Serviceauftrag – API öffnen

Freigeben Version: Zurich

Aktualisiert 31. Juli 2025

57 Minuten Lesedauer

Die Serviceauftrag Offen Die API stellt einen Endpunkt bereit, der einen standardisierten Mechanismus für die Vergabe von Serviceaufträgen ermöglicht.

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

TMF-Konformitätslogo

Um auf diese API zuzugreifen, die Order Management for Telecommunications Plugin (sn_ind_tmt_orm) muss aktiviert sein. Weitere Informationen finden Sie unter Install Order Management . Für Informationen zu Auftragsmanagement Tabellen, Entitäten und Beziehungen, siehe .

Diese API wird in bereitgestellt sn_tmf_api Namespace.

Der aufrufende Anwender muss über die Rolle sn_ind_tmt_orm.order_integrator verfügen.

Diese API kann erweitert werden, um Anpassungen an erforderlichen Parametern, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unterDie Serviceauftrag – API-Entwicklerleitfaden öffnen .

Serviceauftrag – API öffnen – GET /sn_tmf_api/order/serviceOrder

Ruft alle Serviceaufträge ab.

Diese API ruft Serviceauftragsinformationen aus den folgenden zugehörigen Tabellen ab:

Reihenfolge [sn_ind_tmt_orm_order]
Bestellmerkmalwert [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
Auftragspositionselementkontakt [sn_ind_tmt_orm_order_line_item_contact]
Auftragspositionsbezogene Elemente [sn_ind_tmt_orm_order_line_related_items]

URL-Format

/api/sn_tmf_api/order/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. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zahl Standard: 20 Maximum: 100
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. Datentyp: Zahl Standard: 0
Status	Reihenfolge nach Status filtern. Nur Aufträge mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge Standard: Alle status zurückgegeben.

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

Kopfzeilen

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

Tabelle : 4. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

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

Statuscodes

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

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung).
206	Teilressource als Antwort zurückgegeben (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 oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Datentyp: Zeichenfolge
ExpectedCompletionDate	Datum, an dem der Auftrag abgeschlossen werden soll. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	SYS_ID des angeforderten Serviceauftrags. Datentyp: Zeichenfolge
note	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	Anwendername der Person, die die zugehörige Notiz erstellt 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
orderDate	Datum und Zeitstempel des Auftrags. FORMAT: JJJJ-MM-TT HH:MM:SS Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Ponr	Kennzeichnung, die angibt, ob der Punkt, an dem der Auftrag nicht zurückgegeben wurde, erreicht wurde. Gültige Werte: Wahr: Der Punkt, an dem der Auftrag nicht zurückgegeben wurde, wurde erreicht. Der Auftrag kann während der Erfüllung nicht geändert oder abgebrochen werden. Falsch: Der Punkt, an dem der Auftrag nicht zurückgegeben wurde, wurde nicht erreicht. Der Auftrag kann geändert oder storniert werden. Datentyp: Boolesch
Zugehörige Partei	Liste der Kontakte für den Auftrag. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Befindet sich in der Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer]. Datentyp: Zeichenfolge
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ des Kunden. Mögliche Werte: Verbraucher Kunde CustomerContact Datentyp: Zeichenfolge
RelatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
AnfordertCompletionDate	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
AnfordertStartdatum	Vom Kunden angefordertes Startdatum des Auftrags. Datentyp: Zeichenfolge
ServiceOrderItem	Liste der Einzelposten im Serviceauftrag und der zugehörigen Aktion. `"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
ServiceOrderElement.Aktion	Aktion, die für das Serviceauftragselement 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	Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item.
serviceOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
ServiceOrderItem.extern Produktbestand	Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ServiceOrderElement.externalProduktbestand.externalProduktInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
serviceOrderItem.id	Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
ServiceOrderItem.orderBeziehung	Liste der Beziehungen zwischen Auftragspositionen. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
ServiceOrderItem.orderBeziehung.Beziehungstyp	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Übergeordnetes Element Erfordert `HasChild` Und `Übergeordnetes Element` Werden für übergeordnete/untergeordnete Beziehungen verwendet. `Erforderlich` Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
ServiceOrderElement.Menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
serviceOrderItem.place	Zuordnung der Standorte, an denen der Service installiert werden soll. Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location]. Datentyp: Zeichenfolge
serviceOrderItem.place.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Ort` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ServiceOrderItem.ponr	Kennzeichnung, die angibt, ob der Punkt, an dem keine Rückgabe für die Auftragsposition erfolgt ist, erreicht wurde. Gültige Werte: Wahr: Der Punkt, an dem keine Rückgabe für die Auftragsposition erfolgt ist, wurde erreicht. Die Auftragsposition kann während der Erfüllung nicht geändert oder storniert werden. Falsch: Der Punkt, an dem keine Rückgabe für die Auftragsposition erfolgt ist, wurde nicht erreicht. Die Auftragsposition kann geändert oder storniert werden. Datentyp: Boolesch
ServiceOrderElement.zugehörigPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" [ { "email": "String", "firstName": "String" "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
serviceOrderItem.relatedParty.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.id	SYS_ID des Positionskontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@referredType	Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.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 zugehörigen Service beschreibt. Nur Servicemerkmale mit einem aktuellen valueUnterscheidet sich von previousValueWerden zurückgegeben. Datentyp: Array von Objekten `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.valueType	Typ des Merkmalwerts. Mögliche Werte: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Einzeiliger Test Kontrollkästchen Auswahl Datum, Adresse E-Mail Ganzzahl, Datum/Uhrzeit Objekt Einzeiliger Text Ja/Nein Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship	Liste der Produktbestände im Zusammenhang mit dem Service. Datentyp: Array von Objekten `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	SYS_ID oder sn_prd_invt_external_ID des Produktbestands. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „sn_prd_invt_external_ID“ der Tabelle „Produktbestand“ [sn_prd_invt_Product_Inventory].
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	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld sys_ID der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification].
serviceOrderItem.service.serviceSpecification.internalVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification]
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. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification]
serviceOrderItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServicespezifikationRef` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceType	Servicetyp. Datentyp: Zeichenfolge
serviceOrderItem.service.state	Status des verkauften Produkts. Beispiel: Neu. Datentyp: Zeichenfolge
ServiceOrderElement.Status	Status des Serviceauftrags. Beispiel: Neu. Datentyp: Zeichenfolge
ServiceOrderItem.Version	Version des Serviceauftrags-Positionselements. 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. Weitere Informationen finden Sie unter Service order states. 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 'http://instance.service-now.com/api/sn_tmf_api/order/serviceOrder' \
--user 'username':'password'

Antworttext.

[
    {
        "id": "bd30366ec3a83010abc8b5183c40dd92",
        "ponr": "true",
        "href": "/api/sn_tmf_api/order/serviceOrder/bd30366ec3a83010abc8b5183c40dd92",
        "completionDate": "2021-06-07T21:52:12.000Z",
        "expectedCompletionDate": "2018-01-14T20:07:40.000Z",
        "orderDate": "2021-06-08T05:34:59.000Z",
        "requestedCompletionDate": "2018-01-14T20:07:40.000Z",
        "requestedStartDate": "2018-01-14T20:07:40.000Z",
        "serviceOrderItem": [
            {
                "id": "100",
                "ponr": "true",
                "quantity": 1,
                "action": "add",
                "service": {
                    "@type": "Service",
                    "id": "4b5072aec3a83010abc8b5183c40dd42",
                    "state": "active",
                    "serviceType": "cfs",
                    "serviceCharacteristic": [
                        {
                            "name": "Firewall coverage",
                            "valueType": "Choice",
                            "value": "Premium(Up to 50 sites)\n\t\t",
                            "previousValue": ""
                        },
                        {
                            "name": "Firewall Security",
                            "valueType": "choice",
                            "value": "Premium",
                            "previousValue": ""
                        },
                        {
                            "name": "CPE Type",
                            "valueType": "choice",
                            "value": "Physical",
                            "previousValue": ""
                        },
                        {
                            "name": "Administration Support",
                            "valueType": "choice",
                            "value": "Basic( Customer Managed)\n\t\t",
                            "previousValue": ""
                        }
                    ],
                    "serviceSpecification": {
                        "id": "f99546ff07266010a7955b7e0ad300a8",
                        "name": "Managed Firewall Service",
                        "version": "",
                        "internalVersion": "1",
                        "internalId": "f99546ff07266010a7955b7e0ad300a8",
                        "@type": "ServiceSpecificationRef"
                    }
                },
                "place": {
                    "id": "920cf6ac73d423002728660c4cf6a799",
                    "@type": "Place"
                },
                "state": "completed",
                "version": "2",
                "@type": "ServiceOrderItem"
            }
        ],
        "relatedParty": [
            {
                "id": "ffc68911c35420105252716b7d40dd55",
                "name": "Funco Intl",
                "@type": "RelatedParty",
                "@referredType": "Customer"
            },
            {
                "id": "eaf68911c35420105252716b7d40ddde",
                "name": "Sally Thomas",
                "@type": "RelatedParty",
                "@referredType": "CustomerContact"
            }
        ],
        "state": "completed",
        "version": "2",
        "@type": "ServiceOrder"
    }
]

Serviceauftrag – API öffnen – GET /sn_tmf_api/order/serviceOrder/{ID}

Ruft einen angegebenen Serviceauftrag ab.

Diese API ruft Serviceauftragsinformationen aus den folgenden zugehörigen Tabellen ab:

Reihenfolge [sn_ind_tmt_orm_order]
Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
Bestellmerkmalwert [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselementkontakt [sn_ind_tmt_orm_order_line_item_contact]
Auftragspositionsbezogene Elemente [sn_ind_tmt_orm_order_line_related_items]

URL-Format

/api/sn_tmf_api/order/serviceOrder/{ID}

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter
Name	Beschreibung
id	SYS_ID des abzurufenden Serviceauftrags. Datentyp: Zeichenfolge Tabelle: Reihenfolge [sn_ind_tmt_orm_order]

Tabelle : 8. Abfrageparameter
Name	Beschreibung
Keine

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

Kopfzeilen

Tabelle : 10. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

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

Statuscodes

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

Tabelle : 12. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung). Die Antwort gibt erfolgreich mit einer Fehlermeldung zurück, wenn für den ausgewählten Auftrag Verarbeitungsprobleme auftreten. Eine 200 OK-Antwort geschieht, wenn sich der Auftrag in der Tabelle „eingehende Warteschlange“ [sn_tmt_Core_inbound_Queue] befindet, die darauf wartet, dass der Planer den zu verarbeitenden Datensatz auswählt. Das Fehlermeldungsfeld enthält Details für den Datensatz. Zum 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": "" } ] }` Eine 200 OK-Antwort geschieht, wenn die Auftragserstellung fehlschlägt und sich der Datensatz in der Tabelle „eingehende Warteschlange“ [sn_tmt_Core_inbound_Queue] in einem Fehlerstatus befindet. Das Fehlermeldungsfeld enthält Details in für den Datensatz der eingehenden Warteschlangentabelle. Zum 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: Fehlender Abfrageparameter 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 oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Datentyp: Zeichenfolge
ExpectedCompletionDate	Datum, an dem der Auftrag abgeschlossen werden soll. Datentyp: Zeichenfolge
id	SYS_ID des angeforderten Serviceauftrags. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
note	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	Anwendername der Person, die die zugehörige Notiz erstellt 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
orderDate	Datum und Zeitstempel des Auftrags. FORMAT: JJJJ-MM-TT HH:MM:SS Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Ponr	Kennzeichnung, die angibt, ob der Punkt, an dem der Auftrag nicht zurückgegeben wurde, erreicht wurde. Gültige Werte: Wahr: Der Punkt, an dem der Auftrag nicht zurückgegeben wurde, wurde erreicht. Der Auftrag kann während der Erfüllung nicht geändert oder abgebrochen werden. Falsch: Der Punkt, an dem der Auftrag nicht zurückgegeben wurde, wurde nicht erreicht. Der Auftrag kann geändert oder storniert werden. Datentyp: Boolesch
Zugehörige Partei	Liste der Kontakte für den Auftrag. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Befindet sich in der Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer]. Datentyp: Zeichenfolge
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ des Kunden. Mögliche Werte: Verbraucher Kunde CustomerContact Datentyp: Zeichenfolge
RelatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
AnfordertCompletionDate	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
AnfordertStartdatum	Vom Kunden angefordertes Startdatum des Auftrags. Datentyp: Zeichenfolge
ServiceOrderItem	Liste der Einzelposten im Serviceauftrag und der zugehörigen Aktion. 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" } ]`
ServiceOrderElement.Aktion	Aktion, die für das Serviceauftragselement 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	Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item.
serviceOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
ServiceOrderItem.extern Produktbestand	Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ServiceOrderElement.externalProduktbestand.externalProduktInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
serviceOrderItem.id	Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
ServiceOrderItem.orderBeziehung	Liste der Beziehungen zwischen Auftragspositionen. Datentyp: Array von Objekten `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
ServiceOrderItem.orderBeziehung.Beziehungstyp	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Übergeordnetes Element Erfordert `HasChild` Und `Übergeordnetes Element` Werden für übergeordnete/untergeordnete Beziehungen verwendet. `Erforderlich` Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
ServiceOrderElement.Menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
serviceOrderItem.place	Zuordnung der Standorte, an denen der Service installiert werden soll. Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location]. Datentyp: Zeichenfolge
serviceOrderItem.place.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Ort` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ServiceOrderItem.ponr	Kennzeichnung, die angibt, ob der Punkt, an dem keine Rückgabe für die Auftragsposition erfolgt ist, erreicht wurde. Gültige Werte: Wahr: Der Punkt, an dem keine Rückgabe für die Auftragsposition erfolgt ist, wurde erreicht. Die Auftragsposition kann während der Erfüllung nicht geändert oder storniert werden. Falsch: Der Punkt, an dem keine Rückgabe für die Auftragsposition erfolgt ist, wurde nicht erreicht. Die Auftragsposition kann geändert oder storniert werden. Datentyp: Boolesch
ServiceOrderElement.zugehörigPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String" "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.id	SYS_ID des Positionskontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@referredType	Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.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 zugehörigen Service beschreibt. Nur Servicemerkmale mit einem aktuellen valueUnterscheidet sich von previousValueWerden zurückgegeben. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.valueType	Typ des Merkmalwerts. Mögliche Werte: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Einzeiliger Test Kontrollkästchen Auswahl Datum, Adresse E-Mail Ganzzahl, Datum/Uhrzeit Objekt Einzeiliger Text Ja/Nein Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship	Liste der Produktbestände im Zusammenhang mit dem Service. Datentyp: Array von Objekten `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	SYS_ID oder sn_prd_invt_external_ID des Produktbestands. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „sn_prd_invt_external_ID“ der Tabelle „Produktbestand“ [sn_prd_invt_Product_Inventory].
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	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld sys_ID der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification].
serviceOrderItem.service.serviceSpecification.internalVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification]
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. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification]
serviceOrderItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServicespezifikationRef` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceType	Servicetyp. Datentyp: Zeichenfolge
serviceOrderItem.service.state	Status des verkauften Produkts. Beispiel: Neu. Datentyp: Zeichenfolge
ServiceOrderElement.Status	Status des Serviceauftrags. Beispiel: Neu. Datentyp: Zeichenfolge
ServiceOrderItem.Version	Version des Serviceauftrags-Positionselements. 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. Weitere Informationen finden Sie unter Service order states. Datentyp: Zeichenfolge
@TYPE	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrder` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel ruft einen angegebenen Serviceauftrag ab.

curl "https://instance.service-now.com/api/sn_tmf_api/order/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"
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcfç",
   "orderDate": "2021-06-08T05:34:59.000Z",
}

Serviceauftrag – API öffnen – PATCH /sn_tmf_api/order/serviceOrder/{ID}

Aktualisiert den angegebenen Serviceauftrag.

URL-Format

Standard-URL: /api/sn_tmf_api/order/serviceOrder/{ID}

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter
Name	Beschreibung
id	SYS_ID des zu aktualisierenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Anforderungstext-Parameter (JSON)
Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Wenn die Aktion für Auftragspositionen lautet `Anhalten` Oder `Fortsetzen` , Dieser Parameter kann nicht aktualisiert werden. Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „sn_ind_tmt_orm_order“.
externalId	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
note	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "text": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Gespeichert in: Das Kommentarfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
Zugehörige Partei	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 Verbraucherkontoinformationen enthält. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Erforderlich. SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Tabelle „Account“ [Customer_Account], Tabelle „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer] Tabelle aktualisiert: sn_ind_tmt_orm_order
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ des Kunden. Mögliche Werte: Verbraucher Kunde CustomerContact Datentyp: Zeichenfolge
RelatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
AnfordertCompletionDate	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Gespeichert in: Das Feld expected_end_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge
AnfordertStartdatum	Vom Kunden angefordertes Startdatum des Auftrags. Datentyp: Zeichenfolge Gespeichert in: Feld expected_Start_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge
ServiceOrderItem	Erforderlich. Liste der Einzelposten im Serviceauftrag und der zugehörigen Aktion. Datentyp: Array von Objekten `"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
ServiceOrderElement.Aktion	Erforderlich. Aktion, die für das Serviceauftragselement 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 Kein 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 die Position. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: Auftragsposition [sn_ind_tmt_orm_order_line_item] Tabelle/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 lautet `Anhalten` Oder `Fortsetzen` , Dieser Parameter kann nicht aktualisiert werden. Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „sn_ind_tmt_orm_order_line_item“.
ServiceOrderItem.extern Produktbestand	Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Hinweis: Beim Erstellen eines PATCH-Auftrags mit einer bereits vorhandenen externen Produktbestands-ID wurde der Vorgang zuvor abgebrochen und ein Fehler zurückgegeben. Mit Xanadu Release: Dieser Parameter wird einfach ignoriert, wenn eine vorhandene externe Produktbestands-ID angegeben wird und kein Fehler ausgelöst wird.
ServiceOrderElement.externalProduktbestand.externalProduktInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Gespeichert in: Dem Feld „external_Inventory_ID“ der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item] und dem Feld „sn_prd_invt_external_ID“ der Tabelle „sn_prd_invt_Product_Inventory“.
serviceOrderItem.id	Erforderlich. Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_ID
ServiceOrderItem.orderBeziehung	Erforderlich. Liste der Beziehungen zwischen Auftragspositionen. Datentyp: Array von Objekten `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceOrderItem.orderRelationship.id	Erforderlich. Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [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.orderBeziehung.Beziehungstyp	Erforderlich. Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Übergeordnetes Element Erfordert `HasChild` Und `Übergeordnetes Element` Werden für übergeordnete/untergeordnete Beziehungen verwendet. `Erforderlich` Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceOrderItem.place	Zuordnung der Standorte, 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 Tabelle „Standort“ [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 Ort der Auftragsposition. Datentyp: Zeichenfolge
ServiceOrderElement.Menge	Legt die Anzahl der zu bestellenden Einzelposten fest. Diese Eigenschaft gilt nur, wenn ein Serviceauftrag hinzugefügt wird, d. h. der Wert von actionEigenschaft ist `Hinzufügen` . Datentyp: Zahl Standard: Leere Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity
ServiceOrderElement.zugehörigPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@referredType	Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.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
serviceOrderItem.service.id	Eindeutiger Bezeichner des verkauften Service. Dieser Wert kann die sys_ID oder die externe ID in der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory] sein. Dieser Wert wird nur für Change-/Trennungsaufträge verwendet. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic	Liste, die die Merkmale des zugehörigen Service beschreibt. Nur Servicemerkmale mit einem aktuellen valueUnterscheidet sich von previousValueWerden zurückgegeben. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	Name des Merkmalsdatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der serviceOrderItem.actionParameter ist ein anderer als `Hinzufügen` . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.valueType	Typ des Merkmalwerts. Mögliche Werte: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Einzeiliger Test Kontrollkästchen Auswahl Datum, Adresse E-Mail Ganzzahl, Datum/Uhrzeit Objekt Einzeiliger Text Ja/Nein Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification	Erforderlich. Beschreibung der Servicespezifikation, die dem Service zugeordnet ist. Hinweis: Änderungsreihenfolgen ( serviceOrderItem.actionIst `Ändern` ) Werden je nach Wert von unterschiedlich verarbeitet sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderSystemeigenschaft. Wenn die Eigenschaft auf „wahr“ festgelegt ist und der Service eine andere Version als in der Bestellung angegeben hat, wird der Service automatisch auf die Version in der Reihenfolge aktualisiert, indem die referenzierte Servicespezifikation geändert wird. Dadurch kann der Auftrag erfolgreich verarbeitet werden. Wenn die Eigenschaft auf „falsch“ festgelegt ist und der Service eine andere Version als in der Reihenfolge angegeben hat, schlägt die Reihenfolge aufgrund der Versionsabweichung fehl. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "name": "String", "@type": "String" }` Gespeichert in: Feld „Service_Specification“ 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 `ServicespezifikationRef` . 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
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt application/json.

