--- 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) 所要時間：69分デジタルプロダクトリリース API は、リリースとポリシーコンプライアンスを管理するためのエンドポイントを提供します。この API には、ServiceNow Store で利用可能なデジタルプロダクトリリース (sn_dpr) アプリケーションが必要です。詳細については、「[Digital Product Release](https://www.servicenow.com/docs/access?context=dpr-landing-page&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。 ## デジタルプロダクトリリース:GET /sn_dpr/digital_product_release/bundle/{sysId} {#ariaid-title2} リリースバンドルの詳細を取得します。このエンドポイントを拡張すると、応答本文で返されるフィールドと集計データをカスタマイズできます。このエンドポイントのデフォルト機能は、ReleaseBundleSNC スクリプトインクルードの getReleaseBundleDetails() メソッドによって定義されます。機能をカスタマイズするには、ReleaseBundle スクリプトインクルードの getReleaseBundleDetails() メソッドを上書きします。このメソッドは ReleaseBundleSNC を拡張します。デフォルトでは、機能拡張、ポリシー、リリース状況、およびタスク数の集計データを応答本文に含めることができます。このエンドポイントにアクセスするには、発信者は次のいずれかのロールを持っている必要があります。 * sn_dpr_model.product_manager * sn_dpr_model.release_admin * sn_dpr_model.release_coordinator * sn_dpr_model.release_user {#dpr-GET-bundle__ul_nwh_2fr_2hc} ### URL 形式バージョニングされた URL: /api/sn_dpr/{api_version}/digital_product_release/bundle/{sysId} デフォルト URL: /api/sn_dpr/digital_product_release/bundle/{sysId} ### サポートされている要求パラメーター {#dpr-GET-bundle__entry__2}{#dpr-GET-bundle__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | sysId | リリースバンドルのSys_id。テーブル:リリースバンドル \[sn_dpr_model_release_bundle\] データタイプ：文字列 | [表 : 1. パスパラメーター] {#dpr-GET-bundle__entry__8} | 名前 | 説明 | |-|-| | sendAggregation | 機能拡張、ポリシー、リリース状況、およびタスク数の集計データを応答本文に含めるかどうかを示すフラグ。データタイプ：ブーリアン有効な値： * true:機能拡張、ポリシー、リリース状況、およびタスク数の集計を返します。 * false:集計を返しません。 {#dpr-GET-bundle__ul_grf_jrg_whc} デフォルト値：false | [表 : 2. クエリパラメーター] {#dpr-GET-bundle__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 3. 要求本文パラメーター (JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#dpr-GET-bundle__entry__16}{#dpr-GET-bundle__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | 認証 | 認証用の基本トークンまたはベアラートークン。 | [表 : 4. 要求ヘッダー] {#dpr-GET-bundle__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#dpr-GET-bundle__entry__26}{#dpr-GET-bundle__entry-200-status-code}{#dpr-GET-bundle__entry-400-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター (JSON) {#dpr-GET-bundle__entry__32} | 名前 | 説明 | |-|-| | 集計 | 機能拡張、ポリシー、リリース状況、タスク数の集計データ。このパラメーターは、要求で sendAggregation クエリパラメーターが `true` に設定されている場合にのみ、応答本文に含まれます。 "aggregates": { "enhancementAggregate": {Object}, "policyAggregate": {Object}, "releaseAggregate": {Object}, "taskAggregate": {Object} } データタイプ: オブジェクト | | aggregates.enhancementAggregate | 各ステータスの拡張の数を一覧表示します。データタイプ: オブジェクト "enhancementAggregate": { "Closed": Number, "Open": Number } | | aggregates.policyAggregate | 各実行ステータスのポリシーの数をリストします。データタイプ: オブジェクト "policyAggregate": { "Executed": Number, "Pending": Number } | | aggregates.releaseAggregate | 各ステータスのリリースの数をリストします。状況は、少なくとも 1 つのリリースがその状況にある場合にのみこのオブジェクトに含まれます。データタイプ: オブジェクト "releaseAggregate": { "Cancelled": Number, "Completed": Number, "Draft": Number, "In Progress": Number, "Pending": Number, "Restarting": Number, "Review": Number } | | aggregates.taskAggregate | 承認されたタスクと未承認のタスクの数を一覧表示します。データタイプ: オブジェクト "taskAggregate": { "approval": Number, "nonApproval": Number } | | name | リリースバンドルの名前。データタイプ：文字列 | | owner | リリースバンドルの所有者。データタイプ：文字列 | | リリース | バンドルに含まれるリリースに関するデータ。 "releases": { "count": Number, "list": [Array] } データタイプ: オブジェクト | | releases.count | バンドルに含まれるリリースの数。データタイプ：数値 | | releases.list | バンドルに含まれるリリースのsys_idsのリスト。テーブル:リリース \[sn_dpr_model_release\] データタイプ：アレイ | | sysId | リリースバンドルのSys_id。テーブル:リリースバンドル \[sn_dpr_model_release_bundle\] データタイプ：文字列 | [ ] ### cURL 要求この例では、拡張、ポリシー、リリース状況、タスク数の集計データなど、指定されたリリースバンドルに関する詳細を取得します。 curl -X GET \ "https://instance.service-now.com/api/sn_dpr/v1/digital_product_release/bundle/9d0d0b4c874b1110dba83d5ebf867de2?sendAggregation=true" \ --header "Accept: application/json" \ --header "Authorization: Basic " 応答本文。 { "sysId": "9d0d0b4c874b1110dba83d5ebf867de2", "name": "Release Bundle Q4", "owner": "jane.doe", "releases": { "count": 2, "list": ["rel1", "rel2"] }, "aggregates": { "releaseAggregate": { "In Progress": 1, "Completed": 1 }, "taskAggregate": { "approval": 3, "nonApproval": 5 }, "policyAggregate": { "Executed": 2, "Pending": 1 }, "enhancementAggregate": { "Open": 1, "Closed": 1 } } } ## デジタルプロダクトリリース:GET /sn_dpr/digital_product_release/releases/{releaseId}/policies/status {#ariaid-title3} リリースの現在のフェーズのポリシー実行の詳細を製品別に取得します。このエンドポイントにアクセスするには、発信者は次のいずれかのロールを持っている必要があります。 * sn_dpr_model.product_manager * sn_dpr_model.release_admin * sn_dpr_model.release_coordinator * sn_dpr_model.release_user {#dpr-GET-releases-policies-status__ul_nwh_2fr_2hc} このエンドポイントを呼び出す前に、リリースステータスが \[処理中 \] である必要があり、現在のフェーズステータスも \[処理中\] である必要があります。\[リリース\] タブのデジタルプロダクトリリースワークスペースでリリース情報を表示できます。 ### URL 形式バージョニングされた URL: /api/sn_dpr/{api_version}/digital_product_release/releases/{releaseId}/policies/status デフォルト URL: /api/sn_dpr/digital_product_release/releases/{releaseId}/policies/status ### サポートされている要求パラメーター {#dpr-GET-releases-policies-status__entry__2}{#dpr-GET-releases-policies-status__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | releaseId | リリースのSys_id。テーブル:リリース \[sn_dpr_model_release\] データタイプ：文字列 | [表 : 7. パスパラメーター] {#dpr-GET-releases-policies-status__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 8. クエリパラメーター] {#dpr-GET-releases-policies-status__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 9. 要求本文パラメーター (JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#dpr-GET-releases-policies-status__entry__16}{#dpr-GET-releases-policies-status__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 10. 要求ヘッダー] {#dpr-GET-releases-policies-status__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 11. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#dpr-GET-releases-policies-status__table_csx_jkm_fhc__entry__2}{#dpr-GET-releases-policies-status__entry-200-status-code}{#dpr-GET-releases-policies-status__entry-400-status-code}{#dpr-GET-releases-policies-status__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 12. ステータスコード] {#dpr-GET-releases-policies-status__table_csx_jkm_fhc} ### 応答本文のパラメーター (JSON) {#dpr-GET-releases-policies-status__entry__32} | 名前 | 説明 | |-|-| | result | コンプライアンスサマリーと製品ポリシーの詳細を含むオブジェクト。データタイプ: オブジェクト "result": { "overallSummary": {Object}, "products": [Array] } | | result.overallSummary | 現在のリリースフェーズのポリシーコンプライアンスサマリー。データタイプ: オブジェクト "overallSummary": { "compliant": Boolean, "compliantCount": Number, "currentPhase": "String", "nonCompliantCount": Number, "timestamp": "String", "totalCount": Number } | | result.overallSummary.compliant | 現在のリリースフェーズで評価されたすべてのポリシーが準拠しているかどうかを示すフラグ。有効な値： * true:評価されたすべてのポリシーが準拠しています。 * false:すべての評価済みポリシーが準拠しているわけではありません。 {#dpr-GET-releases-policies-status__ul_vmf_vvc_hhc} データタイプ：ブーリアン | | result.overallSummary.compliantCount | 準拠しているポリシーの数。データタイプ：数値 | | result.overallSummary.currentPhase | 現在のリリースフェーズの名前。データタイプ：文字列 | | result.overallSummary.nonCompliantCount | 非準拠ポリシーの数。データタイプ：数値 | | result.overallSummary.timestamp | ポリシーコンプライアンスが最後に評価された日時。データタイプ：文字列 | | result.overallSummary.totalCount | 評価されたポリシーの合計数。データタイプ：数値 | | result.products | 製品レベルのコンプライアンス結果のリスト。アレイ内の各オブジェクトは製品を表します。データタイプ：アレイ "products": [ { "policyExecutionDetails": [Array], "productId": "String", "productName": "String", "productVersion": "String", "summary": {Object} } ] | | result.products.policyExecutionDetails | コンプライアンス結果を含む実行済みポリシーのリスト。アレイ内の各オブジェクトはポリシーを表します。データタイプ：アレイ "policyExecutionDetails": [ { "executionOutput": "Check sum OK; 0 violations. Execution log id: e23-9a.", "lastRunAt": "2025-09-26T08:30:00Z", "name": "Policy Name 1", "policyId": "policyVersionSysId1", "reason": "All checks passed", "status": "compliant" } ] | | result.products.policyExecutionDetails.executionOutput | ポリシーの実行によって生成された出力メッセージ。データタイプ：文字列 | | result.products.policyExecutionDetails.lastRunAt | ポリシーのコンプライアンスが最後に評価された日時。データタイプ：文字列 | | result.products.policyExecutionDetails.name | ポリシーの表示名。データタイプ：文字列 | | result.products.policyExecutionDetails.policyId | ポリシーのSys_id。テーブル:ポリシー \[sn_pace_policy\] データタイプ：文字列 | | result.products.policyExecutionDetails.reason | ポリシーが準拠または非準拠の理由を説明するメッセージ。データタイプ：文字列 | | result.products.policyExecutionDetails.status | ポリシーのコンプライアンスステータス。有効な値： * 準拠 * non_compliant * not_run {#dpr-GET-releases-policies-status__ul_yqv_x1d_hhc} データタイプ：文字列 | | result.products.productId | 製品のSys_id。テーブル:製品モデル \[cmdb_model\] データタイプ：文字列 | | result.products.productName | 製品の表示名。データタイプ：文字列 | | result.products.productVersion | 現在のリリースの製品に関連付けられているバージョン。データタイプ：文字列 | | result.products.summary | 製品のコンプライアンス結果。データタイプ: オブジェクト "summary": { "compliant": Boolean, "compliantCount": Number, "nonCompliantCount": Number, "totalCount": Number } | | result.products.summary.compliant | 製品のすべてのポリシーが準拠しているかどうかを示すフラグ。有効な値： * true:すべてのポリシーが準拠しています。 * false:すべてのポリシーが準拠しているわけではありません。 {#dpr-GET-releases-policies-status__ul_kh3_myc_hhc} データタイプ：ブーリアン | | result.products.summary.compliantCount | 準拠しているポリシーの数。データタイプ：数値 | | result.products.summary.nonCompliantCount | 非準拠ポリシーの数。データタイプ：数値 | | result.products.summary.totalCount | 製品について評価されたポリシーの合計数。データタイプ：数値 | [ ] ### cURL 要求この例では、指定されたリリースの現在のフェーズのポリシー実行の詳細を取得します。 curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/releases/d4982eeb474b621027d48b41516d4385/policies/status" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 応答本文。 { "result": { "overallSummary": { "compliant": false, "compliantCount": 3, "nonCompliantCount": 2, "totalCount": 5, "currentPhase": "Phase Name", "timestamp": "2025-09-26T09:15:00Z" }, "products": [ { "productId": "f8fe5fd40a0a0b9100f91d64df145295", "productName": "Payments Service", "productVersion": "v2.4.1", "summary": { "compliant": false, "compliantCount": 1, "nonCompliantCount": 1, "totalCount": 2 }, "policyExecutionDetails": [ { "name": "Policy Name 1", "policyId": "f6783cc843590210ab16fc4bbcb8f223", "status": "compliant", "lastRunAt": "2025-09-26T08:30:00Z", "executionOutput": "Check sum OK; 0 violations. Execution log id: e23-9a.", "reason": "All checks passed" }, { "name": "Policy Name 2", "policyId": "152bb04c43590210ab16fc4bbcb8f2a7", "status": "non_compliant", "lastRunAt": "2025-09-26T08:32:00Z", "executionOutput": "Validation failed at step 3: required configuration missing.", "reason": "Missing required configuration 'payments.retry_limit'" } ] } ] } } ## デジタルプロダクトリリース:POST /sn_dpr/digital_product_release/product_enhancement {#ariaid-title4} 製品またはサービスの拡張を作成します。このエンドポイントにアクセスするには、発信者は sn_dpr_model.product_manager ロールを持っている必要があります。 ### URL 形式バージョニングされた URL: /api/sn_dpr/{api_version}/digital_product_release/product_enhancement デフォルト URL: /api/sn_dpr/digital_product_release/product_enhancement ### サポートされている要求パラメーター {#dpr-POST-product_enhancement__entry__2}{#dpr-POST-product_enhancement__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 13. パスパラメーター] {#dpr-POST-product_enhancement__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 14. クエリパラメーター] {#dpr-POST-product_enhancement__entry__10} | 名前 | 説明 | |-|-| | description | 拡張の説明。データタイプ：文字列 | | name | 必須です。拡張の名前。データタイプ：文字列 | | priority | 拡張の優先度。有効な値： * 高 * medium * 低 {#dpr-POST-product_enhancement__ul_mkf_p5h_whc} デフォルト:medium データタイプ：文字列 | | productFeatureSysId | 拡張に関連付ける製品機能のSys_id。テーブル:製品の特徴 \[sn_dpr_model_product_feature\] データタイプ：文字列 | | productSysId | 必須です。拡張に関連付ける製品またはサービスのSys_id。テーブル:アプリケーションモデル \[cmdb_application_product_model\] またはサービスモデル \[cmdb_service_product_model\] データタイプ：文字列 | | releaseSysId | 拡張を追加するリリースのSys_id。リリースは、 versionSysId パラメーターで指定されたバージョンに関連付けられている必要があります。テーブル:リリース \[sn_dpr_model_release\] データタイプ：文字列 | | versionSysId | 拡張に関連付ける製品バージョンまたはサービスバージョンのSys_id。バージョンは、 productSysId パラメーターで指定されたものと同じ製品またはサービス用である必要があります。テーブル:ソフトウェアモデル \[cmdb_software_product_model\] またはサービスオファリングモデル \[cmdb_service_offering_model\] データタイプ：文字列 | [表 : 15. 要求本文パラメーター (JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#dpr-POST-product_enhancement__table_zpj_tcp_whc__entry__2}{#dpr-POST-product_enhancement__accept-JSON-only-entry-RESTAPI}{#dpr-POST-product_enhancement__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 16. 要求ヘッダー] {#dpr-POST-product_enhancement__table_zpj_tcp_whc} {#dpr-POST-product_enhancement__entry__32} | ヘッダー | 説明 | |-|-| | なし | | [表 : 17. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#dpr-POST-product_enhancement__entry__36}{#dpr-POST-product_enhancement__entry-400-status-code}{#dpr-POST-product_enhancement__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 201 | 作成されました。拡張が正常に作成されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 18. ステータスコード] ### 応答本文のパラメーター (JSON) {#dpr-POST-product_enhancement__table_fv1_gmm_fhc__entry__2} | 名前 | 説明 | |-|-| | result | API 要求の詳細。データタイプ: オブジェクト "result": { "error": Boolean, "sysId": "String" } | | result.error | API 要求にエラーがあるかどうかを示すフラグ。可能な値： * true:エラー。 * false:エラーなし。 {#dpr-POST-product_enhancement__ul_tz2_smm_fhc} データタイプ：ブーリアン | | result.sysId | 作成された拡張のSys_id。テーブル:製品の機能拡張 \[sn_dpr_model_product_enhancement\] データタイプ：文字列 | [ ] {#dpr-POST-product_enhancement__table_fv1_gmm_fhc} ### cURL 要求この例では、製品機能拡張を作成します。 curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/product_enhancement" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\":\"Offline streaming\", \"productSysId\":\"de8e9c0dfff8f2108289ffffffffff61\", \"priority\":\"high\", \"description\":\"Enhancement description\", \"versionSysId\":\"da4b608dff7cf2108289ffffffffffc2\", \"releaseSysId\":\"9a4b608dff7cf2108289ffffffffffc3\", \"productFeatureSysId\":\"192d2905ff7436108289ffffffffff3f\" }" \ --user 'username':'password' 応答本文。 { "result": { "error": false, "sysId": "76417985ff7436108289ffffffffff5f" } } ## デジタルプロダクトリリース:POST /sn_dpr/digital_product_release/release {#ariaid-title5} リリースを作成します。リリースは、独立したリリースとして作成することも、子リリースを含むプライマリリリースとして作成することもできます。このエンドポイントを使用して、既存のリリースを \[ドラフト\] ステータスから \[対応中\] に移行することもできます。このエンドポイントにアクセスするには、発信者は次のいずれかのロールを持っている必要があります。 * sn_dpr_model.product_manager * sn_dpr_model.release_admin {#dpr-POST-release__ul_nwh_2fr_2hc} ### URL 形式バージョニングされた URL: /api/sn_dpr/{api_version}/digital_product_release/release デフォルト URL: /api/sn_dpr/digital_product_release/release ### サポートされている要求パラメーター {#dpr-POST-release__entry__2}{#dpr-POST-release__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 19. パスパラメーター] {#dpr-POST-release__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 20. クエリパラメーター] {#dpr-POST-release__entry__10} | 名前 | 説明 | |-|-| | autoCreateIncludedVersions | 自動的に作成する子リリースバージョンのリスト。データタイプ：アレイ "autoCreateIncludedVersions": [ { "product": "String", "version": "String" } ] | | autoCreateIncludedVersions.product | バージョンに使用する製品のSys_id。テーブル:製品モデル \[cmdb_model\] データタイプ：文字列 | | autoCreateIncludedVersions.version | バージョンの名前。データタイプ：文字列 | | autoCreateVersionName | 自動的に作成するバージョンの名前。データタイプ：文字列 | | draftReleaseId | ドラフトリリースのSys_id。リリースを \[ドラフト\] ステータスから \[処理中\] に移行するには、このパラメーターを使用します。テーブル:リリース \[sn_dpr_model_release\] データタイプ：文字列 | | includedVersion | リリースに含める既存の製品バージョンのsys_idsのリスト。テーブル:システムコンポーネントモデル \[cmdb_sw_component_model\] データタイプ：アレイ | | ドラフトリリース | \[ドラフト\] ステータスでリリースを作成するかどうかを示すフラグ。有効な値： * true:リリースは、ステータスが \[ドラフト\] に設定されて作成されます。 * false:リリースは、ステータスが \[処理中\] に設定されて作成されます。 {#dpr-POST-release__ul_pzs_pfp_ghc} デフォルト値：False データタイプ：ブーリアン | | name | 必須です。リリースの名前。データタイプ：文字列 | | productId | 必須です。製品のSys_id。テーブル:製品モデル \[cmdb_model\] データタイプ：文字列 | | 製品バージョン | 製品バージョンのSys_id。テーブル:システムコンポーネントモデル \[cmdb_sw_component_model\] データタイプ：文字列 | | releaseCalendar | リリースカレンダーのSys_id。テーブル:リリースカレンダー \[sn_dpr_model_release_calendar\] データタイプ：文字列 | | リリース日 | yyyy-MM-dd 形式のリリース日。このパラメーターを使用すると、リリース準備ターゲット \[sn_dpr_model_release_target\] テーブルにレコードが作成されます。データタイプ：文字列 | | releaseDescription | リリースの説明。データタイプ：文字列 | | releaseOwner | 必須です。リリースオーナーのSys_id。テーブル：ユーザー \[sys_user\] データタイプ：文字列 | | releaseTarget | リリース準備ターゲットのSys_id。テーブル:リリース準備ターゲット \[sn_dpr_model_release_target\] データタイプ：文字列 | | template_id | リリースに使用するテンプレートのSys_id。テーブル:リリーステンプレート \[sn_dpr_model_release_template\] データタイプ：文字列 | | validatesVersion | リリースがバージョンを検証するかどうかを示すフラグ。有効な値： * true:リリースはバージョンを検証します。 * false:リリースはバージョンを検証しません。 {#dpr-POST-release__ul_vtk_kfp_ghc} デフォルト値：False データタイプ：ブーリアン | [表 : 21. 要求本文パラメーター (JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#dpr-POST-release__entry__46}{#dpr-POST-release__accept-JSON-only-entry-RESTAPI}{#dpr-POST-release__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 22. 要求ヘッダー] {#dpr-POST-release__entry__52} | ヘッダー | 説明 | |-|-| | なし | | [表 : 23. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#dpr-POST-release__entry__56}{#dpr-POST-release__entry-400-status-code} | ステータスコード | 説明 | |-|-| | 201 | 作成されました。リリースが正常に作成されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | [表 : 24. ステータスコード] ### 応答本文のパラメーター (JSON) {#dpr-POST-release__section_hsf_11q_ghc} {#dpr-POST-release__table_fv1_gmm_fhc__entry__2} | 名前 | 説明 | |-|-| | result | API 要求の詳細。データタイプ: オブジェクト "result": { "error": Boolean, "message": "String", "progressId": "String", "releaseId": "String" } | | result.error | API 要求にエラーがあるかどうかを示すフラグ。可能な値： * true:エラー。 * false:エラーなし。 {#dpr-POST-release__ul_tz2_smm_fhc} データタイプ：ブーリアン | | result.message | API 要求の成功または失敗に関する詳細を含むメッセージ。データタイプ：文字列 | | result.progressId | autoCreateIncludedVersions要求パラメーターにリストされている子リリースバージョンの作成進捗状況トラッカーの Sys ID。テーブル:プログレスワーカー \[sys_progress_worker\] データタイプ：文字列 | | result.releaseId | 作成されたプライマリリリースのSys_id。テーブル:リリース \[sn_dpr_model_release\] データタイプ：文字列 | [ ] {#dpr-POST-release__table_fv1_gmm_fhc} ### cURL 要求この例では、含まれるバージョンを含むリリースを作成します。 curl "http://instance.service-now.com/api/sn_dpr/v1/digital_product_release/release" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\": \"Patch Q4\", \"releaseTarget\": \"8071e5f8ff687a10509cffffffffffd9\", \"releaseOwner\": \"6816f79cc0a8016401c5a33be04be441\", \"releaseDescription\": \"Q4 release\", \"productVersion\": \"\", \"templateId\": \"c83134a4ff643a10509cffffffffffb5\", \"releaseDate\": \"\", \"releaseCalendar\": \"\", \"includedVersions\": [ \"39fd3f66ff503610509cffffffffff09\" ], \"productId\": \"c65c372bfb9d5610fdacfe7405efdcd7\", \"autoCreateVersionName\": \"1.2\", \"autoCreateIncludedVersions\": [ { \"product\": \"de66ea3833e966103e8361a9ed5c7b4e\", \"version\": \"1.1\" } ] }" \ --user 'username':'password' 応答本文。 { "result": { "error": false, "message": "", "releaseId": "af90e98dff3c3210509cffffffffffc9", "progressId": "f7902d01ffbc3210509cffffffffff7b" } } ### cURL 要求 {#dpr-POST-release__example_bqc_mdq_ghc} この例では、既存のリリースを \[ドラフト\] ステータスから \[処理中\] に移行します。 curl "http://instance.service-now.com/api/sn_dpr/v1/digital_product_release/release" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\": \"Q4 2025 Product Release\", \"releaseTarget\": \"077e1ffb97bc4e107bc2341de053afe2\", \"releaseOwner\": \"6816f79cc0a8016401c5a33be04be441\", \"releaseDescription\": \"\", \"productVersion\": \"0ff12581ffbc3210509cffffffffff15\", \"templateId\": \"648c6ca8ffe03a10509cffffffffff11\", \"releaseDate\": \"\", \"releaseCalendar\": \"\", \"includedVersions\": [], \"productId\": \"\", \"autoCreateVersionName\": \"\", \"autoCreateIncludedVersions\": [], \"draftReleaseId\": \"83f12581ffbc3210509cffffffffff16\" }" \ --user 'username':'password' 応答本文。 { "result": { "error": false, "message": "", "releaseId": "83f12581ffbc3210509cffffffffff16" } } ### cURL 要求 {#dpr-POST-release__example_mnp_j2q_ghc} この例では、独立リリースを作成します。 curl "http://instance.service-now.com/api/sn_dpr/v1/digital_product_release/release" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\": \"Q2 2026 patch\", \"productVersion\": null, \"releaseTarget\": \"008b84a1ffe4ba10509cffffffffff2c\", \"releaseDescription\": \"\", \"releaseOwner\": \"6816f79cc0a8016401c5a33be04be441\", \"productId\": \"012c6d20ff203210229bffffffffff25\", \"autoCreateVersionName\": \"2.4\", \"templateId\": \"648c6ca8ffe03a10509cffffffffff11\", \"releaseDate\": \"\", \"releaseCalendar\": \"\", \"isDraftRelease\": false, \"validatesVersion\": true }" \ --user 'username':'password' 応答本文。 { "result": { "error": false, "message": "", "releaseId": "c6f52181ffbc3210509cffffffffffc0" } } ## デジタルプロダクトリリース:POST /sn_dpr/digital_product_release/release/{releaseId}/key_date {#ariaid-title6} リリースのキー日付を作成します。重要な日付は、リリース中の期限、マイルストーン、およびその他の重要なイベントを追跡するために使用されます。このエンドポイントを呼び出す前に、 [タイムライン指向のリリース](https://www.servicenow.com/docs/access?context=dpr-working-timeline-release&version=australia&pubname=australia-it-service-management&ft:locale=en-US) を作成する必要があります。タイムライン指向のリリースは期限が決まっており、厳格なスケジュールに従いますが、ステージ指向のリリースは、期日に間に合わせることよりも、主に目標と機能を完了することに重点を置いています。このエンドポイントにアクセスするには、発信者は次のいずれかのロールを持っている必要があります。 * sn_dpr_model.product_manager * sn_dpr_model.release_admin * sn_dpr_model.release_coordinator {#dpr-POST-release-key_date__ul_nwh_2fr_2hc} ### URL 形式バージョニングされた URL: /api/sn_dpr/{api_version}/digital_product_release/release/{releaseId}/key_date デフォルト URL: /api/sn_dpr/digital_product_release/release/{releaseId}/key_date ### サポートされている要求パラメーター {#dpr-POST-release-key_date__entry__2}{#dpr-POST-release-key_date__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | releaseId | リリースのSys_id。テーブル:リリース \[sn_dpr_model_release\] データタイプ：文字列 | [表 : 25. パスパラメーター] {#dpr-POST-release-key_date__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 26. クエリパラメーター] {#dpr-POST-release-key_date__entry__12} | 名前 | 説明 | |-|-| | assignedTo | キー日付に割り当てられたユーザーのSys_id。ユーザーには、次のいずれかのロールが必要です。 * sn_dpr_model.product_manager * sn_dpr_model.release_admin * sn_dpr_model.release_coordinator * sn_dpr_model.release_user {#dpr-POST-release-key_date__ul_kyv_ghc_xhc} テーブル：ユーザー \[sys_user\] データタイプ：文字列 | | description | キー日付の説明。データタイプ：文字列 | | 期限 | 必須です。イベントまたは目標を完了する必要がある期日。期日は、リリース開始予定日と終了予定日の間にする必要があります。形式:yyyy-MM-dd データタイプ：文字列 | | name | 必須です。キー日付の名前。データタイプ：文字列 | | state | 必須です。キー日付のステータス。有効な値： * アーカイブ済み * 欠落 * 予定 {#dpr-POST-release-key_date__ul_ssr_1hc_xhc} データタイプ：文字列 | | type | 必須です。キー日付のタイプ。有効な値： * deadline * important_date * key_event * マイルストーン {#dpr-POST-release-key_date__ul_ikw_3fc_xhc} データタイプ：文字列 | [表 : 27. 要求本文パラメーター (JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#dpr-POST-release-key_date__table_zpj_tcp_whc__entry__2}{#dpr-POST-release-key_date__accept-JSON-only-entry-RESTAPI}{#dpr-POST-release-key_date__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 28. 要求ヘッダー] {#dpr-POST-release-key_date__table_zpj_tcp_whc} {#dpr-POST-release-key_date__entry__32} | ヘッダー | 説明 | |-|-| | なし | | [表 : 29. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#dpr-POST-release-key_date__table_d11_5kv_whc__entry__2}{#dpr-POST-release-key_date__entry-400-status-code}{#dpr-POST-release-key_date__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 201 | 作成されました。キー日付が正常に作成されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 30. ステータスコード] {#dpr-POST-release-key_date__table_d11_5kv_whc} ### 応答本文のパラメーター (JSON) {#dpr-POST-release-key_date__table_fv1_gmm_fhc__entry__2} | 名前 | 説明 | |-|-| | result | API 要求の詳細。データタイプ: オブジェクト "result": { "error": Boolean, "keyDateSysId": "String", "message": "String" } | | result.error | API 要求にエラーがあるかどうかを示すフラグ。可能な値： * true:エラー。 * false:エラーなし。 {#dpr-POST-release-key_date__ul_tz2_smm_fhc} データタイプ：ブーリアン | | result.keyDateSysId | 作成されたキー日付のSys_id。テーブル:リリースキー日付 \[sn_dpr_model_release_key_date\] データタイプ：文字列 | | result.message | API 要求の成功または失敗に関する詳細を含むメッセージ。データタイプ：文字列 | [ ] {#dpr-POST-release-key_date__table_fv1_gmm_fhc} ### cURL 要求この例では、指定したリリースのプロジェクト起動日を作成します。 curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release/eb7dd11d97b402107bc2341de053af34/key_date" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\": \"Project Launch\", \"type\": \"milestone\", \"dueDate\": \"2025-11-01\", \"state\": \"upcoming\", \"description\": \"Launching the new project phase.\", \"assignedTo\": \"62826bf03710200044e0bfc8bcbe5df1\" }" \ --user 'username':'password' 応答本文。 { "result": { "error": false, "message": "Release key date created successfully", "keyDateSysId": "eb0b0905ff7036108289ffffffffff6d" } } ## デジタルプロダクトリリース:POST /sn_dpr/digital_product_release/release/{releaseId}/policies/run {#ariaid-title7} リリースの現在のフェーズにマッピングされたポリシーを実行します。このエンドポイントにアクセスするには、発信者は sn_dpr_model.product_manager ロールを持っている必要があります。このエンドポイントを呼び出す前に、リリースステータスが \[処理中 \] である必要があり、現在のフェーズステータスも \[処理中\] である必要があります。\[リリース\] タブのデジタルプロダクトリリースワークスペースでリリース情報を表示できます。 ### URL 形式バージョニングされた URL: /api/sn_dpr/{api_version}/digital_product_release/release/{releaseId}/policies/run デフォルト URL: /api/sn_dpr/digital_product_release/release/{releaseId}/policies/run ### サポートされている要求パラメーター {#dpr-POST-release-policies-run__entry__2}{#dpr-POST-release-policies-run__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | releaseId | リリースのSys_id。テーブル:リリース \[sn_dpr_model_release\] データタイプ：文字列 | [表 : 31. パスパラメーター] {#dpr-POST-release-policies-run__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 32. クエリパラメーター] {#dpr-POST-release-policies-run__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 33. 要求本文パラメーター (JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#dpr-POST-release-policies-run__entry__16}{#dpr-POST-release-policies-run__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 34. 要求ヘッダー] {#dpr-POST-release-policies-run__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 35. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#dpr-POST-release-policies-run__table_csx_jkm_fhc__entry__2}{#dpr-POST-release-policies-run__entry-400-status-code}{#dpr-POST-release-policies-run__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 201 | 作成されました。リリースフェーズポリシーの実行がスケジュールされています。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 36. ステータスコード] {#dpr-POST-release-policies-run__table_csx_jkm_fhc} ### 応答本文のパラメーター (JSON) {#dpr-POST-release-policies-run__table_fv1_gmm_fhc__entry__2} | 名前 | 説明 | |-|-| | result | API 要求の詳細。データタイプ: オブジェクト "result": { "error": Boolean, "errorCode": "String", "message": "String", "policyExecutionScheduled": Boolean } | | result.error | API 要求にエラーがあるかどうかを示すフラグ。可能な値： * true:エラー。 * false:エラーなし。 {#dpr-POST-release-policies-run__ul_tz2_smm_fhc} データタイプ：ブーリアン | | result.errorCode | 要求の HTTP ステータスコード。データタイプ：文字列 | | result.message | API 要求の成功または失敗に関する詳細を含むメッセージ。データタイプ：文字列 | | result.policyExecutionScheduled | リリースフェーズポリシーの実行がスケジュールされているかどうかを示すフラグ。有効な値： * true:リリースフェーズポリシーの実行がスケジュールされています。 * false:リリースフェーズポリシーの実行がスケジュールされていません。 {#dpr-POST-release-policies-run__ul_hfm_2nm_fhc} データタイプ：ブーリアン | [ ] {#dpr-POST-release-policies-run__table_fv1_gmm_fhc} ### cURL 要求この例では、指定されたリリースの現在のフェーズにマッピングされたポリシーを実行します。 curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release/d4982eeb474b621027d48b41516d4385/policies/run" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password' 応答本文。 { "result": { "error": false, "errorCode": "", "message": "Policy execution scheduled.", "policyExecutionScheduled": true } } ## デジタルプロダクトリリース:POST /sn_dpr/digital_product_release/release/{releaseId}/related_task {#ariaid-title8} リリースに関連タスクを追加します。リリース情報は、デジタルプロダクトリリースワークスペースの \[リリース\] タブで表示できます。リリースの関連タスクは、リリースレコードの \[リリーススコープ\] セクションに表示されます。重要: このエンドポイントを呼び出す前に、リリースの関連タスクとして追加できる既存のタスクレコードが必要です。レコードはタスク \[task\] テーブルを拡張するテーブルに存在する必要がありますが、タスクテーブル自体には存在しません。[sn_dpr_model.release_related_task_types](https://www.servicenow.com/docs/access?context=digital-product-release-properties&version=australia&pubname=australia-it-service-management&ft:locale=en-US)システムプロパティで、タスクレコードを含むテーブルをリストします。このエンドポイントにアクセスするには、発信者は次のいずれかのロールを持っている必要があります。 * sn_dpr_model.product_manager * sn_dpr_model.release_admin {#dpr-POST-release-related_task__ul_nwh_2fr_2hc} ### URL 形式バージョニングされた URL: /api/sn_dpr/{api_version}/digital_product_release/release/{releaseId}/related_task デフォルト URL: /api/sn_dpr/digital_product_release/release/{releaseId}/related_task ### サポートされている要求パラメーター {#dpr-POST-release-related_task__entry__2}{#dpr-POST-release-related_task__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | releaseId | リリースのSys_id。テーブル:リリース \[sn_dpr_model_release\] データタイプ：文字列 | [表 : 37. パスパラメーター] {#dpr-POST-release-related_task__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 38. クエリパラメーター] {#dpr-POST-release-related_task__entry__12} | 名前 | 説明 | |-|-| | taskIds | 必須です。リリースの関連タスクとして追加するタスクsys_idsのリスト。タスクレコードは、 sn_dpr_model.release_related_task_types システムプロパティにリストされているテーブルからのものである必要があります。詳細については、「[Digital Product Release properties](https://www.servicenow.com/docs/access?context=digital-product-release-properties&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。データタイプ：アレイ | [表 : 39. 要求本文パラメーター (JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#dpr-POST-release-related_task__table_zpj_tcp_whc__entry__2}{#dpr-POST-release-related_task__accept-JSON-only-entry-RESTAPI}{#dpr-POST-release-related_task__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 40. 要求ヘッダー] {#dpr-POST-release-related_task__table_zpj_tcp_whc} {#dpr-POST-release-related_task__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 41. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#dpr-POST-release-related_task__table_d11_5kv_whc__entry__2}{#dpr-POST-release-related_task__entry-400-status-code}{#dpr-POST-release-related_task__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 201 | 作成されました。関連タスクがリリースに正常に追加されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 42. ステータスコード] {#dpr-POST-release-related_task__table_d11_5kv_whc} ### 応答本文のパラメーター (JSON) {#dpr-POST-release-related_task__table_fv1_gmm_fhc__entry__2} | 名前 | 説明 | |-|-| | result | API 要求の詳細。データタイプ: オブジェクト "result": { "error": Boolean, "message": "String" } | | result.error | API 要求にエラーがあるかどうかを示すフラグ。可能な値： * true:エラー。 * false:エラーなし。 {#dpr-POST-release-related_task__ul_tz2_smm_fhc} データタイプ：ブーリアン | | result.message | API 要求の成功または失敗に関する詳細を含むメッセージ。データタイプ：文字列 | [ ] {#dpr-POST-release-related_task__table_fv1_gmm_fhc} ### cURL 要求この例では、2 つの関連タスクをリリースに追加します。 curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release/eb7dd11d97b402107bc2341de053af34/related_task" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{\"taskIds\": [\"36836028532023004247ddeeff7b12f1\", \"bc84b11dff5c32108289ffffffffff12\"]}" \ --user 'username':'password' 応答本文。 { "result": { "error": false, "message": "Successfully created the mappings between the release and all the tasks." } } ## デジタルプロダクトリリース - POST /sn_dpr/digital_product_release/release_calendar {#ariaid-title9} リリースカレンダーを作成します。このエンドポイントにアクセスするには、発信者に sn_dpr_model.release_calendar_admin ロールが必要です。 ### URL 形式バージョニングされた URL: /api/sn_dpr/{api_version}/digital_product_release/release_calendar デフォルト URL: /api/sn_dpr/digital_product_release/release_calendar ### サポートされている要求パラメーター {#dpr-POST-release_calendar__entry__2}{#dpr-POST-release_calendar__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 43. パスパラメーター] {#dpr-POST-release_calendar__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 44. クエリパラメーター] {#dpr-POST-release_calendar__entry__10} | 名前 | 説明 | |-|-| | description | リリースカレンダーの説明。データタイプ：文字列 | | name | 必須です。リリースカレンダーの名前。データタイプ：文字列 | | releaseAdmin | 必須です。リリースカレンダー所有者のSys_id。テーブル：ユーザー \[sys_user\] データタイプ：文字列 | | スケジュール | リリースカレンダーに使用するスケジュールsys_idsのカンマ区切りリスト。たとえば、「 `sysId1,sysId2,sysId3」`などです。テーブル:スケジュール \[cmn_schedule\] データタイプ：文字列 | [表 : 45. 要求本文パラメーター (JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#dpr-POST-release_calendar__table_zpj_tcp_whc__entry__2}{#dpr-POST-release_calendar__accept-JSON-only-entry-RESTAPI}{#dpr-POST-release_calendar__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | 認証 | 認証用の基本トークンまたはベアラートークン。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 46. 要求ヘッダー] {#dpr-POST-release_calendar__table_zpj_tcp_whc} {#dpr-POST-release_calendar__entry__28} | ヘッダー | 説明 | |-|-| | なし | | [表 : 47. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#dpr-POST-release_calendar__table_d11_5kv_whc__entry__2}{#dpr-POST-release_calendar__entry-400-status-code}{#dpr-POST-release_calendar__entry-401-status-code} | ステータスコード | 説明 | |-|-| | 201 | 作成されました。リリースカレンダーが正常に作成されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 | [表 : 48. ステータスコード] {#dpr-POST-release_calendar__table_d11_5kv_whc} ### 応答本文のパラメーター (JSON) {#dpr-POST-release_calendar__section_tmc_1lv_whc} {#dpr-POST-release_calendar__table_fv1_gmm_fhc__entry__2} | 名前 | 説明 | |-|-| | result | API 要求の詳細。データタイプ: オブジェクト "result": { "error": Boolean, "message": "String", "releaseCalendarId": "String" } | | result.error | API 要求にエラーがあるかどうかを示すフラグ。可能な値： * true:エラー。 * false:エラーなし。 {#dpr-POST-release_calendar__ul_tz2_smm_fhc} データタイプ：ブーリアン | | result.message | API 要求の成功または失敗に関する詳細を含むメッセージ。データタイプ：文字列 | | result.releaseCalendarId | 作成されたリリースカレンダーのSys_id。テーブル:リリースカレンダー \[sn_dpr_model_release_calendar\] データタイプ：文字列 | [ ] {#dpr-POST-release_calendar__table_fv1_gmm_fhc} ### cURL 要求この例では、リリースカレンダーを作成します。 curl 'https://instance.service-now.com/api/sn_dpr/v1/digital_product_release/release_calendar' \ --request POST \ --header 'Accept:application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic ' \ --data '{ "name": "Q1 2025 Release Calendar123", "releaseAdmin": "dc6770ae3b97a210532fb50f23e45a33", "description": "Calendar for Q1 releases" }' 応答本文。 { "result": { "error": false, "message": "", "releaseCalendarId": "5f6702c13bbc3a50532fb50f23e45a2b" } } ## デジタルプロダクトリリース - POST /sn_dpr/digital_product_release/release_id/{releaseId}/complete_phase {#ariaid-title10} リリースの現在のフェーズを完了します。注: 現在のフェーズは、フェーズのすべてのポリシーが準拠している場合にのみ \[ 完了\] に設定されます。このエンドポイントにアクセスするには、発信者は次のいずれかのロールを持っている必要があります。 * sn_dpr_model.product_manager * sn_dpr_model.release_admin * sn_dpr_model.release_coordinator {#dpr-POST-releaseid-completephase__ul_nwh_2fr_2hc} このエンドポイントを呼び出す前に、リリースステータスが \[処理中 \] である必要があり、現在のフェーズステータスも \[処理中\] である必要があります。\[リリース\] タブのデジタルプロダクトリリースワークスペースでリリース情報を表示できます。 ### URL 形式バージョニングされた URL: /api/sn_dpr/{api_version}/digital_product_release/release_id/{releaseId}/complete_phase デフォルト URL: /api/sn_dpr/digital_product_release/release_id/{releaseId}/complete_phase ### サポートされている要求パラメーター {#dpr-POST-releaseid-completephase__entry__2}{#dpr-POST-releaseid-completephase__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | releaseId | リリースのSys_id。テーブル:リリース \[sn_dpr_model_release\] データタイプ：文字列 | [表 : 49. パスパラメーター] {#dpr-POST-releaseid-completephase__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 50. クエリパラメーター] {#dpr-POST-releaseid-completephase__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 51. 要求本文パラメーター (JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#dpr-POST-releaseid-completephase__entry__16}{#dpr-POST-releaseid-completephase__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 52. 要求ヘッダー] {#dpr-POST-releaseid-completephase__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 53. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#dpr-POST-releaseid-completephase__entry__24}{#dpr-POST-releaseid-completephase__entry-400-status-code}{#dpr-POST-releaseid-completephase__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 201 | 作成されました。リリースフェーズは正常に完了しました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 54. ステータスコード] ### 応答本文のパラメーター (JSON) {#dpr-POST-releaseid-completephase__entry__32} | 名前 | 説明 | |-|-| | result | API 要求の詳細。このオブジェクトに含まれる要素は、要求が成功したか失敗したかによって異なります。データタイプ: オブジェクト成功オブジェクト。 "result": { "message": "String", "phaseSysId": "String", "status": "String", } エラーオブジェクト。 "result": { "error": Boolean, "message": "String" } | | result.error | API 要求にエラーがあるかどうかを示すフラグ。このパラメーターは要求が失敗した場合にのみ返されるため、可能な値は `true` のみです。データタイプ：ブーリアン | | result.message | API 要求の成功または失敗に関する詳細を含むメッセージ。データタイプ：文字列 | | result.phaseSysId | リリースフェーズのSys_id。テーブル:リリースフェーズ \[sn_dpr_model_release_phase\] データタイプ：文字列 | | result.status | API 要求のステータス。このパラメーターは要求が成功した場合にのみ返されるため、使用可能な値は `成功`のみです。データタイプ：文字列 | [ ] ### cURL 要求この例は、指定されたリリースの現在のフェーズを完了します。 curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release_id/d4982eeb474b621027d48b41516d4385/complete_phase" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password' 応答本文。 { "result": { "status": "success", "message": "Release phase is marked as complete", "phaseSysId": "2498222f474b621027d48b41516d4342" } } ### cURL 要求 {#dpr-POST-releaseid-completephase__example_dtv_vsf_fhc} この例は、無効なリリースsys_idが指定された場合のエラー応答を示しています。 curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release_id/a/complete_phase" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password' エラー応答。 { "result": { "error": true, "message": "Release ID is invalid" } } ## デジタルプロダクトリリース - POST /sn_dpr/digital_product_release/release_target {#ariaid-title11} リリース準備ターゲットまたは一連の繰り返しリリース準備ターゲットを作成します。このエンドポイントにアクセスするには、発信者は次のいずれかのロールを持っている必要があります。 * sn_dpr_model.product_manager * sn_dpr_model.release_admin {#dpr-POST-release_target__ul_nwh_2fr_2hc} ### URL 形式バージョニングされた URL: /api/sn_dpr/{api_version}/digital_product_release/release_target デフォルト URL: /api/sn_dpr/digital_product_release/release_target ### サポートされている要求パラメーター {#dpr-POST-release_target__entry__2}{#dpr-POST-release_target__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 55. パスパラメーター] {#dpr-POST-release_target__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 56. クエリパラメーター] {#dpr-POST-release_target__entry__10} | 名前 | 説明 | |-|-| | description | 準備ターゲットの説明。データタイプ：文字列 | | endDate | 繰り返し準備ターゲットの終了日。isRecurringが `true` の場合は必須です。データタイプ：文字列 | | 繰り返しである | 必須です。準備ターゲットが繰り返しかどうかを示すフラグ。有効な値： * true:ターゲットは繰り返しです。 * false:ターゲットは単一の日付です。 {#dpr-POST-release_target__ul_nwm_nxf_k3c} データタイプ：ブーリアン | | name | 必須です。リリース準備ターゲットの名前。データタイプ：文字列 | | releaseAdmin | 必須です。準備ターゲットオーナーのSys_id。テーブル：ユーザー \[sys_user\] データタイプ：文字列 | | releaseCalendar | 必須です。準備ターゲットのリリースカレンダーのSys_id。テーブル:リリースカレンダー \[sn_dpr_model_release_calendar\] データタイプ：文字列 | | 繰り返し | 繰り返し準備ターゲットのスケジュールを設定します。isRecurringが `true` の場合は必須です。データタイプ: オブジェクト "repeats": { "daysOfWeek": Number, "every": Number, "type": "String" } | | repeats.daysOfWeek | 1 週間の作業日数。データタイプ：数値 | | repeats.every | 各日付の間隔の数。ターゲットの繰り返し頻度を定義するために repeats.type とともに使用されます。この例では、ターゲットは 2 週間ごとに繰り返されます。 "repeats": { "every": 2, "type": "weekly" } データタイプ：数値 | | repeats.type | 各日付の間隔のタイプ。ターゲットの繰り返し頻度を定義するために repeats.every とともに使用されます。有効な値： * 週次 * 月次 {#dpr-POST-release_target__ul_kgt_1bg_k3c} データタイプ：文字列 | | scheduleSysId | リリースターゲットに使用するスケジュールのSys_id。テーブル:スケジュール \[cmn_schedule\] データタイプ：文字列 | | startDate | 必須です。準備ターゲットの日付、または繰り返し準備ターゲットの最初の日付。データタイプ：文字列 | | targetsWithOverlappingScheduleDetails | 繰り返し準備ターゲットの日付のリスト。データタイプ：アレイ "targetsWithOverlappingScheduleDetails": [ { "active": Boolean, "date": "String" } ] | | targetsWithOverlappingScheduleDetails.active | 準備ターゲットの繰り返しがアクティブかどうかを示すフラグ。有効な値： * true:アクティブ。 * false:非アクティブ。 {#dpr-POST-release_target__ul_sjq_hgg_k3c} データタイプ：ブーリアン | | targetsWithOverlappingScheduleDetails.date | 準備ターゲットの繰り返し日。データタイプ：文字列 | [表 : 57. 要求本文パラメーター (JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#dpr-POST-release_target__table_tn3_hhg_k3c__entry__2}{#dpr-POST-release_target__accept-JSON-only-entry-RESTAPI}{#dpr-POST-release_target__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 58. 要求ヘッダー] {#dpr-POST-release_target__table_tn3_hhg_k3c} {#dpr-POST-release_target__entry__48} | ヘッダー | 説明 | |-|-| | なし | | [表 : 59. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#dpr-POST-release_target__table_osg_lhg_k3c__entry__2}{#dpr-POST-release_target__entry-400-status-code} | ステータスコード | 説明 | |-|-| | 201 | 作成されました。リリースターゲットが正常に作成されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | [表 : 60. ステータスコード] {#dpr-POST-release_target__table_osg_lhg_k3c} ### 応答本文のパラメーター (JSON) {#dpr-POST-release_target__table_ndx_qsy_j3c__entry__2} | 名前 | 説明 | |-|-| | result | API 要求の詳細。データタイプ: オブジェクト "result": { "count": Number, "error": Boolean, "message": "String" } | | result.count | API 要求によって作成されたリリースターゲットの数。データタイプ：数値 | | result.error | API 要求にエラーがあるかどうかを示すフラグ。可能な値： * true:エラー。 * false:エラーなし。 {#dpr-POST-release_target__ul_odx_qsy_j3c} データタイプ：ブーリアン | | result.message | エラーメッセージ。要求が成功した場合、このパラメーターは空です。データタイプ：文字列 | [ ] {#dpr-POST-release_target__table_ndx_qsy_j3c} ### cURL 要求この例では、毎週金曜日にターゲットを繰り返す、4 つのリリース準備ターゲットのセットを作成します。 curl "http://instance.service-now.com/api/sn_dpr/digital_product_release/release_target" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\": \"Weekly Friday patch\", \"releaseAdmin\": \"6816f79cc0a8016401c5a33be04be441\", \"isRecurring\": true, \"description\": \"\", \"startDate\": \"2025-10-24\", \"releaseCalendar\": \"d3d1f3b4ff60ba10509cffffffffffa8\", \"endDate\": \"2025-11-19\", \"repeats\": { \"type\": \"weekly\", \"every\": 1, \"daysOfWeek\": 5 }, \"scheduleSysId\": \"b862d589ff3c3210509cffffffffff97\", \"targetsWithOverlappingScheduleDetails\": [ { \"active\": true, \"date\": \"2025-10-24\" }, { \"active\": true, \"date\": \"2025-10-31\" }, { \"active\": true, \"date\": \"2025-11-07\" }, { \"active\": true, \"date\": \"2025-11-14\" } ] }" \ --user 'username':'password' 応答本文。 { "result": { "error": false, "message": "", "count": 4 } } ### cURL 要求 {#dpr-POST-release_target__example_cdx_2lz_j3c} この例では、指定された日付のリリース準備ターゲットを作成します。 curl "http://instance.service-now.com/api/sn_dpr/digital_product_release/release_target" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\": \"Fourth Thursday patch\", \"releaseAdmin\": \"6816f79cc0a8016401c5a33be04be441\", \"isRecurring\": false, \"description\": \"Last Thursday of October\", \"startDate\": \"2025-10-30\", \"releaseCalendar\": \"d3d1f3b4ff60ba10509cffffffffffa8\" }" \ --user 'username':'password' 応答本文。 { "result": { "error": false, "message": "", "count": 1 } } ## デジタルプロダクトリリース:PUT /sn_dpr/digital_product_release/release/{sysId}/retarget {#ariaid-title12} リリースの準備ターゲットを変更します。新しい準備ターゲットは、既に定義されている既存の準備ターゲット、または帯域外日付 (標準リリースカレンダーに関連付けられていない 1 回限りの準備ターゲット) にすることができます。帯域外日付を設定するには、 [sn_dpr.out_of_band_release_allowed](https://www.servicenow.com/docs/access?context=digital-product-release-properties&version=australia&pubname=australia-it-service-management&ft:locale=en-US) システムプロパティを true に設定する必要があります。リリースフェーズの期間は、新しい準備ターゲットを反映するように調整されます。このエンドポイントを呼び出す前に、リリースステータスが \[処理中 \] または \[処理待ち\] である必要があります。このエンドポイントにアクセスするには、発信者は次のいずれかのロールを持っている必要があります。 * sn_dpr_model.product_manager * sn_dpr_model.release_admin {#dpr-PUT-release-retarget__ul_nwh_2fr_2hc} ### URL 形式バージョニングされた URL: /api/sn_dpr/{api_version}/digital_product_release/release/{sysId}/retarget デフォルト URL: /api/sn_dpr/digital_product_release/release/{sysId}/retarget ### サポートされている要求パラメーター {#dpr-PUT-release-retarget__entry__2}{#dpr-PUT-release-retarget__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | sysId | リリースのSys_id。テーブル:リリース \[sn_dpr_model_release\] データタイプ：文字列 | [表 : 61. パスパラメーター] {#dpr-PUT-release-retarget__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 62. クエリパラメーター] {#dpr-PUT-release-retarget__entry__12} | 名前 | 説明 | |-|-| | outOfBand | 準備ターゲットが帯域外日付 (標準リリースカレンダーに関連付けられていない 1 回限りの準備ターゲット) であるかどうかを示すフラグ。このパラメーターは、 releaseTarget  を使用しない場合は必須です。有効な値： * true:準備ターゲットは帯域外です。 * false:準備ターゲットが既に定義されており、標準リリースカレンダーに関連付けられています。 {#dpr-PUT-release-retarget__ul_hdr_lmy_j3c} デフォルト値：False データタイプ：ブーリアン | | releaseCalendar | 準備ターゲットに使用するリリースカレンダーのSys_id。outOfBandを使用する場合は必須です。テーブル:リリースカレンダー \[sn_dpr_model_release_calendar\] データタイプ：文字列 | | リリース日 | 準備ターゲットの日付。outOfBandを使用する場合は必須です。データタイプ：文字列 | | releaseTarget | リリース準備ターゲットのSys_id。このパラメーターを使用して、既存の準備ターゲットを選択します。新しいターゲットを設定するには、このパラメーターまたは outOfBand のいずれかが必要です。テーブル:リリース準備ターゲット \[sn_dpr_model_release_target\] データタイプ：文字列 | [表 : 63. 要求本文パラメーター (JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#dpr-PUT-release-retarget__entry__22}{#dpr-PUT-release-retarget__accept-JSON-only-entry-RESTAPI}{#dpr-PUT-release-retarget__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 64. 要求ヘッダー] {#dpr-PUT-release-retarget__entry__28} | ヘッダー | 説明 | |-|-| | なし | | [表 : 65. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#dpr-PUT-release-retarget__entry__32}{#dpr-PUT-release-retarget__entry-200-status-code}{#dpr-PUT-release-retarget__entry-400-status-code}{#dpr-PUT-release-retarget__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 66. ステータスコード] ### 応答本文のパラメーター (JSON) {#dpr-PUT-release-retarget__table_ndx_qsy_j3c__entry__2} | 名前 | 説明 | |-|-| | result | API 要求の詳細。データタイプ: オブジェクト "result": { "error": Boolean, "message": "String" } | | result.error | API 要求にエラーがあるかどうかを示すフラグ。可能な値： * true:エラー。 * false:エラーなし。 {#dpr-PUT-release-retarget__ul_odx_qsy_j3c} データタイプ：ブーリアン | | result.message | エラーメッセージ。要求が成功した場合、このパラメーターは空です。データタイプ：文字列 | [ ] {#dpr-PUT-release-retarget__table_ndx_qsy_j3c} ### cURL 要求この例では、既存の準備ターゲットを使用してリリース準備ターゲットを更新します。 curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release/9b2e7ec9476c8e105b8e0dcfe16d43d4/retarget" \ --request PUT \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"releaseTarget\": \"3f6668e95427fd10f877ac7ac399daa6\" }" \ --user 'username':'password' 応答本文。 { "result": { "error": false, "message": "" } } ### cURL 要求 {#dpr-PUT-release-retarget__example_mkk_lpy_j3c} この例では、帯域外準備ターゲットを使用してリリース準備ターゲットを更新します。 curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release/9b2e7ec9476c8e105b8e0dcfe16d43d4/retarget" \ --request PUT \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"outOfBand\": true, \"releaseCalendar\": \"fcb2eaa09f4302105c534d837a0a1c2b\", \"releaseDate\": \"2026-10-23\" }" \ --user 'username':'password' 応答本文。 { "result": { "error": false, "message": "" } }