テーブル API
-
- 更新日2024年2月1日
- 所要時間:72 分
- Washington DC
- "API リファレンス"
テーブル API は、既存のテーブルでの作成、読み取り、更新、および削除 (CRUD) 操作の実行を可能にするエンドポイントを提供します。
呼び出し元ユーザーは、要求で指定されたテーブルのデータにアクセスするための十分なロールを持っている必要があります。
テーブル - DELETE /now/table/{tableName}/{sys_id}
指定されたテーブルから指定されたレコードを削除します。
URL 形式
バージョニングされた URL:/api/now/{api_version}/table/{tableName}/{sys_id}
デフォルトの URL:/api/now/table/{tableName}/{sys_id}
サポートされている要求パラメーター
名前 | 説明 |
---|---|
api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
sys_id | 削除するレコードの sys_id。 データタイプ:文字列 |
tableName | 指定したレコードを削除するテーブルの名前 (「incident」や「asset」など)。 データタイプ:文字列 |
名前 | 説明 |
---|---|
sysparm_query_no_domain | ログインユーザーが設定されているドメインだけにレコード検索を制限するかどうかを示すフラグ。 有効な値:
データタイプ:ブール デフォルト値:false 注: sysparm_query_no_domain パラメーターは、システム管理者または、query_no_domain_table_api ロールを持つユーザーのみが利用できるパラメーターです。 |
名前 | 説明 |
---|---|
なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
ヘッダー | 説明 |
---|---|
Accept | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
ヘッダー | 説明 |
---|---|
なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
ステータスコード | 説明 |
---|---|
204 | 要求が正常に完了したことを示します。 |
応答本文のパラメーター (JSON または XML)
名前 | 説明 |
---|---|
なし |
例: cURL 要求
インシデントテーブルからレコードを削除します。
応答本文はありません。
テーブル - GET /now/table/{tableName}
指定されたテーブルの複数のレコードを取得します。
基本的な手順については、「 既存のインシデントを取得する」を参照してください。
URL 形式
バージョニングされた URL:/api/now/{api_version}/table/{tableName}
デフォルトの URL:/api/now/table/{tableName}
サポートされている要求パラメーター
名前 | 説明 |
---|---|
api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 このエンドポイントは、バージョンに応じて、有効なクエリに対して異なる結果を返します。
データタイプ:文字列 |
tableName | レコードの取得元のテーブルの名前。 データタイプ:文字列 |
名前 | 説明 |
---|---|
なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
ヘッダー | 説明 |
---|---|
承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
ヘッダー | 説明 |
---|---|
Link | 前の要求に基づく相対 URL。利用可能なレコードセットのページングに使用できます。 たとえば、次のようになります。
|
X-Total-Count | クエリによって返されたレコードの合計数。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
ステータスコード | 説明 |
---|---|
200 | 要求が正常に完了しました。有効なクエリで結果が返されなかった場合、応答の本文には空の結果配列のみが含まれます。 |
応答本文のパラメーター (JSON または XML)
パラメーター | 説明 |
---|---|
name-value pairs | 指定されたレコード内のすべてのパラメーターのフィールド名と値、またはクエリパラメーターで指定されたフィールド名と値。 |
例: cURL 要求
問題テーブルから最初のレコードを取得します。
応答には、要求されたレコードの名前と値のペアが含まれます。
テーブル - GET /now/table/{tableName}/{sys_id}
指定されたテーブルから、指定された sys_id で識別されるレコードを取得します。
URL 形式
バージョニングされた URL:/api/now/{api_version}/table/{tableName}/{sys_id}
デフォルトの URL:/api/now/table/{tableName}/{sys_id}
サポートされている要求パラメーター
名前 | 説明 |
---|---|
api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
sys_id | 取得するレコードの sys_id。 データタイプ:文字列 |
tableName | レコードの取得元のテーブルの名前。 データタイプ:文字列 |
名前 | 説明 |
---|---|
なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
ヘッダー | 説明 |
---|---|
承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
ヘッダー | 説明 |
---|---|
なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
ステータスコード | 説明 |
---|---|
200 | 成功。要求が正常に処理されました。 |
404 | 見つかりません。要求アイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
パラメーター | 説明 |
---|---|
name-value pairs | 指定されたレコード内のすべてのパラメーターのフィールド名と値、またはクエリパラメーターで指定されたフィールド名と値。 |
例: cURL 要求
インシデントテーブルからレコードを取得します。
応答には、要求されたレコードの名前と値のペアが含まれます。
テーブル - PATCH /now/table/{tableName}/{sys_id}
指定されたレコードを要求本文に含まれる名前と値のペアで更新します。
URL 形式
バージョニングされた URL:/api/now/{api_version}/table/{tableName}/{sys_id}
デフォルトの URL:/api/now/table/{tableName}/{sys_id}
サポートされている要求パラメーター
名前 | 説明 |
---|---|
api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
sys_id | 更新するレコードの sys_id。 データタイプ:文字列 |
tableName | 指定されたレコードがあるテーブルの名前。 データタイプ:文字列 |
名前 | 説明 |
---|---|
name-value pairs | 指定されたレコードで更新する各パラメーターのフィールド名と新しい値。 注: レコード内のすべてのフィールドは更新できない場合があります。たとえば、「sys_」のプリフィックスを持つフィールドは、通常、自動的に生成されるシステムパラメーターであり、更新することはできません。 |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
ヘッダー | 説明 |
---|---|
Accept | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
Content-Type | 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
X-no-response-body | デフォルトでは、応答には変更されたレコードの詳細を示す本文コンテンツが含まれます。応答本文を抑制するには、この要求ヘッダーを true に設定します。 |
ヘッダー | 説明 |
---|---|
なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
ステータスコード | 説明 |
---|---|
200 | 成功。要求が正常に処理されました。 |
400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
404 | 見つかりません。要求アイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
名前 | 説明 |
---|---|
name-value pairs | 指定されたレコード内のすべてのパラメーターのフィールド名と値、またはクエリパラメーターで指定されたフィールド名と値。 |
例: cURL 要求
インシデントテーブルのレコードを更新します。
応答には、更新されたレコードの名前と値のペアが含まれます。
テーブル - POST /now/table/{tableName}
指定されたテーブルに 1 つのレコードを挿入します。このメソッドでは、複数のレコードの挿入はサポートされていません。
URL 形式
バージョニングされた URL:/api/now/{api_version}/table/{tableName}
デフォルトの URL:/api/now/table/{tableName}
サポートされている要求パラメーター
名前 | 説明 |
---|---|
api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
tableName | レコードを保存するテーブルの名前。 データタイプ:文字列 |
名前 | 説明 |
---|---|
name-value pairs | 指定されたレコードで定義する各パラメーターのフィールド名および関連付けられた値。 注: レコード内のすべてのフィールドは更新できない場合があります。たとえば、「sys_」のプリフィックスを持つフィールドは、通常、自動的に生成されるシステムパラメーターであり、更新することはできません。 指定されておらず、システムによって自動生成されないフィールドは、関連付けられたデータタイプの null 値に設定されます。 |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
ヘッダー | 説明 |
---|---|
Accept | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
Content-Type | 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
X-no-response-body | デフォルトでは、応答には新規レコードの詳細を示す本文コンテンツが含まれます。応答本文を抑制するには、要求内でこのヘッダーを true に設定します。 |
ヘッダー | 説明 |
---|---|
場所 | 作成されたリソースの場所。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
ステータスコード | 説明 |
---|---|
201 | 要求が正常に完了したことを示します。 |
400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
404 | 見つかりません。要求アイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
名前 | 説明 |
---|---|
name-value pairs | 新しく作成されたレコード内のすべてのパラメーターのフィールド名と値、またはクエリパラメーターで指定されたフィールド名と値。 |
例: cURL 要求
新規レコードをインシデントテーブルに挿入します。
応答には、新規レコードの名前と値のペアが含まれます。
テーブル - PUT /now/table/{tableName}/{sys_id}
要求本文で指定されたレコードを更新します。
URL 形式
バージョニングされた URL:/api/now/{api_version}/table/{tableName}/{sys_id}
デフォルトの URL:/api/now/table/{tableName}/{sys_id}
サポートされている要求パラメーター
名前 | 説明 |
---|---|
api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
sys_id | 更新するレコードの一意の識別子。 データタイプ:文字列 |
tableName | レコードがあるテーブルの名前。 データタイプ:文字列 |
名前 | 説明 |
---|---|
name-value pairs | 関連テーブルで更新するフィールドの名前と値のペア。たとえば、簡単な説明のファイルを更新するには、次のような名前と値のペアを入力します。--data "{\"short_description\": \"my short desc\" }" \ |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
ヘッダー | 説明 |
---|---|
Accept | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
Content-Type | 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml。 |
X-no-response-body | デフォルトでは、応答には変更されたレコードの詳細を示す本文コンテンツが含まれます。応答本文を抑制するには、要求内でこのヘッダーを true に設定します。 |
ヘッダー | 説明 |
---|---|
なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
ステータスコード | 説明 |
---|---|
200 | 成功。要求が正常に処理されました。 |
400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
404 | 見つかりません。要求アイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
名前 | 説明 |
---|---|
name-value pairs | 変更要求のすべてのフィールド (変更されたフィールド以外も含む) とその関連付けられた値。 |
例: cURL 要求
インシデントテーブルのレコードを更新します。
応答には、更新されたレコードの名前と値のペアが含まれます。