SG サービス API

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：54分

    • SG サービス API は、アプリケーションサービスと、それらの間のアップストリームの関係を作成および管理するためのエンドポイントを提供します。

    ストアでアプリを要求する

    ServiceNow Store Web サイトにアクセスして利用可能なすべてのアプリを表示し、ストアにリクエストを送信する方法について確認してください。リリースされたすべてのアプリのこれまでのリリースノート情報については、 ServiceNow Store のリリースノートを参照してください。

    この API は、CMDB アプリケーション API および CLI (sn_service_graph) プラグインが有効になっている場合にのみ使用できます。この API は sn_service_graph 名前空間内で使用されます。

    この API を使用するために、ソーステーブルや関係タイプに関する詳細は必要ありません。

    企業全体の自動化をサポートする重要な操作をスクリプト化するために、ユーザーインターフェイスを使用する代わりに、API を活用するか、CMDB アプリケーション CLI および API ストアアプリが提供するコマンドライン操作を実行できます。CMDB アプリケーション CLI および API ストアアプリは、アプリケーションサービスに関連するすべての API と、それらの API へのインターフェイスにアクセスできるようにするコマンドラインを統合する堅牢なフレームワークを提供します。

    CMDB アプリケーションの CLI および API コマンドは、次のタスクをアクティブ化します。
    • アプリケーションサービスの登録と作成、およびアップストリームの関係の確立
    • 指定されたアプリケーションサービスとそのアップストリームの関係の詳細の取得
    • ビジネスアプリケーションやビジネスサービスオファリングなどの上位レベルの構成要素の接続
    • 指定された入力タイプのアプリケーションサービスへの入力
    • アプリケーションサービスのステータスの変更

    コマンド ライン ソリューションについては、「 CMDB アプリケーション CLI と API で使用可能なコマンド」を参照してください。

    SG サービス – POST /sg_services/app_service/convert

    手動または空のタイプのアプリケーションサービスを計算されたアプリケーションサービスに変換します。変換中、アプリケーションサービスレコードは新しくアサインされたクラスとともに [cmdb_ci_service_calculated] テーブルに移動します。

    CI を識別する以下のプロパティは、次のように優先されます。
    1. sys_id – sys_id の場合、システムは sys_id のみを使用し、追加の値は無視します。
    2. 数値 – sys_id なしで指定された場合、システムは数値のみを使用し、追加の値は無視します。
    3. <IRE field name> – sys_id または数値が指定されていない場合のみ、システムはこれらの値を使用します。

    URL 形式

    バージョニングされた URL：/api/sn_service_graph/{api_version}/sg_services/app_service/convert

    デフォルトの URL：/api/sn_service_graph/sg_services/app_service/convert

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 1. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (JSON)
    名前 説明
    <IRE field name> アプリケーションサービスを特定する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    levels 変換に含めるレベルの数。

    データタイプ：文字列
    number アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    sys_id サービスインスタンス [cmdb_ci_service_auto] テーブルにリストされているアプリケーションサービスのSys_id。

    データタイプ：文字列

    ヘッダー

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

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON)

    名前 説明
    status 成功または失敗を示します。

    データタイプ：文字列

    cURL 要求

    次の例は、アプリケーションサービスタイプを変換する方法を示しています。

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/convert" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
 \"name\": \"Test Register\",
 \"environment\": \"Test\",
 \"version\": \"1.0\",
 \"levels\" : 8
}" \
--user 'username':'password'

    計算されたアプリケーションサービスへの変換に成功したことを示す結果。

    {
  "result": {
  "status": "success"
  }
}

    SG サービス:POST /sg_services/app_service/削除

    アプリケーションサービスを削除します。

    CI を識別する以下のプロパティは、次のように優先されます。
    1. sys_id – sys_id の場合、システムは sys_id のみを使用し、追加の値は無視します。
    2. 数値 – sys_id なしで指定された場合、システムは数値のみを使用し、追加の値は無視します。
    3. <IRE field name> – sys_id または数値が指定されていない場合のみ、システムはこれらの値を使用します。

    URL 形式

    バージョニングされた URL：/api/sn_service_graph/{api_version}/sg_services/app_service/delete

    デフォルトの URL：/api/sn_service_graph/sg_services/app_service/delete

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 7. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 9. 要求本文パラメーター (JSON)
    名前 説明
    <IRE field name> アプリケーションサービスを特定する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    number アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    sys_id サービスインスタンス [cmdb_ci_service_auto] テーブルにリストされているアプリケーションサービスのSys_id。

    データタイプ：文字列

    ヘッダー

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

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON)

    名前 説明
    status 成功または失敗を示します。

    データタイプ：文字列

    cURL 要求

    次の例は、アプリケーションサービスを削除する方法を示しています。

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/delete" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"name\": \"Test Register\",
   \"environment\": \"Test\",
   \"version\": \"1.0\"
}" \
--user 'username':'password'

    アプリケーションサービスの削除に成功したことを示す結果。

    {
  "result": {
  "status": "success"
  }
}

    SG サービス:POST /sg_services/app_service/find

    指定されたアプリケーションサービスとそのアップストリームの関係の詳細を検索します。

    app_service_user ロールを持つユーザーはこの API を使用できますが、結果は運用ステータスのアプリケーションサービスに制限されます。app_service_admin ロールは、アプリケーションサービスを無制限に表示できます。

    CI を識別する以下のプロパティは、次のように優先されます。
    1. sys_id – sys_id の場合、システムは sys_id のみを使用し、追加の値は無視します。
    2. 数値 – sys_id なしで指定された場合、システムは数値のみを使用し、追加の値は無視します。
    3. <IRE field name> – sys_id または数値が指定されていない場合のみ、システムはこれらの値を使用します。

    URL 形式

    バージョニングされた URL：/api/sn_service_graph/{api_version}/sg_services/app_service/find

    デフォルトの URL：/api/sn_service_graph/sg_services/app_service/find

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 13. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (JSON)
    名前 説明
    <IRE フィールド> アプリケーションサービスを特定する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    number アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    sys_id サービスインスタンス [cmdb_ci_service_auto] テーブルにリストされているアプリケーションサービスのSys_id。

    データタイプ：文字列

    ヘッダー

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

    表 : 16. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON)

    名前 説明
    <IRE field name> アプリケーションサービスを特定する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    number アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    operational_status アプリケーションサービスの運用ステータス。たとえば、active です。

    データタイプ：文字列
    relationships アプリケーションサービスのアップストリームの関係を定義するオブジェクトのリスト。

    データタイプ：アレイ

    "relationships": [
 {
    "name": "String",
    "number": "String",
    "sys_id": "String",
    "class_name": "String",
    "relationship": "String"
 }
]
    relationships.class_name アプリケーションサービスを含むクラスの名前。

    データタイプ：文字列
    relationships.name 関係の名前。

    データタイプ：文字列
    relationships.number 関係の一意の番号。

    データタイプ：文字列
    relationships.relationship 関係性ルール。

    データタイプ：文字列
    relationships.sys_id 関係の sys_id。

    データタイプ：文字列
    sys_id サービスインスタンス [cmdb_ci_service_auto] テーブルにリストされているアプリケーションサービスのSys_id。

    データタイプ：文字列

    cURL 要求

    次の例は、アプリケーションサービスの詳細を検索する方法を示しています。

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/find" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"name\": \"Test App Service1\"
 }" \
--user 'username':'password'

    応答の本文に、アプリケーションサービスと関係情報が含まれています。

    {
  "result": {
    "aliases": null,
    "asset": null,
    "asset_tag": null,
    "assigned": "",
    "assigned_to": null,
    "assignment_group": null,
    "attestation_score": null,
    "attested": "0",
    "attested_by": null,
    "attested_date": "",
    "attributes": null,
    "bucket": null,
    "business_contact": null,
    "business_need": null,
    "business_relation_manager": null,
    "business_unit": null,
    "busines_criticality": "4 - not critical",
    "can_print": "0",
    "category": null,
    "change_control": null,
    "checked_in": "",
    "checked_out": "",
    "checkout": null,
    "comments": null,
    "company": null,
    "compatibility_dependencies": null,
    "consumer_type": "internal",
    "correlation_id": null,
    "cost": null,
    "cost_cc": "USD",
    "cost_center": null,
    "delivery_date": "",
    "delivery_manager": null,
    "department": null,
    "discovery_source": "Manual Entry",
    "dns_domain": null,
    "due": "",
    "due_in": null,
    "duplicate_of": null,
    "end_date": "",
    "environment": null,
    "fault_count": "0",
    "first_discovered": "2021-07-19 20:09:48",
    "fqdn": null,
    "gl_account": null,
    "hide_from_dashboard": "0",
    "install_date": "",
    "install_status": "1",
    "invoice_number": null,
    "ip_address": null,
    "justification": null,
    "last_discovered": "2021-07-19 20:09:48",
    "last_review_date": "",
    "layer": null,
    "lease_id": null,
    "life_cycle_stage": null,
    "life_cycle_stage_status": null,
    "location": null,
    "mac_address": null,
    "maintenance_schedule": null,
    "managed_by": null,
    "managed_by_group": null,
    "manufacturer": null,
    "model_id": null,
    "model_number": null,
    "monitor": "0",
    "monitoring_requirements": null,
    "name": "Test App Service1",
    "number": "SNSVC0001014",
    "operational_status": "2",
    "order_date": "",
    "owned_by": null,
    "parent": null,
    "portfolio_status": "pipeline",
    "po_number": null,
    "prerequisites": null,
    "price_model": "per_unit",
    "price_unit": null,
    "published_ref": null,
    "purchase_date": "",
    "schedule": null,
    "serial_number": null,
    "service_classification": "Application Service",
    "service_level_requirement": null,
    "service_owner_delegate": null,
    "service_status": "requirements",
    "severity": null,
    "short_description": null,
    "skip_sync": "0",
    "sla": null,
    "spm_service_portfolio": null,
    "spm_taxonomy_node": null,
    "stakeholders": null,
    "start_date": "",
    "state": null,
    "subcategory": null,
    "supported_by": null,
    "support_group": null,
    "sys_class_name": "cmdb_ci_service_auto",
    "sys_class_path": "/!!/!7/!(",
    "sys_created_by": "admin",
    "sys_created_on": "2021-07-19 20:09:48",
    "sys_domain": "global",
    "sys_domain_path": "/",
    "sys_id": "a2f0618040697410f87713b656474255",
    "sys_mod_count": "0",
    "sys_updated_by": "admin",
    "sys_updated_on": "2021-07-19 20:09:48",
    "unit_description": null,
    "unverified": "0",
    "used_for": "Production",
    "user_group": null,
    "vendor": null,
    "version": null,
    "view_service": "61e1cb757f23220002d31ccebefa9120",
    "warranty_expiration": "",
    "relationships": [
      {
        "name": "Test Biz App1",
        "sys_id": "0250a94040697410f87713b656474250",
        "number": "APM0001001",
        "class_name": "cmdb_ci_business_app",
        "relationship": "Consumes::Consumed by"
      },
      {
        "name": "Tech Service Offering1",
        "sys_id": "98d0ed4040697410f87713b6564742ef",
        "number": "BSN0001005",
        "class_name": "service_offering",
        "relationship": "Contains::Contained by"
      }
    ]
  }
}

    SG サービス:POST /sg_services/app_service/populate

    サービスの作成方法を使用して、アプリケーションサービスを設定します。

    CI を識別する以下のプロパティは、次のように優先されます。
    1. sys_id – sys_id の場合、システムは sys_id のみを使用し、追加の値は無視します。
    2. 数値 – sys_id なしで指定された場合、システムは数値のみを使用し、追加の値は無視します。
    3. <IRE field name> – sys_id または数値が指定されていない場合のみ、システムはこれらの値を使用します。

    URL 形式

    バージョニングされた URL：/api/sn_service_graph/{api_version}/sg_services/app_service/populate

    デフォルトの URL：/api/sn_service_graph/sg_services/app_service/populate

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 19. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 20. クエリパラメーター
    名前 説明
    なし
    表 : 21. 要求本文パラメーター (JSON)
    名前 説明
    <IRE field name> アプリケーションサービスを特定する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    number アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    population_method 必須。入力するコンテンツを識別するための入力方法とそれに付随するプロパティを識別します。

    タイプごとに 1 つの付随オブジェクトのみが有効です。

    データタイプ：オブジェクト
    population_method.group_id cmdb_group 入力タイプで構成された CMDB グループのグループ ID。

    データタイプ：「文字列」

    "population_method": {
  "group_id": "String",
  "type": "cmdb_group"
}

    関連付けられた入力タイプ：cmdb_group
    population_method.levels サービスのビルドに使用するレベルの数。レベル値が指定されていない場合、システムは値の sys_property をチェックします。svc.manual.convert.levels.default_value が入力されていない場合は、デフォルト値の 3 が使用されます。

    データタイプ：数値

    "population_method": {
  "levels": Number,
  "type": "dynamic_service"
}

    関連する入力タイプ：dynamic_service

    デフォルト：sys_property にレベル値が設定されていない場合は 3
    population_method.service_candidate

    サービス候補の一意の識別子。

    データタイプ：文字列

    "population_method": {
  "service_candidate": "String",
  "type": "tag_based_service_family"
}

    関連する入力タイプ：tag_based_service_family
    population_method.service_relations アプリケーションサービス内の CI の階層データを含むオブジェクトのリスト。すべての CI は親および子 CI とのペアを形成します。アプリケーションサービスのエントリーポイントと呼ばれるトップレベル CI には親 CI がありません。

    データタイプ：アレイ

    "population_method": {

  "service_relations":[
     {
      "child": "String",
      "parent": "String"
     }
  ],

  "type": "service_hierarchy"   
}

    関連する入力タイプ： service_hierarchy
    population_method.service_relations.child CI に関連する子 CI の名前。

    データタイプ：文字列
    population_method.service_relations.parent CI に関連する親 CI の名前。

    データタイプ：文字列
    population_method.tags CI に関連付けるタグを含むオブジェクトのリスト。この情報は、キー値 [cmdb_key_value] テーブルにあります。

    データタイプ：アレイ

    "population_method": {

  "tags": [
     {
      "tag": "String",
      "value": "String"
     }
  ],

  "type": "tag_list"  
}

    関連付けられた入力タイプ：tag_list
    population_method.tags.tag タグ名。

    データタイプ：文字列
    population_method.tags.value タグ値。

    データタイプ：文字列
    population_method.type 必須。アプリケーションサービスに追加する入力タイプ。

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

    有効な値：
    • cmdb_group
    • service_hierarchy
    • dynamic_service
    • tag_list
    • tag_based_service_family
    sys_id サービスインスタンス [cmdb_ci_service_auto] テーブルにリストされているアプリケーションサービスのSys_id。

    データタイプ：文字列

    ヘッダー

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

    表 : 22. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON)

    名前 説明
    status 成功または失敗を示します。

    データタイプ：文字列

    cURL 要求

    次の例は、dynamic_service タイプでアプリケーションサービスを作成する方法を示しています。

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/populate" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\",

 \"population_method\": {
   \"type\": \"dynamic_service\",
   \"levels\" : 8
  }
}" \
--user 'username':'password'

    アプリケーションサービスの作成に成功したことを示す結果。

    {
  "result": {
  "status": "success"
  }
}

    SG サービス – POST /sg_services/app_service/register

    アプリケーションサービス、タグを作成し、ビジネスアプリケーション、ビジネスサービスオファリング、その他のアプリケーションサービスなどのアップストリームの関係をビルドします。

    CI を識別する以下のプロパティは、次のように優先されます。
    1. sys_id – sys_id の場合、システムは sys_id のみを使用し、追加の値は無視します。
    2. 数値 – sys_id なしで指定された場合、システムは数値のみを使用し、追加の値は無視します。
    3. <IRE field name> – sys_id または数値が指定されていない場合のみ、システムはこれらの値を使用します。

    URL 形式

    バージョニングされた URL：/api/sn_service_graph/{api_version}/sg_services/app_service/register

    デフォルトの URL：/api/sn_service_graph/sg_services/app_service/register

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 25. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 26. クエリパラメーター
    名前 説明
    なし
    表 : 27. 要求本文パラメーター (JSON)
    名前 説明
    <IRE field name> アプリケーションサービスを特定する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    number アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    relationships タイプ別に分類されたアップストリームの関係。

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

    "relationships": {
 "business_app": [Array],
 "business_service_offering": [Array],
 "parent_app_service": [Array],
 "technical_service_offering": [Array]
}

    関係の最大数は 25 です。
    relationships.business_app
    ビジネスアプリケーション関係タイプを表すオブジェクトのリスト。これらの値は、次のいずれかのアイテムをキーと値のペアとして使用して定義できます。
    • <IRE field name>
    • number
    • sys_id

    データタイプ：アレイ
    relationships.business_service_offering
    ビジネスサービスオファリング関係タイプを表すオブジェクトのリスト。これらの値は、次のアイテムをキーと値のペアとして使用して定義できます。
    • <IRE field name>
    • number
    • sys_id

    データタイプ：アレイ
    relationships.parent_app_service
    アプリケーションサービス関係タイプを表すオブジェクトのリスト。これらの値は、次のアイテムをキーと値のペアとして使用して定義できます。
    • <IRE field name>
    • number
    • sys_id

    データタイプ：アレイ
    relationships.technical_service_offering
    テクノロジー管理オファリング (以前のテクニカルサービスオファリング)関係タイプを表すオブジェクトのリスト。これらの値は、次のアイテムをキーと値のペアとして使用して定義できます。
    • <IRE field name>
    • number
    • sys_id

    データタイプ：アレイ
    sys_id サービスインスタンス [cmdb_ci_service_auto] テーブルにリストされているアプリケーションサービスのSys_id。

    データタイプ：文字列
    tags キーと値のペアとしてのタグ定義を含むオブジェクトのリスト。
    "tags": [
 {
  "key": "String",
  "value": "String"
 }]

    データタイプ：アレイ
    tags.key タグカテゴリ名。

    データタイプ：文字列
    tags.value タグ値。

    データタイプ：文字列

    ヘッダー

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

    表 : 28. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 29. 応答ヘッダー
    cHeader 説明
    なし

    ステータスコード

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

    表 : 30. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON)

    cHeader 説明
    app_service アプリケーションサービスの詳細。

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

    "app_service": {
  "name": "String",
  "number": "String",
  "sys_id": "String"
}
    app_service.name アプリケーションサービスの名前。

    データタイプ：文字列
    app_service.number アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    app_service.sys_id サービスインスタンス [cmdb_ci_service_auto] テーブルにリストされているアプリケーションサービスのSys_id。

    データタイプ：文字列
    message ステータスを説明するメッセージ。
    可能な値：
    • Service already exists
    • Service registered successfully

    データタイプ：文字列
    status サービスが登録されているかどうかを示すステータス。
    可能な値：
    • Insert：アプリケーションサービスが正常に作成されました。
    • No action：アプリケーションサービスは既に存在していますアクションは実行されません。

    データタイプ：文字列

    cURL 要求

    次の例は、アプリケーションサービスを登録する方法を示しています。

    curl "instance.service-now.com/api/sn_service_graph/sg_services/app_service/register" \--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\",
  \"number\": \" SNSVC0001014\",
  \"relationships\": {
    \"business_application\": [
      {
        \"sys_id\": \"0250a94040697410f87713b656474250\"
      },
      {
        \"number\": \"APM0001002\"
      },
      {
        \"name\": \"Test Biz App1\"
      }
    ],
    \"business_service_offering\": [
      {
        \"sys_id\": \"ed32e98040697410f87713b656474259\"
      }
    ],
    \"technical_service_offering\": [
      {
        \"sys_id\": \"80e12d8040697410f87713b65647421c\"
      },
      {
        \"number\": \"BSN0001005\"
      },
      {
        \"name\": \"Tech Service Offering2\"
      }
    ],
    \"parent_app_service\": [
      {
        \"sys_id\": \"a2f0618040697410f87713b656474255\"
      }
    ]
  },
  \"tags\": [
    {
      \"key\": \"key1\",
      \"value\": \"value1\"
    },
    {
      \"key\": \"key2\",
      \"value\": \"value2\"
    }
  ]
}" \
--user 'username':'password'

    応答の本文には、ID とステータス情報が含まれます。

    {
  "result": {
    "app_service": {
      "sys_id": "5780cb604061f410f87713b656474271",
      "name": "Test Register",
      "number": " SNSVC0001014"
    },
    "message": "Service registered successfully",
    "status": "INSERT"
  }
}

    SG サービス:POST /sg_services/app_service/関係性/作成

    ビジネスアプリケーション、ビジネスサービスオファリング、その他のアプリケーションサービスなどのアップストリームの関係をビルドします。

    この API は、1 つの親と対応する子オブジェクトを含む入力を取得して、関係を作成します。

    CI を識別する以下のプロパティは、次のように優先されます。
    1. sys_id – sys_id の場合、システムは sys_id のみを使用し、追加の値は無視します。
    2. 数値 – sys_id なしで指定された場合、システムは数値のみを使用し、追加の値は無視します。
    3. <IRE field name> – sys_id または数値が指定されていない場合のみ、システムはこれらの値を使用します。

    URL 形式

    バージョニングされた URL：/api/sn_service_graph/{api_version}/sg_services/app_service/relationship/create

    デフォルトの URL：/api/sn_service_graph/sg_services/app_service/relationship/create

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 31. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 32. クエリパラメーター
    名前 説明
    なし
    表 : 33. 要求本文パラメーター (JSON)
    名前 説明
    child 関係を作成する子アプリケーションサービスを特定する情報。

    動的 CI グループは子として追加できますが、親になることはできません。

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

    "child": {
  "<service_app_identifier>": "String"
}

    テーブル:サービスインスタンス [cmdb_ci_service_auto]
    child.<service_app_identifier> 関係の作成に使用する子アプリケーションサービスを特定する詳細情報。
    必要なオプションは 1 つだけです。各オプションは、処理の優先順位別にリストされます。
    • sys_id:子アプリケーションサービスのSys_id。
    • number:子アプリケーションサービスを識別する一意の番号。
    • <IRE フィールド名>:アプリケーションサービスを識別する IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    parent 関係の作成に使用する親アプリケーションサービスを特定する詳細情報。

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

    "parent": {
  "<service_app_identifier>": "String",
  "class_name": "String"
}
    parent.<service_app_identifier> アプリケーションサービスを特定する情報。
    必要なオプションは 1 つだけです。各オプションは、処理の優先順位別にリストされます。
    • sys_id:サービスインスタンス [cmdb_ci_service_auto] にリストされているアプリケーションサービスSys_id。
    • number:アプリケーションサービスを識別する一意の番号。
    • <IRE フィールド名>:アプリケーションサービスを識別する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    parent.class_name アプリケーションサービスを含むクラスの名前。
    親クラス名は、次のいずれかのテーブルからのものである必要があります。
    • cmdb_ci_business_app
    • cmdb_ci_service_auto
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • cmdb_ci_service_discovered
    • service_offering

    デフォルト：cmdb_ci_service_auto

    データタイプ：文字列

    ヘッダー

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

    表 : 34. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 35. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 36. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON)

    名前 説明
    status 成功または失敗を示します。

    データタイプ：文字列

    cURL 要求

    次の例は、アプリケーションサービスから関係を作成する方法を示しています。

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/relationship/create" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"child\": {
   \"name\": \"wdfsdf\",
   \"environment\": \"Test\",
   \"version\": \"1.0\"
   },
  \"parent\": {
   \"sys_id\": \"abcdefg\",
   \"name\": \"business App1\",
   \"class_name\": \"service_offering\"
  }
}" \
--user 'username':'password'

    アプリケーションサービスの関係の作成に成功したことを示す結果。

    {
  "result": {
  "status": "success"
  }
}

    SG サービス:POST /sg_services/app_service/関係/削除

    アプリケーションサービスのアップストリームの関係を削除します。

    CI を識別する以下のプロパティは、次のように優先されます。
    1. sys_id – sys_id の場合、システムは sys_id のみを使用し、追加の値は無視します。
    2. 数値 – sys_id なしで指定された場合、システムは数値のみを使用し、追加の値は無視します。
    3. <IRE field name> – sys_id または数値が指定されていない場合のみ、システムはこれらの値を使用します。

    URL 形式

    バージョニングされた URL：/api/sn_service_graph/{api_version}/sg_services/app_service/relationship/delete

    デフォルトの URL：/api/sn_service_graph/sg_services/app_service/relationship/delete

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 37. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 38. クエリパラメーター
    名前 説明
    なし
    表 : 39. 要求本文パラメーター (JSON)
    名前 説明
    child サービスアプリケーションから削除する子の関係を説明する情報。

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

    "child": {
  "<IRE field name>": "String",
  "number": "String",
  "sys_id": "String"
}
    child.<IRE field name> 子アプリケーションサービスを特定する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    child.number 子アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    child.sys_id サービスインスタンス [cmdb_ci_service_auto] にリストされている子アプリケーションサービスのSys_id。

    データタイプ：文字列
    parent 関係の削除元となる親アプリケーションサービスを特定する詳細情報。

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

    "parent": {
  "<IRE field name>": "String",
  "number": "String",
  "sys_id": "String",
  "class_name": "String"
}
    parent.<IRE field name> アプリケーションサービスを特定する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    parent.number アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    parent.sys_id サービスインスタンス [cmdb_ci_service_auto] テーブルにリストされているアプリケーションサービスのSys_id。

    データタイプ：文字列
    parent.class_name アプリケーションサービスを含むクラスの名前。
    親クラス名は、次のいずれかのテーブルからのものである必要があります。
    • cmdb_ci_service_auto
    • cmdb_ci_service_discovered
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • service_offering
    • cmdb_ci_business_app

    デフォルト：cmdb_ci_service_auto

    データタイプ：文字列

    ヘッダー

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

    表 : 40. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 41. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 42. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON)

    名前 説明
    status 成功または失敗を示します。

    データタイプ：文字列

    cURL 要求

    次の例は、アプリケーションサービスから関係を削除する方法を示しています。

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/relationship/delete" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"child\": {
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\"

  },
  \"parent\": {
   \"sys_id\": \"abcdefg\",
   \"name\": \"business App1\",
   \"class_name\": \"service_offering\"
     }
 }" \
--user 'username':'password'

    アプリケーションサービスの関係の削除に成功したことを示す結果。

    {
  "result": {
  "status": "success"
  }
}

    SG サービス:POST /sg_services/app_service/ステータス

    アプリケーションサービスのライフサイクル状況をアクティブ化、非アクティブ化、または廃止に変更します。

    CI を識別する以下のプロパティは、次のように優先されます。
    1. sys_id – sys_id の場合、システムは sys_id のみを使用し、追加の値は無視します。
    2. 数値 – sys_id なしで指定された場合、システムは数値のみを使用し、追加の値は無視します。
    3. <IRE field name> – sys_id または数値が指定されていない場合のみ、システムはこれらの値を使用します。

    URL 形式

    バージョニングされた URL：/api/sn_service_graph/{api_version}/sg_services/app_service/state

    デフォルトの URL：/api/sn_service_graph/sg_services/app_service/state

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 43. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 44. クエリパラメーター
    名前 説明
    なし
    表 : 45. 要求本文パラメーター (JSON)
    名前 説明
    <IRE field name> アプリケーションサービスを特定する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    number アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    state 必須です。アプリケーションサービスのライフサイクル状況。
    有効な値：
    • ACTIVATE – ライフサイクルが運用中で、使用中です。
      • life_cycle_stage=Operational
      • life_cycle_stage_status=In Use
      • operational_status=Operational
    • DEACTIVATE – ライフサイクルが運用されておらず、設計段階です。
      • life_cycle_stage=Design
      • life_cycle_stage_status=Build
      • operational_status=Non-Operational
    • 廃止 – 提供終了。
      • life_cycle_stage=End Of Life
      • life_cycle_stage_status=Retired
      • operational_status=Retired

    データタイプ：文字列

    格納場所: サービスインスタンス [cmdb_ci_service_auto]
    sys_id サービスインスタンス [cmdb_ci_service_auto] テーブルにリストされているアプリケーションサービスのSys_id。

    データタイプ：文字列

    ヘッダー

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

    表 : 46. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 47. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 48. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON)

    名前 説明
    status 成功または失敗を示します。

    データタイプ：文字列

    cURL 要求

    次の例は、アプリケーションサービスのライフサイクルステータスを有効に変更する方法を示しています。

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/state" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  {
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\",
  \"state\": \"activate\"
  }
}" \
--user 'username':'password'

    操作に成功したことを示す結果。

    {
  "result": {
  "status": "success"
  }
}

    SG サービス:POST /sg_services/app_service/update

    提供された既存のアプリケーションサービスを更新し、指定されたアプリケーションサービスのタグを作成します。

    CI を識別する以下のプロパティは、次のように優先されます。
    1. sys_id – sys_id の場合、システムは sys_id のみを使用し、追加の値は無視します。
    2. 数値 – sys_id なしで指定された場合、システムは数値のみを使用し、追加の値は無視します。
    3. <IRE field name> – sys_id または数値が指定されていない場合のみ、システムはこれらの値を使用します。

    URL 形式

    バージョニングされた URL：/api/sn_service_graph/{api_version}/sg_services/app_service/update

    デフォルトの URL：/api/sn_service_graph/sg_services/app_service/update

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 49. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 50. 要求本文パラメーター (JSON)
    名前 説明
    <fields or tags to update> キーと値のペアを使用して、更新する各フィールドまたはタグを特定します。

    基本的な情報のみを更新できます。アップストリームの関係は更新できません。

    データタイプ：文字列
    <IRE field name> アプリケーションサービスを特定する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    sys_id、number、または IRE を送信してアプリケーションサービスを特定することができます。ただし、これらのフィールドは、識別子として使用する場合は更新できません。IRE フィールドを更新するには、入力に識別子として sys_id または number を含める必要があります。

    データタイプ：文字列
    number アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    sys_id サービスインスタンス [cmdb_ci_service_auto] テーブルにリストされているアプリケーションサービスのSys_id。

    データタイプ：文字列

    ヘッダー

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

    表 : 51. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 52. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 53. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON)

    名前 説明
    <IRE field name> アプリケーションサービスを特定する 1 つ以上の IRE フィールド。たとえば、名前やバージョン。

    データタイプ：文字列
    number アプリケーションサービスを特定する一意の番号。

    データタイプ：文字列
    sys_id サービスインスタンス [cmdb_ci_service_auto] テーブルにリストされているアプリケーションサービスのSys_id。

    データタイプ：文字列
    <更新されたフィールド> 更新が成功すると、ペイロードで送信された変更済みの各フィールドが応答本文にリストされます。

    cURL 要求

    次の例は、name を IRE フィールドとして使用して、アプリケーションサービスを更新する方法を示しています。

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  {
   \"name\": \"Test Register\",
   \"environment\": \"Test\",
   \"version\": \"1.0\"
  }
}" \
--user 'username':'password'

    応答には、アプリケーションサービスの識別情報と更新されたフィールドが含まれます。

    {
  "result": {
  "sys_id": "123456",
  "number": "SVCKji0w9e",
  "name": "Test Register",
  "environment": "Test",
  "version": "1.0"
  }
}