DevOps Config API

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む23読むのに数分

    • DevOps Config API は、アプリケーションを管理するためのエンドポイントを提供します。

    この API にはアプリケーション DevOps コンフィグ が必要であり、 sn_devops_config 名前空間内で提供されます。

    DELETE、PATCH、および POST 操作の場合、呼び出し元ユーザーには sn_devops_config.admin ロールが必要です。GET 操作の場合、呼び出し元ユーザーには sn_devops_config.viewer または sn_devops_config.admin ロールが必要です。

    アプリケーションライフサイクル管理に DevOps Config API を使用します。を使用したアプリケーションの DevOps コンフィグ管理の詳細については、「 DevOps Config の構成」を参照してください。

    DevOps Config - DELETE /devops_config/application/{appid}

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

    URL 形式

    バージョニングされた URL:/ api/sn_devops_config/v1/devops_config/application/{appid}

    デフォルトの URL:/ api/sn_devops_config/devops_config/application/{appid}

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

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

    データタイプ：文字列
    appid 削除するアプリケーションのSys_id。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (JSON)
    名前 説明
    なし

    ヘッダー

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

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

    ステータスコード

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

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。アプリケーション ID が無効です。
    403 禁止されました。ユーザーには API にアクセスする権限がありません。

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

    名前 説明
    エラー エラー情報。このパラメーターは、要求が失敗した場合にのみ返されます。

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

    "error": { 
   "message": "String", 
   "detail": "String" 
}
    error.detail 要求が失敗した理由に関するその他の詳細。

    データタイプ：文字列
    error.message 要求が失敗した理由を含むエラーメッセージ。

    データタイプ：文字列
    結果 要求に関する情報を含む結果オブジェクト。

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

    "result": { 
   "errors": [Array], 
   "success": [Array] 
}
    result.errors 要求からのエラーのアレイ。成功した要求のアレイは空です。

    データタイプ：アレイ
    result.success 要求の成功メッセージ。失敗した要求のアレイは空です。

    データタイプ：アレイ
    status 要求のステータス。このパラメーターは、要求が失敗した場合にのみ返されます。

    可能な値：failure

    データタイプ：文字列

    cURL 要求

    この例では、アプリケーションを削除します。

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    応答本文。

    { 
  "result": { 
    "errors": [], 
    "success": [ 
      "CDM Application Demo Application 1234 has been deleted successfully." 
    ] 
  } 
}

    cURL 要求

    この例は、ユーザーが API にアクセスする権限を持っていない場合のエラー応答を示しています。

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    エラー応答。

    { 
  "error": { 
    "message": "User Not Authorized", 
    "detail": "Failed API level ACL Validation" 
  }, 
  "status": "failure" 
}

    DevOps Config - GET /devops_config/application/{appid}

    アプリケーションを取得します。

    URL 形式

    バージョニングされた URL:/ api/sn_devops_config/v1/devops_config/application/{appid}

    デフォルトの URL:/ api/sn_devops_config/devops_config/application/{appid}

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

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

    データタイプ：文字列
    appid 取得するアプリケーションのSys_id。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 9. 要求本文パラメーター (JSON)
    名前 説明
    なし

    ヘッダー

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

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

    ステータスコード

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

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。アプリケーション ID が無効です。
    403 禁止されました。ユーザーには API にアクセスする権限がありません。

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

    名前 説明
    エラー エラー情報。このパラメーターは、要求が失敗した場合にのみ返されます。

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

    "error": { 
   "message": "String", 
   "detail": "String" 
}
    error.detail 要求が失敗した理由に関するその他の詳細。

    データタイプ：文字列
    error.message 要求が失敗した理由を含むエラーメッセージ。

    データタイプ：文字列
    結果 要求に関する情報を含む結果オブジェクト。

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

    "result": { 
  "data": {Object},
  "message": "String",
  "status": Number
}
    result.data アプリケーションのデータ。

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

    "data": { 
  "appDescription": "String", 
  "appId": "String",
  "appManagedByGroups": [Array],
  "appManufacturerId": "String", 
  "appManufacturerName": "String", 
  "appModelId": "String", 
  "appModelName": "String", 
  "appModelOwnerId": "String", 
  "appModelOwnerName": "String", 
  "appName": "String", 
  "sdlcType": "String"
}
    result.data.appDescription アプリケーションの説明

    データタイプ：文字列
    result.data.appId アプリケーションのSys_id。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    result.data.appManagedByGroups アプリケーションを管理するグループのsys_idsのカンマ区切りリスト。グループ [sys_user_group] テーブルにあります。

    データタイプ：文字列
    result.data.appManufacturerId メーカーのSys_id。会社 [core_company] テーブルにあります。

    データタイプ：文字列
    result.data.appManufacturerName メーカーの名前。

    データタイプ：文字列
    result.data.appModelId アプリケーションモデルのSys_id。アプリケーションモデル [cmdb_application_product_model] テーブルにあります。

    データタイプ：文字列
    result.data.appModelName アプリケーションモデルの名前。アプリケーションモデル [cmdb_application_product_model] テーブルにあります。

    データタイプ：文字列
    result.data.appModelOwnerId アプリケーションモデルオーナーのSys_id。ユーザー [sys_user] テーブルにあります。

    データタイプ：文字列
    result.data.appModelOwnerName アプリケーションモデルオーナーの名前。

    データタイプ：文字列
    result.data.appName アプリケーションの名前。

    データタイプ：文字列
    result.data.error エラー情報。このパラメーターは、要求が失敗した場合にのみ返されます。

    データタイプ：文字列
    result.data.sdlcType アプリケーションのタイプ。
    可能な値：
    • application
    • インフラストラクチャ

    データタイプ：文字列
    result.message 要求の成功または失敗の結果に関する情報。

    データタイプ：文字列
    result.status 要求のステータスコード。
    可能な値：
    • 200
    • 400
    • 403

    データタイプ：数値
    status 要求のステータス。このパラメーターは、要求が失敗した場合にのみ返されます。

    可能な値：failure

    データタイプ：文字列

    cURL 要求

    この例では、アプリケーションを取得します。

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    応答本文。

    { 
  "result": { 
    "status": 200, 
    "message": "Success", 
    "data": { 
      "appName": "Demo Application 1234", 
      "appId": "38e17dc3473d111072566862736d43c7", 
      "appDescription": "Updated description of Demo Application created from REST API", 
      "sdlcType": "application", 
      "appModelId": "a4e13dc3473d111072566862736d4307", 
      "appModelName": "Demo Application 1234", 
      "appManufacturerId": "262702654725d950a34a3085d36d435e", 
      "appManufacturerName": "", 
      "appModelOwnerId": "6816f79cc0a8016401c5a33be04be441", 
      "appModelOwnerName": "System Administrator", 
      "appManagedByGroups": [] 
    } 
  } 
}

    cURL 要求

    この例は、ユーザーが無効なアプリケーション ID を入力した場合のエラー応答を示しています。

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/18a17de3283d15107256686277777777" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    エラー応答。

    { 
  "result": { 
    "status": 400, 
    "message": "No valid Application", 
    "data": { 
      "error": "No valid Application" 
    } 
  } 
}

    DevOps Config - PATCH /devops_config/application/{appid}

    アプリケーションを更新します。

    URL 形式

    バージョニングされた URL:/ api/sn_devops_config/v1/devops_config/application/{appid}

    デフォルトの URL:/ api/sn_devops_config/devops_config/application/{appid}

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

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

    データタイプ：文字列
    appid 更新するアプリケーションのSys_id。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (JSON)
    名前 説明
    appDescription アプリケーションの説明

    データタイプ：文字列
    appManagedByGroup アプリケーションを管理するグループのsys_idsのカンマ区切りリスト。呼び出し元ユーザーは、これらのグループに属している必要があります。グループ [sys_user_group] テーブルにあります。

    データタイプ：文字列

    "appManagedByGroups": "sys_id, sys_id"
    appManufacturerId メーカーのSys_id。会社 [core_company] テーブルにあります。

    データタイプ：文字列
    appModelOwnerId アプリケーションモデルオーナーのSys_id。ユーザー [sys_user] テーブルにあります。

    データタイプ：文字列

    ヘッダー

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

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

    ステータスコード

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

    表 : 18. ステータスコード
    ステータスコード 説明
    200 アプリケーションが正常に更新されました。
    403 禁止されました。ユーザーには API にアクセスする権限がありません。
    404 アプリケーションは更新されていません。オブジェクトのプロパティには message 、 result エラーに関する追加情報が含まれています。

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

    名前 説明
    エラー エラー情報。このパラメーターは、要求が失敗した場合にのみ返されます。

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

    "error": { 
   "message": "String", 
   "detail": "String" 
}
    error.message 要求が失敗した理由を含むエラーメッセージ。

    データタイプ：文字列
    error.detail 要求が失敗した理由に関するその他の詳細。

    データタイプ：文字列
    結果 アプリケーションに関する情報を含む結果オブジェクト。

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

    "result": { 
   "message": "String", 
   "data": "String" 
}
    result.message 要求の成功または失敗の結果に関する情報。

    データタイプ：文字列
    result.data アプリケーションのSys_id。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    status 要求のステータス。このパラメーターは、要求が失敗した場合にのみ返されます。

    可能な値：failure

    データタイプ：文字列

    cURL 要求

    この例では、既存のアプリケーションを更新します。

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request PATCH \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{ 
  \"appDescription\": \"Updated description of Demo Application created from REST API\", 
  \"appManufacturerId\": \"262702654725d950a34a3085d36d435e\", 
  \"appModelOwnerId\": \"6816f79cc0a8016401c5a33be04be441\" 
}" \ 
--user 'username':'password'

    応答本文。

    { 
  "result": { 
    "message": "Application with name Demo Application 1234 updated successfully.", 
    "data": "38e17dc3473d111072566862736d43c7" 
  } 
}

    DevOps Config - POST /devops_config/application

    アプリケーションを作成します。

    URL 形式

    バージョニングされた URL:/ api/sn_devops_config/v1/devops_config/application

    デフォルトの URL:/ api/sn_devops_config/devops_config/application

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

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

    データタイプ：文字列
    表 : 20. クエリパラメーター
    名前 説明
    なし
    表 : 21. 要求本文パラメーター (JSON)
    名前 説明
    appDescription アプリケーションの説明

    データタイプ：文字列
    appManagedByGroup アプリケーションを管理するグループのsys_idsのカンマ区切りリスト。呼び出し元ユーザーは、これらのグループに属している必要があります。グループ [sys_user_group] テーブルにあります。

    データタイプ：文字列

    "appManagedByGroups": "sys_id, sys_id"
    appManufacturerId メーカーのSys_id。会社 [core_company] テーブルにあります。

    データタイプ：文字列
    appModelId アプリケーションの作成に使用する既存のアプリケーションモデルのSys_id。アプリケーションモデル [cmdb_application_product_model] テーブルにあります。

    このパラメーターを指定する場合は、、appServiceIdappModelNameappServiceNameまたはtechnicalServiceIdパラメーターを指定しappNameないでください。

    データタイプ：文字列
    appModelName アプリケーションの作成に使用する既存のアプリケーションモデルの名前。アプリケーションモデル [cmdb_application_product_model] テーブルにあります。

    このパラメーターを指定する場合は、、appServiceIdappModelIdappServiceNameまたはtechnicalServiceIdパラメーターを指定しappNameないでください。

    データタイプ：文字列
    appModelOwnerId アプリケーションモデルオーナーのSys_id。ユーザー [sys_user] テーブルにあります。

    データタイプ：文字列
    appName アプリケーションの名前。

    既存のアプリケーションと同じ名前は使用しないでください。

    このパラメーターを指定する場合は、、appServiceIdappModelIdappServiceNameまたはtechnicalServiceIdパラメーターを指定しappModelNameないでください。

    データタイプ：文字列
    appServiceId アプリケーションの作成に使用する既存のアプリケーションサービスのSys_id。アプリケーションサービス [cmdb_ci_service_auto] テーブルにあります。

    このパラメーターは、typeアプリケーションである場合にのみ使用します。

    このパラメーターを指定する場合は、、appServiceNameappModelNameappModelIdまたはtechnicalServiceIdパラメーターを指定しappNameないでください。

    データタイプ：文字列
    appServiceName アプリケーションの作成に使用する既存のアプリケーションサービスの名前。アプリケーションサービス [cmdb_ci_service_auto] テーブルにあります。

    このパラメーターは、typeアプリケーションである場合にのみ使用します。

    このパラメーターを指定する場合は、、appServiceIdappModelNameappModelIdまたはtechnicalServiceIdパラメーターを指定しappNameないでください。

    データタイプ：文字列
    テクニカルサービス ID アプリケーションの作成に使用する既存のダイナミック CI グループのSys_id。ダイナミック CI グループ [cmdb_ci_query_based_service] テーブルにあります。

    このパラメーターは、typeインフラストラクチャである場合にのみ使用します。

    このパラメーターを指定する場合は、、 appServiceNameappModelNameappModelIdまたはappServiceIdパラメーターを指定しappNameないでください。

    データタイプ：文字列
    タイプ 必須です。作成するアプリケーションのタイプ。
    有効な値：
    • application
    • インフラストラクチャ

    データタイプ：文字列

    ヘッダー

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

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

    ステータスコード

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

    表 : 24. ステータスコード
    ステータスコード 説明
    201 アプリケーションが正常に作成されました。
    403 禁止されました。ユーザーには API にアクセスする権限がありません。
    404 アプリケーションが作成されていません。オブジェクトのプロパティには message 、 result エラーに関する追加情報が含まれています。

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

    名前 説明
    エラー エラー情報。このパラメーターは、要求が失敗した場合にのみ返されます。

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

    "error": { 
   "message": "String", 
   "detail": "String" 
}
    error.message 要求が失敗した理由を含むエラーメッセージ。

    データタイプ：文字列
    error.detail 要求が失敗した理由に関するその他の詳細。

    データタイプ：文字列
    結果 アプリケーションに関する情報を含む結果オブジェクト。

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

    "result": { 
   "message": "String", 
   "data": "String" 
}
    result.message 要求の成功または失敗の結果に関する情報。

    データタイプ：文字列
    result.data アプリケーションのSys_id。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    status 要求のステータス。このパラメーターは、要求が失敗した場合にのみ返されます。

    可能な値：failure

    データタイプ：文字列

    cURL 要求

    この例では、新しいアプリケーションを作成します。

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{ 
  \"type\": \"application\", 
  \"appName\": \"Demo Application 1234\", 
  \"appDescription\": \"Description of Demo Application created from REST API\", 
  \"appManufacturerId\": \"262702654725d950a34a3085d36d435e\", 
  \"appModelOwnerId\": \"6816f79cc0a8016401c5a33be04be441\" 
}" \ 
--user 'username':'password'

    応答本文。

    { 
  "result": { 
    "message": "Application with name Demo Application 1234 created successfully.", 
    "data": "38e17dc3473d111072566862736d43c7" 
  } 
}