--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP ft:publication_title : - オーストラリア API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # アプリケーションサービス API # アプリケーションサービス API {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：35分 アプリケーションサービス API は、アプリケーションサービスを作成、変更、および更新できるようにするエンドポイントを提供します。 この API を使用するには、ユーザーにアプリケーションサービスアドミニストレーター \[app_service_admin\] ロールが必要です。 重要: Rome リリース以降、アプリケーションサービス API は拡張もサポートもされなくなりました。詳細については、Now Support ナレッジベースの「[Deprecation Process (廃止プロセス) \[KB0867184\]](https://support.servicenow.com/kb_view.do?sysparm_article=KB0867184)」の記事を参照してください。 ## アプリケーションサービス:GET /now/cmdb/app_service/{sys_id}/getContent {#ariaid-title2} マッピングされたアプリケーションサービス内の構成アイテム (CI) のリストとそれらの関係を取得します。手動で作成されたサービスのコンテンツのみを取得します。 ### URL 形式 {#appservice-GET-getContent__section_lwf_psn_wlb} デフォルト URL: /api/now/cmdb/app_service/{sys_id}/getContent ### サポートされている要求パラメーター {#appservice-GET-getContent__entry__2} | 名前 | 説明 | |-|-| | sys_id | マップされたアプリケーションサービスのSys_id。 データタイプ：文字列 テーブル:マップ済みアプリケーションサービス \[cmdb_ci_service_discovered\] | [表 : 1. パスパラメーター] {#appservice-GET-getContent__entry__6} | 名前 | 説明 | |-|-| | モード | 返される関係データの量。 有効な値： * 完全:シャローモードで返されたデータに加えて、CI 属性とルックアップ情報を返します。 * 浅い:サービス内の CI 間の親子関係を返します。 {#appservice-GET-getContent__ul_mcl_cl4_ndb} 値の大文字と小文字は区別されません。 データタイプ：文字列 | [表 : 2. クエリパラメーター] {#appservice-GET-getContent__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 3. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#appservice-GET-getContent__entry__14}{#appservice-GET-getContent__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 4. 要求ヘッダー] {#appservice-GET-getContent__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#appservice-GET-getContent__entry__22}{#appservice-GET-getContent__entry-200-status-code}{#appservice-GET-getContent__entry-400-status-code}{#appservice-GET-getContent__entry-401-appservice}{#appservice-GET-getContent__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 401 | 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#appservice-GET-getContent__table_nyj_nl4_wlb__entry__2} | 名前 | 説明 | |-|-| | cmdb | 指定されたアプリケーションサービスに関連付けられた CI を説明するオブジェクトのリスト。 データタイプ: オブジェクト "cmdb": [ { "items": {Object}, "relations": [Array] } ] | | cmdb.items | アプリケーションサービス内の CI。要求で完全なクエリパラメーターが渡された場合、このセクションには各 CI の属性とルックアップ情報が含まれます。 データタイプ：アレイ "items": [ { "className": "String", "values": {Object} } ] | | cmdb.items.className | CI を含むクラスの名前。 データタイプ：文字列 | | cmdb.items.values | 関連する CI を見つけるために使用する情報。 データタイプ: オブジェクト "values": { "name": "String", "sys_id": "String" } | | cmdb.items.values.name | CI の名前。 データタイプ：文字列 | | cmdb.items.values.sys_id | CI のSys_id。 データタイプ：文字列 | | cmdb.relations | ホストとその子など、関連する CI の関係性データ。 データタイプ：アレイ | | service | 指定されたサービスに関連するサービスのリスト。 データタイプ：オブジェクトのアレイ "service": [ { "name": "String", "service_relations": [Array], "url": "String" } ] | | service.name | アプリケーションサービスの名前。 データタイプ：文字列 | | service.service_relations | アプリケーションサービス内の CI の階層データ。すべての CI は親および子 CI とのペアを形成します。アプリケーションサービスのエントリーポイントと呼ばれるトップレベル CI には親 CI がありません。 データタイプ：オブジェクトのアレイ "service_relations": [ { "child": "String", "parent": "String" } ] | | service.service_relations.child | CI に関連する子 CI の名前。 データタイプ：文字列 | | service.service_relations.parent | CI に関連する親 CI の名前。 データタイプ：文字列 | | service.url | アプリケーションサービスへの相対パス。 データタイプ：文字列 | [ ] {#appservice-GET-getContent__table_nyj_nl4_wlb} ### cURL 要求のサンプル curl "https://instance.servicenow.com/api/now/cmdb/app_service/2fce42d80a0a0bb4004af34d7e3984c8/getContent?mode=shallow" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' { "service": { "name": "PeopleSoft Portals", "url": "/api/now/table/cmdb_ci_service_discovered/2fce42d80a0a0bb4004af34d7e3984c8", "service_relations": [ { "parent": "", "child": "3a2810c20a0a0bb400268337d6e942ca" }, { "parent": "3a27f1520a0a0bb400ecd6ff7afcf036", "child": "3a5dd3dbc0a8ce0100655f1ec66ed42c" }, { "parent": "3a290cc60a0a0bb400000bdb386af1cf", "child": "3a307c930a0a0bb400353965d0b8861f" }, { "parent": "3a172e820a0a0bb40034228e9f65f1be", "child": "3a27d4370a0a0bb4006316812bf45439" }, { "parent": "", "child": "3a172e820a0a0bb40034228e9f65f1be" }, { "parent": "", "child": "3a27f1520a0a0bb400ecd6ff7afcf036" }, { "parent": "3a2810c20a0a0bb400268337d6e942ca", "child": "3a290cc60a0a0bb400000bdb386af1cf" } ] }, "cmdb": { "relations": [], "items": [ { "values": { "sys_id": "3a172e820a0a0bb40034228e9f65f1be", "name": "PS LoadBal01" }, "className": "cmdb_ci_win_server" }, { "values": { "sys_id": "3a2810c20a0a0bb400268337d6e942ca", "name": "PS Apache03" }, "className": "cmdb_ci_web_server" }, { "values": { "sys_id": "55b35562c0a8010e01cff22378e0aea9", "name": "ny8500-nbxs08" }, "className": "cmdb_ci_netgear" }, { "values": { "sys_id": "3a27f1520a0a0bb400ecd6ff7afcf036", "name": "PS Apache02" }, "className": "cmdb_ci_web_server" }, { "values": { "sys_id": "3a307c930a0a0bb400353965d0b8861f", "name": "PS ORA01" }, "className": "cmdb_ci_database" } ] } } ## アプリケーションサービス:GET /now/cmdb/csdm/app_service/find_service {#ariaid-title3} 指定されたアプリケーションサービスとそれに関連するビジネスコンテキストに関する基本情報を返します。 注: このエンドポイントは廃止されました。代わりに [SG サービス -- POST /sg_services/app_service/find](https://servicenow-prod.fluidtopics.net/CW0YS6Evuq8m_BUE1Rseyg#sg_svcs-POST-find "指定されたアプリケーションサービスとそのアップストリームの関係の詳細を検索します。") を使用してください。 ### URL 形式 デフォルト URL: /api/now/cmdb/csdm/app_service/find_service ### サポートされている要求パラメーター {#appservice-GET-find_service__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 7. パスパラメーター] {#appservice-GET-find_service__entry__6} | 名前 | 説明 | |-|-| | name | numberが渡されない場合は必須です。情報を返すサービスの名前。 データタイプ：文字列 テーブル:サービスインスタンス \[cmdb_ci_service_auto\] | | number | nameが渡されない場合は必須です。情報を返すアプリケーションサービスを特定する一意の番号。 データタイプ：文字列 テーブル:サービスインスタンス \[cmdb_ci_service_auto\] | [表 : 8. クエリパラメーター] {#appservice-GET-find_service__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 9. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#appservice-GET-find_service__entry__16}{#appservice-GET-find_service__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 10. 要求ヘッダー] {#appservice-GET-find_service__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 11. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#appservice-GET-find_service__table_wwn_rhd_ct__entry__2}{#appservice-GET-find_service__entry-200-status-code}{#appservice-GET-find_service__entry-400-status-code}{#appservice-GET-find_service__entry-401-appservice}{#appservice-GET-find_service__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 401 | 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 12. ステータスコード] {#appservice-GET-find_service__table_wwn_rhd_ct} ### 応答本文のパラメーター (JSON または XML) {#appservice-GET-find_service__entry__34}{#appservice-GET-find_service__entry-error-appservice}{#appservice-GET-find_service__entry-error-details-appservice}{#appservice-GET-find_service__entry-error-message-appservice} | 名前 | 説明 | |-|-| | エラー | 発生したエラーについて説明します。 データタイプ: オブジェクト "error": { "details": "String", "message": "String" } | | error.details | エラーに関する追加情報。 データタイプ：文字列 | | error.message | エラーを説明するメッセージ。 データタイプ：文字列 | | のサービス | オブジェクトのアレイ。各オブジェクトには、指定されたアプリケーションサービスに関連付けられたサービスの詳細が含まれています。 データタイプ：アレイ "services": [ { "environment": "String", "name": "String", "number": "String", "relationships": {Object}, "sys_id": "String", "version": "String" } ] | | services.environment | 「本番」や「テストラボ 2」など、アプリケーションサービスが展開される環境。これは、実装者にとって意味のある任意の値にすることができます。 データタイプ：文字列 最大長：40 デフォルト値:null | | services.name | 必須です。アプリケーションサービスの名前。他のすべてのアプリケーションサービスと一意の名前である必要があります。 データタイプ：文字列 最大長:255 | | services.number | アプリケーションサービスを特定する一意の番号。この値は、最初にエンドポイントによって生成されます。 データタイプ：文字列 | | services.relationships | アプリケーションサービスに関連付けられたサービスタイプ。 データタイプ: オブジェクト "relationships": { "business_app": [Array], "business_service_offering": [Array], "technical_service_offering": [Array] } | | services.relationships.business_app | アプリケーションサービスに関連するビジネスアプリケーションのsys_idsのリスト。 データタイプ：アレイ | | services.relationships.technical_service_offering | アプリケーションサービスに関連する技術管理オファリング (以前のテクニカルサービスオファリング) のsys_idsのリスト。 データタイプ：アレイ | | services.relationships.business_service_offering | アプリケーションサービスに関連するビジネスサービスオファリングのsys_idsのリスト。 データタイプ：アレイ | | services.sys_id | アプリケーションサービスの sys_id。 データタイプ：文字列 | | services.version | アプリケーションサービスのバージョン番号。 データタイプ：文字列 最大長：40 形式:ユーザー定義可能 デフォルト値:null | [ ] ### cURL 要求のサンプル curl -X GET \ https://instance.servicenow.com/api/now/cmdb/csdm/app_service/find_service?name=Email_East&number=SNSVC0001018 \ -H 'Accept: application/json' \ -u 'username':'password' { "result": { "services": [ { "name": "Email_East", "number": "SNSVC0001018", "sys_id": "f809cb60db94101037740f95ca96190f", "environment": "Production", "version": "1.1.1", "relationships": { "business_app": [ "658c7620db54101037740f95ca9619f2" ], "technical_service_offering": [], "business_service_offering": [ "069c7e20db54101037740f95ca9619bf" ] } } ] } } ## アプリケーションサービス:POST /now/cmdb/app_service/create {#ariaid-title4} アプリケーションサービスを作成するか、既存のアプリケーションサービスを更新します。 ### URL 形式 デフォルト URL: /api/now/cmdb/app_service/create ### サポートされている要求パラメーター {#createService-POST-api-now-cmdb-app__entry__2} | パラメーター | 説明 | |-|-| | なし | | [表 : 13. パラメーター] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#createService-POST-api-now-cmdb-app__entry__6}{#createService-POST-api-now-cmdb-app__accept-RESTAPI}{#createService-POST-api-now-cmdb-app__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 14. 要求ヘッダー] {#createService-POST-api-now-cmdb-app__entry__12} | ヘッダー | 説明 | |-|-| | なし | | [表 : 15. 応答ヘッダー] ### ステータスコード 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#createService-POST-api-now-cmdb-app__table_wwn_rhd_ct__entry__2}{#createService-POST-api-now-cmdb-app__entry-200-status-code}{#createService-POST-api-now-cmdb-app__entry-400-status-code}{#createService-POST-api-now-cmdb-app__entry-401-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 | [表 : 16. ステータスコード] {#createService-POST-api-now-cmdb-app__table_wwn_rhd_ct} ### 要求本文 API は、要求本文でこれらの JSON 要素を受け入れます。さらに、マップ済みアプリケーションサービス \[cmdb_ci_service_discovered\] テーブルから任意のフィールドを追加して、アプリケーションサービスレコードにデータを渡すことができます。たとえば、\[コメント\] フィールドにコンテンツを追加するには、JSON 要求に `「comments: "Passing data to the Comments field"` を追加します。 {#createService-POST-api-now-cmdb-app__table_rm1_yjd_kv__entry__2} | 要素 | 説明 | |-|-| | name | 作成または更新するアプリケーションサービスの名前。 | | service_relations | CI と CI が形成する階層に関する情報。すべての CI は、親 CI および子 CI とのペアを形成します。アプリケーションサービスのエントリーポイントと呼ばれるトップレベル CI には親 CI がありません。 | | 親 | マップ階層の下位レベルの CI をこの CI と結合する送信接続を持つ CI の Sys_ ID。 | | child | Sys_、その受信接続がマップ階層の上位レベルにある CI とこの CI を結合する CI の ID。 | [表 : 17. 要求本文で承認された要素] {#createService-POST-api-now-cmdb-app__table_rm1_yjd_kv} ### 応答本文 API は、応答本文でこれらの JSON 要素を返します。 {#createService-POST-api-now-cmdb-app__table_mc1_pr1_tx__entry__2} | 要素 | 説明 | |-|-| | URL | アプリケーションサービスレコードのsys_idを表示するための標準テーブル REST API の URL。 この要素は、エンドポイントが成功した場合にのみ表示されます。 データタイプ：文字列 | | getContentUrl | アプリケーションサービスコンテンツを取得するための REST API パス。 この要素は、エンドポイントが成功した場合にのみ表示されます。 データタイプ：文字列 | | info | アプリケーションサービスに追加された CI の数。 この要素は、エンドポイントが成功した場合にのみ表示されます。 データタイプ：文字列 | | エラー | エラーメッセージの詳細。 この要素は、エンドポイントに障害が発生した場合のみ表示されます。 データタイプ: オブジェクト | | メッセージ | エラーの性質を説明するエラーメッセージ。 この要素は、エンドポイントに障害が発生した場合のみ表示されます。 データタイプ：文字列 | | status | REST API が失敗した場合は「失敗」と表示されます。 この要素は、エンドポイントに障害が発生した場合のみ表示されます。 データタイプ：文字列 | [表 : 18. 応答本文で返される要素] {#createService-POST-api-now-cmdb-app__table_mc1_pr1_tx} ### cURL 要求のサンプル curl "http:///api/now/cmdb/app_service/create" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\": \"myTestAppService\", \"comments\": \"Passing data to the Comments field\", \"service_relations\": [ { \"parent\": \"\", \"child\": \"3a70f789c0a8ce010091b0ea635b982a\" },{ \"parent\": \"3a70f789c0a8ce010091b0ea635b982a\", \"child\": \"b4fd7c8437201000deeabfc8bcbe5dc1\" },{ \"parent\": \"b4fd7c8437201000deeabfc8bcbe5dc1\", \"child\": \"53fdbc8437201000deeabfc8bcbe5d10\" } ] }" \ --user 'admin':'admin' { "result": { "url": "/api/now/table/cmdb_ci_service_discovered/b1cff89fc9e19300964fcbb1ac3059a5", "getContentUrl": "/api/now/cmdb/app_service/b1cff89fc9e19300964fcbb1ac3059a5/getContent", "info": "3 CIs added to service" } } ## アプリケーションサービス:POST /now/cmdb/csdm/app_service/register_service {#ariaid-title5} サービスインスタンス \[cmdb_ci_service_auto\] テーブルにアプリケーションサービスレコードスタブを作成し、渡された情報を入力します。 レコードを保存する前に、渡されたパラメーターとアプリケーションサービス名の一意性を検証します。また、指定されたビジネスアプリケーション、ビジネスサービスオファリング、および技術管理オファリング (以前のテクニカルサービスオファリング) をサービスアプリケーションに関連付けることで サービスにビジネスコンテキストを提供するアップストリームの関係を作成します。インフラストラクチャとの下流の関係は作成されません。下流の関係を定義するには、 アプリケーションサービス - PUT /now/cmdb/csdm/app_service/{service_sys_id}/populate_service エンドポイントを呼び出す必要があります。 注: このエンドポイントは廃止されました。代わりに [SG サービス -- POST /sg_services/app_service/register](https://servicenow-prod.fluidtopics.net/CW0YS6Evuq8m_BUE1Rseyg#sg_svcs-POST-register "アプリケーションサービス、タグを作成し、ビジネスアプリケーション、ビジネスサービスオファリング、その他のアプリケーションサービスなどのアップストリームの関係をビルドします。") を使用してください。 ### URL 形式 デフォルト URL: /api/now/cmdb/csdm/app_service/register_service ### サポートされている要求パラメーター {#appservice-POST-register_service__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 19. パスパラメーター] {#appservice-POST-register_service__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 20. クエリパラメーター] {#appservice-POST-register_service__entry__10}{#appservice-POST-register_service__entry-basic_details-environment-appservice}{#appservice-POST-register_service__entry-basic_details-name-appservice}{#appservice-POST-register_service__entry-basic_details-version-appservice}{#appservice-POST-register_service__entry-relationships-bus_app-appservice}{#appservice-POST-register_service__entry-relationships-bus_srv_off-appservice}{#appservice-POST-register_service__entry-relationships-tech_srv_off-appservice} | 名前 | 説明 | |-|-| | basic_details | 必須です。指定されたアプリケーションサービスに関連付けられているサービスの詳細。 データタイプ: オブジェクト "basic_details": { "environment": "String", "name": "String", "version": "String" } | | basic_details.environment | 「本番」や「テストラボ 2」など、アプリケーションサービスが展開される環境。これは、実装者にとって意味のある任意の値にすることができます。 データタイプ：文字列 最大長：40 デフォルト値:null | | basic_details.name | 必須です。アプリケーションサービスの名前。他のすべてのアプリケーションサービスと一意の名前である必要があります。 データタイプ：文字列 最大長:255 | | basic_details.version | アプリケーションサービスのバージョン番号。 データタイプ：文字列 最大長：40 形式:ユーザー定義可能 デフォルト値:null | | relationships | アプリケーションサービスに関連付けるアップストリーム (親) サービスタイプ。 データタイプ: オブジェクト "relationships": { "business_app": [Array], "business_service_offering": [Array], "technical_service_offering": [Array] } テーブル:CI 関係 \[cmdb_rel_ci\] | | relationships.business_app | アプリケーションサービスに関連付けるビジネスアプリケーションのsys_idsのリスト。 データタイプ：アレイ | | relationships.business_service_offering | アプリケーションサービスに関連付けるビジネスサービスオファリングのsys_idsのリスト。 データタイプ：アレイ | | relationships.technical_service_offering | アプリケーションサービスに関連付けるテクニカルサービスオファリングのsys_idsのリスト。 データタイプ：アレイ | [表 : 21. 要求本文のパラメーター] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#appservice-POST-register_service__table_hxm_cks_mlb__entry__2}{#appservice-POST-register_service__accept-JSON-only-entry-RESTAPI}{#appservice-POST-register_service__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 22. 要求ヘッダー] {#appservice-POST-register_service__table_hxm_cks_mlb} {#appservice-POST-register_service__entry__34} | ヘッダー | 説明 | |-|-| | なし | | [表 : 23. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#appservice-POST-register_service__table_wwn_rhd_ct__entry__2}{#appservice-POST-register_service__entry-400-status-code}{#appservice-POST-register_service__entry-401-appservice}{#appservice-POST-register_service__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 201 | 成功。アプリケーションサービスが正常に登録されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 401 | 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 24. ステータスコード] {#appservice-POST-register_service__table_wwn_rhd_ct} ### 応答本文のパラメーター (JSON または XML) {#appservice-POST-register_service__entry__48}{#appservice-POST-register_service__entry-error-appservice}{#appservice-POST-register_service__entry-error-details-appservice}{#appservice-POST-register_service__entry-error-message-appservice} | 名前 | 説明 | |-|-| | エラー | 発生したエラーについて説明します。 データタイプ: オブジェクト "error": { "details": "String", "message": "String" } | | error.details | エラーに関する追加情報。 データタイプ：文字列 | | error.message | エラーを説明するメッセージ。 データタイプ：文字列 | | number | アプリケーションサービスを特定する一意の番号。この番号はエンドポイントによって生成されます。 データタイプ：文字列 | | service_sys_id | 登録済みアプリケーションサービスのSys_id。 データタイプ：文字列 | [ ] ### cURL 要求のサンプル curl -X POST \ https://instance.servicenow.com/api/now/cmdb/csdm/app_service/register_service \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -u 'username':'password' -d '{ "basic_details": { "environment": "Test Lab 2", "name": "Test Lab 2", "version": "1.1.1" }, "relationships": { "business_app":["f07c7620db54101037740f95ca96199a"], "business_service_offering":["069c7e20db54101037740f95ca9619bf"] } }' { "result": { "service_sys_id": "80f21bbadbd410103d3a93c3e296199a", "number": "SNSVC0001018" } } ## アプリケーションサービス:PUT /now/cmdb/csdm/app_service/{service_sys_id}/populate_service {#ariaid-title6} 指定されたアプリケーションサービスに、下流の構成アイテム (CI) の指定されたセットを入力します。 このエンドポイントを呼び出す前に、 [POST /now/cmdb/csdm/app_service/register_service](https://servicenow-prod.fluidtopics.net/rAtCy2JogqQVf0c6RucgHQ#appservice-POST-register_service "サービスインスタンス [cmdb_ci_service_auto] テーブルにアプリケーションサービスレコードスタブを作成し、渡された情報を入力します。") エンドポイントを呼び出してアプリケーションサービスを作成する必要があります。 注: このエンドポイントは廃止されました。代わりに [SG サービス -- POST /sg_services/app_service/populate](https://servicenow-prod.fluidtopics.net/CW0YS6Evuq8m_BUE1Rseyg#sg_svcs-POST-populate "サービスの作成方法を使用して、アプリケーションサービスを設定します。") を使用してください。 ### URL 形式 デフォルト URL: /api/now/cmdb/csdm/app_service/{service_sys_id}/populate_service ### サポートされている要求パラメーター {#appservice-PUT-populate_service__entry__2} | 名前 | 説明 | |-|-| | service_sys_id | 指定された CI を設定するアプリケーションサービスのSys_id。 データタイプ：文字列 テーブル:サービスインスタンス \[cmdb_ci_service_auto\] | [表 : 25. パスパラメーター] {#appservice-PUT-populate_service__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 26. クエリパラメーター] {#appservice-PUT-populate_service__entry__10} | 名前 | 説明 | |-|-| | population_method | 指定されたアプリケーションサービスに関連付ける CI。population_method オブジェクトの要素は、type パラメーターで定義される入力される情報のタイプによって異なります。 データタイプ: オブジェクト type = cmdb_group_based の場合 "population_method": { "group_id": "String", "type": "String" } type = ディスカバリーの場合 注: このタイプを使用するには、サービスマッピング (com.snc.service-mapping) プラグインを有効にする必要があります。 "population_method": { "attributes": [Array], "entry_point_id": "String", "type": "String" } type = tag_list の場合 注: このタイプを使用するには、サービスマッピング (com.snc.service-mapping) プラグインを有効にする必要があります。 "population_method": { "tags": [Array], "type": "String" } | | population_method.attributes | ホスト、ポート、名前、URL など、CI に関連付ける属性のリスト。 注: 必要なすべての属性を渡す必要があります。 データタイプ：アレイ "attributes": { "name":"String", "value":"String" } | | population_method.attributes.name | ホスト、ポート、名前、URL などの属性の名前。 データタイプ：文字列 | | population_method.attributes.value | 属性値。 データタイプ：文字列 | | population_method.entry_point | population_method.type = ディスカバリーの場合は必須です。アプリケーションサービスへのエントリーポイント。エントリーポイントの詳細については、「 [エントリーポイント属性」](https://www.servicenow.com/docs/access?context=r_EntryPointsforBizSvcDef&version=australia&pubname=australia-it-operations-management&ft:locale=en-US) および [「サービスマッピングのエントリーポイントタイプの作成](https://www.servicenow.com/docs/access?context=t_CreateEntryPoint&version=australia&pubname=australia-it-operations-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | population_method.group_id | population_method.type = cmdb_group_based の場合は必須です。CI に関連付けるグループのSys_id。 データタイプ：文字列 タイトル:CMDB グループ \[cmdb_group\] | | population_method.tags | CI に関連付けるタグのリスト。 データタイプ：オブジェクトのアレイ [ "tags": { "tag": "String", "value": "String" } ] タイトル: Key Values \[cmdb_key_value\] | | population_method.tags.tag | タグの名前。 データタイプ：文字列 | | population_method.tags.value | タグ値。 データタイプ：文字列 | | population_method.type | 必須です。入力する CI のタイプ。 有効な値： * cmdb_group_based * ディスカバリー * tag_list {#appservice-PUT-populate_service__ul_j42_5jm_tlb} データタイプ：文字列 | [表 : 27. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#appservice-PUT-populate_service__table_h3m_gh2_mlb__entry__2}{#appservice-PUT-populate_service__accept-JSON-only-entry-RESTAPI}{#appservice-PUT-populate_service__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 28. 要求ヘッダー] {#appservice-PUT-populate_service__table_h3m_gh2_mlb} {#appservice-PUT-populate_service__entry__38} | ヘッダー | 説明 | |-|-| | なし | | [表 : 29. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#appservice-PUT-populate_service__entry__42}{#appservice-PUT-populate_service__entry-200-status-code}{#appservice-PUT-populate_service__entry-401-appservice}{#appservice-PUT-populate_service__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 30. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#appservice-PUT-populate_service__entry__50}{#appservice-PUT-populate_service__entry-error-appservice}{#appservice-PUT-populate_service__entry-error-details-appservice}{#appservice-PUT-populate_service__entry-error-message-appservice} | 名前 | 説明 | |-|-| | エラー | 発生したエラーについて説明します。 データタイプ: オブジェクト "error": { "details": "String", "message": "String" } | | error.details | エラーに関する追加情報。 データタイプ：文字列 | | error.message | エラーを説明するメッセージ。 データタイプ：文字列 | [ ] ### cURL 要求のサンプル 次のコード例は、CI タイプが cmdb_group_based の場合にアプリケーションサービスを設定する方法を示しています。 curl -X PUT \ https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -u 'username':'password' \ -d '{ "population_method": { "type":"cmdb_group_based", "group_id": "e809cf60db94101037640f95ca961932" } }' { "result": {} } 次のコード例は、ディスカバリーアプリケーションサービスを設定する方法を示しています。 curl -X PUT \ https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -u 'username':'password' \ -d '{ "population_method": { "type":"discovery", "entry_point_id":"cmdb_ci_endpoint_ad_forest", "attributes": [ { "name":"host", "value":"test1.com" }, { "name":"port", "value":"500" }, { "name":"protocol", "value":"ssh" } ] } }' { "result": {} } ## アプリケーションサービス - PUT /now/cmdb/csdm/app_service/{service_sys_id}/service_details {#ariaid-title7} 指定されたアプリケーションサービスを渡された基本情報で更新します。 また、渡された情報をアプリケーションサービスクラスで定義された識別および調整エンジン (IRE) ルールと照合することで、アプリケーションサービスの一意性を検証します。 注: このエンドポイントは廃止されました。代わりに [SG サービス -- POST /sg_services/app_service/update](https://servicenow-prod.fluidtopics.net/CW0YS6Evuq8m_BUE1Rseyg#sg_svcs-POST-update "提供された既存のアプリケーションサービスを更新し、指定されたアプリケーションサービスのタグを作成します。") を使用してください。 ### URL 形式 デフォルト URL: /api/now/cmdb/csdm/app_service/{service_sys_id}/service_details ### サポートされている要求パラメーター {#appservice-PUT-service_details__entry__2} | 名前 | 説明 | |-|-| | service_sys_id | 更新するアプリケーションサービスのSys_id。 データタイプ：文字列 テーブル:サービスインスタンス \[cmdb_ci_service_auto\] | [表 : 31. パスパラメーター] {#appservice-PUT-service_details__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 32. クエリパラメーター] {#appservice-PUT-service_details__entry__10}{#appservice-PUT-service_details__entry-basic_details-appservice}{#appservice-PUT-service_details__entry-basic_details-environment-appservice}{#appservice-PUT-service_details__entry-basic_details-name-appservice}{#appservice-PUT-service_details__entry-relationships-appservice}{#appservice-PUT-service_details__entry-relationships-bus_app-appservice}{#appservice-PUT-service_details__entry-relationships-bus_srv_off-appservice}{#appservice-PUT-service_details__entry-relationships-tech_srv_off-appservice} | 名前 | 説明 | |-|-| | basic_details | 指定されたアプリケーションサービスに関連付けられているサービスの詳細。 データタイプ: オブジェクト "basic_details": { "environment": "String", "name": "String" } | | basic_details.environment | 「本番」や「テストラボ 2」など、アプリケーションサービスが展開される環境。これは、実装者にとって意味のある任意の値にすることができます。 データタイプ：文字列 最大長：40 デフォルト値:null | | basic_details.name | 必須です。アプリケーションサービスの名前。他のすべてのアプリケーションサービスと一意の名前である必要があります。 データタイプ：文字列 最大長:255 | | relationships | アプリケーションサービスに関連付けるサービスタイプ。CI 関係 \[cmdb_rel_ci\] テーブルにあります。 データタイプ: オブジェクト "relationships": { "business_app": [Array], "business_service_offering": [Array], "technical_service_offering": [Array] } | | relationships.business_app | アプリケーションサービスに関連付けるビジネスアプリケーションのsys_idsのリスト。 データタイプ：アレイ | | relationships.business_service_offering | アプリケーションサービスに関連付けるビジネスサービスオファリングのsys_idsのリスト。 データタイプ：アレイ | | relationships.technical_service_offering | アプリケーションサービスに関連付けるテクニカルサービスオファリングのsys_idsのリスト。 データタイプ：アレイ | [表 : 33. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#appservice-PUT-service_details__entry__26}{#appservice-PUT-service_details__accept-JSON-only-entry-RESTAPI}{#appservice-PUT-service_details__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 34. 要求ヘッダー] {#appservice-PUT-service_details__entry__32} | ヘッダー | 説明 | |-|-| | なし | | [表 : 35. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#appservice-PUT-service_details__entry__36}{#appservice-PUT-service_details__entry-200-status-code}{#appservice-PUT-service_details__entry-401-appservice} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | 権限がありません。ユーザー認証情報が間違っているか、app_service_admin ロールがありません。 | [表 : 36. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#appservice-PUT-service_details__entry__42}{#appservice-PUT-service_details__entry-error-appservice}{#appservice-PUT-service_details__entry-error-details-appservice}{#appservice-PUT-service_details__entry-error-message-appservice} | 名前 | 説明 | |-|-| | エラー | 発生したエラーについて説明します。 データタイプ: オブジェクト "error": { "details": "String", "message": "String" } | | error.details | エラーに関する追加情報。 データタイプ：文字列 | | error.message | エラーを説明するメッセージ。 データタイプ：文字列 | [ ] ### cURL 要求のサンプル curl -X PUT \ https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/service_details \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -u 'username':'password' \ -d '{ "basic_details": { "environment": "Test Lab 2" }, "relationships": { "business_app" :["f07c7620db54101037740f95ca96199a"] } }' { "result": {} }