Skip to content

Latest commit

 

History

History
534 lines (326 loc) · 9.52 KB

readme.md

File metadata and controls

534 lines (326 loc) · 9.52 KB

Opc-Publisher-Service

Overview

Azure Industrial IoT OPC UA Publisher 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

  • Jobs : Jobs controller
  • Publish : Value and Event publishing services
  • Workers : Agent controller

Resources

Jobs

Jobs controller

Query jobs

POST /publisher/v2/jobs
Description

List all jobs that are registered or continues a query.

Parameters
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
Responses
HTTP Code Description Schema
200 Success JobInfoListApiModel
Consumes
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Get list of jobs

GET /publisher/v2/jobs
Description

List all jobs that are registered or continues a query.

Parameters
Type Name Description Schema
Query continuationToken
optional
Optional Continuation token string
Query pageSize
optional
Optional number of results to return integer (int32)
Responses
HTTP Code Description Schema
200 Success JobInfoListApiModel
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Get job by id

GET /publisher/v2/jobs/{id}
Description

Returns a job with the provided identifier.

Parameters
Type Name Schema
Path id
required
string
Responses
HTTP Code Description Schema
200 Success JobInfoApiModel
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Delete job by id

DELETE /publisher/v2/jobs/{id}
Description

Deletes a job.

Parameters
Type Name Schema
Path id
required
string
Responses
HTTP Code Description Schema
200 Success No Content

Cancel job by id

GET /publisher/v2/jobs/{id}/cancel
Description

Cancels a job execution.

Parameters
Type Name Schema
Path id
required
string
Responses
HTTP Code Description Schema
200 Success No Content

Restart job by id

GET /publisher/v2/jobs/{id}/restart
Description

Restarts a cancelled job which sets it back to active.

Parameters
Type Name Schema
Path id
required
string
Responses
HTTP Code Description Schema
200 Success No Content

Publish

Value and Event publishing services

Get currently published nodes

POST /publisher/v2/publish/{endpointId}
Description

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.

Parameters
Type Name Description Schema
Path endpointId
required
The identifier of the activated endpoint. string
Body body
required
The list request PublishedItemListRequestApiModel
Responses
HTTP Code Description Schema
200 Success PublishedItemListResponseApiModel
Consumes
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Get next set of published nodes

GET /publisher/v2/publish/{endpointId}
Description

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.

Parameters
Type Name Description Schema
Path endpointId
required
The identifier of the activated endpoint. string
Query continuationToken
required
The continuation token to continue with string
Responses
HTTP Code Description Schema
200 Success PublishedItemListResponseApiModel
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Bulk publish node values

POST /publisher/v2/publish/{endpointId}/bulk
Description

Adds or removes in bulk values that should be published from a particular endpoint.

Parameters
Type Name Description Schema
Path endpointId
required
The identifier of an activated endpoint. string
Body body
required
The bulk publish request PublishBulkRequestApiModel
Responses
HTTP Code Description Schema
200 Success PublishBulkResponseApiModel
Consumes
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Start publishing node values

POST /publisher/v2/publish/{endpointId}/start
Description

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.

Parameters
Type Name Description Schema
Path endpointId
required
The identifier of the activated endpoint. string
Body body
required
The publish request PublishStartRequestApiModel
Responses
HTTP Code Description Schema
200 Success PublishStartResponseApiModel
Consumes
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Stop publishing node values

POST /publisher/v2/publish/{endpointId}/stop
Description

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.

Parameters
Type Name Description Schema
Path endpointId
required
The identifier of the activated endpoint. string
Body body
required
The unpublish request PublishStopRequestApiModel
Responses
HTTP Code Description Schema
200 Success PublishStopResponseApiModel
Consumes
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Workers

Agent controller

Get list of workers

GET /publisher/v2/workers
Description

List all workers that are registered or continues a query.

Parameters
Type Name Description Schema
Query continuationToken
optional
Optional Continuation token string
Query pageSize
optional
Optional number of results to return integer (int32)
Responses
HTTP Code Description Schema
200 Success WorkerInfoListApiModel
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Get worker

GET /publisher/v2/workers/{id}
Description

Returns a worker with the provided identifier.

Parameters
Type Name Schema
Path id
required
string
Responses
HTTP Code Description Schema
200 Success WorkerInfoApiModel
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Delete worker by id

DELETE /publisher/v2/workers/{id}
Description

Deletes an worker in the registry.

Parameters
Type Name Schema
Path id
required
string
Responses
HTTP Code Description Schema
200 Success No Content