{
"opencollection": "1.0.0",
"info": {
"name": "Microsoft Azure AccessControlClient AccessConnector Twins API",
"version": "2020-08-01-preview"
},
"items": [
{
"info": {
"name": "Twins",
"type": "folder"
},
"items": [
{
"info": {
"name": "Microsoft Azure Get Digitaltwins Id",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/digitaltwins/:id",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Retrieves a digital twin.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The digital twin id is invalid.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found."
},
{
"info": {
"name": "Microsoft Azure Put Digitaltwins Id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/digitaltwins/:id",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
},
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Adds or replaces a digital twin.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The digital twin id or payload is invalid.
* ModelDecommissioned - The model for the digital twin is decommissioned.
* TwinLimitReached - The maximum number of digital twins allowed has been reached.
* ValidationFailed - The digital twin payload is not valid.
* 412 Precondition Failed
* PreconditionFailed - The precondition check (If-Match or If-None-Match) failed."
},
{
"info": {
"name": "Microsoft Azure Patch Digitaltwins Id",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/digitaltwins/:id",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
},
{
"name": "If-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Updates a digital twin.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The digital twin id or payload is invalid.
* JsonPatchInvalid - The JSON Patch provided is invalid.
* ValidationFailed - Applying the patch results in an invalid digital twin.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found.
* 412 Precondition Failed
* PreconditionFailed - The precondition check (If-Match or If-None-Match) failed."
},
{
"info": {
"name": "Microsoft Azure Delete Digitaltwins Id",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/digitaltwins/:id",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
},
{
"name": "If-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Deletes a digital twin. All relationships referencing the digital twin must already be deleted.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The digital twin id is invalid.
* RelationshipsNotDeleted - The digital twin contains relationships.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found.
* 412 Precondition Failed
* PreconditionFailed - The precondition check (If-Match or If-None-Match) failed."
},
{
"info": {
"name": "Microsoft Azure Get Digitaltwins Id Relationships Relationshipid",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/digitaltwins/:id/relationships/:relationshipId",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "relationshipId",
"value": "",
"type": "path",
"description": "The id of the relationship. The id is unique within the digital twin and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Retrieves a relationship between two digital twins.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The digital twin id or relationship id is invalid.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found.
* RelationshipNotFound - The relationship was not found."
},
{
"info": {
"name": "Microsoft Azure Put Digitaltwins Id Relationships Relationshipid",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/digitaltwins/:id/relationships/:relationshipId",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
},
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "relationshipId",
"value": "",
"type": "path",
"description": "The id of the relationship. The id is unique within the digital twin and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Adds a relationship between two digital twins.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The digital twin id, relationship id, or payload is invalid.
* InvalidRelationship - The relationship is invalid.
* OperationNotAllowed - The relationship cannot connect to the same digital twin.
* ValidationFailed - The relationship content is invalid.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found.
* TargetTwinNotFound - T"
},
{
"info": {
"name": "Microsoft Azure Patch Digitaltwins Id Relationships Relationshipid",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/digitaltwins/:id/relationships/:relationshipId",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
},
{
"name": "If-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "relationshipId",
"value": "",
"type": "path",
"description": "The id of the relationship. The id is unique within the digital twin and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Updates the properties on a relationship between two digital twins.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The digital twin id or relationship id is invalid.
* InvalidRelationship - The relationship is invalid.
* JsonPatchInvalid - The JSON Patch provided is invalid.
* ValidationFailed - The relationship content is invalid.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found.
* RelationshipNotFound - The r"
},
{
"info": {
"name": "Microsoft Azure Delete Digitaltwins Id Relationships Relationshipid",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/digitaltwins/:id/relationships/:relationshipId",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
},
{
"name": "If-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "relationshipId",
"value": "",
"type": "path",
"description": "The id of the relationship. The id is unique within the digital twin and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Deletes a relationship between two digital twins.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The digital twin id or relationship id is invalid.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found.
* RelationshipNotFound - The relationship was not found.
* 412 Precondition Failed
* PreconditionFailed - The precondition check (If-Match or If-None-Match) failed."
},
{
"info": {
"name": "Microsoft Azure Get Digitaltwins Id Relationships",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/digitaltwins/:id/relationships",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "relationshipName",
"value": "",
"type": "query",
"description": "The name of the relationship."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Retrieves the relationships from a digital twin.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The digital twin id is invalid.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found."
},
{
"info": {
"name": "Microsoft Azure Get Digitaltwins Id Incomingrelationships",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/digitaltwins/:id/incomingrelationships",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Retrieves all incoming relationship for a digital twin.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The digital twin id is invalid.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found."
},
{
"info": {
"name": "Microsoft Azure Post Digitaltwins Id Telemetry",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/digitaltwins/:id/telemetry",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
},
{
"name": "Message-Id",
"value": ""
},
{
"name": "Telemetry-Source-Time",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Sends telemetry on behalf of a digital twin.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The digital twin id or message id is invalid.
* ValidationFailed - The telemetry content is invalid.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found."
},
{
"info": {
"name": "Microsoft Azure Post Digitaltwins Id Components Componentpath Telemetry",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/digitaltwins/:id/components/:componentPath/telemetry",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
},
{
"name": "Message-Id",
"value": ""
},
{
"name": "Telemetry-Source-Time",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "componentPath",
"value": "",
"type": "path",
"description": "The name of the DTDL component."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Sends telemetry on behalf of a component in a digital twin.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The digital twin id, message id, or component path is invalid.
* ValidationFailed - The telemetry content is invalid.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found.
* ComponentNotFound - The component path was not found."
},
{
"info": {
"name": "Microsoft Azure Get Digitaltwins Id Components Componentpath",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/digitaltwins/:id/components/:componentPath",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "componentPath",
"value": "",
"type": "path",
"description": "The name of the DTDL component."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Retrieves a component from a digital twin.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The digital twin id or component path is invalid.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found.
* ComponentNotFound - The component path was not found."
},
{
"info": {
"name": "Microsoft Azure Patch Digitaltwins Id Components Componentpath",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/digitaltwins/:id/components/:componentPath",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
},
{
"name": "If-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the digital twin. The id is unique within the service and case sensitive."
},
{
"name": "componentPath",
"value": "",
"type": "path",
"description": "The name of the DTDL component."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Updates a component on a digital twin.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The digital twin id, component path, or payload is invalid.
* JsonPatchInvalid - The JSON Patch provided is invalid.
* ValidationFailed - Applying the patch results in an invalid digital twin.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found.
* 412 Precondition Failed
* PreconditionFailed - The precondition check (If-Match or If"
}
]
}
],
"bundled": true
}