Servicekatalog-API

Die Servicekatalog Die API stellt Endpunkte bereit, auf die zugegriffen wird Servicekatalog Konfiguration und Aktionen aus innerhalb von Serviceportal.

Servicekatalog – /sn_sc/servicecatalog/cart/{cart_item_ID} LÖSCHEN

Löscht das angegebene Element aus dem aktuellen Einkaufswagen.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/cart/{cart_item_ID}

Standard-URL: /api/sn_sc/servicecatalog/cart/{cart_item_ID}

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 1. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

Cart_item_ID SYS_ID des Elements, das aus dem aktuellen Einkaufswagen gelöscht werden soll.

Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 3. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 4. Anforderungskopfzeilen.
Header Beschreibung
Keine
Tabelle : 5. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 6. Statuscodes
Statuscode Beschreibung
204 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde und das angegebene Element aus dem Einkaufswagen gelöscht wurde.
400 Gibt an, dass entweder der angegebene cart_item_idIst ungültig, oder der Anwender hat keinen Zugriff auf das Einkaufswagenelement.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Keine

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/1f4cc597db21120064301150f0b8f5fc" \
--request DELETE \
--user "username":"password"
None

Servicekatalog – /sn_sc/servicecatalog/cart/{sys_ID} LÖSCHEN/leer

Löscht einen angegebenen Einkaufswagen und den Inhalt des Einkaufswagens.

Welche Fähigkeiten ein Anwender löschen kann (Artikel und/oder Einkaufswagen) hängt von der Rolle ab, in der er sich authentifiziert.

Zum Löschen von Einkaufswagen- und Einkaufswageninhalten erforderliche Anwenderrollen:
  • administrator/catalog_admin: Kann jeden Anwenderwagen leeren.
  • administrator: Kann den Einkaufswagen löschen, nachdem alle Inhalte des Einkaufswagens gelöscht wurden.
  • Catalog_admin: Kann alle Artikel im Einkaufswagen löschen.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/cart/{sys_ID}/leer

Standard-URL: /api/sn_sc/servicecatalog/cart/{sys_ID}/empty

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

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

Datentyp: Zeichenfolge

sys_id SYS_ID des Einkaufswagens, der geleert und gelöscht werden soll.

Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 9. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 10. Anforderungskopfzeilen.
Header Beschreibung
Keine
Tabelle : 11. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 12. Statuscodes
Statuscode Beschreibung
204 Anforderung erfolgreich abgeschlossen, und der Einkaufswagen wird geleert und gelöscht.
400 Gibt einen Fehler aus einem der folgenden Gründe an:
  • Ungültige cartId.
  • Anwender hat keine Rolle admin/catalog_admin oder versucht, einen anderen Anwenderwagen zu leeren.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Keine

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/dde34ad713426300027879d96144b072/empty" \
--request DELETE \
--user 'username':'password'
None

Servicekatalog – GET /sn_sc/servicecatalog/cart

Ruft die Details der Artikel im Einkaufswagen des angemeldeten Anwenders ab.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/cart

Standard-URL: /api/sn_sc/servicecatalog/cart

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 13. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

Tabelle : 14. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 15. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 16. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 17. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 18. Statuscodes
Statuscode Beschreibung
200 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde. Wenn sich kein Artikel im Einkaufswagen befindet, werden grundlegende Einkaufswageninformationen und Preise für den Anwender zurückgegeben. Wenn der Einkaufswagen Artikel enthält, sind auch die Informationen zu den Artikeln und ihren individuellen Preisen enthalten.
400 Gibt an, dass der Einkaufswagen leer ist und nicht auschecken kann.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Parameter Beschreibung
Einkaufswagen-ID SYS_ID des Einkaufswagens.

Datentyp: Zeichenfolge

<recurring_frequency> Liste der Artikel im Einkaufswagen mit einer bestimmten wiederkehrenden Häufigkeit. Mögliche Werte sind:
  • täglich
  • monatlich
  • jährlich
  • Keine (keine wiederkehrenden Gebühren)

Datentyp: Objekt

"<recurring_frequency>": {
  "frequency_label": "String",
  "items": [Array],
  "show_subtotal_price": "String",
  "subtotal_price": "String",
  "subtotal_recurring_frequency": "String",
  "subtotal_recurring_price": "String",
  "subtotal_title": "String",
  "total_title": "String"
<recurring_frequency>.frequency_label Häufigkeit der zugehörigen wiederkehrenden Gebühr.

Datentyp: Zeichenfolge

Standard: Null

<recurring_frequency>.Elemente Liste von Objekten, die Details zu jedem Element enthalten, das der angegebenen wiederkehrenden Häufigkeitskategorie zugeordnet ist.

Datentyp: Array

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created.by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_description": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
<recurring_frequency>.items.cart_item_id SYS_ID des Artikels in diesem Einkaufswagen.

Datentyp: Zeichenfolge

<recurring_frequency>.items.catalog_item_id SYS_ID des Katalogs, der dem Element zugeordnet ist.

Datentyp: Zeichenfolge

<recurring_frequency>.items.created.by Anwender, der den Artikel ursprünglich in den Einkaufswagen gelegt hat.

Datentyp: Zeichenfolge

<recurring_frequency>.items.created_on Datum, an dem der Artikel ursprünglich in den Einkaufswagen gelegt wurde.

Datentyp: Zeichenfolge

<recurring_frequency>.items.delivery_time Zeit, die für die Lieferung des angegebenen Artikels benötigt wird.

Datentyp: Zeichenfolge

<recurring_frequency>.items.item_id Katalog-sys_ID des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.item_name Name des angegebenen Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.localized_price Preis des Artikels in lokaler Währung.

Datentyp: Zeichenfolge

<recurring_frequency>.items.localized_recurring_price Wiederkehrende Gebühr für den angegebenen Artikel in lokaler Währung.

Datentyp: Zeichenfolge

<recurring_frequency>.items.name Elementname.

Datentyp: Zeichenfolge

<recurring_frequency>.items.order_Guide Name des Bestellleitfadens, dem dieser Artikel zugeordnet ist.

Datentyp: Zeichenfolge

<recurring_frequency>.Elemente.Bild Dateiname des Bilds des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.Artikel.Preis Preis des Artikels.

Datentyp: Zeichenfolge

<recurring_frequency>.Artikel.Menge Nummer des angegebenen Artikels im Einkaufswagen.

Datentyp: Zeichenfolge

<recurring_frequency>.items.recurring_frequency Wie oft die wiederkehrende Gebühr für den angegebenen Artikel in Rechnung gestellt wird.

Datentyp: Zeichenfolge

Standard: Null

<recurring_frequency>.items.recurring_price Wiederkehrende Gebühr für das angegebene Element.

Datentyp: Zeichenfolge

<recurring_frequency>.items.recurring_subtotal Zwischensumme der wiederkehrenden Gebühren für den Artikel ( recurring_priceX quantity).

Datentyp: Zahl

<recurring_frequency>.items.recurring_subtotal_price Zwischensumme der wiederkehrenden Gebühren für den Artikel.

Datentyp: Zeichenfolge

<recurring_frequency>.items.short_description Kurzbeschreibung des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.Show_price Kennzeichnung, die angibt, ob der Preis des Artikels im Einkaufswagen angezeigt wird.
Mögliche Werte:
  • Wahr: Zeigen Sie den Preis des Artikels im Einkaufswagen an.
  • Falsch: Preis des Artikels im Einkaufswagen nicht anzeigen.

Datentyp: Boolesch

<recurring_frequency>.items.Show_quantity Kennzeichnung, die angibt, ob die Artikelmenge im Einkaufswagen angezeigt werden soll.
Mögliche Werte:
  • Wahr: Zeigt die Artikelmenge im Einkaufswagen an.
  • Falsch: Die Artikelmenge im Einkaufswagen nicht anzeigen.

Datentyp: Boolesch

<recurring_frequency>.items.Show_recurring_price Kennzeichnung, die angibt, ob die wiederkehrenden Gebühren im Einkaufswagen angezeigt werden sollen.
Mögliche Werte:
  • Wahr: Zeigen Sie die wiederkehrenden Gebühren im Einkaufswagen an.
  • Falsch: Wiederkehrende Gebühren nicht im Einkaufswagen anzeigen.

Datentyp: Boolesch

<recurring_frequency>.Elemente.Zwischensumme Zwischensumme der Elemente.

Datentyp: Zahl

<recurring_frequency>.items.subtotal_price Zwischensumme für das Element ( priceX quantity).

Datentyp: Zeichenfolge

<recurring_frequency>.items.sys_class_Name Systemklassifizierungsname des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.sys_ID SYS_ID des Elementdatensatzes.

Datentyp: Zeichenfolge

<recurring_frequency>.items.updated_by Anwender, der den Artikel aktualisiert hat, nachdem er ursprünglich in den Einkaufswagen gelegt wurde.

Datentyp: Zeichenfolge

<recurring_frequency>.items.updated_on Letztes Datum/letzte Uhrzeit, zu der der Artikel entweder anfänglich in den Einkaufswagen gelegt oder aktualisiert wurde.

Datentyp: Zeichenfolge

<recurring_frequency>.items.variables Liste der Name/Wert-Paare der Elementvariablen.

Datentyp: Objekt

<recurring_frequency>.Show_subtotal_price Kennzeichnung, die angibt, ob eine Zwischensumme für die zugehörige wiederkehrende Gebührenkategorie angezeigt werden soll.
Mögliche Werte:
  • Wahr: Zwischensummen im Einkaufswagen anzeigen.
  • Falsch: Keine Zwischensummen im Einkaufswagen anzeigen.

Datentyp: Boolesch

<recurring_frequency>.subtotal_price Zwischensumme der Kosten aller Elemente für die zugehörige wiederkehrende Häufigkeitskategorie.

Datentyp: Zeichenfolge

<recurring_frequency>.subtotal_recurring_frequency Typ der wiederkehrenden Zwischensumme, z. B. täglich, monatlich usw. Identisch mit subtotal_recurring_frequency.

Datentyp: Zeichenfolge

<recurring_frequency>.subtotal_recurring_price Zwischensumme der wiederkehrenden Gebühren der Elemente innerhalb der zugehörigen Kategorie „wiederkehrende Häufigkeit“.

Datentyp: Zeichenfolge

<recurring_frequency>.subtotal_title Wenn show_subtotal_priceIst auf festgelegt Wahr , Der Text, der im Einkaufswagen für den zugehörigen Untertitel angezeigt werden soll.

Datentyp: Zeichenfolge

<recurring_frequency>.total_title Text, der für den Gesamttitel der zugehörigen wiederkehrenden Häufigkeitskategorie angezeigt werden soll.

Datentyp: Zeichenfolge

Show_subtotal_price Kennzeichnung, die angibt, ob der Zwischensummenpreis im Einkaufswagen angezeigt werden soll.
Mögliche Werte:
  • Wahr: Zwischensummen im Einkaufswagen anzeigen.
  • Falsch: Keine Zwischensummen im Einkaufswagen anzeigen.

Datentyp: Zeichenfolge

zwischensumme_Preis Zwischensumme aller Artikel im Einkaufswagen in gesamten Dollar.

Datentyp: Zeichenfolge

zwischensumme_recurring_frequency Typ der wiederkehrenden Zwischensumme, z. B. täglich, monatlich usw. Identisch mit <recurring_frequency>.subtotal_recurring_frequency.

Datentyp: Zeichenfolge

zwischensumme_recurring_price Zwischensumme der wiederkehrenden Häufigkeitsgebühren für alle Artikel im Einkaufswagen.

Datentyp: Zeichenfolge

zwischensumme_title Text, der im Einkaufswagen für den Feldtitel der Zwischensumme angezeigt werden soll.

Datentyp: Zeichenfolge

Total_title Text, der im Einkaufswagen für den Gesamtfeldtitel angezeigt werden soll.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "cart_id": "6d88bc29137d2300027879d96144b04b",
    "subtotal_price": "$1,598.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "none": {
      "subtotal_price": "$1,598.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
      {
        "updated_on": "2018-11-15 14:24:00",
        "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
        "short_description": "Apple iPhone 7 ",
        "recurring_subtotal_price": "$0.00",
        "delivery_time": "2 Days",
        "sys_class_name": "sc_cat_item",
        "sys_id": "1f88bc29137d2300027879d96144b056",
        "price": "$799.00",
        "recurring_frequency": null,
        "subtotal_price": "$799.00",
        "variables": {},
        "quantity": "1",
        "item_id": "07f1666b0bf00300eba42da0d5673ab0",
        "recurring_price": "$0.00",
        "show_price": true,
        "item_name": "Apple iPhone7",
        "cart_item_id": "1f88bc29137d2300027879d96144b056",
        "recurring_subtotal": 0,
        "show_quantity": true,
        "created_by": "admin",
        "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
        "created_on": "2018-11-15 14:24:00",
        "localized_price": "$799.00",
        "subtotal": 799,
        "show_recurring_price": false,
        "name": "Apple iPhone7",
        "updated_by": "admin",
        "localized_recurring_price": "$0.00",
        "order_guide": ""
      },
    ],
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
   },
   "show_subtotal_price": "true",
   "subtotal_title": "Subtotal"
 }
}

Servicekatalog – GET /sn_sc/servicecatalog/cart/Delivery_address/{user_ID}

Ruft die Versandadresse des angegebenen Anwenders basierend auf ab glide.sc.req_for.rolesEigenschaft und das Standardverhalten, das in konfiguriert ist glide.sc.req_for.roles.defaultproperty.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/cart/Delivery_address/{user_ID}

Standard-URL: /api/sn_sc/servicecatalog/cart/Delivery_address/{user_ID}

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

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

Datentyp: Zeichenfolge

user_id SYS_ID des Anwenders, dessen Versandadresse abgerufen werden soll.

Datentyp: Zeichenfolge

Tabelle: Benutzer [sys_user]

Tabelle : 20. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 21. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 22. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 23. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 24. Statuscodes
Statuscode Beschreibung
200 Anforderung erfolgreich abgeschlossen; gibt die Versandadresse des angegebenen Anwenders zurück.
400 Anwender-sys_ID ist ungültig.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Ergebnis Adresse des angegebenen Anwenders.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/delivery_address/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
'result': '25 New Chardon Street, Boston\nBoston, MA, 02114-1801\nUSA'
}

Servicekatalog – GET /sn_sc/servicecatalog/Kataloge

Ruft basierend auf den übergebenen Parametern eine Liste von Katalogen ab, auf die der Anwender Zugriff hat.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/Kataloge

Standard-URL: /api/sn_sc/servicecatalog/catalogs

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

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

Datentyp: Zeichenfolge

Tabelle : 26. Abfrageparameter
Name Beschreibung
Sysparm_limit Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs.

Dieser Grenzwert wird vor der ACL-Auswertung angewendet. Wenn keine Datensätze zurückgegeben werden, einschließlich der Datensätze, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge so an, dass Datensätze, auf die Sie zuerst zugreifen können, zurückgegeben werden.

Hinweis:
Ungewöhnlich groß sysparm_limitWerte können sich auf die Systemleistung auswirken.

Datentyp: Zahl

