CRUD and Query application resources
POST /registry/v2/applications
Registers a server solely using a discovery url. Requires that the onboarding agent service is running and the server can be located by a supervisor in its network using the discovery url.
Type | Name | Description | Schema |
---|---|---|---|
Body | body required |
Server registration request | ServerRegistrationRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
GET /registry/v2/applications
Get all registered applications in paged form. The returned model can contain a continuation token if more results are available. Call this operation again using the token to retrieve more results.
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 | OK | ApplicationInfoListModel |
text/plain
application/json
text/json
application/x-msgpack
PUT /registry/v2/applications
The application is registered using the provided information, but it is not associated with a publisher. This is useful for when you need to register clients or you want to register a server that is located in a network not reachable through a publisher module.
Type | Name | Description | Schema |
---|---|---|---|
Body | body required |
Application registration request | ApplicationRegistrationRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | ApplicationRegistrationResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
DELETE /registry/v2/applications
Purges all applications that have not been seen for a specified amount of time.
Type | Name | Description | Schema |
---|---|---|---|
Query | notSeenFor optional |
A duration in milliseconds | string (date-span) |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
POST /registry/v2/applications/discover
Registers servers by running a discovery scan in a supervisor's network. Requires that the onboarding agent service is running.
Type | Name | Description | Schema |
---|---|---|---|
Body | body required |
Discovery request | DiscoveryRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
DELETE /registry/v2/applications/discover/{requestId}
Cancels a discovery request using the request identifier.
Type | Name | Description | Schema |
---|---|---|---|
Path | requestId required |
Discovery request | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
POST /registry/v2/applications/query
List applications that match a query model. The returned model can contain a continuation token if more results are available. Call the GetListOfApplications operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | pageSize optional |
Optional number of results to return | integer (int32) |
Body | body required |
Application query | ApplicationRegistrationQueryModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | ApplicationInfoListModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/applications/query
Get a list of applications filtered using the specified query parameters. The returned model can contain a continuation token if more results are available. Call the GetListOfApplications operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | pageSize optional |
Number of results to return | integer (int32) |
Body | body required |
Applications Query model | ApplicationRegistrationQueryModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | ApplicationInfoListModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/applications/sites
List all sites applications are registered in.
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 | OK | ApplicationSiteListModel |
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/applications/{applicationId}
Type | Name | Description | Schema |
---|---|---|---|
Path | applicationId required |
Application id for the server | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | ApplicationRegistrationModel |
text/plain
application/json
text/json
application/x-msgpack
DELETE /registry/v2/applications/{applicationId}
Unregisters and deletes application and all its associated endpoints.
Type | Name | Description | Schema |
---|---|---|---|
Path | applicationId required |
The identifier of the application | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
PATCH /registry/v2/applications/{applicationId}
The application information is updated with new properties. Note that this information might be overridden if the application is re-discovered during a discovery run (recurring or one-time).
Type | Name | Description | Schema |
---|---|---|---|
Path | applicationId required |
The identifier of the application | string |
Body | body required |
Application update request | ApplicationRegistrationUpdateModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
POST /registry/v2/applications/{applicationId}/disable
A manager can disable an application.
Type | Name | Description | Schema |
---|---|---|---|
Path | applicationId required |
The application id | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
POST /registry/v2/applications/{applicationId}/enable
A manager can enable an application.
Type | Name | Description | Schema |
---|---|---|---|
Path | applicationId required |
The application id | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
Discovery
GET /registry/v2/discovery
Get all registered discoverers and therefore twin modules in paged form. The returned model can contain a continuation token if more results are available. Call this operation again using the token to retrieve more results.
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 | OK | DiscovererListModel |
text/plain
application/json
text/json
application/x-msgpack
POST /registry/v2/discovery/query
Get all discoverers that match a specified query. The returned model can contain a continuation token if more results are available. Call the GetListOfDiscoverers operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | pageSize optional |
Number of results to return | integer (int32) |
Body | body required |
Discoverers query model | DiscovererQueryModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | DiscovererListModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/discovery/query
Get a list of discoverers filtered using the specified query parameters. The returned model can contain a continuation token if more results are available. Call the GetListOfDiscoverers operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | connected optional |
Included connected or disconnected | boolean |
Query | discovery optional |
Discovery mode of discoverer | enum (Off, Local, Network, Fast, Scan) |
Query | pageSize optional |
Number of results to return | integer (int32) |
Query | siteId optional |
Site of the discoverer | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | DiscovererListModel |
text/plain
application/json
text/json
application/x-msgpack
POST /registry/v2/discovery/{discovererId}
Allows a caller to configure recurring discovery runs on the discovery module identified by the module id.
Type | Name | Description | Schema |
---|---|---|---|
Path | discovererId required |
discoverer identifier | string |
Query | mode required |
Discovery mode | enum (Off, Local, Network, Fast, Scan) |
Body | body optional |
Discovery configuration | DiscoveryConfigModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
GET /registry/v2/discovery/{discovererId}
Returns a discoverer's registration and connectivity information. A discoverer id corresponds to the twin modules module identity.
Type | Name | Description | Schema |
---|---|---|---|
Path | discovererId required |
Discoverer identifier | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | DiscovererModel |
text/plain
application/json
text/json
application/x-msgpack
PATCH /registry/v2/discovery/{discovererId}
Allows a caller to configure recurring discovery runs on the twin module identified by the discoverer id or update site information.
Type | Name | Description | Schema |
---|---|---|---|
Path | discovererId required |
discoverer identifier | string |
Body | body required |
Patch request | DiscovererUpdateModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
Activate, Deactivate and Query endpoint resources
GET /registry/v2/endpoints
Get all registered endpoints in paged form. The returned model can contain a continuation token if more results are available. Call this operation again using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | continuationToken optional |
Optional Continuation token | string |
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
Query | pageSize optional |
Optional number of results to return | integer (int32) |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | EndpointInfoListModel |
text/plain
application/json
text/json
application/x-msgpack
PUT /registry/v2/endpoints
Adds an endpoint. This will onboard the endpoint and the associated application but no other endpoints. This call is synchronous and will return successful if endpoint is found. Otherwise the call will fail with error not found.
Type | Name | Description | Schema |
---|---|---|---|
Body | body optional |
Query for the endpoint to register. This must have at least the discovery url. If more information is specified it is used to validate that the application has such endpoint and if not the call will fail. | ServerEndpointQueryModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | string |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /registry/v2/endpoints/query
Return endpoints that match the specified query. The returned model can contain a continuation token if more results are available. Call the GetListOfEndpoints operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
Query | pageSize optional |
Optional number of results to return | integer (int32) |
Body | body required |
Query to match | EndpointRegistrationQueryModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | EndpointInfoListModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/endpoints/query
Get a list of endpoints filtered using the specified query parameters. The returned model can contain a continuation token if more results are available. Call the GetListOfEndpoints operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | applicationId optional |
Application id to filter | string |
Query | certificate optional |
Certificate thumbprint of the endpoint | string |
Query | discovererId optional |
Discoverer id to filter with | string |
Query | endpointState optional |
The last state of the activated endpoint | enum (Connecting, NotReachable, Busy, NoTrust, CertificateInvalid, Ready, Error, Disconnected, Unauthorized) |
Query | includeNotSeenSince optional |
Whether to include endpoints that were soft deleted | boolean |
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
Query | pageSize optional |
Optional number of results to return | integer (int32) |
Query | securityMode optional |
Security mode to use for communication - null = Best | enum (Best, Sign, SignAndEncrypt, None, NotNone) |
Query | securityPolicy optional |
Endpoint security policy to use - null = Best. | string |
Query | siteOrGatewayId optional |
Site or gateway id to filter with | string |
Query | url optional |
Endoint url for direct server access | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | EndpointInfoListModel |
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/endpoints/{endpointId}
Gets information about an endpoint.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
endpoint identifier | string |
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | EndpointInfoModel |
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/endpoints/{endpointId}/certificate
Gets current certificate of the endpoint.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
endpoint identifier | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | X509CertificateChainModel |
text/plain
application/json
text/json
application/x-msgpack
POST /registry/v2/endpoints/{endpointId}/test
Test an endpoint can be connected to. Returns error information if connecting fails.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
endpoint identifier | string |
Body | body required |
TestConnectionRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | TestConnectionResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
Configure discovery events
PUT /events/v2/discovery/requests/{requestId}/events
Register a client to receive discovery progress events through SignalR for a particular request.
Type | Name | Description | Schema |
---|---|---|---|
Path | requestId required |
The request to monitor | string |
Body | body optional |
The connection that will receive discovery events. | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
DELETE /events/v2/discovery/requests/{requestId}/events/{connectionId}
Unregister a client and stop it from receiving discovery events for a particular request.
Type | Name | Description | Schema |
---|---|---|---|
Path | connectionId required |
The connection that will not receive any more discovery progress | string |
Path | requestId required |
The request to unsubscribe from | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
PUT /events/v2/discovery/{discovererId}/events
Register a client to receive discovery progress events through SignalR from a particular discoverer.
Type | Name | Description | Schema |
---|---|---|---|
Path | discovererId required |
The discoverer to subscribe to | string |
Body | body optional |
The connection that will receive discovery events. | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
DELETE /events/v2/discovery/{discovererId}/events/{connectionId}
Unregister a client and stop it from receiving discovery events.
Type | Name | Description | Schema |
---|---|---|---|
Path | connectionId required |
The connection that will not receive any more discovery progress | string |
Path | discovererId required |
The discoverer to unsubscribe from | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
Read, Update and Query Gateway resources
GET /registry/v2/gateways
Get all registered Gateways and therefore twin modules in paged form. The returned model can contain a continuation token if more results are available. Call this operation again using the token to retrieve more results.
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 | OK | GatewayListModel |
text/plain
application/json
text/json
application/x-msgpack
POST /registry/v2/gateways/query
Get all Gateways that match a specified query. The returned model can contain a continuation token if more results are available. Call the GetListOfGateway operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | pageSize optional |
Number of results to return | integer (int32) |
Body | body required |
Gateway query model | GatewayQueryModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | GatewayListModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/gateways/query
Get a list of Gateways filtered using the specified query parameters. The returned model can contain a continuation token if more results are available. Call the GetListOfGateway operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | connected optional |
Included connected or disconnected | boolean |
Query | pageSize optional |
Number of results to return | integer (int32) |
Query | siteId optional |
Site of the Gateway | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | GatewayListModel |
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/gateways/{GatewayId}
Returns a Gateway's registration and connectivity information. A Gateway id corresponds to the twin modules module identity.
Type | Name | Description | Schema |
---|---|---|---|
Path | GatewayId required |
Gateway identifier | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | GatewayInfoModel |
text/plain
application/json
text/json
application/x-msgpack
PATCH /registry/v2/gateways/{GatewayId}
Allows a caller to configure operations on the Gateway module identified by the Gateway id.
Type | Name | Description | Schema |
---|---|---|---|
Path | GatewayId required |
Gateway identifier | string |
Body | body required |
Patch request | GatewayUpdateModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
History raw access services
GET /history/v2/capabilities/{endpointId}
Gets the capabilities of the connected historian server. The endpoint must be in the registry 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 | namespaceFormat optional |
enum (Uri, Index, Expanded) |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryServerCapabilitiesModel |
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/delete/{endpointId}/events
Delete historic events using historic access. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The history update request | DeleteEventsDetailsModelHistoryUpdateRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryUpdateResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/delete/{endpointId}/values
Delete historic values using historic access. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The history update request | DeleteValuesDetailsModelHistoryUpdateRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryUpdateResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/delete/{endpointId}/values/modified
Delete historic values using historic access. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The history update request | DeleteValuesDetailsModelHistoryUpdateRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryUpdateResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/delete/{endpointId}/values/pick
Delete value history using historic access. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The history update request | DeleteValuesAtTimesDetailsModelHistoryUpdateRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryUpdateResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/history/read/{endpointId}
Read node history if available using historic access. The endpoint must be in the registry 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 history read request | VariantValueHistoryReadRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | VariantValueHistoryReadResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/history/read/{endpointId}/next
Read next batch of node history values using historic access. The endpoint must be in the registry 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 history read next request | HistoryReadNextRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | VariantValueHistoryReadNextResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/history/update/{endpointId}
Update node history using historic access. The endpoint must be in the registry 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 history update request | VariantValueHistoryUpdateRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryUpdateResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/insert/{endpointId}/events
Insert historic events using historic access. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The history insert request | UpdateEventsDetailsModelHistoryUpdateRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryUpdateResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/insert/{endpointId}/values
Insert historic values using historic access. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The history insert request | UpdateValuesDetailsModelHistoryUpdateRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryUpdateResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/read/{endpointId}/configuration
Read history node configuration if available. The endpoint must be in the registry 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 optional |
The history configuration read request | HistoryConfigurationRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryConfigurationResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/read/{endpointId}/events
Read historic events of a node if available using historic access. The endpoint must be in the registry 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 history read request | ReadEventsDetailsModelHistoryReadRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoricEventModelArrayHistoryReadResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/read/{endpointId}/events/next
Read next batch of historic events of a node using historic access. The endpoint must be in the registry 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 history read next request | HistoryReadNextRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoricEventModelArrayHistoryReadNextResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/read/{endpointId}/values
Read processed history values of a node if available using historic access. The endpoint must be in the registry 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 history read request | ReadValuesDetailsModelHistoryReadRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoricValueModelArrayHistoryReadResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/read/{endpointId}/values/modified
Read processed history values of a node if available using historic access. The endpoint must be in the registry 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 history read request | ReadModifiedValuesDetailsModelHistoryReadRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoricValueModelArrayHistoryReadResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/read/{endpointId}/values/next
Read next batch of historic values of a node using historic access. The endpoint must be in the registry 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 history read next request | HistoryReadNextRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoricValueModelArrayHistoryReadNextResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/read/{endpointId}/values/pick
Read historic values of a node if available using historic access. The endpoint must be in the registry 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 history read request | ReadValuesAtTimesDetailsModelHistoryReadRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoricValueModelArrayHistoryReadResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/read/{endpointId}/values/processed
Read processed history values of a node if available using historic access. The endpoint must be in the registry 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 history read request | ReadProcessedValuesDetailsModelHistoryReadRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoricValueModelArrayHistoryReadResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/replace/{endpointId}/events
Replace historic events using historic access. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The history replace request | UpdateEventsDetailsModelHistoryUpdateRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryUpdateResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/replace/{endpointId}/values
Replace historic values using historic access. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The history replace request | UpdateValuesDetailsModelHistoryUpdateRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryUpdateResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/upsert/{endpointId}/events
Upsert historic events using historic access. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The history upsert request | UpdateEventsDetailsModelHistoryUpdateRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryUpdateResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /history/v2/upsert/{endpointId}/values
Upsert historic values using historic access. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The history upsert request | UpdateValuesDetailsModelHistoryUpdateRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | HistoryUpdateResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
Value and Event publishing services
POST /publisher/v2/publish/{endpointId}
Returns currently published node ids for an endpoint. The endpoint must be in the registry 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 | PublishedItemListRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | PublishedItemListResponseModel |
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 in the registry 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 | OK | PublishedItemListResponseModel |
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 a registered endpoint. | string |
Body | body required |
The bulk publish request | PublishBulkRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | PublishBulkResponseModel |
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 in the registry 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 | PublishStartRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | PublishStartResponseModel |
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 in the registry 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 | PublishStopRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | PublishStopResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
Read, Update and Query publisher resources
GET /registry/v2/publishers
Get all registered publishers and therefore twin modules in paged form. The returned model can contain a continuation token if more results are available. Call this operation again using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | continuationToken optional |
Optional Continuation token | string |
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
Query | pageSize optional |
Optional number of results to return | integer (int32) |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | PublisherListModel |
text/plain
application/json
text/json
application/x-msgpack
POST /registry/v2/publishers/query
Get all publishers that match a specified query. The returned model can contain a continuation token if more results are available. Call the GetListOfPublisher operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
Query | pageSize optional |
Number of results to return | integer (int32) |
Body | body required |
Publisher query model | PublisherQueryModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | PublisherListModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/publishers/query
Get a list of publishers filtered using the specified query parameters. The returned model can contain a continuation token if more results are available. Call the GetListOfPublisher operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | connected optional |
Included connected or disconnected | boolean |
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
Query | pageSize optional |
Number of results to return | integer (int32) |
Query | siteId optional |
Site for the supervisors | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | PublisherListModel |
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/publishers/{publisherId}
Returns a publisher's registration and connectivity information. A publisher id corresponds to the twin modules module identity.
Type | Name | Description | Schema |
---|---|---|---|
Path | publisherId required |
Publisher identifier | string |
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | PublisherModel |
text/plain
application/json
text/json
application/x-msgpack
PATCH /registry/v2/publishers/{publisherId}
Allows a caller to configure operations on the publisher module identified by the publisher id.
Type | Name | Description | Schema |
---|---|---|---|
Path | publisherId required |
Publisher identifier | string |
Body | body required |
Patch request | PublisherUpdateModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
GET /registry/v2/publishers/{publisherId}/endpoints
Get all configured endpoints on the publisher. These are the ones configured in the local storage of the publisher.
Type | Name | Description | Schema |
---|---|---|---|
Path | publisherId required |
string | |
Query | IncludeNodes optional |
Include nodes that make up the configuration | boolean |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | PublishedNodesEntryModelIAsyncEnumerable |
text/plain
application/json
text/json
application/x-msgpack
PUT /registry/v2/publishers/{publisherId}/endpoints
Set all configured endpoints on the publisher. These are the ones that will be written to local storage of the publisher.
Type | Name | Schema |
---|---|---|
Path | publisherId required |
string |
Body | body required |
SetConfiguredEndpointsRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
Read, Update and Query publisher resources
GET /registry/v2/supervisors
Get all registered supervisors and therefore twin modules in paged form. The returned model can contain a continuation token if more results are available. Call this operation again using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | continuationToken optional |
Optional Continuation token | string |
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
Query | pageSize optional |
Optional number of results to return | integer (int32) |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | SupervisorListModel |
text/plain
application/json
text/json
application/x-msgpack
POST /registry/v2/supervisors/query
Get all supervisors that match a specified query. The returned model can contain a continuation token if more results are available. Call the GetListOfSupervisors operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
Query | pageSize optional |
Number of results to return | integer (int32) |
Body | body required |
Supervisors query model | SupervisorQueryModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | SupervisorListModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/supervisors/query
Get a list of supervisors filtered using the specified query parameters. The returned model can contain a continuation token if more results are available. Call the GetListOfSupervisors operation using the token to retrieve more results.
Type | Name | Description | Schema |
---|---|---|---|
Query | connected optional |
Included connected or disconnected | boolean |
Query | endpointId optional |
Managing provided endpoint twin | string |
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
Query | pageSize optional |
Number of results to return | integer (int32) |
Query | siteId optional |
Site for the supervisors | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | SupervisorListModel |
text/plain
application/json
text/json
application/x-msgpack
GET /registry/v2/supervisors/{supervisorId}
Returns a supervisor's registration and connectivity information. A supervisor id corresponds to the twin modules module identity.
Type | Name | Description | Schema |
---|---|---|---|
Path | supervisorId required |
Supervisor identifier | string |
Query | onlyServerState optional |
Whether to include only server state, or display current client state of the endpoint if available | boolean |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | SupervisorModel |
text/plain
application/json
text/json
application/x-msgpack
PATCH /registry/v2/supervisors/{supervisorId}
Allows a caller to configure recurring discovery runs on the twin module identified by the supervisor id or update site information.
Type | Name | Description | Schema |
---|---|---|---|
Path | supervisorId required |
supervisor identifier | string |
Body | body required |
Patch request | SupervisorUpdateModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
Value and Event monitoring services
PUT /events/v2/telemetry/{endpointId}/samples
Register a client to receive publisher samples through SignalR.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The endpoint to subscribe to | string |
Body | body optional |
The connection that will receive publisher samples. | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
DELETE /events/v2/telemetry/{endpointId}/samples/{connectionId}
Unregister a client and stop it from receiving samples.
Type | Name | Description | Schema |
---|---|---|---|
Path | connectionId required |
The connection that will not receive any more published samples | string |
Path | endpointId required |
The endpoint to unsubscribe from | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | No Content |
Node access read services
POST /twin/v2/browse/{endpointId}
Browse a node on the specified endpoint. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The browse request | BrowseFirstRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | BrowseFirstResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /twin/v2/browse/{endpointId}
Browse the set of unique hierarchically referenced target nodes on the endpoint. The endpoint must be in the registry and the server accessible. 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.
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 |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | BrowseFirstResponseModel |
text/plain
application/json
text/json
application/x-msgpack
POST /twin/v2/browse/{endpointId}/next
Browse next set of references on the endpoint. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The request body with continuation token. | BrowseNextRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | BrowseNextResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /twin/v2/browse/{endpointId}/next
Browse the next set of unique hierarchically referenced target nodes on the endpoint. The endpoint must be in the registry and the server accessible. Note that this is the same as the POST method with the model containing the continuation token and the targetNodesOnly flag set to true.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Query | continuationToken required |
Continuation token from GetSetOfUniqueNodes operation | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | BrowseNextResponseModel |
text/plain
application/json
text/json
application/x-msgpack
POST /twin/v2/browse/{endpointId}/path
Browse using a path from the specified node id. This call uses TranslateBrowsePathsToNodeIds service under the hood. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The browse path request | BrowsePathRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | BrowsePathResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /twin/v2/call/{endpointId}
Invoke method node with specified input arguments. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The method call request | MethodCallRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | MethodCallResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /twin/v2/call/{endpointId}/metadata
(Obsolete - use GetMetadata API) Return method meta data to support a user interface displaying forms to input and output arguments. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The method metadata request | MethodMetadataRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | MethodMetadataResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /twin/v2/capabilities/{endpointId}
Gets the capabilities of the connected server. The endpoint must be in the registry 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 | namespaceFormat optional |
enum (Uri, Index, Expanded) |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | ServerCapabilitiesModel |
text/plain
application/json
text/json
application/x-msgpack
POST /twin/v2/metadata/{endpointId}/node
Get the node metadata which includes the fields and meta data of the type and can be used when constructing event filters or calling methods to pass the correct arguments. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The metadata request | NodeMetadataRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | NodeMetadataResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /twin/v2/read/{endpointId}
Read a variable node's value. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The read value request | ValueReadRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | ValueReadResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
GET /twin/v2/read/{endpointId}
Get a variable node's value using its node id. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Query | nodeId required |
The node to read | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | ValueReadResponseModel |
text/plain
application/json
text/json
application/x-msgpack
POST /twin/v2/read/{endpointId}/attributes
Read attributes of a node. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The read request | ReadRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | ReadResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /twin/v2/write/{endpointId}
Write variable node's value. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The write value request | ValueWriteRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | ValueWriteResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack
POST /twin/v2/write/{endpointId}/attributes
Write any attribute of a node. The endpoint must be in the registry and the server accessible.
Type | Name | Description | Schema |
---|---|---|---|
Path | endpointId required |
The identifier of the activated endpoint. | string |
Body | body required |
The batch write request | WriteRequestModel |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | WriteResponseModel |
application/json-patch+json
application/json
text/json
application/*+json
application/x-msgpack
text/plain
application/json
text/json
application/x-msgpack