Jobs - DeleteJobs Add

Service:

Azure Digital Twins

API Version:

2023-10-31

Hiermee initieert u een taak waarmee alle modellen, tweelingen en relaties op het exemplaar worden verwijderd. Verwijdert geen andere typen entiteiten. Statuscodes:

• 202 gemaakt
• 400 Ongeldige aanvraag
  • JobLimitReached : het maximum aantal toegestane verwijdertaken is bereikt.
  • ValidationFailed : Operation-Id bestaat al.

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

With optional parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
api-version	query	True	string	De aangevraagde API-versie.
timeoutInMinutes	query		integer int32	Gewenste time-out voor de verwijdertaak. Zodra de opgegeven time-out is bereikt, stopt de service alle verwijderbewerkingen die worden geactiveerd door de huidige verwijdertaak die worden uitgevoerd en gaat naar de status Mislukt. Houd er rekening mee dat uw exemplaar hierdoor een onbekende status heeft, omdat er geen terugdraaibewerking wordt uitgevoerd.

Aanvraagkoptekst

Name	Vereist	Type	Description
operation-id		string	Id voor de statusmonitor van de bewerking. De id wordt gegenereerd als de header niet is doorgegeven door de client.
traceparent		string	Identificeert de aanvraag in een gedistribueerd traceringssysteem.
tracestate		string	Biedt leverancierspecifieke traceringsidentificatie-informatie en is een aanvulling op traceringsouder.

Antwoorden

Name	Type	Description
202 Accepted	DeleteJob	Taak geaccepteerd Headers Operation-Location: string
Other Status Codes	ErrorResponse	Standaardantwoord. Headers x-ms-error-code: string

Beveiliging

oauth2

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

Voorbeelden

Add a job

Sample Request

HTTP

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

Sample Response

Status code:

202

Operation-Location: https://instance-name/jobs/deletions/{id}?api-version=2023-10-31
Operation-Id: {id}

Response Body

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

Definities

Name	Description
delete-job-status	Status van de taak.
DeleteJob	Een taak die een verwijzing bevat naar de uit te voeren bewerkingen, resultaten en metagegevens van de uitvoering.
Error	Foutdefinitie.
ErrorResponse	Foutreactie.
InnerError	Een specifiekere foutbeschrijving dan is opgegeven door de betreffende fout.

delete-job-status

Status van de taak.

Name	Type	Description
failed	string
notstarted	string
running	string
succeeded	string

DeleteJob

Een taak die een verwijzing bevat naar de uit te voeren bewerkingen, resultaten en metagegevens van de uitvoering.

Name	Type	Description
createdDateTime	string	Begintijd van de taak. De tijdstempel heeft RFC3339 indeling: yyyy-MM-ddTHH:mm:ssZ.
error	Error	Details van de fout(en) die zijn opgetreden bij het uitvoeren van de importtaak.
finishedDateTime	string	Eindtijd van de taak. De tijdstempel heeft RFC3339 indeling: yyyy-MM-ddTHH:mm:ssZ.
id	string	De id van de verwijdertaak.
purgeDateTime	string	Tijdstip waarop de taak door de service van het systeem wordt verwijderd. De tijdstempel heeft RFC3339 indeling: yyyy-MM-ddTHH:mm:ssZ.
status	delete-job-status	Status van de taak.

Error

Foutdefinitie.

Name	Type	Description
code	string	Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.
details	Error[]	Interne foutdetails.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.

ErrorResponse

Foutreactie.

Name	Type	Description
error	Error	De foutdetails.

InnerError

Een specifiekere foutbeschrijving dan is opgegeven door de betreffende fout.

Name	Type	Description
code	string	Een specifiekere foutcode dan is opgegeven door de betreffende fout.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.