クラウドサービスカタログ API

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：58分

    • クラウドサービスカタログ API は、クラウドサービススタックの作成やリソース操作要求の呼び出しなど、クラウドサービスカタログで利用可能な 1 日目 (プロビジョニング) および 2 日目 (変更) の操作に関連するメソッドを提供します。また、カタログ要求に関する情報、スタック取得ステータス、およびその他の情報を取得することもできます。

    この API は now 名前空間に含まれており、sn_cmp.cloud_service_user ロールが必要です。Cloud Services Catalog (CSC) アプリケーションは別のサブスクリプションとして利用でき、ITOM Enterprise バンドルまたは ITOM クラウドアクセラレート製品エンタイトルメントが必要です。

    クラウドサービスカタログ API は、Day 2 の操作中に実行するアクションを特徴としています。この API のコンテキストでは、リソースカタログアイテムは 2 日目の操作に関連するカタログアイテムを参照します。

    この API を使用するには、クラウドサービスカタログのガイド付きセットアッププロセスを完了していること、または UI でプロビジョニングとカタログ操作が機能する構成が機能していることを確認してください。これらの手順の詳細については、「 Cloud Services Catalog」を参照してください。

    クラウドサービスカタログ - GET /now/cmp_catalog_api/itemsbyciclass

    指定された構成アイテム (CI) クラスに基づいて、リソースカタログアイテムのリストを返します。

    URL 形式

    デフォルト URL: /api/now/cmp_catalog_api/itemsbyciclass

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    名前 説明
    なし
    表 : 2. クエリパラメータ
    名前 説明
    ci_class 必須。リソースカタログアイテムを取得する CI クラスの名前 (「cmdb_ci_vm_instance」など)。構成アイテム [cmdb_ci] テーブルの [参照 CI タイプ] フィールドにあります。

    データタイプ：文字列
    display_variables 各カタログアイテムに関連付けられたカタログアイテム変数をリストするかどうかを示すフラグ。
    有効な値：
    • true:リストカタログアイテム変数を表示します。
    • false:リストカタログアイテム変数を表示しません。

    データタイプ：ブーリアン

    デフォルト：False
    operation_name オプション。操作の名前。OperationSignature [sn_cmp_rb_op_signature] テーブルのリソース インターフェイスの Name 列にあります。
    注:
    このパラメーターは、操作の一部または全体を照会できます。たとえば、「Servicenow」で始まるすべてのインターフェイスを一覧表示する場合は、変数を operation_name = Servicenow として設定できます。

    デフォルト:すべての操作タイプのすべてのカタログアイテムが返されます。

    データタイプ：文字列
    resource_interface オプション。リソースカタログアイテムがホストされているリソースインターフェイス。ResourceInterfaces [sn_cmp_rb_resourceinterface] テーブルの Name 列にあります。

    データタイプ：文字列
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    403 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
    404 見つかりません。要求アイテムが見つかりませんでした。
    405 無効なメソッドです。この機能は無効です。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    active リソース運用カタログアイテムのアクティブ状況。

    可能な値：

    • true:リソース運用カタログアイテムがアクティブです。
    • false:リソース運用カタログアイテムは非アクティブです。

    データタイプ：文字列
    created_on リソース運用カタログアイテムが作成されたときのタイムスタンプ。

    形式:yyyy-MM-dd HH:mm:ss。

    データタイプ：文字列
    display_name リソースインターフェイスの名前。ResourceInterfaces [sn_cmp_rb_resourceinterface] テーブルにあります。

    データタイプ：文字列
    id リソース運用カタログアイテムのSys_id。リソース運用カタログアイテム [sn_cmp_rsrc_opr_cat_item] テーブルにあります。

    データタイプ：文字列
    name リソース運用カタログアイテムの名前。リソース運用カタログアイテム [sn_cmp_rsrc_opr_cat_item] テーブルにあります。

    データタイプ：文字列
    short_description リソース運用カタログアイテムの簡単な説明。リソース運用カタログアイテム [sn_cmp_rsrc_opr_cat_item] テーブルにあります。

    データタイプ：文字列
    updated_on リソース運用カタログアイテムが最後に更新された時点のタイムスタンプ。必要な形式:yyyy-MM-dd HH:mm:ss

    データタイプ：文字列

    cURL 要求

    次の例では、要求アイテムのステータスを要求して返します。

    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'

    応答：

    [
  {
    "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
  }
]

    クラウドサービスカタログ - GET /now/cmp_catalog_api/itemsbyrb

    指定されたリソースブロックに基づいてリソースカタログアイテムのリストを返します。

    URL 形式

    デフォルト URL: /api/now/cmp_catalog_api/itemsbyrb

    サポートされている要求パラメーター

    表 : 7. パスパラメーター
    名前 説明
    なし
    表 : 8. クエリパラメータ
    名前 説明
    display_variables 各カタログアイテムに関連付けられたカタログアイテム変数をリストするかどうかを示すフラグ。
    有効な値：
    • true:リストカタログアイテム変数を表示します。
    • false:リストカタログアイテム変数を表示しません。

    データタイプ：ブーリアン

    デフォルト：False
    operation_name オプション。操作の名前。OperationSignature [sn_cmp_rb_op_signature] テーブルのリソース インターフェイスの Name 列にあります。
    注:
    このパラメーターは、操作の一部または全体を照会できます。たとえば、「Servicenow」で始まるすべてのインターフェイスを一覧表示する場合は、変数を operation_name = Servicenow として設定できます。

    デフォルト:すべての操作タイプのすべてのカタログアイテムが返されます。

    データタイプ：文字列
    resource_block 必須です。関連するリソース運用カタログアイテムを取得するリソースブロックの名前 (仮想サーバーなど)。リソースブロック [sn_cmp_rb_resourceblock] テーブルで利用可能です。

    デフォルト:すべての操作タイプのすべてのカタログアイテムが返されます。

    データタイプ：文字列
    resource_interface オプション。リソースカタログアイテムがホストされているリソースインターフェイス。ResourceInterfaces [sn_cmp_rb_resourceinterface] テーブルの Name 列にあります。

    データタイプ：文字列
    表 : 9. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    403 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
    404 見つかりません。要求アイテムが見つかりませんでした。
    405 無効なメソッドです。この機能は無効です。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 Description (説明)
    active リソース運用カタログアイテムのアクティブ状況。

    可能な値：

    • true:リソース運用カタログアイテムがアクティブです。
    • false:リソース運用カタログアイテムは非アクティブです。

    データタイプ：文字列
    display_name リソースインターフェイスの名前。ResourceInterfaces [sn_cmp_rb_resourceinterface] テーブルにあります。

    データタイプ：文字列
    id リソース運用カタログアイテムのSys_id。リソース運用カタログアイテム [sn_cmp_rsrc_opr_cat_item] テーブルにあります。

    データタイプ：文字列
    name リソース運用カタログアイテムの名前。リソース運用カタログアイテム [sn_cmp_rsrc_opr_cat_item] テーブルにあります。

    データタイプ：文字列
    short_description リソース運用カタログアイテムの簡単な説明。リソース運用カタログアイテム [sn_cmp_rsrc_opr_cat_item] テーブルにあります。

    データタイプ：文字列
    変数 リソースカタログアイテムに関するその他の詳細のリスト。この API で返される変数は、渡されたクエリパラメーターによって異なります。

    データタイプ:オブジェクトのアレイ

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

    次の例は、仮想サーバーリソースブロックに基づくリソースカタログアイテムのリストです。

    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'

    応答：

    [
  {
    "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
  }
]

    クラウドサービスカタログ - GET /now/cmp_catalog_api/services

    プロビジョンまたはライフサイクルカタログタイプの指定された詳細計画に基づいて、カタログアイテムのリストを返します。

    URL 形式

    デフォルト URL: /api/now/cmp_catalog_api/services

    サポートされている要求パラメーター

    表 : 13. パスパラメーター
    名前 説明
    なし
    表 : 14. クエリパラメータ
    名前 Description (説明)
    catalog_type オプション。カタログアイテムのタイプ。指定できる値 (大文字と小文字を区別):
    • プロビジョン: すべての詳細計画タイプのカタログアイテムを返します。
    • ライフサイクル :操作タイプ 2 のすべてのカタログアイテムを返します。

    入力が空 (デフォルト) の場合、両方のカタログタイプのすべてのサービスが返されます。

    データタイプ：文字列
    display_variables 各カタログアイテムに関連付けられたカタログアイテム変数をリストするかどうかを示すフラグ。
    有効な値：
    • true:リストカタログアイテム変数を表示します。
    • false:リストカタログアイテム変数を表示しません。

    データタイプ：ブーリアン

    デフォルト：False
    blueprint_name オプション。関連カタログアイテムをフェッチする詳細計画の名前。カテゴリアイテム [sn_cmp_bp_cat_item] テーブルにあります。
    注:
    このパラメーターは、詳細計画名の一部または全部を照会できます。たとえば、「Servicenow」で始まるすべての詳細計画を一覧表示する場合は、変数を blueprint_name = Servicenow として設定できます。

    デフォルト:すべてのブループリントのすべてのサービスが返されます。

    データタイプ：文字列
    表 : 15. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 16. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    403 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
    404 見つかりません。要求アイテムが見つかりませんでした。
    405 無効なメソッドです。この機能は無効です。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 Description (説明)
    active カタログがアクティブかどうかを示すフラグ。
    可能な値：
    • true:カタログはアクティブです。
    • false:カタログはアクティブではありません。

    データタイプ：文字列
    詳細計画 ブループリントのsys_id。詳細計画 [sn_cmp_bp_blueprint] テーブルにあります。

    データタイプ：文字列
    blueprint_category 詳細計画カテゴリのsys_id。クラウドサービスカテゴリ [sn_capi_service_category] テーブルにあります。

    データタイプ：文字列
    blueprint_category_name 詳細計画カテゴリの名前。クラウドサービスカテゴリ [sn_capi_service_category] テーブルにあります。
    可能な値：
    • アクセス
    • 分析
    • アプリケーションサービス
    • ブロックチェーン
    • ビジネスの生産性
    • 計算
    • 設定管理
    • コンテナ
    • データベース
    • 開発ツール
    • イベント
    • ハイブリッドクラウド
    • IOT (アイオット)
    • IPAM
    • ラウドバランサー
    • 機械学習
    • 管理ツール
    • マーケットプレイス
    • モバイル
    • ネットワーク
    • 生産性
    • セキュリティ
    • シェルアクセス
    • ストレージ
    • ツール
    • 不明
    • バーチャルリアリティ

    データタイプ：文字列
    blueprint_name 詳細計画の名前。詳細計画 [sn_cmp_bp_blueprint] テーブルにあります。

    データタイプ：文字列
    blueprint_type 詳細計画のタイプ。

    可能な値: カスタムブループリント

    データタイプ：文字列
    catalog_name カタログの名。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルにあります。

    データタイプ：文字列
    catalog_type カタログのタイプ。可能な値：
    • 1:カタログのタイプはプロビジョンです。
    • 2:カタログのタイプがライフサイクルである。

    データタイプ：文字列
    catalog_type カタログのタイプ。可能な値：
    • 1:カタログのタイプはプロビジョンです。
    • 2:カタログのタイプがライフサイクルである。

    データタイプ：文字列
    createdOn カタログアイテムが作成されたときのタイムスタンプ。

    データタイプ：文字列
    createdBy カタログアイテムを作成したユーザー。

    データタイプ：文字列
    id ブループリントのsys_id。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルにあります。

    データタイプ：文字列
    last_updated_on カタログアイテムが最後に更新された時点のタイムスタンプ。

    データタイプ：文字列
    last_updated_by 管理者やシステムなど、カタログアイテムを最後に更新したユーザー。

    データタイプ：文字列
    operation 操作のsys_id。OperationSignature [sn_cmp_rb_op_signature] テーブルで使用できます。
    operation_name 操作の名前。可能な値：
    • 開始:オフ状態のリソースを開始します。
    • 停止:オン状態のリソースを停止します。
    • ModifySchedule:プロビジョニングされたリソースのスケジュールを変更します。
    • プロビジョニング解除:終了ステータスのリソースを削除し、それに応じてリソース CMDB テーブルを更新します。
    • ModifyLease:プロビジョニングされたリソースでスケジュールされたリース操作を変更します。

    データタイプ：文字列
    変数 リストカタログアイテムに関する追加情報を含むオブジェクト。この API で返される変数は、要求で渡されるクエリパラメーターによって異なります。

    データタイプ: オブジェクト

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

    この例では、「classiclb」という名前のライフサイクルタイプ詳細計画のすべてのカタログアイテムを返します。

    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'

    応答：

    [
  {
    "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"
  }
]

    クラウドサービスカタログ - GET /now/cmp_catalog_api/stacks

    プロビジョンタイプの詳細計画 (スタックとも呼ばれる) に基づいてカタログアイテムのリストを返します。

    URL 形式

    デフォルト URL: /api/now/cmp_catalog_api/stacks

    サポートされている要求パラメーター

    表 : 19. パスパラメーター
    名前 説明
    なし
    表 : 20. クエリパラメータ
    名前 説明
    blueprint_name オプション。関連カタログアイテムをフェッチする詳細計画の名前。カテゴリアイテム [sn_cmp_bp_cat_item] テーブルにあります。
    注:
    このパラメーターは、詳細計画名の一部または全部を照会できます。たとえば、「Servicenow」で始まるすべての詳細計画を一覧表示する場合は、変数を blueprint_name = Servicenow として設定できます。

    デフォルト:すべてのブループリントのすべてのサービスが返されます。

    データタイプ：文字列
    display_variables 各カタログアイテムに関連付けられたカタログアイテム変数をリストするかどうかを示すフラグ。
    有効な値：
    • true:リストカタログアイテム変数を表示します。
    • false:リストカタログアイテム変数を表示しません。

    データタイプ：ブーリアン

    デフォルト：False
    表 : 21. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 22. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    403 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
    404 見つかりません。要求アイテムが見つかりませんでした。
    405 無効なメソッドです。この機能は無効です。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 Description (説明)
    active カタログがアクティブかどうかを示すフラグ。
    可能な値：
    • true:カタログはアクティブです。
    • false:カタログはアクティブではありません。

    データタイプ：文字列
    詳細計画 ブループリントのsys_id。詳細計画 [sn_cmp_bp_blueprint] テーブルにあります。

    データタイプ：文字列
    blueprint_category 詳細計画カテゴリのsys_id。クラウドサービスカテゴリ [sn_capi_service_category] テーブルにあります。

    データタイプ：文字列
    blueprint_category_name 詳細計画カテゴリの名前。クラウドサービスカテゴリ [sn_capi_service_category] テーブルにあります。
    可能な値：
    • アクセス
    • 分析
    • アプリケーションサービス
    • ブロックチェーン
    • ビジネスの生産性
    • 計算
    • 設定管理
    • コンテナ
    • データベース
    • 開発ツール
    • イベント
    • ハイブリッドクラウド
    • IOT (アイオット)
    • IPAM
    • ラウドバランサー
    • 機械学習
    • 管理ツール
    • マーケットプレイス
    • モバイル
    • ネットワーク
    • 生産性
    • セキュリティ
    • シェルアクセス
    • ストレージ
    • ツール
    • 不明
    • バーチャルリアリティ

    データタイプ：文字列
    blueprint_name 詳細計画の名前。詳細計画 [sn_cmp_bp_blueprint] テーブルにあります。

    データタイプ：文字列
    blueprint_type 詳細計画のタイプ。

    可能な値: カスタムブループリント

    データタイプ：文字列
    catalog_name カタログの名。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルにあります。

    データタイプ：文字列
    catalog_type カタログのタイプ。可能な値：
    • 1:カタログのタイプはプロビジョンです。
    • 2:カタログのタイプがライフサイクルである。

    データタイプ：文字列
    catalog_type_name カタログタイプの名前。可能な値：
    • プロビジョニング操作 (Day 1):カタログタイプの名前は「プロビジョン」です。
    • ライフサイクル操作 (2 日目):カタログタイプの名前はライフサイクルです。

    データタイプ：文字列
    id ブループリントのsys_id。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルにあります。

    データタイプ：文字列
    ライフサイクル操作 ライフサイクル操作の名前とsys_idを含むオブジェクト。

    日付タイプ:オブジェクトのアレイ

    "lifecycleOperations": [
      {
        "id": "String",
        "name": "String"
      }
    lifecycleOperations.id ライフサイクル操作のsys_id。OperationSignature [sn_cmp_rb_op_signature] テーブルで使用できます。
    lifeCycleOperations.name ライフサイクル操作のタイプ。可能な値：
    1. プロビジョニング解除:終了ステータスのリソースを削除し、それに応じてリソースの CMDB テーブルを更新します。
    2. ModifySchedule:プロビジョニング時のスタックまたは既存のスタックで営業時間のスケジューリングを実行します。
    3. 停止:オン状態のリソースを停止します。
    4. クリーンアップ:終了状態のリソースをクリーンアップします。
    5. ModifyLease:プロビジョニングされたリソースでスケジュールされたリース操作を変更します。
    6. 開始:オフ状態のリソースを開始します。

    日付タイプ:オブジェクト
    operation 操作のsys_id。OperationSignature [sn_cmp_rb_op_signature] テーブルで使用できます。
    operation_name 操作の名前。可能な値：
    • 開始:オフ状態のリソースを開始します。
    • 停止:オン状態のリソースを停止します。
    • ModifySchedule:プロビジョニングされたリソースのスケジュールを変更します。
    • プロビジョニング解除:終了ステータスのリソースを削除し、それに応じてリソース CMDB テーブルを更新します。
    • ModifyLease:プロビジョニングされたリソースでスケジュールされたリース操作を変更します。

    データタイプ：文字列
    shortDescription カタログの簡単な説明。

    データタイプ：文字列
    template_name テンプレートの名前。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルで利用可能です。

    データタイプ：文字列
    template_type テンプレートタイプのsys_id。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルで利用可能です。

    データタイプ：文字列
    template_cloud_product_name 製品の名前。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルで利用可能です。

    データタイプ：文字列
    変数 リストカタログアイテムに関する追加情報を含むオブジェクト。この API で返される変数は、要求で渡されるクエリパラメーターによって異なります。

    データタイプ: オブジェクト

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

    次の例では、プロビジョンカタログタイプのインスタンス内のすべてのカタログアイテムを返します。

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

    帰る：

    [
  {
    "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"
  }
]

    クラウドサービスカタログ - GET /now/cmp_catalog_api/status

    指定されたカタログ RITM (要求アイテム) のステータスと詳細を返します。

    このメソッドを使用して、要求の発信元を特定してトレースし、そのフローを監視します。応答には次のものが含まれます。
    1. 送信された要求の RITM 番号
    2. 要求が属するステージ
    3. 要求を開き、アサインされたユーザー
    4. 要求にアサインされたグループ
    5. 要求がオープンされたとき
    6. 要求の状況
    7. 送信データ

    URL 形式

    デフォルト URL: /api/now/cmp_catalog_api/status

    サポートされている要求パラメーター

    表 : 25. パスパラメーター
    名前 説明
    なし
    表 : 26. クエリパラメータ
    名前 説明
    req_item 要求アイテム [sc_req_item] テーブル内の一意の要求アイテム番号。たとえば、 RITM0000001 などです。

    データタイプ：文字列
    表 : 27. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 28. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 29. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 30. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    403 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
    404 見つかりません。要求アイテムが見つかりませんでした。
    405 無効なメソッドです。この機能は無効です。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    assignmentGroup 要求にアサインされたグループ。

    データタイプ：文字列
    assignedTo 要求にアサインされたユーザーのメール。

    データタイプ：文字列
    カタログアイテム カタログアイテム要求のsys_id。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルにあります。

    データタイプ：文字列
    エラー 返されたエラーに関する詳細を含むメッセージ。考えられるエラーメッセージ：
    • レコードが見つかりません:要求アイテムが存在しません。
    • 認証されていないユーザー: ユーザーの資格情報には、この要求を行う権限がありません。

    データタイプ：文字列
    番号 新しい要求アイテムに与えられる一意の要求アイテム番号 (RITM)。要求アイテム [sc_req_item] テーブルにあります。

    データタイプ：文字列
    openedAt 要求アイテムがオープンされたときのタイムスタンプ。

    形式:yyyy-MM-dd HH:mm:ss。

    日付タイプ：文字列
    openedBy 要求を開いたユーザーのsys_id。

    データタイプ：文字列
    ステージ 要求アイテムの現在の処理ステージ。
    可能な値：
    • ユーザー向けに作成されたタスク
    • 展開が正常に完了しました
    • プロビジョニング承認待ち
    • リソース制限超過
    • 展開に失敗しました
    • 展開がキャンセルされました
    • スタックの展開を再試行中
    • スタックを展開中

    データタイプ：文字列
    state 要求アイテムの現在の完了ステータス。
    可能な値：
    • オープン
    • 対応中
    • 完了してクローズ
    • 未完了でクローズ
    • スキップしてクローズ
    • 保留中

    データタイプ：文字列
    送信データ クラウドアカウント、場所、アプリケーション、コストセンターデータなど、要求送信に関する情報。送信データは、要求で渡された要求アイテム番号によって異なります。

    データタイプ: オブジェクト

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id 要求アイテムレコードのsys_id。要求アイテム [sc_req_item] テーブルにあります。

    データタイプ：文字列

    cURL 要求

    次の例では、要求アイテム番号 RITM0010076 のステータス情報を返します。

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

    応答：

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

    クラウドサービスカタログ:POST /now/cmp_catalog_api/submitoprequest

    リソース操作要求を送信して、プロビジョニングされたリソースに対して Day 2 操作を実行します。

    URL 形式

    デフォルト URL: /api/now/cmp_catalog_api/submitoprequest

    サポートされている要求パラメーター

    表 : 31. パスパラメーター
    名前 説明
    なし
    表 : 32. クエリパラメータ
    名前 説明
    cat_id 必須。呼び出すクラウドカタログアイテムのsys_id。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルで利用可能です。

    データタイプ：文字列
    表 : 33. 要求本文パラメーター (XML または JSON)
    名前 Description (説明)
    CloudAccount 必須。要求を送信するクラウドアカウントの名前。アカウント名は、クラウドアカウント [cmdb_ci_cmp_cloud_account] テーブルで使用できます。

    データタイプ：文字列
    場所 必須。リソースをプロビジョニングするデータセンターの場所。たとえば、us-west-1 や asia-south-2 などです。この値は、クラウドアカウントのプラットフォームプロバイダーのデータセンターの場所と一致する必要があります。関連データセンター [sn_cmp_ca_assc_datacenter] テーブルで利用可能です。

    データタイプ：文字列
    StackName 必須。スタックの名前。スタック名は動的であり、リソース管理に反映されます。

    データタイプ：文字列
    resourceId 必須。2 日目の操作が実行されるリソースのsys_id。スタックアイテム [sn_cmp_stack_item] テーブルにあります。
    resource_block 必須です。関連するリソース運用カタログアイテムを取得するリソースブロックの名前 (仮想サーバーなど)。リソースブロック [sn_cmp_rb_resourceblock] テーブルで利用可能です。

    デフォルト:すべての操作タイプのすべてのカタログアイテムが返されます。

    データタイプ：文字列
    operation_name オプション。操作の名前。OperationSignature [sn_cmp_rb_op_signature] テーブルのリソース インターフェイスの Name 列にあります。 入力する操作名は、 resourceBlock パラメーターで渡された値によって異なります。
    注:
    このパラメーターは、操作の一部または全体を照会できます。たとえば、「Servicenow」で始まるすべてのインターフェイスを一覧表示する場合は、変数を operation_name = Servicenow として設定できます。
    デフォルト:すべての操作タイプのすべてのカタログアイテムが返されます。データタイプ：文字列
    resourceInterface 必須です。関連するリソース運用カタログアイテムを取得するリソースブロックの名前 (仮想サーバーなど)。リソースブロック [sn_cmp_rb_resourceblock] テーブルで利用可能です。 入力するリソース・インターフェースは、 resourceBlock パラメーターと operation_name パラメーターで渡された値によって異なります。

    デフォルト:すべての操作タイプのすべてのカタログアイテムが返されます。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 34. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 35. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 36. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    403 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
    404 見つかりません。要求アイテムが見つかりませんでした。
    405 無効なメソッドです。この機能は無効です。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 Description (説明)
    assignmentGroup 要求にアサインされたグループ。

    データタイプ：文字列
    assignedTo 要求にアサインされたユーザーのメール。

    データタイプ：文字列
    カタログアイテム カタログアイテム要求のsys_id。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルにあります。

    データタイプ：文字列
    番号 新しい要求アイテムに与えられる一意の要求アイテム番号 (RITM)。要求アイテム [sc_req_item] テーブルにあります。

    データタイプ：文字列
    openedAt 要求アイテムがオープンされたときのタイムスタンプ。

    形式:yyyy-MM-dd HH:mm:ss。

    日付タイプ：文字列
    openedBy 要求を開いたユーザーのsys_id。

    データタイプ：文字列
    ステージ 要求アイテムの現在の処理ステージ。
    可能な値：
    • ユーザー向けに作成されたタスク
    • 展開が正常に完了しました
    • プロビジョニング承認待ち
    • リソース制限超過
    • 展開に失敗しました
    • 展開がキャンセルされました
    • スタックの展開を再試行中
    • スタックを展開中

    データタイプ：文字列
    state 要求アイテムの現在の完了ステータス。
    可能な値：
    • オープン
    • 対応中
    • 完了してクローズ
    • 未完了でクローズ
    • スキップしてクローズ
    • 保留中

    データタイプ：文字列
    送信データ クラウドアカウント、場所、アプリケーション、コストセンターデータなど、要求送信に関する情報。送信データは、要求で渡された要求アイテム番号によって異なります。

    データタイプ: オブジェクト

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id 要求アイテムレコードのsys_id。要求アイテム [sc_req_item] テーブルにあります。

    データタイプ：文字列

    次の例では、2 日目の操作要求アイテムを作成します。

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

    応答本文：

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

    クラウドサービスカタログ:POST /now/cmp_catalog_api/submitrequest

    クラウドサービス要求を送信します。このメソッドは、Day 2 操作とスタックまたはリソース操作カタログアイテムの両方について、プロビジョニングされた要求を受け入れます。

    URL 形式

    デフォルト URL: /api/now/cmp_catalog_api/submitrequest

    サポートされている要求パラメーター

    表 : 37. パスパラメーター
    名前 説明
    なし
    表 : 38. クエリパラメータ
    名前 説明
    cat_id 必須。呼び出すクラウドカタログアイテムのsys_id。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルで利用可能です。

    データタイプ：文字列
    表 : 39. 要求本文パラメーター (XML または JSON)
    名前 説明
    CloudAccount 必須。要求を送信するクラウドアカウントの名前。アカウント名は、クラウドアカウント [cmdb_ci_cmp_cloud_account] テーブルで使用できます。

    データタイプ：文字列
    場所 必須。リソースをプロビジョニングするデータセンターの場所。たとえば、us-west-1 や asia-south-2 などです。この値は、クラウドアカウントのプラットフォームプロバイダーのデータセンターの場所と一致する必要があります。関連データセンター [sn_cmp_ca_assc_datacenter] テーブルで利用可能です。

    データタイプ：文字列
    StackName 必須。スタックの名前。スタック名は動的であり、リソース管理に反映されます。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 40. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 41. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 42. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    403 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
    404 見つかりません。要求アイテムが見つかりませんでした。
    405 無効なメソッドです。この機能は無効です。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 Description (説明)
    assignmentGroup 要求にアサインされたグループ。

    データタイプ：文字列
    assignedTo 要求にアサインされたユーザーのメール。

    データタイプ：文字列
    カタログアイテム カタログアイテム要求のsys_id。クラウドカタログアイテム [sn_cmp_bp_cat_item] テーブルにあります。

    データタイプ：文字列
    番号 新しい要求アイテムに与えられる一意の要求アイテム番号 (RITM)。要求アイテム [sc_req_item] テーブルにあります。

    データタイプ：文字列
    openedAt 要求アイテムがオープンされたときのタイムスタンプ。

    形式:yyyy-MM-dd HH:mm:ss。

    日付タイプ：文字列
    openedBy 要求を開いたユーザーのsys_id。

    データタイプ：文字列
    ステージ 要求アイテムの現在の処理ステージ。
    可能な値：
    • ユーザー向けに作成されたタスク
    • 展開が正常に完了しました
    • プロビジョニング承認待ち
    • リソース制限超過
    • 展開に失敗しました
    • 展開がキャンセルされました
    • スタックの展開を再試行中
    • スタックを展開中

    データタイプ：文字列
    state 要求アイテムの現在の完了ステータス。
    可能な値：
    • オープン
    • 対応中
    • 完了してクローズ
    • 未完了でクローズ
    • スキップしてクローズ
    • 保留中

    データタイプ：文字列
    送信データ クラウドアカウント、場所、アプリケーション、コストセンターデータなど、要求送信に関する情報。送信データは、要求で渡された要求アイテム番号によって異なります。

    データタイプ: オブジェクト

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id 要求アイテムレコードのsys_id。要求アイテム [sc_req_item] テーブルにあります。

    データタイプ：文字列

    次の例では、インスタンスの AWS クラウドアカウントでクラウドリソース要求を送信します。

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

    応答：

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