Sign in

v7

latestSwagger 2.02026-07-13322074.5 KB
Jobs

Initiates a job which deletes all models, twins, and relationships on the instance. Does not delete any other types of entities. Status codes:

  • 202 Created
  • 400 Bad Request
    • JobLimitReached - The maximum number of delete jobs allowed has been reached.
    • ValidationFailed - Operation-Id already exists.
post/jobs/deletions

Query parameters

api-versionstring required

The requested API version.

timeoutInMinutesinteger

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.

Headers

operation-idstring

ID for the operation's status monitor. The ID is generated if header was not passed by the client.

Response

Job Accepted

idstring

The identifier of the delete job.

status'notstarted' | 'running' | 'failed' | 'succeeded'

Status of the job.

createdDateTimestring date-time

Start time of the job. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

finishedDateTimestring date-time

End time of the job. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

purgeDateTimestring date-time

Time at which job will be purged by the service from the system. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.