API „Serviceauftrag öffnen“.

Freigeben Version: Washingtondc

Aktualisiert 1. Februar 2024

55 Minuten Lesedauer

Die Service Order Open- API bietet einen standardisierten Mechanismus für die Erteilung von Serviceaufträgen.

Diese API ist eine ServiceNow® -Implementierung der Open API TMForum TMF641 Service Ordering Management API-Spezifikation.

Für den Zugriff auf diese API muss das Plugin Order Management for Telecommunications (sn_ind_tmt_orm) aktiviert sein. Weitere Informationen finden Sie unter Install Order Management . Weitere Informationen zu Tabellen, Entitäten und Beziehungen [ Order Management finden Sie unter Order Management data model.

Diese API wird innerhalb des Namespace sn_ind_tmt_orm bereitgestellt.

Der aufrufende Benutzer muss die Rolle sn_ind_tmt_orm.order_integrator haben.

Diese API kann erweitert werden, um Anpassungen für erforderliche Parameter, Anforderungstextvalidierung, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unter das Service Order Open API-Entwicklerleitfaden.

Service Order Open API – GET /sn_ind_tmt_orm/serviceorder

Ruft alle Serviceaufträge ab.

Diese API ruft Informationen zu Serviceaufträgen aus den folgenden zugehörigen Tabellen ab:

Bestellung [sn_ind_tmt_orm_order]
Bestellmerkmalswert [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Auftragsposition [sn_ind_tmt_orm_order_line_related_items]

URL-Format

/api/sn_ind_tmt_orm/serviceorder

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 2. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Datentyp: Zeichenfolge Standard: Alle Felder zurückgegeben.
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Standard: 20 Höchstwert: 100 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
Status	Filtern Sie Aufträge nach Status. Nur Aufträge mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge Standard: Alle zurückgegebenen Status.

Tabelle : 3. Anforderungstextparameter (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
Keine

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltsbereich	Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird. Wenn beispielsweise `offset=2` und `limit=3`festgelegt ist, lautet der Wert der Kopfzeile Content-Range`items 3-5`.
Content-Type	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodesder REST-API.

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
206	In Antwort zurückgegebene Teilressource (mit Paginierung).
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Datentyp: Zeichenfolge
erwartetesAbschlussdatum	Datum, an dem der Auftrag abgeschlossen werden soll. Datentyp: Zeichenfolge
id	Sys_id des angeforderten Serviceauftrags. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
Hinweis.Autor	Benutzername der Person, die die zugehörige Notiz verfasst hat. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge
ponr	Kennzeichnung, die angibt, ob der Point of no Return für die Bestellung erreicht wurde. Gültige Werte: true: Der Point of no Return für die Bestellung wurde erreicht. Der Auftrag kann während der Erfüllung nicht geändert oder storniert werden. false: Point of no Return für die Bestellung wurde nicht erreicht. Der Auftrag kann geändert oder storniert werden. Datentyp: Boolesch
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
serviceOrderItem	Array von Objekten, das die Einzelposten im Serviceauftrag und die zugehörige Aktion beschreibt. `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ]` Datentyp: Array
serviceOrderItem.action	Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte Auswahlliste im Feld Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Details finden Sie unter Action types for customer and service orders. Datentyp: Zeichenfolge
serviceOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
serviceOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
serviceOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
serviceOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceOrderItem.orderRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceOrderItem.orderRelationship.relationshipType	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceAuftragselement.Menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
serviceOrderItem.place	Zuordnung der Speicherorte, an denen der Service installiert werden soll Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceOrderItem.place.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.ponr	Kennzeichnung, die angibt, ob der Point of no Return für die Auftragsposition erreicht wurde. Gültige Werte: true: Der Point of no Return für die Auftragsposition wurde erreicht. Die Auftragsposition kann nicht geändert oder storniert werden, während die Erfüllung ausgeführt wird. false: Point of no Return für die Auftragsposition wurde nicht erreicht. Die Bestellposition kann geändert oder storniert werden. Datentyp: Boolesch
serviceOrderItem.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" [ { "email": "String", "firstName": "String" "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
serviceOrderItem.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@referredType	Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceAuftragselement.service	Beschreibung der Instanzdetails des vom Kunden erworbenen Service. Datentyp: Objekt `"service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" }`
serviceOrderItem.service.serviceCharacteristic	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value zurückgegeben, der sich vom previousValue unterscheidet. Datentyp: Array von Objekten `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.valueType	Typ des Merkmalswerts. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship	Liste der Produktbestände, die sich auf den Service beziehen. Datentyp: Array `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id oder sn_prd_invt_external_id des Produktbestands. Befindet sich im Feld sys_id oder sn_prd_invt_external_id der Produktbestandstabelle [sn_prd_invt_product_inventory]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship.relationshipType	Typ der Beziehung zwischen dem Service und dem Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification	Beschreibung der Servicespezifikation, die dem Service zugeordnet ist. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Initial_version oder external_id der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.internalId	Initial_version der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.internalVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.version	External_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceType	Servicetyp. Datentyp: Zeichenfolge
serviceAuftragselement.service.status	Status des verkauften Produkts. Beispiel: neu. Datentyp: Zeichenfolge
serviceOrderItem.state	Status der Serviceauftragsposition. Beispiel: neu. Datentyp: Zeichenfolge
serviceOrderItem.version	Version des Serviceauftrags-Einzelpostens. Datentyp: Zeichenfolge
serviceOrderItem.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Status	Status des Serviceauftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden alle Serviceaufträge abgerufen.

curl --location --request GET 'https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder' \
--user 'username':'password'

Antworttext.

[
   {
      "id": "4f2af65ac3a030106e2473ce3640ddcf",
      "ponr": "false",
      "expectedCompletionDate": "2018-01-15T09:37:40.000Z",
      "requestedCompletionDate": "2018-01-15T09:37:40.000Z",
      "requestedStartDate": "2018-01-15T09:37:40.000Z",
      "note": [
         {
            "author": "System Administrator",
            "date": "2021-06-07T14:53:04.000Z",
            "text": "This is a TMF service order illustration no 2"
         },
         {
            "author": "System Administrator",
            "date": "2021-06-07T14:53:03.000Z",
            "text": "This is a TMF service order illustration"
         }
      ],
      "serviceOrderItem": [
         {
            "id": "100",
            "ponr": "false",
            "action": "add",
            "actionReason": "adding service package OLI",
            "quantity": 1,
            "service": {
               "@type": "Service",
               "state": "",
               "serviceType": "cfs",
               "serviceCharacteristic": [
                  {
                     "name": "Firewall coverage",
                     "valueType": "choice",
                     "value": "Premium (Up to 50 sites)",
                     "previousValue": ""
                  },
                  {
                     "name": "Firewall Security",
                     "valueType": "choice",
                     "value": "Standard",
                     "previousValue": ""
                  },
                  {
                     "name": "Administration Support",
                     "valueType": "choice",
                     "value": "Basic (Customer Managed)",
                     "previousValue": ""
                  }
               ],
               "serviceRelationship": [
                  {
                     "id": "326d13f45b5620102dff5e92dc81c785",
                     "relationshipType": "Requires"
                  }
               ],
               "serviceSpecification": {
                  "id": "f99546ff07266010a7955b7e0ad300a8",
                  "name": "Managed Firewall Service",
                  "version": "v2",
                  "internalVersion": "2",
                  "internalId": " f99546ff07266010a7955b7e0ad300a8",
                  "@type": "ServiceSpecificationRef"
               }
            },
            "place": {
               "id": "920cf6ac73d423002728660c4cf6a799",
               "@type": "Place"
            },
            "relatedParty": [
               {
                  "id": "972af65ac3a030106e2473ce3640ddda",
                  "firstName": "Mike",
                  "lastName": "Hudson",
                  "email": "mike@example.com",
                  "phone": "1234567890",
                  "@type": "RelatedParty",
                  "@referredType": "OrderLineItemContact"
               }
            ],
            "state": "new",
            "version": "1",
            "@type": "ServiceOrderItem"
         }
      ],
      "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
      "state": "new",
      "version": "1",
      "@type": "ServiceOrder"
   }
]

Service Order Open API – GET /sn_ind_tmt_orm/serviceorder/{id}

Ruft einen angegebenen Serviceauftrag ab.

Diese API ruft Informationen zu Serviceaufträgen aus den folgenden zugehörigen Tabellen ab:

Bestellung [sn_ind_tmt_orm_order]
Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
Bestellmerkmalswert [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Auftragsposition [sn_ind_tmt_orm_order_line_related_items]

URL-Format

/api/sn_ind_tmt_orm/serviceorder/{id}

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter
Name	Beschreibung
id	Sys_id des abzurufenden Serviceauftrags. Befindet sich in der Auftragstabelle [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 9. Anforderungstextparameter (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 10. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 11. Antwortkopfzeilen
Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodesder REST-API.

Tabelle : 12. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung). Die Antwort gibt „Success“ mit einer Fehlermeldung zurück, wenn der ausgewählte Auftrag Verarbeitungsprobleme aufweist. Die Antwort 200 OK erfolgt, wenn sich der Auftrag in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] befindet und darauf wartet, dass der Planer den zu verarbeitenden Datensatz auswählt. Das Fehlermeldungsfeld enthält Details für den Datensatz. Beispiel: `{ "code": 102, "reason": "Request in queue", "message": "Request in queue", "details": [ { "message": "This Order is still in the inbound queue table waiting to be processed.", "datapath": "" } ] }` Die Antwort 200 OK erfolgt, wenn eine Auftragserstellung fehlschlägt und der Datensatz in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] einen Fehlerstatus aufweist. Das Fehlermeldungsfeld enthält Details in für den Datensatz der Tabelle der eingehenden Warteschlange. Beispiel: `{ "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] }`
400	Ungültige Anforderung. Mögliche Gründe: Abfrageparameter fehlt Ungültiger URI
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Datentyp: Zeichenfolge
erwartetesAbschlussdatum	Datum, an dem der Auftrag abgeschlossen werden soll. Datentyp: Zeichenfolge
id	Sys_id des angeforderten Serviceauftrags. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
Hinweis.Autor	Benutzername der Person, die die zugehörige Notiz verfasst hat. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge
ponr	Kennzeichnung, die angibt, ob der Point of no Return für die Bestellung erreicht wurde. Gültige Werte: true: Der Point of no Return für die Bestellung wurde erreicht. Der Auftrag kann während der Erfüllung nicht geändert oder storniert werden. false: Point of no Return für die Bestellung wurde nicht erreicht. Der Auftrag kann geändert oder storniert werden. Datentyp: Boolesch
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
serviceOrderItem	Array von Objekten, das die Einzelposten im Serviceauftrag und die zugehörige Aktion beschreibt. Datentyp: Array `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ]`
serviceOrderItem.action	Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte Auswahlliste im Feld Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Weitere Informationen finden Sie unter Action types for customer and service orders Datentyp: Zeichenfolge
serviceOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
serviceOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
serviceOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
serviceOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceOrderItem.orderRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceOrderItem.orderRelationship.relationshipType	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceAuftragselement.Menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
serviceOrderItem.place	Zuordnung der Speicherorte, an denen der Service installiert werden soll Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceOrderItem.place.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.ponr	Kennzeichnung, die angibt, ob der Point of no Return für die Auftragsposition erreicht wurde. Gültige Werte: true: Der Point of no Return für die Auftragsposition wurde erreicht. Die Auftragsposition kann nicht geändert oder storniert werden, während die Erfüllung ausgeführt wird. false: Point of no Return für die Auftragsposition wurde nicht erreicht. Die Bestellposition kann geändert oder storniert werden. Datentyp: Boolesch
serviceOrderItem.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String" "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@referredType	Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceAuftragselement.service	Beschreibung der Instanzdetails des vom Kunden erworbenen Service. `"service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" }` Datentyp: Objekt
serviceOrderItem.service.serviceCharacteristic	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value zurückgegeben, der sich vom previousValue unterscheidet. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.valueType	Typ des Merkmalswerts. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship	Liste der Produktbestände, die sich auf den Service beziehen. Datentyp: Array `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id oder sn_prd_invt_external_id des Produktbestands. Befindet sich im Feld sys_id oder sn_prd_invt_external_id der Produktbestandstabelle [sn_prd_invt_product_inventory]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship.relationshipType	Typ der Beziehung zwischen dem Service und dem Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification	Beschreibung der Servicespezifikation, die dem Service zugeordnet ist. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Initial_version oder external_id der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.internalId	Initial_version der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.internalVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.version	External_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceType	Servicetyp. Datentyp: Zeichenfolge
serviceAuftragselement.service.status	Status des verkauften Produkts. Beispiel: neu. Datentyp: Zeichenfolge
serviceOrderItem.state	Status der Serviceauftragsposition. Beispiel: neu. Datentyp: Zeichenfolge
serviceOrderItem.version	Version des Serviceauftrags-Einzelpostens. Datentyp: Zeichenfolge
serviceOrderItem.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Status	Status des Serviceauftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Beispiel wird ein angegebener Serviceauftrag abgerufen.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder/4f2af65ac3a030106e2473ce3640ddcf" \
--request GET \
--user 'username':'password'

Antworttext.

{
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "ponr": "false",
   "expectedCompletionDate": "2018-01-15T09:37:40.000Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.000Z",
   "requestedStartDate": "2018-01-15T09:37:40.000Z",
   "note": [
      {
         "author": "System Administrator",
         "date": "2021-06-07T14:53:04.000Z",
         "text": "This is a TMF service order illustration no 2"
      },
      {
         "author": "System Administrator",
         "date": "2021-06-07T14:53:03.000Z",
         "text": "This is a TMF service order illustration"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "ponr": "false",
         "action": "add",
         "actionReason": "adding service package OLI",
         "quantity": 1,
         "service": {
            "@type": "Service",
            "state": "",
            "serviceType": "cfs",
            "serviceCharacteristic": [
               {
                  "name": "Firewall coverage",
                  "valueType": "choice",
                  "value": "Premium (Up to 50 sites)",
                  "previousValue": ""
               },
               {
                  "name": "Firewall Security",
                  "valueType": "choice",
                  "value": "Standard",
                  "previousValue": ""
               },
               {
                  "name": "Administration Support",
                  "valueType": "choice",
                  "value": "Basic (Customer Managed)",
                  "previousValue": ""
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "version": "v2",
               "internalVersion": "2",
               "internalId": "f99546ff07266010a7955b7e0ad300a8",
               "@type": "ServiceSpecificationRef"
            }
         },
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "relatedParty": [
            {
               "id": "972af65ac3a030106e2473ce3640ddda",
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "state": "new",
         "version": "1",
         "@type": "ServiceOrderItem"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "state": "new",
   "version": "1",
   "@type": "ServiceOrder"
}

Service Order Open API – PATCH /sn_ind_tmt_orm/order/serviceorder/{id}

Aktualisiert den angegebenen Serviceauftrag.

URL-Format

Standard-URL: /api/sn_ind_tmt_orm/order/serviceOrder/{id}

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter
Name	Beschreibung
id	Sys_id des zu aktualisierenden Kundenauftrags. Befindet sich in der Kundenauftragstabelle [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter (JSON)
Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Wenn die Aktion für Bestellpositionen `angehalten` oder `fortgesetzt`wird, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/committed_due_date
externe ID	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note:" [ { "text": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/comments Standard: Leere Zeichenfolge
orderDate	Datum der Kundenauftragsanforderung. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Die Anforderung muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Erforderlich. Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge Tabelle aktualisiert: sn_ind_tmt_orm_order
relatedPartei.name	Name einesAccounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_end_date Standard: Leere Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_start_date Standard: Leere Zeichenfolge
serviceOrderItem	Erforderlich. Array von Objekten, das die Einzelposten im Serviceauftrag und die zugehörige Aktion beschreibt. Datentyp: Array `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceOrderItem.action	Erforderlich. Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte Auswahlliste im Feld Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change löschen no-change resume anhalten Details finden Sie unter Action types for customer and service orders. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action
serviceOrderItem.actionReason	Optional. Beschreibung des Grunds für den Einzelposten. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: Auftragspositionselement [sn_ind_tmt_orm_order_line_item] table/action_reason.
serviceOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Wenn die Aktion für das Element `angehalten` oder `fortgesetzt`wird, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/committed_due_date
serviceOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_inventory_id und sn_prd_invt_product_inventory/sn_prd_invt_external_id
serviceOrderItem.id	Erforderlich. Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_id
serviceOrderItem.orderRelationship	Erforderlich. Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceOrderItem.orderRelationship.id	Erforderlich. Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/parent_line_item oder sn_ind_tmt_orm_order_line_related_items/related_order_line_item
serviceOrderItem.orderRelationship.relationshipType	Erforderlich. Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceOrderItem.place	Zuordnung der Speicherorte, an denen der Service installiert werden soll Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Erforderlich. Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/location
serviceOrderItem.place.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionselement. Datentyp: Zeichenfolge
serviceAuftragselement.Menge	Legt die Anzahl der zu bestellenden Einzelposten fest. Diese Eigenschaft gilt nur beim Hinzufügen eines Serviceauftrags. Das heißt, der Wert der Eigenschaft action ist `add`. Datentyp: Zahl Standard: Leere Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity
serviceOrderItem.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@referredType	Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceAuftragselement.service	Erforderlich. Beschreibung der Instanzdetails des vom Kunden erworbenen Service. Datentyp: Objekt `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceAuftragselement.service.id	Eindeutiger Bezeichner des verkauften Service. Dieser Wert kann die sys_id oder die externe ID in der Produktbestandstabelle [sn_ind_tmt_orm_product_inventory] sein. Dieser Wert wird nur für Change/Disconnect-Aufträge verwendet. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value zurückgegeben, der sich vom previousValue unterscheidet. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Name des Merkmalsdatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter serviceOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification	Erforderlich. Beschreibung der Servicespezifikation, die dem Service zugeordnet ist. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "name": "String", "@type": "String" }` Aktualisiert das Feld service_specification in der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item].
serviceOrderItem.service.serviceSpecification.id	Erforderlich. Initial_version oder external_id der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.name	Erforderlich. Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrder`. Diese Informationen werden nicht gespeichert. 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
Content-Type	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodesder REST-API.

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
201	Erfolgreich. Wenn Probleme mit den Merkmalen oder Merkmalsoptionsinformationen auftreten, speichert der Endpunkt die folgenden Kommentare in den Arbeitsnotizfeldern des zugeordneten Datensatzes für die Kundenauftragsposition: `Die folgenden Merkmale der Bestellposition sind nicht vorhanden: Überprüfen Sie die Spezifikation <specification.name>, und korrigieren Sie das Merkmal und die Merkmalsoption in der Auftragsposition, bevor Sie den Auftrag genehmigen.` `Merkmal der Bestellposition: <characteristic.name> mit Merkmalswert: <characteristic.value>ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.`
400	Ungültige Anforderung. Dies kann einen der folgenden Gründe haben: `Ungültige Nutzlast: Anforderungstext fehlt` – Nutzlast wurde im Anforderungstext nicht übergeben. `Ungültige Nutzlast: serviceOrderItem fehlt` – Objekt für Serviceauftrags-Einzelposition oder JSON fehlt. `Ungültige Nutzlast: serviceOrderItem-ID fehlt` – Der Parameter id fehlt in der Serviceauftragsposition der Nutzlast. `Ungültige Nutzlast: serviceOrderItem-Aktion fehlt` – Der Parameter action fehlt in der Serviceauftragsposition der Nutzlast. `Ungültige Nutzlast: serviceOrderItem serviceOffering fehlt` : Das Serviceangebotsobjekt oder JSON fehlt in der Serviceauftrags-Einzelposition in der Nutzlast. `Ungültige Nutzlast: serviceOffering-ID fehlt` – Der Parameter id fehlt in der Serviceauftragsposition des Serviceangebotsobjekts in der Nutzlast. `Ungültige Nutzlast: Serviceangebot ist nicht vorhanden` – Das Serviceangebot in der Serviceauftragsposition ist nicht gültig. `Ungültige Nutzlast: serviceOrderItem-Service fehlt` – Das Serviceobjekt oder JSON in der Serviceauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Serviceservice-Spezifikation fehlt` – Das Servicespezifikationsobjekt oder JSON in der Serviceauftrags-Einzelposition fehlt in der Nutzlast. `Ungültige Nutzlast: serviceSpecification-ID fehlt` – Der Parameter id in der Serviceauftragsposition des Servicespezifikationsobjekts fehlt in der Nutzlast. `Ungültige Nutzlast: Servicespezifikation ist nicht vorhanden` – Die Servicespezifikation in der Serviceauftrags-Einzelposition ist nicht gültig. `Ungültige Nutzlast: Servicebestand ist nicht vorhanden` – In einem Change-Auftrag (Aktion = Change) ist die Menge eines Artikels größer als der Bestand. `Ungültige Nutzlast: Servicebestands-ID fehlt` – In einem Change-Auftrag fehlt service.id in der Nutzlast. `Ungültige Nutzlast: Verkaufter Service ist inaktiv` – In einem Change-Auftrag ist ein in der Nutzlast angegebener Service inaktiv. `Ungültige Nutzlast: relatedPartei fehlt` : Das Objekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Kunden-Account oder Verbraucher fehlt` : Das Kunden- oder Verbraucherobjekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Kunden-Account ist nicht vorhanden` – Der angegebene Kunde der zugehörigen Partei ist in der Instanz nicht vorhanden. `Ungültige Nutzlast: Verbraucher ist nicht vorhanden` – Der angegebene zugehörige Verbraucher ist in der Instanz nicht vorhanden. `Ungültige Nutzlast: Auftragserstellung fehlgeschlagen` – der angeforderte Auftrag kann nicht erstellt werden. `Überarbeitung während der Ausführung in Auftragswährung nicht unterstützt` – Der Parameter orderCurrency kann nach dem Erstellen des Auftrags nicht aktualisiert werden. `Dieser Auftrag muss noch in der Kundenauftragstabelle erstellt werden. Weitere Details finden Sie in der eingehenden Warteschlange.` – Die angegebene Auftrags-ID ist nicht in der Kundenauftragstabelle enthalten. `Die Patch-Anforderung kann nicht gestellt werden, da der Erfüllungstyp des Auftrags nicht „liefern“ ist.` – Die Patch-Anforderung wurde für einen Auftrag gestellt, der einen anderen Erfüllungstyp als „Liefern“ aufweist.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Datentyp: Zeichenfolge
externe ID	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge
id	Sys_id des Serviceauftrags. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "text": "String" } ]`
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts oder Kundenkontakts , der dem Auftrag zugeordnet ist. Befindet sich in den Tabellen „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
serviceOrderItem	Array von Objekten, das die Einzelposten im Serviceauftrag und die zugehörige Aktion beschreibt. Datentyp: Array `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]`
serviceOrderItem.action	Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte Auswahlliste im Feld Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change löschen Details finden Sie unter Action types for customer and service orders. Datentyp: Zeichenfolge
serviceOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
serviceOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
serviceOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
serviceOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceOrderItem.orderRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceOrderItem.orderRelationship.relationshipType	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceOrderItem.place	Zuordnung der Speicherorte, an denen der Service installiert werden soll Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceOrderItem.place.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceAuftragselement.Menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
serviceOrderItem.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@referredType	Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceAuftragselement.service	Beschreibung der Instanzdetails des vom Kunden erworbenen Service. Datentyp: Objekt `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }`
serviceAuftragselement.service.id	Eindeutiger Bezeichner des verkauften Service. Dieser Wert kann die sys_id oder die externe ID in der Produktbestandstabelle [sn_ind_tmt_orm_product_inventory] sein. Dieser Wert wird nur für Change/Disconnect-Aufträge zurückgegeben. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value zurückgegeben, der sich vom previousValue unterscheidet. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Name des Merkmalsdatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter serviceOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification	Beschreibung der Servicespezifikation, die dem Service zugeordnet ist. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "name": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Initial_version oder external_id der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Status	Status des Serviceauftrags. Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Beispiel zeigt, wie ein Serviceauftrag aktualisiert wird.

curl -X PATCH 'https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder/a831e56e77602110c8b3a4d54b5a9954' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      "actionReason":"adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic( Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "relatedParty":     "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}'
Sarsij Kumar02:14
Change the response as well to the following
Sarsij Kumar02:14
{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      "actionReason": "adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic( Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service",
          "sys_id": "f99546ff07266010a7955b7e0ad300a8",
          "version": "",
          "status": "published",
          "internalId": "f99546ff07266010a7955b7e0ad300a8"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "orderType": "add",
  "state": "revision_received",
  "href": "/api/sn_ind_tmt_orm/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954"
}

Antworttext.

{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      v"actionReason": "adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic(Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service",
          "sys_id": "f99546ff07266010a7955b7e0ad300a8",
          "version": "",
          "status": "published",
          "internalId": "f99546ff07266010a7955b7e0ad300a8"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "relatedParty": [    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "orderType": "add",
  "state": "revision_received",
  "href": "/api/sn_ind_tmt_orm/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954"
}

Service Order Open API – POST /sn_ind_tmt_orm/cancelserviceorder

Bricht den angegebenen Serviceauftrag ab.

Hinweis:

Dieser Endpunkt kann nicht für Aufträge verwendet werden, für die der Point of no Return erreicht wurde. Eine Auftragsposition kann nicht storniert werden, während die Erfüllung ausgeführt wird.

URL-Format

Standard-URL: /api/sn_ind_tmt_orm/cancelserviceorder

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 20. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 21. Anforderungstextparameter (JSON)
Name	Beschreibung
Stornierungsgrund	Grund für den Abbruch. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
serviceOrder	Enthält Daten zum Serviceauftrag. Datentyp: Objekt `"serviceOrder": { "id": "String", "href": "String", "@referredType": "String" }`
serviceOrder.id	Erforderlich. Sys_id des zu stornierenden Kundenauftrags. Befindet sich in der Kundenauftragstabelle [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
serviceOrder.href	URL des zu stornierenden Kundenauftrags. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
serviceOrder.@referredType	Der Wert für diesen Parameter muss `ServiceOrder`sein. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
angefordertesCancellationDate	Datum, an dem die Bestellung storniert werden soll. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
@type	Der Wert für diesen Parameter muss `CancelServiceOrder`sein. Datentyp: Zeichenfolge Standard: Leere 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
Content-Type	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodesder REST-API.

Tabelle : 24. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Dies kann einen der folgenden Gründe haben: Leere Nutzlast. Ungültige Nutzlast. Pflichtfeld fehlt:<field name> . Ungültige Auftrags-ID. Ungültige Auftrags-ID: `Dieser Auftrag muss noch in der Kundenauftragstabelle erstellt werden`. Die Stornierungsanforderung wurde für einen Auftrag gestellt, der noch nicht erstellt wurde. Der Auftrag befindet sich in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] und wartet darauf, dass der Scheduler den Datensatz abholt.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
Stornierungsgrund	Grund für den Abbruch. Datentyp: Zeichenfolge
id	Sys_id des stornierten Auftrags. Datentyp: Zeichenfolge
serviceOrder	Enthält Daten zum Serviceauftrag. Datentyp: Objekt `"serviceOrder": { "id": "String", "@referredType": "String" }`
serviceAuftrag.id	Sys_id des stornierten Auftrags. Datentyp: Zeichenfolge
serviceOrder.@referredType	Der Wert für diesen Parameter ist `ServiceOrder`. Datentyp: Zeichenfolge
angefordertesCancellationDate	Datum, an dem die Bestellung storniert werden soll. Datentyp: Zeichenfolge
Status	Status der Stornierung. Wenn die Stornierungsanforderung erfolgreich verarbeitet wurde (Statuscode 201), lautet der Wert für diesen Parameter `fertig`. Datentyp: Zeichenfolge
@type	Der Wert für diesen Parameter ist `CancelServiceOrder`. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Codebeispiel wird ein Kundenauftrag storniert.

curl -X POST "https://instance.servicenow.com/api/sn_ind_tmt_orm/cancelserviceorder" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
  "cancellationReason": "Duplicate order",
  "requestedCancellationDate": "2023-01-24T11:56:21.931Z",
  "serviceOrder": {
    "id": "5f4f5e5377a311101fa5a4d54b5a99fd",
    "@referredType": "ServiceOrder"
  },
  "@type": "CancelServiceOrder"
}

{
  "id": "5f4f5e5377a311101fa5a4d54b5a99fd",
  "cancellationReason": "Duplicate order",
  "requestedCancellationDate": "2023-01-24T11:56:21.931Z",
  "@type": "CancelServiceOrder",
  "serviceOrder": {
    "id": "5f4f5e5377a311101fa5a4d54b5a99fd",
    "@referredType": "ServiceOrder"
  },
  "state": "done"
}

Service Order Open API – POST /sn_ind_tmt_orm/serviceorder

Erstellt, aktualisiert oder löscht einen Serviceauftrag oder eine Position.

Wenn eine Aktion zum Hinzufügen empfangen und akzeptiert wird, wird in den folgenden Tabellen ein neuer Datensatz erstellt:

Bestellung [sn_ind_tmt_orm_order]
Bestellmerkmalswert [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Auftragsposition [sn_ind_tmt_orm_order_line_related_items]

URL-Format

/api/sn_ind_tmt_orm/serviceorder

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 26. Abfrageparameter
Name	Beschreibung
Modus	Aktiviert die asynchrone Auftragsverarbeitung. Das heißt, der Auftrag wird der zu erstellenden Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] hinzugefügt. Wenn nicht enthalten, wird die Bestellung synchron verarbeitet. Möglicher Wert: async Datentyp: Zeichenfolge

Tabelle : 27. Anforderungstextparameter (JSON)
Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/committed_due_date
externe ID	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note:" [ { "text": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/comments Standard: Leere Zeichenfolge
orderDate	Datum der Kundenauftragsanforderung. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Die Anforderung muss mindestens ein Element auflisten, das Informationen zum Kunden- oder Verbraucherkonto enthält. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Erforderlich. Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge Tabelle aktualisiert: sn_ind_tmt_orm_order
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Kunde Kundenkontakt Verbraucher Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_end_date Standard: Leere Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_start_date Standard: Leere Zeichenfolge
serviceOrderItem	Erforderlich. Array von Objekten, das die Einzelposten im Serviceauftrag und die zugehörige Aktion beschreibt. Datentyp: Array `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceOrderItem.action	Erforderlich. Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte Auswahlliste im Feld Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change löschen no-change resume anhalten Details finden Sie unter Action types for customer and service orders. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action Standard: hinzufügen
ServiceAuftragselement.Aktionsgrund	Optional. Beschreibung des Grunds für den Einzelposten. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: Auftragspositionselement [sn_ind_tmt_orm_order_line_item] table/action_reason.
serviceOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/committed_due_date
serviceOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_inventory_id und sn_prd_invt_product_inventory/sn_prd_invt_external_id
serviceOrderItem.id	Erforderlich. Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_id
serviceOrderItem.orderRelationship	Erforderlich. Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceOrderItem.orderRelationship.id	Erforderlich. Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/parent_line_item oder sn_ind_tmt_orm_order_line_related_items/related_order_line_item
serviceOrderItem.orderRelationship.relationshipType	Erforderlich. Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceOrderItem.place	Zuordnung der Speicherorte, an denen der Service installiert werden soll Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Erforderlich. Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/location Standard: Leere Zeichenfolge
serviceOrderItem.place.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionselement. Datentyp: Zeichenfolge
serviceAuftragselement.Menge	Legt die Anzahl der zu bestellenden Einzelposten fest. Diese Eigenschaft gilt nur beim Hinzufügen eines Serviceauftrags. Das heißt, der Wert der Eigenschaft action ist `add`. Datentyp: Zahl Standard: Leere Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity
serviceOrderItem.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@referredType	Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceAuftragselement.service	Erforderlich. Beschreibung der Instanzdetails des vom Kunden erworbenen Service. Datentyp: Objekt `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceAuftragselement.service.id	Eindeutiger Bezeichner des verkauften Service. Dieser Wert kann die sys_id oder die externe ID in der Produktbestandstabelle [sn_ind_tmt_orm_product_inventory] sein. Dieser Wert wird nur für Change/Disconnect-Aufträge verwendet. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value zurückgegeben, der sich vom previousValue unterscheidet. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Name des Merkmalsdatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter serviceOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship	Liste der Produktbestände, die sich auf den Service beziehen. Datentyp: Array `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id oder sn_prd_invt_external_id des Produktbestands. Befindet sich im Feld sys_id oder sn_prd_invt_external_id der Produktbestandstabelle [sn_prd_invt_product_inventory]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship.relationshipType	Typ der Beziehung zwischen dem Service und dem Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification	Erforderlich. Beschreibung der Servicespezifikation, die dem Service zugeordnet ist. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Aktualisiert das Feld service_specification in der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item].
serviceOrderItem.service.serviceSpecification.id	Erforderlich. Initial_version oder external_id der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.internalVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.name	Erforderlich. Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.version	External_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

