Jobs - DeleteJobs GetById
Ruft einen Löschauftrag ab. Statuscodes:
- 200 – OK
- 404 – Nicht gefunden
- DeleteJobNotFound: Der Löschauftrag wurde nicht gefunden.
GET https://digitaltwins-hostname/jobs/deletions/{id}?api-version=2023-10-31
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
id
|
path | True |
string |
Die ID für den Löschauftrag. Die ID ist innerhalb des Diensts eindeutig und beachtet die Groß-/Kleinschreibung. |
api-version
|
query | True |
string |
Die angeforderte API-Version. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
traceparent |
string |
Identifiziert die Anforderung in einem verteilten Ablaufverfolgungssystem. |
|
tracestate |
string |
Stellt herstellerspezifische Ablaufverfolgungsinformationen bereit und ist ein Begleiter für traceparent. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Erfolg |
|
Other Status Codes |
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 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"
}
Definitionen
Name | Beschreibung |
---|---|
delete-job-status |
Status des Auftrags. |
Delete |
Ein Auftrag, der einen Verweis auf die auszuführenden Vorgänge, Ergebnisse und Ausführungsmetadaten enthält. |
Error |
Fehlerdefinition. |
Error |
Fehlerantwort. |
Inner |
Eine spezifischere Fehlerbeschreibung als der enthaltende Fehler. |
delete-job-status
Status des Auftrags.
Name | Typ | Beschreibung |
---|---|---|
failed |
string |
|
notstarted |
string |
|
running |
string |
|
succeeded |
string |
DeleteJob
Ein Auftrag, der einen Verweis auf die auszuführenden Vorgänge, Ergebnisse und Ausführungsmetadaten enthält.
Name | Typ | Beschreibung |
---|---|---|
createdDateTime |
string |
Startzeit des Auftrags. Der Zeitstempel hat RFC3339 Format: |
error |
Details zu den Fehlern, die beim Ausführen des Importauftrags aufgetreten sind. |
|
finishedDateTime |
string |
Endzeit des Auftrags. Der Zeitstempel hat RFC3339 Format: |
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: |
status |
Status des Auftrags. |
Error
Fehlerdefinition.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient. |
details |
Error[] |
Interne Fehlerdetails. |
innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
message |
string |
Eine für Menschen lesbare Darstellung des Fehlers. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
Die Fehlerdetails. |
InnerError
Eine spezifischere Fehlerbeschreibung als der enthaltende Fehler.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde. |
innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für