Service Catalog API
Die Service Catalog- API bietet Endpunkte, die über ein Service Portal auf die Service Catalog-Konfiguration und -Aktionen zugreifen.
Servicekatalog – DELETE /sn_sc/servicecatalog/cart/{cart_item_id}
Löscht den angegebenen Artikel 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Artikels, der aus dem aktuellen Einkaufswagen gelöscht werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 204 | Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde und der angegebene Artikel aus dem Einkaufswagen gelöscht wurde. |
| 400 | Gibt an, dass entweder der angegebene cart_item_id ungültig ist oder der Benutzer keinen Zugriff auf den Artikel im Einkaufswagen hat. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (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 – DELETE /sn_sc/servicecatalog/cart/{sys_id}/empty
Löscht einen angegebenen Einkaufswagen und den Inhalt des Einkaufswagen.
Was ein Benutzer löschen kann (Artikel und/oder Einkaufswagen) hängt von der Rolle ab, mit der sich der Benutzer authentifiziert.
- admin/catalog_admin: Kann jeden Benutzer-Einkaufswagen leeren.
- Administrator: Kann den Einkaufswagen löschen, nachdem der gesamte Inhalt des Einkaufswagens gelöscht wurde.
- catalog_admin: Kann alle Artikel im Einkaufswagen löschen.
URL-Format
Versionierte URL: /api/sn_sc/{api_version}/servicecatalog/cart/{sys_id}/empty
Standard-URL: /api/sn_sc/servicecatalog/cart/{sys_id}/empty
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 zu leerenden und zu löschenden Einkaufswagens. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 204 | Die Anforderung wurde erfolgreich abgeschlossen. Der Einkaufswagen wird geleert und gelöscht. |
| 400 | Zeigt einen Fehler aus einem der folgenden Gründe an:
|
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (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 Benutzers ab.
URL-Format
Versionierte URL: /api/sn_sc/{api_version}/servicecatalog/cart
Standard-URL: /api/sn_sc/servicecatalog/cart
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde. Wenn sich kein Artikel im Einkaufswagen befindet, werden grundlegende Einkaufswagen-Informationen und Preise für den Benutzer zurückgegeben. Wenn der Einkaufswagen Artikel enthält, werden auch die Informationen zu den Artikeln und deren individuelle Preisgestaltung berücksichtigt. |
| 400 | Zeigt an, dass der Einkaufswagen leer ist und nicht ausgecheckt werden kann. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Parameter | Beschreibung |
|---|---|
| cart_id | Sys_id des Einkaufswagens. Datentyp: Zeichenfolge |
| <recurring_frequency> | Liste der Artikel im Einkaufswagen mit einer bestimmten wiederkehrenden Häufigkeit. Mögliche Werte umfassen:
Datentyp: Objekt |
| <recurring_frequency>.frequency_label | Häufigkeit der zugehörigen wiederkehrenden Gebühr. Datentyp: Zeichenfolge Standard: Null |
| <recurring_frequency>.items | Liste der Objekte, die Details zu jedem Element enthalten, das der angegebenen wiederkehrenden Häufigkeitskategorie zugeordnet ist. Datentyp: Array |
| <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 | Benutzer, 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 es dauert, bis der angegebene Artikel geliefert wird. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.item_id | Katalog-sys_id des Elements. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.item_name | Name des angegebenen Artikels. 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 der lokalen Währung. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.name | Artikelname. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.order_guide | Name des Bestellleitfadens, dem dieser Artikel zugeordnet ist. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.picture | Dateiname des Bildes des Artikels. 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 den angegebenen Artikel. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.recurring_subtotal | Zwischensumme der wiederkehrenden Gebühren für den Artikel (recurring_price x 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 Artikels. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.show_price | Kennzeichnung, die angibt, ob der Preis des Artikels im Einkaufswagen angezeigt wird. Mögliche Werte:
Datentyp: Boolesch |
| <recurring_frequency>.items.show_quantity | Kennzeichnung, die angibt, ob die Artikelmenge im Einkaufswagen angezeigt werden soll. Mögliche Werte:
Datentyp: Boolesch |
| <recurring_frequency>.items.show_recurring_price | Kennzeichnung, die angibt, ob die wiederkehrenden Gebühren im Einkaufswagen angezeigt werden sollten. Mögliche Werte:
Datentyp: Boolesch |
| <recurring_frequency>.Elemente.Zwischensumme | Zwischensumme der Anzahl der Artikel. Datentyp: Zahl |
| <recurring_frequency>.items.subtotal_price | Zwischensumme für das Element (price x quantity). Datentyp: Zeichenfolge |
| <recurring_frequency>.items.sys_class_name | Systemklassifizierungsname des Artikels. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.sys_id | Sys_id des Elementdatensatzes. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.updated_by | Benutzer, 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 dem/der der Artikel entweder ursprünglich in den Einkaufswagen gelegt wurde 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:
Datentyp: Boolesch |
| <recurring_frequency>.Zwischensumme_Preis | Zwischensumme der Kosten aller Artikel für die zugehörige wiederkehrende Häufigkeitskategorie. Datentyp: Zeichenfolge |
| <recurring_frequency>.subtotal_recurring_frequency | Art der Zwischensumme der wiederkehrenden Häufigkeit, wie täglich, monatlich usw. Identisch mit subtotal_recurring_frequency. Datentyp: Zeichenfolge |
| <recurring_frequency>.subtotal_recurring_price | Zwischensumme der wiederkehrenden Gebühren der Artikel innerhalb der zugehörigen Kategorie der wiederkehrenden Häufigkeit. Datentyp: Zeichenfolge |
| <recurring_frequency>.subtotal_title | Wenn show_subtotal_price auf truefestgelegt ist, der Text, der im Einkaufswagen für den zugehörigen Untertitel angezeigt werden soll.Datentyp: Zeichenfolge |
| <recurring_frequency>.total_title | Anzuzeigender Text für den Gesamttitel der zugehörigen Kategorie der wiederkehrenden Häufigkeit. Datentyp: Zeichenfolge |
| show_subtotal_price | Kennzeichnung, die angibt, ob der Zwischensummenpreis im Einkaufswagen angezeigt werden soll. Mögliche Werte:
Datentyp: Zeichenfolge |
| subtotal_price | Zwischensumme aller Artikel im Einkaufswagen in ganzen Dollar. Datentyp: Zeichenfolge |
| subtotal_recurring_frequency | Art der Zwischensumme der wiederkehrenden Häufigkeit, wie täglich, monatlich usw. Identisch mit <recurring_frequency>.subtotal_recurring_frequency. Datentyp: Zeichenfolge |
| subtotal_recurring_price | Zwischensumme der Gebühren der wiederkehrenden Häufigkeit für alle Artikel im Einkaufswagen. Datentyp: Zeichenfolge |
| subtotal_title | Text, der im Einkaufswagen für den Zwischensummenfeldtitel angezeigt werden soll. Datentyp: Zeichenfolge |
| total_title | Text, der im Einkaufswagen für den Summenfeldtitel 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"
}
}
Service Catalog – GET /sn_sc/servicecatalog/cart/delivery_address/{user_id}
Ruft die Versandadresse des angegebenen Benutzers basierend auf der Eigenschaft glide.sc.req_for.roles und dem im glide.sc.req_for.roles.defaultpropertykonfigurierten Standardverhalten ab.
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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Benutzers, dessen Versandadresse abgerufen werden soll. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen; gibt die Versandadresse des angegebenen Benutzers zurück. |
| 400 | Benutzer-sys_id ist ungültig. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Adresse des angegebenen Benutzers. 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/catalogs
Ruft eine Liste von Katalogen ab, auf die der Benutzer basierend auf den übergebenen Parametern Zugriff hat.
URL-Format
Versionierte URL: /api/sn_sc/{api_version}/servicecatalog/catalogs
Standard-URL: /api/sn_sc/servicecatalog/catalogs
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| sysparm_limit | Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden. Hinweis: Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen. Datentyp: Zahl Standard: 10.000 |
| sysparm_text | Schlagwort, nach dem im Feld „Titel“ der verfügbaren Servicekataloge gesucht werden soll. Datentyp: Zeichenfolge |
| sysparm_view | Gerät, auf dem der Artikel angezeigt werden kann:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde. Wenn eine gültige Abfrage keine Ergebnisse zurückgibt, enthält der Antwort-Haupttext nur ein leeres Ergebnis-Array. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Beschreibung | Beschreibung des Katalogs. Datentyp: Zeichenfolge |
| desktop_image | Bild, das für diesen Katalog auf dem Desktop angezeigt wird. Datentyp: Zeichenfolge |
| has_categories | Kennzeichnung, die angibt, ob der Katalog Kategorien enthält. Mögliche Werte:
Datentyp: Boolesch |
| has_items | Kennzeichnung, die angibt, ob der Katalog Artikel enthält. Mögliche Werte:
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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 |
| Name | Beschreibung |
|---|---|
| sysparm_limit | Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden. Hinweis: Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen. Datentyp: Zahl Standard: 10.000 |
| sysparm_offset | Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie Datentyp: Zahl Standard: 0 |
| sysparm_top_level_only | Gibt nur die Kategorien zurück, deren übergeordnetes Element ein Katalog ist. Gültige Werte:
Datentyp: Boolesch |
| sysparm_view | UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die Felder, die in der Antwort zurückgegeben werden. Gültige Werte:
Wenn Sie auch den Parameter sysparm_fields angeben, hat dieser Vorrang. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Gibt eine Liste von Kategorien in einem Katalog zurück. Wenn es keine Abfrageergebnisse gibt, wird ein leeres Array zurückgegeben. |
| 400 | Gibt an, dass die Anforderung oder Katalog-sys_id ungültig ist. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| count | Anzahl der Artikel innerhalb der Kategorie. Datentyp: Zahl |
| Beschreibung | Kurze Beschreibung der Kategorie. Datentyp: Zeichenfolge |
| vollständige _description | Detaillierte Beschreibung der Kategorie. Datentyp: Zeichenfolge |
| header_icon | Symbol, das in Kategoriekopfzeilen verwendet wird. Datentyp: Zeichenfolge |
| homepage_image | Bild, das für diese Kategorie auf der Startseite der Kategorie angezeigt wird. Datentyp: Zeichenfolge |
| icon | Symbol für die Bezeichnung dieser Kategorie. Datentyp: Zeichenfolge |
| Unterkategorien | Liste der Unterkategorien innerhalb der Kategorie. Datentyp: Array |
| subcategories.sys_id | Sys_id der Unterkategorie. Datentyp: Zeichenfolge |
| Unterkategorien.Titel | Titel der Unterkategorie. Datentyp: Zeichenfolge |
| sys_id | Sys_id der Kategorie. Datentyp: Zeichenfolge |
| Titel | Kategorietitel. 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"
}
]
}
Service Catalog – 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 |
| Name | Beschreibung |
|---|---|
| sysparm_view | Gerät, auf dem der Artikel angezeigt werden kann:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde, und gibt die verfügbaren Informationen des angegebenen Katalogs zurück. |
| 400 | Gibt an, dass die Anforderung aus einem der folgenden Gründe ungültig ist:
|
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| categories | Liste der Objekte, die Kategorien im Katalog beschreiben. Datentyp: Array |
| Kategorien.Beschreibung | Beschreibung der Kategorie. Datentyp: Zeichenfolge |
| kategorien.header_image | Kategorien-Kopfzeilen-Bild. Datentyp: Zeichenfolge |
| kategorien.sys_id | Eindeutiger Kategorien-Identifier (sys_id). Datentyp: Zeichenfolge |
| Kategorien.Titel | Kategorietitel. Datentyp: Zeichenfolge |
| Beschreibung | Katalogbeschreibung. Datentyp: Zeichenfolge |
| desktop_image | Quelle des Bildes, das mit dem Katalog in der Desktopansicht angezeigt wird. Datentyp: Zeichenfolge |
| has_categories | Kennzeichnung, die angibt, ob der Katalog Kategorien enthält. Mögliche Werte:
Datentyp: Boolesch |
| has_items | Kennzeichnung, die angibt, ob Artikel in der Kategorie vorhanden sind. Mögliche Werte:
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": ""
}
}
Service Catalog – 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 |
| Name | Beschreibung |
|---|---|
| sysparm_view | UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die Felder, die in der Antwort zurückgegeben werden. Gültige Werte:
Wenn Sie auch den Parameter sysparm_fields angeben, hat dieser Vorrang. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Gibt an, dass die Anforderung aus einem der folgenden Gründe ungültig ist:
|
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| child_categories | Liste der Objekte, die die untergeordneten Kategorien beschreiben, die zu dieser Kategorie gehören. Datentyp: Array |
| child_categories.count | Anzahl der Elemente in der untergeordneten Kategorie. Datentyp: Zahl |
| child_categories.isParentCategory | Kennzeichnung, die angibt, ob es sich um eine übergeordnete Kategorie handelt. Mögliche Werte:
Datentyp: Boolesch |
| child_categories.parent | Sys_id des übergeordneten Elements der untergeordneten Kategorie. Datentyp: Zeichenfolge |
| child_categories.subcategories | Liste der Objekte, die die Unterkategorien für diese untergeordnete Kategorie beschreiben. Datentyp: Array |
| child_categories.subcategories.sys_id | Sys_id der untergeordneten Unterkategorie. Datentyp: Zeichenfolge |
| child_categories.subcategories.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 | Kurze Beschreibung der Kategorie. Datentyp: Zeichenfolge |
| full_description | Detaillierte Beschreibung der Kategorie. Datentyp: Zeichenfolge |
| header_icon | Die Quelle des neben der Kategoriekopfzeile angezeigten Symbols, wenn die Kategorie als oberste Kategorie aufgelistet wird. Datentyp: Zeichenfolge |
| homepage_image | Quelle des Startseitenbilds für die Kategorie. Datentyp: Zeichenfolge |
| icon | Die Quelle des neben dem Kategorienamen angezeigten kleinen Symbols, wenn die Kategorie als Unterkategorie aufgelistet wird. Datentyp: Zeichenfolge |
| sys_id | Sys_id der Kategorie. Datentyp: Zeichenfolge |
| Titel | Kategorietitel. 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| 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 der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden. Hinweis: Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen. Datentyp: Zahl Standard: 10.000 |
| sysparm_offset | Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie Datentyp: Zahl Standard: 0 |
| sysparm_text | Bestimmter Text, nach dem in den Kategorieelementen gesucht werden soll. Zum Beispiel sysparm_text=„iPhone“ oder sysparm_text=„Mobilgeräte“.Datentyp: Zeichenfolge |
| sysparm_type | Art des Elements. Gültige Suchwerte:
Datentyp: Zeichenfolge |
| sysparm_view | UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die Felder, die in der Antwort zurückgegeben werden. Gültige Werte:
Wenn Sie auch den Parameter sysparm_fields angeben, hat dieser Vorrang. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Gibt eine Liste von Katalogen und Elementen basierend auf den angegebenen Parametern zurück. Wenn eine gültige Abfrage keine Ergebnisse zurückgibt, enthält der Antwort-Haupttext nur ein leeres Ergebnis-Array. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Parameter | Beschreibung |
|---|---|
| catalogs | Liste der Objekte, die die Kataloge beschreiben, die dieses Element enthalten. Datentyp: Array |
| catalogs.sys_id | Sys_id des Katalogs. Datentyp: Zeichenfolge |
| catalogs.title | Katalogtitel. Datentyp: Zeichenfolge |
| Kategorie | Beschreibt die Kategorie, die dieses Element enthält. Datentyp: Objekt |
| Kategorie.sys_id | Sys_id der Kategorie. Datentyp: Zeichenfolge |
| Kategorie.Titel | Kategorietitel Datentyp: Zeichenfolge |
| content_type | Art 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-Artikel | Wissensbasierter Artikel, der dem Element zugeordnet ist. Datentyp: Zeichenfolge |
| local_currency | Landeswährungscode für die lokale Währung. Datentyp: Zeichenfolge |
| localized_price | Preis des Artikels, ausgedrückt in der durch local_currencydefinierten Währung. Datentyp: Zeichenfolge |
| localized_recurring_price | Preis der wiederkehrenden Gebühr, ausgedrückt in der durch local_currencydefinierten Währung. Datentyp: Zeichenfolge |
| Name | Name des Elements. Datentyp: Zeichenfolge |
| Bestellen | Vordefinierte Bestellung, zu der das Element gehört. Datentyp: Zahl |
| Bild | Pfad zum Bild, das für das Element angezeigt werden soll. Datentyp: Zeichenfolge |
| price | Preis des Artikels, ausgedrückt in der durch price_currencydefinierten Währung. Datentyp: Zeichenfolge |
| price_currency | Landeswährungscode, für den der Elementpreis ausgedrückt wird. Datentyp: Zeichenfolge |
| recurring_frequency | Häufigkeit, mit der wiederkehrende Gebühren erhoben werden, z. B. täglich, monatlich oder jährlich; null, wenn für den Artikel keine Gebühren anfallen. Datentyp: Zeichenfolge |
| recurring_price | Betrag der wiederkehrenden Gebühr, die mit dem Element verbunden ist. Datentyp: Zeichenfolge |
| recurring_price_currency | Landeswährungscode, für den die wiederkehrenden Gebühren angegeben werden. Datentyp: Zeichenfolge |
| short_description | Kurze Beschreibung des Elements. Datentyp: Zeichenfolge |
| show_price | Kennzeichnung, die angibt, ob der Artikelpreis im Einkaufswagen angezeigt werden soll. Mögliche Werte:
Datentyp: Boolesch |
| show_quantity | Kennzeichnung, die angibt, ob die Artikelmenge im Einkaufswagen angezeigt werden soll. Mögliche Werte:
Datentyp: Boolesch |
| sys_class_name | Tabelle, zu der der Datensatz gehört, wie zum Beispiel sc_cat_item_producer. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Elements. Datentyp: Zeichenfolge |
| type | Art 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
}
]
}
Service Catalog – GET /sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}
Überprüft, ob der angegebene delegierte Benutzer ü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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Benutzer über Beschaffungsrechte verfügt. Befindet sich in der Service Catalog-Tabelle [sc_catalog]. Datentyp: Zeichenfolge |
| user_sys_id | Sys_id des Benutzers, um zu überprüfen, ob er über Beschaffungsrechte für das angegebene Servicekatalogelement verfügt. Befindet sich in der Benutzertabelle [sys_users]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Kennzeichnung, die angibt, ob der angegebene Benutzer über Erwerbsrechte für das angegebene Servicekatalogelement verfügt. Gültige Werte:
|
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
}
}
Service Catalog – 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 |
| Name | Beschreibung |
|---|---|
| sysparm_view | UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die Felder, die in der Antwort zurückgegeben werden. Gültige Werte:
Wenn Sie auch den Parameter sysparm_fields angeben, hat dieser Vorrang. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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:
|
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| catalogs | Liste der Objekte, die die Kataloge beschreiben, die dieses Element enthalten. Datentyp: Array |
| catalogs.sys_id | Sys_id des Katalogs. Datentyp: Zeichenfolge |
| catalogs.title | Katalogtitel. Datentyp: Zeichenfolge |
| categories | Liste der Objekte, die die Kategorien beschreiben, die dieses Element enthalten. Datentyp: Array |
| Kategorien.aktiv | Kennzeichnung, die angibt, ob die Kategorie aktiv ist. Mögliche Werte:
Datentyp: Boolesch |
| Kategorien.Kategorie | Beschreibt die zugeordnete Kategorie. Datentyp: Objekt |
| kategorien.category.active | Kennzeichnung, die angibt, ob die Kategorie aktiv ist. Mögliche Werte:
Datentyp: Boolesch |
| Kategorien.Kategorie.sys_id | Sys_id der Kategorie. Datentyp: Zeichenfolge |
| kategorien.category.title | Kategorietitel. Datentyp: Zeichenfolge |
| kategorien.sys_id | Übergeordnete Kategorie der in categories.categoryangegebenen Kategorie. Datentyp: Zeichenfolge |
| Kategorie | Primäre Kategorie, zu der das Element gehört. Datentyp: Objekt |
| 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 im Katalogelement definiert sind. Datentyp: Objekt |
| client_script.onChange | Liste der Client-Skripts des Typs „onChange“, die dem Element zugeordnet sind. Datentyp: Array |
| client_script.onSubmit | Liste der onSubmit-Client-Skripts, die dem Element zugeordnet sind. Datentyp: Array |
| client_script.onLoad | Liste der onLoad-Client-Skripts, die dem Element zugeordnet sind. Datentyp: Array |
| content_type | Art des Inhalts. Datentyp: Zeichenfolge |
| data_lookup | Liste der für das Katalogelement definierten Datensuchen. Datentyp: Array |
| Beschreibung | Detaillierte Beschreibung des Elements. Datentyp: Zeichenfolge |
| icon | Quelle des kleinen Symbols, das neben dem Elementnamen angezeigt wird. Datentyp: Zeichenfolge |
| KB-Artikel | Wissensbasierter Artikel, der dem Element zugeordnet ist. Datentyp: Zeichenfolge |
| local_currency | Landeswährungscode für die lokale Währung. Datentyp: Zeichenfolge |
| localized_price | Preis des Artikels, ausgedrückt in der durch local_currencydefinierten Währung. Datentyp: Zeichenfolge |
| localized_recurring_price | Preis der wiederkehrenden Gebühr, ausgedrückt in der durch local_currencydefinierten Währung. Datentyp: Zeichenfolge |
| Name | Name des Elements. Datentyp: Zeichenfolge |
| Bestellen | Anzahl der Bestellungen für den Artikel. Datentyp: Zahl |
| Bild | Dateiname des Bildes, das für das Element angezeigt werden soll. Datentyp: Zeichenfolge |
| price | Preis des Artikels, ausgedrückt in der durch price_currencydefinierten Währung. Datentyp: Zeichenfolge |
| price_currency | Landeswährungscode, für den der Elementpreis ausgedrückt wird. Datentyp: Zeichenfolge |
| recurring_frequency | Häufigkeit, mit der wiederkehrende Gebühren erhoben werden, z. B. täglich, monatlich oder jährlich. Datentyp: Zeichenfolge |
| recurring_price | Betrag der wiederkehrenden Gebühr, die mit dem Element verbunden ist Datentyp: Zeichenfolge |
| recurring_price_currency | Landeswährungscode, für den die wiederkehrenden Gebühren angegeben werden. Datentyp: Zeichenfolge |
| short_description | Kurze Beschreibung des Elements. Datentyp: Zeichenfolge |
| show_price | Kennzeichnung, die angibt, ob der Artikelpreis im Einkaufswagen angezeigt werden soll. Mögliche Werte:
Datentyp: Boolesch |
| show_quantity | Kennzeichnung, die angibt, ob die Artikelmenge im Einkaufswagen angezeigt werden soll. Mögliche Werte:
Datentyp: Boolesch |
| sys_class_name | Name der Tabelle, zu der dieser Datensatz gehört. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Elements. Datentyp: Zeichenfolge |
| type | Art 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 Benutzers ab.
URL-Format
Versionierte URL: /api/sn_sc/{api_version}/servicecatalog/wishlist
Standard-URL: /api/sn_sc/servicecatalog/wishlist
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| cart_id | Sys_id des Wunschlisten-Einkaufswagens. Datentyp: Zeichenfolge |
| items | Liste der Objekte, die die Artikel im Wunschlisten-Einkaufswagen beschreiben. Datentyp: Array |
| 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 diesen Artikel im Wunschlisten-Einkaufswagen. Identisch mit items.item_id. Datentyp: Zeichenfolge |
| items.created_by | Benutzer, der den Artikel ursprünglich in den Wunschlisten-Einkaufswagen gelegt hat. Datentyp: Zeichenfolge |
| items.created_on | Datum und Uhrzeit, zu der der Artikel ursprünglich in den Wunschlisten-Einkaufswagen gelegt wurde. Datentyp: Zeichenfolge |
| items.delivery_time | Zeit, die zur Lieferung des Artikels benötigt wird. Datentyp: Zeichenfolge |
| items.item_id | Eindeutiger Identifier für diesen Artikel im Wunschlisten-Einkaufswagens (sys_id). Gleich wie items.catalog_item_id. Datentyp: Zeichenfolge |
| items.item_name | Name des Elements. Datentyp: Zeichenfolge |
| items.localized_price | Preis des Artikels ausgedrückt in der lokalen Währung. Datentyp: Zeichenfolge |
| items.localized_recurring_price | Preis der wiederkehrenden Gebühr ausgedrückt in der lokalen Währung. Datentyp: Zeichenfolge |
| items.name | Name des Elements. Datentyp: Zeichenfolge |
| items.order_guide | Bestellleitfaden, dem der Artikel zugeordnet ist. Datentyp: Zeichenfolge |
| items.picture | Pfad zum Bild, das für das Element angezeigt werden soll. Datentyp: Zeichenfolge |
| items.price | Preis des Artikels. Datentyp: Zeichenfolge |
| items.quantity | Zahl dieses Artikels im Wunschlisten-Einkaufswagen. Datentyp: Zeichenfolge |
| items.recurring_frequency | Häufigkeit, mit der wiederkehrende Gebühren erhoben werden, z. B. täglich, monatlich oder jährlich. Null, wenn keine wiederkehrenden Gebühren für diesen Artikel. Datentyp: Zeichenfolge |
| items.recurring_price | Betrag der wiederkehrenden Gebühr, die mit dem Element verbunden 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 der Artikelpreis im Einkaufswagen angezeigt werden soll. Wenn dieser Parameter auf „false“ festgelegt ist, werden Name-Wert-Paare der Preisgestaltung in den Antwortparametern nicht zurückgegeben. Datentyp: Boolesch |
| items.zeige_menge | 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 |
| items.Zwischensumme | Zwischensumme für diesen Artikel – ohne Cent (Preis x Menge). Datentyp: Zahl |
| items.subtotal_price | Zwischensumme für diesen Artikel – einschließlich Cent (Preis x Menge). Datentyp: Zeichenfolge |
| items.sys_class_name | Untergeordnete Klasse, zu der der zugeordnete Elementdatensatz gehört. Datentyp: Zeichenfolge |
| items.sys_id | Eindeutiger Identifier des Elements (sys_id). Gleich wie items.cart_item_id. Datentyp: Zeichenfolge |
| items.updated_by | Benutzer, der diesen Artikel im Wunschlisten-Einkaufswagen aktualisiert hat. Datentyp: Zeichenfolge |
| items.updated_on | Datum und Uhrzeit, zu der der Artikel auf die Wunschliste gesetzt wurde. Datentyp: Zeichenfolge |
| items.variables | 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": ""
}
]
}
}
Service Catalog – GET /sn_sc/servicecatalog/wishlist/{cart_item_id}
Ruft die Details des angegebenen Artikels ab, die im Einkaufswagen der Wunschliste gespeichert sind.
URL-Format
Versionierte URL: /api/sn_sc/v1/servicecatalog/wishlist/{cart_item_id}
Standard-URL: /api/sn_sc/servicecatalog/wishlist/{cart_item_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| cart_item_id | Sys_id des abzurufenden Wunschlisten-Artikels im Einkaufswagen. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Zeigt eine fehlgeschlagene Anforderung an. Falsche Einkaufswagen-Artikel-ID oder der Artikel ist nicht im Wunschlisten-Einkaufswagen vorhanden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| cart_item_id | Sys_id des Elements. Datentyp: Zeichenfolge |
| catalog_item_id | Sys_id des Katalogbezeichners für diesen Artikel im Wunschlisten-Einkaufswagen. Datentyp: Zeichenfolge |
| Delivery_time | Zeit, die zur Lieferung des Artikels benötigt wird. Datentyp: Zeichenfolge |
| item_name | Name des Elements. Datentyp: Zeichenfolge |
| localized_price | Preis des Artikels ausgedrückt in der lokalen Währung. Datentyp: Zeichenfolge |
| localized_recurring_price | Preis der wiederkehrenden Gebühr ausgedrückt in der lokalen Währung. Datentyp: Zeichenfolge |
| price | Preis des Artikels. Datentyp: Zeichenfolge |
| quantity | Zahl dieses Artikels im Wunschlisten-Einkaufswagen. Datentyp: Zeichenfolge |
| recurring_frequency | Häufigkeit, mit der wiederkehrende Gebühren erhoben werden, z. B. täglich, monatlich oder jährlich. Null, wenn keine wiederkehrenden Gebühren für diesen Artikel. Datentyp: Zeichenfolge |
| recurring_price | Betrag der wiederkehrenden Gebühr, die mit dem Element verbunden 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 – POST /sn_sc/servicecatalog/cart/checkout
Ruft den Checkout für den aktuellen Einkaufswagen ab und verarbeitet ihn basierend darauf, ob der zweistufige Checkout-Prozess aktiviert ist.
Beim einstufigen Checkout checkt die Methode den Einkaufswagen aus (speichert) und gibt die Anforderungsnummer und die Auftragsbestellnummer zurück. Beim zweistufigen Checkout gibt die Methode den Status der Einkaufswagenbestellung und alle für den zweistufigen Checkout erforderlichen Informationen zurück.
URL-Format
Versionierte URL: /api/sn_sc/{api_version}/servicecatalog/cart/checkout
Standard-URL: /api/sn_sc/servicecatalog/cart/checkout
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde. Gibt die Gesamt- und Zwischensummeninformationen sowie Informationen zu den Artikeln im Einkaufswagen zurück. Beim einstufigen Checkout checkt die Methode den Einkaufswagen aus (speichert) und gibt die Anforderungsnummer und die Auftragsbestellnummer zurück. Beim zweistufigen Checkout gibt die Methode den Status der Einkaufswagenbestellung und alle für den zweistufigen Checkout erforderlichen Informationen zurück. |
| 400 | Zeigt an, dass der Einkaufswagen leer ist und nicht ausgecheckt werden kann. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Parameter | Beschreibung |
|---|---|
| cart_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 umfassen:
Datentyp: Objekt |
| <recurring_frequency>.frequency_label | Häufigkeit der zugehörigen wiederkehrenden Gebühr. Wenn für den Artikel keine wiederkehrenden Gebühren anfallen, enthält dieser Parameter „null“. Datentyp: Zeichenfolge |
| <recurring_frequency>.items | Array von Objekten, das Details zu jedem Element enthält, das der angegebenen wiederkehrenden Häufigkeitskategorie zugeordnet ist. Datentyp: Array |
| <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 | Benutzer, 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 es dauert, bis der angegebene Artikel geliefert wird. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.item_id | Sys_id des Elements. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.item_name | Name des angegebenen Artikels. 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 der lokalen Währung. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.name | Artikelname. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.order_guide | Name des Bestellleitfadens, dem dieser Artikel zugeordnet ist. Wenn dieser Artikel nicht mit einem Bestellleitfaden verknüpft ist, enthält dieser Parameter eine leere Zeichenfolge. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.picture | Dateiname des Bildes des Artikels. 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 den Artikel keine wiederkehrenden Gebühren anfallen, enthält dieser Parameter „null“. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.recurring_price | Wiederkehrende Gebühr für den angegebenen Artikel. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.recurring_subtotal | Zwischensumme der wiederkehrenden Gebühren für den Artikel (recurring_price x 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 Artikels. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.show_price | Kennzeichnung, die angibt, ob der Preis des Artikels im Einkaufswagen angezeigt wird. Mögliche Werte:
Datentyp: Boolesch |
| <recurring_frequency>.items.show_quantity | Kennzeichnung, die angibt, ob die Artikelmenge im Einkaufswagen angezeigt werden soll. Mögliche Werte:
Datentyp: Boolesch |
| <recurring_frequency>.items.show_recurring_price | Kennzeichnung, die angibt, ob die wiederkehrenden Gebühren im Einkaufswagen angezeigt werden sollten. Mögliche Werte:
Datentyp: Boolesch |
| <recurring_frequency>.Elemente.Zwischensumme | Zwischensumme der Anzahl der Artikel. Datentyp: Zahl |
| <recurring_frequency>.items.subtotal_price | Zwischensumme für das Element (price x quantity). Datentyp: Zeichenfolge |
| <recurring_frequency>.items.sys_class_name | Systemklassifizierungsname des Artikels. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.sys_id | Sys_id des Elementdatensatzes. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.updated_by | Benutzer, 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 dem/der der Artikel entweder ursprünglich in den Einkaufswagen gelegt wurde 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:
Datentyp: Boolesch |
| <recurring_frequency>.Zwischensumme_Preis | Zwischensumme der Kosten aller Artikel für die zugehörige wiederkehrende Häufigkeitskategorie. Datentyp: Zeichenfolge |
| <recurring_frequency>.subtotal_recurring_frequency | Art der Zwischensumme der wiederkehrenden Häufigkeit, wie täglich, monatlich usw. Identisch mit subtotal_recurring_frequency. Datentyp: Zeichenfolge |
| <recurring_frequency>.subtotal_recurring_price | Zwischensumme der wiederkehrenden Gebühren der Artikel innerhalb der zugehörigen Kategorie der wiederkehrenden Häufigkeit. Datentyp: Zeichenfolge |
| <recurring_frequency>.subtotal_title | Wenn show_subtotal_price auf truefestgelegt ist, der Text, der im Einkaufswagen für den zugehörigen Untertitel angezeigt werden soll.Datentyp: Zeichenfolge |
| <recurring_frequency>.total_title | Anzuzeigender Text für den Gesamttitel der zugehörigen Kategorie der wiederkehrenden Häufigkeit. Datentyp: Zeichenfolge |
| requested_for | Sys_id des Benutzers, für den der Artikel bestellt wurde. Datentyp: Zeichenfolge |
| „angefordert_für_Benutzer“ | Benutzer, 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:
Datentyp: Zeichenfolge |
| spezielle_Anweisungen | Alle Anweisungen des Kunden für den Artikel. Datentyp: Zeichenfolge |
| subtotal_price | Zwischensumme aller Artikel im Einkaufswagen in ganzen Dollar. Datentyp: Zeichenfolge |
| subtotal_recurring_frequency | Art der Zwischensumme der wiederkehrenden Häufigkeit, wie täglich, monatlich usw. Identisch mit <recurring_frequency>.subtotal_recurring_frequency. Datentyp: Zeichenfolge |
| subtotal_recurring_price | Zwischensumme der Gebühren der wiederkehrenden Häufigkeit für alle Artikel im Einkaufswagen. Datentyp: Zeichenfolge |
| subtotal_title | Text, der im Einkaufswagen für den Zwischensummenfeldtitel angezeigt werden soll. Datentyp: Zeichenfolge |
| total_title | Text, der im Einkaufswagen für den Summenfeldtitel 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 – POST /sn_sc/servicecatalog/cart/submit_order
Checkt den Benutzer-Einkaufswagen basierend auf dem aktuellen Checkout-Typ (einstufig oder zweistufig) aus.
Beim einstufigen Checkout checkt die Methode den Einkaufswagen aus (speichert) und gibt die Anforderungsnummer und die Auftragsbestellnummer zurück. Beim zweistufigen Checkout gibt die Methode den Status der Einkaufswagenbestellung und alle für den zweistufigen Checkout 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde und die Artikel im Einkaufswagen erfolgreich ausgecheckt wurden. Beim einstufigen Checkout checkt die Methode den Einkaufswagen aus (speichert) und gibt die Anforderungsnummer und die Auftragsbestellnummer zurück. Beim zweistufigen Checkout gibt die Methode den Status der Einkaufswagenbestellung und alle für den zweistufigen Checkout erforderlichen Informationen zurück. |
| 400 | Zeigt an, dass der Benutzereinkaufswagen leer ist. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| parent_id | Wenn verfügbar, sys_id des übergeordneten Datensatzes, aus dem die Anforderung erstellt wird. Weitere Informationen finden Sie unter Übergeordnete Zuordnungen für eine Anforderung konfigurieren. 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 – POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart
Fügt den angegebenen Artikel zum Einkaufswagen des aktuellen Benutzers 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Artikels, der dem aktuellen Einkaufswagen hinzugefügt werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| sysparm_also_request_for | Kommagetrennte Zeichenfolge von Benutzer-sys_ids anderer Benutzer, für die der angegebene Artikel bestellt werden soll. Benutzer-sys_ids befinden sich in der Benutzertabelle [sys_user].
|
| sysparm_quantity | Erforderlich. Menge des Artikels. Kann keine negative Zahl sein. Datentyp: Zahl |
| sysparm_requested_for | Sys_id des Benutzers, für den der angegebene Artikel bestellt werden soll. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| variables | Name-Wert-Paare aller obligatorischen Einkaufswagenartikel-Variablen. Obligatorische Variablen werden im zugehörigen Formular definiert. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Die folgenden Fehler können auftreten:
|
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| cart_id | sys_id des Einkaufswagens. Datentyp: Zeichenfolge |
| items | Details aller Artikel im Einkaufswagen. Datentyp: Array |
| 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 Benutzers. Datentyp: Zeichenfolge |
| items.localized_recurring_price | Wiederkehrender Preis des Artikels in der lokalen Währung des Benutzers. Datentyp: Zeichenfolge |
| items.price | Basispreis. Datentyp: Zeichenfolge |
| items.quantity | 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 eine 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 – POST /sn_sc/servicecatalog/items/{sys_id}/add_to_wishlist
Fügt den angegebenen Artikel dem Wunschlisten-Einkaufswagen 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Artikels, der der Wunschliste hinzugefügt werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Zeigt eine fehlgeschlagene Anforderung an. Ungültige Anforderungsdaten oder der Benutzer kann keinen Artikel zur Wunschliste hinzufügen. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (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 – POST /sn_sc/servicecatalog/items/{sys_id}/checkout_guide
Ruft ein Array von Inhalten ab, die für das Auschecken angefordert wurden.
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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| items | Liste der Objekte, die die zum Auschecken angeforderten Elemente beschreiben. Datentyp: Array |
| items.sys_id | Erforderlich. Sys_id des Katalogelements. Datentyp: Zeichenfolge |
| items.sysparm_quantity | Anzahl der Elemente. Datentyp: Zeichenfolge Standard: 1 |
| items.variables | Name-Wert-Paare von Variablen, die dem Element zugeordnet sind. Datentyp: Objekt Standard: Keine Variablen |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde.
|
| 400 | Gibt an, dass die Anforderung ungültig ist. Möglicherweise liegt einer der folgenden Gründe vor:
|
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| cart_id | Sys_id des Einkaufswagens. Datentyp: Zeichenfolge |
| items | Liste der Objekte, die Details aller Artikel im Einkaufswagen enthalten. Datentyp: Array |
| 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 | Zeitdauer, die zur 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 |
| items.price | Preis des Artikels. Datentyp: Zeichenfolge |
| items.quantity | Zahl des Artikels im Einkaufswagen. Datentyp: Zeichenfolge |
| items.recurring_frequency | Wiederkehrende Häufigkeit des Artikels. Datentyp: Zeichenfolge |
| items.recurring_price | Wiederkehrender Preis des Artikels. Datentyp: Zeichenfolge |
| items.variables | Name-Wert-Paare, die dem Artikel im Einkaufswagen zugeordnet sind. Datentyp: Objekt |
| parent_id | Wenn verfügbar, die sys_id des übergeordneten Datensatzes, aus dem die Anforderung erstellt wird. Weitere Informationen finden Sie unter Übergeordnete Zuordnungen für eine Anforderung konfigurieren. 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 |
| subtotal_price | Einkaufswagen-Zwischensumme. Datentyp: Zeichenfolge |
| subtotal_price | Zwischensumme des aktuellen Häufigkeitsblocks. Datentyp: Zeichenfolge |
| subtotal_recurring_frequency | Zwischensumme der wiederkehrenden Häufigkeit des Einkaufswagens. Datentyp: Zeichenfolge |
| subtotal_recurring_frequency | Wiederkehrende Häufigkeitszwischensumme des aktuellen Häufigkeitsblocks. Datentyp: Zeichenfolge |
| subtotal_recurring_price | Zwischensumme des wiederkehrenden Preises des Einkaufswagens. Datentyp: Zeichenfolge |
| subtotal_recurring_price | Wiederkehrender Zwischensummenpreis des aktuellen Häufigkeitsblocks. Datentyp: Zeichenfolge |
| total_title | Titel für das Gesamtsummenfeld auf der Seite. Datentyp: Zeichenfolge |
| total_title | Titel für das Gesamtsummenfeld im aktuellen Häufigkeitsblock. 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 – POST /sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users
Gibt eine Liste von Benutzern zurück, deren Anforderung für das angegebene Element nicht delegiert (von einem anderen Benutzer angefordert) werden kann.
Sie können diesen Endpunkt aufrufen, bevor Sie einen Endpunkt wie Servicekatalog-API - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart oder Servicekatalog-API - POST /sn_sc/servicecatalog/items/{sys_id}/order_now aufrufen, die die zulassen Anforderung eines Servicekatalogelements im Namen einer anderen Person. Diese Aufrufe schlagen fehl, wenn Sie einen Benutzer übergeben, der für das zugeordnete Element nicht berechtigt ist. Mit diesem Endpunkt können Sie Ihre Benutzerliste überprüfen, bevor Sie einen Endpunkt aufrufen, der den Artikel bestellt oder versucht, den Artikel in einen Einkaufswagen zu legen.
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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Benutzer über Beschaffungsrechte verfügt. Befindet sich in der Service Catalog-Tabelle [sc_catalog]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| sysparm_also_request_for | Kommagetrennte Zeichenfolge gültiger Anwender-sys_ids. Der Endpunkt überprüft, ob diese Benutzer über Beschaffungsrechte für das angegebene Servicekatalogelement verfügen. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Anforderung fehlgeschlagen. Ungültige Anforderung für Verarbeitung. Weitere Informationen zum Fehler finden Sie in der Nachricht in den zurückgegebenen Ergebnissen. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| errCode | Nummer, die dem Fehler zugeordnet ist. Wird nur zurückgegeben, wenn der Endpunkt fehlschlägt. Datentyp: Zeichenfolge |
| fehlerMsg | Beschreibung des Fehlers, der beim Fehler des Endpunkts aufgetreten ist |
| ungültigeBenutzer | Namen der Benutzer, 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 – POST /sn_sc/servicecatalog/items/{sys_id}/order_now
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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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. Befindet sich in der Tabelle „Katalogelement“ [sc_cat_item]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| sysparm_also_request_for | Kommagetrennte Zeichenfolge von Benutzer-sys_ids anderer Benutzer, für die der angegebene Artikel bestellt werden soll. Benutzer-sys_ids befinden sich in der Benutzertabelle [sys_user].
|
| sysparm_quantity | Erforderlich. Menge des Artikels. Kann keine negative Zahl sein. Datentyp: Zahl |
| sysparm_requested_for | Sys_id des Benutzers, für den der angegebene Artikel bestellt werden soll. Befindet sich in der Benutzertabelle [sys_user]. Die Einstellungen der Eigenschaften glide.sc.req_for.roles und glide.sc.req_for.roles.default bestimmen die Ebene, auf der ein Benutzer Elemente anfordern kann.
Datentyp: Zeichenfolge |
| variables | Name-Wert-Paare aller obligatorischen Einkaufswagenartikel-Variablen. Obligatorische Variablen werden im zugehörigen Formular definiert. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Gibt an, dass der Mengenwert ungültig ist und die Anforderung nicht erteilt wurde. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nummer | Nummer der generierten Anforderung. |
| parent_id | Wenn verfügbar, die sys_id des übergeordneten Datensatzes, aus dem die Anforderung erstellt wird. Weitere Informationen finden Sie unter Übergeordnete Zuordnungen für eine Anforderung konfigurieren. 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 eine 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 – POST /sn_sc/servicecatalog/items/{sys_id}/submit_producer
Erstellt einen Datensatz und gibt den relativen Pfad der Tabellen -API und die Umleitungs-URL zurück, um auf den erstellten Datensatz zuzugreifen.
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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 |
| Name | Beschreibung |
|---|---|
| sysparm_view | UI-Ansicht, für die die Daten gerendert werden sollen. Bestimmt die Felder, die in der Antwort zurückgegeben werden. Gültige Werte:
Wenn Sie auch den Parameter sysparm_fields angeben, hat dieser Vorrang. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| variables | Name-Wert-Paare der Variablen des zu definierenden Erstellerdatensatzes. |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Zeigt eine erfolgreiche Anforderung an und gibt das Antwortobjekt aus Table-API und URL zurück, um auf den erstellten Datensatz zuzugreifen. |
| 400 | Anforderung wird aufgrund einer falschen Anforderungsnachricht nicht verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Die angeforderte Ressource wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| number | Nummer des Tickets, das dem Datensatzersteller zugeordnet ist. Datentyp: Zeichenfolge |
| parent_id | Wenn verfügbar, sys_id des übergeordneten Datensatzes, aus dem die Anforderung erstellt wird. Weitere Informationen finden Sie unter Übergeordnete Zuordnungen für eine Anforderung konfigurieren. Datentyp: Zeichenfolge |
| parent_table | Name der übergeordneten Tabelle. Datentyp: Zeichenfolge |
| record | Relativer Pfad der Table-API des neu erstellten Datensatzerstellers. Datentyp: Zeichenfolge |
| weitergeleitet_portal_url | URL, an die das Service Portal weitergeleitet werden soll. Datentyp: Zeichenfolge |
| weitergeleitet_zu | Weiterleitungs-Wert. Datentyp: Zeichenfolge |
| weitergeleitet_url | Weiterleitungs-URL, um auf den erstellten Datensatzersteller zuzugreifen. Datentyp: Zeichenfolge |
| sys_id | Sys_id des erstellten Datensatzes. Datentyp: Zeichenfolge |
| Tabelle | Name der Tabelle, an der die Anforderung gemacht 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 – POST /sn/sc/servicecatalog/variables/{sys_id}/display_value
Gibt den Anzeigewert der angegebenen Variablen 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Variablen, für die der Anzeigewert zurückgegeben werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| sysparm_value | Sys_id des Datensatzes, der den zurückzugebenden Anzeigewert enthält. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen 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. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| result | Wert der Variablen anzeigen. 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)"
}
Service Catalog – PUT /sn_sc/servicecatalog/cart/{cart_item_id}
Aktualisiert den angegebenen Artikel im Einkaufswagen des angemeldeten Benutzers.
URL-Format
Versionierte URL: /api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}
Standard-URL: /api/sn_sc/servicecatalog/cart/{cart_item_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Artikels im Einkaufswagen. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| sysparm_quantity | Erforderlich. Menge des Artikels, der im Einkaufswagen aktualisiert werden muss. 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 Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 201 | Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde und der Artikel zum Einkaufswagen hinzugefügt wird. |
| 400 | Folgende drei Fehler können auftreten:
|
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| cart_id | Sys_id des Einkaufswagens. Datentyp: Zeichenfolge |
| <recurring_frequency> | Beschreibt Artikel im Einkaufswagen mit einer bestimmten wiederkehrenden Häufigkeit. Mögliche Werte umfassen:
Datentyp: Objekt |
| <recurring_frequency>.frequency_label | Häufigkeit der zugehörigen wiederkehrenden Gebühr. Wenn für den Artikel keine wiederkehrenden Gebühren anfallen, enthält dieser Parameter „null“. Datentyp: Zeichenfolge |
| <recurring_frequency>.items | Liste der Objekte, die jedes Element beschreiben, das der angegebenen wiederkehrenden Häufigkeitskategorie zugeordnet ist. Datentyp: Array |
| <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 | Benutzer, 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 es dauert, bis der angegebene Artikel geliefert wird. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.item_id | sys_id des Elements. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.item_name | Name des angegebenen Artikels. 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 | Artikelname. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.order_guide | Name des Bestellleitfadens, dem dieser Artikel zugeordnet ist. Wenn dieser Artikel nicht mit einem Bestellleitfaden verknüpft ist, enthält dieser Parameter eine leere Zeichenfolge. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.picture | Dateiname des Bildes des Artikels. 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 den angegebenen Artikel. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.recurring_subtotal | Zwischensumme der wiederkehrenden Gebühren für den Artikel (recurring_price x 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 Artikels. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.show_price | Kennzeichnung, die angibt, ob der Preis des Artikels im Einkaufswagen angezeigt wird. Mögliche Werte:
Datentyp: Boolesch |
| <recurring_frequency>.items.show.quantity | Kennzeichnung, die angibt, ob die Artikelmenge im Einkaufswagen angezeigt werden soll. Mögliche Werte:
Datentyp: Boolesch |
| <recurring_frequency>.items.show_recurring_price | Kennzeichnung, die angibt, ob die wiederkehrenden Gebühren im Einkaufswagen angezeigt werden sollten. Mögliche Werte:
Datentyp: Boolesch |
| <recurring_frequency>.Elemente.Zwischensumme | Zwischensumme der Anzahl der Elemente. Datentyp: Zahl |
| <recurring_frequency>.items.subtotal_price | Zwischensumme für das Element (price x quantity). Datentyp: Zeichenfolge |
| <recurring_frequency>.items.sys_class_name | Systemklassifizierungsname des Artikels. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.sys_id | Sys_id des Elements. Datentyp: Zeichenfolge |
| <recurring_frequency>.items.updated_by | Benutzer, 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 dem/der der Artikel entweder ursprünglich in den Einkaufswagen gelegt wurde 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>.Zwischensumme_Preis | Zwischensumme der Kosten aller Artikel für die zugehörige wiederkehrende Häufigkeitskategorie. Datentyp: Zeichenfolge |
| <recurring_frequency>.subtotal_recurring_frequency | Art der Zwischensumme der wiederkehrenden Häufigkeit, wie täglich, monatlich usw. Datentyp: Zeichenfolge |
| <recurring_frequency>.subtotal_recurring_price | Zwischensumme der wiederkehrenden Gebühren der Artikel innerhalb der zugehörigen Kategorie der wiederkehrenden Häufigkeit. Datentyp: Zeichenfolge |
| <recurring_frequency>.subtotal_title | Wenn show_subtotal_price auf truefestgelegt ist, der Text, der im Einkaufswagen für den zugehörigen Untertitel angezeigt werden soll.Datentyp: Zeichenfolge |
| <recurring_frequency>.total_title | Anzuzeigender Text für den Gesamttitel der zugehörigen Kategorie der wiederkehrenden Häufigkeit. Datentyp: Zeichenfolge |
| show_subtotal_price | Kennzeichnung, die angibt, ob der Zwischensummenpreis im Einkaufswagen angezeigt werden soll. Mögliche Werte:
Datentyp: Zeichenfolge |
| subtotal_price | Zwischensumme aller Artikel im Einkaufswagen. Datentyp: Zeichenfolge |
| subtotal_recurring_frequency | Art der Zwischensumme der wiederkehrenden Häufigkeit, wie täglich, monatlich usw. Identisch mit <recurring_frequency>.subtotal_recurring_frequency. Datentyp: Zeichenfolge |
| subtotal_recurring_price | Zwischensumme der Gebühren der wiederkehrenden Häufigkeit für alle Artikel im Einkaufswagen. Datentyp: Zeichenfolge |
| subtotal_title | Text, der im Einkaufswagen für den Zwischensummenfeldtitel angezeigt werden soll. Datentyp: Zeichenfolge |
| total_title | Text, der im Einkaufswagen für den Summenfeldtitel 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 Artikeln ab, die auf den für einen Bestellleitfaden beschriebenen Anforderungen basieren.
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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Elemente abgerufen werden sollen. Befindet sich in der Tabelle „Bestellleitfaden“ [sc_cat_item_guide]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| variables | Variablen, die für ein Element angefordert wurden. Jede Variable ist ein JSON-Objekt, das aus Name-Wert-Paaren besteht. Datentyp: Array |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde. Gibt eine Liste von Elementen basierend auf der übergebenen Variablenliste zurück. Wenn das festgelegte Ergebnis keine Elemente enthält, wird ein leeres Array zurückgegeben. |
| 400 | Gibt an, dass die Anforderung ungültig ist. Möglicherweise liegt einer der folgenden Gründe vor:
|
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Fehler beim Berechnen von Elementen in Abhängigkeit von den ausgewählten Optionen. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| catalogs | Liste der Objekte der Kataloge, zu denen das Element gehört, sowie Katalogtitel und sys_id des Katalogs. Datentyp: Array |
| catalogs.sys_id | Sys_id des Katalogs. Datentyp: Zeichenfolge |
| catalogs.title | Katalogtitel. Datentyp: Zeichenfolge |
| Kategorie | Beschreibt die Kategorie, die dieses Element enthält. Datentyp: Objekt |
| Kategorie.sys_id | Sys_id der Kategorie. Datentyp: Zeichenfolge |
| Kategorie.Titel | Kategorietitel Datentyp: Zeichenfolge |
| client_script | Liste aller Katalog-Client-Skripts, die im Katalogelement definiert sind. Datentyp: Objekt |
| client_script.onChange | Liste der Client-Skripts des Typs „onChange“, 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 onSubmit-Client-Skripts, die dem Element zugeordnet sind. Datentyp: Array |
| data_lookup | Datensuchvorgänge, 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 den Suchergebnisseiten, oder der Titel auf dem Bestellformular des Katalogelements. Datentyp: Zeichenfolge |
| show_price | Gibt an, ob die Preisdetails angezeigt werden sollen. Ralls „true“, werden die folgenden Werte zurückgegeben.
Datentyp: Boolesch |
| sys_id | Sys_id des Katalogelements. Datentyp: Zeichenfolge |
| type | Elementtyp. Mögliche Werte:
Datentyp: Zeichenfolge |
| variables | Name-Wert-Paare aller Variablen, die dem Katalogelement zugeordnet sind. Datentyp: Array |
| ui_policy | Liste aller im Katalogelement definierten Katalog-UI-Richtlinien. 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": []
}
]
}