Serviceauftrags-OpenAPI

Freigeben Version: Xanadu

Aktualisiert 1. August 2024

57 Minuten Lesedauer

Die Service Order Open API stellt Endpunkte bereit, die einen standardisierten Mechanismus für die Erteilung von Serviceaufträgen ermöglichen.

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

TMF-Konformitätslogo

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

Diese API wird im Namespace sn_tmf_api bereitgestellt.

Der anrufende Benutzer muss über die Rolle sn_ind_tmt_orm.order_integrator verfügen.

Diese API kann erweitert werden, um Anpassungen für erforderliche Parameter, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unterEntwicklerhandbuch für die Serviceauftrags-API.

Serviceauftrags-Offene API: GET /sn_tmf_api/order/serviceOrder

Ruft alle Serviceaufträge ab.

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

Bestellung [sn_ind_tmt_orm_order]
Wert des Bestellmerkmals [sn_ind_tmt_orm_order_characterist_value]
Bestellposition [sn_ind_tmt_orm_order_line_item]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Bestellposition [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 zurückgegebenen Felder.
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Standard: 20 Maximum: 100 Datentyp: Zahl
Offset	Startindex, ab dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Standard: 0 Datentyp: Zahl
Staat	Filtern Sie Bestellungen nach Status. In der Antwort werden nur Aufträge zurückgegeben, deren Status dem Wert dieses Parameters entspricht. Datentyp: Zeichenfolge Standard: Alle zurückgegebenen Status.

Tabelle : 3. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 4. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltsbereich	Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2` und `Limit=3`, ist der Wert des Content-Range -Headers `Elemente 3-5`.
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter previous
X-Gesamtzahl	Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

Statuscodes

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

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

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Datentyp: Zeichenfolge
erwartetesAbschlussdatum	Datum, an dem der Auftrag abgeschlossen werden soll. Datentyp: Zeichenfolge
href	Ein relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Sys_id des angeforderten Serviceauftrags. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
Anmerkung.Autor	Anwendername der Person, die den zugehörigen Hinweis verfasst hat. Datentyp: Zeichenfolge
Notiz.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom 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 ohne Rückkehr für den Auftrag erreicht wurde. Gültige Werte: „wahr“: Der Punkt ohne Rückkehr für den Auftrag wurde erreicht. Die Bestellung kann nicht geändert oder storniert werden, während die Erfüllung ausgeführt wird. „falsch“: Der Punkt ohne Rückkehr für den Auftrag wurde nicht erreicht. Der Auftrag kann geändert oder storniert werden. Datentyp: Boolesch
Zugehörige Partei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden 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
zugehörigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
serviceOrderItem	Array von Objekten, das die Positionen im Serviceauftrag und die zugehörige Aktion beschreibt. `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ]` Datentyp: Array
serviceBestellelement.Aktion	Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen sind 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
serviceBestellelement.Aktionsgrund	Der Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
serviceAuftragselement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
serviceBestellelement.externerProduktbestand	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceAuftragselement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
serviceOrderItem.id	Eindeutiger Bezeichner der Position. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceBestellelement.bestellBeziehung	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceBestellelement.bestellbeziehung.beziehungstyp	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. „`Erfordert` “ wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceauftragselement.menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
serviceBestellelement.Ort	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 Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceAuftragselement.Ort.@Typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.ponr	Kennzeichnung, die angibt, ob der Punkt ohne Rückkehr für die Auftragsposition erreicht wurde. Gültige Werte: „wahr“: Der Punkt ohne Rückkehr für die Auftragsposition wurde erreicht. Die Auftragsposition kann nicht geändert oder storniert werden, während die Erfüllung ausgeführt wird. „falsch“: Der Punkt ohne Rückkehr für die Auftragsposition wurde nicht erreicht. Die Auftragsposition kann geändert oder storniert werden. Datentyp: Boolesch
serviceauftragselement.zugehörigePartei	Liste der Kontakte für Positionen. 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
serviceAuftragselement.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Auftragspositionselement – Kontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
serviceAuftragselement.zugehörigePartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@referenztyp	Erforderlich. Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceBestellelement.service	Beschreibung der Instanzdetails des vom Kunden erworbenen Service. Datentyp: Objekt `"service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" }`
serviceAuftragselement.service.serviceMerkmal	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value -Wert, der sich von previousValue unterscheidet, zurückgegeben. Datentyp: Array von Objekten `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceAuftragselement.service.servicemerkmal.wert	Merkmaloptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unterCreate product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceAuftragsElement.service.serviceMerkmal.wertTyp	Typ des Merkmalswerts. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceBeziehung	Liste der Produktbestände im Zusammenhang mit dem Service. Datentyp: Array `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id oder sn_prd_invt_external_id des Produktbestands. Befindet sich im Feld „sys_id“ oder „sn_prd_invt_external_id“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory]. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceBeziehung.Beziehungstyp	Typ der Beziehung zwischen Service und Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge
serviceBestellelement.service.serviceSpezifikation	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
serviceauftragselement.service.servicespezifikation.interneId	Initiale_Version der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.interneVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.version	Externe_Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.@typ	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceTyp	Servicetyp. Datentyp: Zeichenfolge
serviceBestellelement.service.status	Status des verkauften Produkts. Beispiel: neu. Datentyp: Zeichenfolge
serviceauftragselement.status	Status der Serviceauftragsposition. Beispiel: neu. Datentyp: Zeichenfolge
serviceBestellelement.version	Version des Serviceauftragspositionselements. Datentyp: Zeichenfolge
serviceauftragselement.@typ	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Staat	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"
    }
]

Offene API für Serviceaufträge – GET /sn_tmf_api/order/serviceOrder/{id}

Ruft einen angegebenen Serviceauftrag ab.

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

Bestellung [sn_ind_tmt_orm_order]
Bestellposition [sn_ind_tmt_orm_order_line_item]
Wert des Bestellmerkmals [sn_ind_tmt_orm_order_characterist_value]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Bestellposition [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. Befindet sich in der Reihenfolgentabelle [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 9. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 10. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

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

Statuscodes

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

Tabelle : 12. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung). Die Antwort gibt erfolgreich mit einer Fehlermeldung zurück, wenn der ausgewählte Auftrag Verarbeitungsprobleme hat. Die Antwort „200 OK“ erfolgt, wenn sich der Auftrag in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] befindet und darauf wartet, dass der Planer den zu verarbeitenden Datensatz auswählt. Das Feld „Fehlermeldung“ enthält Details für den Datensatz. Beispiel: `{ "code": 102, "reason": "Request in queue", "message": "Request in queue", "details": [ { "message": "This Order is still in the inbound queue table waiting to be processed.", "datapath": "" } ] }` Die Antwort 200 OK erfolgt, wenn die Auftragserstellung fehlschlägt und der Datensatz in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] einen Fehlerstatus aufweist. Das Feld „Fehlermeldung“ enthält Details in für den Datensatz der eingehenden Warteschlangentabelle. 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 den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Datentyp: Zeichenfolge
erwartetesAbschlussdatum	Datum, an dem der Auftrag abgeschlossen werden soll. Datentyp: Zeichenfolge
id	Sys_id des angeforderten Serviceauftrags. Datentyp: Zeichenfolge
href	Ein relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
Anmerkung.Autor	Anwendername der Person, die den zugehörigen Hinweis verfasst hat. Datentyp: Zeichenfolge
Notiz.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom 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 ohne Rückkehr für den Auftrag erreicht wurde. Gültige Werte: „wahr“: Der Punkt ohne Rückkehr für den Auftrag wurde erreicht. Die Bestellung kann nicht geändert oder storniert werden, während die Erfüllung ausgeführt wird. „falsch“: Der Punkt ohne Rückkehr für den Auftrag wurde nicht erreicht. Der Auftrag kann geändert oder storniert werden. Datentyp: Boolesch
Zugehörige Partei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden 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
zugehörigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
serviceOrderItem	Array von Objekten, das die Positionen im Serviceauftrag und die zugehörige Aktion beschreibt. Datentyp: Array `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ]`
serviceBestellelement.Aktion	Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte Auswahlliste im Feld Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Einzelheiten finden Sie unter Action types for customer and service orders Datentyp: Zeichenfolge
serviceBestellelement.Aktionsgrund	Der Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
serviceAuftragselement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
serviceBestellelement.externerProduktbestand	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceAuftragselement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
serviceOrderItem.id	Eindeutiger Bezeichner der Position. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceBestellelement.bestellBeziehung	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceBestellelement.bestellbeziehung.beziehungstyp	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. „`Erfordert` “ wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceauftragselement.menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
serviceBestellelement.Ort	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 Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceAuftragselement.Ort.@Typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceOrderItem.ponr	Kennzeichnung, die angibt, ob der Punkt ohne Rückkehr für die Auftragsposition erreicht wurde. Gültige Werte: „wahr“: Der Punkt ohne Rückkehr für die Auftragsposition wurde erreicht. Die Auftragsposition kann nicht geändert oder storniert werden, während die Erfüllung ausgeführt wird. „falsch“: Der Punkt ohne Rückkehr für die Auftragsposition wurde nicht erreicht. Die Auftragsposition kann geändert oder storniert werden. Datentyp: Boolesch
serviceauftragselement.zugehörigePartei	Liste der Kontakte für Positionen. 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
serviceAuftragselement.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Auftragspositionselement – Kontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
serviceAuftragselement.zugehörigePartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@referenztyp	Erforderlich. Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceBestellelement.service	Beschreibung der Instanzdetails des vom Kunden erworbenen Service. `"service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" }` Datentyp: Objekt
serviceAuftragselement.service.serviceMerkmal	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value -Wert, der sich von previousValue unterscheidet, zurückgegeben. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceAuftragselement.service.servicemerkmal.wert	Merkmaloptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unterCreate product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceAuftragsElement.service.serviceMerkmal.wertTyp	Typ des Merkmalswerts. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceBeziehung	Liste der Produktbestände im Zusammenhang mit dem Service. Datentyp: Array `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id oder sn_prd_invt_external_id des Produktbestands. Befindet sich im Feld „sys_id“ oder „sn_prd_invt_external_id“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory]. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceBeziehung.Beziehungstyp	Typ der Beziehung zwischen Service und Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge
serviceBestellelement.service.serviceSpezifikation	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
serviceauftragselement.service.servicespezifikation.interneId	Initiale_Version der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.interneVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.version	Externe_Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.@typ	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceTyp	Servicetyp. Datentyp: Zeichenfolge
serviceBestellelement.service.status	Status des verkauften Produkts. Beispiel: neu. Datentyp: Zeichenfolge
serviceauftragselement.status	Status der Serviceauftragsposition. Beispiel: neu. Datentyp: Zeichenfolge
serviceBestellelement.version	Version des Serviceauftragspositionselements. Datentyp: Zeichenfolge
serviceauftragselement.@typ	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Staat	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

