Cloud Services Catalog-API

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 23 Minuten Lesedauer

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

    Diese API ist im Now -Namespace enthalten 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-Paket“ oder „ITOM Cloud Accelerate“.

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

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

    Cloud-Services-Katalog – GET /now/cmp_catalog_api/itemsbyciclass

    Gibt eine Liste von Ressourcenkatalogelementen basierend auf einer bestimmten CI-Klasse (Configuration Item, Konfigurationselement) 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 (Beispiel: „cmdb_ci_vm_instance“). Zu finden im Feld Referenz-CI-Typ in der Tabelle „Konfigurationselement“ [cmdb_ci].

    Datentyp: Zeichenfolge
    display_variables Kennzeichnung, die angibt, ob Katalogelementvariablen aufgelistet werden, 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 auf „ operation_name = Servicenow“ festlegen.

    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 HTTP-Antwortcodesder REST-API.

    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.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    aktiv Der aktive Status des Ressourcenvorgang-Katalogelements.

    Mögliche Werte:

    • wahr: Das Ressourcenvorgang-Katalogelement ist aktiv.
    • „falsch“: Das Ressourcenvorgang-Katalogelement ist inaktiv.

    Datentyp: Zeichenfolge
    created_on Zeitstempel ab dem Zeitpunkt der Erstellung des Ressourcenvorgang-Katalogelements.

    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 Ressourcenvorgang-Katalogelements. Befindet sich in der Tabelle „Ressourcenvorgang-Katalogelement“ [sn_cmp_rsrc_opr_cat_item].

    Datentyp: Zeichenfolge
    name Name des Ressourcenvorgang-Katalogelements. Befindet sich in der Tabelle „Ressourcenvorgang-Katalogelement“ [sn_cmp_rsrc_opr_cat_item].

    Datentyp: Zeichenfolge
    short_description Kurze Beschreibung des Ressourcenvorgang-Katalogelements. Befindet sich in der Tabelle „Ressourcenvorgang-Katalogelement“ [sn_cmp_rsrc_opr_cat_item].

    Datentyp: Zeichenfolge
    updated_on Zeitstempel vom Zeitpunkt der letzten Aktualisierung des Ressourcenvorgang-Katalogelements. 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-Services-Katalog – 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, 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 auf „ operation_name = Servicenow“ festlegen.

    Standard: Alle Katalogelemente aller Vorgangstypen werden zurückgegeben.

    Datentyp: Zeichenfolge
    resource_block Erforderlich Der Name des Ressourcenblocks, von dem die zugehörigen Ressourcenvorgangs-Katalogelemente abgerufen werden sollen (z. B. Virtual Server). Verfügbar in der Tabelle „Ressourcenblock“ [sn_cmp_rb_resourceblock].

    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 : 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 HTTP-Antwortcodesder REST-API.

    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.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    aktiv Der aktive Status des Ressourcenvorgang-Katalogelements.

    Mögliche Werte:

    • wahr: Das Ressourcenvorgang-Katalogelement ist aktiv.
    • „falsch“: Das Ressourcenvorgang-Katalogelement 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 Ressourcenvorgang-Katalogelements. Befindet sich in der Tabelle „Ressourcenvorgang-Katalogelement“ [sn_cmp_rsrc_opr_cat_item].

    Datentyp: Zeichenfolge
    name Name des Ressourcenvorgang-Katalogelements. Befindet sich in der Tabelle „Ressourcenvorgang-Katalogelement“ [sn_cmp_rsrc_opr_cat_item].

    Datentyp: Zeichenfolge
    short_description Kurze Beschreibung des Ressourcenvorgang-Katalogelements. Befindet sich in der Tabelle „Ressourcenvorgang-Katalogelement“ [sn_cmp_rsrc_opr_cat_item].

    Datentyp: Zeichenfolge
    variables Liste mit zusätzlichen Details zum Ressourcenkatalogelement. Die in dieser API zurückgegebenen Variablen variieren je nach den übergebenen Abfrageparametern.

    Datentyp: Array von Objekten

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

    Diese Beispielliste von Ressourcenkatalogelementen basiert 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-Services-Katalog – GET /now/cmp_catalog_api/services

    Gibt eine Liste von Katalogelementen basierend auf dem angegebenen Blueprint eines Katalogtyps „Bereitstellung“ oder „Lebenszyklus“ 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 Typ Blueprint zurück.
    • Lebenszyklus : Gibt alle Katalogelemente des Vorgangstyps Tag 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, 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 einen Teil oder den gesamten Blueprint-Namen abfragen. Wenn Sie beispielsweise alle Blueprints auflisten möchten, die mit „ServiceNow“ beginnen, können Sie die Variable als Blueprint_Name = ServiceNow festlegen.

    Standard: Es werden alle Services aller Blueprints 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 HTTP-Antwortcodesder REST-API.

    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.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    aktiv Kennzeichnung, die angibt, ob der Katalog aktiv ist.
    Mögliche Werte:
    • wahr: Katalog ist aktiv.
    • „falsch“: Der Katalog ist nicht aktiv.

    Datentyp: Zeichenfolge
    Blaupause sys_id des Blueprints Befindet sich in der Blueprint-Tabelle [sn_cmp_bp_Blueprint].

    Datentyp: Zeichenfolge
    Blueprint_category sys_id der Blueprint-Kategorie Befindet sich in der Tabelle „Cloud-Servicekategorie“ [sn_capi_service_category].

    Datentyp: Zeichenfolge
    Blueprint_Kategorie_Name Name der Blueprint-Kategorie. Befindet sich in der Tabelle „Cloud-Servicekategorie“ [sn_capi_service_category].
    Mögliche Werte:
    • Zugriff
    • Analytics
    • Anwendungsservices
    • Blockchain
    • Geschäftliche Produktivität
    • Compute
    • Konfigurationsverwaltung
    • Container
    • Datenbank
    • Entwicklertools
    • Ereignis
    • Hybrid Cloud
    • IOT
    • IPAM
    • Lauter Ausgleicher
    • Machine Learning
    • Verwaltungstools
    • Marktplatz
    • Mobil
    • Netzwerk
    • Produktivität
    • Sicherheit
    • Shell-Zugriff
    • Speicher
    • Tools
    • Unbekannt
    • Virtuelle Realität

    Datentyp: Zeichenfolge
    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: Benutzerdefinierter Plan

    Datentyp: Zeichenfolge
    catalog_name Name des Katalogs. Befindet sich in der Tabelle „Cloud-Katalogelement“ [sn_cmp_bp_cat_item].

    Datentyp: Zeichenfolge
    catalog_type Der Typ des Katalogs. Mögliche Werte:
    • 1: Katalog weist den Typ „Bereitstellung“ auf.
    • 2: Katalog ist vom Typ „Lebenszyklus“.

    Datentyp: Zeichenfolge
    catalog_type Der Typ des Katalogs. Mögliche Werte:
    • 1: Katalog weist den Typ „Bereitstellung“ auf.
    • 2: Katalog ist vom Typ „Lebenszyklus“.

    Datentyp: Zeichenfolge
    createdOn Zeitstempel ab Erstellungsdatum des Katalogelements.

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

    Datentyp: Zeichenfolge
    id sys_id des Blueprints Befindet sich in der Tabelle „Cloud-Katalogelement“ [sn_cmp_bp_cat_item].

    Datentyp: Zeichenfolge
    last_updated_on Zeitstempel vom Zeitpunkt der letzten Aktualisierung des Katalogelements.

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

    Datentyp: Zeichenfolge
    operation sys_id des Vorgangs Verfügbar in der Tabelle „OperationSignature“ [sn_cmp_rb_op_signature].
    operational_name Name des Vorgangs Mögliche Werte:
    • Starten: Startet die Ressourcen, die sich im Status „Aus“ befinden.
    • Stoppen: Stoppt die Ressourcen, die sich im Status „Ein“ befinden.
    • ModifySchedule: Ändert den Zeitplan für bereitgestellte Ressourcen.
    • Bereitstellung aufheben: Löscht Ressourcen mit dem Status „Beendet“ und aktualisiert die CMDB-Tabellen der Ressourcen entsprechend.
    • ModifyLease: Ändert den Leasingvorgang, der für bereitgestellte Ressourcen geplant ist.

    Datentyp: Zeichenfolge
    variables Ein Objekt mit zusätzlichen Details zum Listenkatalogelement. Die in dieser API zurückgegebenen Variablen variieren je nach den Abfrageparametern, die in der Anforderung übergeben werden.

    Datentyp: Objekt

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

    In diesem Beispiel werden alle Katalogelemente eines Lebenszyklustyp-Blueprints mit dem Namen „classiclb“ zurückgegeben.

    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-Services-Katalog – GET /now/cmp_catalog_api/stacks

    Gibt eine Liste von Katalogelementen basierend auf Blueprints vom Typ „Bereitstellung“ zurück (auch als Stapel bezeichnet).

    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 einen Teil oder den gesamten Blueprint-Namen abfragen. Wenn Sie beispielsweise alle Blueprints auflisten möchten, die mit „ServiceNow“ beginnen, können Sie die Variable als Blueprint_Name = ServiceNow festlegen.

    Standard: Es werden alle Services aller Blueprints zurückgegeben.

    Datentyp: Zeichenfolge
    display_variables Kennzeichnung, die angibt, ob Katalogelementvariablen aufgelistet werden, 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 HTTP-Antwortcodesder REST-API.

    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.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    aktiv Kennzeichnung, die angibt, ob der Katalog aktiv ist.
    Mögliche Werte:
    • wahr: Katalog ist aktiv.
    • „falsch“: Der Katalog ist nicht aktiv.

    Datentyp: Zeichenfolge
    Blaupause sys_id des Blueprints Befindet sich in der Blueprint-Tabelle [sn_cmp_bp_Blueprint].

    Datentyp: Zeichenfolge
    Blueprint_category sys_id der Blueprint-Kategorie Befindet sich in der Tabelle „Cloud-Servicekategorie“ [sn_capi_service_category].

    Datentyp: Zeichenfolge
    Blueprint_Kategorie_Name Name der Blueprint-Kategorie. Befindet sich in der Tabelle „Cloud-Servicekategorie“ [sn_capi_service_category].
    Mögliche Werte:
    • Zugriff
    • Analytics
    • Anwendungsservices
    • Blockchain
    • Geschäftliche Produktivität
    • Compute
    • Konfigurationsverwaltung
    • Container
    • Datenbank
    • Entwicklertools
    • Ereignis
    • Hybrid Cloud
    • IOT
    • IPAM
    • Lauter Ausgleicher
    • Machine Learning
    • Verwaltungstools
    • Marktplatz
    • Mobil
    • Netzwerk
    • Produktivität
    • Sicherheit
    • Shell-Zugriff
    • Speicher
    • Tools
    • Unbekannt
    • Virtuelle Realität

    Datentyp: Zeichenfolge
    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: Benutzerdefinierter Plan

    Datentyp: Zeichenfolge
    catalog_name Name des Katalogs. Befindet sich in der Tabelle „Cloud-Katalogelement“ [sn_cmp_bp_cat_item].

    Datentyp: Zeichenfolge
    catalog_type Der Typ des Katalogs. Mögliche Werte:
    • 1: Katalog weist den Typ „Bereitstellung“ auf.
    • 2: Katalog ist vom Typ „Lebenszyklus“.

    Datentyp: Zeichenfolge
    catalog_type_name Der Name des Katalogtyps. Mögliche Werte:
    • Bereitstellungsvorgang (Tag 1): Der Katalogtyp wird als „Bereitstellung“ bezeichnet.
    • LifeCycle-Vorgang (Tag 2): Der Katalogtyp wird als Lebenszyklus bezeichnet.

    Datentyp: Zeichenfolge
    id sys_id des Blueprints Befindet sich in der Tabelle „Cloud-Katalogelement“ [sn_cmp_bp_cat_item].

    Datentyp: Zeichenfolge
    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 Verfügbar in der Tabelle „OperationSignature“ [sn_cmp_rb_op_signature].
    lifeCycleOperations.name Typ der Lebenszyklusvorgänge. Mögliche Werte:
    1. Bereitstellung aufheben: Löscht Ressourcen im Status „Beendet“ und aktualisiert die CMDB-Tabellen der Ressourcen entsprechend.
    2. ModifySchedule: Führt eine Geschäftszeitplanung für Stapel zum Zeitpunkt der Bereitstellung oder für vorhandene Stapel durch.
    3. Stoppen: Stoppt die Ressourcen, die sich im Status „Ein“ befinden.
    4. Bereinigung: Bereinigt Ressourcen mit einem Status „Beendet“.
    5. ModifyLease: Ändert den Leasingvorgang, der für bereitgestellte Ressourcen geplant ist.
    6. Starten: Startet die Ressourcen, die sich im Status „Aus“ befinden.

    Datumstyp: Objekt
    operation sys_id des Vorgangs Verfügbar in der Tabelle „OperationSignature“ [sn_cmp_rb_op_signature].
    operational_name Name des Vorgangs Mögliche Werte:
    • Starten: Startet die Ressourcen, die sich im Status „Aus“ befinden.
    • Stoppen: Stoppt die Ressourcen, die sich im Status „Ein“ befinden.
    • ModifySchedule: Ändert den Zeitplan für bereitgestellte Ressourcen.
    • Bereitstellung aufheben: Löscht Ressourcen mit dem Status „Beendet“ und aktualisiert die CMDB-Tabellen der Ressourcen entsprechend.
    • ModifyLease: Ändert den Leasingvorgang, der für bereitgestellte Ressourcen geplant ist.

    Datentyp: Zeichenfolge
    shortDescription Eine kurze Beschreibung des Katalogs.

    Datentyp: Zeichenfolge
    template_name Name der Vorlage. Verfügbar in der Tabelle „Cloud-Katalogelement“ [sn_cmp_bp_cat_item].

    Datentyp: Zeichenfolge
    template_type sys_id des Vorlagentyps. Verfügbar in der Tabelle „Cloud-Katalogelement“ [sn_cmp_bp_cat_item].

    Datentyp: Zeichenfolge
    template_cloud_product_name Name des Produkts. Verfügbar in der Tabelle „Cloud-Katalogelement“ [sn_cmp_bp_cat_item].

    Datentyp: Zeichenfolge
    variables Ein Objekt mit zusätzlichen Details zum Listenkatalogelement. Die in dieser API zurückgegebenen Variablen variieren je nach den Abfrageparametern, die in der Anforderung übergeben werden.

    Datentyp: Objekt

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

    Im folgenden Beispiel werden alle Katalogelemente in der -Instanz mit dem Katalogtyp „Bereitstellung“ zurückgegeben.

    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-Services-Katalog – 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 und 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 Benutzer, die geöffnet haben und denen die Anforderung zugewiesen ist
    4. Die der Anforderung zugewiesene Gruppe
    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 Nummer des Anforderungselements 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 HTTP-Antwortcodesder REST-API.

    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.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    assignmentGroup Die der Anforderung zugewiesene Gruppe

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

    Datentyp: Zeichenfolge
    Katalogelement sys_id der Katalogelementanforderung. Befindet sich in der Tabelle „Cloud-Katalogelement“ [sn_cmp_bp_cat_item].

    Datentyp: Zeichenfolge
    Fehler Eine Meldung 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 Die eindeutige Anforderungselementnummer (RITM), die dem neuen Anforderungselement zugewiesen wurde. Befindet sich in der Tabelle „Anforderungselement“ [sc_req_item].

    Datentyp: Zeichenfolge
    openedAt Zeitstempel vom Zeitpunkt des Öffnens des Anforderungselements.

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

    Datumstyp: Zeichenfolge
    openedBy sys_id des Anwenders, der die Anforderung geöffnet hat.

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

    Datentyp: Zeichenfolge
    Staat Der aktuelle Abschlussstatus des Anforderungselements.
    Mögliche Werte:
    • Offen
    • In Bearbeitung
    • Abgeschlossen
    • Unvollständig geschlossen
    • Als übersprungen geschlossen
    • Ausstehend

    Datentyp: Zeichenfolge
    Übermittlungsdaten Informationen über die Anforderungsübermittlung, wie Cloud-Account, Standort, Anwendung und Kostenstellendaten. Die Übermittlungsdaten variieren je nach der in der Anforderung übergebenen Anforderungselementnummer.

    Datentyp: Objekt

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id sys_id des Anforderungselementdatensatzes. Befindet sich in der Tabelle „Anforderungselement“ [sc_req_item].

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im folgenden Beispiel werden Statusinformationen für das Anforderungselement Nummer RITM0010076 zurückgegeben.

    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-Services-Katalog – POST /now/cmp_catalog_api/submitoprequest

    Sendet eine Ressourcenvorgangsanforderung, um Tag-2-Vorgänge für bereitgestellte Ressourcen durchzufü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
    chat_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. Accountnamen 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. Zum Beispiel us-west-1 oder asia-south-2. Dieser Wert muss mit dem Rechenzentrumsstandort des Plattformanbieters des Cloud-Accounts übereinstimmen. Verfügbar in der Tabelle „Zugeordnete Rechenzentren“ [sn_cmp_ca_assc_datacenter].

    Datentyp: Zeichenfolge
    StackName Erforderlich. Name des Stapels. Der Stapelname ist dynamisch und spiegelt sich in der Ressourcenverwaltung wider.

    Datentyp: Zeichenfolge
    resourceId Erforderlich. Die sys_id der Ressource, in der Tag-2-Vorgänge durchgeführt werden. Befindet sich in der Tabelle „Stapelelemente“ [sn_cmp_stack_item].
    resource_block Erforderlich Der Name des Ressourcenblocks, von dem die zugehörigen Ressourcenvorgangs-Katalogelemente abgerufen werden sollen (z. B. Virtual Server). Verfügbar in der Tabelle „Ressourcenblock“ [sn_cmp_rb_resourceblock].

    Standard: Alle Katalogelemente aller Vorgangstypen werden zurückgegeben.

    Datentyp: Zeichenfolge
    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 von dem im Parameter resourceBlock übergebenen Wert ab.
    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 auf „ operation_name = Servicenow“ festlegen.
    Standard: Alle Katalogelemente aller Vorgangstypen werden zurückgegeben.Datentyp: Zeichenfolge
    resourceInterface Erforderlich Der Name des Ressourcenblocks, von dem die zugehörigen Ressourcenvorgangs-Katalogelemente abgerufen werden sollen (z. B. Virtual Server). Verfügbar in der Tabelle „Ressourcenblock“ [sn_cmp_rb_resourceblock]. Die von Ihnen eingegebene Ressourcenschnittstelle hängt von dem Wert ab, der in den Parametern resourceBlock und operation_name übergeben wird.

    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 HTTP-Antwortcodesder REST-API.

    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.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    assignmentGroup Die der Anforderung zugewiesene Gruppe

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

    Datentyp: Zeichenfolge
    Katalogelement sys_id der Katalogelementanforderung. Befindet sich in der Tabelle „Cloud-Katalogelement“ [sn_cmp_bp_cat_item].

    Datentyp: Zeichenfolge
    Nummer Die eindeutige Anforderungselementnummer (RITM), die dem neuen Anforderungselement zugewiesen wurde. Befindet sich in der Tabelle „Anforderungselement“ [sc_req_item].

    Datentyp: Zeichenfolge
    openedAt Zeitstempel vom Zeitpunkt des Öffnens des Anforderungselements.

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

    Datumstyp: Zeichenfolge
    openedBy sys_id des Anwenders, der die Anforderung geöffnet hat.

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

    Datentyp: Zeichenfolge
    Staat Der aktuelle Abschlussstatus des Anforderungselements.
    Mögliche Werte:
    • Offen
    • In Bearbeitung
    • Abgeschlossen
    • Unvollständig geschlossen
    • Als übersprungen geschlossen
    • Ausstehend

    Datentyp: Zeichenfolge
    Übermittlungsdaten Informationen über die Anforderungsübermittlung, wie Cloud-Account, Standort, Anwendung und Kostenstellendaten. Die Übermittlungsdaten variieren je nach der in der Anforderung übergebenen Anforderungselementnummer.

    Datentyp: Objekt

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id sys_id des Anforderungselementdatensatzes. Befindet sich in der Tabelle „Anforderungselement“ [sc_req_item].

    Datentyp: Zeichenfolge

    Im folgenden Beispiel wird ein Tag-2-Vorgangsanforderungselement 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-Services-Katalog – POST /now/cmp_catalog_api/submitrequest

    Sendet eine Cloud-Serviceanfrage. Diese Methode akzeptiert bereitgestellte Anforderungen für Tag-2-Vorgänge und Stapel oder Ressourcenvorgang-Katalogelemente.

    URL-Format

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

    Unterstützte Anforderungsparameter

    Tabelle : 37. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 38. Abfrageparameter
    Name Beschreibung
    chat_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. Accountnamen 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. Zum Beispiel us-west-1 oder asia-south-2. Dieser Wert muss mit dem Rechenzentrumsstandort des Plattformanbieters des Cloud-Accounts übereinstimmen. Verfügbar in der Tabelle „Zugeordnete Rechenzentren“ [sn_cmp_ca_assc_datacenter].

    Datentyp: Zeichenfolge
    StackName Erforderlich. Name des Stapels. Der Stapelname ist dynamisch und spiegelt sich in der Ressourcenverwaltung wider.

    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 HTTP-Antwortcodesder REST-API.

    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.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    assignmentGroup Die der Anforderung zugewiesene Gruppe

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

    Datentyp: Zeichenfolge
    Katalogelement sys_id der Katalogelementanforderung. Befindet sich in der Tabelle „Cloud-Katalogelement“ [sn_cmp_bp_cat_item].

    Datentyp: Zeichenfolge
    Nummer Die eindeutige Anforderungselementnummer (RITM), die dem neuen Anforderungselement zugewiesen wurde. Befindet sich in der Tabelle „Anforderungselement“ [sc_req_item].

    Datentyp: Zeichenfolge
    openedAt Zeitstempel vom Zeitpunkt des Öffnens des Anforderungselements.

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

    Datumstyp: Zeichenfolge
    openedBy sys_id des Anwenders, der die Anforderung geöffnet hat.

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

    Datentyp: Zeichenfolge
    Staat Der aktuelle Abschlussstatus des Anforderungselements.
    Mögliche Werte:
    • Offen
    • In Bearbeitung
    • Abgeschlossen
    • Unvollständig geschlossen
    • Als übersprungen geschlossen
    • Ausstehend

    Datentyp: Zeichenfolge
    Übermittlungsdaten Informationen über die Anforderungsübermittlung, wie Cloud-Account, Standort, Anwendung und Kostenstellendaten. Die Übermittlungsdaten variieren je nach der in der Anforderung übergebenen Anforderungselementnummer.

    Datentyp: Objekt

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id sys_id des Anforderungselementdatensatzes. Befindet sich in der Tabelle „Anforderungselement“ [sc_req_item].

    Datentyp: Zeichenfolge

    Im folgenden Beispiel wird eine Cloud-Ressourcenanforderung im AWS Cloud-Konto der -Instanz übermittelt.

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