Azure Digitaltwins
A service for managing and querying digital twins and digital twin models.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
A service for managing and querying digital twins and digital twin models.
Endpoints 32
Models
- GETDigitalTwinModels_List
/models?dependenciesFor=string&includeModelDefinition=false&api-version=stringRetrieves model metadata and, optionally, model definitions. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The model id is invalid. *… - POSTDigitalTwinModels_Add
/models?api-version=stringUploads one or more models. When any error occurs, no models are uploaded. Status codes: * 201 Created * 400 Bad Request * DTDLParserError - The models… - GETDigitalTwinModels_GetById
/models/:id?includeModelDefinition=false&api-version=stringRetrieves model metadata and optionally the model definition. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The model id is invalid. *… - DELETEDigitalTwinModels_Delete
/models/:id?api-version=stringDeletes 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… - PATCHDigitalTwinModels_Update
/models/:id?api-version=stringUpdates the metadata for a model. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The model id is invalid. * JsonPatchInvalid - The JSON…
Query
- POSTQuery_QueryTwins
/query?api-version=stringExecutes a query that allows traversing relationships and filtering by property values. Status codes: * 200 OK * 400 Bad Request * BadRequest - The…
Twins
- GETDigitalTwins_GetById
/digitaltwins/:id?api-version=stringRetrieves a digital twin. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id is invalid. * 404 Not Found * DigitalTwinNotFound -… - PUTDigitalTwins_Add
/digitaltwins/:id?api-version=stringAdds or replaces a digital twin. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id or payload is invalid. * ModelDecommissioned… - DELETEDigitalTwins_Delete
/digitaltwins/:id?api-version=stringDeletes a digital twin. All relationships referencing the digital twin must already be deleted. Status codes: * 204 No Content * 400 Bad Request *… - PATCHDigitalTwins_Update
/digitaltwins/:id?api-version=stringUpdates a digital twin. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The digital twin id or payload is invalid. * JsonPatchInvalid -… - GETDigitalTwins_GetRelationshipById
/digitaltwins/:id/relationships/:relationshipId?api-version=stringRetrieves a relationship between two digital twins. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id or relationship id is… - PUTDigitalTwins_AddRelationship
/digitaltwins/:id/relationships/:relationshipId?api-version=stringAdds a relationship between two digital twins. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id, relationship id, or payload… - DELETEDigitalTwins_DeleteRelationship
/digitaltwins/:id/relationships/:relationshipId?api-version=stringDeletes a relationship between two digital twins. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The digital twin id or relationship id… - PATCHDigitalTwins_UpdateRelationship
/digitaltwins/:id/relationships/:relationshipId?api-version=stringUpdates the properties on a relationship between two digital twins. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The digital twin id… - GETDigitalTwins_ListRelationships
/digitaltwins/:id/relationships?relationshipName=string&api-version=stringRetrieves the relationships from a digital twin. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id is invalid. * 404 Not Found… - GETDigitalTwins_ListIncomingRelationships
/digitaltwins/:id/incomingrelationships?api-version=stringRetrieves all incoming relationship for a digital twin. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id is invalid. * 404 Not… - POSTDigitalTwins_SendTelemetry
/digitaltwins/:id/telemetry?api-version=stringSends telemetry on behalf of a digital twin. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The digital twin id or message id is… - POSTDigitalTwins_SendComponentTelemetry
/digitaltwins/:id/components/:componentPath/telemetry?api-version=stringSends telemetry on behalf of a component in a digital twin. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The digital twin id, message… - GETDigitalTwins_GetComponent
/digitaltwins/:id/components/:componentPath?api-version=stringRetrieves a component from a digital twin. Status codes: * 200 OK * 400 Bad Request * InvalidArgument - The digital twin id or component path is invalid. *… - PATCHDigitalTwins_UpdateComponent
/digitaltwins/:id/components/:componentPath?api-version=stringUpdates a component on a digital twin. Status codes: * 204 No Content * 400 Bad Request * InvalidArgument - The digital twin id, component path, or payload is…
EventRoutes
- GETEventRoutes_List
/eventroutes?api-version=stringRetrieves all event routes. Status codes: * 200 OK - GETEventRoutes_GetById
/eventroutes/:id?api-version=stringRetrieves an event route. Status codes: * 200 OK * 404 Not Found * EventRouteNotFound - The event route was not found. - PUTEventRoutes_Add
/eventroutes/:id?api-version=stringAdds or replaces an event route. Status codes: * 204 No Content * 400 Bad Request * EventRouteEndpointInvalid - The endpoint provided does not exist or is not… - DELETEEventRoutes_Delete
/eventroutes/:id?api-version=stringDeletes an event route. Status codes: * 204 No Content * 404 Not Found * EventRouteNotFound - The event route was not found.
Jobs
- GETImportJobs_List
/jobs/imports?api-version=stringRetrieves all import jobs. Status codes: * 200 OK - GETImportJobs_GetById
/jobs/imports/:id?api-version=stringRetrieves an import job. Status codes: * 200 OK * 404 Not Found * ImportJobNotFound - The import job was not found. - PUTImportJobs_Add
/jobs/imports/:id?api-version=stringCreates an import job. Status codes: * 201 Created * 400 Bad Request * JobLimitReached - The maximum number of import jobs allowed has been reached. *… - DELETEImportJobs_Delete
/jobs/imports/:id?api-version=stringDeletes an import job. This is simply used to remove a job id, so it may be reused later. It can not be used to stop entities from being imported. Status… - POSTImportJobs_Cancel
/jobs/imports/:id/cancel?api-version=stringCancels an import job that is currently running. Service will stop any import operations triggered by the current import job that are in progress, and go to a… - GETDeleteJobs_List
/jobs/deletions?api-version=stringRetrieves all deletion jobs. This may be useful to find a delete job that was previously requested, or to view a history of delete jobs that have run or are… - POSTDeleteJobs_Add
/jobs/deletions?api-version=string&timeoutInMinutes=0Initiates a job which deletes all models, twins, and relationships on the instance. Does not delete any other types of entities. Status codes: * 202 Created *… - GETDeleteJobs_GetById
/jobs/deletions/:id?api-version=stringRetrieves a delete job. Status codes: * 200 OK * 404 Not Found * DeleteJobNotFound - The delete job was not found.
API details
- Base URL
https://digitaltwins-hostname- Authentication
- OAuth 2.0 (implicit flow)
- Operations
- 32 operations on 17 pathsGET 13POST 6DELETE 5PUT 4PATCH 4
- Main resources
- Twins 14Jobs 8Models 5EventRoutes 4Query 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
2023-10-31 - Links
- OpenAPI document
How to test the Azure Digitaltwins in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Digitaltwins collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “DigitalTwinModels_List” (GET /models?dependenciesFor=string&includeModelDefinition=false&api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Digitaltwins?
A service for managing and querying digital twins and digital twin models. It is listed under Developer tools and has 32 endpoints.
Who publishes the Azure Digitaltwins?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Azure Digitaltwins?
Requests go to https://digitaltwins-hostname. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Digitaltwins?
With OAuth 2.0 (implicit flow).
How many endpoints does the Azure Digitaltwins have?
32 operations on 17 paths (13 GET, 6 POST, 5 DELETE, 4 PUT, 4 PATCH). The largest groups are Twins, Jobs, Models, EventRoutes.
Is forking the Azure Digitaltwins free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.