Microsoft.DigitalTwins (preview:2020-05-31)

2025/10/23 • 24 deleted methods

DigitalTwinModels_Add (removed)
Description :  Uploads one or more models. When any error occurs, no models are uploaded. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 409 (Conflict): One or more of the provided models already exist.
Reference :  Link ¶

⚼ Request

POST:  /models
{
models:
{
Description: An array of models to add. ,
Required: False ,
}
object ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
displayName:
{
Description: A language map that contains the localized display names as specified in the model definition. ,
Required: False ,
}
object ,
description:
{
Description: A language map that contains the localized descriptions as specified in the model definition. ,
Required: False ,
}
object ,
id:
{
Description: The id of the model as specified in the model definition. ,
Required: True ,
}
string ,
uploadTime:
{
Description: The time the model was uploaded to the service. ,
Format: date-time ,
Required: False ,
}
string ,
decommissioned:
{
Description: Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins. ,
Required: False ,
}
boolean ,
model:
{
Description: The model definition. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwinModels_List (removed)
Description :  Retrieves model metadata and, optionally, model definitions. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid.
Reference :  Link ¶

⚼ Request

GET:  /models
{
dependenciesFor:
{
Description: The set of the models which will have their dependencies retrieved. If omitted, all models are retrieved. ,
Required: False ,
}
array ,
includeModelDefinition:
{
Description: When true the model definition will be returned as part of the result. ,
Required: False ,
}
boolean ,
x-ms-max-item-count:
{
Description: The maximum number of items to retrieve per request. The server may choose to return less than the requested max. ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ModelData objects. ,
Required: False ,
}
[
{
displayName:
{
Description: A language map that contains the localized display names as specified in the model definition. ,
Required: False ,
}
object ,
description:
{
Description: A language map that contains the localized descriptions as specified in the model definition. ,
Required: False ,
}
object ,
id:
{
Description: The id of the model as specified in the model definition. ,
Required: True ,
}
string ,
uploadTime:
{
Description: The time the model was uploaded to the service. ,
Format: date-time ,
Required: False ,
}
string ,
decommissioned:
{
Description: Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins. ,
Required: False ,
}
boolean ,
model:
{
Description: The model definition. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: A URI to retrieve the next page of objects. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwinModels_GetById (removed)
Description :  Retrieves model metadata and optionally the model definition. Status codes: 200 (OK): Success. 404 (Not Found): There is no model with the provided id.
Reference :  Link ¶

⚼ Request

GET:  /models/{id}
{
id:
{
Description: The id for the model. The id is globally unique and case sensitive. ,
Required: True ,
}
string ,
includeModelDefinition:
{
Description: When true the model definition will be returned as part of the result. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
displayName:
{
Description: A language map that contains the localized display names as specified in the model definition. ,
Required: False ,
}
object ,
description:
{
Description: A language map that contains the localized descriptions as specified in the model definition. ,
Required: False ,
}
object ,
id:
{
Description: The id of the model as specified in the model definition. ,
Required: True ,
}
string ,
uploadTime:
{
Description: The time the model was uploaded to the service. ,
Format: date-time ,
Required: False ,
}
string ,
decommissioned:
{
Description: Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins. ,
Required: False ,
}
boolean ,
model:
{
Description: The model definition. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwinModels_Update (removed)
Description :  Updates the metadata for a model. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 404 (Not Found): There is no model with the provided id.
Reference :  Link ¶

⚼ Request

PATCH:  /models/{id}
{
id:
{
Description: The id for the model. The id is globally unique and case sensitive. ,
Required: True ,
}
string ,
updateModel:
{
Description: An update specification described by JSON Patch. Only the decommissioned property can be replaced. ,
Required: True ,
}
object ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwinModels_Delete (removed)
Description :  Deletes a model. A model can only be deleted if no other models reference it. Status codes: 204 (No Content): Success. 400 (Bad Request): The request is invalid. 404 (Not Found): There is no model with the provided id. 409 (Conflict): There are dependencies on the model that prevent it from being deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /models/{id}
{
id:
{
Description: The id for the model. The id is globally unique and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
Query_QueryTwins (removed)
Description :  Executes a query that allows traversing relationships and filtering by property values. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid.
Reference :  Link ¶

⚼ Request

POST:  /query
{
querySpecification:
{
Description: The query specification to execute. ,
Required: True ,
}
{
query:
{
Description: The query to execute. This value is ignored if a continuation token is provided. ,
Required: False ,
}
string ,
continuationToken:
{
Description: A token which is used to retrieve the next set of results from a previous query. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
query-charge:
{
Description: The query charge. ,
}
number ,
}
,
$schema:
{
Description: The results of a query operation and an optional continuation token. ,
}
{
items:
{
Description: The query results. ,
Required: False ,
}
[
object ,
]
,
continuationToken:
{
Description: A token which can be used to construct a new QuerySpecification to retrieve the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_GetById (removed)
Description :  Retrieves a digital twin. Status codes: 200 (OK): Success. 404 (Not Found): There is no digital twin with the provided id.
Reference :  Link ¶

⚼ Request

GET:  /digitaltwins/{id}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Weak Etag. ,
}
string ,
}
,
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_Add (removed)
Description :  Adds or replaces a digital twin. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 412 (Precondition Failed): The model is decommissioned or the digital twin already exists (when using If-None-Match: *).
Reference :  Link ¶

⚼ Request

PUT:  /digitaltwins/{id}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
twin:
{
Description: The digital twin instance being added. If provided, the $dtId property is ignored. ,
Required: True ,
}
object ,
If-None-Match:
{
Description: Only perform the operation if the entity does not already exist. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Weak Etag. ,
}
string ,
}
,
$schema: object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_Delete (removed)
Description :  Deletes a digital twin. All relationships referencing the digital twin must already be deleted. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 404 (Not Found): There is no digital twin with the provided id.
Reference :  Link ¶

⚼ Request

DELETE:  /digitaltwins/{id}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_Update (removed)
Description :  Updates a digital twin. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 404 (Not Found): There is no digital twin with the provided id.
Reference :  Link ¶

⚼ Request

PATCH:  /digitaltwins/{id}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
patchDocument:
{
Description: An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove. ,
Required: True ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
etag:
{
Description: Weak Etag. ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_GetRelationshipById (removed)
Description :  Retrieves a relationship between two digital twins. Status codes: 200 (OK): Success. 404 (Not Found): There is either no digital twin or relationship with the provided id.
Reference :  Link ¶

⚼ Request

GET:  /digitaltwins/{id}/relationships/{relationshipId}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
relationshipId:
{
Description: The id of the relationship. The id is unique within the digital twin and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Weak Etag. ,
}
string ,
}
,
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_AddRelationship (removed)
Description :  Adds a relationship between two digital twins. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 404 (Not Found): There is either no digital twin, target digital twin, or relationship with the provided id. 409 (Conflict): A relationship with the provided id already exists.
Reference :  Link ¶

⚼ Request

PUT:  /digitaltwins/{id}/relationships/{relationshipId}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
relationshipId:
{
Description: The id of the relationship. The id is unique within the digital twin and case sensitive. ,
Required: True ,
}
string ,
relationship:
{
Description: The data for the relationship. ,
Required: False ,
}
object ,
If-None-Match:
{
Description: Only perform the operation if the entity does not already exist. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Weak Etag. ,
}
string ,
}
,
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_DeleteRelationship (removed)
Description :  Deletes a relationship between two digital twins. Status codes: 200 (OK): Success. 404 (Not Found): There is either no digital twin or relationship with the provided id.
Reference :  Link ¶

⚼ Request

DELETE:  /digitaltwins/{id}/relationships/{relationshipId}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
relationshipId:
{
Description: The id of the relationship. The id is unique within the digital twin and case sensitive. ,
Required: True ,
}
string ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_UpdateRelationship (removed)
Description :  Updates the properties on a relationship between two digital twins. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 404 (Not Found): There is either no digital twin or relationship with the provided id.
Reference :  Link ¶

⚼ Request

PATCH:  /digitaltwins/{id}/relationships/{relationshipId}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
relationshipId:
{
Description: The id of the relationship. The id is unique within the digital twin and case sensitive. ,
Required: True ,
}
string ,
patchDocument:
{
Description: JSON Patch description of the update to the relationship properties. ,
Required: False ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
etag:
{
Description: Weak Etag. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_ListRelationships (removed)
Description :  Retrieves the relationships from a digital twin. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 404 (Not Found): There is no digital twin with the provided id.
Reference :  Link ¶

⚼ Request

GET:  /digitaltwins/{id}/relationships
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
relationshipName:
{
Description: The name of the relationship. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The relationship objects. ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: A URI to retrieve the next page of objects. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_ListIncomingRelationships (removed)
Description :  Retrieves all incoming relationship for a digital twin. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 404 (Not Found): There is no digital twin with the provided id.
Reference :  Link ¶

⚼ Request

GET:  /digitaltwins/{id}/incomingrelationships
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
$relationshipId:
{
Description: A user-provided string representing the id of this relationship, unique in the context of the source digital twin, i.e. sourceId + relationshipId is unique in the context of the service. ,
Required: False ,
}
string ,
$sourceId:
{
Description: The id of the source digital twin. ,
Required: False ,
}
string ,
$relationshipName:
{
Description: The name of the relationship. ,
Required: False ,
}
string ,
$relationshipLink:
{
Description: Link to the relationship, to be used for deletion. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: A URI to retrieve the next page of objects. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_SendTelemetry (removed)
Description :  Sends telemetry on behalf of a digital twin. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 404 (Not Found): There is no digital twin with the provided id.
Reference :  Link ¶

⚼ Request

POST:  /digitaltwins/{id}/telemetry
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
telemetry:
{
Description: The telemetry measurements to send from the digital twin. ,
Required: True ,
}
object ,
dt-id:
{
Description: A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages. ,
Required: True ,
}
string ,
dt-timestamp:
{
Description: An RFC 3339 timestamp that identifies the time the telemetry was measured. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_SendComponentTelemetry (removed)
Description :  Sends telemetry on behalf of a component in a digital twin. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 404 (Not Found): There is either no digital twin with the provided id or the component path is invalid.
Reference :  Link ¶

⚼ Request

POST:  /digitaltwins/{id}/components/{componentPath}/telemetry
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
componentPath:
{
Description: The name of the DTDL component. ,
Required: True ,
}
string ,
telemetry:
{
Description: The telemetry measurements to send from the digital twin's component. ,
Required: True ,
}
object ,
dt-id:
{
Description: A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages. ,
Required: True ,
}
string ,
dt-timestamp:
{
Description: An RFC 3339 timestamp that identifies the time the telemetry was measured. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_GetComponent (removed)
Description :  Retrieves a component from a digital twin. Status codes: 200 (OK): Success. 404 (Not Found): There is either no digital twin with the provided id or the component path is invalid.
Reference :  Link ¶

⚼ Request

GET:  /digitaltwins/{id}/components/{componentPath}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
componentPath:
{
Description: The name of the DTDL component. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Weak Etag. ,
}
string ,
}
,
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
DigitalTwins_UpdateComponent (removed)
Description :  Updates a component on a digital twin. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid. 404 (Not Found): There is either no digital twin with the provided id or the component path is invalid.
Reference :  Link ¶

⚼ Request

PATCH:  /digitaltwins/{id}/components/{componentPath}
{
id:
{
Description: The id of the digital twin. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
componentPath:
{
Description: The name of the DTDL component. ,
Required: True ,
}
string ,
patchDocument:
{
Description: An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove. ,
Required: False ,
}
object ,
If-Match:
{
Description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
etag:
{
Description: Weak Etag. ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
EventRoutes_List (removed)
Description :  Retrieves all event routes. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid.
Reference :  Link ¶

⚼ Request

GET:  /eventroutes
{
x-ms-max-item-count:
{
Description: The maximum number of items to retrieve per request. The server may choose to return less than the requested max. ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EventRoute objects. ,
Required: False ,
}
[
{
id:
{
Description: The id of the event route. ,
Required: False ,
}
string ,
endpointName:
{
Description: The name of the endpoint this event route is bound to. ,
Required: True ,
}
string ,
filter:
{
Description: An expression which describes the events which are routed to the endpoint. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: A URI to retrieve the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
EventRoutes_GetById (removed)
Description :  Retrieves an event route. Status codes: 200 (OK): Success. 404 (Not Found): There is no event route with the provided id.
Reference :  Link ¶

⚼ Request

GET:  /eventroutes/{id}
{
id:
{
Description: The id for an event route. The id is unique within event routes and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the event route. ,
Required: False ,
}
string ,
endpointName:
{
Description: The name of the endpoint this event route is bound to. ,
Required: True ,
}
string ,
filter:
{
Description: An expression which describes the events which are routed to the endpoint. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
EventRoutes_Add (removed)
Description :  Adds or replaces an event route. Status codes: 200 (OK): Success. 400 (Bad Request): The request is invalid.
Reference :  Link ¶

⚼ Request

PUT:  /eventroutes/{id}
{
id:
{
Description: The id for an event route. The id is unique within event routes and case sensitive. ,
Required: True ,
}
string ,
eventRoute:
{
Description: The event route data ,
Required: False ,
}
{
id:
{
Description: The id of the event route. ,
Required: False ,
}
string ,
endpointName:
{
Description: The name of the endpoint this event route is bound to. ,
Required: True ,
}
string ,
filter:
{
Description: An expression which describes the events which are routed to the endpoint. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
EventRoutes_Delete (removed)
Description :  Deletes an event route. Status codes: 200 (OK): Success. 404 (Not Found): There is no event route with the provided id.
Reference :  Link ¶

⚼ Request

DELETE:  /eventroutes/{id}
{
id:
{
Description: The id for an event route. The id is unique within event routes and case sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}