Header

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

Tabelle : 29. Antwortkopfzeilen
Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodesder REST-API.

Tabelle : 30. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
201	Erfolgreich. Wenn Probleme mit den Merkmalen oder Merkmalsoptionsinformationen auftreten, speichert der Endpunkt die folgenden Kommentare in den Arbeitsnotizfeldern des zugeordneten Datensatzes für die Kundenauftragsposition: Die folgenden Merkmale der Bestellposition sind nicht vorhanden: Überprüfen Sie die Spezifikation <specification.name>, und korrigieren Sie das Merkmal und die Merkmalsoption in der Auftragsposition, bevor Sie den Auftrag genehmigen. Merkmal der Bestellposition: <characteristic.name> mit Merkmalswert: <characteristic.value> ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.
202	Akzeptiert. Erfolgreiche Anforderung für einen Auftrag im asynchronen Modus. Das heißt, die Anforderung wurde mit dem Parameter mode auf `async` gestellt, und der Datensatz ist zur Verarbeitung in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] geplant.
400	Ungültige Anforderung. Dies kann einen der folgenden Gründe haben: Ungültige Nutzlast: Anforderungstext fehlt. Nutzlast wurde im Anforderungstext nicht übergeben. Ungültige Nutzlast: serviceOrderItem fehlt. Objekt für Serviceauftrags-Einzelposten oder JSON fehlt. Ungültige Nutzlast: serviceOrderItem-ID fehlt. – Die ID fehlt in der Serviceauftrags-Einzelposition. Ungültige Nutzlast: serviceOrderItem-Aktion fehlt. – Das Serviceobjekt oder JSON fehlt in der Nutzlast. Ungültige Nutzlast: serviceOrderItem-Service fehlt. – Die Serviceeigenschaft fehlt in der Serviceauftragsposition. Ungültige Nutzlast: serviceSpecification fehlt. Das Servicespezifikationsobjekt oder JSON in der Serviceauftragsposition fehlt in der Nutzlast. Ungültige Nutzlast: serviceSpecification-ID fehlt. Der Parameter id in der Serviceauftragsposition des Servicespezifikationsobjekts fehlt in der Nutzlast. Ungültige Nutzlast: Servicespezifikation ist nicht vorhanden. – Die Servicespezifikation in der Serviceauftrags-Einzelposition ist ungültig. Ungültige Nutzlast: Produktbestand ist nicht vorhanden. - In einem Change- oder Löschauftrag (z. B. Aktion = Ändern oder Löschen) ist der gesendete verkaufte Service nicht im System vorhanden. Ungültige Nutzlast: Produktbestands-ID fehlt. – In einem Change- oder Löschauftrag fehlt die ID des verkauften Produkts in der Nutzlast. Ungültige Nutzlast: Kunden-Account oder Verbraucher fehlt: Das Kunden- oder Verbraucherobjekt der zugehörigen Partei fehlt in der Nutzlast. Ungültige Nutzlast: Verkauftes Produkt ist inaktiv. – In einem Change- oder Löschauftrag befindet sich das in der Nutzlast gesendete verkaufte Produkt nicht im aktiven Status. Ungültige Nutzlast: Verbraucher ist nicht vorhanden – Der angegebene zugehörige Verbraucher ist in der Instanz nicht vorhanden. Ungültige Nutzlast: Kundenaccount ist nicht vorhanden. – Der in der Nutzlast angegebene Kunde der zugehörigen Partei ist nicht im System vorhanden. Ungültige Nutzlast: Auftragserstellung fehlgeschlagen. – Die angeforderte Bestellung kann nicht erstellt werden.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Datentyp: Zeichenfolge
externe ID	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge
id	Sys_id des Serviceauftrags. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "text": "String" } ]`
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge
orderId	Sys_id des zu erstellenden Auftrags. Bei erfolgreicher Anforderung wird der Auftrag der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] in einem zu verarbeitenden Zeitplan hinzugefügt. Hinweis: Dieser Wert ist das einzige Ergebnis, wenn die Bestellung asynchron mit dem Abfrageparameter mode erstellt wird. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts oder Kundenkontakts , der dem Auftrag zugeordnet ist. Befindet sich in den Tabellen „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Kunde Kundenkontakt Verbraucher Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
serviceOrderItem	Array von Objekten, das die Einzelposten im Serviceauftrag und die zugehörige Aktion beschreibt. Datentyp: Array `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]`
serviceOrderItem.action	Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte Auswahlliste im Feld Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change löschen no-change resume anhalten Details finden Sie unter Action types for customer and service orders. Datentyp: Zeichenfolge
ServiceAuftragselement.Aktionsgrund	Beschreibung des Grunds für das Hinzufügen des Einzelpostens. Befindet sich in der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
serviceOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
serviceOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceOrderItem.orderRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceOrderItem.orderRelationship.relationshipType	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceOrderItem.place	Zuordnung der Speicherorte, an denen der Service installiert werden soll Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceOrderItem.place.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceAuftragselement.Menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
serviceOrderItem.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@referredType	Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceOrderItem.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceAuftragselement.service	Beschreibung der Instanzdetails des vom Kunden erworbenen Service. Datentyp: Objekt `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }`
serviceAuftragselement.service.id	Eindeutiger Bezeichner des verkauften Service. Dieser Wert kann die sys_id oder die externe ID in der Produktbestandstabelle [sn_ind_tmt_orm_product_inventory] sein. Dieser Wert wird nur für Change/Disconnect-Aufträge zurückgegeben. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value zurückgegeben, der sich vom previousValue unterscheidet. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Name des Merkmalsdatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter serviceOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship	Liste der Produktbestände, die sich auf den Service beziehen. Datentyp: Array `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id oder sn_prd_invt_external_id des Produktbestands. Befindet sich im Feld sys_id oder sn_prd_invt_external_id der Produktbestandstabelle [sn_prd_invt_product_inventory]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship.relationshipType	Typ der Beziehung zwischen dem Service und dem Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification	Beschreibung der Servicespezifikation, die dem Service zugeordnet ist. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Initial_version oder external_id der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.internalId	Initial_version der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.internalVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.version	External_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.state	Status der Serviceauftragsposition. Beispiel: neu. Datentyp: Zeichenfolge
serviceOrderItem.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Status	Status des Serviceauftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

