Jobs - DeleteJobs List

Service:

Azure Digital Twins

API Version:

2023-10-31

Ruft alle Löschaufträge ab. Dies kann hilfreich sein, um einen zuvor angeforderten Löschauftrag zu finden oder einen Verlauf der Löschaufträge anzuzeigen, die auf dem instance ausgeführt wurden oder derzeit ausgeführt werden. Statuscodes:

• 200 – OK

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Die angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
max-items-per-page		integer	Die maximale Anzahl von Elementen, die pro Anforderung abgerufen werden sollen. Der Server gibt möglicherweise weniger als die angeforderte Nummer zurück.
traceparent		string	Identifiziert die Anforderung in einem verteilten Ablaufverfolgungssystem.
tracestate		string	Stellt herstellerspezifische Ablaufverfolgungsinformationen bereit und ist ein Begleiter für die Ablaufverfolgung.

Antworten

Name	Typ	Beschreibung
200 OK	DeleteJobCollection	Erfolg
Other Status Codes	ErrorResponse	Standardantwort. Headers x-ms-error-code: string

Sicherheit

oauth2

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

Beispiele

Get all import jobs

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "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"
    },
    {
      "id": "deletejob2",
      "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"
    }
  ],
  "nextLink": "url-to-next-page"
}

Definitionen

Name	Beschreibung
delete-job-status	Status des Auftrags.
DeleteJob	Ein Auftrag, der einen Verweis auf auszuführende Vorgänge, Ergebnisse und Ausführungsmetadaten enthält.
DeleteJobCollection	Eine Auflistung von Löschauftragsobjekten.
Error	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
InnerError	Eine spezifischere Fehlerbeschreibung, als vom enthaltenden Fehler bereitgestellt wurde.

delete-job-status

Status des Auftrags.

Name	Typ	Beschreibung
failed	string
notstarted	string
running	string
succeeded	string

DeleteJob

Ein Auftrag, der einen Verweis auf auszuführende Vorgänge, Ergebnisse und Ausführungsmetadaten enthält.

Name	Typ	Beschreibung
createdDateTime	string	Startzeit des Auftrags. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
error	Error	Details zu den Fehlern, die beim Ausführen des Importauftrags aufgetreten sind.
finishedDateTime	string	Endzeit des Auftrags. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
id	string	Der Bezeichner des Löschauftrags.
purgeDateTime	string	Zeitpunkt, zu dem der Auftrag vom Dienst aus dem System gelöscht wird. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
status	delete-job-status	Status des Auftrags.

DeleteJobCollection

Eine Auflistung von Löschauftragsobjekten.

Name	Typ	Beschreibung
nextLink	string	Ein URI zum Abrufen der nächsten Ergebnisseite.
value	DeleteJob[]	Die Liste der Löschauftragsobjekte.

Error

Fehlerdefinition.

Name	Typ	Beschreibung
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
details	Error[]	Interne Fehlerdetails.
innererror	InnerError	Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Die Fehlerdetails.

InnerError

Eine spezifischere Fehlerbeschreibung, als vom enthaltenden Fehler bereitgestellt wurde.

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode, als vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.