Statuscodes

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

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
201	Erfolgreich. Wenn Probleme mit den Informationen zur Option „Merkmale“ oder „Merkmale“ auftreten, speichert der Endpunkt die folgenden Kommentare in den Feldern „Arbeitsnotizen“ des zugehörigen Kundenauftrags-Positionselementdatensatzes: `Die folgenden Merkmale des Bestellelements sind nicht vorhanden: Spezifikation überprüfen < specification.name> und korrigieren Sie das Merkmal und die Merkmalsoption in der Auftragsposition, bevor Sie den Auftrag genehmigen.` `Bestellelementmerkmal: < characteristic.name> mit Merkmalswert: < characteristic.value>ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.`
400	Ungültige Anforderung. Dies kann einer der folgenden Gründe sein: `Ungültige Nutzlast: Anforderungstext fehlt` – Nutzlast wurde im Anforderungstext nicht übergeben. `Ungültige Nutzlast: ServiceOrderItem fehlt` – Serviceauftrags-Positionselement-Objekt oder JSON fehlt. `Ungültige Nutzlast: ServiceOrderItem-ID fehlt` - Die idParameter fehlt in der Serviceauftrags-Position der Nutzlast. `Ungültige Nutzlast: Aktion „serviceOrderItem“ fehlt` - Die actionParameter fehlt in der Serviceauftrags-Position der Nutzlast. `Ungültige Nutzlast: ServiceOrderItem serviceOffering fehlt` – Das Serviceangebotsobjekt oder JSON fehlt in der Serviceauftrags-Position in der Nutzlast. `Ungültige Nutzlast: ServiceOffering-ID fehlt` - Die idParameter fehlt in der Serviceauftrags-Position des Serviceangebotsobjekts in der Nutzlast. `Ungültige Nutzlast: Serviceangebot ist nicht vorhanden` – Das Serviceangebot in der Serviceauftrags-Position ist ungültig. `Ungültige Nutzlast: Service „serviceOrderItem“ fehlt` – Das Serviceobjekt oder JSON in der Serviceauftrags-Position fehlt in der Nutzlast. `Ungültige Nutzlast: Service serviceSpecification fehlt` – Das Servicespezifikationsobjekt oder JSON in der Serviceauftrags-Position fehlt in der Nutzlast. `Ungültige Nutzlast: ServiceSpecification-ID fehlt` - Die idParameter in der Serviceauftrags-Position des Servicespezifikationsobjekts fehlt in der Nutzlast. `Ungültige Nutzlast: Servicespezifikation ist nicht vorhanden` – Die Servicespezifikation in der Serviceauftrags-Position ist ungültig. `Ungültige Nutzlast: Servicebestand ist nicht vorhanden` – In einem Change-Auftrag (Aktion = Change) ist die Menge eines Artikels größer als die Menge auf Lager. `Ungültige Nutzlast: Servicebestand-ID fehlt` – In einem Change-Auftrag service.idFehlt 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: RelatedParty fehlt` – Das Objekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Kundenaccount oder Verbraucher fehlt` – Der Kunde oder das Verbraucherobjekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Kundenaccount ist nicht vorhanden` – Der angegebene zugehörige Kunde ist in der Instanz nicht vorhanden. `Ungültige Nutzlast: Verbraucher ist nicht vorhanden` – Der angegebene Verbraucher der zugehörigen Partei ist in der Instanz nicht vorhanden. `Ungültige Nutzlast: Auftragserstellung fehlgeschlagen` – Die angeforderte Bestellung kann nicht erstellt werden. `Laufende Überarbeitung der Auftragswährung wird nicht unterstützt` - Die orderCurrencyParameter kann nicht aktualisiert werden, nachdem der Auftrag erstellt wurde. `Dieser Auftrag muss noch in der Kundenauftragstabelle erstellt werden. Weitere Details finden Sie in der eingehenden Warteschlange.` – Die angegebene Auftrags-ID befindet sich nicht in der Kundenauftragstabelle. `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“ hat.
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 oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Datentyp: Zeichenfolge
externalId	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	SYS_ID des Serviceauftrags. Datentyp: Zeichenfolge
note	Liste der zusätzlichen Notizen, 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
orderDate	Datum und Zeitstempel des Auftrags. FORMAT: JJJJ-MM-TT HH:MM:SS Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Zugehörige Partei	Liste der Kontakte für den Auftrag. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
ZugehörigPartei.ID	SYS_ID oder external_ID des Accounts, Kunden oder Verbraucherkontakts, der dem Auftrag zugeordnet ist. Befindet sich in Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer]. Datentyp: Zeichenfolge
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ des Kunden. Mögliche Werte: Kunde CustomerContact Verbraucher Datentyp: Zeichenfolge
RelatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
AnfordertCompletionDate	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
AnfordertStartdatum	Vom Kunden angefordertes Startdatum des Auftrags. Datentyp: Zeichenfolge
ServiceOrderItem	Liste der Einzelposten im Serviceauftrag und der zugehörigen Aktion. 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" } ]`
ServiceOrderElement.Aktion	Aktion, die für das Serviceauftragselement 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	Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item.
serviceOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
ServiceOrderItem.extern Produktbestand	Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Hinweis: Beim Erstellen eines PATCH-Auftrags mit einer bereits vorhandenen externen Produktbestands-ID wurde der Vorgang zuvor abgebrochen und ein Fehler zurückgegeben. Mit Xanadu Release: Dieser Parameter wird einfach ignoriert, wenn eine vorhandene externe Produktbestands-ID angegeben wird und kein Fehler ausgelöst wird.
ServiceOrderElement.externalProduktbestand.externalProduktInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
ServiceOrderItem.ID	Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
ServiceOrderItem.orderBeziehung	Liste der Beziehungen zwischen Auftragspositionen. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
ServiceOrderItem.orderRelationship.ID	Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
ServiceOrderItem.orderBeziehung.Beziehungstyp	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Übergeordnetes Element Erfordert `HasChild` Und `Übergeordnetes Element` Werden für übergeordnete/untergeordnete Beziehungen verwendet. `Erforderlich` Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceOrderItem.place	Zuordnung der Standorte, an denen der Service installiert werden soll. Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location]. Datentyp: Zeichenfolge
serviceOrderItem.place.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Ort` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ServiceOrderElement.Menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
ServiceOrderElement.zugehörigPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
ServiceOrderElement.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
ServiceOrderElement.zugehörigPartei.Telefon	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@referredType	Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.service	Beschreibung der Instanzdetails des vom Kunden erworbenen Service. Datentyp: Objekt `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }`
serviceOrderItem.service.id	Eindeutiger Bezeichner des verkauften Service. Dieser Wert kann die sys_ID oder die externe ID in der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory] sein. Dieser Wert wird nur für Change-/Trennungsaufträge zurückgegeben. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic	Liste, die die Merkmale des zugehörigen Service beschreibt. Nur Servicemerkmale mit einem aktuellen valueUnterscheidet sich von previousValueWerden zurückgegeben. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	Name des Merkmalsdatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der serviceOrderItem.actionParameter ist ein anderer als `Hinzufügen` . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.valueType	Typ des Merkmalwerts. Mögliche Werte: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Einzeiliger Test Kontrollkästchen Auswahl Datum, Adresse E-Mail Ganzzahl, Datum/Uhrzeit Objekt Einzeiliger Text Ja/Nein 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 `ServicespezifikationRef` . 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. Weitere Informationen finden Sie unter Service order states. Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Beispiel zeigt, wie ein Serviceauftrag aktualisiert wird.

curl -X PATCH 'https://instance.service-now.com/api/sn_tmf_api/order/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": "Choice",
            "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.

{
  "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": "Choice",
            "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_tmf_api/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954"
}

Serviceauftrag – API öffnen – POST /sn_tmf_api/order/serviceOrder/cancelserviceorder

Bricht den angegebenen Serviceauftrag ab.

Hinweis:

Dieser Endpunkt kann nicht für Aufträge verwendet werden, für die der Punkt ohne Rückgabe erreicht wurde. Eine Auftragsposition kann nicht storniert werden, während die Erfüllung ausgeführt wird.

URL-Format

Standard-URL: /api/sn_tmf_api/order/serviceOrder/cancelserviceorder

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 20. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 21. Anforderungstext-Parameter (JSON)
Name	Beschreibung
AbbruchReason	Grund für Stornierung. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
ServiceOrder	Daten zum Serviceauftrag. Datentyp: Objekt `"serviceOrder": { "id": "String", "href": "String", "@referredType": "String" }`
serviceOrder.id	Erforderlich. SYS_ID des zu stornierenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
ServiceOrder.href	URL des zu stornierenden Kundenauftrags. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
ServiceOrder.@referredType	Der Wert für diesen Parameter muss sein `ServiceOrder` . Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
AnfordertAbbruchdatum	Datum, an dem der Auftrag storniert werden soll. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
@TYPE	Der Wert für diesen Parameter muss sein `ServiceOrder stornieren` . 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
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt application/json.

Statuscodes

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

Tabelle : 24. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Dies kann einer der folgenden Gründe sein: 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 Abbruchanforderung 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 Planer den Datensatz abholt.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
AbbruchReason	Grund für Stornierung. Datentyp: Zeichenfolge
id	SYS_ID des stornierten Auftrags. Datentyp: Zeichenfolge
ServiceOrder	Daten zum Serviceauftrag. Datentyp: Objekt `"serviceOrder": { "id": "String", "@referredType": "String" }`
ServiceOrder.ID	SYS_ID des stornierten Auftrags. Datentyp: Zeichenfolge
ServiceOrder.@referredType	Der Wert für diesen Parameter ist `ServiceOrder` . Datentyp: Zeichenfolge
AnfordertAbbruchdatum	Datum, an dem der Auftrag storniert werden soll. Datentyp: Zeichenfolge
Status	Status der Stornierung. Wenn die Stornierungsanforderung erfolgreich verarbeitet wurde (Statuscode 201), ist der Wert für diesen Parameter `Fertig` . Datentyp: Zeichenfolge
@TYPE	Der Wert für diesen Parameter ist `ServiceOrder stornieren` . Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel storniert einen Kundenauftrag.

curl -X POST "https://instance.servicenow.com/api/sn_tmf_api/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"
}

Serviceauftrag – API öffnen – POST /sn_tmf_api/order/serviceOrder

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

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

Reihenfolge [sn_ind_tmt_orm_order]
Bestellmerkmalwert [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
Auftragspositionselementkontakt [sn_ind_tmt_orm_order_line_item_contact]
Auftragspositionsbezogene Elemente [sn_ind_tmt_orm_order_line_related_items]

URL-Format

/api/sn_tmf_api/order/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 der Auftrag synchron verarbeitet. Gültiger Wert: Asynchron Datentyp: Zeichenfolge

Tabelle : 27. Anforderungstext-Parameter (JSON)
Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „sn_ind_tmt_orm_order“.
externalId	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
note	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "text": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Gespeichert in: Das Kommentarfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
orderDate	Datum und Zeitstempel des Auftrags. FORMAT: JJJJ-MM-TT HH:MM:SS Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Zugehörige Partei	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 Verbraucherkontoinformationen enthält. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Erforderlich. SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Tabelle „Account“ [Customer_Account], Tabelle „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer] Tabelle aktualisiert: sn_ind_tmt_orm_order
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ des Kunden. Mögliche Werte: Kunde CustomerContact Verbraucher Datentyp: Zeichenfolge
RelatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
AnfordertCompletionDate	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Gespeichert in: Das Feld expected_end_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge
AnfordertStartdatum	Vom Kunden angefordertes Startdatum des Auftrags. Datentyp: Zeichenfolge Gespeichert in: Feld expected_Start_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge
ServiceOrderItem	Erforderlich. Liste der Einzelposten im Serviceauftrag und der zugehörigen Aktion. Datentyp: Array von Objekten `"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
ServiceOrderElement.Aktion	Erforderlich. Aktion, die für das Serviceauftragselement 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 Kein 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
ServiceOrderItem.actionReason	Optional. Beschreibung des Grunds für die Position. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: Auftragsposition [sn_ind_tmt_orm_order_line_item] Tabelle/action_reason.
serviceOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
ServiceOrderItem.extern Produktbestand	Externe IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ServiceOrderElement.externalProduktbestand.externalProduktInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_Inventory_ID“ der Tabelle „sn_ind_tmt_orm_order_line_item“ und das Feld „sn_prd_invt_external_ID“ der Tabelle „sn_prd_invt_Product_Inventory“.
serviceOrderItem.id	Erforderlich. Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_ID
ServiceOrderItem.orderBeziehung	Erforderlich. Liste der Beziehungen zwischen Auftragspositionen. Datentyp: Array von Objekten `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceOrderItem.orderRelationship.id	Erforderlich. Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [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.orderBeziehung.Beziehungstyp	Erforderlich. Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Übergeordnetes Element Erfordert `HasChild` Und `Übergeordnetes Element` Werden für übergeordnete/untergeordnete Beziehungen verwendet. `Erforderlich` Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceOrderItem.place	Zuordnung der Standorte, 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 Tabelle „Standort“ [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 Ort der Auftragsposition. Datentyp: Zeichenfolge
ServiceOrderElement.Menge	Legt die Anzahl der zu bestellenden Einzelposten fest. Diese Eigenschaft gilt nur, wenn ein Serviceauftrag hinzugefügt wird, d. h. der Wert von actionEigenschaft ist `Hinzufügen` . Datentyp: Zahl Standard: Leere Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity
ServiceOrderElement.zugehörigPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@referredType	Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.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
serviceOrderItem.service.id	Eindeutiger Bezeichner des verkauften Service. Dieser Wert kann die sys_ID oder die externe ID in der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory] sein. Dieser Wert wird nur für Change-/Trennungsaufträge verwendet. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic	Liste, die die Merkmale des zugehörigen Service beschreibt. Nur Servicemerkmale mit einem aktuellen valueUnterscheidet sich von previousValueWerden zurückgegeben. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	Name des Merkmalsdatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der serviceOrderItem.actionParameter ist ein anderer als `Hinzufügen` . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.valueType	Typ des Merkmalwerts. Mögliche Werte: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Einzeiliger Test Kontrollkästchen Auswahl Datum, Adresse E-Mail Ganzzahl, Datum/Uhrzeit Objekt Einzeiliger Text Ja/Nein Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship	Liste der Produktbestände im Zusammenhang mit dem Service. Datentyp: Array von Objekten `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	SYS_ID oder sn_prd_invt_external_ID des Produktbestands. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „sn_prd_invt_external_ID“ der Tabelle „Produktbestand“ [sn_prd_invt_Product_Inventory].
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. Hinweis: Änderungsreihenfolgen ( serviceOrderItem.actionIst `Ändern` ) Werden je nach Wert von unterschiedlich verarbeitet sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderSystemeigenschaft. Wenn die Eigenschaft auf „wahr“ festgelegt ist und der Service eine andere Version als in der Bestellung angegeben hat, wird der Service automatisch auf die Version in der Reihenfolge aktualisiert, indem die referenzierte Servicespezifikation geändert wird. Dadurch kann der Auftrag erfolgreich verarbeitet werden. Wenn die Eigenschaft auf „falsch“ festgelegt ist und der Service eine andere Version als in der Reihenfolge angegeben hat, schlägt die Reihenfolge aufgrund der Versionsabweichung fehl. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Gespeichert in: Feld „Service_Specification“ 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. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification]
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. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification]
serviceOrderItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServicespezifikationRef` . 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
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt application/json.

Statuscodes

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

Tabelle : 30. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
201	Erfolgreich. Wenn Probleme mit den Informationen zur Option „Merkmale“ oder „Merkmale“ auftreten, speichert der Endpunkt die folgenden Kommentare in den Feldern „Arbeitsnotizen“ des zugehörigen Kundenauftrags-Positionselementdatensatzes: Die folgenden Merkmale des Bestellelements sind nicht vorhanden: Spezifikation überprüfen < specification.name> und korrigieren Sie das Merkmal und die Merkmalsoption in der Auftragsposition, bevor Sie den Auftrag genehmigen. Bestellelementmerkmal: < 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 gestellt modeParameter auf festgelegt `Asynchron` Und die Verarbeitung des Datensatzes in der Tabelle „eingehende Warteschlange“ [sn_tmt_Core_inbound_Queue] ist geplant.
400	Ungültige Anforderung. Dies kann einer der folgenden Gründe sein: Ungültige Nutzlast: Verbraucher ist nicht vorhanden – der angegebene Verbraucher der zugehörigen Partei ist in der Instanz nicht vorhanden. Ungültige Nutzlast: Kundenaccount ist nicht vorhanden. – Der in der Nutzlast angegebene verbundene Kunde ist nicht im System vorhanden. Ungültige Nutzlast: Kundenaccount oder Verbraucher fehlt – der Kunde oder das Verbraucherobjekt der zugehörigen Partei fehlt in der Nutzlast. Ungültige Nutzlast: Auftragserstellung fehlgeschlagen. – Die angeforderte Bestellung kann nicht erstellt werden. Ungültige Nutzlast: Produktbestand ist nicht vorhanden. – In einem Change- oder Löschauftrag (d. h. Aktion = ändern oder löschen) ist der gesendete verkaufte Service nicht im System vorhanden. Ungültige Nutzlast: Produktbestand-ID fehlt. – In einem Change- oder Löschauftrag fehlt die ID des verkauften Produkts in der Nutzlast. Ungültige Nutzlast: Anforderungstext fehlt. – Nutzlast wurde im Anforderungstext nicht übergeben. Ungültige Nutzlast: Aktion „serviceOrderItem“ fehlt. – Das Serviceobjekt oder JSON fehlt in der Nutzlast. Ungültige Nutzlast: ServiceOrderItem-ID fehlt. – Die ID fehlt in der Serviceauftrags-Position. Ungültige Nutzlast: ServiceOrderItem fehlt. – Serviceauftrags-Positionselement-Objekt oder JSON fehlt. Ungültige Nutzlast: Service „serviceOrderItem“ fehlt. – Die Serviceeigenschaft fehlt in der Serviceauftrags-Position. Ungültige Nutzlast: Servicespezifikation ist nicht vorhanden. – Die Servicespezifikation in der Serviceauftrags-Position ist ungültig. Ungültige Nutzlast: ServiceSpecification-ID fehlt. - Die idParameter in der Serviceauftrags-Position des Servicespezifikationsobjekts fehlt in der Nutzlast. Ungültige Nutzlast: ServiceSpecification fehlt. – Das Servicespezifikationsobjekt oder JSON in der Serviceauftrags-Position 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 Status „aktiv“.
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 oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Datentyp: Zeichenfolge
externalId	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	SYS_ID des Serviceauftrags. Datentyp: Zeichenfolge
note	Liste der zusätzlichen Notizen, 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
orderDate	Datum und Zeitstempel des Auftrags. FORMAT: JJJJ-MM-TT HH:MM:SS Datentyp: Zeichenfolge Standard: Leere 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 der Auftrag asynchron mit erstellt wird modeAbfrageparameter. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` Datentyp: Zeichenfolge
Zugehörige Partei	Liste der Kontakte für den Auftrag. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
ZugehörigPartei.ID	SYS_ID oder external_ID des Accounts, Kunden oder Verbraucherkontakts, der dem Auftrag zugeordnet ist. Befindet sich in Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer]. Datentyp: Zeichenfolge
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ des Kunden. Mögliche Werte: Kunde CustomerContact Verbraucher Datentyp: Zeichenfolge
RelatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
AnfordertCompletionDate	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
AnfordertStartdatum	Vom Kunden angefordertes Startdatum des Auftrags. Datentyp: Zeichenfolge
ServiceOrderItem	Liste der Einzelposten im Serviceauftrag und der zugehörigen Aktion. 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" } ]`
ServiceOrderElement.Aktion	Aktion, die für das Serviceauftragselement 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 Kein Change resume Anhalten Details finden Sie unter Action types for customer and service orders. Datentyp: Zeichenfolge
ServiceOrderItem.actionReason	Beschreibung des Grunds für das Hinzufügen der Position. Datentyp: Zeichenfolge Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
serviceOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
ServiceOrderItem.extern Produktbestand	Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ServiceOrderElement.externalProduktbestand.externalProduktInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
ServiceOrderItem.ID	Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
ServiceOrderItem.orderBeziehung	Liste der Beziehungen zwischen Auftragspositionen. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
ServiceOrderItem.orderRelationship.ID	Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
ServiceOrderItem.orderBeziehung.Beziehungstyp	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Übergeordnetes Element Erfordert `HasChild` Und `Übergeordnetes Element` Werden für übergeordnete/untergeordnete Beziehungen verwendet. `Erforderlich` Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceOrderItem.place	Zuordnung der Standorte, an denen der Service installiert werden soll. Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location]. Datentyp: Zeichenfolge
serviceOrderItem.place.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Ort` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ServiceOrderElement.Menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
ServiceOrderElement.zugehörigPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
ServiceOrderElement.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
ServiceOrderElement.zugehörigPartei.Telefon	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@referredType	Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
ServiceOrderItem.relatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.service	Beschreibung der Instanzdetails des vom Kunden erworbenen Service. Datentyp: Objekt `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }`
serviceOrderItem.service.id	Eindeutiger Bezeichner des verkauften Service. Dieser Wert kann die sys_ID oder die externe ID in der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory] sein. Dieser Wert wird nur für Change-/Trennungsaufträge zurückgegeben. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic	Liste, die die Merkmale des zugehörigen Service beschreibt. Nur Servicemerkmale mit einem aktuellen valueUnterscheidet sich von previousValueWerden zurückgegeben. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	Name des Merkmalsdatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der serviceOrderItem.actionParameter ist ein anderer als `Hinzufügen` . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.value	Merkmalsoptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceCharacteristic.valueType	Typ des Merkmalwerts. Mögliche Werte: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Einzeiliger Test Kontrollkästchen Auswahl Datum, Adresse E-Mail Ganzzahl, Datum/Uhrzeit Objekt Einzeiliger Text Ja/Nein Datentyp: Zeichenfolge
serviceOrderItem.service.serviceRelationship	Liste der Produktbestände im Zusammenhang mit dem Service. Datentyp: Array von Objekten `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	SYS_ID oder sn_prd_invt_external_ID des Produktbestands. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „sn_prd_invt_external_ID“ der Tabelle „Produktbestand“ [sn_prd_invt_Product_Inventory].
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	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld sys_ID der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification].
serviceOrderItem.service.serviceSpecification.internalVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification]
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. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification]
serviceOrderItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServicespezifikationRef` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ServiceOrderElement.Status	Status des Serviceauftrags. 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. Weitere Informationen finden Sie unter Service order states. Datentyp: Zeichenfolge
@TYPE	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrder` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