Wird asynchron verarbeitet

Dieses Beispiel zeigt, wie Sie den Abfrageparameter mode verwenden, um einen Auftrag asynchron zu erstellen. Die Bestellung wird der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] nach einem zu erstellenden Zeitplan hinzugefügt.

curl -X POST 'https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder?mode=async' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      "actionReason":"adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic( Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}'

Antworttext.

{
  "orderId": "304e877ac3ab5110856d73ce3640dde5"
}

Synchrone Verarbeitung (Standard)

Das folgende Beispiel zeigt, wie Sie einen Serviceauftrag erstellen, indem Sie die Eigenschaft serviceOrderItem.action auf hinzufügen festlegen.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "add",
         "actionReason":"adding service package OLI",
         "quantity": 1,
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Standard"
               },
               {
                  "name": "Firewall coverage",
                  "value": "Premium (Up to 50 sites)"
               },
               {
                  "name": "Administration Support",
                  "value": "Basic (Customer Managed)"
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "@type": "Managed Firewall Service"
            }
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

Antworttext:

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "add",
         "actionReason":"adding service package OLI",
         "quantity": 1,
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Standard"
               },
               {
                  "name": "Firewall coverage",
                  "value": "Premium (Up to 50 sites)"
               },
               {
                  "name": "Administration Support",
                  "value": "Basic (Customer Managed)"
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "@type": "Managed Firewall Service",
               "internalVersion": "2",
               "version": "v2",
               "internalId": "f99546ff07266010a7955b7e0ad300a8"
            }
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "state": "new"
}

