CI ライフサイクル管理 API
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
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| actionName | 必須です。構成アイテムアクション名。 データタイプ:文字列 |
| requestorId | 必須です。 ワークフローコンテキストのSys_id、または CI ライフサイクル管理:POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。 オペレーターユーザー ID は、CI ステータス登録ユーザー [statemgmt_register_users] テーブルにあります。 データタイプ:文字列 |
| sysIds | 必須です。CI sys_idsのカンマ区切りリスト。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 要求の結果をカプセル化するオブジェクト。 データタイプ: オブジェクト |
| result.errors | 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。 データタイプ:アレイ |
| result.errors.error | 要求の処理中に発生した状況管理エラーの識別子。 可能な値:
データタイプ:文字列 |
| result.errors.message | 関連する errorの詳細を提供するメッセージ。 データタイプ:文字列 |
| result.result | 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}
サポートされている要求パラメーター
| パラメーター | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| req_id | ワークフローコンテキストのSys_id、または CI ライフサイクル管理:POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。 オペレーターユーザー ID は、CI ステータス登録ユーザー [statemgmt_register_users] テーブルにあります。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 要求の結果をカプセル化するオブジェクト。 データタイプ: オブジェクト |
| result.errors | 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。 データタイプ:アレイ |
| result.errors.error | 要求の処理中に発生した状況管理エラーの識別子。 可能な値:
データタイプ:文字列 |
| result.errors.message | 関連する errorの詳細を提供するメッセージ。 データタイプ:文字列 |
| result.result | オペレーターが正常に登録解除されたかどうかを示すフラグ。 可能な値:
データタイプ:文字列 |
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}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| sys_id | 関連する CI アクションを返す CI のSys_id。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.ciActions パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 要求の結果をカプセル化するオブジェクト。 データタイプ: オブジェクト |
| result.ciActions | CI のアクティブな CI アクションのカンマ区切りリスト。何も見つからない場合は no_active_action 。データタイプ:文字列 |
| result.errors | 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。 データタイプ:アレイ |
| result.errors.error | 要求の処理中に発生した状況管理エラーの識別子。 可能な値:
データタイプ:文字列 |
| result.errors.message | 関連する errorの詳細を提供するメッセージ。 データタイプ:文字列 |
| result.result | 指定されたすべての CI に対してアクティブな 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
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| actionName | 必須です。比較する CI アクションの名前。 データタイプ:文字列 |
| その他のアクション名 | 必須です。比較する CI アクションの名前。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 指定された 2 つの 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
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| sys_id | 適用された CI アクションのターゲットである CI のSys_id。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| actionName | 必須です。指定された CI に適用される CI アクションの名前。 データタイプ:文字列 |
| requestorId | 必須です。 ワークフローコンテキストのSys_id、または CI ライフサイクル管理:POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。 オペレーターユーザー ID は、CI ステータス登録ユーザー [statemgmt_register_users] テーブルにあります。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 要求の結果をカプセル化するオブジェクト。 データタイプ: オブジェクト |
| result.errors | 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。 データタイプ:アレイ |
| result.errors.error | 要求の処理中に発生した状況管理エラーの識別子。 可能な値:
データタイプ:文字列 |
| result.errors.message | 関連する errorの詳細を提供するメッセージ。 データタイプ:文字列 |
| result.result | 適用された CI アクションの要求者のリースが期限切れになったかどうかを示すフラグ。 可能な値:
データタイプ:文字列 |
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
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| actionName | 必須です。チェックする CI アクションの名前。 データタイプ:文字列 |
| ciClass | 必須です。CI クラス。 データタイプ:文字列 |
| opsLabel | 必須です。確認する運用ステータス。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 指定された運用ステータスにあるときに、指定されたタイプの CI に対して 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
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| ciClass | 必須です。移行制限を確認する CI クラス。 データタイプ:文字列 |
| opsLabel | 必須です。現在の CI 運用ステータスのラベル。 データタイプ:文字列 |
| transitionOpsLabel | 必須です。移行のターゲットである運用ステータスのラベル。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 指定された CI クラスに対して、指定された運用ステータスの移行が制限されている (許可されない) かどうかを示すフラグ。 可能な値:
データタイプ:文字列 |
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
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| req_id | ワークフローコンテキストのSys_id、または CI ライフサイクル管理:POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。 オペレーターユーザー ID は、CI ステータス登録ユーザー [statemgmt_register_users] テーブルにあります。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 要求の結果をカプセル化するオブジェクト。 データタイプ: オブジェクト |
| result.errors | 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。 データタイプ:アレイ |
| result.errors.error | 要求の処理中に発生した状況管理エラーの識別子。 可能な値:
データタイプ:文字列 |
| result.errors.message | 関連する errorの詳細を提供するメッセージ。 データタイプ:文字列 |
| result.result | 指定されたアクティブなワークフローユーザーまたは登録されたユーザーが有効な要求者であるかどうかを示すフラグ。 可能な値:
データタイプ:文字列 |
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}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| sys_id | CI のSys_id。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 要求の結果をカプセル化するオブジェクト。 データタイプ: オブジェクト |
| result.errors | 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。 データタイプ:アレイ |
| result.errors.error | 要求の処理中に発生した状況管理エラーの識別子。 可能な値:
データタイプ:文字列 |
| result.errors.message | 関連する errorの詳細を提供するメッセージ。 データタイプ:文字列 |
| result.operationalStates | 指定された CI の運用ステータス。ステータスが指定されていない場合は 不明 です。データタイプ:文字列 |
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}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| sys_id | リースを延長する CI のSys_id。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| actionName | 必須です。関連付けられた CI アクションの名前。 データタイプ:文字列 |
| leaseTime | 必須です。actionNameで指定された CI アクションに対してリースが有効な期間。 データタイプ:文字列 形式:HH:MM:SS |
| requestorId | 必須です。 ワークフローコンテキストのSys_id、または CI ライフサイクル管理:POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。 オペレーターユーザー ID は、CI ステータス登録ユーザー [statemgmt_register_users] テーブルにあります。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 要求の結果をカプセル化するオブジェクト。 データタイプ: オブジェクト |
| result.errors | 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。 データタイプ:アレイ |
| result.errors.error | 要求の処理中に発生した状況管理エラーの識別子。 可能な値:
データタイプ:文字列 |
| result.errors.message | 関連する errorの詳細を提供するメッセージ。 データタイプ:文字列 |
| result.result | リース時間が延長されたかどうかを示すフラグ。 可能な値:
データタイプ:文字列 |
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
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| 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_idsのカンマ区切りリスト。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 要求の結果をカプセル化するオブジェクト。 データタイプ: オブジェクト |
| result.errors | 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。 データタイプ:アレイ |
| result.errors.error | 要求の処理中に発生した状況管理エラーの識別子。 可能な値:
データタイプ:文字列 |
| result.errors.message | 関連する errorの詳細を提供するメッセージ。 データタイプ:文字列 |
| result.result | リスト内のすべての CI に対して 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
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 要求の結果をカプセル化するオブジェクト。 データタイプ: オブジェクト |
| result.errors | 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。 データタイプ:アレイ |
| result.errors.error | 要求の処理中に発生した状況管理エラーの識別子。 可能な値:
データタイプ:文字列 |
| result.errors.message | 関連する errorの詳細を提供するメッセージ。 データタイプ:文字列 |
| result.requestorId | 登録された演算子の GUID。この値を使用して、CI アクションと運用状況を設定します。 データタイプ:文字列 |
| result.result | オペレーターが正常に登録されたかどうかを示すフラグ。 可能な値:
データタイプ:文字列 |
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
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| oldOpsLabels | すべての CI を含める必要がある古い CI 運用状況のカンマ区切りリスト。 データタイプ:文字列 |
| opsLabel | 必須です。指定された CI に設定する運用ステータスのラベル。 データタイプ:文字列 |
| requestorId | 必須です。 ワークフローコンテキストのSys_id、または CI ライフサイクル管理:POST /now/cilifecyclemgmt/operators エンドポイントから返されたオペレーターユーザー ID。 オペレーターユーザー ID は、CI ステータス登録ユーザー [statemgmt_register_users] テーブルにあります。 データタイプ:文字列 |
| sysIds | 必須です。運用ステータスを設定する CI のsys_idsのカンマ区切りリスト。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求はエンドポイントによって正常に処理されました。 応答本文 result.result パラメーターを確認して、操作の結果を確認します。 要求の処理中にエンドポイントでエラーが発生した場合、エラーコードとメッセージが応答本文 result.errors パラメーターに表示されます。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 要求の結果をカプセル化するオブジェクト。 データタイプ: オブジェクト |
| result.errors | 各オブジェクトが要求の処理中に発生したエラーを表すオブジェクトのリスト。 データタイプ:アレイ |
| result.errors.error | 要求の処理中に発生した状況管理エラーの識別子。 可能な値:
データタイプ:文字列 |
| result.errors.message | 関連する errorの詳細を提供するメッセージ。 データタイプ:文字列 |
| result.result | 要求に含まれるすべての CI に適切な状況が設定されているかどうかを示すフラグ。 可能な値:
データタイプ:文字列 |
cURL 要求
2 つの CI の [ 修理中 ] 運用ステータスを設定します。
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
}
}