Standard: 10000

Sysparm_Text Stichwort, nach dem im Feld „Titel“ der verfügbaren Servicekataloge gesucht werden soll.

Datentyp: Zeichenfolge

Sysparm_View Gerät, auf dem das Element angezeigt werden kann:
  • desktop: Auf dem Desktop.
  • mobile: Auf einem Mobilgerät.
  • both: Sowohl auf einem Desktop als auch auf einem Mobilgerät.

Datentyp: Zeichenfolge

Tabelle : 27. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 28. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 29. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 30. Statuscodes
Statuscode Beschreibung
200 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde. Wenn eine gültige Abfrage keine Ergebnisse zurückgibt, enthält der Antworttext nur ein leeres Ergebnis-Array.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Beschreibung Beschreibung des Katalogs.

Datentyp: Zeichenfolge

Desktop_Image Bild, das auf dem Desktop für diesen Katalog angezeigt wird.

Datentyp: Zeichenfolge

Has_Categories Kennzeichnung, die angibt, ob der Katalog Kategorien enthält.
Mögliche Werte:
  • Wahr: Katalog enthält Kategorien.
  • Falsch: Katalog enthält keine Kategorien.

Datentyp: Boolesch

Has_items Kennzeichnung, die angibt, ob der Katalog Elemente enthält.
Mögliche Werte:
  • Wahr: Katalog enthält Elemente.
  • Falsch: Katalog enthält keine Elemente.

Datentyp: Boolesch

sys_id SYS_ID des Katalogs.

Datentyp: Zeichenfolge

Titel Katalogtitel.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs?sysparm_limit=10" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": [
    {
      "title": "Technical Catalog",
      "sys_id": "742ce428d7211100f2d224837e61036d",
      "has_categories": true,
      "has_items": true,
      "description": "Products and services for the IT department",
      "desktop_image": "7a7c8271475211002ee987e8dee4906d.iix"
    },
    {
      "title": "Service Catalog",
      "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
      "has_categories": true,
      "has_items": true,
      "description": "Service Catalog - IT Now",
      "desktop_image": "adbcc271475211002ee987e8dee49001.iix"
    }
  ]
}

Servicekatalog – GET /sn_sc/servicecatalog/catalogs/{sys_ID}/Categories

Ruft die Liste der verfügbaren Kategorien für den angegebenen Katalog ab.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/catalogs/{sys_ID}/Categories

Standard-URL: /api/sn_sc/servicecatalog/catalogs/{sys_ID}/Categories

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 31. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

sys_id SYS_ID des Katalogs, dessen Kategorien angefordert werden.

Datentyp: Zeichenfolge

Tabelle : 32. Abfrageparameter
Name Beschreibung
Sysparm_limit Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs.

Dieser Grenzwert wird vor der ACL-Auswertung angewendet. Wenn keine Datensätze zurückgegeben werden, einschließlich der Datensätze, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge so an, dass Datensätze, auf die Sie zuerst zugreifen können, zurückgegeben werden.

Hinweis:
Ungewöhnlich groß sysparm_limitWerte können sich auf die Systemleistung auswirken.

Datentyp: Zahl

Standard: 10000

Sysparm_Offset Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken.

Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Sysparm_Offset=sysparm_Offset+sysparm_limit , Bis Sie das Ende aller Datensätze erreichen.

Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

Datentyp: Zahl

Standard: 0

sysparm_top_level_only Nur die Kategorien zurückgeben, deren übergeordnetes Element ein Katalog ist.
Gültige Werte:
  • Wahr: Gibt nur die Kategorien zurück, deren übergeordnetes Element ein Katalog ist.
  • Falsch: Alle Kategorien zurückgeben.

Datentyp: Boolesch

Sysparm_View UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die in der Antwort zurückgegebenen Felder.

Gültige Werte:

  • Desktop
  • Mobile
  • both

Wenn Sie auch angeben sysparm_fieldsParameter, hat Vorrang.

Datentyp: Zeichenfolge

Tabelle : 33. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 34. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 35. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 36. Statuscodes
Statuscode Beschreibung
200 Gibt eine Liste von Kategorien in einem Katalog zurück. Wenn keine Abfrageergebnisse vorhanden sind, wird ein leeres Array zurückgegeben.
400 Gibt an, dass die sys_ID der Anforderung oder des Katalogs ungültig ist.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
count Anzahl der Elemente innerhalb der Kategorie.

Datentyp: Zahl

Beschreibung Kurze Kategoriebeschreibung.

Datentyp: Zeichenfolge

Vollständige _Beschreibung Detaillierte Kategoriebeschreibung.

Datentyp: Zeichenfolge

Header_Symbol Symbol, das in Kategorie-Header verwendet wird.

Datentyp: Zeichenfolge

Homepage_Image Bild, das für diese Kategorie auf der Homepage der Kategorie angezeigt wird.

Datentyp: Zeichenfolge

icon Symbol, das zum Signieren dieser Kategorie verwendet werden soll.

Datentyp: Zeichenfolge

Unterkategorien Liste der Unterkategorien innerhalb der Kategorie.

Datentyp: Array

"subcategories": [
  "sys_id": "String",
  "title": "String
]
Unterkategorien.sys_ID SYS_ID der Unterkategorie.

Datentyp: Zeichenfolge

Unterkategorien.Titel Titel der Unterkategorie.

Datentyp: Zeichenfolge

sys_id SYS_ID der Kategorie.

Datentyp: Zeichenfolge

Titel Kategorientitel.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs/e0d08b13c3330100c8b837659bba8fb4/categories?sysparm_limit=2 \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": [
    {
      "title": "Can We Help You?",
      "description": "Your IT gateway. Report issues and submit requests.\n\t\t",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "29f8ffa9471211002ee987e8dee4905e.iix",
      "count": 14,
      "subcategories": [],
      "sys_id": "e15706fc0a0a0aa7007fc21e1ab70c2f"
    },
    {
      "title": "Departmental Services",
      "description": "Services offered by different departments in the organization",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "6fb4a1d95f2211001c9b2572f2b47748.iix",
      "count": 1,
      "subcategories": [],
      "sys_id": "95fc11615f1211001c9b2572f2b477c6"
    },
    {
      "title": "Desktops",
      "description": "Desktop computers for your work area.",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "1bface31475211002ee987e8dee49095.iix",
      "count": 1,
      "subcategories": [],
      "sys_id": "900682363731300054b6a3549dbe5d5f"
    }
  ]
}

Servicekatalog – GET /sn_sc/servicecatalog/catalogs/{sys_ID}

Ruft die verfügbaren Informationen für einen angegebenen Katalog ab.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/catalogs/{sys_ID}

Standard-URL: /api/sn_sc/servicecatalog/catalogs/{sys_ID}

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 37. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

sys_id SYS_ID des abzurufenden Katalogs.

Datentyp: Zeichenfolge

Tabelle : 38. Abfrageparameter
Name Beschreibung
Sysparm_View Gerät, auf dem das Element angezeigt werden kann:
  • desktop: Auf dem Desktop.
  • mobile: Auf einem Mobilgerät.
  • both: Sowohl auf einem Desktop als auch auf einem Mobilgerät.

Datentyp: Zeichenfolge

Tabelle : 39. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 40. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 41. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 42. Statuscodes
Statuscode Beschreibung
200 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde, und gibt die verfügbaren Informationen für den angegebenen Katalog zurück.
400 Gibt an, dass die Anforderung aus einem der folgenden Gründe ungültig ist:
  • Anwender hat keinen Zugriff auf den Katalog.
  • Ungültige sys_ID.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
categories Liste von Objekten, die Kategorien innerhalb des Katalogs beschreiben.

Datentyp: Array

"categories": [
  "description": "String",
  "header_image": "String",
  "sys_id": "String",
  "title": "String
]
categories.description Beschreibung der Kategorie.

Datentyp: Zeichenfolge

Categories.Header_image Kategorie-Header-Bild.

Datentyp: Zeichenfolge

Categories.sys_ID Eindeutiger Kategoriebezeichner (sys_ID).

Datentyp: Zeichenfolge

Kategorien.Titel Kategorientitel.

Datentyp: Zeichenfolge

Beschreibung Katalogbeschreibung.

Datentyp: Zeichenfolge

Desktop_Image Quelle des Bilds, das mit dem Katalog in der Desktop-Ansicht angezeigt wird.

Datentyp: Zeichenfolge

Has_Categories Kennzeichnung, die angibt, ob der Katalog Kategorien enthält.
Mögliche Werte:
  • Wahr: Katalog hat Kategorien.
  • Falsch: Katalog enthält keine Kategorien.

Datentyp: Boolesch

Has_items Kennzeichnung, die angibt, ob in der Kategorie Elemente vorhanden sind.
Mögliche Werte:
  • Wahr: Dem Katalog sind Elemente zugeordnet.
  • Falsch: Dem Katalog sind keine Elemente zugeordnet.

Datentyp: Boolesch

sys_id Eindeutige Katalog-sys_ID

Datentyp: Zeichenfolge

Titel Katalogtitel.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.comaqsw" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "title": "Customer Service",
    "sys_id": "65bcd377c3011200b12d9f2974d3aea0",
    "has_categories": true,
    "categories": [
      {
        "header_image": "",
        "sys_id": "4cb69d19c3921200b0449f2974d3ae69",
        "description": null,
        "title": "Services"
      },
      {
        "header_image": "",
        "sys_id": "1b8611d5c3921200b0449f2974d3ae12",
        "description": null,
        "title": "Support"
      }
    ],
    "has_items": true,
    "description": "Customer Service",
    "desktop_image": ""
  }
}

Servicekatalog – GET /sn_sc/servicecatalog/Categories/{sys_ID}

Ruft die verfügbaren Informationen für eine angegebene Kategorie ab.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/Categories/{sys_ID}

Standard-URL: /api/sn_sc/servicecatalog/Categories/{sys_ID}

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 43. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

sys_id SYS_ID der Kategorie, für die Informationen zurückgegeben werden sollen.

Datentyp: Zeichenfolge

Tabelle : 44. Abfrageparameter
Name Beschreibung
Sysparm_View UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die in der Antwort zurückgegebenen Felder.

Gültige Werte:

  • Desktop
  • Mobile
  • both

Wenn Sie auch angeben sysparm_fieldsParameter, hat Vorrang.

Datentyp: Zeichenfolge

Tabelle : 45. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 46. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 47. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 48. Statuscodes
Statuscode Beschreibung
200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400 Gibt an, dass die Anforderung aus einem der folgenden Gründe ungültig ist:
  • Anwender hat keinen Zugriff auf die Kategorie.
  • Ungültige sys_ID.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Child_Categories Liste von Objekten, die die untergeordneten Kategorien beschreiben, die zu dieser Kategorie gehören.

Datentyp: Array

"child_categories": [
  "count": Number,
  "isParentCategory": "String",
  "parent": "String",
  "subcategories": [Array],
  "sys_id": "String",
  "title": "String"
]
Child_Categories.count Anzahl der Elemente in der untergeordneten Kategorie.

Datentyp: Zahl

Child_Categories.isParentCategory Kennzeichnung, die angibt, ob dies eine übergeordnete Kategorie ist.
Mögliche Werte:
  • Wahr: Übergeordnete Kategorie.
  • Falsch: Nicht die übergeordnete Kategorie.

Datentyp: Boolesch

Child_Categories.parent SYS_ID des übergeordneten Elements der untergeordneten Kategorie.

Datentyp: Zeichenfolge

Child_Categories.Unterkategorien Liste von Objekten, die die Unterkategorien für diese untergeordnete Kategorie beschreiben.

Datentyp: Array

"subcategories": [
  "sys_id": "String",
  "title": "String"
]
Untergeordnete Kategorien.Unterkategorien.sys_ID SYS_ID der untergeordneten Unterkategorie.

Datentyp: Zeichenfolge

Child_Categories.Unterkategorien.title Titel der untergeordneten Unterkategorie.

Datentyp: Zeichenfolge

Child_Categories.sys_ID SYS_ID der untergeordneten Kategorie.

Datentyp: Zeichenfolge

Child_Categories.title Titel der untergeordneten Kategorie.

Datentyp: Zeichenfolge

Beschreibung Kurzkategoriebeschreibung.

Datentyp: Zeichenfolge

Full_description Detaillierte Kategoriebeschreibung.

Datentyp: Zeichenfolge

Header_Symbol Quelle des Symbols, das neben dem Kategorieheader angezeigt wird, wenn die Kategorie in der Kategorie der obersten Ebene aufgeführt ist.

Datentyp: Zeichenfolge

Homepage_Image Quelle des Homepage-Bilds für die Kategorie.

Datentyp: Zeichenfolge

icon Quelle des kleinen Symbols, das neben dem Kategorienamen angezeigt wird, wenn die Kategorie als Unterkategorie aufgeführt ist.

Datentyp: Zeichenfolge

sys_id SYS_ID der Kategorie.

Datentyp: Zeichenfolge

Titel Kategorientitel.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/categories/b0fdfb01932002009ca87a75e57ffbe9" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "title": "Office",
    "description": "Office services such as printing, supplies requisition\n\t\t\tand document shipping and delivery.\n\t\t",
    "full_description": null,
    "icon": "",
    "header_icon": "",
    "homepage_image": "498b0271475211002ee987e8dee490ea.iix",
    "sys_id": "109cdff8c6112276003b17991a09ad65",
    "child_categories": [
      {
        "sys_id": "109f0438c6112276003ae8ac13e7009d",
        "title": "Services",
        "count": 16,
        "parent": "109cdff8c6112276003b17991a09ad65",
        "subcategories": [],
        "isParentCategory": false
      }
    ]
  }
}

Servicekatalog – GET /sn_sc/servicecatalog/items

Ruft eine Liste von Katalogelementen basierend auf den angegebenen Parametern ab.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/items

Standard-URL: /api/sn_sc/servicecatalog/items

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 49. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

Tabelle : 50. Abfrageparameter
Name Beschreibung
Sysparm_catalog Katalog-sys_ID des Elements. Verwenden Sie diesen Parameter, um Elemente in einem bestimmten Katalog zu suchen.

Datentyp: Zeichenfolge

Sysparm_category Kategorie-sys_ID des Elements. Verwenden Sie diesen Parameter, um Katalogelemente in einer bestimmten Kategorie zu suchen.

Datentyp: Zeichenfolge

Sysparm_limit Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs.

Dieser Grenzwert wird vor der ACL-Auswertung angewendet. Wenn keine Datensätze zurückgegeben werden, einschließlich der Datensätze, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge so an, dass Datensätze, auf die Sie zuerst zugreifen können, zurückgegeben werden.

Hinweis:
Ungewöhnlich groß sysparm_limitWerte können sich auf die Systemleistung auswirken.

Datentyp: Zahl

Standard: 10000

Sysparm_Offset Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken.

Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Sysparm_Offset=sysparm_Offset+sysparm_limit , Bis Sie das Ende aller Datensätze erreichen.

Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

Datentyp: Zahl

Standard: 0

Sysparm_Text Bestimmter Text, nach dem in den Kategorieelementen gesucht werden soll. Beispiel: Sysparm_Text="iPhone" Oder Sysparm_Text="Mobilgeräte" .