cURL-Anforderung

Im folgenden Beispiel wird ein Serviceauftrag aktualisiert, indem die Eigenschaft serviceOrderItem.action auf geändert wird.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "change",
         "actionReason":"change service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

Antworttext.

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "change",
         "actionReason":"change service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "state": "new"
}

cURL-Anforderung

Im folgenden Beispiel wird eine Serviceauftrags-Einzelposition gelöscht, indem die Eigenschaft serviceOrderItem.action auf deletefestgelegt wird.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "delete",
         "actionReason":"delete service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

Antworttext.

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "delete",
         "actionReason":"delete service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "state": "new"
}

Service Order Open API – POST /sn_ind_tmt_orm/serviceorder/outboundresponse

Aktualisiert den Erfüllungsstatus für die angegebenen Domänenauftragsdatensätze in der Tabelle „Ausgehende Anforderung“ [sn_tmt_core_outbound_request].

Zur Verwendung dieser Methode muss die Tabelle „Ausgehende Anforderung“ den angegebenen Domänenauftragsdatensatz enthalten. Außerdem löst die Methodenvalidierung einen Fehler aus, wenn sich die im Anforderungstext angegebenen Datensätze oder Status nicht im vorhandenen ausgehenden Datensatz befinden.

Hinweis:

Sie können mit diesem Endpunkt keine neuen Datensätze in dieser Tabelle erstellen.

