CI ライフサイクル管理 API

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

    • CI ライフサイクル管理 API は、構成アイテム (CI) の運用ステータスを操作し、CI アクションを適用するためのエンドポイントを提供します。

    この API インターフェイスは、許可されていない CI アクション、互換 CI アクション、および許可されていない運用上の移行によって指定された制限および許可を遵守します。インターフェイスが制限付き操作を試行すると、操作はブロックされ、エラーが記録され、必要に応じてタスクが作成されます。

    CI ライフサイクル管理 - DELETE /now/cilifecyclemgmt/actions

    CI のリストの構成アイテム (CI) アクションを削除します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/actions

    デフォルトの URL：/api/now/cilifecyclemgmt/actions

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

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

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

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    actionName 必須です。構成アイテムのアクション名。

    データタイプ：文字列
    requestorId 必須です。 ワークフローコンテキストの sys_id、または CI ライフサイクル管理 - POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。

    オペレーターユーザー ID は、CI ステータス登録済みユーザー [statemgmt_register_users] テーブルにあります。

    データタイプ：文字列
    sysids 必須です。CI sys_id のカンマ区切りリスト。

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

    ヘッダー

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

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

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

    ステータスコード

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

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 要求の結果をカプセル化するオブジェクト。

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

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。

    データタイプ：アレイ

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error 要求の処理中に発生したステータス管理エラーの識別子。
    可能な値：
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    データタイプ：文字列
    result.errors.message 関連する error の詳細を提供するメッセージ。

    データタイプ：文字列
    result.result CI アクションが正常に削除されたかどうかを示すフラグ。
    可能な値：
    • true：CI アクションが削除されました。
    • false：CI アクションが削除されませんでした。

    データタイプ：文字列

    cURL 要求

    2 つの CI から CI アクションを削除します。

    curl --request DELETE \
'https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33' \
--header 'Accept: application/json' \
--user "username":"password"

    応答本文は、CI アクションが CI から削除されたことを確認します。

    {
  "result": {
    "result": true
  }
}

    CI ライフサイクル管理 - DELETE /now/cilifecyclemgmt/operators/{req_id}

    ワークフロー以外のユーザーのオペレーターの登録を解除します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/operators/{req_id}

    デフォルトの URL：/api/now/cilifecyclemgmt/operators/{req_id}

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

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

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

    データタイプ：文字列
    req_id ワークフローコンテキストの sys_id、または CI ライフサイクル管理 - POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。

    オペレーターユーザー ID は、CI ステータス登録済みユーザー [statemgmt_register_users] テーブルにあります。

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

    ヘッダー

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

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

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

    ステータスコード

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

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 要求の結果をカプセル化するオブジェクト。

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

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。

    データタイプ：アレイ

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error 要求の処理中に発生したステータス管理エラーの識別子。
    可能な値：
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    データタイプ：文字列
    result.errors.message 関連する error の詳細を提供するメッセージ。

    データタイプ：文字列
    result.result オペレーターが正常に登録解除されたかどうかを示すフラグ。
    可能な値：
    • true：オペレーターが正常に登録解除されました。
    • false：オペレーターが正常に登録解除されませんでした。

    データタイプ：文字列

    cURL 要求

    ユーザー ID でオペレーターを登録解除します。

    curl --request DELETE \
