{ "swagger": "2.0", "info": { "version": "2023-10-31", "title": "Azure Digital Twins API", "description": "A service for managing and querying digital twins and digital twin models." }, "host": "digitaltwins-hostname", "schemes": [ "https" ], "produces": [ "application/json" ], "consumes": [ "application/json" ], "paths": { "/models": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "post": { "tags": [ "Models" ], "description": "Uploads one or more models. When any error occurs, no models are uploaded.\nStatus codes:\n* 201 Created\n* 400 Bad Request\n * DTDLParserError - The models provided are not valid DTDL.\n * InvalidArgument - The model id is invalid.\n * LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached.\n * ModelVersionNotSupported - The version of DTDL used is not supported.\n* 409 Conflict\n * ModelAlreadyExists - The model provided already exists.", "operationId": "DigitalTwinModels_Add", "x-ms-examples": { "Add models": { "$ref": "./examples/ModelAdd.json" } }, "parameters": [ { "name": "models", "in": "body", "description": "An array of models to add.", "required": true, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "object" } } }, { "$ref": "#/parameters/api-version" } ], "responses": { "201": { "description": "Success", "schema": { "$ref": "#/definitions/NonPagedDigitalTwinsModelDataCollection" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "Models" ], "description": "Retrieves model metadata and, optionally, model definitions.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached.\n* 404 Not Found\n * ModelNotFound - The model was not found.", "x-ms-pageable": { "nextLinkName": "nextLink" }, "operationId": "DigitalTwinModels_List", "x-ms-examples": { "List models": { "$ref": "./examples/ModelsGet.json" }, "List models (include dependencies and definitions)": { "$ref": "./examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json" } }, "parameters": [ { "name": "dependenciesFor", "in": "query", "description": "If specified, only return the set of the specified models along with their dependencies. If omitted, all models are retrieved.", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } }, { "$ref": "#/parameters/includeModelDefinition" }, { "$ref": "#/parameters/max-items-per-page" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PagedDigitalTwinsModelDataCollection" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/models/{id}": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "get": { "tags": [ "Models" ], "description": "Retrieves model metadata and optionally the model definition.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * MissingArgument - The model id was not provided.\n* 404 Not Found\n * ModelNotFound - The model was not found.", "operationId": "DigitalTwinModels_GetById", "x-ms-examples": { "Get a model by id": { "$ref": "./examples/ModelGetById.json" }, "Get a model by id (with definition)": { "$ref": "./examples/ModelGetByIdWithIncludeModelDefinition.json" } }, "parameters": [ { "$ref": "#/parameters/modelId" }, { "$ref": "#/parameters/includeModelDefinition" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DigitalTwinsModelData" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "Models" ], "description": "Updates the metadata for a model.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * MissingArgument - The model id was not provided.\n* 404 Not Found\n * ModelNotFound - The model was not found.\n* 409 Conflict\n * ModelReferencesNotDecommissioned - The model refers to models that are not decommissioned.", "operationId": "DigitalTwinModels_Update", "consumes": [ "application/json-patch+json" ], "x-ms-examples": { "Decommission a model": { "$ref": "./examples/ModelUpdateDecommissioned.json" } }, "parameters": [ { "$ref": "#/parameters/modelId" }, { "name": "updateModel", "description": "An update specification described by JSON Patch. Only the decommissioned property can be replaced.", "in": "body", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "Models" ], "operationId": "DigitalTwinModels_Delete", "description": "Deletes a model. A model can only be deleted if no other models reference it.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * MissingArgument - The model id was not provided.\n* 404 Not Found\n * ModelNotFound - The model was not found.\n* 409 Conflict\n * ModelReferencesNotDeleted - The model refers to models that are not deleted.", "x-ms-examples": { "Delete a model": { "$ref": "./examples/DeleteModel.json" } }, "parameters": [ { "$ref": "#/parameters/modelId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/query": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "post": { "tags": [ "Query" ], "operationId": "Query_QueryTwins", "description": "Executes a query that allows traversing relationships and filtering by property values.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * BadRequest - The continuation token is invalid.\n * SqlQueryError - The query contains some errors.\n * TimeoutError - The query execution timed out after 60 seconds. Try simplifying the query or adding conditions to reduce the result size.\n * 429 Too Many Requests\n * QuotaReachedError - The maximum query rate limit has been reached.", "x-ms-examples": { "Query for digital twins": { "$ref": "./examples/QueryFirstPage.json" }, "Retrieve paged query results": { "$ref": "./examples/QueryNextPage.json" }, "Query for digital twins through a relationship": { "$ref": "./examples/QueryJoin.json" } }, "parameters": [ { "name": "querySpecification", "in": "body", "description": "The query specification to execute.", "required": true, "schema": { "$ref": "#/definitions/QuerySpecification" } }, { "$ref": "#/parameters/max-items-per-page" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/QueryResult" }, "headers": { "query-charge": { "description": "The query charge.", "type": "number" } } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/digitaltwins/{id}": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "get": { "tags": [ "Twins" ], "operationId": "DigitalTwins_GetById", "description": "Retrieves a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.", "x-ms-examples": { "Get a digital twin by id": { "$ref": "./examples/GetTwin.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DigitalTwin" }, "headers": { "ETag": { "description": "Weak Etag.", "type": "string" } } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "Twins" ], "operationId": "DigitalTwins_Add", "description": "Adds or replaces a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id or payload is invalid.\n * ModelDecommissioned - The model for the digital twin is decommissioned.\n * TwinLimitReached - The maximum number of digital twins allowed has been reached.\n * ValidationFailed - The digital twin payload is not valid.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.", "x-ms-examples": { "Add a digital twin": { "$ref": "./examples/PutTwinBasicExample.json" }, "Add a digital twin (with properties and components)": { "$ref": "./examples/PutTwinAdvancedExample.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "name": "twin", "description": "The digital twin instance being added. If provided, the $dtId property is ignored.", "in": "body", "required": true, "schema": { "type": "object" } }, { "$ref": "#/parameters/if-none-match-star" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DigitalTwin" }, "headers": { "ETag": { "description": "Weak Etag.", "type": "string" } } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "Twins" ], "operationId": "DigitalTwins_Delete", "description": "Deletes a digital twin. All relationships referencing the digital twin must already be deleted.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n * RelationshipsNotDeleted - The digital twin contains relationships.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.", "x-ms-examples": { "Delete a digital twin": { "$ref": "./examples/DeleteTwin.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "$ref": "#/parameters/if-match" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "Twins" ], "operationId": "DigitalTwins_Update", "description": "Updates a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or payload is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * ValidationFailed - Applying the patch results in an invalid digital twin.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.", "consumes": [ "application/json-patch+json" ], "x-ms-examples": { "Update a digital twin": { "$ref": "./examples/PatchTwinBasicExample.json" }, "Update a digital twin (multiple updates)": { "$ref": "./examples/PatchTwinAdvancedExample.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "name": "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.", "in": "body", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "$ref": "#/parameters/if-match" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success", "headers": { "ETag": { "description": "Weak Etag.", "type": "string" } } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/digitaltwins/{id}/relationships/{relationshipId}": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "get": { "tags": [ "Twins" ], "operationId": "DigitalTwins_GetRelationshipById", "description": "Retrieves a relationship between two digital twins.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id or relationship id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * RelationshipNotFound - The relationship was not found.", "x-ms-examples": { "Get a relationship by id": { "$ref": "./examples/GetRelationshipById.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "$ref": "#/parameters/relationshipId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Relationship" }, "headers": { "ETag": { "description": "Weak Etag.", "type": "string" } } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "Twins" ], "operationId": "DigitalTwins_AddRelationship", "description": "Adds a relationship between two digital twins.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id, relationship id, or payload is invalid.\n * InvalidRelationship - The relationship is invalid.\n * OperationNotAllowed - The relationship cannot connect to the same digital twin.\n * ValidationFailed - The relationship content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * TargetTwinNotFound - The digital twin target of the relationship was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.", "x-ms-examples": { "Create a relationship": { "$ref": "./examples/CreateRelationshipBasicExample.json" }, "Create a relationship (with properties)": { "$ref": "./examples/CreateRelationshipAdvancedExample.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "$ref": "#/parameters/relationshipId" }, { "name": "relationship", "in": "body", "description": "The data for the relationship.", "required": true, "schema": { "type": "object" } }, { "$ref": "#/parameters/if-none-match-star" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Relationship" }, "headers": { "ETag": { "description": "Weak Etag.", "type": "string" } } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "Twins" ], "operationId": "DigitalTwins_DeleteRelationship", "description": "Deletes a relationship between two digital twins.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or relationship id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * RelationshipNotFound - The relationship was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.", "x-ms-examples": { "Delete a relationship": { "$ref": "./examples/DeleteRelationship.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "$ref": "#/parameters/relationshipId" }, { "$ref": "#/parameters/if-match" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "Twins" ], "consumes": [ "application/json-patch+json" ], "operationId": "DigitalTwins_UpdateRelationship", "description": "Updates the properties on a relationship between two digital twins.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or relationship id is invalid.\n * InvalidRelationship - The relationship is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * ValidationFailed - The relationship content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * RelationshipNotFound - The relationship was not found.\n* 409 Conflict\n * RelationshipAlreadyExists - The relationship already exists.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.", "x-ms-examples": { "Update relationship properties": { "$ref": "./examples/PatchRelationshipBasicExample.json" }, "Update relationship properties (multiple updates)": { "$ref": "./examples/PatchRelationshipAdvancedExample.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "$ref": "#/parameters/relationshipId" }, { "name": "patchDocument", "description": "JSON Patch description of the update to the relationship properties.", "in": "body", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "$ref": "#/parameters/if-match" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success", "headers": { "ETag": { "description": "Weak Etag.", "type": "string" } } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/digitaltwins/{id}/relationships": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "get": { "tags": [ "Twins" ], "operationId": "DigitalTwins_ListRelationships", "description": "Retrieves the relationships from a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.", "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List relationships": { "$ref": "./examples/GetRelationship.json" }, "List relationships by name": { "$ref": "./examples/GetRelationshipByRelationshipName.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "name": "relationshipName", "description": "The name of the relationship.", "in": "query", "required": false, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/RelationshipCollection" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/digitaltwins/{id}/incomingrelationships": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "get": { "tags": [ "Twins" ], "operationId": "DigitalTwins_ListIncomingRelationships", "description": "Retrieves all incoming relationship for a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.", "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List incoming relationships": { "$ref": "./examples/GetIncomingRelationship.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/IncomingRelationshipCollection" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/digitaltwins/{id}/telemetry": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "post": { "tags": [ "Twins" ], "operationId": "DigitalTwins_SendTelemetry", "description": "Sends telemetry on behalf of a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or message id is invalid.\n * ValidationFailed - The telemetry content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.", "x-ms-examples": { "Send telemetry": { "$ref": "./examples/SendTelemetry.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "name": "telemetry", "in": "body", "description": "The telemetry measurements to send from the digital twin.", "required": true, "schema": { "type": "object" } }, { "name": "Message-Id", "in": "header", "description": "A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages.", "required": true, "type": "string" }, { "name": "Telemetry-Source-Time", "in": "header", "description": "An RFC 3339 timestamp that identifies the time the telemetry was measured.", "required": false, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/digitaltwins/{id}/components/{componentPath}/telemetry": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "post": { "tags": [ "Twins" ], "operationId": "DigitalTwins_SendComponentTelemetry", "description": "Sends telemetry on behalf of a component in a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id, message id, or component path is invalid.\n * ValidationFailed - The telemetry content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * ComponentNotFound - The component path was not found.", "x-ms-examples": { "Send telemetry in a component": { "$ref": "./examples/SendTelemetryFromComponent.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "$ref": "#/parameters/componentPath" }, { "name": "telemetry", "in": "body", "description": "The telemetry measurements to send from the digital twin's component.", "required": true, "schema": { "type": "object" } }, { "name": "Message-Id", "in": "header", "description": "A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages.", "required": true, "type": "string" }, { "name": "Telemetry-Source-Time", "in": "header", "description": "An RFC 3339 timestamp that identifies the time the telemetry was measured.", "required": false, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/digitaltwins/{id}/components/{componentPath}": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "get": { "tags": [ "Twins" ], "operationId": "DigitalTwins_GetComponent", "description": "Retrieves a component from a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id or component path is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * ComponentNotFound - The component path was not found.", "x-ms-examples": { "Get a component in a digital twin": { "$ref": "./examples/GetComponent.json" } }, "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "$ref": "#/parameters/componentPath" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Component" }, "headers": { "ETag": { "description": "Weak Etag.", "type": "string" } } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "Twins" ], "operationId": "DigitalTwins_UpdateComponent", "description": "Updates a component on a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id, component path, or payload is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * ValidationFailed - Applying the patch results in an invalid digital twin.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.", "x-ms-examples": { "Update a component in a digital twin": { "$ref": "./examples/PatchComponentBasicExample.json" }, "Update a component in a digital twin (multiple updates)": { "$ref": "./examples/PatchComponentAdvancedExample.json" } }, "consumes": [ "application/json-patch+json" ], "parameters": [ { "$ref": "#/parameters/digitalTwinId" }, { "$ref": "#/parameters/componentPath" }, { "name": "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.", "in": "body", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "$ref": "#/parameters/if-match" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success", "headers": { "ETag": { "description": "Weak Etag.", "type": "string" } } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/eventroutes": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "get": { "tags": [ "EventRoutes" ], "description": "Retrieves all event routes.\nStatus codes:\n* 200 OK", "operationId": "EventRoutes_List", "x-ms-examples": { "List event routes": { "$ref": "./examples/EventRoutesList.json" } }, "parameters": [ { "$ref": "#/parameters/max-items-per-page" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/EventRouteCollection" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/eventroutes/{id}": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "get": { "tags": [ "EventRoutes" ], "description": "Retrieves an event route.\nStatus codes:\n* 200 OK\n* 404 Not Found\n * EventRouteNotFound - The event route was not found.", "operationId": "EventRoutes_GetById", "x-ms-examples": { "Get an event route by id": { "$ref": "./examples/EventRouteGet.json" } }, "parameters": [ { "$ref": "#/parameters/eventRouteId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/EventRoute" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "EventRoutes" ], "description": "Adds or replaces an event route.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * EventRouteEndpointInvalid - The endpoint provided does not exist or is not active.\n * EventRouteFilterInvalid - The event route filter is invalid.\n * EventRouteIdInvalid - The event route id is invalid.\n * LimitExceeded - The maximum number of event routes allowed has been reached.", "operationId": "EventRoutes_Add", "x-ms-examples": { "Add an event route": { "$ref": "./examples/EventRoutePut.json" }, "Add an event route (with filter)": { "$ref": "./examples/EventRoutePutWithFilter.json" } }, "parameters": [ { "$ref": "#/parameters/eventRouteId" }, { "name": "eventRoute", "description": "The event route data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EventRoute" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "EventRoutes" ], "description": "Deletes an event route.\nStatus codes:\n* 204 No Content\n* 404 Not Found\n * EventRouteNotFound - The event route was not found.", "operationId": "EventRoutes_Delete", "x-ms-examples": { "Delete an event route": { "$ref": "./examples/EventRouteDelete.json" } }, "parameters": [ { "$ref": "#/parameters/eventRouteId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/jobs/imports": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "get": { "tags": [ "Jobs" ], "operationId": "ImportJobs_List", "description": "Retrieves all import jobs.\nStatus codes:\n* 200 OK", "x-ms-examples": { "Get all import jobs": { "$ref": "./examples/ImportJobList.json" } }, "parameters": [ { "$ref": "#/parameters/max-items-per-page" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ImportJobCollection" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/jobs/imports/{id}": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "put": { "tags": [ "Jobs" ], "operationId": "ImportJobs_Add", "description": "Creates an import job.\nStatus codes:\n* 201 Created\n* 400 Bad Request\n * JobLimitReached - The maximum number of import jobs allowed has been reached.\n * ValidationFailed - The import job request is not valid.", "x-ms-examples": { "Add a job": { "$ref": "./examples/ImportJobPut.json" } }, "parameters": [ { "$ref": "#/parameters/importJobId" }, { "name": "importJob", "description": "The import job being added.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ImportJob" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "201": { "description": "Success", "schema": { "$ref": "#/definitions/ImportJob" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "Jobs" ], "operationId": "ImportJobs_GetById", "description": "Retrieves an import job.\nStatus codes:\n* 200 OK\n* 404 Not Found\n * ImportJobNotFound - The import job was not found.", "x-ms-examples": { "Get an import job by id": { "$ref": "./examples/ImportJobGet.json" } }, "parameters": [ { "$ref": "#/parameters/importJobId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ImportJob" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "Jobs" ], "operationId": "ImportJobs_Delete", "description": "Deletes 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.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * ValidationFailed - The import job request is not valid.", "x-ms-examples": { "Delete an import job": { "$ref": "./examples/ImportJobDelete.json" } }, "parameters": [ { "$ref": "#/parameters/importJobId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/jobs/imports/{id}/cancel": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "post": { "tags": [ "Jobs" ], "operationId": "ImportJobs_Cancel", "description": "Cancels 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 cancelled state. Please note that this will leave your instance in an unknown state as there won't be any rollback operation. \nStatus codes:\n* 200 Request Accepted\n* 400 Bad Request\n * ValidationFailed - The import job request is not valid.", "x-ms-examples": { "Cancel a job": { "$ref": "./examples/ImportJobCancel.json" } }, "parameters": [ { "$ref": "#/parameters/importJobId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ImportJob" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/jobs/deletions": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "post": { "tags": [ "Jobs" ], "operationId": "DeleteJobs_Add", "x-ms-long-running-operation": true, "description": "Initiates a job which deletes all models, twins, and relationships on the instance. Does not delete any other types of entities.\nStatus codes:\n* 202 Created\n* 400 Bad Request\n * JobLimitReached - The maximum number of delete jobs allowed has been reached. \n * ValidationFailed - Operation-Id already exists.", "x-ms-examples": { "Add a job": { "$ref": "./examples/DeleteJobPost.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/operation-id" }, { "$ref": "#/parameters/timeoutInMinutes" } ], "responses": { "202": { "description": "Job Accepted", "schema": { "$ref": "#/definitions/DeleteJob" }, "headers": { "Operation-Location": { "type": "string", "description": "The URL to track the status of the long running operation." } } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "Jobs" ], "operationId": "DeleteJobs_List", "description": "Retrieves 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 currently running on the instance.\nStatus codes:\n* 200 OK", "x-ms-examples": { "Get all import jobs": { "$ref": "./examples/DeleteJobList.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/max-items-per-page" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DeleteJobCollection" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/jobs/deletions/{id}": { "parameters": [ { "$ref": "#/parameters/traceparent" }, { "$ref": "#/parameters/tracestate" } ], "get": { "tags": [ "Jobs" ], "operationId": "DeleteJobs_GetById", "description": "Retrieves a delete job.\nStatus codes:\n* 200 OK\n* 404 Not Found\n * DeleteJobNotFound - The delete job was not found.", "x-ms-examples": { "Get an import job by id": { "$ref": "./examples/DeleteJobGet.json" } }, "parameters": [ { "$ref": "#/parameters/deleteJobId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DeleteJob" } }, "default": { "description": "Default response.", "headers": { "x-ms-error-code": { "type": "string", "description": "Error code for specific error that occurred." } }, "schema": { "$ref": "#/definitions/ErrorResponse" } } } } } }, "definitions": { "DigitalTwin": { "description": "Digital twin", "type": "object", "additionalProperties": {} }, "Relationship": { "description": "Digital twin relationship", "type": "object", "additionalProperties": {} }, "Component": { "description": "Digital twin component", "type": "object", "additionalProperties": {} }, "EventRoute": { "description": "A route which directs notification and telemetry events to an endpoint. Endpoints are a destination outside of Azure Digital Twins such as an EventHub.", "type": "object", "required": [ "endpointName", "filter" ], "properties": { "id": { "description": "The id of the event route.", "type": "string", "readOnly": true }, "endpointName": { "description": "The name of the endpoint this event route is bound to.", "type": "string" }, "filter": { "description": "An expression which describes the events which are routed to the endpoint.", "type": "string" } } }, "EventRouteCollection": { "description": "A collection of EventRoute objects.", "type": "object", "required": [ "value" ], "properties": { "value": { "description": "The EventRoute objects.", "type": "array", "items": { "$ref": "#/definitions/EventRoute" } }, "nextLink": { "description": "A URI to retrieve the next page of results.", "type": "string" } } }, "NonPagedDigitalTwinsModelDataCollection": { "description": "A collection of DigitalTwinsModelData objects.", "type": "array", "items": { "$ref": "#/definitions/DigitalTwinsModelData" } }, "PagedDigitalTwinsModelDataCollection": { "description": "A collection of DigitalTwinsModelData objects.", "type": "object", "required": [ "value" ], "properties": { "value": { "description": "The DigitalTwinsModelData objects.", "type": "array", "items": { "$ref": "#/definitions/DigitalTwinsModelData" } }, "nextLink": { "description": "A URI to retrieve the next page of objects.", "type": "string" } } }, "DigitalTwinsModelData": { "description": "A model definition and metadata for that model.", "required": [ "id" ], "type": "object", "properties": { "displayName": { "description": "A language map that contains the localized display names as specified in the model definition.", "type": "object", "additionalProperties": { "type": "string" } }, "description": { "description": "A language map that contains the localized descriptions as specified in the model definition.", "type": "object", "additionalProperties": { "type": "string" } }, "id": { "description": "The id of the model as specified in the model definition.", "type": "string" }, "uploadTime": { "description": "The time the model was uploaded to the service.", "format": "date-time", "type": "string" }, "decommissioned": { "description": "Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins.", "type": "boolean", "default": false }, "model": { "description": "The model definition.", "type": "object" } } }, "RelationshipCollection": { "description": "A collection of relationships which relate digital twins together.", "type": "object", "required": [ "value" ], "properties": { "value": { "description": "The relationship objects.", "type": "array", "items": { "description": "The relationship JSON document.", "type": "object" } }, "nextLink": { "description": "A URI to retrieve the next page of objects.", "type": "string" } } }, "IncomingRelationshipCollection": { "description": "A collection of incoming relationships which relate digital twins together.", "type": "object", "required": [ "value" ], "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IncomingRelationship" } }, "nextLink": { "type": "string", "description": "A URI to retrieve the next page of objects." } } }, "IncomingRelationship": { "type": "object", "description": "An incoming relationship.", "properties": { "$relationshipId": { "type": "string", "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." }, "$sourceId": { "type": "string", "description": "The id of the source digital twin." }, "$relationshipName": { "type": "string", "description": "The name of the relationship." }, "$relationshipLink": { "type": "string", "description": "Link to the relationship, to be used for deletion." } } }, "QuerySpecification": { "description": "A query specification containing either a query statement or a continuation token from a previous query result.", "type": "object", "properties": { "query": { "description": "The query to execute. This value is ignored if a continuation token is provided.", "type": "string" }, "continuationToken": { "description": "A token which is used to retrieve the next set of results from a previous query.", "type": "string" } } }, "QueryResult": { "description": "The results of a query operation and an optional continuation token.", "type": "object", "required": [ "value" ], "properties": { "value": { "description": "The query results.", "type": "array", "items": { "type": "object" } }, "continuationToken": { "description": "A token which can be used to construct a new QuerySpecification to retrieve the next set of results.", "type": "string" } } }, "ImportJob": { "description": "A job which contains a reference to the operations to perform, results, and execution metadata.", "type": "object", "required": [ "inputBlobUri", "outputBlobUri" ], "properties": { "id": { "description": "The identifier of the import job.", "type": "string", "readOnly": true }, "inputBlobUri": { "description": "The path to the input Azure storage blob that contains file(s) describing the operations to perform in the job.", "type": "string" }, "outputBlobUri": { "description": "The path to the output Azure storage blob that will contain the errors and progress logs of import job.", "type": "string" }, "status": { "description": "Status of the job.", "enum": [ "notstarted", "running", "failed", "succeeded", "cancelling", "cancelled" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "status", "modelAsExtensible": true, "modelAsString": false } }, "createdDateTime": { "description": "Start time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "format": "date-time", "readOnly": true }, "lastActionDateTime": { "description": "Last time service performed any action from the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "format": "date-time", "readOnly": true }, "finishedDateTime": { "description": "End time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "format": "date-time", "readOnly": true }, "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`.", "type": "string", "format": "date-time", "readOnly": true }, "error": { "$ref": "#/definitions/Error", "description": "Details of the error(s) that occurred executing the import job." } } }, "ImportJobCollection": { "description": "A collection of import job objects.", "type": "object", "required": [ "value" ], "properties": { "value": { "description": "The list of import job objects.", "type": "array", "items": { "$ref": "#/definitions/ImportJob" } }, "nextLink": { "description": "A URI to retrieve the next page of results.", "type": "string" } } }, "DeleteJob": { "description": "A job which contains a reference to the operations to perform, results, and execution metadata.", "type": "object", "properties": { "id": { "description": "The identifier of the delete job.", "type": "string", "readOnly": true }, "status": { "description": "Status of the job.", "enum": [ "notstarted", "running", "failed", "succeeded" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "delete-job-status", "modelAsExtensible": true, "modelAsString": false } }, "createdDateTime": { "description": "Start time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "format": "date-time", "readOnly": true }, "finishedDateTime": { "description": "End time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "format": "date-time", "readOnly": true }, "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`.", "type": "string", "format": "date-time", "readOnly": true }, "error": { "$ref": "#/definitions/Error", "description": "Details of the error(s) that occurred executing the import job." } } }, "DeleteJobCollection": { "description": "A collection of delete job objects.", "type": "object", "required": [ "value" ], "properties": { "value": { "description": "The list of delete job objects.", "type": "array", "items": { "$ref": "#/definitions/DeleteJob" } }, "nextLink": { "description": "A URI to retrieve the next page of results.", "type": "string" } } }, "ErrorResponse": { "description": "Error response.", "required": [ "error" ], "properties": { "error": { "$ref": "#/definitions/Error", "description": "The error details." } } }, "Error": { "description": "Error definition.", "properties": { "code": { "description": "Service specific error code which serves as the substatus for the HTTP error code.", "type": "string", "readOnly": true }, "message": { "description": "A human-readable representation of the error.", "type": "string", "readOnly": true }, "details": { "description": "Internal error details.", "type": "array", "items": { "$ref": "#/definitions/Error" }, "readOnly": true }, "innererror": { "description": "An object containing more specific information than the current object about the error.", "$ref": "#/definitions/InnerError" } } }, "InnerError": { "description": "A more specific error description than was provided by the containing error.", "properties": { "code": { "description": "A more specific error code than was provided by the containing error.", "type": "string" }, "innererror": { "description": "An object containing more specific information than the current object about the error.", "$ref": "#/definitions/InnerError" } } } }, "securityDefinitions": { "oauth2": { "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0", "type": "oauth2" } }, "parameters": { "eventRouteId": { "name": "id", "in": "path", "required": true, "type": "string", "description": "The id for an event route. The id is unique within event routes and case sensitive.", "x-ms-parameter-location": "method" }, "includeModelDefinition": { "name": "includeModelDefinition", "description": "When true the model definition will be returned as part of the result.", "in": "query", "required": false, "type": "boolean", "default": false, "x-ms-parameter-location": "method" }, "digitalTwinId": { "name": "id", "in": "path", "description": "The id of the digital twin. The id is unique within the service and case sensitive.", "type": "string", "required": true, "x-ms-parameter-location": "method" }, "modelId": { "name": "id", "in": "path", "description": "The id for the model. The id is globally unique and case sensitive.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "relationshipId": { "name": "relationshipId", "description": "The id of the relationship. The id is unique within the digital twin and case sensitive.", "in": "path", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "importJobId": { "name": "id", "in": "path", "description": "The id for the import job. The id is unique within the service and case sensitive.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "deleteJobId": { "name": "id", "in": "path", "description": "The id for the delete job. The id is unique within the service and case sensitive.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "componentPath": { "name": "componentPath", "in": "path", "description": "The name of the DTDL component.", "type": "string", "required": true, "x-ms-parameter-location": "method" }, "api-version": { "name": "api-version", "in": "query", "description": "The requested API version.", "required": true, "type": "string", "minLength": 1 }, "max-items-per-page": { "name": "max-items-per-page", "in": "header", "description": "The maximum number of items to retrieve per request. The server may choose to return less than the requested number.", "required": false, "type": "integer", "x-ms-client-name": "MaxItemsPerPage", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "postfix": "Options" } }, "operation-id": { "name": "operation-id", "in": "header", "description": "ID for the operation's status monitor. The ID is generated if header was not passed by the client.", "required": false, "type": "string" }, "timeoutInMinutes": { "name": "timeoutInMinutes", "in": "query", "description": "Desired timeout for the delete job. Once the specified timeout is reached, service will stop any delete operations triggered by the current delete job that are in progress, and go to a failed state. Please note that this will leave your instance in an unknown state as there won't be any rollback operation.", "required": false, "type": "integer", "format": "int32" }, "if-none-match-star": { "name": "If-None-Match", "in": "header", "description": "Only perform the operation if the entity does not already exist.", "required": false, "type": "string", "enum": [ "*" ], "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "postfix": "Options" } }, "if-match": { "name": "If-Match", "in": "header", "description": "Only perform the operation if the entity's etag matches one of the etags provided or * is provided.", "required": false, "type": "string", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "postfix": "Options" } }, "traceparent": { "name": "traceparent", "in": "header", "description": "Identifies the request in a distributed tracing system.", "required": false, "type": "string", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "postfix": "Options" } }, "tracestate": { "name": "tracestate", "in": "header", "description": "Provides vendor-specific trace identification information and is a companion to traceparent.", "required": false, "type": "string", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "postfix": "Options" } } }, "security": [ { "oauth2": [] } ] }