Asynchrone Verarbeitung

Dieses Beispiel zeigt die Verwendung von modeAbfrageparameter zum asynchronen Erstellen einer Bestellung. Der Auftrag wird der Tabelle „eingehende Warteschlange“ [sn_tmt_Core_inbound_Queue] in einem zu erstellenden Zeitplan hinzugefügt.

curl -X POST 'https://instance.service-now.com/api/sn_tmf_api/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"
}

Wird synchron verarbeitet (Standard)

Das folgende Beispiel zeigt, wie Sie einen Serviceauftrag erstellen, indem Sie festlegen serviceOrderItem.actionEigenschaft bis Hinzufügen .

curl "https://instance.service-now.com/api/sn_tmf_api/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",
                  "valueType": "Choice",
                  "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",
                  "valueType": "Choice",
                  "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",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

cURL-Anforderung

Im folgenden Beispiel wird ein Serviceauftrag aktualisiert, indem festgelegt wird serviceOrderItem.actionEigenschaft bis Ändern .

curl "https://instance.service-now.com/api/sn_tmf_api/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",
                  "valueType": "Choice",
                  "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",
                  "valueType": "Choice",
                  "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",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

cURL-Anforderung

Im folgenden Beispiel wird eine Serviceauftrags-Position gelöscht, indem festgelegt wird serviceOrderItem.actionEigenschaft bis Löschen .

