Dela via


Jobs - DeleteJobs GetById

Hämtar ett borttagningsjobb. Statuskoder:

  • 200 OK
  • 404 – Hittades inte
    • DeleteJobNotFound – Det gick inte att hitta borttagningsjobbet.
GET https://digitaltwins-hostname/jobs/deletions/{id}?api-version=2023-10-31

URI-parametrar

Name I Obligatorisk Typ Description
id
path True

string

ID:t för borttagningsjobbet. ID:t är unikt inom tjänsten och skiftlägeskänsligt.

api-version
query True

string

Den begärda API-versionen.

Begärandehuvud

Name Obligatorisk Typ Description
traceparent

string

Identifierar begäran i ett distribuerat spårningssystem.

tracestate

string

Tillhandahåller leverantörsspecifik spårningsidentifieringsinformation och är ett komplement till traceparent.

Svar

Name Typ Description
200 OK

DeleteJob

Klart

Other Status Codes

ErrorResponse

Standardsvar.

Headers

x-ms-error-code: string

Säkerhet

oauth2

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

Exempel

Get an import job by id

Sample Request

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

Sample Response

{
  "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"
}

Definitioner

Name Description
delete-job-status

Jobbets status.

DeleteJob

Ett jobb som innehåller en referens till de åtgärder som ska utföras, resultat och körningsmetadata.

Error

Feldefinition.

ErrorResponse

Felsvar.

InnerError

En mer specifik felbeskrivning än vad som angavs av det innehållande felet.

delete-job-status

Jobbets status.

Name Typ Description
failed

string

notstarted

string

running

string

succeeded

string

DeleteJob

Ett jobb som innehåller en referens till de åtgärder som ska utföras, resultat och körningsmetadata.

Name Typ Description
createdDateTime

string

Jobbets starttid. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

error

Error

Information om de fel som uppstod när importjobbet kördes.

finishedDateTime

string

Jobbets sluttid. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

id

string

Identifieraren för borttagningsjobbet.

purgeDateTime

string

Tid då jobbet rensas av tjänsten från systemet. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

status

delete-job-status

Jobbets status.

Error

Feldefinition.

Name Typ Description
code

string

Tjänstspecifik felkod som fungerar som understatus för HTTP-felkoden.

details

Error[]

Intern felinformation.

innererror

InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

message

string

En mänsklig läsbar representation av felet.

ErrorResponse

Felsvar.

Name Typ Description
error

Error

Felinformationen.

InnerError

En mer specifik felbeskrivning än vad som angavs av det innehållande felet.

Name Typ Description
code

string

En mer specifik felkod än vad som angavs av det innehållande felet.

innererror

InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.