Datentyp: Zeichenfolge

Sysparm_type Typ des Elements.

Gültige Suchwerte:

  • Datensatzersteller
  • Bestellleitfaden
Wenn ein anderer Wert übergeben wird, werden die Informationen ignoriert.

Datentyp: Zeichenfolge

Sysparm_View UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die in der Antwort zurückgegebenen Felder.

Gültige Werte:

  • Desktop
  • Mobile
  • both

Wenn Sie auch angeben sysparm_fieldsParameter, hat Vorrang.

Datentyp: Zeichenfolge

Tabelle : 51. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 52. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 53. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 54. Statuscodes
Statuscode Beschreibung
200 Gibt eine Liste von Katalogen und Elementen basierend auf den angegebenen Parametern zurück. Wenn eine gültige Abfrage zu keinen Elementen führt, enthält der Antworttext nur ein leeres Ergebnis-Array.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Parameter Beschreibung
Kataloge Liste von Objekten, die die Kataloge beschreiben, die dieses Element enthalten.

Datentyp: Array

"catalogs": [{
  "sys_id": "String",
  "title": "String"
}]
Catalogs.sys_ID SYS_ID des Katalogs.

Datentyp: Zeichenfolge

Kataloge.Titel Katalogtitel.

Datentyp: Zeichenfolge

Kategorie Beschreibt die Kategorie, die dieses Element enthält.

Datentyp: Objekt

"catalogs": {
  "sys_id": "String",
  "title": "String"
}
Kategorie.sys_ID SYS_ID der Kategorie.

Datentyp: Zeichenfolge

Kategorie.Titel Kategorietitel

Datentyp: Zeichenfolge

content_type Typ des Inhalts.

Datentyp: Zeichenfolge

Beschreibung Detaillierte Beschreibung des Elements.

Datentyp: Zeichenfolge

icon Quelle des kleinen Symbols, das neben dem Elementnamen angezeigt wird.

Datentyp: Zeichenfolge

kb_article wissensbasierter artikel, der dem Element zugeordnet ist.

Datentyp: Zeichenfolge

Local_currency Länderwährungscode für die lokale Währung.

Datentyp: Zeichenfolge

Localized_price Preis des Artikels, ausgedrückt in der von definierten Währung local_currency.

Datentyp: Zeichenfolge

Localized_recurring_price Preis der wiederkehrenden Gebühr, ausgedrückt in der von definierten Währung local_currency.

Datentyp: Zeichenfolge

Name Name des Elements.

Datentyp: Zeichenfolge

Bestellen Vordefinierte Reihenfolge, zu der der Artikel gehört.

Datentyp: Zahl

Bild Pfad zum Bild, das für das Element angezeigt werden soll.

Datentyp: Zeichenfolge

Preis Preis des Artikels, ausgedrückt in der von definierten Währung price_currency.

Datentyp: Zeichenfolge

Price_currency Länderwährungscode, für den der Artikelpreis ausgedrückt wird.

Datentyp: Zeichenfolge

recurring_frequency Häufigkeit, mit der die wiederkehrenden Gebühren angewendet werden, z. B. täglich, monatlich oder jährlich; null, wenn für den Artikel keine Gebühren vorhanden sind.

Datentyp: Zeichenfolge

recurring_price Betrag der wiederkehrenden Gebühr, die dem Artikel zugeordnet ist.

Datentyp: Zeichenfolge

Recurring_price_currency Länderwährungscode, für den die wiederkehrenden Gebühren ausgedrückt werden.

Datentyp: Zeichenfolge

short_description Kurze Beschreibung des Elements.

Datentyp: Zeichenfolge

Show_price Kennzeichnung, die angibt, ob Artikelpreise im Einkaufswagen angezeigt werden sollen.
Mögliche Werte:
  • Wahr: Name-Wert-Paare werden in den Antwortparametern zurückgegeben.
  • Falsch: Name-Wert-Paare werden in den Antwortparametern nicht zurückgegeben.

Datentyp: Boolesch

Show_quantity Kennzeichnung, die angibt, ob die Artikelmenge im Einkaufswagen angezeigt werden soll.
Mögliche Werte:
  • Wahr: Zeigt die Artikelmenge im Einkaufswagen an.
  • Falsch: Zeigen Sie die Artikelmenge nicht im Einkaufswagen an.

Datentyp: Boolesch

sys_class_name Tabelle, zu der der Datensatz gehört, z. B. sc_cat_item_producer.

Datentyp: Zeichenfolge

sys_id SYS_ID des Elements.

Datentyp: Zeichenfolge

Typ Typ des Elements.

Datentyp: Zeichenfolge

URL URL des Elements.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items?sysparm_catalog=e0d08b13c3330100c8b837659bba8fb4&sysparm_limit=2" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": [
    {
      "short_description": null,
      "kb_article": "",
      "icon": "images/icons/catalog_item.gifx",
      "description": "<p class=\"p1\"><font size=\"2\"><span class=\"s1\">Request an existing Standard Change Template is made unavailable when it is no longer required or no longer acceptable as a Standard Change.  This will be confirmed by your Change Management team.</span></font></p>",
      "show_price": false,
      "type": "record_producer",
      "show_quantity": true,
      "sys_class_name": "sc_cat_item_producer",
      "picture": "",
      "url": "",
      "sys_id": "011f117a9f3002002920bde8132e7020",
      "content_type": "",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Retire a Standard Change Template",
      "category": {
        "sys_id": "00728916937002002dcef157b67ffb6d",
        "title": "Template Management"
      },
      "order": 30
    },
    {
      "short_description": null,
      "kb_article": "",
      "icon": "4cc3ec3d471211002ee987e8dee490d0.iix",
      "description": "<p><font size=\"3\" color=\"#808080\" face=\"arial,helvetica,sans-serif\">A role delegator may delegate any role they have to any member of the specified group</font></p>",
      "show_price": false,
      "type": "record_producer",
      "show_quantity": true,
      "sys_class_name": "sc_cat_item_producer",
      "picture": "ed44b5804f889200086eeed18110c7ca.iix",
      "url": "",
      "sys_id": "01205b180a0a0b3000b6efd641d24b75",
      "content_type": "",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Grant role delegation rights within a group",
      "category": {
        "sys_id": "496a3a7e0a0a0bc00089b39df14eb56e",
        "title": "Role Delegation"
      },
      "order": 100
    }
  ]
}

Servicekatalog – GET /sn_sc/servicecatalog/items/{item_sys_ID}/Delegation/{user_sys_ID}

Überprüft, ob der angegebene delegierte Anwender über Beschaffungsrechte für das angegebene Servicekatalogelement verfügt.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/items/{item_sys_ID}/Delegation/{user_sys_ID}

Standard-URL: /api/sn_sc/servicecatalog/items/{item_sys_ID}/Delegation/{user_sys_ID}

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 55. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

item_sys_id SYS_ID des Servicekatalogelements, um zu überprüfen, ob der angegebene Anwender über Beschaffungsrechte verfügt.

Datentyp: Zeichenfolge

Tabelle: Servicekatalog [sc_catalog]

user_sys_id SYS_ID des Anwenders, um zu überprüfen, ob er über Beschaffungsrechte für das angegebene Servicekatalogelement verfügt.

Datentyp: Zeichenfolge

Tabelle: Anwender [sys_users]

Tabelle : 56. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 57. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 58. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 59. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 60. Statuscodes
Statuscode Beschreibung
200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Ergebnis Kennzeichnung, die angibt, ob der angegebene Anwender über Beschaffungsrechte für das angegebene Servicekatalogelement verfügt.
Gültige Werte:
  • Wahr: Anwender hat Beschaffungsrechte.
  • Falsch: Anwender hat keine Beschaffungsrechte.

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/5c7e9fd20f1010108af26b198b767eb8/delegation/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "result": true
  }
}

Servicekatalog – GET /sn_sc/servicecatalog/items/{sys_ID}

Ruft ein angegebenes Katalogelement ab.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/items/{sys_ID}

Standard-URL: /api/sn_sc/servicecatalog/items/{sys_ID}

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 61. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

sys_id SYS_ID des zurückzugebenden Katalogelements.

Datentyp: Zeichenfolge

Tabelle : 62. Abfrageparameter
Name Beschreibung
Sysparm_View UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die in der Antwort zurückgegebenen Felder.

Gültige Werte:

  • Desktop
  • Mobile
  • both

Wenn Sie auch angeben sysparm_fieldsParameter, hat Vorrang.

Datentyp: Zeichenfolge

Tabelle : 63. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 64. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 65. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 66. Statuscodes
Statuscode Beschreibung
200 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde, und gibt die Details des Katalogelements zurück.
400 Gibt an, dass die Anforderung aus einem der folgenden Gründe ungültig ist:
  • Anwender hat keinen Zugriff auf das Katalogelement.
  • Ungültige sys_ID.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Kataloge Liste von Objekten, die die Kataloge beschreiben, die dieses Element enthalten.

Datentyp: Array

"catalogs": [{
  "sys_id": "String",
  "title": "String"
}]
Catalogs.sys_ID SYS_ID des Katalogs.

Datentyp: Zeichenfolge

Kataloge.Titel Katalogtitel.

Datentyp: Zeichenfolge

categories Liste von Objekten, die die Kategorien beschreiben, die dieses Element enthalten.

Datentyp: Array

"categories": [{
  "active": Boolean,
  "category": {Object},
  "sys_id": "String",
  "title": "String"
}]
Kategorien.aktiv Kennzeichnung, die angibt, ob die Kategorie aktiv ist.
Mögliche Werte:
  • Wahr: Kategorie ist aktiv.
  • Falsch: Kategorie ist inaktiv.

Datentyp: Boolesch

categories.category Beschreibt die zugeordnete Kategorie.

Datentyp: Objekt

"category": {
  "active": Boolean,
  "sys_id": "String",
  "title": "String"
}
categories.category.active Kennzeichnung, die angibt, ob die Kategorie aktiv ist.
Mögliche Werte:
  • Wahr: Kategorie ist aktiv.
  • Falsch: Kategorie ist inaktiv.

Datentyp: Boolesch

categories.category.sys_id SYS_ID der Kategorie.

Datentyp: Zeichenfolge

categories.category.title Kategorientitel.

Datentyp: Zeichenfolge

Categories.sys_ID Übergeordnete Kategorie der in angegebenen Kategorie categories.category.

Datentyp: Zeichenfolge

Kategorie Primäre Kategorie, zu der das Element gehört.

Datentyp: Objekt

"category": {
  "sys_id": "String",
  "title": "String"
}
Kategorie.sys_ID SYS_ID der primären Kategorie.

Datentyp: Zeichenfolge

Kategorie.Titel Titel der primären Kategorie.

Datentyp: Zeichenfolge

Client_script Liste aller Katalog-Client-Skripts, die für das Katalogelement definiert sind.

Datentyp: Objekt

"client_script": {
  "onChange": [Array],
  "onLoad": [Array],
  "onSubmit": [Array]
}
Client_script.onChange Liste der onChange-Client-Skripts, die dem Element zugeordnet sind.

Datentyp: Array

Client_script.onSubmit Liste der Client-Skripts, die dem Element zugeordnet sind, onSubmit.

Datentyp: Array

Client_script.onLoad Liste der onLoad-Client-Skripts, die dem Element zugeordnet sind.

Datentyp: Array

content_type Typ des Inhalts.

Datentyp: Zeichenfolge

Data_Lookup Liste der Datensuchen, die für das Katalogelement definiert sind.

Datentyp: Array

Beschreibung Detaillierte Beschreibung des Elements.

Datentyp: Zeichenfolge

icon Quelle des kleinen Symbols, das neben dem Elementnamen angezeigt wird.

Datentyp: Zeichenfolge

kb_article wissensbasierter artikel, der dem Element zugeordnet ist.

Datentyp: Zeichenfolge

Local_currency Länderwährungscode für die lokale Währung.

Datentyp: Zeichenfolge

Localized_price Preis des Artikels, ausgedrückt in der von definierten Währung local_currency.

Datentyp: Zeichenfolge

Localized_recurring_price Preis der wiederkehrenden Gebühr, ausgedrückt in der von definierten Währung local_currency.

Datentyp: Zeichenfolge

Name Name des Elements.

Datentyp: Zeichenfolge

Bestellen Anzahl der Aufträge für den Artikel.

Datentyp: Zahl

Bild Dateiname des Bilds, das für das Element angezeigt werden soll.

Datentyp: Zeichenfolge

Preis Preis des Artikels, ausgedrückt in der von definierten Währung price_currency.

Datentyp: Zeichenfolge

Price_currency Länderwährungscode, für den der Artikelpreis ausgedrückt wird.

Datentyp: Zeichenfolge

recurring_frequency Häufigkeit, mit der die wiederkehrenden Gebühren angewendet werden, z. B. täglich, monatlich oder jährlich.

Datentyp: Zeichenfolge

recurring_price Betrag der wiederkehrenden Gebühr, die dem Artikel zugeordnet ist

Datentyp: Zeichenfolge

Recurring_price_currency Länderwährungscode, für den die wiederkehrenden Gebühren ausgedrückt werden.

Datentyp: Zeichenfolge

short_description Kurze Beschreibung des Elements.

Datentyp: Zeichenfolge

Show_price Kennzeichnung, die angibt, ob Artikelpreise im Einkaufswagen angezeigt werden sollen.
Mögliche Werte:
  • Wahr: Name/Wert-Paare der Preisgestaltung werden in den Antwortparametern zurückgegeben.
  • Falsch: Name/Wert-Paare der Preisgestaltung werden in den Antwortparametern nicht zurückgegeben.

Datentyp: Boolesch

Show_quantity Kennzeichnung, die angibt, ob die Artikelmenge im Einkaufswagen angezeigt werden soll.
Mögliche Werte:
  • Wahr: Zeigt die Artikelmenge im Einkaufswagen an.
  • Falsch: Zeigen Sie die Artikelmenge nicht im Einkaufswagen an.

Datentyp: Boolesch

sys_class_name Name der Tabelle, zu der dieser Datensatz gehört.

Datentyp: Zeichenfolge

sys_id SYS_ID des Elements.

Datentyp: Zeichenfolge

Typ Typ des Elements.

Datentyp: Zeichenfolge

ui_Policy Liste der UI-Richtlinien, die dem Element zugeordnet sind.

Datentyp: Array

URL URL des Elementbilds.

Datentyp: Zeichenfolge

variables Liste der verfügbaren Variablen, die dem Element zugeordnet sind.

