Dela via


Jobs - DeleteJobs Add

Initierar ett jobb som tar bort alla modeller, tvillingar och relationer på instansen. Tar inte bort några andra typer av entiteter. Statuskoder:

  • 202 Skapad
  • 400 Felaktig begäran
    • JobLimitReached – Det maximala antalet tillåtna borttagningsjobb har uppnåtts.
    • ValidationFailed – Operation-Id finns redan.
POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31
POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31&timeoutInMinutes={timeoutInMinutes}

URI-parametrar

Name I Obligatorisk Typ Description
api-version
query True

string

Den begärda API-versionen.

timeoutInMinutes
query

integer

int32

Önskad tidsgräns för borttagningsjobbet. När den angivna tidsgränsen nås stoppar tjänsten alla borttagningsåtgärder som utlöses av det aktuella borttagningsjobbet som pågår och går till ett feltillstånd. Observera att detta lämnar instansen i ett okänt tillstånd eftersom det inte blir någon återställningsåtgärd.

Begärandehuvud

Name Obligatorisk Typ Description
operation-id

string

ID för åtgärdens statusövervakare. ID:t genereras om huvudet inte skickades av klienten.

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
202 Accepted

DeleteJob

Jobbet har godkänts

Headers

Operation-Location: string

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

Add a job

Sample Request

POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31&timeoutInMinutes=60

Sample Response

Operation-Location: https://instance-name/jobs/deletions/{id}?api-version=2023-10-31
Operation-Id: {id}
{
  "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": "notstarted"
}

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.