Im folgenden Beispiel wird ein angegebener Serviceauftrag abgerufen.

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",
}

Serviceauftrags-Open-API – 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. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Wenn die Aktion für Auftragspositionen „ `aussetzen` “ oder „ `fortsetzen`“ ist, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/committed_due_date
externalId	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "text": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/comments Standard: Leere Zeichenfolge
Zugehörige Partei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. In der Anforderung muss mindestens ein Artikel aufgeführt werden, der Informationen zu Kunden- oder Verbraucherkonten 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 dem Auftrag zugeordnet ist. Zu finden in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge Tabelle aktualisiert: sn_ind_tmt_orm_order
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_end_date Standard: Leere Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_start_date Standard: Leere Zeichenfolge
serviceOrderItem	Erforderlich. Array von Objekten, das die Positionen im Serviceauftrag und die zugehörige Aktion beschreibt. Datentyp: Array `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceBestellelement.Aktion	Erforderlich. Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte Auswahlliste im Feld Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change delete 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
serviceBestellelement.Aktionsgrund	Optional. Beschreibung des Grunds für die Position. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: Tabelle/action_reason für Bestellposition [sn_ind_tmt_orm_order_line_item].
serviceAuftragselement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Wenn die Aktion für das Element „ `unterbrechen` “ oder „ `fortsetzen`“ lautet, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/committed_due_date
serviceBestellelement.externerProduktbestand	Array von Objekten mit externen IDs für die Zuordnung zu den für den Auftrag erstellten Produktbeständen. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Hinweis: Zuvor wurde beim Erstellen eines PATCH-Auftrags mit einer bereits vorhandenen externen Produktbestands-ID der Vorgang abgebrochen und ein Fehler zurückgegeben. Mit dem Release Xanadu wird dieser Parameter einfach ignoriert, wenn eine vorhandene externe Produktbestands-ID angegeben und kein Fehler ausgegeben wird.
serviceAuftragselement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_inventory_id und sn_prd_invt_product_inventory/sn_prd_invt_external_id
serviceOrderItem.id	Erforderlich. Eindeutiger Bezeichner der Position. Zu finden 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
serviceBestellelement.bestellBeziehung	Erforderlich. Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceOrderItem.orderRelationship.id	Erforderlich. Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden 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
serviceBestellelement.bestellbeziehung.beziehungstyp	Erforderlich. Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. „`Erfordert` “ wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceBestellelement.Ort	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 Standorttabelle [cmn_location]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/location
serviceAuftragselement.Ort.@Typ	Teil des TMF Open API-Standards. Anmerkung für Bestellposition. Datentyp: Zeichenfolge
serviceauftragselement.menge	Legt die Anzahl der zu bestellenden Einzelposten fest. Diese Eigenschaft gilt nur beim Hinzufügen eines Serviceauftrags. Das heißt, der Wert der Eigenschaft action lautet „ `add`“. Datentyp: Zahl Standard: Leere Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity
serviceauftragselement.zugehörigePartei	Liste der Kontakte für Positionen. 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
serviceAuftragselement.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
serviceAuftragselement.zugehörigePartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@referenztyp	Erforderlich. Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceBestellelement.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 Services. 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
serviceAuftragselement.service.serviceMerkmal	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value -Wert, der sich von previousValue unterscheidet, zurückgegeben. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Name des Merkmaldatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceMerkmal.vorherigerWert	Vorherige Merkmaloptionswerte, wenn die Aktualisierung für den Change-Auftrag gilt. Die Anforderung ist ein Change, wenn der Parameter serviceOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unterCreate product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceAuftragselement.service.servicemerkmal.wert	Merkmaloptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unterCreate product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceBestellelement.service.serviceSpezifikation	Erforderlich. Beschreibung der Servicespezifikation, die dem Service zugeordnet ist. Hinweis: Change-Aufträge (serviceOrderItem.action ist `change`) werden je nach Wert der Systemeigenschaft sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder unterschiedlich verarbeitet. Wenn die Eigenschaft auf true festgelegt ist (Standardeinstellung) und der Service eine andere Version hat als im Auftrag angegeben, wird der Service automatisch auf die im Auftrag angegebene Version aktualisiert, indem die referenzierte Servicespezifikation geändert wird. Dadurch kann der Auftrag erfolgreich verarbeitet werden. Wenn die Eigenschaft auf „false“ festgelegt ist und der Service eine andere Version hat als die im Auftrag angegebene, schlägt der Auftrag aufgrund der Versionsabweichung fehl. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "name": "String", "@type": "String" }` Aktualisiert das Feld „service_specification“ in der Tabelle „Auftragspositionselement“ [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
serviceauftragselement.service.servicespezifikation.@typ	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceauftragselement.@typ	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. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
201	Erfolgreich. Wenn Probleme mit den Merkmalen oder Merkmalsoptionsinformationen auftreten, speichert der Endpunkt die folgenden Kommentare in den Arbeitsnotizen-Feldern des zugehörigen Kundenauftragspositionselement-Datensatzes: `Die folgenden Merkmale für Bestellelemente sind nicht vorhanden: Überprüfen Sie die Spezifikation <specification.name>, und korrigieren Sie das Merkmal und die Merkmalsoption in der Auftragsposition, bevor Sie den Auftrag genehmigen.` `Merkmal des Bestellelements: <characteristic.name> mit Merkmalswert: <characteristic.value>ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.`
400	Ungültige Anforderung. Kann einer der folgenden Gründe sein: `Ungültige Nutzlast: Anforderungstext fehlt` – Nutzlast wurde im Anforderungstext nicht übergeben. `Ungültige Nutzlast: serviceOrderItem fehlt` – Objekt für Serviceauftragsposition oder JSON fehlt. `Ungültige Nutzlast: serviceOrderItem-ID fehlt` – Der Parameter id fehlt in der Serviceauftragsposition der Nutzlast. `Ungültige Nutzlast: Aktion „serviceOrderItem“ fehlt` – Der Parameter action fehlt in der Serviceauftragsposition der Nutzlast. `Ungültige Nutzlast: serviceOrderItem serviceOffering fehlt` – Das Serviceangebotsobjekt oder die JSON-Datei fehlt in der Serviceauftragsposition in der Nutzlast. `Ungültige Nutzlast: Serviceangebots-ID fehlt` – Der Parameter id fehlt in der Serviceauftragsposition des Serviceangebotsobjekts in der Nutzlast. `Ungültige Nutzlast: Serviceangebot nicht vorhanden` – Das Serviceangebot in der Serviceauftragsposition ist ungültig. `Ungültige Nutzlast: Service „serviceOrderItem“ fehlt` – das Serviceobjekt oder JSON in der Serviceauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Service serviceSpecification fehlt` – Das Servicespezifikationsobjekt oder JSON in der Serviceauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: serviceSpecification-ID fehlt` – Der Parameter id in der Serviceauftragsposition des Servicespezifikationsobjekts fehlt in der Nutzlast. `Ungültige Nutzlast: Servicespezifikation nicht vorhanden` – Die Servicespezifikation in der Serviceauftragsposition ist ungültig. `Ungültige Nutzlast: Servicebestand nicht vorhanden` – In einem Change-Auftrag (Aktion = Change) ist die Menge eines Artikels größer als der Bestand. `Ungültige Nutzlast: Servicebestands-ID fehlt` – in einem Change-Auftrag fehlt service.id in der Nutzlast. `Ungültige Nutzlast: Verkaufter Service ist inaktiv` – In einem Change-Auftrag ist ein in der Nutzlast angegebener Service inaktiv. `Ungültige Nutzlast: „relatedParty“ fehlt` : Das Objekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Kunden-Account oder Verbraucher fehlt` – Das Kunden- oder Verbraucherobjekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Kunden-Account nicht vorhanden` – Der angegebene zugehörige Vertragspartei-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` – Der angeforderte Auftrag kann nicht erstellt werden. `In-Ausführungs-Überarbeitung von Auftragswährung nicht unterstützt` : Der Parameter orderCurrency kann nicht aktualisiert werden, nachdem der Auftrag erstellt wurde. `Diese Bestellung 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. `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 den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Datentyp: Zeichenfolge
externalId	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge
href	Ein relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Sys_id des Serviceauftrags. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "text": "String" } ]`
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom 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. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
Zugehörigepartei.id	Sys_id oder external_id des Accounts, Kunden oder Verbraucherkontakts, der dem Auftrag zugeordnet ist. Zu finden in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
Zugehörigepartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Kunde Kundenkontakt Verbraucher Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
serviceOrderItem	Array von Objekten, das die Positionen im Serviceauftrag und die zugehörige Aktion beschreibt. Datentyp: Array `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]`
serviceBestellelement.Aktion	Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte Auswahlliste im Feld Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change delete Details finden Sie unter Action types for customer and service orders. Datentyp: Zeichenfolge
serviceBestellelement.Aktionsgrund	Der Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
serviceAuftragselement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
serviceBestellelement.externerProduktbestand	Array von Objekten mit externen IDs für die Zuordnung zu den für den Auftrag erstellten Produktbeständen. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Hinweis: Zuvor wurde beim Erstellen eines PATCH-Auftrags mit einer bereits vorhandenen externen Produktbestands-ID der Vorgang abgebrochen und ein Fehler zurückgegeben. Mit dem Release Xanadu wird dieser Parameter einfach ignoriert, wenn eine vorhandene externe Produktbestands-ID angegeben und kein Fehler ausgegeben wird.
serviceAuftragselement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
serviceAuftragsElement.id	Eindeutiger Bezeichner der Position. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceBestellelement.bestellBeziehung	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceBestellelement.bestellbeziehung.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceBestellelement.bestellbeziehung.beziehungstyp	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. „`Erfordert` “ wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceBestellelement.Ort	Zuordnung der Standorte, an denen der Service installiert werden soll. Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceBestellelement.Ort.ID	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceAuftragselement.Ort.@Typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceauftragselement.menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
serviceauftragselement.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceAuftragselement.zugehörigePartei.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge
serviceAuftragselement.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
serviceAuftragselement.zugehörigePartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge
serviceAuftragselement.zugehörigePartei.telefon	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@referenztyp	Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceBestellelement.service	Beschreibung der Instanzdetails des vom Kunden erworbenen Service. Datentyp: Objekt `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }`
serviceBestellelement.service.id	Eindeutiger Bezeichner des verkauften Services. 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
serviceAuftragselement.service.serviceMerkmal	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value -Wert, der sich von previousValue unterscheidet, zurückgegeben. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceAuftragselement.service.servicemerkmal.name	Name des Merkmaldatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceMerkmal.vorherigerWert	Vorherige Merkmaloptionswerte, wenn die Aktualisierung für den Change-Auftrag gilt. Die Anforderung ist ein Change, wenn der Parameter serviceOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unterCreate product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceAuftragselement.service.servicemerkmal.wert	Merkmaloptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unterCreate product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceBestellelement.service.serviceSpezifikation	Beschreibung der Servicespezifikation, die dem Service zugeordnet ist. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "name": "String", "@type": "String" }`
serviceAuftragselement.service.servicespezifikation.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
serviceauftragselement.service.servicespezifikation.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.@typ	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceauftragselement.@typ	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Staat	Status des Serviceauftrags. Weitere Informationen finden Sie unter Service order states. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird gezeigt, 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": "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.

{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      v"actionReason": "adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic(Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service",
          "sys_id": "f99546ff07266010a7955b7e0ad300a8",
          "version": "",
          "status": "published",
          "internalId": "f99546ff07266010a7955b7e0ad300a8"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "relatedParty": [
        {
            "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"
}

Serviceauftrags-Offene API – POST /sn_tmf_api/order/serviceOrder/cancelserviceorder

Storniert den angegebenen Serviceauftrag.

Hinweis:

Dieser Endpunkt kann nicht für Aufträge verwendet werden, für die der Punkt ohne Rückkehr 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. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Stornierungsgrund	Grund für Abbruch. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
serviceAuftrag	Enthält Daten zum Serviceauftrag. Datentyp: Objekt `"serviceOrder": { "id": "String", "href": "String", "@referredType": "String" }`
serviceOrder.id	Erforderlich. Sys_id des zu stornierenden Kundenauftrags. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
serviceOrder.href	URL des zu stornierenden Kundenauftrags. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
serviceauftrag.@referenztyp	Der Wert für diesen Parameter muss `ServiceOrder`sein. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
RequestCancelationDate	Datum, bis zu dem der Auftrag storniert werden soll. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
@type	Der Wert für diesen Parameter muss `CancelServiceOrder`sein. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge

Header

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

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

Statuscodes

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

Tabelle : 24. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. 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 Stornierungsanforderung wurde für einen Auftrag gestellt, der noch nicht erstellt wurde. Der Auftrag befindet sich in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] und wartet darauf, dass der Planer den Datensatz abruft.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
Stornierungsgrund	Grund für Abbruch. Datentyp: Zeichenfolge
id	Sys_id des stornierten Auftrags. Datentyp: Zeichenfolge
serviceAuftrag	Enthält Daten zum Serviceauftrag. Datentyp: Objekt `"serviceOrder": { "id": "String", "@referredType": "String" }`
serviceAuftrag.id	Sys_id des stornierten Auftrags. Datentyp: Zeichenfolge
serviceauftrag.@referenztyp	Der Wert für diesen Parameter ist `ServiceOrder`. Datentyp: Zeichenfolge
RequestCancelationDate	Datum, bis zu dem der Auftrag storniert werden soll. Datentyp: Zeichenfolge
Staat	Status des Abbruchs. Wenn die Abbruchanforderung erfolgreich verarbeitet wurde (Statuscode 201), ist der Wert für diesen Parameter `fertig`. Datentyp: Zeichenfolge
@type	Der Wert für diesen Parameter ist `CancelServiceOrder`. 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"
}

Serviceauftrags-Offene API – 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 in den folgenden Tabellen ein neuer Datensatz erstellt:

Bestellung [sn_ind_tmt_orm_order]
Wert des Bestellmerkmals [sn_ind_tmt_orm_order_characterist_value]
Bestellposition [sn_ind_tmt_orm_order_line_item]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Bestellposition [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. Möglicher Wert: asynchron Datentyp: Zeichenfolge

Tabelle : 27. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/committed_due_date
externalId	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
href	Ein relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "text": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/comments 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. In der Anforderung muss mindestens ein Artikel aufgeführt werden, der Informationen zu Kunden- oder Verbraucherkonten 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 dem Auftrag zugeordnet ist. Zu finden in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge Tabelle aktualisiert: sn_ind_tmt_orm_order
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Kunde Kundenkontakt Verbraucher Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_end_date Standard: Leere Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_start_date Standard: Leere Zeichenfolge
serviceOrderItem	Erforderlich. Array von Objekten, das die Positionen im Serviceauftrag und die zugehörige Aktion beschreibt. Datentyp: Array `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceBestellelement.Aktion	Erforderlich. Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte Auswahlliste im Feld Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change delete 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: add
Servicebestellelement.Aktionsgrund	Optional. Beschreibung des Grunds für die Position. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: Tabelle/action_reason für Bestellposition [sn_ind_tmt_orm_order_line_item].
serviceAuftragselement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/committed_due_date
serviceBestellelement.externerProduktbestand	Array von Objekten mit externen IDs für die Zuordnung zu den für den Auftrag erstellten Produktbeständen. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceAuftragselement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_inventory_id und sn_prd_invt_product_inventory/sn_prd_invt_external_id
serviceOrderItem.id	Erforderlich. Eindeutiger Bezeichner der Position. Zu finden 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
serviceBestellelement.bestellBeziehung	Erforderlich. Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
serviceOrderItem.orderRelationship.id	Erforderlich. Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden 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
serviceBestellelement.bestellbeziehung.beziehungstyp	Erforderlich. Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. „`Erfordert` “ wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceBestellelement.Ort	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 Standorttabelle [cmn_location]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/location Standard: Leere Zeichenfolge
serviceAuftragselement.Ort.@Typ	Teil des TMF Open API-Standards. Anmerkung für Bestellposition. Datentyp: Zeichenfolge
serviceauftragselement.menge	Legt die Anzahl der zu bestellenden Einzelposten fest. Diese Eigenschaft gilt nur beim Hinzufügen eines Serviceauftrags. Das heißt, der Wert der Eigenschaft action lautet „ `add`“. Datentyp: Zahl Standard: Leere Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity
serviceauftragselement.zugehörigePartei	Liste der Kontakte für Positionen. 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
serviceAuftragselement.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
serviceAuftragselement.zugehörigePartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge
serviceOrderItem.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@referenztyp	Erforderlich. Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceBestellelement.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 Services. 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
serviceAuftragselement.service.serviceMerkmal	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value -Wert, der sich von previousValue unterscheidet, zurückgegeben. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Name des Merkmaldatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceMerkmal.vorherigerWert	Vorherige Merkmaloptionswerte, wenn die Aktualisierung für den Change-Auftrag gilt. Die Anforderung ist ein Change, wenn der Parameter serviceOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unterCreate product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceAuftragselement.service.servicemerkmal.wert	Merkmaloptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unterCreate product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceBeziehung	Liste der Produktbestände im Zusammenhang mit dem Service. Datentyp: Array `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id oder sn_prd_invt_external_id des Produktbestands. Befindet sich im Feld „sys_id“ oder „sn_prd_invt_external_id“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory]. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceBeziehung.Beziehungstyp	Typ der Beziehung zwischen Service und Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge
serviceBestellelement.service.serviceSpezifikation	Erforderlich. Beschreibung der Servicespezifikation, die dem Service zugeordnet ist. Hinweis: Change-Aufträge (serviceOrderItem.action ist `change`) werden je nach Wert der Systemeigenschaft sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder unterschiedlich verarbeitet. Wenn die Eigenschaft auf true festgelegt ist (Standardeinstellung) und der Service eine andere Version hat als im Auftrag angegeben, wird der Service automatisch auf die im Auftrag angegebene Version aktualisiert, indem die referenzierte Servicespezifikation geändert wird. Dadurch kann der Auftrag erfolgreich verarbeitet werden. Wenn die Eigenschaft auf „false“ festgelegt ist und der Service eine andere Version hat als die im Auftrag angegebene, schlägt der Auftrag aufgrund der Versionsabweichung fehl. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Aktualisiert das Feld „service_specification“ in der Tabelle „Auftragspositionselement“ [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
serviceauftragselement.service.servicespezifikation.interneVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceOrderItem.service.serviceSpecification.name	Erforderlich. Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.version	Externe_Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.@typ	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceauftragselement.@typ	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. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 30. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
201	Erfolgreich. Wenn Probleme mit den Merkmalen oder Merkmalsoptionsinformationen auftreten, speichert der Endpunkt die folgenden Kommentare in den Arbeitsnotizen-Feldern des zugehörigen Kundenauftragspositionselement-Datensatzes: Die folgenden Merkmale für Bestellelemente sind nicht vorhanden: Überprüfen Sie die Spezifikation <specification.name>, und korrigieren Sie das Merkmal und die Merkmalsoption in der Auftragsposition, bevor Sie den Auftrag genehmigen. Merkmal des Bestellelements: <characteristic.name> mit Merkmalswert: <characteristic.value> ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.
202	Akzeptiert. Erfolgreiche Anforderung für eine Bestellung im asynchronen Modus. Das heißt, bei der Anforderung wurde der Parameter mode auf `async` festgelegt, und der Datensatz ist zur Verarbeitung in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] geplant.
400	Ungültige Anforderung. Kann einer der folgenden Gründe sein: Ungültige Nutzlast: Anforderungstext fehlt. Nutzlast wurde im Anforderungstext nicht übergeben. Ungültige Nutzlast: serviceOrderItem fehlt. Objekt für Serviceauftrags-Positionselement oder JSON fehlt. Ungültige Nutzlast: serviceOrderItem-ID fehlt. – In der Serviceauftragsposition fehlt die ID. Ungültige Nutzlast: Die Aktion „serviceOrderItem“ fehlt. – Das Serviceobjekt oder JSON fehlt in der Nutzlast. Ungültige Nutzlast: Service „serviceOrderItem“ fehlt. – In der Serviceauftragsposition fehlt die Serviceeigenschaft. Ungültige Nutzlast: serviceSpecification fehlt. Das Servicespezifikationsobjekt oder JSON in der Serviceauftragsposition fehlt in der Nutzlast. Ungültige Nutzlast: serviceSpecification ID fehlt. Der Parameter id in der Serviceauftragsposition des Servicespezifikationsobjekts fehlt in der Nutzlast. Ungültige Nutzlast: Servicespezifikation ist nicht vorhanden. Die Servicespezifikation in der Serviceauftragsposition ist ungültig. 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: Produktbestands-ID fehlt. – In einem Change- oder Löschauftrag fehlt die ID des verkauften Produkts in der Nutzlast. Ungültige Nutzlast: Kunden-Account oder Verbraucher fehlt – Das Kunden- oder Verbraucherobjekt der zugehörigen Partei fehlt in der Nutzlast. Ungültige Nutzlast: Verkauftes Produkt ist inaktiv. – In einem Change- oder Löschauftrag befindet sich das in der Nutzlast gesendete verkaufte Produkt nicht im Status „Aktiv“. Ungültige Nutzlast: Verbraucher ist nicht vorhanden – Der angegebene Verbraucher der zugehörigen Partei ist in der Instanz nicht vorhanden. Ungültige Nutzlast: Kunden-Account ist nicht vorhanden. – Der in der Nutzlast angegebene Kunde der zugehörigen Partei ist im System nicht vorhanden. Ungültige Nutzlast: Auftragserstellung fehlgeschlagen. Der angeforderte Auftrag kann nicht erstellt werden.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Datentyp: Zeichenfolge
externalId	Eindeutige Auftragsnummer für den externen Serviceauftrag. Datentyp: Zeichenfolge
href	Ein relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Sys_id des Serviceauftrags. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "text": "String" } ]`
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom 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 Zeitplan zur Verarbeitung hinzugefügt. Hinweis: Dieser Wert ist das einzige Ergebnis, wenn der Auftrag asynchron mit dem Abfrageparameter mode erstellt wird. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` Datentyp: Zeichenfolge
Zugehörige Partei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
Zugehörigepartei.id	Sys_id oder external_id des Accounts, Kunden oder Verbraucherkontakts, der dem Auftrag zugeordnet ist. Zu finden in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
Zugehörigepartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Kunde Kundenkontakt Verbraucher Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
serviceOrderItem	Array von Objekten, das die Positionen im Serviceauftrag und die zugehörige Aktion beschreibt. Datentyp: Array `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]`
serviceBestellelement.Aktion	Aktion, die für die Serviceauftragsposition ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte Auswahlliste im Feld Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change delete kein Change resume anhalten Details finden Sie unter Action types for customer and service orders. Datentyp: Zeichenfolge
Servicebestellelement.Aktionsgrund	Beschreibung des Grunds für das Hinzufügen des Einzelpostens. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceAuftragselement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
serviceBestellelement.externerProduktbestand	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceAuftragselement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
serviceAuftragsElement.id	Eindeutiger Bezeichner der Position. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceBestellelement.bestellBeziehung	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceBestellelement.bestellbeziehung.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceBestellelement.bestellbeziehung.beziehungstyp	Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte: HasChild Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. „`Erfordert` “ wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
serviceBestellelement.Ort	Zuordnung der Standorte, an denen der Service installiert werden soll. Datentyp: Objekt `"place:" { "id": "String", "@type": "String" }`
serviceBestellelement.Ort.ID	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceAuftragselement.Ort.@Typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceauftragselement.menge	Anzahl der bestellten Einzelposten. Datentyp: Zahl
serviceauftragselement.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceAuftragselement.zugehörigePartei.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge
serviceAuftragselement.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
serviceAuftragselement.zugehörigePartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge
serviceAuftragselement.zugehörigePartei.telefon	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@referenztyp	Erforderlich. Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
serviceauftragselement.zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceBestellelement.service	Beschreibung der Instanzdetails des vom Kunden erworbenen Service. Datentyp: Objekt `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }`
serviceBestellelement.service.id	Eindeutiger Bezeichner des verkauften Services. 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
serviceAuftragselement.service.serviceMerkmal	Liste, die die Merkmale des zugeordneten Service beschreibt. Es werden nur Servicemerkmale mit einem aktuellen value -Wert, der sich von previousValue unterscheidet, zurückgegeben. Datentyp: Array `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceAuftragselement.service.servicemerkmal.name	Name des Merkmaldatensatzes, der dem Service zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceMerkmal.vorherigerWert	Vorherige Merkmaloptionswerte, wenn die Aktualisierung für den Change-Auftrag gilt. Die Anforderung ist ein Change, wenn der Parameter serviceOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unterCreate product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceAuftragselement.service.servicemerkmal.wert	Merkmaloptionswerte, die dem Service zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unterCreate product characteristics and characteristic options. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceBeziehung	Liste der Produktbestände im Zusammenhang mit dem Service. Datentyp: Array `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id oder sn_prd_invt_external_id des Produktbestands. Befindet sich im Feld „sys_id“ oder „sn_prd_invt_external_id“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory]. Datentyp: Zeichenfolge
serviceAuftragselement.service.serviceBeziehung.Beziehungstyp	Typ der Beziehung zwischen Service und Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge
serviceBestellelement.service.serviceSpezifikation	Beschreibung der Servicespezifikation, die dem Service zugeordnet ist. Datentyp: Objekt `"serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
serviceAuftragselement.service.servicespezifikation.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
serviceauftragselement.service.servicespezifikation.interneId	Initiale_Version der Servicespezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.interneVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.version	Externe_Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceauftragselement.service.servicespezifikation.@typ	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceauftragselement.status	Status der Serviceauftragsposition. Beispiel: neu. Datentyp: Zeichenfolge
serviceauftragselement.@typ	Teil des TMF Open API-Standards. Dieser Wert ist immer `ServiceOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Staat	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

Wird asynchron verarbeitet

In diesem Beispiel wird gezeigt, wie der Abfrageparameter mode verwendet wird, um einen Auftrag asynchron zu erstellen. 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"
}

Synchrone Verarbeitung (Standard)

Das folgende Beispiel zeigt, wie Sie einen Serviceauftrag erstellen, indem Sie die Eigenschaft serviceOrderItem.action auf „ Hinzufügen“ setzen.

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",
                  "value": "Standard"
               },
               {
                  "name": "Firewall coverage",
                  "value": "Premium (Up to 50 sites)"
               },
               {
                  "name": "Administration Support",
                  "value": "Basic (Customer Managed)"
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "@type": "Managed Firewall Service"
            }
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

Antworttext:

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

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",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

Antworttext.

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

cURL-Anforderung

Im folgenden Beispiel wird eine Serviceauftragsposition gelöscht, indem die Eigenschaft serviceOrderItem.action auf „ delete“ festgelegt wird.

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",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

Antworttext.

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

Serviceauftrags-Offene API – POST /sn_tmf_api/order/serviceOrder/outboundresponse

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

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

Hinweis:

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

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

URL-Format

/api/sn_tmf_api/order/serviceOrder/outboundresponse

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 32. Abfrageparameter
Name	Beschreibung
Keine

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

Header

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

Tabelle : 35. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

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

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

Parameter des Antwort-Haupttexts (JSON)


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

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

curl "http://instance.servicenow.com/api/sn_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"
    }
  ]
}