Datentyp: Array

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0cf7477237153000158bbfc8bcbe5dec" \
  --request GET \
  --header "Accept:application/json" \
  --user "username":"password"
{
  "result": {
    "short_description": "Apple iPad 3",
    "kb_article": "",
    "icon": "e6b3bc0647311200e0ef563dbb9a71fc.iix",
    "description": "\n\t\t\t<p>\n\t\t\t\t<font size=\"3\">\n\t\t\t\t\t<span style=\"color: gray;\">\n\t\t\t\t\t\tiPad with Retina display Wi-Fi 16GB - Black </span>\n\t\t\t\t</font>\n\t\t\t</p>\n\t\t\t<p>\n\t\t\t\t<span style=\"color: gray;\">Key Features:</span>\n\t\t\t</p>\n\t\t\t<ul><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Retina display (2048x1536 resolution)</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">16GB storage</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Wi-Fi enabled</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Built-in speaker, microphone and camera</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Up to 10 hours battery life</span>\n\t\t\t\t</li></ul>",
    "show_price": true,
    "recurring_price": "$0.00",
    "type": "catalog_item",
    "show_quantity": true,
    "local_currency": "USD",
    "sys_class_name": "pc_hardware_cat_item",
    "picture": "5b977690cb921200f2de77a4634c9c6a.iix",
    "url": "",
    "sys_id": "060f3afa3731300054b6a3549dbe5d3e",
    "recurring_price_currency": "USD",
    "content_type": "",
    "localized_price": "$600.00",
    "price": "$600.00",
    "catalogs": [
      {
        "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
         "title": "Service Catalog"
      }
    ],
    "recurring_frequency": null,
    "name": "Apple iPad 3",
    "localized_recurring_price": "$0.00",
    "category": {
      "sys_id": "b06546f23731300054b6a3549dbe5dd8",
      "title": "Tablets"
    },
    "price_currency": "USD",
    "order": 0,
    "categories": [
      {
        "sys_id": "d258b953c611227a0146101fb1be7c31",
        "active": true,
        "category": {
          "sys_id": "b06546f23731300054b6a3549dbe5dd8",
          "active": true,
          "title": "Tablets"
        },
        "title": "Hardware"
      }
    ],
    "variables": [],
    "ui_policy": [],
    "client_script": {
      "onChange": [],
      "onSubmit": [],
      "onLoad": []
    },
    "data_lookup": []
  }
}

Servicekatalog – GET /sn_sc/servicecatalog/wishlist

Ruft die Liste der Elemente in der Wunschliste des angemeldeten Anwenders ab.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/wishlist

Standard-URL: /api/sn_sc/servicecatalog/wishlist

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 67. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

Tabelle : 68. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 69. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 70. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 71. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 72. Statuscodes
Statuscode Beschreibung
200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Einkaufswagen-ID SYS_ID des Wunschlistenwagens.

Datentyp: Zeichenfolge

items Liste von Objekten, die die Artikel im Einkaufswagen der Wunschliste beschreiben.

Datentyp: Array

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created_by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_descriptions": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
items.cart_item_id SYS_ID des Elements. Identisch mit items.sys_id.

Datentyp: Zeichenfolge

items.catalog_item_id SYS_ID des Katalogbezeichners für dieses Element im Einkaufswagen der Wunschliste. Identisch mit items.item_id.

Datentyp: Zeichenfolge

Items.created_by Anwender, der den Artikel anfänglich in den Einkaufswagen der Wunschliste gelegt hat.

Datentyp: Zeichenfolge

Items.created_on Datum und Uhrzeit, zu der der Artikel ursprünglich in den Wunschlistenwagen gelegt wurde.

Datentyp: Zeichenfolge

items.delivery_time Zeit, die für die Lieferung des Artikels benötigt wird.

Datentyp: Zeichenfolge

items.item_id Eindeutiger Katalogbezeichner für dieses Element im Einkaufswagen der Wunschliste (sys_ID). Identisch mit items.catalog_item_id.

Datentyp: Zeichenfolge

items.item_name Name des Elements.

Datentyp: Zeichenfolge

Items.localized_price Preis des Artikels in lokaler Währung.

Datentyp: Zeichenfolge

Items.localized_recurring_price Preis der wiederkehrenden Gebühr in lokaler Währung.

Datentyp: Zeichenfolge

items.name Name des Elements.

Datentyp: Zeichenfolge

Items.order_Guide Bestellleitfaden, dem der Artikel zugeordnet ist.

Datentyp: Zeichenfolge

Elemente.Bild Pfad zum Bild, das für das Element angezeigt werden soll.

Datentyp: Zeichenfolge

Artikel.Preis Preis des Artikels.

Datentyp: Zeichenfolge

Artikel.Menge Nummer dieses Artikels im Einkaufswagen der Wunschliste.

Datentyp: Zeichenfolge

Items.recurring_frequency Häufigkeit, mit der die wiederkehrenden Gebühren angewendet werden, z. B. täglich, monatlich oder jährlich. Null, wenn keine wiederkehrenden Gebühren für dieses Element vorhanden sind.

Datentyp: Zeichenfolge

Items.recurring_price Betrag der wiederkehrenden Gebühr, die dem Artikel zugeordnet ist.

Datentyp: Zeichenfolge

Items.recurring_subtotal Zwischensumme für die wiederkehrenden Gebühren für diesen Artikel (Recurring_price x Menge).

Datentyp: Zahl

Items.recurring_subtotal_price Zwischensumme für die wiederkehrenden Gebühren für diesen Artikel (Recurring_price x Menge).

Datentyp: Zeichenfolge

Items.short_description Kurze Beschreibung des Elements.

Datentyp: Zeichenfolge

Items.Show_price Kennzeichnung, die angibt, ob Artikelpreise im Einkaufswagen angezeigt werden sollen. Wenn dieser Parameter auf „falsch“ festgelegt ist, werden Name/Wert-Paare der Preisgestaltung in den Antwortparametern nicht zurückgegeben.

Datentyp: Boolesch

Items.Show_quantity Kennzeichnung, die angibt, ob die Artikelmenge im Einkaufswagen angezeigt werden soll.

Datentyp: Boolesch

Items.Show_recurring_price Kennzeichnung, die angibt, ob die wiederkehrenden Gebühren im Einkaufswagen angezeigt werden sollen.

Datentyp: Boolesch

Elemente.Zwischensumme Zwischensumme für diesen Artikel – ohne Cents (Preis x Menge).

Datentyp: Zahl

Items.subtotal_price Zwischensumme für diesen Artikel – einschließlich Cents (Preis x Menge).

Datentyp: Zeichenfolge

Items.sys_class_Name Untergeordnete Klasse, zu der der zugehörige Elementdatensatz gehört.

Datentyp: Zeichenfolge

Items.sys_ID Eindeutiger Bezeichner des Elements (sys_ID). Identisch mit items.cart_item_id.

Datentyp: Zeichenfolge

Elements.updated_by Anwender, der diesen Artikel im Einkaufswagen der Wunschliste aktualisiert hat.

Datentyp: Zeichenfolge

Elements.Updated_on Datum und Uhrzeit, zu der das Element auf die Wunschliste gesetzt wurde.

Datentyp: Zeichenfolge

Elements.Variablen Name-Wert-Paare von Variablen, die dem Element zugeordnet sind.

Datentyp: Objekt

cURL-Anforderung

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
{
  "result": {
    "cart_id": "3a68c46013f12300027879d96144b0ce",
    "items": [
      {
        "updated_on": "2018-11-16 05:54:41",
        "catalog_item_id": "774906834fbb4200086eeed18110c737",
        "short_description": "Macbook Pro",
        "recurring_subtotal_price": "$100.00",
        "delivery_time": "5 Days 0 seconds",
        "sys_class_name": "sc_cat_item",
        "sys_id": "3b8d887113b5a300027879d96144b0c2",
        "price": "$1,499.00",
        "recurring_frequency": "Annually",
        "subtotal_price": "$1,499.00",
        "variables": {
          "Adobe Photoshop": "false",
          "Adobe Acrobat": "false",
          "Optional Software": "true",
          "Additional software requirements": "",
          "Eclipse IDE": "true"
        },
        "quantity": "1",
        "item_id": "774906834fbb4200086eeed18110c737",
        "recurring_price": "$100.00",
        "show_price": true,
        "item_name": "Developer Laptop (Mac)",
        "cart_item_id": "3b8d887113b5a300027879d96144b0c2",
        "recurring_subtotal": 100,
        "show_quantity": true,
        "created_by": "admin",
        "picture": "4e4efd444f889200086eeed18110c7e6.iix",
        "created_on": "2018-11-16 05:54:41",
        "localized_price": "$1,499.00",
        "subtotal": 1499,
        "show_recurring_price": true,
        "name": "Developer Laptop (Mac)",
        "updated_by": "admin",
        "localized_recurring_price": "$100.00",
        "order_guide": ""
      }
    ]
  }
}

Servicekatalog – GET /sn_sc/servicecatalog/wishlist/{cart_item_ID}

Ruft die Details des angegebenen Elements ab, das im Einkaufswagen der Wunschliste gespeichert ist.

URL-Format

Versionierte URL: /api/sn_sc/v1/servicecatalog/wishlist/{cart_item_ID}

Standard-URL: /api/sn_sc/servicecatalog/wishlist/{cart_item_ID}

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 73. Pfad-Parameter
Name Beschreibung
Cart_item_ID SYS_ID des abzurufenden Wunschlisten-Einkaufswagenelements.

Datentyp: Zeichenfolge

Tabelle : 74. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 75. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 76. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 77. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 78. Statuscodes
Statuscode Beschreibung
200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
404 Gibt eine fehlgeschlagene Anforderung an. Falsche Artikel-ID des Einkaufswagens, oder der Artikel ist nicht im Einkaufswagen der Wunschliste vorhanden.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Cart_item_ID SYS_ID des Elements.

Datentyp: Zeichenfolge

Catalog_item_ID SYS_ID des Katalogbezeichners für dieses Element im Einkaufswagen der Wunschliste.

Datentyp: Zeichenfolge

Delivery_time Zeit, die für die Lieferung des Artikels benötigt wird.

Datentyp: Zeichenfolge

item_name Name des Elements.

Datentyp: Zeichenfolge

Localized_price Preis des Artikels in lokaler Währung.

Datentyp: Zeichenfolge

Localized_recurring_price Preis der wiederkehrenden Gebühr in lokaler Währung.

Datentyp: Zeichenfolge

Preis Preis des Artikels.

Datentyp: Zeichenfolge

quantity Nummer dieses Artikels im Einkaufswagen der Wunschliste.

Datentyp: Zeichenfolge

recurring_frequency Häufigkeit, mit der die wiederkehrenden Gebühren angewendet werden, z. B. täglich, monatlich oder jährlich. Null, wenn keine wiederkehrenden Gebühren für dieses Element vorhanden sind.

Datentyp: Zeichenfolge

recurring_price Betrag der wiederkehrenden Gebühr, die dem Artikel zugeordnet ist.

Datentyp: Zeichenfolge

variables Name-Wert-Paare der Variablen, die dem Element zugeordnet sind.

Datentyp: Objekt

cURL-Anforderung

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist/774906834fbb4200086eeed18110c737" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
    "variables": {
      "Adobe Photoshop": "",
      "Adobe Acrobat": "",
      "Optional Software": "",
      "Additional software requirements": ""
    },
    "quantity": "1",
    "localized_price": "$1,100.00",
    "price": "$1,100.00",
    "recurring_frequency": "Annually",
    "localized_recurring_price": "$100.00",
    "recurring_price": "$100.00",
    "item_name": "Standard Laptop &",
    "cart_item_id": "d31be364c3012200d68d3b0ac3d3aecf",
    "delivery_time": "5 Days"
  }
}

Servicekatalog – NACH /sn_sc/servicecatalog/cart/Checkout

Ruft den Bezahlvorgang für den aktuellen Einkaufswagen ab und verarbeitet ihn basierend darauf, ob der zweistufige Bezahlvorgang aktiviert ist.

Beim einstufigen Checkout wird der Einkaufswagen von der Methode ausgecheckt (gespeichert) und die Anforderungsnummer und die Anforderungsauftrags-ID zurückgegeben. Bei zweistufigem Bezahlvorgang gibt die Methode den Einkaufswagenbestellungsstatus und alle für den zweistufigen Bezahlvorgang erforderlichen Informationen zurück.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/cart/Checkout

Standard-URL: /api/sn_sc/servicecatalog/cart/Checkout

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 79. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

Tabelle : 80. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 81. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 82. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 83. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 84. Statuscodes
Statuscode Beschreibung
200 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde. Gibt die Gesamt- und Zwischensummeninformationen und Informationen zu den Artikeln im Einkaufswagen zurück.

Beim einstufigen Checkout wird der Einkaufswagen von der Methode ausgecheckt (gespeichert) und die Anforderungsnummer und die Anforderungsauftrags-ID zurückgegeben. Bei zweistufigem Bezahlvorgang gibt die Methode den Einkaufswagenbestellungsstatus und alle für den zweistufigen Bezahlvorgang erforderlichen Informationen zurück.

400 Gibt an, dass der Einkaufswagen leer ist und nicht auschecken kann.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Parameter Beschreibung
Einkaufswagen-ID SYS_ID des Einkaufswagens.

Datentyp: Zeichenfolge

Delivery_address Adresse, an die die Artikel im Einkaufswagen geliefert werden sollen.

Datentyp: Zeichenfolge

<recurring_frequency> Liste der Artikel im Einkaufswagen mit einer bestimmten wiederkehrenden Häufigkeit. Mögliche Werte sind:
  • täglich
  • monatlich
  • jährlich
  • Keine (keine wiederkehrenden Gebühren)

Datentyp: Objekt

"<recurring_frequency>": {
  "frequency_label": "String",
  "items": [Array],
  "show_subtotal_price": "String",
  "subtotal_price": "String",
  "subtotal_recurring_frequency": "String",
  "subtotal_recurring_price": "String",
  "subtotal_title": "String",
  "total_title": "String"
}
<recurring_frequency>.frequency_label Häufigkeit der zugehörigen wiederkehrenden Gebühr. Wenn für das Element keine wiederkehrenden Gebühren vorhanden sind, enthält dieser Parameter „null“.

Datentyp: Zeichenfolge

<recurring_frequency>.Elemente Array von Objekten, das Details zu jedem Element enthält, das der angegebenen wiederkehrenden Häufigkeitskategorie zugeordnet ist.

Datentyp: Array

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created.by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_description": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
<recurring_frequency>.items.cart_item_id SYS_ID des Artikels in diesem Einkaufswagen.

Datentyp: Zeichenfolge

<recurring_frequency>.items.catalog_item_id Katalog-sys_ID des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.created.by Anwender, der den Artikel ursprünglich in den Einkaufswagen gelegt hat.

Datentyp: Zeichenfolge

<recurring_frequency>.items.created_on Datum, an dem der Artikel ursprünglich in den Einkaufswagen gelegt wurde.

Datentyp: Zeichenfolge

<recurring_frequency>.items.delivery_time Zeit, die für die Lieferung des angegebenen Artikels benötigt wird.

Datentyp: Zeichenfolge

<recurring_frequency>.items.item_id SYS_ID des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.item_name Name des angegebenen Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.localized_price Preis des Artikels in lokaler Währung.

Datentyp: Zeichenfolge

<recurring_frequency>.items.localized_recurring_price Wiederkehrende Gebühr für den angegebenen Artikel in lokaler Währung.

Datentyp: Zeichenfolge

<recurring_frequency>.items.name Elementname.

Datentyp: Zeichenfolge

