Azure Industrial IoT OPC UA Publisher Service
Version : v2
License : MIT LICENSE
License URL : https://opensource.org/licenses/MIT
Terms of service : null
Host : localhost:9080
Schemes : HTTP, HTTPS
- Jobs : Jobs controller
- Publish : Value and Event publishing services
- Workers : Agent controller
Jobs controller
POST /publisher/v2/jobs
List all jobs that are registered or continues a query.
Type | Name | Description | Schema |
---|---|---|---|
Query | pageSize optional |
Optional number of results to return | integer (int32) |
Body | body optional |
Query specification to use as filter. | JobInfoQueryApiModel |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | JobInfoListApiModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /publisher/v2/jobs
List all jobs that are registered or continues a query.
Type | Name | Description | Schema |
---|---|---|---|
Query | continuationToken optional |
Optional Continuation token | string |
Query | pageSize optional |
Optional number of results to return | integer (int32) |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | JobInfoListApiModel |
text/plain
application/json
text/json
application/x-msgpack
GET /publisher/v2/jobs/{id}
Returns a job with the provided identifier.
Type | Name | Schema |
---|---|---|
Path | id required |
string |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | JobInfoApiModel |
text/plain
application/json
text/json
application/x-msgpack
DELETE /publisher/v2/jobs/{id}
Deletes a job.
Type | Name | Schema |
---|---|---|
Path | id required |
string |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
GET /publisher/v2/jobs/{id}/cancel
Cancels a job execution.
Type | Name | Schema |
---|---|---|
Path | id required |
string |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
GET /publisher/v2/jobs/{id}/restart
Restarts a cancelled job which sets it back to active.
Type | Name | Schema |
---|---|---|
Path | id required |
string |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
Value and Event publishing services
POST /publisher/v2/publish/{endpointId}
Returns currently published node ids for an endpoint. The endpoint must be activated and connected and the module client and server must trust each other.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The list request | PublishedItemListRequestApiModel |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | PublishedItemListResponseApiModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /publisher/v2/publish/{endpointId}
Returns next set of currently published node ids for an endpoint. The endpoint must be activated and connected and the module client and server must trust each other.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Query | continuationToken required |
The continuation token to continue with | string |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | PublishedItemListResponseApiModel |
text/plain
application/json
text/json
application/x-msgpack
POST /publisher/v2/publish/{endpointId}/bulk
Adds or removes in bulk values that should be published from a particular endpoint.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of an activated endpoint. | string |
Body | body required |
The bulk publish request | PublishBulkRequestApiModel |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | PublishBulkResponseApiModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /publisher/v2/publish/{endpointId}/start
Start publishing variable node values to IoT Hub. The endpoint must be activated and connected and the module client and server must trust each other.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The publish request | PublishStartRequestApiModel |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | PublishStartResponseApiModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /publisher/v2/publish/{endpointId}/stop
Stop publishing variable node values to IoT Hub. The endpoint must be activated and connected and the module client and server must trust each other.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The unpublish request | PublishStopRequestApiModel |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | PublishStopResponseApiModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
Agent controller
GET /publisher/v2/workers
List all workers that are registered or continues a query.
Type | Name | Description | Schema |
---|---|---|---|
Query | continuationToken optional |
Optional Continuation token | string |
Query | pageSize optional |
Optional number of results to return | integer (int32) |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | WorkerInfoListApiModel |
text/plain
application/json
text/json
application/x-msgpack
GET /publisher/v2/workers/{id}
Returns a worker with the provided identifier.
Type | Name | Schema |
---|---|---|
Path | id required |
string |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | WorkerInfoApiModel |
text/plain
application/json
text/json
application/x-msgpack
DELETE /publisher/v2/workers/{id}
Deletes an worker in the registry.
Type | Name | Schema |
---|---|---|
Path | id required |
string |
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |