Azure Digital Twins API (preview:2023-02-27)

2025/10/23 • 29 new methods

DigitalTwinModels_Add (new)
Description :  Uploads one or more models. When any error occurs, no models are uploaded. Status codes: * 201 Created * 400 Bad Request * DTDLParserError - The models provided are not valid DTDL. * InvalidArgument - The model id is invalid. * LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached. * ModelVersionNotSupported - The version of DTDL used is not supported. * 409 Conflict * ModelAlreadyExists - The model provided already exists.
Reference :  Link ¶

⚼ Request

POST:  /models
{
models:
{
Description: An array of models to add. ,
Required: True ,
}
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: True ,
}
{
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 (new)
Description :  Retrieves model metadata and, optionally, model definitions. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The model id is invalid. * LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached. * 404 Not Found * ModelNotFound - The model was not found.
Reference :  Link ¶

⚼ Request

GET:  /models
{
dependenciesFor:
{
Description: If specified, only return the set of the specified models along with their dependencies. 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 ,
max-items-per-page:
{
Description: The maximum number of items to retrieve per request. The server may choose to return less than the requested number. ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DigitalTwinsModelData objects. ,
Required: True ,
}
[
{
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: True ,
}
{
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 (new)
Description :  Retrieves model metadata and optionally the model definition. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The model id is invalid. * MissingArgument - The model id was not provided. * 404 Not Found * ModelNotFound - The model was not found.
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: True ,
}
{
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 (new)
Description :  Updates the metadata for a model. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The model id is invalid. * JsonPatchInvalid - The JSON Patch provided is invalid. * MissingArgument - The model id was not provided. * 404 Not Found * ModelNotFound - The model was not found. * 409 Conflict * ModelReferencesNotDecommissioned - The model refers to models that are not decommissioned.
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: True ,
}
{
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 (new)
Description :  Deletes a model. A model can only be deleted if no other models reference it. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The model id is invalid. * MissingArgument - The model id was not provided. * 404 Not Found * ModelNotFound - The model was not found. * 409 Conflict * ModelReferencesNotDeleted - The model refers to models that are not 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: True ,
}
{
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 (new)
Description :  Executes a query that allows traversing relationships and filtering by property values. Status codes: * 200 OK * 400 Bad Request * BadRequest - The continuation token is invalid. * SqlQueryError - The query contains some errors. * TimeoutError - The query execution timed out after 60 seconds. Try simplifying the query or adding conditions to reduce the result size. * 429 Too Many Requests * QuotaReachedError - The maximum query rate limit has been reached.
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 ,
}
,
max-items-per-page:
{
Description: The maximum number of items to retrieve per request. The server may choose to return less than the requested number. ,
Required: False ,
}
integer ,
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. ,
}
{
value:
{
Description: The query results. ,
Required: True ,
}
[
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: True ,
}
{
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 (new)
Description :  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.
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:
{
Description: Digital twin ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  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.
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:
{
Description: Digital twin ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  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.
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: True ,
}
{
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 (new)
Description :  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.
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 (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  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.
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:
{
Description: Digital twin relationship ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  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 - The digital twin target of the relationship was not found. * 412 Precondition Failed * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.
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: 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:
{
Description: Digital twin relationship ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  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.
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: True ,
}
{
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 (new)
Description :  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 relationship was not found. * 409 Conflict * RelationshipAlreadyExists - The relationship already exists. * 412 Precondition Failed * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.
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: 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 (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  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.
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: True ,
}
[
object ,
]
,
nextLink:
{
Description: A URI to retrieve the next page of objects. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  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.
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: True ,
}
[
{
$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: True ,
}
{
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 (new)
Description :  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.
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 ,
Message-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 ,
Telemetry-Source-Time:
{
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: True ,
}
{
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 (new)
Description :  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.
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 ,
Message-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 ,
Telemetry-Source-Time:
{
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: True ,
}
{
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 (new)
Description :  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.
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:
{
Description: Digital twin component ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  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-None-Match) failed.
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: 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 (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  Retrieves all event routes. Status codes: * 200 OK
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The EventRoute objects. ,
Required: True ,
}
[
{
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: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: A URI to retrieve the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  Retrieves an event route. Status codes: * 200 OK * 404 Not Found * EventRouteNotFound - The event route was not found.
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: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  Adds or replaces an event route. Status codes: * 204 No Content * 400 Bad Request * EventRouteEndpointInvalid - The endpoint provided does not exist or is not active. * EventRouteFilterInvalid - The event route filter is invalid. * EventRouteIdInvalid - The event route id is invalid. * LimitExceeded - The maximum number of event routes allowed has been reached.
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: True ,
}
{
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: True ,
}
string ,
}
,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 (new)
Description :  Deletes an event route. Status codes: * 204 No Content * 404 Not Found * EventRouteNotFound - The event route was not found.
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: True ,
}
{
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 ,
}
,
}
,
}
ImportJobs_List (new)
Description :  Retrieves all import jobs. Status codes: * 200 OK
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of import job objects. ,
Required: True ,
}
[
{
id:
{
Description: The identifier of the import job. ,
Required: False ,
}
string ,
inputBlobUri:
{
Description: The path to the input Azure storage blob that contains file(s) describing the operations to perform in the job. ,
Required: True ,
}
string ,
outputBlobUri:
{
Description: The path to the output Azure storage blob that will contain the errors and progress logs of import job. ,
Required: True ,
}
string ,
status:
{
Description: Status of the job. ,
Enum:
{
notstarted: No description available. ,
running: No description available. ,
failed: No description available. ,
succeeded: No description available. ,
cancelling: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: Start time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Last time service performed any action from the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
finishedDateTime:
{
Description: End time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
purgeDateTime:
{
Description: Time at which job will be purged by the service from the system. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details of the error(s) that occurred executing the import job. ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: A URI to retrieve the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 ,
}
,
}
,
}
ImportJobs_Add (new)
Description :  Creates an import job. Status codes: * 201 Created * 400 Bad Request * JobLimitReached - The maximum number of import jobs allowed has been reached. * ValidationFailed - The import job request is not valid.
Reference :  Link ¶

⚼ Request

PUT:  /jobs/imports/{id}
{
id:
{
Description: The id for the import job. The id is unique within the service and case sensitive. ,
Required: True ,
}
string ,
importJob:
{
Description: The import job being added. ,
Required: True ,
}
{
id:
{
Description: The identifier of the import job. ,
Required: False ,
}
string ,
inputBlobUri:
{
Description: The path to the input Azure storage blob that contains file(s) describing the operations to perform in the job. ,
Required: True ,
}
string ,
outputBlobUri:
{
Description: The path to the output Azure storage blob that will contain the errors and progress logs of import job. ,
Required: True ,
}
string ,
status:
{
Description: Status of the job. ,
Enum:
{
notstarted: No description available. ,
running: No description available. ,
failed: No description available. ,
succeeded: No description available. ,
cancelling: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: Start time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Last time service performed any action from the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
finishedDateTime:
{
Description: End time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
purgeDateTime:
{
Description: Time at which job will be purged by the service from the system. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details of the error(s) that occurred executing the import job. ,
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 ,
}
,
}
,
}
,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: The identifier of the import job. ,
Required: False ,
}
string ,
inputBlobUri:
{
Description: The path to the input Azure storage blob that contains file(s) describing the operations to perform in the job. ,
Required: True ,
}
string ,
outputBlobUri:
{
Description: The path to the output Azure storage blob that will contain the errors and progress logs of import job. ,
Required: True ,
}
string ,
status:
{
Description: Status of the job. ,
Enum:
{
notstarted: No description available. ,
running: No description available. ,
failed: No description available. ,
succeeded: No description available. ,
cancelling: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: Start time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Last time service performed any action from the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
finishedDateTime:
{
Description: End time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
purgeDateTime:
{
Description: Time at which job will be purged by the service from the system. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details of the error(s) that occurred executing the import job. ,
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 ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 ,
}
,
}
,
}
ImportJobs_GetById (new)
Description :  Retrieves an import job. Status codes: * 200 OK * 404 Not Found * ImportJobNotFound - The import job was not found.
Reference :  Link ¶

⚼ Request

GET:  /jobs/imports/{id}
{
id:
{
Description: The id for the import job. 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)

{
id:
{
Description: The identifier of the import job. ,
Required: False ,
}
string ,
inputBlobUri:
{
Description: The path to the input Azure storage blob that contains file(s) describing the operations to perform in the job. ,
Required: True ,
}
string ,
outputBlobUri:
{
Description: The path to the output Azure storage blob that will contain the errors and progress logs of import job. ,
Required: True ,
}
string ,
status:
{
Description: Status of the job. ,
Enum:
{
notstarted: No description available. ,
running: No description available. ,
failed: No description available. ,
succeeded: No description available. ,
cancelling: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: Start time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Last time service performed any action from the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
finishedDateTime:
{
Description: End time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
purgeDateTime:
{
Description: Time at which job will be purged by the service from the system. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details of the error(s) that occurred executing the import job. ,
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 ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 ,
}
,
}
,
}
ImportJobs_Delete (new)
Description :  Deletes an import job. Status codes: * 204 No Content * 400 Bad Request * ValidationFailed - The import job request is not valid.
Reference :  Link ¶

⚼ Request

DELETE:  /jobs/imports/{id}
{
id:
{
Description: The id for the import job. The id is unique within the service 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: True ,
}
{
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 ,
}
,
}
,
}
ImportJobs_Cancel (new)
Description :  Cancels an import job. Status codes: * 200 Request Accepted * 400 Bad Request * ValidationFailed - The import job request is not valid.
Reference :  Link ¶

⚼ Request

POST:  /jobs/imports/{id}/cancel
{
id:
{
Description: The id for the import job. 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)

{
id:
{
Description: The identifier of the import job. ,
Required: False ,
}
string ,
inputBlobUri:
{
Description: The path to the input Azure storage blob that contains file(s) describing the operations to perform in the job. ,
Required: True ,
}
string ,
outputBlobUri:
{
Description: The path to the output Azure storage blob that will contain the errors and progress logs of import job. ,
Required: True ,
}
string ,
status:
{
Description: Status of the job. ,
Enum:
{
notstarted: No description available. ,
running: No description available. ,
failed: No description available. ,
succeeded: No description available. ,
cancelling: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: Start time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Last time service performed any action from the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
finishedDateTime:
{
Description: End time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
purgeDateTime:
{
Description: Time at which job will be purged by the service from the system. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details of the error(s) that occurred executing the import job. ,
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 ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
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 ,
}
,
}
,
}