<recurring_frequency>.items.order_Guide Name des Bestellleitfadens, dem dieser Artikel zugeordnet ist. Wenn dieses Element keinem Bestellleitfaden zugeordnet ist, enthält dieser Parameter eine leere Zeichenfolge.

Datentyp: Zeichenfolge

<recurring_frequency>.Elemente.Bild Dateiname des Bilds des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.Artikel.Preis Preis des Artikels.

Datentyp: Zeichenfolge

<recurring_frequency>.Artikel.Menge Nummer des angegebenen Artikels im Einkaufswagen.

Datentyp: Zeichenfolge

<recurring_frequency>.items.recurring_frequency Wie oft die wiederkehrende Gebühr für den angegebenen Artikel in Rechnung gestellt wird. Wenn für das Element keine wiederkehrenden Gebühren vorhanden sind, enthält dieser Parameter „null“.

Datentyp: Zeichenfolge

<recurring_frequency>.items.recurring_price Wiederkehrende Gebühr für das angegebene Element.

Datentyp: Zeichenfolge

<recurring_frequency>.items.recurring_subtotal Zwischensumme der wiederkehrenden Gebühren für den Artikel ( recurring_priceX quantity).

Datentyp: Zahl

<recurring_frequency>.items.recurring_subtotal_price Zwischensumme der wiederkehrenden Gebühren für den Artikel.

Datentyp: Zeichenfolge

<recurring_frequency>.items.short_description Kurzbeschreibung des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.Show_price Kennzeichnung, die angibt, ob der Preis des Artikels im Einkaufswagen angezeigt wird.
Mögliche Werte:
  • Wahr: Zeigen Sie den Preis des Artikels im Einkaufswagen an.
  • Falsch: Preis des Artikels im Einkaufswagen nicht anzeigen.

Datentyp: Boolesch

<recurring_frequency>.items.Show_quantity Kennzeichnung, die angibt, ob die Artikelmenge im Einkaufswagen angezeigt werden soll.
Mögliche Werte:
  • Wahr: Zeigt die Artikelmenge im Einkaufswagen an.
  • Falsch: Die Artikelmenge im Einkaufswagen nicht anzeigen.

Datentyp: Boolesch

<recurring_frequency>.items.Show_recurring_price Kennzeichnung, die angibt, ob die wiederkehrenden Gebühren im Einkaufswagen angezeigt werden sollen.
Mögliche Werte:
  • Wahr: Zeigen Sie die wiederkehrenden Gebühren im Einkaufswagen an.
  • Falsch: Wiederkehrende Gebühren nicht im Einkaufswagen anzeigen.

Datentyp: Boolesch

<recurring_frequency>.Elemente.Zwischensumme Zwischensumme der Elemente.

Datentyp: Zahl

<recurring_frequency>.items.subtotal_price Zwischensumme für das Element ( priceX quantity).

Datentyp: Zeichenfolge

<recurring_frequency>.items.sys_class_Name Systemklassifizierungsname des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.sys_ID SYS_ID des Elementdatensatzes.

Datentyp: Zeichenfolge

<recurring_frequency>.items.updated_by Anwender, der den Artikel aktualisiert hat, nachdem er ursprünglich in den Einkaufswagen gelegt wurde.

Datentyp: Zeichenfolge

<recurring_frequency>.items.updated_on Letztes Datum/letzte Uhrzeit, zu der der Artikel entweder anfänglich in den Einkaufswagen gelegt oder aktualisiert wurde.

Datentyp: Zeichenfolge

<recurring_frequency>.items.variables Liste der Name-Wert-Paare der Elementvariablen.

Datentyp: Objekt

<recurring_frequency>.Show_subtotal_price Kennzeichnung, die angibt, ob eine Zwischensumme für die zugehörige wiederkehrende Gebührenkategorie angezeigt werden soll.
Mögliche Werte:
  • Wahr: Zwischensummen im Einkaufswagen anzeigen.
  • Falsch: Keine Zwischensummen im Einkaufswagen anzeigen.

Datentyp: Boolesch

<recurring_frequency>.subtotal_price Zwischensumme der Kosten aller Elemente für die zugehörige wiederkehrende Häufigkeitskategorie.

Datentyp: Zeichenfolge

<recurring_frequency>.subtotal_recurring_frequency Typ der wiederkehrenden Zwischensumme, z. B. täglich, monatlich usw. Identisch mit subtotal_recurring_frequency.

Datentyp: Zeichenfolge

<recurring_frequency>.subtotal_recurring_price Zwischensumme der wiederkehrenden Gebühren der Elemente innerhalb der zugehörigen Kategorie „wiederkehrende Häufigkeit“.

Datentyp: Zeichenfolge

<recurring_frequency>.subtotal_title Wenn show_subtotal_priceIst auf festgelegt Wahr , Der Text, der im Einkaufswagen für den zugehörigen Untertitel angezeigt werden soll.

Datentyp: Zeichenfolge

<recurring_frequency>.total_title Text, der für den Gesamttitel der zugehörigen wiederkehrenden Häufigkeitskategorie angezeigt werden soll.

Datentyp: Zeichenfolge

requested_for SYS_ID des Anwenders, für den der Artikel bestellt wurde.

Datentyp: Zeichenfolge

Angefordert_für_Anwender Anwender, der das Element im Namen einer anderen Person angefordert hat.

Datentyp: Zeichenfolge

Show_subtotal_price Kennzeichnung, die angibt, ob der Zwischensummenpreis im Einkaufswagen angezeigt werden soll.
Mögliche Werte:
  • Wahr: Zwischensummen im Einkaufswagen anzeigen.
  • Falsch: Keine Zwischensummen im Einkaufswagen anzeigen.

Datentyp: Zeichenfolge

Special_Instructions Alle Anweisungen des Kunden zum Artikel.

Datentyp: Zeichenfolge

zwischensumme_Preis Zwischensumme aller Artikel im Einkaufswagen in gesamten Dollar.

Datentyp: Zeichenfolge

zwischensumme_recurring_frequency Typ der wiederkehrenden Zwischensumme, z. B. täglich, monatlich usw. Identisch mit <recurring_frequency>.subtotal_recurring_frequency.

Datentyp: Zeichenfolge

zwischensumme_recurring_price Zwischensumme der wiederkehrenden Häufigkeitsgebühren für alle Artikel im Einkaufswagen.

Datentyp: Zeichenfolge

zwischensumme_title Text, der im Einkaufswagen für den Feldtitel der Zwischensumme angezeigt werden soll.

Datentyp: Zeichenfolge

Total_title Text, der im Einkaufswagen für den Gesamtfeldtitel angezeigt werden soll.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/checkout" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "cart_id": "0830db8413a56300397533e2e144b0ba",
    "subtotal_price": "$1,598.00",
    "subtotal_recurring_frequency": "",
    "delivery_address": "",
    "special_instructions": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "requested_for_user": "System Administrator",
    "none": {
      "subtotal_price": "$1,598.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
        {
          "updated_on": "2018-11-06 17:01:21",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "a846872a1369e300027879d96144b07e",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "a846872a1369e300027879d96144b07e",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 17:01:21",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        },
        {
          "updated_on": "2018-11-06 17:34:15",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "7d138fa21329e300027879d96144b065",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "7d138fa21329e300027879d96144b065",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 16:47:30",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "requested_for": "6816f79cc0a8016401c5a33be04be441",
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Servicekatalog – /sn_sc/servicecatalog/cart/submit_order VERÖFFENTLICHEN

Checkt den Anwenderwagen basierend auf dem aktuellen Check-out-Typ aus (ein-Schritt oder zwei-Schritt).

Beim einstufigen Checkout wird der Einkaufswagen von der Methode ausgecheckt (gespeichert) und die Anforderungsnummer und die Anforderungsauftrags-ID zurückgegeben. Bei zweistufigem Bezahlvorgang gibt die Methode den Einkaufswagenbestellungsstatus und alle für den zweistufigen Bezahlvorgang erforderlichen Informationen zurück.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/cart/submit_order

Standard-URL: /api/sn_sc/servicecatalog/cart/submit_order

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 85. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

Tabelle : 86. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 87. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 88. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 89. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 90. Statuscodes
Statuscode Beschreibung
200 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde und die Artikel im Einkaufswagen erfolgreich ausgecheckt wurden.

Beim einstufigen Checkout wird der Einkaufswagen von der Methode ausgecheckt (gespeichert) und die Anforderungsnummer und die Anforderungsauftrags-ID zurückgegeben. Bei zweistufigem Bezahlvorgang gibt die Methode den Einkaufswagenbestellungsstatus und alle für den zweistufigen Bezahlvorgang erforderlichen Informationen zurück.

400 Gibt an, dass der Anwenderwagen leer ist.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
parent_id Falls verfügbar, sys_ID des übergeordneten Datensatzes, aus dem die Anforderung erstellt wird. Weitere Informationen finden Sie unter Konfigurieren Sie eine übergeordnete Zuordnung für eine Anforderung .

Datentyp: Zeichenfolge

parent_table Name der übergeordneten Tabelle.

Datentyp: Zeichenfolge

request_id SYS_ID der generierten Bestellanforderung.

Datentyp: Zeichenfolge

Request_number Nummer der generierten Anforderung.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com /api/sn_sc/v1/servicecatalog/cart/submit_order " \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "request_number": "REQ0010010",
    "request_id": "f89ed597db21120064301150f0b8f5ff"
  }
}

Servicekatalog – /sn_sc/servicecatalog/items/{sys_ID}/add_to_cart VERÖFFENTLICHEN

Fügt das angegebene Element dem Einkaufswagen des aktuellen Anwenders hinzu.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/items/{sys_ID}/add_to_cart

Standard-URL: /api/sn_sc/servicecatalog/items/{sys_ID}/add_to_cart

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 91. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

sys_id SYS_ID des Elements, das dem aktuellen Einkaufswagen hinzugefügt werden soll.

Datentyp: Zeichenfolge

Tabelle : 92. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 93. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
sysparm_also_request_for Kommagetrennte Zeichenfolge von Anwender-sys_IDs anderer Anwender, für die das angegebene Element bestellt werden soll.
  • Sie können nicht mehr als 50 zusätzliche Anwender angeben, die das Element erhalten sollen.
  • Wenn eine Person in der Liste nicht für das Element qualifiziert ist, wird die gesamte Anforderung abgelehnt.
  • Wenn das zugeordnete Element nicht über verfügt requested_forVariablensatz, die Anforderung wird abgelehnt.
  • Wenn das zugeordnete Element über verfügt requested_forVariablensatz, aber Aktivieren Sie auch „Anforderung für“ Variable ist nicht konfiguriert, oder der aufrufende Anwender hat nicht die richtigen Rollen, die Anforderung wird abgelehnt.

Tabelle: Benutzer [sys_user]

Sysparm_quantity Erforderlich. Menge des Artikels. Darf keine negative Zahl sein.

Datentyp: Zahl

Sysparm_requested_for SYS_ID des Anwenders, für den der angegebene Artikel bestellt werden soll.

Datentyp: Zeichenfolge

Tabelle: Benutzer [sys_user]

variables Name-Wert-Paare aller obligatorischen Einkaufswagenelementvariablen. Obligatorische Variablen sind im zugehörigen Formular definiert.

Datentyp: Zeichenfolge

Header

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

Tabelle : 94. Anforderungskopfzeilen.
Header Beschreibung
Keine
Tabelle : 95. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 96. Statuscodes
Statuscode Beschreibung
200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400 Die folgenden Fehler können auftreten:
  • Ungültiger Mengenwert: Gibt an, dass entweder sysparm_quantityParameter ist nicht angegeben oder enthält einen ungültigen Wert.
  • Sicherheitsbeschränkungen verhindern die Reihenfolge des Elements: Gibt an, dass die in den Pfadparametern angegebene sys_ID des Einkaufswagenelements ungültig ist oder der Anwender keinen Zugriff auf das Element hat.
  • Obligatorische Variablen sind erforderlich: Gibt an, dass mindestens eine der obligatorischen Variablen in der Anforderung nicht angegeben ist.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Einkaufswagen-ID Sys_ID des Einkaufswagens

Datentyp: Zeichenfolge

items Details aller Artikel im Einkaufswagen.

Datentyp: Array

"items":[
  {
    "cart_item_id":"String",
    "catalog_item_id":"String",
    "item_name":"String",
    "localized_recurring_price":"String",
    "localized_price":"String",
    "price":"String",
    "quantity":"String",
    "recurring_frequency":"String",
    "recurring_price":"String"
  }
]
items.cart_item_id SYS_ID des Elements.

Datentyp: Zeichenfolge

items.catalog_item_id Katalog-sys_ID des Elements.

Datentyp: Zeichenfolge

items.item_name Name des Elements.

Datentyp: Zeichenfolge

Items.localized_price Preis des Artikels in der lokalen Währung des Anwenders.

Datentyp: Zeichenfolge

Items.localized_recurring_price Wiederkehrender Preis des Artikels in der lokalen Währung des Anwenders.

Datentyp: Zeichenfolge

Artikel.Preis Basispreis.

Datentyp: Zeichenfolge

Artikel.Menge Menge des Artikels im Einkaufswagen.

Datentyp: Zeichenfolge

Items.recurring_frequency Häufigkeit, mit der der wiederkehrende Preis angewendet wird.

Datentyp: Zeichenfolge

Items.recurring_price Wiederkehrender Preis.

Datentyp: Zeichenfolge

Zwischensumme Zwischensumme der Artikel im Einkaufswagen.

Datentyp: Zeichenfolge

Beispiel für Curl-Anforderung und -Antwort

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0d08837237153000158bbfc8bcbe5d02/add_to_cart" \
--request POST \
--header "Accept:application/json" \
--data "{ 'sysparm_quantity' : '1',
  'variables' : {
    'acrobat' : 'true'
  }
}" \
--user "username":"password"
{
  "result": {
    "cart_id": "0951c597db21120064301150f0b8f5cf",
    "subtotal": "$1,599.98",
    "items": [
      {
        "catalog_item_id": "0d08837237153000158bbfc8bcbe5d02",
        "quantity": "1",
        "localized_price": "$799.99",
        "price": "$799.99",
        "recurring_frequency": "Monthly",
        "localized_recurring_price": "$30.00",
        "recurring_price": "$29.00",
        "item_name": "Apple iPhone 5",
        "cart_item_id": "ac61c597db21120064301150f0b8f5f9"
      }
    ]
  }
}

Servicekatalog – /sn_sc/servicecatalog/items/{sys_ID}/add_to_wishlist VERÖFFENTLICHEN

Fügt das angegebene Element dem Einkaufswagen der Wunschliste hinzu.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/items/{sys_ID}/add_to_wishlist

Standard-URL: /api/sn_sc/ servicecatalog/items/{sys_ID}/add_to_wishlist

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 97. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

sys_id SYS_ID des Elements, das der Wunschliste hinzugefügt werden soll.

Datentyp: Zeichenfolge

Tabelle : 98. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 99. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Keine

Header

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

Tabelle : 100. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 101. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 102. Statuscodes
Statuscode Beschreibung
200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400 Gibt eine fehlgeschlagene Anforderung an. Ungültige Anforderungsdaten, oder der Anwender kann der Wunschliste kein Element hinzufügen.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Keine

cURL-Anforderung

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/add_to_wishlist" \
 --request POST \
 --header "Accept:application/json" \
 --header "Content-Type:application/json" \
 --data "{\"sysparm_quantity\":\"1\"}" \
 --user "username":"password"
{
  "result": {
    "cart_id": "02a559a7c3b02200d68d3b0ac3d3ae5d",
    "items": [
      {
        "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
        "variables": {
          "Adobe Photoshop": "",
          "Adobe Acrobat": "",
          "Optional Software": "",
          "Additional software requirements": ""
        },
        "quantity": "1",
        "localized_price": "$1,100.00",
        "price": "$1,100.00",
        "recurring_frequency": "Annually",
        "localized_recurring_price": "$100.00",
        "recurring_price": "$100.00",
        "item_name": "Standard Laptop &",
        "cart_item_id": "d31be364c3012200d68d3b0ac3d3aecf",
        "delivery_time": "5 Days"
      }
    ]
  }
}

Servicekatalog – /sn_sc/servicecatalog/items/{sys_ID}/Checkout_Guide VERÖFFENTLICHEN

Ruft ein Array von Inhalten ab, die zum Bezahlvorgang angefordert werden.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/items/{sys_ID}/Checkout_Guide

Standard-URL: /api/sn_sc/servicecatalog/items/{sys_ID}/Checkout_Guide

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 103. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

sys_id SYS_ID des Checkout-Leitfadens, für den die Informationen zurückgegeben werden sollen.

Datentyp: Zeichenfolge

Tabelle : 104. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 105. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
items Liste von Objekten, die die zum Bezahlvorgang angeforderten Elemente beschreiben.
Datentyp: Array
"items": [{
  "sys_id": "String",
  "sysparm_quantity": "String",
  "variables": {Object}
}]
Items.sys_ID Erforderlich. SYS_ID des Katalogelements.

Datentyp: Zeichenfolge

Items.sysparm_quantity Anzahl der Elemente.

Datentyp: Zeichenfolge

Standard: 1

Elements.Variablen Name-Wert-Paare von Variablen, die dem Element zugeordnet sind.

Datentyp: Objekt

Standard: Keine Variablen

Header

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

Tabelle : 106. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 107. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 108. Statuscodes
Statuscode Beschreibung
200 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde.
  • Ist nicht zweistufig: Artikel werden dem Einkaufswagen hinzugefügt, und der Inhalt des Einkaufswagens wird zurückgegeben.
  • Ist zweistufig: Gibt die Anforderungsnummer und die sys_ID der Anforderung nach dem Bezahlvorgang zurück.
400 Gibt an, dass die Anforderung ungültig ist. Dies kann aus einem der folgenden Gründe liegen:
  • Mindestens ein gesendetes Element ist nicht vorhanden.
  • Anwender hat keinen Zugriff auf mindestens eines der Elemente.
  • Obligatorische Variablen eines oder mehrerer Elemente wurden nicht beantwortet. (Nur als obligatorisch definierte Variablen werden berücksichtigt.)
  • Mengenwert wird gesendet und ist keine positive Ganzzahl.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Tabelle : 109. Elemente, die im Antworttext zurückgegeben werden, wenn der zweistufige Checkout auf „falsch“ festgelegt ist
Name Beschreibung
Einkaufswagen-ID SYS_ID des Einkaufswagens.

Datentyp: Zeichenfolge

items Liste von Objekten, die Details aller Artikel im Einkaufswagen enthalten.

Datentyp: Array

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "delivery_time": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "variables": {Object}
}]
items.cart_item_id SYS_ID des Artikels im Einkaufswagen.