"https://instance.service-now.com/api/now/cilifecyclemgmt/operators/3cf1b3cc30121010f877773aa7167c6e" \
--header "Accept: application/json" \
--user "username":"password"

    応答本文は、オペレーターが登録解除されたことを確認します。

    {
  "result": {
    "result": true
  }
}

    CI ライフサイクル管理 - GET /now/cilifecyclemgmt/actions/{sys_id}

    指定された CI のアクティブな構成アイテム (CI) アクションのリストを返します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/actions/{sys_id}

    デフォルトの URL：/api/now/cilifecyclemgmt/actions/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 関連付けられている CI アクションを返す CI の sys_id。

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

    ヘッダー

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

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

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

    ステータスコード

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

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.ciActions パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 要求の結果をカプセル化するオブジェクト。

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

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.ciActions CI のアクティブな CI アクションのカンマ区切りリスト。見つからない場合は no_active_action。

    データタイプ：文字列
    result.errors 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。

    データタイプ：アレイ

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error 要求の処理中に発生したステータス管理エラーの識別子。
    可能な値：
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    データタイプ：文字列
    result.errors.message 関連する error の詳細を提供するメッセージ。

    データタイプ：文字列
    result.result 指定されたすべての CI に対してアクティブな CI アクションのリストが返されたかどうかを示すフラグ。
    可能な値：
    • true：アクティブな CI アクションのリストが返されました。
    • false：アクティブな CI アクションのリストが返されませんでした。

    データタイプ：文字列

    cURL 要求

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/actions/00a9a80d3790200044e0bfc8bcbe5d1c' \
--header 'Accept: application/json' \
--user "username":"password"

    応答本文は、指定された CI に対してアクティブな CI アクションがないことを示しています。

    {
  "result": {
    "ciActions": [
      "no_active_action"
    ],
    "result": true
  }
}

    CI ライフサイクル管理 - GET /now/cilifecyclemgmt/compatActions

    指定された 2 つの構成アイテム (CI) アクションに互換性があるかどうかを判断します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/compatActions

    デフォルトの URL：/api/now/cilifecyclemgmt/compatActions

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

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

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

    データタイプ：文字列
    表 : 20. クエリパラメーター
    名前 説明
    actionName 必須です。比較する CI アクションの名前。

    データタイプ：文字列
    otherActionName 必須です。比較する CI アクションの名前。

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

    ヘッダー

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

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

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

    ステータスコード

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

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 指定された 2 つの CI アクションに互換性があるかどうかを示すフラグ。
    可能な値：
    • true：CI アクションに互換性があります。
    • false：CI アクションに互換性がありません。

    データタイプ：文字列

    cURL 要求

    パッチ適用とプロビジョニングの CI アクションの互換性を確認します。

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/compatActions?actionName=Patching&otherActionName=Provisioning' \
--header 'Accept: application/json' \
--user "username":"password"

    応答本文は、2 つの CI アクションに互換性があることを確認します。

    {
  "result": true
}

    CI ライフサイクル管理 - GET /now/cilifecyclemgmt/leases/{sys_id}/expired

    指定された CI に適用される構成アイテム (CI) アクションの要求者に対してリースが期限切れかどうかを判断します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}/expired

    デフォルトの URL：/api/now/cilifecyclemgmt/leases/{sys_id}/expired

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

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

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

    データタイプ：文字列
    sys_id 適用された CI アクションのターゲットである CI の sys_id。

    データタイプ：文字列
    表 : 26. クエリパラメーター
    名前 説明
    actionName 必須です。指定された CI に適用される CI アクションの名前。

    データタイプ：文字列
    requestorId 必須です。 ワークフローコンテキストの sys_id、または CI ライフサイクル管理 - POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。

    オペレーターユーザー ID は、CI ステータス登録済みユーザー [statemgmt_register_users] テーブルにあります。

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

    ヘッダー

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

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

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

    ステータスコード

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

    表 : 30. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 要求の結果をカプセル化するオブジェクト。

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

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。

    データタイプ：アレイ

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error 要求の処理中に発生したステータス管理エラーの識別子。
    可能な値：
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    データタイプ：文字列
    result.errors.message 関連する error の詳細を提供するメッセージ。

    データタイプ：文字列
    result.result 適用された CI アクションの要求者のリース期限が切れたかどうかを示すフラグ。
    可能な値：
    • true：要求者のリース期限が切れました。
    • false：要求者のリース期限が切れていません。

    データタイプ：文字列

    cURL 要求

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/00a9a80d3790200044e0bfc8bcbe5d1c/expired?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a' \
--header 'Accept: application/json' \
--user "username":"password"

    応答本文は、適用された CI アクションの要求者のリース期限が切れていないことを示しています。

    {
  "result": {
    "result": false
  }
}

    CI ライフサイクル管理 - GET /now/cilifecyclemgmt/notAllowedAction

    指定された運用ステータスのときに、指定されたクラスの CI に対して指定された構成アイテム (CI) アクションが許可されていないかどうかを判断します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/notAllowedAction

    デフォルトの URL：/api/now/cilifecyclemgmt/notAllowedAction

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

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

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

    データタイプ：文字列
    表 : 32. クエリパラメーター
    名前 説明
    actionName 必須です。チェックする CI アクションの名前。

    データタイプ：文字列
    ciClass 必須です。CI クラス。

    データタイプ：文字列
    opsLabel 必須です。チェックする運用ステータス。

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

    ヘッダー

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

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

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

    ステータスコード

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

    表 : 36. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 指定された運用ステータスのときに、指定されたタイプの CI に対して CI アクションが制限されている (許可されていない) かどうかを示すフラグ。
    可能な値：
    • true：CI アクションは制限されています (許可されていません)。
    • false：CI アクションは無制限です (許可されています)。

    データタイプ：文字列

    cURL 要求

    DR スタンバイ運用ステータスのコンピューターに対して、パッチ適用 CI アクションが制限されている (許可されていない) かどうかを確認します。

    curl --request GET \
