Opc-Twin-Service
Overview
Azure Industrial IoT OPC UA Twin Service
Version information
Version : v2
License information
License : MIT LICENSE
License URL : https://opensource.org/licenses/MIT
Terms of service : null
URI scheme
Host : localhost:9080
Schemes : HTTP, HTTPS
Tags
- Browse : Browse nodes services
- Call : Call node method services
- Read : Node read services
- Write : Node writing services
Resources
Browse
Browse nodes services
Browse node references
POST /twin/v2/browse/{endpointId}
Description
Browse a node on the specified endpoint. The endpoint must be activated and connected and the module client and server must trust each other.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Body | body required |
The browse request | BrowseRequestApiModel |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | BrowseResponseApiModel |
Consumes
application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/x-msgpack
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack
Browse set of unique target nodes
GET /twin/v2/browse/{endpointId}
Description
Browse the set of unique hierarchically referenced target nodes on the endpoint. The endpoint must be activated and connected and the module client and server must trust each other. The root node id to browse from can be provided as part of the query parameters. If it is not provided, the RootFolder node is browsed. Note that this is the same as the POST method with the model containing the node id and the targetNodesOnly flag set to true.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Query | nodeId optional |
The node to browse or omit to browse the root node (i=84) | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | BrowseResponseApiModel |
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack
Browse next set of references
POST /twin/v2/browse/{endpointId}/next
Description
Browse next set of references on the endpoint. The endpoint must be activated and connected and the module client and server must trust each other.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Body | body required |
The request body with continuation token. | BrowseNextRequestApiModel |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | BrowseNextResponseApiModel |
Consumes
application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/x-msgpack
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack
Browse next set of unique target nodes
GET /twin/v2/browse/{endpointId}/next
Description
Browse the next set of unique hierarchically referenced target nodes on the endpoint. The endpoint must be activated and connected and the module client and server must trust each other. Note that this is the same as the POST method with the model containing the continuation token and the targetNodesOnly flag set to true.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Query | continuationToken required |
Continuation token from GetSetOfUniqueNodes operation | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | BrowseNextResponseApiModel |
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack
Browse using a browse path
POST /twin/v2/browse/{endpointId}/path
Description
Browse using a path from the specified node id. This call uses TranslateBrowsePathsToNodeIds service under the hood. The endpoint must be activated and connected and the module client and server must trust each other.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Body | body required |
The browse path request | BrowsePathRequestApiModel |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | BrowsePathResponseApiModel |
Consumes
application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/x-msgpack
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack
Call
Call node method services
Call a method
POST /twin/v2/call/{endpointId}
Description
Invoke method node with specified input arguments. The endpoint must be activated and connected and the module client and server must trust each other.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Body | body required |
The method call request | MethodCallRequestApiModel |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | MethodCallResponseApiModel |
Consumes
application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/x-msgpack
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack
Get method meta data
POST /twin/v2/call/{endpointId}/metadata
Description
Return method meta data to support a user interface displaying forms to input and output arguments. The endpoint must be activated and connected and the module client and server must trust each other.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Body | body required |
The method metadata request | MethodMetadataRequestApiModel |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | MethodMetadataResponseApiModel |
Consumes
application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/x-msgpack
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack
Read
Node read services
Read variable value
POST /twin/v2/read/{endpointId}
Description
Read a variable node’s value. The endpoint must be activated and connected and the module client and server must trust each other.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Body | body required |
The read value request | ValueReadRequestApiModel |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | ValueReadResponseApiModel |
Consumes
application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/x-msgpack
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack
Get variable value
GET /twin/v2/read/{endpointId}
Description
Get a variable node’s value using its node id. The endpoint must be activated and connected and the module client and server must trust each other.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Query | nodeId required |
The node to read | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | ValueReadResponseApiModel |
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack
Read node attributes
POST /twin/v2/read/{endpointId}/attributes
Description
Read attributes of a node. The endpoint must be activated and connected and the module client and server must trust each other.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Body | body required |
The read request | ReadRequestApiModel |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | ReadResponseApiModel |
Consumes
application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/x-msgpack
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack
Write
Node writing services
Write variable value
POST /twin/v2/write/{endpointId}
Description
Write variable node’s value. The endpoint must be activated and connected and the module client and server must trust each other.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Body | body required |
The write value request | ValueWriteRequestApiModel |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | ValueWriteResponseApiModel |
Consumes
application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/x-msgpack
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack
Write node attributes
POST /twin/v2/write/{endpointId}/attributes
Description
Write any attribute of a node. The endpoint must be activated and connected and the module client and server must trust each other.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | endpointId required |
The identifier of the activated endpoint. | string |
| Body | body required |
The batch write request | WriteRequestApiModel |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success | WriteResponseApiModel |
Consumes
application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/x-msgpack
Produces
text/plainapplication/jsontext/jsonapplication/x-msgpack