Datentyp: Zeichenfolge

items.catalog_item_id SYS_ID des Katalogelements im Einkaufswagen.

Datentyp: Zeichenfolge

items.delivery_time Zeit, die für die Lieferung des Artikels benötigt wird.

Datentyp: Zeichenfolge

items.item_name Name des Artikels im Einkaufswagen.

Datentyp: Zeichenfolge

Items.localized_price Preis des Artikels in lokaler Währung.

Datentyp: Zeichenfolge

Items.localized_recurring_price Wiederkehrender Preis des Artikels in lokaler Währung.

Datentyp: Zeichenfolge

Artikel.Preis Preis des Artikels.

Datentyp: Zeichenfolge

Artikel.Menge Nummer des Artikels im Einkaufswagen.

Datentyp: Zeichenfolge

Items.recurring_frequency Wiederkehrende Häufigkeit des Elements.

Datentyp: Zeichenfolge

Items.recurring_price Wiederkehrender Preis des Artikels.

Datentyp: Zeichenfolge

Elements.Variablen Name-Wert-Paare, die dem Artikel im Einkaufswagen zugeordnet sind.

Datentyp: Objekt

parent_id Falls verfügbar, die sys_ID des übergeordneten Datensatzes, aus dem die Anforderung erstellt wird. Weitere Informationen finden Sie unter Konfigurieren Sie eine übergeordnete Zuordnung für eine Anforderung .

Datentyp: Zeichenfolge

parent_table Name der übergeordneten Tabelle (Groß-/Kleinschreibung beachten).

Datentyp: Zeichenfolge

Request_number Nummer des Anforderungsdatensatzes.

Datentyp: Zeichenfolge

request_id SYS_ID der Anforderung.

Datentyp: Zeichenfolge

zwischensumme_Preis Zwischensumme des Einkaufswagens.

Datentyp: Zeichenfolge

zwischensumme_Preis Zwischensumme des aktuellen Frequenzblocks.

Datentyp: Zeichenfolge

zwischensumme_recurring_frequency Zwischensumme der wiederkehrenden Häufigkeit des Einkaufswagens.

Datentyp: Zeichenfolge

zwischensumme_recurring_frequency Zwischensumme der wiederkehrenden Häufigkeit des aktuellen Frequenzblocks.

Datentyp: Zeichenfolge

zwischensumme_recurring_price Zwischensumme des wiederkehrenden Preises des Einkaufswagens.

Datentyp: Zeichenfolge

zwischensumme_recurring_price Zwischensumme des wiederkehrenden Preises des aktuellen Frequenzblocks

Datentyp: Zeichenfolge

Total_title Titel für Gesamtfeld auf Seite.

Datentyp: Zeichenfolge