"https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedAction?actionName=Patching&ciClass=cmdb_ci_computer&opsLabel=DR+Standby" \
--header "Accept: application/json" \
--user "username":"password"

    応答本文は、指定された運用ステータスのときに、指定された CI クラスに対してこのアクションが制限されている (許可されていない) ことを確認します。

    {
  "result": true
}

    CI ライフサイクル管理 - GET /now/cilifecyclemgmt/notAllowedOpsTransition

    指定されたクラスの構成アイテム (CI) が、指定された運用ステータスから 2 番目に指定された運用ステータスに移行できるかどうかを判断します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/notAllowedOpsTransition

    デフォルトの URL：/api/now/cilifecyclemgmt/notAllowedOpsTransition

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

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

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

    データタイプ：文字列
    表 : 38. クエリパラメーター
    名前 説明
    ciClass 必須です。移行の制限を確認する CI クラス。

    データタイプ：文字列
    opsLabel 必須です。現在の CI 運用ステータスのラベル。

    データタイプ：文字列
    transitionOpsLabel 必須です。移行のターゲットである運用ステータスのラベル。

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

    ヘッダー

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

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

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

    ステータスコード

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

    表 : 42. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 指定された CI クラスに対して、指定された運用ステータスの移行が制限されている (許可されていない) かどうかを示すフラグ。
    可能な値：
    • true：運用ステータスの移行は制限されています (許可されていません)。
    • false：運用ステータスの移行は無制限です (許可されています)。

    データタイプ：文字列

    cURL 要求

    Linux サーバー CI に対して、廃止運用ステータスから DR スタンバイ運用ステータスへの移行が制限されている (許可されていない) かどうかを確認します。

    curl --request GET \
"https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedOpsTransition?ciClass=cmdb_ci_computer&opsLabel=Retired&transitionOpsLabel=DR+Standby" \
--header "Accept: application/json" \
--user "username":"password"

    応答本文は、この CI クラスに対して、指定された運用ステータスの移行が無制限である (許可されている) ことを示しています。

    {
  "result": false
}

    CI ライフサイクル管理 - GET /now/cilifecyclemgmt/requestors/{req_id}/valid

    指定されたアクティブなワークフローユーザーまたは登録されたユーザーが有効な要求者であるかどうかを判断します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/requestors/{req_id}/valid

    デフォルトの URL：/api/now/cilifecyclemgmt/requestors/{req_id}/valid

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

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

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

    データタイプ：文字列
    req_id ワークフローコンテキストの sys_id、または CI ライフサイクル管理 - POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。

    オペレーターユーザー ID は、CI ステータス登録済みユーザー [statemgmt_register_users] テーブルにあります。

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

    ヘッダー

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

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

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

    ステータスコード

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

    表 : 48. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 要求の結果をカプセル化するオブジェクト。

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

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。

    データタイプ：アレイ

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error 要求の処理中に発生したステータス管理エラーの識別子。
    可能な値：
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    データタイプ：文字列
    result.errors.message 関連する error の詳細を提供するメッセージ。

    データタイプ：文字列
    result.result 指定されたアクティブなワークフローユーザーまたは登録されたユーザーが有効な要求者であるかどうかを示すフラグ。
    可能な値：
    • true：有効な要求者。
    • false：無効な要求者。

    データタイプ：文字列

    cURL 要求

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/requestors/4cab9b95301a9010f877773aa7167ca9/valid' \
--header 'Accept: application/json' \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    CI ライフサイクル管理 - GET /now/cilifecyclemgmt/statuses/{sys_id}

    指定された構成アイテム (CI) の現在の運用ステータスを返します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/statuses/{sys_id}

    デフォルトの URL：/api/now/cilifecyclemgmt/statuses/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id CI の sys_id。

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

    ヘッダー

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

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

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

    ステータスコード

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

    表 : 54. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 要求の結果をカプセル化するオブジェクト。

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

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。

    データタイプ：アレイ

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error 要求の処理中に発生したステータス管理エラーの識別子。
    可能な値：
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    データタイプ：文字列
    result.errors.message 関連する error の詳細を提供するメッセージ。

    データタイプ：文字列
    result.operationalStates 指定された CI の運用ステータス、またはステータスが指定されていない場合は unknown です。

    データタイプ：文字列

    cURL 要求

    curl --request GET 'https://instance.service-now.com/api/now/cilifecyclemgmt/statuses/aac0b1213784200044e0bfc8bcbe5de3' \
