Arbeitsauftragsmanagement-API

Freigeben Version: Zurich

Aktualisiert 31. Juli 2025

43 Minuten Lesedauer

Die Arbeitsauftragsmanagement Die API stellt Endpunkte zum Erstellen, Aktualisieren und Abrufen von Arbeitsaufträgen bereit.

Diese API ist in der Anwendung „offene APIs für Telekommunikation“ enthalten, die auf verfügbar ist ServiceNow Store.

Diese API wird in bereitgestellt sn_tmf_api Namespace.

Der aufrufende Anwender muss über die Rolle sn_tmf_api.work_order_Integrator verfügen.

Die Arbeitsauftragsmanagement API ist ein ServiceNow Implementierung der REST-Spezifikation der TM-Forum-Arbeitsauftragsmanagement-API. Diese Implementierung basiert auf TMF697 Arbeitsauftragsmanagement-API v5.0 .

Arbeitsauftragsmanagement – GET /sn_tmf_api/work_order_Management_api/Workorder/{ID}

Ruft einen angegebenen Arbeitsauftrag aus der Tabelle „Arbeitsauftrag“ [wm_order] ab.

URL-Format

Versionierte URL: /api/sn_tmf_api/{api_Version}/work_order_Management_api/workorder/{ID}

Standard-URL: /api/sn_tmf_api/work_order_Management_api/workorder/{ID}

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: `v1` Oder `v2` . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
id	SYS_ID oder externalIdentifierDes Arbeitsauftrags. Tabelle: Arbeitsauftrag [wm_order] Feld: SYS_ID oder Correlation_ID Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Werte: @TYPE Kategorie Abschlussdatum Beschreibung ExpectedCompletionDate href id Initiatedaus Priorität AnfordertCompletionDate AnfordertStartdatum shortDescription startDate Status Arbeitsauftragsnummer Standard: Gibt alle Felder zurück. Datentyp: Zeichenfolge