curl "https://instance.service-now.com/api/sn_tmf_api/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",
                  "valueType": "Choice",
                  "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",
                  "valueType": "Choice",
                  "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",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

Serviceauftrag – API öffnen – POST /sn_tmf_api/order/serviceOrder/outborder response

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 .

URL-Format

/api/sn_tmf_api/order/serviceOrder/outborder response

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 32. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 33. Anforderungstext-Parameter (JSON)
Name	Beschreibung
externalId	Erforderlich. Ausgehender Anforderungsbezeichner des Domänenauftragsdatensatzes, der zur Erfüllung gesendet wurde. Datentyp: Zeichenfolge Tabelle: Im Feld Request_ID in der Tabelle „ausgehende Anforderung“ [sn_tmt_Core_Outbound_Request].
ServiceOrderItem	Erforderlich. Liste der Domänenaufträge, deren externer Erfüllungsstatus aktualisiert werden muss. Datentyp: Array von Objekten `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceOrderItem.id	Erforderlich. SYS_ID eines Domänenauftragsdatensatzes, für den der externe Erfüllungsstatus aktualisiert werden soll. Datentyp: Zeichenfolge Tabelle: Domänenauftrag [sn_ind_tmt_orm_Domain_order]
ServiceOrderItem.State	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 REST API-HTTP-Antwortcodes .

Tabelle : 36. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Dies kann einer der folgenden Gründe sein: `Ungültige Nutzlast: ExternalID fehlt` : Gibt an, dass die externe ID ( externalId) Wurde nicht übergeben. `Ungültige Nutzlast: ServiceOrderItem-Status fehlt:` Gibt an, dass der externe Erfüllungsstatus ( ServiceOrderItem.state) Wurde in mindestens einem Domänenauftrag nicht übergeben. `Ungültige externe ID Übergeben Sie die richtige externe ID` : Gibt an, dass die übergebene externe ID ( externalId) Ist im System nicht vorhanden. `Ungültige Domänenauftrags-ID Übergeben Sie die richtige Domänenauftrags-ID` : Gibt an, dass die übergebene Domänenauftrags-ID ( ServiceOrderItem.id) Ist im System nicht vorhanden. `Die übergebene Domänenauftrags-ID ist nicht mit der externen ID verknüpft` : Gibt an, dass die externe ID ( externalId) Ist keinem Domänenauftrag zugeordnet. 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 Erfüllungsstatus ( ServiceOrderItem.state) Für mindestens einen Domänenauftrag ist ungültig.
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
externalId	Ausgehender Anforderungsbezeichner des Domänenauftragsdatensatzes, der zur Erfüllung gesendet wurde. Datentyp: Zeichenfolge Tabelle: Im Feld Request_ID in der Tabelle „ausgehende Anforderung“ [sn_tmt_Core_Outbound_Request].
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
orderDate	Datum und Zeitstempel des Auftrags. FORMAT: JJJJ-MM-TT HH:MM:SS Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
ServiceOrderItem	Liste der Domänenaufträge, deren externer Erfüllungsstatus aktualisiert werden muss. Datentyp: Array von Objekten `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceOrderItem.ID	SYS_ID eines Domänenauftragsdatensatzes, für den der externe Erfüllungsstatus aktualisiert werden soll. Datentyp: Zeichenfolge Tabelle: Domänenauftrag [sn_ind_tmt_orm_Domain_order]
ServiceOrderItem.State	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_tmf_api/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"
    }
  ]
}