Weitere Informationen zu Domänenaufträgen finden Sie unter Order Management data model.

URL-Format

/api/sn_ind_tmt_orm/serviceorder/outboundresponse

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 32. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 33. Anforderungstextparameter (JSON)
Name	Beschreibung
externe ID	Erforderlich. Ausgehender Anforderungsbezeichner des zur Erfüllung gesendeten Domänenauftragsdatensatzes. Befindet sich im Feld request_id in der Tabelle „Ausgehende Anforderung“ [sn_tmt_core_outbound_request]. Datentyp: Zeichenfolge
Serviceauftragselement	Erforderlich. Liste der Domänenaufträge, deren externer Erfüllungsstatus aktualisiert werden muss. Datentyp: Array von Objekten `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceAuftragselement.id	Erforderlich. Sys_id eines Domänenauftragsdatensatzes, für den der externe Erfüllungsstatus aktualisiert werden soll. Befindet sich in der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_domain_order]. Datentyp: Zeichenfolge
Serviceauftragselement.status	Erforderlich. Externer Erfüllungsstatus des Domänenauftrags. Gültige Werte: Fehler erfüllt Ausstehend Datentyp: Zeichenfolge

Header

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

Tabelle : 35. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

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 HTTP-Antwortcodesder REST-API.

Tabelle : 36. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Dies kann einen der folgenden Gründe haben: `Ungültige Nutzlast: externalId fehlt`: Gibt an, dass die externe ID (externalId) nicht übergeben wurde. `Ungültige Nutzlast: serviceOrderItem-Status fehlt:` Gibt an, dass der externe Erfüllungsstatus (ServiceOrderItem.state) in einem oder mehreren Domänenaufträgen nicht übergeben wurde. `Ungültige externe ID. Übergeben Sie die richtige externe ID`: Gibt an, dass die übergebene externe ID (externalId) nicht im System vorhanden ist. `Ungültige Domänenauftrags-ID. Übergeben Sie die richtige Domänenauftrags-ID`: Gibt an, dass die übergebene Domänenauftrags-ID (ServiceOrderItem.id) nicht im System vorhanden ist. `Übergebene Domänenauftrags-ID ist keiner externen ID zugeordnet`: Gibt an, dass die externe ID (externalId) keinen Domänenaufträgen zugeordnet ist. Das System aktualisiert nur Domänenaufträge, die einer in der Nutzlast übergebenen externen ID zugeordnet sind. `Ungültiger Erfüllungsstatus: Geben Sie den richtigen Erfüllungsstatus`an: Gibt an, dass der übergebene Erfüllungsstatus (ServiceOrderItem.state) für einen oder mehrere Domänenaufträge nicht gültig ist.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
externe ID	Ausgehender Anforderungsbezeichner des zur Erfüllung gesendeten Domänenauftragsdatensatzes. Befindet sich im Feld request_id in der Tabelle „Ausgehende Anforderung“ [sn_tmt_core_outbound_request]. Datentyp: Zeichenfolge
Serviceauftragselement	Liste der Domänenaufträge, deren externer Erfüllungsstatus aktualisiert werden muss. Datentyp: Array von Objekten `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceAuftragselement.id	Sys_id eines Domänenauftragsdatensatzes, für den der externe Erfüllungsstatus aktualisiert werden soll. Befindet sich in der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_domain_order]. Datentyp: Zeichenfolge
Serviceauftragselement.status	Externer Erfüllungsstatus des Domänenauftrags. Mögliche Werte: Fehler erfüllt Ausstehend Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

curl "http://instance.servicenow.com/api/sn_ind_tmt_orm/serviceorder/outboundresponse" \ 
--request POST \
--header "Accept:application/json" \
--data "{ 
  "externalId": "607017d243322110461f99612bb8f25c",
  "serviceOrderItem": [
    {
      "id": "19913c3577b301108e191e599a5a9988",
      "state": "error"
    }
  ]
}"
--user 'username':'password'

Antwort:

{
  "externalId": "607017d243322110461f99612bb8f25c",
  "serviceOrderItem": [
    {
      "id": "19913c3577b301108e191e599a5a9988",
      "state": "error"
    }
  ]
}