Cloud-Servicekatalog-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 23 Minuten Lesedauer

    • Die Cloud-Servicekatalog Die API stellt Methoden im Zusammenhang mit Tag-1-Vorgängen (Bereitstellung) und Tag-2-Vorgängen (Änderung) bereit, die im Cloud-Servicekatalog verfügbar sind, z. B. Erstellen von Cloud-Servicestapeln und Aufrufen von Ressourcenvorgangsanforderungen. Sie können auch Informationen zu Kataloganforderungen, Stapeln, die den Status abrufen, und andere Informationen abrufen.

    Diese API ist in enthalten Jetzt Namespace und erfordert die Rolle sn_CMP.Cloud_Service_user. Die Anwendung „Cloud Services Catalog“ (CSC) ist als separates Abonnement verfügbar und erfordert entweder die Produktberechtigung „ITOM Enterprise“ oder „ITOM Cloud Accelerate“.

    Die Cloud-Servicekatalog API-Funktionen Aktionen, die Sie während Tag 2-Vorgängen ausführen. Im Kontext dieser API beziehen sich Ressourcenkatalogelemente auf Katalogelemente, die sich auf Vorgänge von Tag 2 beziehen.

    Um diese API zu verwenden, stellen Sie sicher, dass Sie den geführten Setup-Prozess für Cloud-Services-Katalog abgeschlossen haben oder über eine funktionierende Konfiguration verfügen, in der Bereitstellungs- und Katalogvorgänge in der Anwenderoberfläche funktionieren. Weitere Informationen zu diesen Schritten finden Sie unter Cloud Services Catalog.

    Cloud-Servicekatalog – GET /now/cmp_catalog_api/itemsbyciclass

    Gibt eine Liste von Ressourcenkatalogelementen basierend auf einer bestimmten Konfigurationselementklasse (Configuration Item, CI) zurück.

    URL-Format

    Standard-URL: /api/now/cmp_catalog_api/itemsbyciclass

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    ci_class Erforderlich. Name der CI-Klasse, von der die Ressourcenkatalogelemente abgerufen werden sollen (z. B. „cmdb_ci_vm_instance“). Befindet sich im Feld Referenz-CI-Typ in der Tabelle „Konfigurationselement“ [cmdb_ci].

    Datentyp: Zeichenfolge
    Display_variables Kennzeichnung, die angibt, ob Katalogelementvariablen aufgelistet werden sollen, die jedem Katalogelement zugeordnet sind.
    Gültige Werte:
    • Wahr: Zeigt Listenkatalogelementvariablen an.
    • Falsch: Zeigt keine Listenkatalogelementvariablen an.

    Datentyp: Boolesch

    Standardwert: False
    operational_name Optional. Name des Vorgangs Befindet sich in der Spalte Name der Ressourcenschnittstelle in der Tabelle „OperationSignature“ [sn_CMP_rb_op_Signature].
    Hinweis:
    Dieser Parameter kann einen Teil oder den gesamten Vorgang abfragen. Wenn Sie beispielsweise alle Schnittstellen auflisten möchten, die mit „ServiceNow“ beginnen, können Sie die Variable als festlegen Operation_Name = ServiceNow .

    Standard: Alle Katalogelemente aller Vorgangstypen werden zurückgegeben.

    Datentyp: Zeichenfolge
    Resource_Interface Optional. Ressourcenschnittstelle, auf der das Ressourcenkatalogelement gehostet wird. Befindet sich in der Spalte Name der Tabelle ResourceInterfaces [sn_CMP_rb_resourceinterface].

    Datentyp: Zeichenfolge
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

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

    Standard: application/json
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktion ist deaktiviert.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    aktiv Aktiver Status des Katalogelements des Ressourcenvorgangs.

    Mögliche Werte:

    • Wahr: Das Katalogelement für den Ressourcenvorgang ist aktiv.
    • Falsch: Das Katalogelement für den Ressourcenvorgang ist inaktiv.

    Datentyp: Zeichenfolge
    created_on Zeitstempel ab dem Zeitpunkt, zu dem das Katalogelement für den Ressourcenvorgang erstellt wurde.

    Format: jjjj-MM-TT HH:mm:ss.

    Datentyp: Zeichenfolge
    display_name Name der Ressourcenschnittstelle. Befindet sich in der Tabelle „ResourceInterfaces“ [sn_CMP_rb_resourceinterface].

    Datentyp: Zeichenfolge
    id SYS_ID des Katalogelements des Ressourcenvorgangs.

    Datentyp: Zeichenfolge

    Tabelle: Katalogelement für Ressourcenvorgang [sn_CMP_rsrc_opr_Cat_item]
    name Name des Katalogelements für den Ressourcenvorgang. Befindet sich in der Tabelle „Katalogelement für Ressourcenvorgang“ [sn_CMP_rsrc_opr_Cat_item].

    Datentyp: Zeichenfolge
    short_description Kurze Beschreibung des Katalogelements des Ressourcenvorgangs.

    Datentyp: Zeichenfolge

    Tabelle: Katalogelement für Ressourcenvorgang [sn_CMP_rsrc_opr_Cat_item]
    updated_on Zeitstempel ab dem Zeitpunkt, zu dem das Katalogelement des Ressourcenvorgangs zuletzt aktualisiert wurde. Erforderliches Format: jjjj-MM-TT HH:mm:ss.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im folgenden Beispiel wird der Status des Anforderungselements angefordert und zurückgegeben.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/itemsbyciclass?ci_class=cmdb_ci_vm_instance&resource_interface=Virtual%20Machine%20Store%20Extension%20Interface&operation_name=Execute%20Job%20Template" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Antwort:

    [
  {
    "display_name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "created_on": "2019-04-28 12:58:26",
    "updated_on": "2019-04-28 12:58:26",
    "name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "short_description": "Catalog item to invoke operation",
    "active": true
  }
]

    Cloud-Servicekatalog – GET /now/cmp_catalog_api/itemsbyrb

    Gibt eine Liste von Ressourcenkatalogelementen basierend auf einem bestimmten Ressourcenblock zurück.

    URL-Format

    Standard-URL: /api/now/cmp_catalog_api/itemsbyrb

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Display_variables Kennzeichnung, die angibt, ob Katalogelementvariablen aufgelistet werden sollen, die jedem Katalogelement zugeordnet sind.
    Gültige Werte:
    • Wahr: Zeigt Listenkatalogelementvariablen an.
    • Falsch: Zeigt keine Listenkatalogelementvariablen an.

    Datentyp: Boolesch

    Standardwert: False
    operational_name Optional. Name des Vorgangs Befindet sich in der Spalte Name der Ressourcenschnittstelle in der Tabelle „OperationSignature“ [sn_CMP_rb_op_Signature].
    Hinweis:
    Dieser Parameter kann einen Teil oder den gesamten Vorgang abfragen. Wenn Sie beispielsweise alle Schnittstellen auflisten möchten, die mit „ServiceNow“ beginnen, können Sie die Variable als festlegen Operation_Name = ServiceNow .

    Standard: Alle Katalogelemente aller Vorgangstypen werden zurückgegeben.

    Datentyp: Zeichenfolge
    Resource_Block Erforderlich. Name des Ressourcenblocks, von dem die zugehörigen Ressourcenvorgangskatalogelemente abgerufen werden sollen (z. B. virtueller Server).

    Standard: Alle Katalogelemente aller Vorgangstypen werden zurückgegeben.

    Datentyp: Zeichenfolge

    Tabelle: Ressourcenblock [sn_CMP_rb_resourceblock]
    Resource_Interface Optional. Ressourcenschnittstelle, auf der das Ressourcenkatalogelement gehostet wird. Befindet sich in der Spalte Name der Tabelle ResourceInterfaces [sn_CMP_rb_resourceinterface].

    Datentyp: Zeichenfolge
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

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

    Standard: application/json
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktion ist deaktiviert.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    aktiv Aktiver Status des Katalogelements des Ressourcenvorgangs.

    Mögliche Werte:

    • Wahr: Das Katalogelement für den Ressourcenvorgang ist aktiv.
    • Falsch: Das Katalogelement für den Ressourcenvorgang ist inaktiv.

    Datentyp: Zeichenfolge
    display_name Name der Ressourcenschnittstelle. Befindet sich in der Tabelle „ResourceInterfaces“ [sn_CMP_rb_resourceinterface].

    Datentyp: Zeichenfolge
    id SYS_ID des Katalogelements des Ressourcenvorgangs.

    Datentyp: Zeichenfolge

    Tabelle: Katalogelement für Ressourcenvorgang [sn_CMP_rsrc_opr_Cat_item]
    name Name des Katalogelements für den Ressourcenvorgang. Befindet sich in der Tabelle „Katalogelement für Ressourcenvorgang“ [sn_CMP_rsrc_opr_Cat_item].

    Datentyp: Zeichenfolge
    short_description Kurze Beschreibung des Katalogelements des Ressourcenvorgangs.

    Datentyp: Zeichenfolge

    Tabelle: Katalogelement für Ressourcenvorgang [sn_CMP_rsrc_opr_Cat_item]
    Variablen Liste zusätzlicher Details zum Ressourcenkatalogelement. Die in dieser API zurückgegebenen Variablen variieren basierend auf den übergebenen Abfrageparametern.

    Datentyp: Array von Objekten

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    Diese Beispielliste von Ressourcenkatalogelementen basierend auf einem virtuellen Server-Ressourcenblock:

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/itemsbyrb?resource_interface=Virtual%20Machine%20Store%20Extension%20Interface&operation_name=Execute%20Job%20Template&resource_block=Virtual%20Server" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Antwort:

    [
  {
    "display_name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "created_on": "2019-04-28 12:58:26",
    "updated_on": "2019-04-28 12:58:26",
    "name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "short_description": "Catalog item to invoke operation",
    "active": true
  }
]

    Cloud-Servicekatalog – GET /now/cmp_catalog_api/Services

    Gibt eine Liste von Katalogelementen basierend auf dem angegebenen Blueprint eines Bereitstellungs- oder Lebenszykluskatalogetyps zurück.

    URL-Format

    Standard-URL: /api/now/CMP_catalog_api/Services

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Catalog_type Optional. Typ des Katalogelements. Akzeptierte Werte (Groß-/Kleinschreibung beachten):
    • Bereitstellung – Gibt alle Katalogelemente vom Blueprint-Typ zurück.
    • Lebenszyklus – Gibt Katalogelemente des Vorgangstyps „ganztägig 2“ zurück.

    Wenn die Eingabe leer ist (Standard), werden alle Services beider Katalogtypen zurückgegeben.

    Datentyp: Zeichenfolge
    Display_variables Kennzeichnung, die angibt, ob Katalogelementvariablen aufgelistet werden sollen, die jedem Katalogelement zugeordnet sind.
    Gültige Werte:
    • Wahr: Zeigt Listenkatalogelementvariablen an.
    • Falsch: Zeigt keine Listenkatalogelementvariablen an.

    Datentyp: Boolesch

    Standardwert: False
    Blueprint_Name Optional. Name des Blueprints, in dem die zugehörigen Katalogelemente abgerufen werden sollen. Befindet sich in der Tabelle „Kategorieelement“ [sn_CMP_bp_Cat_item].
    Hinweis:
    Dieser Parameter kann den Blueprint-Namen ganz oder teilweise abfragen. Wenn Sie beispielsweise alle Blueprints auflisten möchten, die mit „ServiceNow“ beginnen, können Sie die Variable als festlegen Blueprint_Name = ServiceNow .

    Standard: Alle Services aller Blueprints werden zurückgegeben.

    Datentyp: Zeichenfolge
    Tabelle : 15. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

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

    Standard: application/json
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktion ist deaktiviert.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    aktiv Kennzeichnung, die angibt, ob der Katalog aktiv ist.
    Mögliche Werte:
    • Wahr: Katalog ist aktiv.
    • Falsch: Katalog ist nicht aktiv.

    Datentyp: Zeichenfolge
    Blaupause SYS_ID des Blueprints.

    Datentyp: Zeichenfolge

    Tabelle: Blueprint [sn_CMP_bp_Blueprint]
    Blueprint_category SYS_ID der Blueprint-Kategorie.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Servicekategorie [sn_CAPI_Service_category]
    Blueprint_category_Name Name der Blueprint-Kategorie.
    Mögliche Werte:
    • Zugriff
    • Analytics
    • Anwendungsservices
    • Blockchain
    • Geschäftliche Produktivität
    • Berechnen
    • Konfigurationsverwaltung
    • Container
    • Datenbank
    • Entwicklertools
    • Ereignis
    • Hybrid Cloud
    • IOT
    • IPAM
    • Lautausgleichsmodul
    • Machine Learning
    • Verwaltungstools
    • Marktplatz
    • Mobil
    • Netzwerk
    • Produktivität
    • Sicherheit
    • Shell-Zugriff
    • Speicher
    • Tools
    • Unbekannt
    • Virtuelle Realität

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Servicekategorie [sn_CAPI_Service_category]
    Blueprint_Name Name des Blueprints. Befindet sich in der Blueprint-Tabelle [sn_CMP_bp_Blueprint].

    Datentyp: Zeichenfolge
    Blueprint_type Typ des Blueprints.

    Möglicher Wert: Anwenderdefinierter Blueprint

    Datentyp: Zeichenfolge
    Catalog_Name Name des Katalogs.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Katalogelement [sn_CMP_bp_Cat_item]
    Catalog_type Typ des Katalogs.
    Mögliche Werte:
    • 1 : Katalog hat den Typ „Bereitstellung“.
    • 2 : Katalog ist vom Typ „Lebenszyklus“.

    Datentyp: Zeichenfolge
    Catalog_type Typ des Katalogs.
    Mögliche Werte:
    • 1 : Katalog hat den Typ „Bereitstellung“.
    • 2 : Katalog ist vom Typ „Lebenszyklus“.

    Datentyp: Zeichenfolge
    createdOn Zeitstempel ab dem Zeitpunkt der Erstellung des Katalogelements.

    Datentyp: Zeichenfolge
    Erstellt von Anwender, der das Katalogelement erstellt hat.

    Datentyp: Zeichenfolge
    id SYS_ID des Blueprints.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Katalogelement [sn_CMP_bp_Cat_item]
    Last_updated_on Zeitstempel ab dem Zeitpunkt der letzten Aktualisierung des Katalogelements.

    Datentyp: Zeichenfolge
    Last_updated_by Anwender, der das Katalogelement zuletzt aktualisiert hat, z. B. ein Administrator oder das System.

    Datentyp: Zeichenfolge
    operation SYS_ID des Vorgangs.

    Datentyp: Zeichenfolge

    Tabelle: OperationSignature [sn_CMP_rb_op_Signature]
    operational_name Name des Vorgangs
    Mögliche Werte:
    • Bereitstellung aufheben: Löscht Ressourcen mit dem Status „beendet“ und aktualisiert Ressourcen-CMDB-Tabellen entsprechend.
    • ModifyLease: Ändert den für bereitgestellte Ressourcen geplanten Mietvorgang.
    • ModifySchedule: Ändert den Zeitplan für bereitgestellte Ressourcen.
    • Start: Startet die Ressourcen, die sich im Status „aus“ befinden.
    • Stoppen: Stoppt die Ressourcen, die sich im Status „ein“ befinden.

    Datentyp: Zeichenfolge
    Variablen Details zum Listenkatalogelement. Die in dieser API zurückgegebenen Variablen variieren je nach Abfrageparametern, die in der Anforderung übergeben werden.

    Datentyp: Array von Objekten

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    Dieses Beispiel gibt alle Katalogelemente eines Lebenszyklus-Blueprints mit dem Namen „classiclb“ zurück.

    curl "https://instance.servicenow.comapi/now/cmp_catalog_api/services?display_variables=true&catalog_type=LifeCycle&blueprint_name=classiclb" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Antwort:

    [
  {
    "catalog_name": "Deprovision",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "variables": [
      {
        "id": "a12d34c5678c91234bf45678912d34e4",
        "name": "StackID",
        "question_text": "StackID",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:03",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:46:02",
    "created_by": "user@password.com",
    "operation": "a70d51c0476c46104bf15222516d4375",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Deprovision"
  },
  {
    "catalog_name": "ModifySchedule",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": null,
    "id": "361d55c0476c46104bf15222516d4351",
    "variables": [
      {
        "id": "031d55c0476c46104bf15222516d43af",
        "name": "ScheduleProfile",
        "question_text": "ScheduleProfile",
        "default_value": "Not specified"
      },
      {
        "id": "0b1d55c0476c46104bf15222516d43c9",
        "name": "ScheduleTimeZone",
        "question_text": "ScheduleTimeZone",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:53",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:52",
    "created_by": "user@password.com",
    "operation": "130d51c0476c46104bf15222516d436c",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "ModifySchedule"
  },
  {
    "catalog_name": "Stop",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "542dd5c0476c46104bf15222516d43b0",
    "variables": [
      {
        "id": "a02d19c0476c46104bf15222516d4301",
        "name": "StackID",
        "question_text": "StackID",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:00",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:58",
    "created_by": "user@password.com",
    "operation": "930d51c0476c46104bf15222516d436f",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Stop"
  },
  {
    "catalog_name": "Cleanup",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "712d59c0476c46104bf15222516d435c",
    "variables": [
      {
        "id": "da2d59c0476c46104bf15222516d43dc",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "da2d59c0476c46104bf15222516d43e2",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:06",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:46:04",
    "created_by": "user@password.com",
    "operation": "ab0d51c0476c46104bf15222516d437b",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Cleanup"
  },
  {
    "catalog_name": "ModifyLease",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": null,
    "id": "bb1dd5c0476c46104bf15222516d4301",
    "variables": [
      {
        "id": "142dd5c0476c46104bf15222516d4382",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "d82dd5c0476c46104bf15222516d4394",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:58",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:56",
    "created_by": "user@password.com",
    "operation": "2b0d51c0476c46104bf15222516d4378",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "ModifyLease"
  },
  {
    "catalog_name": "Start",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "d71d95c0476c46104bf15222516d4312",
    "variables": [
      {
        "id": "731d95c0476c46104bf15222516d43ae",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "731d95c0476c46104bf15222516d43b4",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:55",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:54",
    "created_by": "user@password.com",
    "operation": "270d51c0476c46104bf15222516d4372",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Start"
  }
]

    Cloud-Servicekatalog – GET /now/cmp_catalog_api/Stacks

    Gibt eine Liste von Katalogelementen basierend auf Bereitstellungstyp-Blueprints (auch als Stapel bezeichnet) zurück.

    URL-Format

    Standard-URL: /api/now/CMP_catalog_api/Stacks

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Blueprint_Name Optional. Name des Blueprints, in dem die zugehörigen Katalogelemente abgerufen werden sollen. Befindet sich in der Tabelle „Kategorieelement“ [sn_CMP_bp_Cat_item].
    Hinweis:
    Dieser Parameter kann den Blueprint-Namen ganz oder teilweise abfragen. Wenn Sie beispielsweise alle Blueprints auflisten möchten, die mit „ServiceNow“ beginnen, können Sie die Variable als festlegen Blueprint_Name = ServiceNow .

    Standard: Alle Services aller Blueprints werden zurückgegeben.

    Datentyp: Zeichenfolge
    Display_variables Kennzeichnung, die angibt, ob Katalogelementvariablen aufgelistet werden sollen, die jedem Katalogelement zugeordnet sind.
    Gültige Werte:
    • Wahr: Zeigt Listenkatalogelementvariablen an.
    • Falsch: Zeigt keine Listenkatalogelementvariablen an.

    Datentyp: Boolesch

    Standardwert: False
    Tabelle : 21. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

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

    Standard: application/json
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktion ist deaktiviert.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    aktiv Kennzeichnung, die angibt, ob der Katalog aktiv ist.
    Mögliche Werte:
    • Wahr: Katalog ist aktiv.
    • Falsch: Katalog ist nicht aktiv.

    Datentyp: Zeichenfolge
    Blaupause SYS_ID des Blueprints.

    Datentyp: Zeichenfolge

    Tabelle: Blueprint [sn_CMP_bp_Blueprint]
    Blueprint_category SYS_ID der Blueprint-Kategorie.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Servicekategorie [sn_CAPI_Service_category]
    Blueprint_category_Name Name der Blueprint-Kategorie.
    Mögliche Werte:
    • Zugriff
    • Analytics
    • Anwendungsservices
    • Blockchain
    • Geschäftliche Produktivität
    • Berechnen
    • Konfigurationsverwaltung
    • Container
    • Datenbank
    • Entwicklertools
    • Ereignis
    • Hybrid Cloud
    • IOT
    • IPAM
    • Lautausgleichsmodul
    • Machine Learning
    • Verwaltungstools
    • Marktplatz
    • Mobil
    • Netzwerk
    • Produktivität
    • Sicherheit
    • Shell-Zugriff
    • Speicher
    • Tools
    • Unbekannt
    • Virtuelle Realität

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Servicekategorie [sn_CAPI_Service_category]
    Blueprint_Name Name des Blueprints. Befindet sich in der Blueprint-Tabelle [sn_CMP_bp_Blueprint].

    Datentyp: Zeichenfolge
    Blueprint_type Typ des Blueprints.

    Möglicher Wert: Anwenderdefinierter Blueprint

    Datentyp: Zeichenfolge
    Catalog_Name Name des Katalogs.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Katalogelement [sn_CMP_bp_Cat_item]
    Catalog_type Typ des Katalogs.
    Mögliche Werte:
    • 1 : Katalog hat den Typ „Bereitstellung“.
    • 2 : Katalog ist vom Typ „Lebenszyklus“.

    Datentyp: Zeichenfolge
    Catalog_type_Name Name des Katalogtyps.
    Mögliche Werte:
    • Bereitstellungsvorgang (Tag 1): Katalogtyp ist „Bereitstellung“.
    • Lebenszyklusvorgang (Tag 2): Katalogtyp ist „Lebenszyklus“.

    Datentyp: Zeichenfolge
    id SYS_ID des Blueprints.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Katalogelement [sn_CMP_bp_Cat_item]
    LebenszyklusVorgänge Objekt, das den Namen und die sys_ID des Lebenszyklusvorgangs enthält

    Datumstyp: Array von Objekten

    "lifecycleOperations": [
      {
        "id": "String",
        "name": "String"
      }
    lifecycleOperations.id SYS_ID des Lebenszyklusvorgangs.

    Datentyp: Zeichenfolge

    Tabelle: OperationSignature [sn_CMP_rb_op_Signature]
    lifeCycleOperations.name Typ der Lebenszyklusvorgänge.
    Mögliche Werte:
    • Bereinigung: Bereinigt Ressourcen mit dem Status „beendet“.
    • Bereitstellung aufheben: Löscht Ressourcen im Status „beendet“ und aktualisiert Ressourcen-CMDB-Tabellen entsprechend.
    • ModifyLease: Ändert den für bereitgestellte Ressourcen geplanten Mietvorgang.
    • ModifySchedule: Führt die Geschäftszeitplanung für Stapel zum Zeitpunkt der Bereitstellung oder für vorhandene Stapel durch.
    • Start: Startet die Ressourcen, die sich im Status „aus“ befinden.
    • Stoppen: Stoppt die Ressourcen, die sich im Status „ein“ befinden.

    Datumstyp: Objekt
    operation SYS_ID des Vorgangs.

    Datentyp: Zeichenfolge

    Tabelle: OperationSignature [sn_CMP_rb_op_Signature]
    operational_name Name des Vorgangs
    Mögliche Werte:
    • Bereitstellung aufheben: Löscht Ressourcen mit dem Status „beendet“ und aktualisiert Ressourcen-CMDB-Tabellen entsprechend.
    • ModifyLease: Ändert den für bereitgestellte Ressourcen geplanten Mietvorgang.
    • ModifySchedule: Ändert den Zeitplan für bereitgestellte Ressourcen.
    • Start: Startet die Ressourcen, die sich im Status „aus“ befinden.
    • Stoppen: Stoppt die Ressourcen, die sich im Status „ein“ befinden.

    Datentyp: Zeichenfolge
    shortDescription Kurze Beschreibung des Katalogs.

    Datentyp: Zeichenfolge
    template_name Name der Vorlage.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Katalogelement [sn_CMP_bp_Cat_item]
    Template_type SYS_ID des Vorlagentyps.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Katalogelement [sn_CMP_bp_Cat_item]
    Template_Cloud_Product_Name Name des Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Katalogelement [sn_CMP_bp_Cat_item]
    Variablen Details zum Listenkatalogelement. Die in dieser API zurückgegebenen Variablen variieren je nach Abfrageparametern, die in der Anforderung übergeben werden.

    Datentyp: Array von Objekten

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    Das folgende Beispiel gibt alle Katalogelemente in der Instanz mit dem Bereitstellungskatalogetyp zurück.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/stacks" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Rückgabe:

    [
  {
    "catalog_type": "1",
    "catalog_type_name": "Provision Operation (Day 1)",
    "catalog_name": "classiclb",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "blueprint_category_name": "Compute",
    "active": true,
    "category": "8641fe260b212200eff7ef9bb4673a3d",
    "shortDescription": null,
    "id": "07cc9580476c46104bf15222516d43c3",
    "last_updated_on": "2024-02-19 07:46:13",
    "last_updated_by": "user@servicenow.com",
    "blueprint_type": "Cloud Template",
    "template_type": "932f81e49f00320048111f80a57fcf6e",
    "template_name": "CloudFormation Template",
    "template_cloud_product": "52cfc4749f00320048111f80a57fcf9a",
    "template_cloud_product_name": "AWS CloudFormation",
    "lifecycleOperations": [
      {
        "id": "1d2d19c0476c46104bf15222516d4392",
        "name": "Deprovision"
      },
      {
        "id": "361d55c0476c46104bf15222516d4351",
        "name": "ModifySchedule"
      },
      {
        "id": "542dd5c0476c46104bf15222516d43b0",
        "name": "Stop"
      },
      {
        "id": "712d59c0476c46104bf15222516d435c",
        "name": "Cleanup"
      },
      {
        "id": "bb1dd5c0476c46104bf15222516d4301",
        "name": "ModifyLease"
      },
      {
        "id": "d71d95c0476c46104bf15222516d4312",
        "name": "Start"
      }
    ],
    "created_on": "2024-02-19 07:44:44",
    "created_by": "user@servicenow.com",
    "operation": "130d51c0476c46104bf15222516d4368",
    "operation_name": "Provision"
  }
]

    Cloud-Servicekatalog – GET /now/cmp_catalog_api/Status

    Gibt den Status und die Details eines bestimmten Katalog-RITM (Anforderungselement) zurück.

    Verwenden Sie diese Methode, um den Ursprung der Anforderung zu identifizieren, nachzuverfolgen und ihren Flow zu überwachen. Die Antwort enthält Folgendes:
    1. RITM-Nummer für die übermittelte Anforderung
    2. Die Phase, in der sich die Anforderung befindet
    3. Die Anwender, die die Anforderung geöffnet haben und denen zugewiesen ist
    4. Die Gruppe, die der Anforderung zugewiesen ist
    5. Wann die Anforderung geöffnet wurde
    6. Der Status, in dem sich die Anforderung befindet
    7. Übermittlungsdaten

    URL-Format

    Standard-URL: /api/now/CMP_catalog_api/Status

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    req_item Eindeutige Anforderungselementnummer in der Tabelle „angefordertes Element“ [sc_req_item]. Beispiel: RITM0000001 .

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

    Kopfzeilen

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

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

    Standard: application/json
    Tabelle : 29. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktion ist deaktiviert.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    assignmentGroup Gruppe, die der Anforderung zugewiesen ist.

    Datentyp: Zeichenfolge
    assignedTo Anwender-E-Mail-Adresse, die der Anforderung zugewiesen ist.

    Datentyp: Zeichenfolge
    CatItem SYS_ID der Katalogelementanforderung.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Katalogelement [sn_CMP_bp_Cat_item]
    Fehler Nachricht mit Details zu einem zurückgegebenen Fehler.
    Mögliche Fehlermeldungen:
    • Datensatz nicht gefunden: Das Anforderungselement ist nicht vorhanden.
    • Anwender nicht authentifiziert: Die Anmeldeinformationen des Anwenders sind nicht berechtigt, diese Anforderung zu stellen.

    Datentyp: Zeichenfolge
    Nummer Eindeutige Anforderungselementnummer (RITM), die dem neuen Anforderungselement zugewiesen wird.

    Datentyp: Zeichenfolge

    Tabelle: Anforderungselement [sc_req_item]
    openedAt Zeitstempel ab dem Zeitpunkt, zu dem das Anforderungselement geöffnet wurde.

    Format: jjjj-MM-TT HH:mm:ss.

    Datumstyp: Zeichenfolge
    Geöffnet von SYS_ID des Anwenders, der die Anforderung geöffnet hat.

    Datentyp: Zeichenfolge
    stage Aktuelle Verarbeitungsphase des Anforderungselements.
    Mögliche Werte:
    • Stapel wird bereitgestellt
    • Bereitstellung abgebrochen
    • Fehler bei der Bereitstellung
    • Bereitstellung erfolgreich
    • Ressourcenlimit überschritten
    • Stapelbereitstellung wird erneut versucht
    • Aufgabe für Anwender erstellt
    • Wartet auf Bereitstellungsgenehmigung

    Datentyp: Zeichenfolge
    Status Aktueller Abschlussstatus des Anforderungselements.
    Mögliche Werte:
    • Abgeschlossen
    • Unvollständig geschlossen
    • Als übersprungen geschlossen
    • Offen
    • Ausstehend
    • In Arbeit

    Datentyp: Zeichenfolge
    Übermittlungsdaten Informationen zur Anforderungsübermittlung, z. B. Cloud-Account, Standort, Anwendung und Kostenstellendaten. Die Übermittlungsdaten variieren je nach Anforderungselementnummer, die in der Anforderung übergeben wurde.

    Datentyp: Objekt

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id SYS_ID des Anforderungselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Anforderungselement [sc_req_item]

    cURL-Anforderung

    Das folgende Beispiel gibt Statusinformationen für die Anforderungselementnummer RITM0010076 zurück.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/statusreq_item=RITM0010076" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Antwort:

    { 
  "catItem": "39737024c390719005091d75e0013115", 
  "stage": "Task Created for User", 
  "sys_id": "ee1197db476cc2904bf15222516d439f", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "number": "RITM0010072", 
  "openedAt": "2024-02-29 18:32:55", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"CloudAccount\":\"AzureCA\",\"CSC_Azure_Functions_newResourceGroup\":\"test-rg-dnd\",\"CSC_Azure_Functions_runTimeVersion\":\"~18\",\"CSC_Azure_Functions_runTimeEngine\":\"node\",\"CSC_Azure_Functions_os\":\"Windows\",\"CSC_Azure_Functions_functionAppName\":\"sa02291029-fa\",\"LeaseEndDate\":\"2024-05-29 17:29:57\",\"ScheduleProfile\":\"-- No Schedule --\",\"UserGroup\":\"cfcbad03d711110050f5edcb9e61038f\",\"CSC_Azure_Functions_applicationName\":\"function-app\",\"ScheduleTimeZone\":\"America/Los_Angeles\",\"BusinessService\":\"\",\"environment\":\"Production\",\"CostCenter\":\"\",\"UseExistingWorkspace\":false,\"CSC_Azure_Functions_existingResourceGroup\":\"cpg-dnd\",\"CSC_Azure_Functions_isNewResourceGroup\":\"false\",\"CSC_Azure_Functions_storageAccountName\":\"sa02291029fasa\",\"Application\":\"\",\"StackName\":\"sa02291029\",\"Location\":\"Azure Datacenter - eastus\",\"Workspace\":\"\"}" 
}

    Cloud-Servicekatalog: VERÖFFENTLICHEN SIE /now/cmp_catalog_api/submitopRequest

    Sendet eine Ressourcenvorgangsanforderung, um Tag 2-Vorgänge für bereitgestellte Ressourcen auszuführen.

    URL-Format

    Standard-URL: /api/now/cmp_catalog_api/submitopRequest

    Unterstützte Anforderungsparameter

    Tabelle : 31. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    Cat_ID Erforderlich. sys_ID des aufzurufenden Cloud-Katalogelements. Verfügbar in der Tabelle „Cloud-Katalogelement“ [sn_CMP_bp_Cat_item].

    Datentyp: Zeichenfolge
    Tabelle : 33. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    CloudAccount Erforderlich. Name des Cloud-Accounts, in dem die Anforderung übermittelt werden soll. Account-Namen sind in der Tabelle „Cloud-Account“ [cmdb_ci_CMP_Cloud_Account] verfügbar.

    Datentyp: Zeichenfolge
    Standort Erforderlich. Rechenzentrumsstandort, in dem die Ressource bereitgestellt werden soll. Beispiel: US-West-1 Oder asien-Süd-2 . Dieser Wert muss mit dem Standort des Rechenzentrums des Plattformanbieters des Cloud-Accounts übereinstimmen. Verfügbar in der zugehörigen Tabelle „Rechenzentrum“ [sn_CMP_ca_assc_Datacenter].

    Datentyp: Zeichenfolge
    StackName Erforderlich. Name des Stapels. Der Stapelname ist dynamisch und wird in der Ressourcenverwaltung berücksichtigt.

    Datentyp: Zeichenfolge
    resourceId Erforderlich. SYS_ID der Ressource, in der Vorgänge von Tag 2 ausgeführt werden.

    Datentyp: Zeichenfolge

    Tabelle: Stapelelemente [sn_CMP_Stack_item]
    Resource_Block Erforderlich. Name des Ressourcenblocks, von dem die zugehörigen Ressourcenvorgangskatalogelemente abgerufen werden sollen (z. B. virtueller Server).

    Standard: Alle Katalogelemente aller Vorgangstypen werden zurückgegeben.

    Datentyp: Zeichenfolge

    Tabelle: Ressourcenblock [sn_CMP_rb_resourceblock]
    operational_name Optional. Name des Vorgangs Befindet sich in der Spalte Name der Ressourcenschnittstelle in der Tabelle „OperationSignature“ [sn_CMP_rb_op_Signature].Der von Ihnen eingegebene Vorgangsname hängt vom in übergebenen Wert ab resourceBlockParameter.
    Hinweis:
    Dieser Parameter kann einen Teil oder den gesamten Vorgang abfragen. Wenn Sie beispielsweise alle Schnittstellen auflisten möchten, die mit „ServiceNow“ beginnen, können Sie die Variable als festlegen Operation_Name = ServiceNow .
    Standard: Alle Katalogelemente aller Vorgangstypen werden zurückgegeben.Datentyp: Zeichenfolge
    ResourceInterface Erforderlich. Name des Ressourcenblocks, von dem die zugehörigen Ressourcenvorgangskatalogelemente abgerufen werden sollen (z. B. virtueller Server).Die von Ihnen eingegebene Ressourcenschnittstelle hängt vom in übergebenen Wert ab resourceBlockUnd operation_nameParameter.

    Standard: Alle Katalogelemente aller Vorgangstypen werden zurückgegeben.

    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 .

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

    Standard: application/json
    Tabelle : 35. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 36. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktion ist deaktiviert.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    assignmentGroup Gruppe, die der Anforderung zugewiesen ist.

    Datentyp: Zeichenfolge
    assignedTo Anwender-E-Mail-Adresse, die der Anforderung zugewiesen ist.

    Datentyp: Zeichenfolge
    CatItem SYS_ID der Katalogelementanforderung.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Katalogelement [sn_CMP_bp_Cat_item]
    Nummer Eindeutige Anforderungselementnummer (RITM), die dem neuen Anforderungselement zugewiesen wird.

    Datentyp: Zeichenfolge

    Tabelle: Anforderungselement [sc_req_item]
    openedAt Zeitstempel ab dem Zeitpunkt, zu dem das Anforderungselement geöffnet wurde.

    Format: jjjj-MM-TT HH:mm:ss.

    Datumstyp: Zeichenfolge
    Geöffnet von SYS_ID des Anwenders, der die Anforderung geöffnet hat.

    Datentyp: Zeichenfolge
    stage Aktuelle Verarbeitungsphase des Anforderungselements.
    Mögliche Werte:
    • Stapel wird bereitgestellt
    • Bereitstellung abgebrochen
    • Fehler bei der Bereitstellung
    • Bereitstellung erfolgreich
    • Ressourcenlimit überschritten
    • Stapelbereitstellung wird erneut versucht
    • Aufgabe für Anwender erstellt
    • Wartet auf Bereitstellungsgenehmigung

    Datentyp: Zeichenfolge
    Status Aktueller Abschlussstatus des Anforderungselements.
    Mögliche Werte:
    • Abgeschlossen
    • Unvollständig geschlossen
    • Als übersprungen geschlossen
    • Offen
    • Ausstehend
    • In Arbeit

    Datentyp: Zeichenfolge
    Übermittlungsdaten Informationen zur Anforderungsübermittlung, z. B. Cloud-Account, Standort, Anwendung und Kostenstellendaten. Die Übermittlungsdaten variieren je nach Anforderungselementnummer, die in der Anforderung übergeben wurde.

    Datentyp: Objekt

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id SYS_ID des Anforderungselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Anforderungselement [sc_req_item]

    Im folgenden Beispiel wird ein Anforderungselement für den Tag 2-Vorgang erstellt.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/submitoprequest?cat_id=e44dcd238731e5101126cbb4dabb3506" /
--request POST\ 
--header 'Accept: application/json' \ 
--user 'username':'password'

//Request body:
{"StackName":"sa02292143","CloudAccount":"AWS","Location":"AWS Datacenter - us-east-1","resourceId":"df8c61e3eb2cc210d298fbbdbad0cd74","operationName":"Deprovision","resourceInterface":"S3 Interface","resourceBlock":"S3"}

    Antworttext:

    { 
  "number": "RITM0010078", 
  "catItem": "e44dcd238731e5101126cbb4dabb3506", 
  "stage": "request_approved", 
  "sys_id": "9bf5cab3c3594610bc89b33605013190", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "openedAt": "2024-04-08 09:08:47", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"StackName\":\"sa02292143\",\"CloudAccount\":\"AWS\",\"Location\":\"AWS Datacenter - us-east-1\",\"resourceId\":\"df8c61e3eb2cc210d298fbbdbad0cd74\",\"operationName\":\"Deprovision\",\"resourceInterface\":\"S3 Interface\",\"resourceBlock\":\"S3\"}" 
} 
 
Sample Request Body for CSC S3 Bucket Catalog Order: 
 
{"StackName":"sa02292143","CloudAccount":"AWS","Location":"AWS Datacenter - us-east-1","resourceId":"df8c61e3eb2cc210d298fbbdbad0cd74","operationName":"Deprovision","resourceInterface":"S3 Interface","resourceBlock":"S3"}

    Cloud-Servicekatalog – POST /now/cmp_catalog_api/submitrequest

    Übermittelt eine Cloud-Services-Anforderung. Diese Methode akzeptiert bereitgestellte Anforderungen für Vorgänge von Tag 2 und Stapel- oder Ressourcenvorgangskatalogelemente.

    URL-Format

    Standard-URL: /api/now/CMP_catalog_api/submitrequest

    Unterstützte Anforderungsparameter

    Tabelle : 37. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 38. Abfrageparameter
    Name Beschreibung
    Cat_ID Erforderlich. sys_ID des aufzurufenden Cloud-Katalogelements. Verfügbar in der Tabelle „Cloud-Katalogelement“ [sn_CMP_bp_Cat_item].

    Datentyp: Zeichenfolge
    Tabelle : 39. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    CloudAccount Erforderlich. Name des Cloud-Accounts, in dem die Anforderung übermittelt werden soll. Account-Namen sind in der Tabelle „Cloud-Account“ [cmdb_ci_CMP_Cloud_Account] verfügbar.

    Datentyp: Zeichenfolge
    Standort Erforderlich. Rechenzentrumsstandort, in dem die Ressource bereitgestellt werden soll. Beispiel: US-West-1 Oder asien-Süd-2 . Dieser Wert muss mit dem Standort des Rechenzentrums des Plattformanbieters des Cloud-Accounts übereinstimmen. Verfügbar in der zugehörigen Tabelle „Rechenzentrum“ [sn_CMP_ca_assc_Datacenter].

    Datentyp: Zeichenfolge
    StackName Erforderlich. Name des Stapels. Der Stapelname ist dynamisch und wird in der Ressourcenverwaltung berücksichtigt.

    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 .

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

    Standard: application/json
    Tabelle : 41. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 42. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktion ist deaktiviert.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    assignmentGroup Gruppe, die der Anforderung zugewiesen ist.

    Datentyp: Zeichenfolge
    assignedTo Anwender-E-Mail-Adresse, die der Anforderung zugewiesen ist.

    Datentyp: Zeichenfolge
    CatItem SYS_ID der Katalogelementanforderung.

    Datentyp: Zeichenfolge

    Tabelle: Cloud-Katalogelement [sn_CMP_bp_Cat_item]
    Nummer Eindeutige Anforderungselementnummer (RITM), die dem neuen Anforderungselement zugewiesen wird.

    Datentyp: Zeichenfolge

    Tabelle: Anforderungselement [sc_req_item]
    openedAt Zeitstempel ab dem Zeitpunkt, zu dem das Anforderungselement geöffnet wurde.

    Format: jjjj-MM-TT HH:mm:ss.

    Datumstyp: Zeichenfolge
    Geöffnet von SYS_ID des Anwenders, der die Anforderung geöffnet hat.

    Datentyp: Zeichenfolge
    stage Aktuelle Verarbeitungsphase des Anforderungselements.
    Mögliche Werte:
    • Stapel wird bereitgestellt
    • Bereitstellung abgebrochen
    • Fehler bei der Bereitstellung
    • Bereitstellung erfolgreich
    • Ressourcenlimit überschritten
    • Stapelbereitstellung wird erneut versucht
    • Aufgabe für Anwender erstellt
    • Wartet auf Bereitstellungsgenehmigung

    Datentyp: Zeichenfolge
    Status Aktueller Abschlussstatus des Anforderungselements.
    Mögliche Werte:
    • Abgeschlossen
    • Unvollständig geschlossen
    • Als übersprungen geschlossen
    • Offen
    • Ausstehend
    • In Arbeit

    Datentyp: Zeichenfolge
    Übermittlungsdaten Informationen zur Anforderungsübermittlung, z. B. Cloud-Account, Standort, Anwendung und Kostenstellendaten. Die Übermittlungsdaten variieren je nach Anforderungselementnummer, die in der Anforderung übergeben wurde.

    Datentyp: Objekt

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id SYS_ID des Anforderungselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Anforderungselement [sc_req_item]

    Das folgende Beispiel sendet eine Cloud-Ressourcenanforderung im AWS Cloud-Account der Instanz.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/submitrequest?cat_id=022e3deec3122910a769f44ed40131b9" /
--request POST \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

//Request body:
{"CloudAccount":"AWS","Location":"us-east-1","StackName":"ss"}

    Antwort:

    { 
  "number": "RITM0010001", 
  "catItem": "022e3deec3122910a769f44ed40131b9", 
  "stage": "check_permissions", 
  "sys_id": "86d34233c3594610bc89b336050131dd", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "openedAt": "2024-04-08 08:59:25", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"CloudAccount\":\"AWS\",\"Location\":\"us-east-1\",\"StackName\":\"ss\"}" 
}