Share via

Jobs - DeleteJobs GetById

Service:
Reference
API Version:
2023-10-31

Retrieves a delete job. Status codes:

  • 200 OK
  • 404 Not Found
    • DeleteJobNotFound - The delete job was not found.
GET https://digitaltwins-hostname/jobs/deletions/{id}?api-version=2023-10-31

URI Parameters

Name In Required Type Description
id
 path True

string

The id for the delete job. The id is unique within the service and case sensitive.
api-version
 query True

string

The requested API version.

Request Header

Name Required Type Description
traceparent

string

Identifies the request in a distributed tracing system.
tracestate

string

Provides vendor-specific trace identification information and is a companion to traceparent.

Responses

Name Type Description
200 OK

DeleteJob

Success
Other Status Codes

ErrorResponse

Default response.

Headers

x-ms-error-code: string

Security

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Examples

Get an import job by id

Sample request

GET https://digitaltwins-hostname/jobs/deletions/deletejob1?api-version=2023-10-31

Sample response

Status code:
200 
{
  "id": "deletejob1",
  "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
  "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
  "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
  "status": "succeeded"
}

Definitions

Name Description
delete-job-status

Status of the job.
DeleteJob

A job which contains a reference to the operations to perform, results, and execution metadata.
Error

Error definition.
ErrorResponse

Error response.
InnerError

A more specific error description than was provided by the containing error.

delete-job-status

Enumeration

Status of the job.

Value Description
failed
notstarted
running
succeeded

DeleteJob

Object

A job which contains a reference to the operations to perform, results, and execution metadata.

Name Type Description
createdDateTime

string

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

Error

Details of the error(s) that occurred executing the import job.
finishedDateTime

string

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

string

The identifier of the delete job.
purgeDateTime

string

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

delete-job-status

Status of the job.

Error

Object

Error definition.

Name Type Description
code

string

Service specific error code which serves as the substatus for the HTTP error code.
details

Error[]

Internal error details.
innererror

InnerError

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.

ErrorResponse

Object

Error response.

Name Type Description
error

Error

The error details.

InnerError

Object

A more specific error description than was provided by the containing error.

Name Type Description
code

string

A more specific error code than was provided by the containing error.
innererror

InnerError

An object containing more specific information than the current object about the error.