Tabelle : 3. Anforderungstext-Parameter (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 4. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt application/json.

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
@TYPE	Dieser Wert ist immer `Arbeitsauftrag` . Datentyp: Zeichenfolge
Kategorie	Kategorie für den Arbeitsauftrag, die von einem Auftragsmanagementsystem verwendet werden kann, z. B. `Unternehmen` Oder `Wohn` . Datentyp: Zeichenfolge
Abschlussdatum	Datum und Uhrzeit des Abschlusses des Arbeitsauftrags. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Arbeitsauftrags. Datentyp: Zeichenfolge
ExpectedCompletionDate	Erwartetes Abschlussdatum und -Uhrzeit, die vom Anbieter festgelegt wurden. Datentyp: Zeichenfolge
ExternalIdentifier	Liste der externen Referenzen, z. B. Lieferanten- oder Korrelations-ID. Datentyp: Array `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier.@type	Dieser Wert ist immer `ExternalIdentifierRef` . Datentyp: Zeichenfolge
externalIdentifier.id	Externe Referenz, z. B. Lieferanten- oder Korrelations-ID. Datentyp: Zeichenfolge
href	Relativer Link zum Arbeitsauftragsdatensatz. Datentyp: Zeichenfolge
id	SYS_ID des Arbeitsauftrags. Tabelle: Arbeitsauftrag [wm_order] Datentyp: Zeichenfolge
Initiatedaus	Referenz-ID, die angibt, wo der Arbeitsauftrag initiiert wurde. Beispiel: Eine sys_ID der Aufgabe aus der Tabelle „Arbeitsauftragsaufgabe“ [wm_Task]. Datentyp: Zeichenfolge
note	Liste der Notizen zum Auftrag. Datentyp: Array `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
Hinweis.@type	Dieser Wert ist immer `Hinweis` . Datentyp: Zeichenfolge
note.author	Autor der Notiz. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz dem Arbeitsauftrag hinzugefügt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Hinweistext. Datentyp: Zeichenfolge
Ort	Der geografische Standort, der dem Arbeitsauftrag zugeordnet ist. Datentyp: Objekt `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
Ort.@Typ	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
place.id	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
Ort.zugehörigPartei	Liste der Supportgruppen für den Standort. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Place.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
place.relatedParty.id	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
place.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Ort.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Priorität	Prioritätsrangliste für den Arbeitsauftrag. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Zugehörige Partei	Liste der zugeordneten Kontakte für den Arbeitsauftrag. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
relatedParty.id	SYS_ID der zugehörigen Partei. Tabelle: Account [Customer_Account], Unternehmen [Core_Company] oder Anwender [sys_user] Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
ZugehörigPartei.Rolle	Rolle der zugehörigen Partei. Mögliche Werte: Account Unternehmen Verbraucher Kontakt Datentyp: Zeichenfolge
RelatedProductOrder	Liste der Produktaufträge für den Arbeitsauftrag. Datentyp: Array `"relatedProductOrder": [ { "@type": "String", "id": "String" } ]`
RelatedProductOrder.@type	Dieser Wert ist immer `ProduktauftragsRef` . Datentyp: Zeichenfolge
relatedProductOrder.id	SYS_ID der Produktbestellung. Tabelle: Produktbestellung [sn_ind_tmt_orm_Product_order] Datentyp: Zeichenfolge
AnfordertCompletionDate	Angefordertes Abschlussdatum und -Uhrzeit. Datentyp: Zeichenfolge
AnfordertStartdatum	Startdatum der Auftragserfüllung, das von der anfordernden Person festgelegt wurde. Wird in Fällen verwendet, in denen die anfordernde Person dem Anbieter nicht erlauben kann, die Erfüllung vor einem angegebenen Datum zu beginnen. Datentyp: Zeichenfolge
shortDescription	Kurze Zusammenfassung des Arbeitsauftrags. Datentyp: Zeichenfolge
startDate	Datum und Uhrzeit des Beginns der Bestellung. Datentyp: Zeichenfolge
Status	Status des Arbeitsauftrags. Mögliche Werte: Entwurf Warten auf Qualifizierung Qualifiziert Zugewiesen In Arbeit Abschließen Datentyp: Zeichenfolge
WorkOrderItem	Liste der Aufgaben unter dem Arbeitsauftrag. Datentyp: Array `"workOrderItem": [ { "@type": "String", "description": "String", "id": "String", "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem.@type	Dieser Wert ist immer `Arbeitsauftragselement` . Datentyp: Zeichenfolge
workOrderItem.description	Beschreibung der Aufgabe. Datentyp: Zeichenfolge
workOrderItem.id	SYS_ID der Aufgabe. Tabelle: Arbeitsauftragsaufgabe [wm_Task] Datentyp: Zeichenfolge
Arbeitsauftragselement.Kurzbeschreibung	Kurze Beschreibung der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Status	Status der Aufgabe Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit	Beschreibung der für die Aufgabe erforderlichen Arbeit. Datentyp: Objekt `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "relatedWork": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
Arbeitsauftragselement.work.@type	Dieser Wert ist immer `WorkRefOrValue` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.erwartetes Abschlussdatum	Erwartetes Abschlussdatum für die Aufgabe. Datentyp: Zeichenfolge
workOrderItem.work.id	SYS_ID des Arbeitstyps für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Datentyp: Zeichenfolge
workOrderItem.work.place	Liste der geografischen Standorte, die der Aufgabe zugeordnet sind. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Dieser Wert ist immer `RelatedPlaceRefOrValue` . Datentyp: Zeichenfolge
workOrderItem.work.place.place	Details zum Standort. Datentyp: Objekt `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
workOrderItem.work.place.place.id	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
workOrderItem.work.place.role	Rolle dieses Standorts im Kontext der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei	Liste der Supportgruppen für die Aufgabe. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Arbeitsauftragselement.Arbeit.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
workOrderItem.work.relatedParty.id	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
workOrderItem.work.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigArbeitsarbeit	Liste der zugehörigen Arbeitsauftragsaufgaben. Datentyp: Array `"relatedWork": [ { "@type": "String", "id": "String" } ]`
Arbeitsauftragselement.Arbeit.relatedArbeitsarbeit.@type	Dieser Wert ist immer `WorkRefOrValue` . Datentyp: Zeichenfolge
workOrderItem.work.relatedWork.id	SYS_ID der zugehörigen Aufgabe. Tabelle: Arbeitsauftragsaufgabe [wm_Task] Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.scheduledStartdatum	Geplantes Startdatum für die Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragMitarbeiterzuweisung	Zuweisungsdetails für die Aufgabe. Datentyp: Array `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.@type	Dieser Wert ist immer `WorkforceMitarbeiterzuweisung` . Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.id	SYS_ID der Gruppe, die der Aufgabe zugewiesen ist. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter	Details zum Mitarbeiter, der der Aufgabe zugewiesen ist. Datentyp: Objekt `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.@type	Dieser Wert ist immer `Einzelperson` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter.KontaktMittel	Liste der Telefonnummern des Mitarbeiters. Datentyp: Array `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.contactMedium.@type	Dieser Wert ist immer `PhoneContactMedium` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsteMitarbeiterzuweisung.ArbeitsteMitarbeiter.KontaktMittel.Telefonnummer	Telefonnummer des Mitarbeiters. Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	SYS_ID des Mitarbeiters. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Name des Mitarbeiters. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitspriorität	Prioritätsrangliste für die Aufgabe. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitstyp	Der Arbeitstyp für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Feld: Name Datentyp: Zeichenfolge
Arbeitsauftragsnummer	Eindeutiger Bezeichner für den Arbeitsauftrag, z. B. WO0008004. Tabelle: Arbeitsauftrag [wm_order] Feld: Nummer Datentyp: Zeichenfolge
Arbeitsauftragsbeziehung	Liste der Aufgabenbeziehungen zum Arbeitsauftrag. Datentyp: Array `"workOrderRelationship": [ { "@type": "String", "id": "String", "relationshipType": "String" } ]`
Arbeitsauftragsbeziehung.@type	Dieser Wert ist immer `Auftragsbeziehung` . Datentyp: Zeichenfolge
workOrderRelationship.id	SYS_ID der Aufgabenbeziehung. Tabelle: Aufgabenbeziehung [Task_rel_Task] Datentyp: Zeichenfolge
Arbeitsauftragsbeziehung.Beziehungstyp	Aufgabenbeziehungstyp. Datentyp: Zeichenfolge

cURL-Anforderung

Ruft den angegebenen Arbeitsauftrag ab.

curl "https://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workorder/27e756a1df113100dca6a5f59bf263da" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

{
   "@type": "WorkOrder",
   "href": "api/sn_tmf_api/workordermanagement/workorder/6d22c6f0ff0de650f8dfffffffffff98",
   "workOrderNumber": "WO0008004",
   "id": "6d22c6f0ff0de650f8dfffffffffff98",
   "category": "test",
   "shortDescription": "Test-Test",
   "description": "Test",
   "startDate": "",
   "requestedCompletionDate": "2025-04-19 07:17:04",
   "requestedStartDate": "",
   "state": "Awaiting Qualification",
   "priority": "4 - Low",
   "initiatedFrom": "",
   "completionDate": "",
   "expectedCompletionDate": "",
   "place": {
      "@type": "GeographicSite",
      "id": "920cf6ac73d423002728660c4cf6a799",
      "relatedParty": [
         {
            "@type": "RelatedPartyRef",
            "id": "320ee92637232000158bbfc8bcbe5d40",
            "name": "East Qualifiers",
            "role": "QualificationGroup"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "5408091a3b100300e81d47b334efc452",
         "name": "Ashley Parker",
         "role": "Contact"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Account"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Consumer"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "820351a1c0a8018b67c73d51c074097c",
         "name": "Acer",
         "role": "Company"
      }
   ],
   "appointment": {},
   "relatedProductOrder": [
      {
         "@type": "ProductOrderRef",
         "id": "19f5456dff092a50f8dfffffffffff01"
      },
      {
         "@type": "ProductOrderRef",
         "id": "7116456dff092a50f8dfffffffffff6e"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifierRef",
         "id": "r6879"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "2fa566fdff456a50f8dfffffffffffc6",
         "shortDescription": "abc",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "2fa566fdff456a50f8dfffffffffffc6",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "25ab8dcd0a0a0bb300bd8a8899934d72"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "bb420af0ff0de650f8dfffffffffff4a",
         "shortDescription": "Test",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "bb420af0ff0de650f8dfffffffffff4a",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "920cf6ac73d423002728660c4cf6a799"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "c301e379ff096a50f8dfffffffffff43",
         "shortDescription": "hi",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "c301e379ff096a50f8dfffffffffff43",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "6808184aeb211100420124e05206fe12"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      }
   ],
   "workOrderRelationship": [
      {
         "@type": "OrderRelationship",
         "id": "02016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "0e016b46ffcd6a50f8dfffffffffff30",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "66da174eff8d6a50f8dfffffffffffda",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "aada174eff8d6a50f8dfffffffffffd9",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "bd20e706ffcd6a50f8dfffffffffffc6",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "c2016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      }
   ],
   "note": [
      {
         "@type": "Note",
         "author": "System Administrator",
         "date": "2025-04-23",
         "text": "This is a note."
      }
   ]
}

Arbeitsauftragsmanagement – GET /sn_tmf_api/work_order_Management_api/workorderManagement

Ruft eine Liste aller Arbeitsaufträge aus der Tabelle „Arbeitsauftrag“ [wm_order] ab.

URL-Format

Versionierte URL: /api/sn_tmf_api/{api_Version}/work_order_Management_api/workorderManagement

Standard-URL: /api/sn_tmf_api/work_order_Management_api/workorderManagement

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: `v1` Oder `v2` . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Werte: @TYPE Kategorie Abschlussdatum Beschreibung ExpectedCompletionDate href id Initiatedaus Priorität AnfordertCompletionDate AnfordertStartdatum shortDescription startDate Status Arbeitsauftragsnummer Standard: Gibt alle Felder zurück. Datentyp: Zeichenfolge
id	SYS_IDs, die zum Filtern von Arbeitsaufträgen verwendet werden sollen. Nur Arbeitsaufträge, die den angegebenen sys_IDs entsprechen, werden in der Antwort zurückgegeben. Tabelle: Arbeitsauftrag [wm_order] Datentyp: Zeichenfolge
limit	Maximale Anzahl der zurückzugebenden Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs. Standard: 20 Datentyp: Zahl
Offset	Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Standard: 0 Datentyp: Zahl

Tabelle : 9. Anforderungstext-Parameter (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 10. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 11. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltsbereich	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2` Und `Grenzwert = 3` , Der Wert von Content-RangeHeader ist `Elemente 3-5` .
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter previous
X-Gesamtzahl	Bei paginierten Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 12. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
206	Teilinhalt. Die Anforderung wurde erfolgreich verarbeitet und hat einen Teilbereich von Inhalten zurückgegeben, der von einem paginierten Aufruf angegeben wurde.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
@TYPE	Dieser Wert ist immer `Arbeitsauftrag` . Datentyp: Zeichenfolge
Kategorie	Kategorie für den Arbeitsauftrag, die von einem Auftragsmanagementsystem verwendet werden kann, z. B. `Unternehmen` Oder `Wohn` . Datentyp: Zeichenfolge
Abschlussdatum	Datum und Uhrzeit des Abschlusses des Arbeitsauftrags. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Arbeitsauftrags. Datentyp: Zeichenfolge
ExpectedCompletionDate	Erwartetes Abschlussdatum und -Uhrzeit, die vom Anbieter festgelegt wurden. Datentyp: Zeichenfolge
ExternalIdentifier	Liste der externen Referenzen, z. B. Lieferanten- oder Korrelations-ID. Datentyp: Array `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier.@type	Dieser Wert ist immer `ExternalIdentifierRef` . Datentyp: Zeichenfolge
externalIdentifier.id	Externe Referenz, z. B. Lieferanten- oder Korrelations-ID. Datentyp: Zeichenfolge
href	Relativer Link zum Arbeitsauftragsdatensatz. Datentyp: Zeichenfolge
id	SYS_ID des Arbeitsauftrags. Tabelle: Arbeitsauftrag [wm_order] Datentyp: Zeichenfolge
Initiatedaus	Referenz-ID, die angibt, wo der Arbeitsauftrag initiiert wurde. Beispiel: Eine sys_ID der Aufgabe aus der Tabelle „Arbeitsauftragsaufgabe“ [wm_Task]. Datentyp: Zeichenfolge
note	Liste der Notizen zum Auftrag. Datentyp: Array `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
Hinweis.@type	Dieser Wert ist immer `Hinweis` . Datentyp: Zeichenfolge
note.author	Autor der Notiz. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz dem Arbeitsauftrag hinzugefügt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Hinweistext. Datentyp: Zeichenfolge
Ort	Der geografische Standort, der dem Arbeitsauftrag zugeordnet ist. Datentyp: Objekt `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
Ort.@Typ	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
place.id	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
Ort.zugehörigPartei	Liste der Supportgruppen für den Standort. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Place.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
place.relatedParty.id	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
place.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Ort.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Priorität	Prioritätsrangliste für den Arbeitsauftrag. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Zugehörige Partei	Liste der zugeordneten Kontakte für den Arbeitsauftrag. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
relatedParty.id	SYS_ID der zugehörigen Partei. Tabelle: Account [Customer_Account], Unternehmen [Core_Company] oder Anwender [sys_user] Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
ZugehörigPartei.Rolle	Rolle der zugehörigen Partei. Mögliche Werte: Account Unternehmen Verbraucher Kontakt Datentyp: Zeichenfolge
RelatedProductOrder	Liste der Produktaufträge für den Arbeitsauftrag. Datentyp: Array `"relatedProductOrder": [ { "@type": "String", "id": "String" } ]`
RelatedProductOrder.@type	Dieser Wert ist immer `ProduktauftragsRef` . Datentyp: Zeichenfolge
relatedProductOrder.id	SYS_ID der Produktbestellung. Tabelle: Produktbestellung [sn_ind_tmt_orm_Product_order] Datentyp: Zeichenfolge
AnfordertCompletionDate	Angefordertes Abschlussdatum und -Uhrzeit. Datentyp: Zeichenfolge
AnfordertStartdatum	Startdatum der Auftragserfüllung, das von der anfordernden Person festgelegt wurde. Wird in Fällen verwendet, in denen die anfordernde Person dem Anbieter nicht erlauben kann, die Erfüllung vor einem angegebenen Datum zu beginnen. Datentyp: Zeichenfolge
shortDescription	Kurze Zusammenfassung des Arbeitsauftrags. Datentyp: Zeichenfolge
startDate	Datum und Uhrzeit des Beginns der Bestellung. Datentyp: Zeichenfolge
Status	Status des Arbeitsauftrags. Mögliche Werte: Entwurf Warten auf Qualifizierung Qualifiziert Zugewiesen In Arbeit Abschließen Datentyp: Zeichenfolge
WorkOrderItem	Liste der Aufgaben unter dem Arbeitsauftrag. Datentyp: Array `"workOrderItem": [ { "@type": "String", "description": "String", "id": "String", "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem.@type	Dieser Wert ist immer `Arbeitsauftragselement` . Datentyp: Zeichenfolge
workOrderItem.description	Beschreibung der Aufgabe. Datentyp: Zeichenfolge
workOrderItem.id	SYS_ID der Aufgabe. Tabelle: Arbeitsauftragsaufgabe [wm_Task] Datentyp: Zeichenfolge
Arbeitsauftragselement.Kurzbeschreibung	Kurze Beschreibung der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Status	Status der Aufgabe Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit	Beschreibung der für die Aufgabe erforderlichen Arbeit. Datentyp: Objekt `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "relatedWork": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
WorkOrderItem .Work.@type	Dieser Wert ist immer `WorkRefOrValue` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.erwartetes Abschlussdatum	Erwartetes Abschlussdatum für die Aufgabe. Datentyp: Zeichenfolge
workOrderItem.work.id	SYS_ID des Arbeitstyps für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Datentyp: Zeichenfolge
workOrderItem.work.place	Liste der geografischen Standorte, die der Aufgabe zugeordnet sind. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Dieser Wert ist immer `RelatedPlaceRefOrValue` . Datentyp: Zeichenfolge
workOrderItem.work.place.place	Details zum Standort. Datentyp: Objekt `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
workOrderItem.work.place.place.id	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
workOrderItem.work.place.role	Rolle dieses Standorts im Kontext der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei	Liste der Supportgruppen für die Aufgabe. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Arbeitsauftragselement.Arbeit.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
workOrderItem.work.relatedParty.id	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
workOrderItem.work.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigArbeitsarbeit	Liste der zugehörigen Arbeitsauftragsaufgaben. Datentyp: Array `"relatedWork": [ { "@type": "String", "id": "String" } ]`
Arbeitsauftragselement.Arbeit.relatedArbeitsarbeit.@type	Dieser Wert ist immer `WorkRefOrValue` . Datentyp: Zeichenfolge
workOrderItem.work.relatedWork.id	SYS_ID der zugehörigen Aufgabe. Tabelle: Arbeitsauftragsaufgabe [wm_Task] Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.scheduledStartdatum	Geplantes Startdatum für die Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragMitarbeiterzuweisung	Zuweisungsdetails für die Aufgabe. Datentyp: Array `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.@type	Dieser Wert ist immer `WorkforceMitarbeiterzuweisung` . Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.id	SYS_ID der Gruppe, die der Aufgabe zugewiesen ist. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter	Details zum Mitarbeiter, der der Aufgabe zugewiesen ist. Datentyp: Objekt `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.@type	Dieser Wert ist immer `Einzelperson` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter.KontaktMittel	Liste der Telefonnummern des Mitarbeiters. Datentyp: Array `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.contactMedium.@type	Dieser Wert ist immer `PhoneContactMedium` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsteMitarbeiterzuweisung.ArbeitsteMitarbeiter.KontaktMittel.Telefonnummer	Telefonnummer des Mitarbeiters. Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	SYS_ID des Mitarbeiters. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Name des Mitarbeiters. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitspriorität	Prioritätsrangliste für die Aufgabe. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitstyp	Der Arbeitstyp für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Feld: Name Datentyp: Zeichenfolge
Arbeitsauftragsnummer	Eindeutiger Bezeichner für den Arbeitsauftrag, z. B. WO0008004. Tabelle: Arbeitsauftrag [wm_order] Feld: Nummer Datentyp: Zeichenfolge
Arbeitsauftragsbeziehung	Liste der Aufgabenbeziehungen zum Arbeitsauftrag. Datentyp: Array `"workOrderRelationship": [ { "@type": "String", "id": "String", "relationshipType": "String" } ]`
Arbeitsauftragsbeziehung.@type	Dieser Wert ist immer `Auftragsbeziehung` . Datentyp: Zeichenfolge
workOrderRelationship.id	SYS_ID der Aufgabenbeziehung. Tabelle: Aufgabenbeziehung [Task_rel_Task] Datentyp: Zeichenfolge
Arbeitsauftragsbeziehung.Beziehungstyp	Aufgabenbeziehungstyp. Datentyp: Zeichenfolge

cURL-Anforderung

Ruft die erste Seite von Arbeitsaufträgen ab.

curl "https://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workordermanagement" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

[{
   "@type": "WorkOrder",
   "href": "api/sn_tmf_api/workordermanagement/workorder/6d22c6f0ff0de650f8dfffffffffff98",
   "workOrderNumber": "WO0008004",
   "id": "6d22c6f0ff0de650f8dfffffffffff98",
   "category": "test",
   "shortDescription": "Test-Test",
   "description": "Test",
   "startDate": "",
   "requestedCompletionDate": "2025-04-19 07:17:04",
   "requestedStartDate": "",
   "state": "Awaiting Qualification",
   "priority": "4 - Low",
   "initiatedFrom": "",
   "completionDate": "",
   "expectedCompletionDate": "",
   "place": {
      "@type": "GeographicSite",
      "id": "920cf6ac73d423002728660c4cf6a799",
      "relatedParty": [
         {
            "@type": "RelatedPartyRef",
            "id": "320ee92637232000158bbfc8bcbe5d40",
            "name": "East Qualifiers",
            "role": "QualificationGroup"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "5408091a3b100300e81d47b334efc452",
         "name": "Ashley Parker",
         "role": "Contact"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Account"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Consumer"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "820351a1c0a8018b67c73d51c074097c",
         "name": "Acer",
         "role": "Company"
      }
   ],
   "appointment": {},
   "relatedProductOrder": [
      {
         "@type": "ProductOrderRef",
         "id": "19f5456dff092a50f8dfffffffffff01"
      },
      {
         "@type": "ProductOrderRef",
         "id": "7116456dff092a50f8dfffffffffff6e"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifierRef",
         "id": "r6879"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "2fa566fdff456a50f8dfffffffffffc6",
         "shortDescription": "abc",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "2fa566fdff456a50f8dfffffffffffc6",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "25ab8dcd0a0a0bb300bd8a8899934d72"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "bb420af0ff0de650f8dfffffffffff4a",
         "shortDescription": "Test",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "bb420af0ff0de650f8dfffffffffff4a",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "920cf6ac73d423002728660c4cf6a799"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "c301e379ff096a50f8dfffffffffff43",
         "shortDescription": "hi",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "c301e379ff096a50f8dfffffffffff43",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "6808184aeb211100420124e05206fe12"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      }
   ],
   "workOrderRelationship": [
      {
         "@type": "OrderRelationship",
         "id": "02016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "0e016b46ffcd6a50f8dfffffffffff30",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "66da174eff8d6a50f8dfffffffffffda",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "aada174eff8d6a50f8dfffffffffffd9",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "bd20e706ffcd6a50f8dfffffffffffc6",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "c2016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      }
   ],
   "note": [
      {
         "@type": "Note",
         "author": "System Administrator",
         "date": "2025-04-23",
         "text": "This is a note."
      }
   ]
}]

Arbeitsauftragsmanagement – PATCH /sn_tmf_api/work_order_Management_api/Workorder/{ID}

Aktualisiert einen Arbeitsauftrag und zugehörige Aufgaben.

Der Arbeitsauftragsdatensatz wird in der Tabelle „Arbeitsauftrag“ [wm_order] aktualisiert. Aufgabendatensätze werden in der Tabelle „Arbeitsauftragsaufgabe“ [wm_Task] aktualisiert.

URL-Format

Versionierte URL: /api/sn_tmf_api/{api_Version}/work_order_Management_api/workorder/{ID}

Standard-URL: /api/sn_tmf_api/work_order_Management_api/workorder/{ID}

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: `v1` Oder `v2` . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
id	SYS_ID des Arbeitsauftrags. Tabelle: Arbeitsauftrag [wm_order] Datentyp: Zeichenfolge

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Anforderungstext-Parameter (JSON)
Name	Beschreibung
@TYPE	Dieser Wert ist immer `Arbeitsauftrag` . Datentyp: Zeichenfolge
Abschlussdatum	Datum und Uhrzeit des Abschlusses des Arbeitsauftrags. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Arbeitsauftrags. Datentyp: Zeichenfolge
ExpectedCompletionDate	Erwartetes Abschlussdatum und -Uhrzeit, die vom Anbieter festgelegt wurden. Datentyp: Zeichenfolge
ExternalIdentifier	Liste der externen Referenzen, z. B. Lieferanten- oder Korrelations-ID. Datentyp: Array `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier.@type	Dieser Wert ist immer `ExternalIdentifierRef` . Datentyp: Zeichenfolge
externalIdentifier.id	Externe Referenz, z. B. Lieferant oder Korrelations-ID. Datentyp: Zeichenfolge
href	Relativer Link zum Arbeitsauftragsdatensatz. Datentyp: Zeichenfolge
id	SYS_ID des Arbeitsauftrags. Tabelle: Arbeitsauftrag [wm_order] Datentyp: Zeichenfolge
Initiatedaus	Referenz-ID, die angibt, wo der Arbeitsauftrag initiiert wurde. Beispiel: Eine sys_ID der Aufgabe aus der Tabelle „Arbeitsauftragsaufgabe“ [wm_Task]. Datentyp: Zeichenfolge
note	Liste der Notizen zum Auftrag. Datentyp: Array `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
Hinweis.@type	Dieser Wert ist immer `Hinweis` . Datentyp: Zeichenfolge
note.author	Autor der Notiz. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz dem Arbeitsauftrag hinzugefügt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Hinweistext. Datentyp: Zeichenfolge
Ort	Der geografische Standort, der dem Arbeitsauftrag zugeordnet ist. Datentyp: Objekt `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
Ort.@Typ	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
place.id	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
Ort.zugehörigPartei	Liste der Supportgruppen für den Standort. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Place.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
place.relatedParty.id	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
place.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Ort.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Priorität	Prioritätsrangliste für den Arbeitsauftrag. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Zugehörige Partei	Liste der zugeordneten Kontakte für den Arbeitsauftrag. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
relatedParty.id	SYS_ID der zugehörigen Partei. Tabelle: Account [Customer_Account], Unternehmen [Core_Company] oder Anwender [sys_user] Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
ZugehörigPartei.Rolle	Rolle der zugehörigen Partei. Mögliche Werte: Account Unternehmen Verbraucher Kontakt Datentyp: Zeichenfolge
AnfordertCompletionDate	Angefordertes Abschlussdatum und -Uhrzeit. Datentyp: Zeichenfolge
AnfordertStartdatum	Startdatum der Auftragserfüllung, das von der anfordernden Person festgelegt wurde. Wird in Fällen verwendet, in denen die anfordernde Person dem Anbieter nicht erlauben kann, die Erfüllung vor einem angegebenen Datum zu beginnen. Datentyp: Zeichenfolge
shortDescription	Kurze Zusammenfassung des Arbeitsauftrags. Datentyp: Zeichenfolge
startDate	Datum und Uhrzeit des Beginns der Bestellung. Datentyp: Zeichenfolge
Status	Status des Arbeitsauftrags. Mögliche Werte: Entwurf Warten auf Qualifizierung Qualifiziert Zugewiesen In Arbeit Abschließen Datentyp: Zeichenfolge
templateId	SYS_ID der Vorlage, die für den Arbeitsauftrag verwendet werden soll. Tabelle: Produktmodell [cmdb_model] Datentyp: Zeichenfolge
WorkOrderItem	Liste der Aufgaben unter dem Arbeitsauftrag. Datentyp: Array `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem.@type	Dieser Wert ist immer `Arbeitsauftragselement` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Aktion	Aktion, die für das Produkt für die Aufgabe ausgeführt werden soll. Mögliche Werte: Hinzufügen löschen modify NoChange Datentyp: Zeichenfolge
workOrderItem.completionDate	Datum und Uhrzeit des Abschlusses der Aufgabe. Datentyp: Zeichenfolge
workOrderItem.description	Beschreibung der Aufgabe. Datentyp: Zeichenfolge
workOrderItem.id	SYS_ID der Aufgabe. Tabelle: Arbeitsauftragsaufgabe [wm_Task] Datentyp: Zeichenfolge
workOrderItem.note	Liste der Notizen zur Aufgabe. Datentyp: Array `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Dieser Wert ist immer `Hinweis` . Datentyp: Zeichenfolge
workOrderItem.note.author	Autor der Notiz. Datentyp: Zeichenfolge
workOrderItem.note.date	Datum, an dem die Notiz der Aufgabe hinzugefügt wurde. Datentyp: Zeichenfolge
workOrderItem.note.text	Der Hinweistext. Datentyp: Zeichenfolge
Arbeitsauftragselement.Kurzbeschreibung	Kurze Beschreibung der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Status	Status der Aufgabe Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit	Beschreibung der für die Aufgabe erforderlichen Arbeit. Datentyp: Objekt `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
Arbeitsauftragselement.work.@type	Dieser Wert ist immer `WorkRefOrValue` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.erwartetes Abschlussdatum	Erwartetes Abschlussdatum für die Aufgabe. Datentyp: Zeichenfolge
workOrderItem.work.id	SYS_ID des Arbeitstyps für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Datentyp: Zeichenfolge
workOrderItem.work.place	Liste der geografischen Standorte, die der Aufgabe zugeordnet sind. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Dieser Wert ist immer `RelatedPlaceRefOrValue` . Datentyp: Zeichenfolge
workOrderItem.work.place.place	Details zum Standort. Datentyp: Objekt `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
workOrderItem.work.place.place.id	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
workOrderItem.work.place.role	Rolle dieses Standorts im Kontext der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei	Liste der Supportgruppen für die Aufgabe. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Arbeitsauftragselement.Arbeit.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
workOrderItem.work.relatedParty.id	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
workOrderItem.work.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.scheduledStartdatum	Geplantes Startdatum für die Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragMitarbeiterzuweisung	Zuweisungsdetails für die Aufgabe. Datentyp: Array `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.@type	Dieser Wert ist immer `WorkforceMitarbeiterzuweisung` . Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.id	SYS_ID der Gruppe, die der Aufgabe zugewiesen ist. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter	Details zum Mitarbeiter, der der Aufgabe zugewiesen ist. Datentyp: Objekt `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.@type	Dieser Wert ist immer `Einzelperson` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter.KontaktMittel	Liste der Telefonnummern des Mitarbeiters. Datentyp: Array `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.contactMedium.@type	Dieser Wert ist immer `PhoneContactMedium` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsteMitarbeiterzuweisung.ArbeitsteMitarbeiter.KontaktMittel.Telefonnummer	Telefonnummer des Mitarbeiters. Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	SYS_ID des Mitarbeiters. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Name des Mitarbeiters. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitspriorität	Prioritätsrangliste für die Aufgabe. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitstyp	Der Arbeitstyp für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Feld: Name Datentyp: Zeichenfolge
Arbeitsauftragsnummer	Eindeutiger Bezeichner für den Arbeitsauftrag, z. B. WO0008004. Tabelle: Arbeitsauftrag [wm_order] Feld: Nummer Datentyp: Zeichenfolge

Header

Tabelle : 16. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 17. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt application/json.

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
@TYPE	Dieser Wert ist immer `Arbeitsauftrag` . Datentyp: Zeichenfolge
Abschlussdatum	Datum und Uhrzeit des Abschlusses des Arbeitsauftrags. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Arbeitsauftrags. Datentyp: Zeichenfolge
ExpectedCompletionDate	Erwartetes Abschlussdatum und -Uhrzeit, die vom Anbieter festgelegt wurden. Datentyp: Zeichenfolge
ExternalIdentifier	Liste der externen Referenzen, z. B. Lieferanten- oder Korrelations-ID. Datentyp: Array `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier.@type	Dieser Wert ist immer `ExternalIdentifierRef` . Datentyp: Zeichenfolge
ExternalIdentifier.ID	Externe Referenz, z. B. Lieferanten- oder Korrelations-ID. Datentyp: Zeichenfolge
href	Relativer Link zum Arbeitsauftragsdatensatz. Datentyp: Zeichenfolge
id	SYS_ID des Arbeitsauftrags. Tabelle: Arbeitsauftrag [wm_order] Datentyp: Zeichenfolge
Initiatedaus	Referenz-ID, die angibt, wo der Arbeitsauftrag initiiert wurde. Beispiel: Eine sys_ID der Aufgabe aus der Tabelle „Arbeitsauftragsaufgabe“ [wm_Task]. Datentyp: Zeichenfolge
note	Liste der Notizen zum Auftrag. Datentyp: Array `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
Hinweis.@type	Dieser Wert ist immer `Hinweis` . Datentyp: Zeichenfolge
note.author	Autor der Notiz. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz dem Arbeitsauftrag hinzugefügt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Hinweistext. Datentyp: Zeichenfolge
Ort	Der geografische Standort, der dem Arbeitsauftrag zugeordnet ist. Datentyp: Objekt `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
Ort.@Typ	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
Ort.ID	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
Ort.zugehörigPartei	Liste der Supportgruppen für den Standort. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Place.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
Ort.zugehörigPartei.ID	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
place.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Ort.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Priorität	Prioritätsrangliste für den Arbeitsauftrag. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Zugehörige Partei	Liste der zugeordneten Kontakte für den Arbeitsauftrag. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
ZugehörigPartei.ID	SYS_ID der zugehörigen Partei. Tabelle: Account [Customer_Account], Unternehmen [Core_Company] oder Anwender [sys_user] Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
ZugehörigPartei.Rolle	Rolle der zugehörigen Partei. Mögliche Werte: Account Unternehmen Verbraucher Kontakt Datentyp: Zeichenfolge
AnfordertCompletionDate	Angefordertes Abschlussdatum und -Uhrzeit. Datentyp: Zeichenfolge
AnfordertStartdatum	Startdatum der Auftragserfüllung, das von der anfordernden Person festgelegt wurde. Wird in Fällen verwendet, in denen die anfordernde Person dem Anbieter nicht erlauben kann, die Erfüllung vor einem angegebenen Datum zu beginnen. Datentyp: Zeichenfolge
shortDescription	Kurze Zusammenfassung des Arbeitsauftrags. Datentyp: Zeichenfolge
startDate	Datum und Uhrzeit des Beginns der Bestellung. Datentyp: Zeichenfolge
Status	Status des Arbeitsauftrags. Mögliche Werte: Entwurf Warten auf Qualifizierung Qualifiziert Zugewiesen In Arbeit Abschließen Datentyp: Zeichenfolge
templateId	SYS_ID der Vorlage, die für den Arbeitsauftrag verwendet werden soll. Tabelle: Produktmodell [cmdb_model] Datentyp: Zeichenfolge
WorkOrderItem	Liste der Aufgaben unter dem Arbeitsauftrag. Datentyp: Array `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem.@type	Dieser Wert ist immer `Arbeitsauftragselement` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Aktion	Aktion, die für das Produkt für die Aufgabe ausgeführt werden soll. Mögliche Werte: Hinzufügen löschen modify NoChange Datentyp: Zeichenfolge
workOrderItem.completionDate	Datum und Uhrzeit des Abschlusses der Aufgabe. Datentyp: Zeichenfolge
workOrderItem.description	Beschreibung der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.ID	SYS_ID der Aufgabe. Tabelle: Arbeitsauftragsaufgabe [wm_Task] Datentyp: Zeichenfolge
workOrderItem.note	Liste der Notizen zur Aufgabe. Datentyp: Array `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Dieser Wert ist immer `Hinweis` . Datentyp: Zeichenfolge
workOrderItem.note.author	Autor der Notiz. Datentyp: Zeichenfolge
workOrderItem.note.date	Datum, an dem die Notiz der Aufgabe hinzugefügt wurde. Datentyp: Zeichenfolge
workOrderItem.note.text	Der Hinweistext. Datentyp: Zeichenfolge
Arbeitsauftragselement.Kurzbeschreibung	Kurze Beschreibung der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Status	Status der Aufgabe Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit	Beschreibung der für die Aufgabe erforderlichen Arbeit. Datentyp: Objekt `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
Arbeitsauftragselement.work.@type	Dieser Wert ist immer `WorkRefOrValue` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.erwartetes Abschlussdatum	Erwartetes Abschlussdatum für die Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ID	SYS_ID des Arbeitstyps für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Datentyp: Zeichenfolge
workOrderItem.work.place	Liste der geografischen Standorte, die der Aufgabe zugeordnet sind. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Dieser Wert ist immer `RelatedPlaceRefOrValue` . Datentyp: Zeichenfolge
workOrderItem.work.place.place	Details zum Standort. Datentyp: Objekt `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
workOrderItem.work.place.place.id	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
workOrderItem.work.place.role	Rolle dieses Standorts im Kontext der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei	Liste der Supportgruppen für die Aufgabe. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Arbeitsauftragselement.Arbeit.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei.ID	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
workOrderItem.work.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.scheduledStartdatum	Geplantes Startdatum für die Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragMitarbeiterzuweisung	Zuweisungsdetails für die Aufgabe. Datentyp: Array `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.@type	Dieser Wert ist immer `WorkforceMitarbeiterzuweisung` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragMitarbeiterzuweisung.ID	SYS_ID der Gruppe, die der Aufgabe zugewiesen ist. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter	Details zum Mitarbeiter, der der Aufgabe zugewiesen ist. Datentyp: Objekt `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.@type	Dieser Wert ist immer `Einzelperson` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter.KontaktMittel	Liste der Telefonnummern des Mitarbeiters. Datentyp: Array `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.contactMedium.@type	Dieser Wert ist immer `PhoneContactMedium` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsteMitarbeiterzuweisung.ArbeitsteMitarbeiter.KontaktMittel.Telefonnummer	Telefonnummer des Mitarbeiters. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragMitarbeiterzuweisung.ArbeitsauftragMitarbeiter.ID	SYS_ID des Mitarbeiters. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Name des Mitarbeiters. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitspriorität	Prioritätsrangliste für die Aufgabe. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitstyp	Der Arbeitstyp für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Feld: Name Datentyp: Zeichenfolge
Arbeitsauftragsnummer	Eindeutiger Bezeichner für den Arbeitsauftrag, z. B. WO0008004. Tabelle: Arbeitsauftrag [wm_order] Feld: Nummer Datentyp: Zeichenfolge

cURL-Anforderung

Aktualisiert den angegebenen Arbeitsauftrag.

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder/2d3f32f0df113100dca6a5f59bf263a9" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "@type": "WorkOrder",
   "description": "Fixed Fibre Broadband Installation",
   "shortDescription": "Fixed Fibre",
   "priority": "1 - Critical",
   "place": {
      "@type": "GeographicSite",
      "id": "f48b22530a0a0ba70001913a1c181eeb",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "781da52637232000158bbfc8bcbe5db8",
            "name": "Jane Smith",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "86a08090ffcd62105e0dffffffffff8b",
         "name": "Workforce Engineering Group",
         "role": "Consumer"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "3df59e8cff5d26105e0dffffffffff0e",
         "action": "add",
         "description": "FTTH Installation",
         "shortDescription": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "state": "Accepted",
         "work": {
            "@type": "WorkRefOrValue",
            "scheduledStartDate": "2024-04-22T14:23:06.528Z",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "description": "Cabinet Configuration",
            "name": "FTTH Installation",
            "workPriority": "high",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "b04b813bffc126105e0dffffffffff0d"
                  }
               }
            ],
            "note": {
               "@type": "Note",
               "text": "Demand Point Type: SDU"
            }
         }
      }
   ],
   "note": {
      "@type": "Note",
      "text": "This is important"
   }
}" \
--user 'username':'password'

Antworttext.

{
   "@type": "WorkOrder",
   "description": "Fixed Fibre Broadband Installation",
   "shortDescription": "Fixed Fibre",
   "priority": "1 - Critical",
   "place": {
      "@type": "GeographicSite",
      "id": "f48b22530a0a0ba70001913a1c181eeb",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "781da52637232000158bbfc8bcbe5db8",
            "name": "Jane Smith",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "86a08090ffcd62105e0dffffffffff8b",
         "name": "Workforce Engineering Group",
         "role": "Consumer"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "3df59e8cff5d26105e0dffffffffff0e",
         "action": "add",
         "description": "FTTH Installation",
         "shortDescription": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "state": "Accepted",
         "work": {
            "@type": "WorkRefOrValue",
            "scheduledStartDate": "2024-04-22T14:23:06.528Z",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "description": "Cabinet Configuration",
            "name": "FTTH Installation",
            "workPriority": "high",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "b04b813bffc126105e0dffffffffff0d"
                  }
               }
            ],
            "note": {
               "@type": "Note",
               "text": "Demand Point Type: SDU"
            }
         }
      }
   ],
   "note": {
      "@type": "Note",
      "text": "This is important"
   },
   "id": "2d3f32f0df113100dca6a5f59bf263a9",
   "href": "/api/sn_tmf_api/work_order_management_api/workOrder/2d3f32f0df113100dca6a5f59bf263a9"
}

Arbeitsauftragsmanagement – POST /sn_tmf_api/work_order_Management_api/cancelWorkOrder

Bricht einen angegebenen Arbeitsauftrag und alle zugehörigen Aufgaben ab.

URL-Format

Versionierte URL: /api/sn_tmf_api/{api_Version}/work_order_Management_api/cancelWorkOrder

Standard-URL: /api/sn_tmf_api/work_order_Management_api/cancelWorkOrder

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: `v1` Oder `v2` . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 20. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 21. Anforderungstext-Parameter (JSON)
Name	Beschreibung
@TYPE	Dieser Wert ist immer `WorkOrder abbrechen` . Datentyp: Zeichenfolge
AbbruchReason	Grund für den Abbruch des Arbeitsauftrags. Datentyp: Zeichenfolge
workOrder	Details zum Arbeitsauftrag. Datentyp: Objekt `"workOrder": { "@type": "String", "id": "String" }`
Arbeitsauftrag.@type	Dieser Wert ist immer `Arbeitsauftragsreferenz` . Datentyp: Zeichenfolge
workOrder.id	Erforderlich. SYS_ID des Arbeitsauftrags, der storniert werden soll. Tabelle: Arbeitsauftrag [wm_order] Datentyp: Zeichenfolge

Header

Tabelle : 22. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 23. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt application/json.

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 24. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
@TYPE	Dieser Wert ist immer `WorkOrder abbrechen` . Datentyp: Zeichenfolge
AbbruchReason	Grund für den Abbruch des Arbeitsauftrags. Datentyp: Zeichenfolge
Status	Status der Stornierungsanforderung. Wenn der Arbeitsauftrag erfolgreich storniert wurde, ist dieser Wert `Abgebrochen` . Datentyp: Zeichenfolge
workOrder	Details zum Arbeitsauftrag. Datentyp: Objekt `"workOrder": { "@type": "String", "id": "String" }`
Arbeitsauftrag.@type	Dieser Wert ist immer `Arbeitsauftragsreferenz` . Datentyp: Zeichenfolge
Arbeitsauftrag.ID	SYS_ID des stornierten Arbeitsauftrags. Tabelle: Arbeitsauftrag [wm_order] Datentyp: Zeichenfolge

cURL-Anforderung

Bricht den angegebenen Arbeitsauftrag ab.

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/cancelWorkOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "@type": "CancelWorkOrder",
   "cancellationReason": "Workforce unavailability",
   "workOrder": {
      "@type": "WorkOrderRef",
      "id": "f8ec1c38-4e4d-4378-a693-f95680e51e25"
   }
}" \
--user 'username':'password'

Antworttext.

{
  "@type": "CancelWorkOrder",
  "cancellationReason": "Workforce unavailability",
  "state": "Cancelled",
  "workOrder": {
    "@type": "WorkOrderRef",
    "id": "f8ec1c38-4e4d-4378-a693-f95680e51e25"
  }
}

Arbeitsauftragsmanagement – POST /sn_tmf_api/work_order_Management_api/Workorder

Erstellt einen Arbeitsauftrag und zugehörige Aufgaben.

Ein Datensatz für den Arbeitsauftrag wird in der Tabelle „Arbeitsauftrag“ [wm_order] erstellt. Ein Datensatz für jede Aufgabe wird in der Tabelle „Arbeitsauftragsaufgabe“ [wm_Task] erstellt.

URL-Format

Versionierte URL: /api/sn_tmf_api/{api_Version}/work_order_Management_api/workorder

Standard-URL: /api/sn_tmf_api/work_order_Management_api/workorder

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: `v1` Oder `v2` . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 26. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 27. Anforderungstext-Parameter (JSON)
Name	Beschreibung
@TYPE	Dieser Wert ist immer `Arbeitsauftrag` . Datentyp: Zeichenfolge
Kategorie	Kategorie für den Arbeitsauftrag, die von einem Auftragsmanagementsystem verwendet werden kann, z. B. `Unternehmen` Oder `Wohn` . Datentyp: Zeichenfolge
Abschlussdatum	Datum und Uhrzeit des Abschlusses des Arbeitsauftrags. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Arbeitsauftrags. Datentyp: Zeichenfolge
ExpectedCompletionDate	Erwartetes Abschlussdatum und -Uhrzeit, die vom Anbieter festgelegt wurden. Datentyp: Zeichenfolge
ExternalIdentifier	Liste der externen Referenzen, z. B. Lieferanten- oder Korrelations-ID. Datentyp: Array `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier.@type	Dieser Wert ist immer `ExternalIdentifierRef` . Datentyp: Zeichenfolge
externalIdentifier.id	Externe Referenz, z. B. Lieferanten- oder Korrelations-ID. Datentyp: Zeichenfolge
href	Relativer Link zum Arbeitsauftragsdatensatz. Datentyp: Zeichenfolge
id	SYS_ID des Arbeitsauftrags. Tabelle: Arbeitsauftrag [wm_order] Datentyp: Zeichenfolge
Initiatedaus	Referenz-ID, die angibt, wo der Arbeitsauftrag initiiert wurde. Beispiel: Eine sys_ID der Aufgabe aus der Tabelle „Arbeitsauftragsaufgabe“ [wm_Task]. Datentyp: Zeichenfolge
note	Liste der Notizen zum Auftrag. Datentyp: Array `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
Hinweis.@type	Dieser Wert ist immer `Hinweis` . Datentyp: Zeichenfolge
note.author	Autor der Notiz. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz dem Arbeitsauftrag hinzugefügt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Hinweistext. Datentyp: Zeichenfolge
Ort	Der geografische Standort, der dem Arbeitsauftrag zugeordnet ist. Datentyp: Objekt `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
Ort.@Typ	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
place.id	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
Ort.zugehörigPartei	Liste der Supportgruppen für den Standort. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Place.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
place.relatedParty.id	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
place.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Ort.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Priorität	Prioritätsrangliste für den Arbeitsauftrag. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Zugehörige Partei	Liste der zugeordneten Kontakte für den Arbeitsauftrag. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
relatedParty.id	SYS_ID der zugehörigen Partei. Tabelle: Account [Customer_Account], Unternehmen [Core_Company] oder Anwender [sys_user] Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
ZugehörigPartei.Rolle	Rolle der zugehörigen Partei. Mögliche Werte: Account Unternehmen Verbraucher Kontakt Datentyp: Zeichenfolge
AnfordertCompletionDate	Angefordertes Abschlussdatum und -Uhrzeit. Datentyp: Zeichenfolge
AnfordertStartdatum	Startdatum der Auftragserfüllung, das von der anfordernden Person festgelegt wurde. Wird in Fällen verwendet, in denen die anfordernde Person dem Anbieter nicht erlauben kann, die Erfüllung vor einem angegebenen Datum zu beginnen. Datentyp: Zeichenfolge
shortDescription	Kurze Zusammenfassung des Arbeitsauftrags. Datentyp: Zeichenfolge
startDate	Datum und Uhrzeit des Beginns der Bestellung. Datentyp: Zeichenfolge
Status	Status des Arbeitsauftrags. Mögliche Werte: Entwurf Warten auf Qualifizierung Qualifiziert Zugewiesen In Arbeit Abschließen Datentyp: Zeichenfolge
templateId	SYS_ID der Vorlage, die für den Arbeitsauftrag verwendet werden soll. Tabelle: Produktmodell [cmdb_model] Datentyp: Zeichenfolge
WorkOrderItem	Liste der Aufgaben unter dem Arbeitsauftrag. Datentyp: Array `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem.@type	Dieser Wert ist immer `Arbeitsauftragselement` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Aktion	Aktion, die für das Produkt für die Aufgabe ausgeführt werden soll. Mögliche Werte: Hinzufügen löschen modify NoChange Datentyp: Zeichenfolge
workOrderItem.completionDate	Datum und Uhrzeit des Abschlusses der Aufgabe. Datentyp: Zeichenfolge
workOrderItem.description	Beschreibung der Aufgabe. Datentyp: Zeichenfolge
workOrderItem.id	SYS_ID der Aufgabe. Tabelle: Arbeitsauftragsaufgabe [wm_Task] Datentyp: Zeichenfolge
workOrderItem.note	Liste der Notizen zur Aufgabe. Datentyp: Array `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Dieser Wert ist immer `Hinweis` . Datentyp: Zeichenfolge
workOrderItem.note.author	Autor der Notiz. Datentyp: Zeichenfolge
workOrderItem.note.date	Datum, an dem die Notiz der Aufgabe hinzugefügt wurde. Datentyp: Zeichenfolge
workOrderItem.note.text	Der Hinweistext. Datentyp: Zeichenfolge
Arbeitsauftragselement.Kurzbeschreibung	Kurze Beschreibung der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Status	Status der Aufgabe Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit	Beschreibung der für die Aufgabe erforderlichen Arbeit. Datentyp: Objekt `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
Arbeitsauftragselement.work.@type	Dieser Wert ist immer `WorkRefOrValue` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.erwartetes Abschlussdatum	Erwartetes Abschlussdatum für die Aufgabe. Datentyp: Zeichenfolge
workOrderItem.work.id	SYS_ID des Arbeitstyps für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Datentyp: Zeichenfolge
workOrderItem.work.place	Liste der geografischen Standorte, die der Aufgabe zugeordnet sind. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Dieser Wert ist immer `RelatedPlaceRefOrValue` . Datentyp: Zeichenfolge
workOrderItem.work.place.place	Details zum Standort. Datentyp: Objekt `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
workOrderItem.work.place.place.id	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
workOrderItem.work.place.role	Rolle dieses Standorts im Kontext der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei	Liste der Supportgruppen für die Aufgabe. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Arbeitsauftragselement.Arbeit.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
workOrderItem.work.relatedParty.id	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
workOrderItem.work.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.scheduledStartdatum	Geplantes Startdatum für die Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragMitarbeiterzuweisung	Zuweisungsdetails für die Aufgabe. Datentyp: Array `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.@type	Dieser Wert ist immer `WorkforceMitarbeiterzuweisung` . Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.id	SYS_ID der Gruppe, die der Aufgabe zugewiesen ist. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter	Details zum Mitarbeiter, der der Aufgabe zugewiesen ist. Datentyp: Objekt `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.@type	Dieser Wert ist immer `Einzelperson` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter.KontaktMittel	Liste der Telefonnummern des Mitarbeiters. Datentyp: Array `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.contactMedium.@type	Dieser Wert ist immer `PhoneContactMedium` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsteMitarbeiterzuweisung.ArbeitsteMitarbeiter.KontaktMittel.Telefonnummer	Telefonnummer des Mitarbeiters. Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	SYS_ID des Mitarbeiters. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Name des Mitarbeiters. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitspriorität	Prioritätsrangliste für die Aufgabe. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitstyp	Der Arbeitstyp für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Feld: Name Datentyp: Zeichenfolge
Arbeitsauftragsnummer	Eindeutiger Bezeichner für den Arbeitsauftrag, z. B. WO0008004. Tabelle: Arbeitsauftrag [wm_order] Feld: Nummer Datentyp: Zeichenfolge

Header

Tabelle : 28. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 29. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt application/json.

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 30. Statuscodes
Statuscode	Beschreibung
201	Erstellt. Der Arbeitsauftrag wurde erfolgreich erstellt.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
@TYPE	Dieser Wert ist immer `Arbeitsauftrag` . Datentyp: Zeichenfolge
Kategorie	Kategorie für den Arbeitsauftrag, die von einem Auftragsmanagementsystem verwendet werden kann, z. B. `Unternehmen` Oder `Wohn` . Datentyp: Zeichenfolge
Abschlussdatum	Datum und Uhrzeit des Abschlusses des Arbeitsauftrags. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Arbeitsauftrags. Datentyp: Zeichenfolge
ExpectedCompletionDate	Erwartetes Abschlussdatum und -Uhrzeit, die vom Anbieter festgelegt wurden. Datentyp: Zeichenfolge
ExternalIdentifier	Liste der externen Referenzen, z. B. Lieferanten- oder Korrelations-ID. Datentyp: Array `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier.@type	Dieser Wert ist immer `ExternalIdentifierRef` . Datentyp: Zeichenfolge
externalIdentifier.id	Externe Referenz, z. B. Lieferanten- oder Korrelations-ID. Datentyp: Zeichenfolge
href	Relativer Link zum Arbeitsauftragsdatensatz. Datentyp: Zeichenfolge
id	SYS_ID des Arbeitsauftrags. Tabelle: Arbeitsauftrag [wm_order] Datentyp: Zeichenfolge
Initiatedaus	Referenz-ID, die angibt, wo der Arbeitsauftrag initiiert wurde. Beispiel: Eine sys_ID der Aufgabe aus der Tabelle „Arbeitsauftragsaufgabe“ [wm_Task]. Datentyp: Zeichenfolge
note	Liste der Notizen zum Auftrag. Datentyp: Array `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
Hinweis.@type	Dieser Wert ist immer `Hinweis` . Datentyp: Zeichenfolge
note.author	Autor der Notiz. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz dem Arbeitsauftrag hinzugefügt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Der Hinweistext. Datentyp: Zeichenfolge
Ort	Der geografische Standort, der dem Arbeitsauftrag zugeordnet ist. Datentyp: Objekt `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
Ort.@Typ	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
place.id	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
Ort.zugehörigPartei	Liste der Supportgruppen für den Standort. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Place.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
place.relatedParty.id	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
place.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Ort.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Priorität	Prioritätsrangliste für den Arbeitsauftrag. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Zugehörige Partei	Liste der zugeordneten Kontakte für den Arbeitsauftrag. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
relatedParty.id	SYS_ID der zugehörigen Partei. Tabelle: Account [Customer_Account], Unternehmen [Core_Company] oder Anwender [sys_user] Datentyp: Zeichenfolge
relatedParty.name	Name der zugehörigen Partei. Datentyp: Zeichenfolge
ZugehörigPartei.Rolle	Rolle der zugehörigen Partei. Mögliche Werte: Account Unternehmen Verbraucher Kontakt Datentyp: Zeichenfolge
AnfordertCompletionDate	Angefordertes Abschlussdatum und -Uhrzeit. Datentyp: Zeichenfolge
AnfordertStartdatum	Startdatum der Auftragserfüllung, das von der anfordernden Person festgelegt wurde. Wird in Fällen verwendet, in denen die anfordernde Person dem Anbieter nicht erlauben kann, die Erfüllung vor einem angegebenen Datum zu beginnen. Datentyp: Zeichenfolge
shortDescription	Kurze Zusammenfassung des Arbeitsauftrags. Datentyp: Zeichenfolge
startDate	Datum und Uhrzeit des Beginns der Bestellung. Datentyp: Zeichenfolge
Status	Status des Arbeitsauftrags. Mögliche Werte: Entwurf Warten auf Qualifizierung Qualifiziert Zugewiesen In Arbeit Abschließen Datentyp: Zeichenfolge
templateId	SYS_ID der Vorlage, die für den Arbeitsauftrag verwendet werden soll. Tabelle: Produktmodell [cmdb_model] Datentyp: Zeichenfolge
WorkOrderItem	Liste der Aufgaben unter dem Arbeitsauftrag. Datentyp: Array `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem.@type	Dieser Wert ist immer `Arbeitsauftragselement` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Aktion	Aktion, die für das Produkt für die Aufgabe ausgeführt werden soll. Mögliche Werte: Hinzufügen löschen modify NoChange Datentyp: Zeichenfolge
workOrderItem.completionDate	Datum und Uhrzeit des Abschlusses der Aufgabe. Datentyp: Zeichenfolge
workOrderItem.description	Beschreibung der Aufgabe. Datentyp: Zeichenfolge
workOrderItem.id	SYS_ID der Aufgabe. Tabelle: Arbeitsauftragsaufgabe [wm_Task] Datentyp: Zeichenfolge
workOrderItem.note	Liste der Notizen zur Aufgabe. Datentyp: Array `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Dieser Wert ist immer `Hinweis` . Datentyp: Zeichenfolge
workOrderItem.note.author	Autor der Notiz. Datentyp: Zeichenfolge
workOrderItem.note.date	Datum, an dem die Notiz der Aufgabe hinzugefügt wurde. Datentyp: Zeichenfolge
workOrderItem.note.text	Der Hinweistext. Datentyp: Zeichenfolge
Arbeitsauftragselement.Kurzbeschreibung	Kurze Beschreibung der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Status	Status der Aufgabe Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit	Beschreibung der für die Aufgabe erforderlichen Arbeit. Datentyp: Objekt `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
Arbeitsauftragselement.work.@type	Dieser Wert ist immer `WorkRefOrValue` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.erwartetes Abschlussdatum	Erwartetes Abschlussdatum für die Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ID	SYS_ID des Arbeitstyps für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Datentyp: Zeichenfolge
workOrderItem.work.place	Liste der geografischen Standorte, die der Aufgabe zugeordnet sind. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Dieser Wert ist immer `RelatedPlaceRefOrValue` . Datentyp: Zeichenfolge
workOrderItem.work.place.place	Details zum Standort. Datentyp: Objekt `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Dieser Wert ist immer `GeographicSite` . Datentyp: Zeichenfolge
workOrderItem.work.place.place.id	SYS_ID des Standorts. Tabelle: Standort [cmn_location] Datentyp: Zeichenfolge
workOrderItem.work.place.role	Rolle dieses Standorts im Kontext der Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei	Liste der Supportgruppen für die Aufgabe. Datentyp: Array `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Arbeitsauftragselement.Arbeit.relatedParty.@type	Dieser Wert ist immer `RelatedPartyRef` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei.ID	SYS_ID der Supportgruppe. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
workOrderItem.work.relatedParty.name	Name der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.zugehörigPartei.Rolle	Rolle der Supportgruppe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.scheduledStartdatum	Geplantes Startdatum für die Aufgabe. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragMitarbeiterzuweisung	Zuweisungsdetails für die Aufgabe. Datentyp: Array `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.@type	Dieser Wert ist immer `WorkforceMitarbeiterzuweisung` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragMitarbeiterzuweisung.ID	SYS_ID der Gruppe, die der Aufgabe zugewiesen ist. Tabelle: Gruppe [sys_user_group] Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter	Details zum Mitarbeiter, der der Aufgabe zugewiesen ist. Datentyp: Objekt `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.@type	Dieser Wert ist immer `Einzelperson` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragenMitarbeiterzuweisung.ArbeitsauftragsMitarbeiter.KontaktMittel	Liste der Telefonnummern des Mitarbeiters. Datentyp: Array `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
Arbeitsauftragselement.Arbeit.WorkforceMitarbeiterzuweisung.WorkforceMitarbeiter.contactMedium.@type	Dieser Wert ist immer `PhoneContactMedium` . Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsteMitarbeiterzuweisung.ArbeitsteMitarbeiter.KontaktMittel.Telefonnummer	Telefonnummer des Mitarbeiters. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.ArbeitsauftragMitarbeiterzuweisung.ArbeitsauftragMitarbeiter.ID	SYS_ID des Mitarbeiters. Tabelle: Benutzer [sys_user] Datentyp: Zeichenfolge
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Name des Mitarbeiters. Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitspriorität	Prioritätsrangliste für die Aufgabe. Mögliche Werte: 1 – Kritisch 2 – Hoch 3 – Mittel 4 – Niedrig 5 – In Planung Datentyp: Zeichenfolge
Arbeitsauftragselement.Arbeit.Arbeitstyp	Der Arbeitstyp für die Aufgabe. Tabelle: Arbeitstyp [wm_work_type] Feld: Name Datentyp: Zeichenfolge
Arbeitsauftragsnummer	Eindeutiger Bezeichner für den Arbeitsauftrag, z. B. WO0008004. Tabelle: Arbeitsauftrag [wm_order] Feld: Nummer Datentyp: Zeichenfolge

cURL-Anforderung

Erstellt einen Arbeitsauftrag und eine Aufgabe mithilfe einer Vorlage.

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "id": "323",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "templateId": "191ba0e0df113100dca6a5f59bf26336",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   }
}" \
--user 'username':'password'

Antworttext.

{
   "id": "ca6d72d1ffa96210b79dffffffffffa1",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "templateId": "191ba0e0df113100dca6a5f59bf26336",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   },
   "href": "api/sn_tmf_api/work_order_management_api/workOrder/ca6d72d1ffa96210b79dffffffffffa1"
}

cURL-Anforderung

Erstellt einen Arbeitsauftrag und eine Aufgabe ohne Verwendung einer Vorlage.

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "id": "323",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   }
}" \
--user 'username':'password'

Antworttext.

{
   "id": "24fc3259ffa96210b79dffffffffff56",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   },
   "href": "api/sn_tmf_api/work_order_management_api/workOrder/24fc3259ffa96210b79dffffffffff56"
}