Total_title Titel für Feld „Gesamtzahl“ im aktuellen Frequenzblock.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/checkout_guide" \
--request POST \
--header "Accept:application/json"  \
--header "Content-Type:application/json" \
--data "{\"items\":[{
  \"sys_id\":\"04b7e94b4f7b4200086eeed18110c7fd\",
  \"variables\":{
    \"acrobat\":\"true\",
    \"Additional_software_requirements\":\"MS Office 2007\"
  },
  \"sysparm_quantity\":\"3\"
},
{
  \"sys_id\":\"e1be6dcb4f7b4200086eeed18110c74c\"
},
{
  \"sys_id\":\"186d917a6fab7980575967ddbb3ee4f2\",
  \"variables\":{
    \"new_email\":\"abel.tuter@example.com\"
  }
},
{
  \"sys_id\":\"8b3ae7fedc1be1004ece5c08239e522b\"
},
{
  \"sys_id\":\"962967674ff38200086eeed18110c7e7\",
  \"variables\":{
    \"ergonomic_office\":\"Office chair should have lumbar support\"
  }
}]}" \
--user "username":"password"
<!--Case-1: if two-step is false:-->
{
  "result": {
    "cart_id": "0d8c7a32c3211200d68d3b0ac3d3aeba",
    "subtotal_price": "$3,350.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$300.00",
    "total_title": "Total",
    "monthly": {
      "subtotal_price": "$50.00",
      "subtotal_recurring_frequency": "Monthly",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "90af095bcd38798071a208d710d1b64f",
          "variables": {},
          "quantity": "1",
          "localized_price": "$50.00",
          "price": "$50.00",
          "recurring_frequency": "Monthly",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Belkin iPad Mini Case",
          "cart_item_id": "cb6e485fc3211200d68d3b0ac3d3ae35",
          "delivery_time": "2 Days"
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "none": {
      "subtotal_price": "-",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "186d917a6fab7980575967ddbb3ee4f2",
          "variables": {
            "Preferred Email address": "abel.tuter@example.com"
          },
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "New Email Account",
          "cart_item_id": "17c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "global.Workflow"
        },
        {
          "catalog_item_id": "8b3ae7fedc1be1004ece5c08239e522b",
          "variables": {},
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Corp VPN",
          "cart_item_id": "97c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "2 Days"
        },
        {
          "catalog_item_id": "e1be6dcb4f7b4200086eeed18110c74c",
          "variables": {},
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "External Monitor",
          "cart_item_id": "d3c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "2 Days"
        },
        {
          "catalog_item_id": "962967674ff38200086eeed18110c7e7",
          "variables": {
            "Please describe any ergonomic requirements\n\t\t": "Office chair should have lumbar support"
          },
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Desk Set Up",
          "cart_item_id": "d7c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "5 Days"
        }
      ],
      "show_subtotal_price": "false",
      "subtotal_title": "Subtotal"
    },
    "yearly": {
      "subtotal_price": "$3,300.00",
      "subtotal_recurring_frequency": "Annually",
      "subtotal_recurring_price": "$300.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
          "variables": {
            "Adobe Photoshop": "",
            "Adobe Acrobat": "true",
            "Optional Software": "",
            "Additional software requirements": "MS Office 2007"
          },
          "quantity": "3",
          "localized_price": "$1,100.00",
          "price": "$1,100.00",
          "recurring_frequency": "Annually",
          "localized_recurring_price": "$100.00",
          "recurring_price": "$100.00",
          "item_name": "Standard Laptop",
          "cart_item_id": "9fc5241fc3211200d68d3b0ac3d3ae7e",
          "delivery_time": "5 Days"
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Case-2: if two-step is true:
{
  "result": {
    "request_number": "REQ0010001",
    "request_id": "82a7e89fc3211200d68d3b0ac3d3ae0a"
  }
}

Servicekatalog – /sn_sc/servicecatalog/items/{item_sys_ID}/get_invalid_delegated_users VERÖFFENTLICHEN

Gibt eine Liste von Anwendern zurück, deren Anforderung für das angegebene Element nicht delegiert werden kann (von einem anderen Anwender angefordert).

Sie können diesen Endpunkt aufrufen, bevor Sie einen Endpunkt wie aufrufen Servicekatalog-API – /sn_sc/servicecatalog/items/{sys_ID}/add_to_cart VERÖFFENTLICHEN Oder Servicekatalog-API – /sn_sc/servicecatalog/items/{sys_ID}/order_now VERÖFFENTLICHEN Die die Anforderung eines Servicekatalogelements im Namen einer anderen Person ermöglichen. Diese Aufrufe schlagen fehl, wenn Sie einen Anwender übergeben, der nicht für das zugehörige Element autorisiert ist. Mit diesem Endpunkt können Sie Ihre Anwenderliste überprüfen, bevor Sie einen Endpunkt aufrufen, der das Element bestellt oder versucht, das Element einem Einkaufswagen hinzuzufügen.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/items/{item_sys_ID}/get_invalid_delegated_users

Standard-URL: /api/sn_sc/servicecatalog/items/{item_sys_ID}/get_invalid_delegated_users

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 110. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

item_sys_id SYS_ID des Servicekatalogelements, um zu überprüfen, ob der angegebene Anwender über Beschaffungsrechte verfügt.

Datentyp: Zeichenfolge

Tabelle: Servicekatalog [sc_catalog]

Tabelle : 111. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 112. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
sysparm_also_request_for Kommagetrennte Zeichenfolge gültiger Anwender-sys_IDs. Der Endpunkt überprüft, ob diese Anwender über Erwerbsrechte für das angegebene Servicekatalogelement verfügen.

Datentyp: Zeichenfolge

Tabelle: Anwender [sys_users]

Header

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

Tabelle : 113. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 114. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 115. Statuscodes
Statuscode Beschreibung
200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400 Anforderung fehlgeschlagen. Ungültige Anforderung für die Verarbeitung angegeben. Weitere Informationen zum Fehler finden Sie in der Meldung in den Rückgabeergebnissen.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
errCode Nummer, die dem Fehler zugeordnet ist. Wird nur zurückgegeben, wenn der Endpunkt fehlschlägt.

Datentyp: Zeichenfolge

Fehler Beschreibung des Fehlers, den der Endpunkt beim Fehlschlagen aufgefunden hat.
Ungültige Anwender Namen der Anwender, die das angegebene Katalogelement nicht anfordern können.

Datentyp: Array

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"sysparm_also_request_for\":\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\"}" \
--user "username":"password"
{
  "result": {
    "invalidUsers": [
      "Abel Tuter"
    ]
  }
}

cURL-Anforderung

curl "https://instance.servicenow.com /api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"sysparm_also_request_for\":\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\"}" \
--user "username":"password"
{
  "result": {
    "errCode": "42202",
    "errMsg": "This item cannot be submitted for multiple people as it is not configured with Requested For"
  }
}

Servicekatalog – /sn_sc/servicecatalog/items/{sys_ID}/order_now VERÖFFENTLICHEN

Bestellt das angegebene Katalogelement.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/items/{sys_ID}/order_now

Standard-URL: /api/sn_sc/servicecatalog/items/{sys_ID}/order_now

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 116. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

sys_id SYS_ID des Servicekatalogelements.

Datentyp: Zeichenfolge

Tabelle: Katalogelement [sc_Cat_item]

Tabelle : 117. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 118. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
sysparm_also_request_for Kommagetrennte Zeichenfolge von Anwender-sys_IDs anderer Anwender, für die das angegebene Element bestellt werden soll.
  • Sie können nicht mehr als 50 zusätzliche Anwender angeben, die das Element erhalten sollen.
  • Wenn eine Person in der Liste nicht für das Element qualifiziert ist, wird die gesamte Anforderung abgelehnt.
  • Wenn das zugeordnete Element nicht über verfügt requested_forVariablensatz, die Anforderung wird abgelehnt.
  • Wenn das zugeordnete Element über verfügt requested_forVariablensatz, aber Aktivieren Sie auch „Anforderung für“ Variable ist nicht konfiguriert, oder der aufrufende Anwender hat nicht die richtigen Rollen, die Anforderung wird abgelehnt.

Tabelle: Benutzer [sys_user]

Sysparm_quantity Erforderlich. Menge des Artikels. Darf keine negative Zahl sein.

Datentyp: Zahl

Sysparm_requested_for SYS_ID des Anwenders, für den der angegebene Artikel bestellt werden soll.
Die Einstellungen von glide.sc.req_for.rolesUnd glide.sc.req_for.roles.defaultEigenschaften bestimmen die Ebene, auf der ein Anwender Elemente anfordern kann.
  • Wenn ein Wert in angegeben ist glide.sc.req_for.rolesEigenschaft, überprüft das System, ob der Anwender über die angegebene Rolle verfügt, um Informationen anderer Anwender anzufordern.
  • Wenn glide.sc.req_for.rolesEigenschaftswert ist leer und glide.sc.req_for.roles.defaultEigenschaftswert ist Ablehnen , Kein Anwender kann Elemente für andere Anwender anfordern.
  • Wenn glide.sc.req_for.rolesEigenschaftswert ist leer und glide.sc.req_for.roles.defaultEigenschaftswert ist Zulassen , Jeder Anwender kann Elemente für andere Anwender anfordern.

Datentyp: Zeichenfolge

variables Name-Wert-Paare aller obligatorischen Einkaufswagenelementvariablen. Obligatorische Variablen sind im zugehörigen Formular definiert.

Datentyp: Zeichenfolge

Header

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

Tabelle : 119. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 120. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 121. Statuscodes
Statuscode Beschreibung
200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400 Gibt an, dass der Mengenwert ungültig ist und die Anforderung nicht gestellt wurde.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Nummer Nummer der generierten Anforderung.

Datentyp: Zeichenfolge

parent_id Falls verfügbar, die sys_ID des übergeordneten Datensatzes, aus dem die Anforderung erstellt wird. Weitere Informationen finden Sie unter Konfigurieren Sie eine übergeordnete Zuordnung für eine Anforderung .

Datentyp: Zeichenfolge

parent_table Falls verfügbar, der Name der übergeordneten Tabelle, aus der die Anforderung erstellt wird.

Datentyp: Zeichenfolge

request_id SYS_ID der Bestellanforderung.

Datentyp: Zeichenfolge

Request_number Anforderungsnummer.

Datentyp: Zeichenfolge

sys_id SYS_ID des Auftrags.

Datentyp: Zeichenfolge

Tabelle Tabellenname der Anforderung.

Datentyp: Zeichenfolge

Beispiel für Curl-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/d82ea08510247200964f77ffeec6c4ee/order_now" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  sysparm_quantity: 1,
  variables: {
    replacement: 'Yes',
    originalnumber: '1640000',
    data_plan: '500MB'
  }
}" \
--user "username":"password"
{
  "result": {
    "sys_id": "cf56a3fcdb3a2300e890f71fbf9619ac",
    "number": "REQ0010012",
    "request_number": "REQ0010012",
    "request_id": "cf56a3fcdb3a2300e890f71fbf9619ac",
    "table": "sc_request"
  }
}

Servicekatalog – /sn_sc/servicecatalog/items/{sys_ID}/submit_Producer VERÖFFENTLICHEN

Erstellt einen Datensatz und gibt zurück Tabelle Relativer API-Pfad und Umleitungs-URL für den Zugriff auf den erstellten Datensatz.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/items/{sys_ID}/submit_Producer

Standard-URL: /api/sn_sc/servicecatalog/items/{sys_ID}/submit_Producer

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 122. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

sys_id SYS_ID der Tabelle, in der der Datensatzersteller erstellt werden soll.

Datentyp: Zeichenfolge

Tabelle : 123. Abfrageparameter
Name Beschreibung
Sysparm_View UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die in der Antwort zurückgegebenen Felder.

Gültige Werte:

  • Desktop
  • Mobile
  • both

Wenn Sie auch angeben sysparm_fieldsParameter, hat Vorrang.

Datentyp: Zeichenfolge

Tabelle : 124. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
variables Name-Wert-Paare der Variablen des zu definierenden Erstellerdatensatzes.

Header

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

Tabelle : 125. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 126. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 127. Statuscodes
Statuscode Beschreibung
200 Gibt eine erfolgreiche Anforderung an und gibt das Antwortobjekt aus Tabellen-API und URL für den Zugriff auf den erstellten Datensatz zurück.
400 Anforderung wird aufgrund einer falschen Anforderungsnachricht nicht verarbeitet.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
404 Angeforderte Ressource wurde nicht gefunden.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Nummer Nummer des Tickets, das dem Datensatzersteller zugeordnet ist.

Datentyp: Zeichenfolge

parent_id Falls verfügbar, sys_ID des übergeordneten Datensatzes, aus dem die Anforderung erstellt wird. Weitere Informationen finden Sie unter Konfigurieren Sie eine übergeordnete Zuordnung für eine Anforderung .

Datentyp: Zeichenfolge

parent_table Name der übergeordneten Tabelle.

Datentyp: Zeichenfolge

record Relativer Pfad der Tabellen-API des neu erstellten Datensatzerstellers.

Datentyp: Zeichenfolge

Umleiten_Portal_url URL, zu der das Serviceportal umgeleitet werden soll.

Datentyp: Zeichenfolge

Umleiten_an Umleitungswert.

Datentyp: Zeichenfolge

Redirect_url Umleitungs-URL, um auf den erstellten Datensatzersteller zuzugreifen.

Datentyp: Zeichenfolge

sys_id SYS_ID des erstellten Datensatzes.

Datentyp: Zeichenfolge

Tabelle Name der Tabelle, für die die Anforderung gestellt wurde.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/3f1dd0320a0a0b99000a53f7604a2ef9/submit_producer" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'variables':{'urgency':'2','comments':'This is sample incident'}}" \
--user "username":"password"
{
  "result": {
    "sys_id": "6baf4e1ddbba2300e890f71fbf961963",
    "number": "INC0010006",
    "parent_id": null,
    "record": "api/now/table/incident/6baf4e1ddbba2300e890f71fbf961963",
    "redirect_portal_url": "",
    "parent_table": "task",
    "redirect_url": "incident.do?sys_id=6baf4e1ddbba2300e890f71fbf961963&sysparm_view=ess",
    "table": "incident",
    "redirect_to": ""
  }
}

Servicekatalog – NACH /sn/sc/servicecatalog/variables/{sys_ID}/Display_value

Gibt den Anzeigewert der angegebenen Variable zurück.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/variables/{sys_ID}/Display_value

Standard-URL: /api/sn_sc/servicecatalog/variables/{sys_ID}/Display_value

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 128. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

sys_id SYS_ID der Variable, für die der Anzeigewert zurückgegeben werden soll.

Datentyp: Zeichenfolge

Tabelle : 129. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 130. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Sysparm_value SYS_ID des Datensatzes, der den zurückzugebenden Anzeigewert enthält.

Datentyp: Zeichenfolge

Header

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

Tabelle : 131. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 132. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 133. Statuscodes
Statuscode Beschreibung
200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Ergebnis Anzeigewert der Variable.

Datentyp: Zeichenfolge

cURL-Anforderung


 curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/variables/2a3947a10a0a020e007f12648f8790c0/display_value" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"sysparm_value\":\"62826bf03710200044e0bfc8bcbe5df1\"}" \ 
--user "username":"password" 
{
  "result": "Abel Tuter (Architect)"
}

Servicekatalog – PUT /sn_sc/servicecatalog/cart/{cart_item_ID}

Aktualisiert das angegebene Element im Einkaufswagen des angemeldeten Anwenders.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/cart/{cart_item_ID}

Standard-URL: /api/sn_sc/servicecatalog/cart/{cart_item_ID}

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 134. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

Cart_item_ID SYS_ID des zu aktualisierenden Einkaufswagenelements.

Datentyp: Zeichenfolge

Tabelle : 135. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 136. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
Sysparm_quantity Erforderlich. Menge des Artikels zum Aktualisieren des Einkaufswagens.

Datentyp: Zeichenfolge

variables Erforderlich, wenn für das Element obligatorische Variablen angegeben sind. Objekt, das aus allen obligatorischen Variablennamen-Wert-Paaren besteht.

Datentyp: Objekt

Header

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

Tabelle : 137. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 138. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 139. Statuscodes
Statuscode Beschreibung
201 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde und dass der Artikel dem Einkaufswagen hinzugefügt wurde.
400 Die folgenden drei Fehler können auftreten:
  • Ungültiger Mengenwert: Gibt an, dass der Parameter „sysparm_quantity“ nicht angegeben ist oder einen ungültigen Wert enthält.
  • Sicherheitsbeschränkungen verhindern die Reihenfolge des Elements: Gibt an, dass entweder die in den Pfadparametern angegebene Element-ID ungültig ist oder der Anwender keinen Zugriff auf das Element hat.
  • Obligatorische Variablen sind erforderlich: Gibt an, dass mindestens einer der obligatorischen Variablenwerte in der Anforderung nicht angegeben ist.
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Einkaufswagen-ID SYS_ID des Einkaufswagens.

Datentyp: Zeichenfolge

<recurring_frequency> Beschreibt Artikel im Einkaufswagen mit einer bestimmten wiederkehrenden Häufigkeit.
Mögliche Werte sind:
  • täglich
  • monatlich
  • jährlich
  • Keine (keine wiederkehrenden Gebühren)

Datentyp: Objekt

"<recurring_frequency>": {
  "frequency_label": "String",
  "items": [Array],
  "show_subtotal_price": "String",
  "subtotal_price": "String",
  "subtotal_recurring_frequency": "String",
  "subtotal_recurring_price": "String",
  "subtotal_title": "String",
  "total_title": "String"
}
<recurring_frequency>.frequency_label Häufigkeit der zugehörigen wiederkehrenden Gebühr. Wenn für das Element keine wiederkehrenden Gebühren vorhanden sind, enthält dieser Parameter „null“.

Datentyp: Zeichenfolge

<recurring_frequency>.Elemente Liste von Objekten, die jedes Element beschreiben, das der angegebenen wiederkehrenden Häufigkeitskategorie zugeordnet ist.

Datentyp: Array

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created.by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_description": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
<recurring_frequency>.items.cart_item_id SYS_ID des Artikels in diesem Einkaufswagen.

Datentyp: Zeichenfolge

<recurring_frequency>.items.catalog_item_id Katalog-sys_ID des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.created.by Anwender, der den Artikel ursprünglich in den Einkaufswagen gelegt hat.

Datentyp: Zeichenfolge

<recurring_frequency>.items.created_on Datum, an dem der Artikel ursprünglich in den Einkaufswagen gelegt wurde.

Datentyp: Zeichenfolge

<recurring_frequency>.items.delivery_time Zeit, die für die Lieferung des angegebenen Artikels benötigt wird.

Datentyp: Zeichenfolge

<recurring_frequency>.items.item_id Element-sys_ID

Datentyp: Zeichenfolge

<recurring_frequency>.items.item_name Name des angegebenen Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.localized_price Preis des Artikels (in lokaler Währung).

Datentyp: Zeichenfolge

<recurring_frequency>.items.localized_recurring_price Wiederkehrende Gebühr für das angegebene Element (in lokaler Währung).

Datentyp: Zeichenfolge

<recurring_frequency>.items.name Elementname.

Datentyp: Zeichenfolge

<recurring_frequency>.items.order_Guide Name des Bestellleitfadens, dem dieser Artikel zugeordnet ist. Wenn dieses Element keinem Bestellleitfaden zugeordnet ist, enthält dieser Parameter eine leere Zeichenfolge.

Datentyp: Zeichenfolge

<recurring_frequency>.Elemente.Bild Dateiname des Bilds des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.Artikel.Preis Preis des Artikels.

Datentyp: Zeichenfolge

<recurring_frequency>.Artikel.Menge Nummer des angegebenen Artikels im Einkaufswagen.

Datentyp: Zeichenfolge

<recurring_frequency>.items.recurring_frequency Wie oft die wiederkehrende Gebühr für den angegebenen Artikel in Rechnung gestellt wird.

Datentyp: Zeichenfolge

Standard: Null

<recurring_frequency>.items.recurring_price Wiederkehrende Gebühr für das angegebene Element.

Datentyp: Zeichenfolge

<recurring_frequency>.items.recurring_subtotal Zwischensumme der wiederkehrenden Gebühren für den Artikel ( recurring_priceX quantity).

Datentyp: Zahl

<recurring_frequency>.items.recurring_subtotal_price Zwischensumme der wiederkehrenden Gebühren für den Artikel.

Datentyp: Zeichenfolge

<recurring_frequency>.items.short_description Kurzbeschreibung des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.Show_price Kennzeichnung, die angibt, ob der Preis des Artikels im Einkaufswagen angezeigt wird.
Mögliche Werte:
  • Wahr: Zeigen Sie den Preis des Artikels im Einkaufswagen an.
  • Falsch: Preis des Artikels im Einkaufswagen nicht anzeigen.

Datentyp: Boolesch

<recurring_frequency>.items.Show.quantity Kennzeichnung, die angibt, ob die Artikelmenge im Einkaufswagen angezeigt werden soll.
Mögliche Werte:
  • Wahr: Zeigt die Artikelmenge im Einkaufswagen an.
  • Falsch: Die Artikelmenge im Einkaufswagen nicht anzeigen.

Datentyp: Boolesch

<recurring_frequency>.items.Show_recurring_price Kennzeichnung, die angibt, ob die wiederkehrenden Gebühren im Einkaufswagen angezeigt werden sollen.
Mögliche Werte:
  • Wahr: Zeigen Sie die wiederkehrenden Gebühren im Einkaufswagen an.
  • Falsch: Wiederkehrende Gebühren nicht im Einkaufswagen anzeigen.

Datentyp: Boolesch

<recurring_frequency>.Elemente.Zwischensumme Zwischensumme der Anzahl der Elemente.

Datentyp: Zahl

<recurring_frequency>.items.subtotal_price Zwischensumme für das Element ( priceX quantity).

Datentyp: Zeichenfolge

<recurring_frequency>.items.sys_class_Name Systemklassifizierungsname des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.sys_ID SYS_ID des Elements.

Datentyp: Zeichenfolge

<recurring_frequency>.items.updated_by Anwender, der den Artikel aktualisiert hat, nachdem er ursprünglich in den Einkaufswagen gelegt wurde.

Datentyp: Zeichenfolge

<recurring_frequency>.items.updated_on Letztes Datum/letzte Uhrzeit, zu der der Artikel entweder anfänglich in den Einkaufswagen gelegt oder aktualisiert wurde.

Datentyp: Zeichenfolge

<recurring_frequency>.items.variables Name-Wert-Paare der Elementvariablen.

Datentyp: Objekt

<recurring_frequency>.Show_subtotal_price Kennzeichnung, die angibt, ob eine Zwischensumme für die zugehörige wiederkehrende Gebührenkategorie angezeigt werden soll.

Datentyp: Zeichenfolge

<recurring_frequency>.subtotal_price Zwischensumme der Kosten aller Elemente für die zugehörige wiederkehrende Häufigkeitskategorie.

Datentyp: Zeichenfolge

<recurring_frequency>.subtotal_recurring_frequency Typ der wiederkehrenden Zwischensumme, z. B. täglich, monatlich usw.

Datentyp: Zeichenfolge

<recurring_frequency>.subtotal_recurring_price Zwischensumme der wiederkehrenden Gebühren der Elemente innerhalb der zugehörigen Kategorie „wiederkehrende Häufigkeit“.

Datentyp: Zeichenfolge

<recurring_frequency>.subtotal_title Wenn show_subtotal_priceIst auf festgelegt Wahr , Der Text, der im Einkaufswagen für den zugehörigen Untertitel angezeigt werden soll.

Datentyp: Zeichenfolge

<recurring_frequency>.total_title Text, der für den Gesamttitel der zugehörigen wiederkehrenden Häufigkeitskategorie angezeigt werden soll.

Datentyp: Zeichenfolge

Show_subtotal_price Kennzeichnung, die angibt, ob der Zwischensummenpreis im Einkaufswagen angezeigt werden soll.
Mögliche Werte:
  • Wahr: Zwischensummen im Einkaufswagen anzeigen.
  • Falsch: Keine Zwischensummen im Einkaufswagen anzeigen.

Datentyp: Zeichenfolge

zwischensumme_Preis Zwischensumme aller Artikel im Einkaufswagen.

Datentyp: Zeichenfolge

zwischensumme_recurring_frequency Typ der wiederkehrenden Zwischensumme, z. B. täglich, monatlich usw. Identisch mit <recurring_frequency>.subtotal_recurring_frequency.

Datentyp: Zeichenfolge

zwischensumme_recurring_price Zwischensumme der wiederkehrenden Häufigkeitsgebühren für alle Artikel im Einkaufswagen.

Datentyp: Zeichenfolge

zwischensumme_title Text, der im Einkaufswagen für den Feldtitel der Zwischensumme angezeigt werden soll.

Datentyp: Zeichenfolge

Total_title Text, der im Einkaufswagen für den Gesamtfeldtitel angezeigt werden soll.

Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/7d138fa21329e300027879d96144b065" \
--request PUT \
--header "Accept:application/json" \
--data "{\"sysparm_quantity\": \"2\" }" \
--user "username":"password"
{
  "result": {
    "cart_id": "0830db8413a56300397533e2e144b0ba",
    "subtotal_price": "$2,397.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "none": {
      "subtotal_price": "$2,397.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
        {
          "updated_on": "2018-11-06 17:01:21",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "a846872a1369e300027879d96144b07e",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "a846872a1369e300027879d96144b07e",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 17:01:21",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        },
        {
          "updated_on": "2018-11-06 17:21:08",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "7d138fa21329e300027879d96144b065",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$1,598.00",
          "variables": {},
          "quantity": "2",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "7d138fa21329e300027879d96144b065",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 16:47:30",
          "localized_price": "$799.00",
          "subtotal": 1598,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Servicekatalog – PUT /sn_sc/servicecatalog/items/{sys_ID}/submit_Guide

Ruft eine Liste von Elementen basierend auf den für einen Bestellleitfaden beschriebenen Anforderungen ab.

URL-Format

Versionierte URL: /api/sn_sc/{api_Version}/servicecatalog/items/{sys_ID}/submit_Guide

Standard-URL: /api/sn_sc/servicecatalog/items/{sys_ID}/submit_Guide

Hinweis:
Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 140. Pfad-Parameter
Name Beschreibung
api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

Datentyp: Zeichenfolge

sys_id SYS_ID des Bestellleitfadens, dessen Artikel abgerufen werden sollen.

Datentyp: Zeichenfolge

Tabelle: Bestellleitfaden [sc_cat_item_guide]

Tabelle : 141. Abfrageparameter
Name Beschreibung
Keine
Tabelle : 142. Anforderungstextparameter (XML oder JSON)
Name Beschreibung
variables Für ein Element angeforderte Variablen. Jede Variable ist ein JSON-Objekt, das aus Name-Wert-Paaren besteht.

Datentyp: Array

Header

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

Tabelle : 143. Anforderungskopfzeilen.
Header Beschreibung
Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

Standard: application/json

Tabelle : 144. Antwortkopfzeilen
Header Beschreibung
Keine

Statuscodes

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

Tabelle : 145. Statuscodes
Statuscode Beschreibung
200 Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde. Gibt eine Liste von Elementen basierend auf der übergebenen Variablenliste zurück. Wenn der Ergebnissatz keine Elemente enthält, wird ein leeres Array zurückgegeben.
400 Gibt an, dass die Anforderung ungültig ist. Dies kann aus einem der folgenden Gründe liegen:
  • Anwender hat keinen Zugriff auf das Element.
  • Obligatorische Variablen eines oder mehrerer Elemente wurden nicht beantwortet. (Nur als obligatorisch definierte Variablen werden berücksichtigt.)
401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
500 Interner Fehler beim Berechnen von Elementen abhängig von den ausgewählten Optionen.

Antworttext-Parameter (JSON oder XML)

Name Beschreibung
Kataloge Liste der Objekte, zu denen das Element gehört, sowie jeder Katalogtitel und jede sys_ID des Katalogs.

Datentyp: Array von Objekten

"catalogs": [
  {
    "sys_id": "String",
    "title": "String"  
  }
]
Catalogs.sys_ID SYS_ID des Katalogs.

Datentyp: Zeichenfolge

Kataloge.Titel Katalogtitel.

Datentyp: Zeichenfolge

Kategorie Kategorie, die dieses Element enthält.

Datentyp: Objekt

"catalogs": {
  "sys_id": "String",
  "title": "String"
}
Kategorie.sys_ID SYS_ID der Kategorie.

Datentyp: Zeichenfolge

Kategorie.Titel Kategorietitel

Datentyp: Zeichenfolge

Client_script Liste aller Katalog-Client-Skripts, die für das Katalogelement definiert sind.

Datentyp: Objekt

"client_script": {
  "onChange": [Array],
  "onLoad": [Array],
  "onSubmit": [Array]
}
Client_script.onChange Liste der onChange-Client-Skripts, die dem Element zugeordnet sind.

Datentyp: Array

Client_script.onLoad Liste der onLoad-Client-Skripts, die dem Element zugeordnet sind.

Datentyp: Array

Client_script.onSubmit Liste der Client-Skripts, die dem Element zugeordnet sind, onSubmit.

Datentyp: Array

Data_Lookup Datensuchen, die für das Katalogelement definiert sind.

Datentyp: Array

Beschreibung Vollständige Beschreibung des Katalogelements.

Datentyp: Zeichenfolge

icon Pfad des Bildes, das als Symbol neben dem Katalogelement angezeigt wird.

Datentyp: Zeichenfolge

Name Name des Katalogelements.

Datentyp: Zeichenfolge

short_description Text auf der Servicekatalog-Homepage oder der Suchergebnisseite oder der Titel auf dem Bestellformular des Katalogelements.

Datentyp: Zeichenfolge

Show_price Kennzeichnung, die angibt, ob die Preisdetails angezeigt werden sollen. Bei „wahr“ werden die folgenden Details zurückgegeben.
  • Local_currency
  • Localized_price
  • Localized_recurring_price
  • Preis
  • Price_currency
  • recurring_frequency
  • recurring_price
  • Recurring_price_currency

Datentyp: Boolesch

sys_id SYS_ID des Katalogelements.

Datentyp: Zeichenfolge

Typ Elementtyp.
Mögliche Werte:
  • Katalogelement
  • Bestellleitfaden
  • Datensatzersteller-Element

Datentyp: Zeichenfolge

variables Name-Wert-Paare aller Variablen, die dem Katalogelement zugeordnet sind.

Datentyp: Array

ui_Policy Liste aller Katalog-UI-Richtlinien, die für das Katalogelement definiert sind.

Datentyp: Array

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/submit_guide" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"variables\":{
    \"hiring_manager\":\"6816f79cc0a8016401c5a33be04be441\",
    \"hiring_group\":\"221f3db5c6112284009f4becd3039cc9\",
    \"remote\":\"No\",
    \"standard_package\":\"No\",
    \"laptop_type\":\"developer\"
  }
}" \
--user "username":"password"
{
  "result": [
    {
      "short_description": "Lenovo - Carbon x1",
      "icon": "1195c2084f889200086eeed18110c74a.iix",
      "description": "<p class=\"p1\"><font size=\"3\" color=\"#808080\"><span class=\"s1\">x1 Carbon</span></font></p>\n<p class=\"p1\"><font size=\"2\" color=\"#808080\" face=\"arial,helvetica,sans-serif\"><span class=\"s1\">The x1 Carbon is Lenovo's lightest ThinkPad yet. It provides a QHD display that fights glare and weighs less than three pounds. Ideal for most computing tasks, and highly mobile. </span></font></p>\n<p class=\"p2\"><font size=\"2\" color=\"#808080\" face=\"arial,helvetica,sans-serif\"><span class=\"s1\">Technical Specs:</span></font></p>\n<ul class=\"ul1\"><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">Intel core i5 processor</span></font></li><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">512GB solid state drive (SSD) </span></font></li><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">Backlit keyboard</span></font></li></ul>",
      "show_price": true,
      "recurring_price": "$100.00",
      "type": "catalog_item",
      "local_currency": "USD",
      "sys_id": "04b7e94b4f7b4200086eeed18110c7fd",
      "recurring_price_currency": "USD",
      "localized_price": "$1,100.00",
      "price": "$1,100.00",
      "catalogs": [
       {
         "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
         "title": "Service Catalog"
       }
      ],
      "recurring_frequency": "Annually",
      "name": "Standard Laptop",
      "localized_recurring_price": "$100.00",
      "category": {
        "sys_id": "d258b953c611227a0146101fb1be7c31",
        "title": "Hardware"
      },
      "price_currency": "USD",
      "show_quantity": false,
      "quantity": "1",
      "order": "100",
      "variables": [
        {
          "label": "Optional Software",
          "type": 0,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "container_start",
          "render_label": true,
          "read_only": false,
          "children": [
            {
              "label": "Adobe Acrobat",
              "type": 7,
              "mandatory": false,
              "displayvalue": "false",
              "friendly_type": "check_box",
              "display_type": "CheckBox",
              "render_label": true,
              "read_only": false,
              "pricing_implications": false,
              "name": "acrobat",
              "attributes": "edge_encryption_enabled=true",
              "id": "90b72d4b4f7b4200086eeed18110c701",
              "value": false,
              "help_text": "",
              "max_length": 0
            },
            {
              "label": "Adobe Photoshop",
              "type": 7,
              "mandatory": false,
              "displayvalue": "false",
              "friendly_type": "check_box",
              "display_type": "CheckBox",
              "render_label": true,
              "read_only": false,
              "pricing_implications": false,
              "name": "photoshop",
              "attributes": "edge_encryption_enabled=true",
              "id": "a8b72d4b4f7b4200086eeed18110c701",
              "value": false,
              "help_text": "",
              "max_length": 0
            }
          ],
          "name": "optional_label",
          "attributes": "edge_encryption_enabled=true",
          "id": "10b72d4b4f7b4200086eeed18110c700",
          "value": "",
          "help_text": "",
          "max_length": 0
        },
        {
          "label": "Additional software requirements",
          "type": 2,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "multi_line_text",
          "display_type": "Multi Line Text",
          "render_label": true,
          "read_only": false,
          "name": "Additional_software_requirements",
          "attributes": "edge_encryption_enabled=true",
          "id": "a8b72d4b4f7b4200086eeed18110c702",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "e1be6dcb4f7b4200086eeed18110c74c",
      "short_description": "LG IPS 27\" Monitor",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "External Monitor",
      "icon": "08569a4c4f889200086eeed18110c77b.iix",
      "description": "<p><font size=\"2\"><span style=\"color: #485563;\"><br /> <font size=\"3\" color=\"#808080\">The striking design of the LG Cinema Screen incorporates an ultra-narrow bezel, so virtually all you see is picture. The viewing experience is more immersive for your favorite movies and games. Make the most of your time, with an LG Full HD LED monitor. </font></span></font></p>\n<p><font size=\"2\" color=\"#808080\">Item Specs:</font></p>\n<ul><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Screen Size: 27"</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Resolution: 1920 x 1080</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Aspect Ratio: 16:9</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Brightness: 250 cd/m2</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Supports Split Screen</font></li></ul>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "2c0b59874f7b4200086eeed18110c71f",
        "title": "Peripherals"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "200",
      "variables": [],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "186d917a6fab7980575967ddbb3ee4f2",
      "short_description": "New Email Creation",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "New Email Account",
      "icon": "b630e97e6fab7980575967ddbb3ee4d2.iix",
      "description": "<p style=\"font-size: 13px;\"><font size=\"4\"><span style=\"color: #485563;\">Service Overview:</span></font></p>\n\t<p style=\"font-size: 13px;\"><font size=\"3\">Creation of a new email account within our Microsoft Exchange environment.  Creation of your email address will also create your Active Directory account. </font></p>\n\t<p> </p>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "109f0438c6112276003ae8ac13e7009d",
        "title": "Services"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "300",
      "variables": [
        {
          "label": "Preferred Email address",
          "type": 6,
          "mandatory": true,
          "displayvalue": "",
          "friendly_type": "single_line_text",
          "display_type": "Single Line Text",
          "render_label": true,
          "read_only": false,
          "name": "new_email",
          "attributes": "edge_encryption_enabled=true",
          "id": "65865e474fbb4200086eeed18110c7dd",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "8b3ae7fedc1be1004ece5c08239e522b",
      "short_description": "Remote access to Internal Corporate Systems\n\t\t",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Corp VPN",
      "icon": "11dc8df74f778200086eeed18110c78e.iix",
      "description": "<p><font size=\"3\"><span style=\"color: #485563;\">Corp VPN Account</span></font></p>\n<ul><li style=\"color: #485563;\"><font size=\"2\">Corp VPN provides VPN (Virtual Private Network) access to all Internal Corporate Systems and to IP Restricted Customer Instances</font></li><li style=\"color: #485563;\"><font size=\"2\">By utilizing Corp VPN, users will be provided a similar experience to being within one of the Corporate office locations, while offsite</font></li></ul>\n<p><font size=\"2\"><span style=\"color: #485563;\"> </span></font></p>\n<p><font size=\"2\"><span style=\"color: #485563;\">Please reference the <span style=\"color: #485563;\">CORP VPN </span><span style=\"color: #485563;\">Installation</span><span style=\"color: #485563;\"> and Support Documentation</span> for instructions on installation, usage and FAQ’s. For all other questions, please contact <span style=\"color: #485563;\">IT Support.</span></span></font></p>\n<p> </p>\n<p><span style=\"font-size: 10pt; font-family: tahoma, arial, helvetica, sans-serif;\"><br /><br /></span></p>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "d2f7cae4c611227a018ddc481b34e099",
        "title": "Security and Access"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "600",
      "variables": [],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "962967674ff38200086eeed18110c7e7",
      "short_description": "Desk Set Up for New Hires or Employee Moves\n\t\t",
      "catalogs": [
        {
          "sys_id": "",
          "title": "Service Catalog"
        }
      ],
      "name": "Desk Set Up",
      "icon": "aa6b08ff4ff38200086eeed18110c7ed.iix",
      "description": "<p><font size=\"3\" face=\"arial, helvetica, sans-serif\">The facilities organization will set up your new desk with the following configuration:</font></p>\n<ul><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Docking Station</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Power Station</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Phone</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Office Chair</font></li></ul>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "",
        "title": null
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "900",
      "variables": [
        {
          "label": "Please describe any ergonomic requirements\n\t\t",
          "type": 2,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "multi_line_text",
          "display_type": "Multi Line Text",
          "render_label": true,
          "read_only": false,
          "name": "ergonomic_office",
          "attributes": "edge_encryption_enabled=true",
          "id": "b0b9ab674ff38200086eeed18110c755",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    }
  ]
}