--header 'Accept: application/json' \
--user "username":"password"
    {
  "result": {
    "operationalState": "Repair in Progress",
    "result": true
  }
}

    CI ライフサイクル管理 - PATCH /now/cilifecyclemgmt/leases/{sys_id}

    指定されたユーザーの指定された構成アイテム (CI) アクションのリース期限を延長します。

    前のリース期限が切れている場合は、新しいリース時間がすぐに開始されます。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}

    デフォルトの URL：/api/now/cilifecyclemgmt/leases/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id リースを延長する CI の sys_id。

    データタイプ：文字列
    表 : 56. クエリパラメーター
    名前 説明
    actionName 必須です。関連付けられている CI アクションの名前。

    データタイプ：文字列
    leaseTime 必須です。actionName で指定された CI アクションに対してリースが有効である期間。

    データタイプ：文字列

    形式：HH:MM:SS
    requestorId 必須です。 ワークフローコンテキストの sys_id、または CI ライフサイクル管理 - POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。

    オペレーターユーザー ID は、CI ステータス登録済みユーザー [statemgmt_register_users] テーブルにあります。

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

    ヘッダー

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

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

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

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

    ステータスコード

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

    表 : 60. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 要求の結果をカプセル化するオブジェクト。

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

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。

    データタイプ：アレイ

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error 要求の処理中に発生したステータス管理エラーの識別子。
    可能な値：
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    データタイプ：文字列
    result.errors.message 関連する error の詳細を提供するメッセージ。

    データタイプ：文字列
    result.result リース時間が延長されたかどうかを示すフラグ。
    可能な値：
    • true：リース時間が延長されました。
    • false：リース時間が延長されませんでした。

    データタイプ：文字列

    cURL 要求

    パッチ適用 CI アクションの要求者のリース期間を 24 時間延長します。

    curl --request PATCH 'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/affd3c8437201000deeabfc8bcbe5dc3?actionName=Patching&leaseTime=24:00:00&requestorId=e7c3402d305a9010f877773aa7167c2a' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    CI ライフサイクル管理 - POST /now/cilifecyclemgmt/actions

    指定された CI のリストに、指定された構成アイテム (CI) アクションを追加します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/actions

    デフォルトの URL：/api/now/cilifecyclemgmt/actions

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

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

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

    データタイプ：文字列
    表 : 62. クエリパラメーター
    名前 説明
    actionName 必須です。リストに追加する CI アクションの名前。

    データタイプ：文字列
    leaseTime 指定された CI アクションに対してリースが有効である時間。

    データタイプ：文字列

    形式：HH:MM:SS
    oldActionName すべての CI が含まれているはずの古い CI アクションのカンマ区切りリスト。

    データタイプ：文字列
    requestorId 必須です。 ワークフローコンテキストの sys_id、または CI ライフサイクル管理 - POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。

    オペレーターユーザー ID は、CI ステータス登録済みユーザー [statemgmt_register_users] テーブルにあります。

    データタイプ：文字列
    sysids 必須です。CI アクションを追加する CI sys_id のカンマ区切りリスト。

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

    ヘッダー

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

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

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

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

    ステータスコード

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

    表 : 66. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 要求の結果をカプセル化するオブジェクト。

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

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。

    データタイプ：アレイ

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error 要求の処理中に発生したステータス管理エラーの識別子。
    可能な値：
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    データタイプ：文字列
    result.errors.message 関連する error の詳細を提供するメッセージ。

    データタイプ：文字列
    result.result リスト内のすべての CI に CI アクションが設定されたかどうかを示すフラグ。
    可能な値：
    • true：CI アクションが設定されました。
    • false：CI アクションが設定されませんでした。

    データタイプ：文字列

    cURL 要求

    2 つの CI にパッチ適用 CI アクションを追加します。

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    CI ライフサイクル管理 - POST /now/cilifecyclemgmt/operators

    ワークフロー以外のユーザーのオペレーターを登録します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/operators

    デフォルトの URL：/api/now/cilifecyclemgmt/operators

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

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

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

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

    ヘッダー

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

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

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

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

    ステータスコード

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

    表 : 72. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 要求の結果をカプセル化するオブジェクト。

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

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。

    データタイプ：アレイ

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error 要求の処理中に発生したステータス管理エラーの識別子。
    可能な値：
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    データタイプ：文字列
    result.errors.message 関連する error の詳細を提供するメッセージ。

    データタイプ：文字列
    result.requestorId 登録済みオペレーターの GUID。この値を使用して、CI アクションと運用ステータスを設定します。

    データタイプ：文字列
    result.result オペレーターが正常に登録されたかどうかを示すフラグ。
    可能な値：
    • true：オペレーターが正常に登録されました。
    • false：オペレーターが正常に登録されませんでした。

    データタイプ：文字列

    cURL 要求

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/operators" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"
    {
  "result": {
    "result": true,
    "requestorId": "6f992b8430121010f877773aa7167c42"
  }
}

    CI ライフサイクル管理 - POST /now/cilifecyclemgmt/statuses

    指定された構成アイテム (CI) のリストの運用ステータスを設定します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/cilifecyclemgmt/statuses

    デフォルトの URL：/api/now/cilifecyclemgmt/statuses

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

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

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

    データタイプ：文字列
    表 : 74. クエリパラメーター
    名前 説明
    oldOpsLabels すべての CI が含まれているはずの、古い CI 運用ステータスのカンマ区切りリスト。

    データタイプ：文字列
    opsLabel 必須です。指定された CI に設定する運用ステータスのラベル。

    データタイプ：文字列
    requestorId 必須です。 ワークフローコンテキストの sys_id、または CI ライフサイクル管理 - POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。

    オペレーターユーザー ID は、CI ステータス登録済みユーザー [statemgmt_register_users] テーブルにあります。

    データタイプ：文字列
    sysids 必須です。運用ステータスが設定される CI の sys_id のカンマ区切りリスト。

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

    ヘッダー

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

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

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

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

    ステータスコード

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

    表 : 78. ステータスコード
    ステータスコード 説明
    200 成功。エンドポイントによって要求が正常に処理されました。

    応答本文の result.result パラメーターを確認して、操作の結果を確認します。

    要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが、応答本文の result.errors パラメーターに表示されます。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    result 要求の結果をカプセル化するオブジェクト。

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

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。

    データタイプ：アレイ

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error 要求の処理中に発生したステータス管理エラーの識別子。
    可能な値：
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    データタイプ：文字列
    result.errors.message 関連する error の詳細を提供するメッセージ。

    データタイプ：文字列
    result.result 要求に含まれているすべての CI に目的のステータスが設定されたかどうかを示すフラグ。
    可能な値：
    • true：運用ステータスが設定されています。
    • false：運用ステータスが設定されていません。

    データタイプ：文字列

    cURL 要求

    2 つの CI に Repair in Progress 運用ステータスを設定します。

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/statuses?opsLabel=Repair%20in%20Progress&requestorId=23d58bc030121010f877773aa7167c83&sysIds=affd3c8437201000deeabfc8bcbe5dc3,aac0b1213784200044e0bfc8bcbe5de3" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"

    応答本文は、要求で指定された両方の CI に対して目的の運用ステータスが設定されたことを示しています。

    {
  "result": {
    "result": true
  }
}