テーブル 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 要求
インシデントテーブルからレコードを削除します。
curl "https://instance.servicenow.com/api/now/table/incident/d977b66a4f411200adf9f8e18110c7b2" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'
応答本文はありません。
None
テーブル - GET /now/table/{tableName}
指定されたテーブルの複数のレコードを取得します。
基本的な手順については、「 既存のインシデントの取得」を参照してください。
URL 形式
バージョニングされた URL:/api/now/{api_version}/table/{tableName}
デフォルトの URL:/api/now/table/{tableName}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 このエンドポイントは、バージョンに応じて、有効なクエリに対して異なる結果を返します。
データタイプ:文字列 |
| tableName | レコードの取得元のテーブルの名前。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| name-value pairs | 結果セットをフィルタリングするために使用する名前と値のペア。このパラメーターは、sysparm_query と相互に排他的です。たとえば、&sysparm_query=active=true を使用する代わりに、&active=true を使用して呼び出しステートメントを簡素化できます。フィールドが選択フィールドや参照タイプフィールドの場合も、表示値を使用できます (&state=7 の代わりに &state=closed など)。複数のキーと値のペアを指定するには、それぞれをアンパサンドで区切ります (&active=true&assigned_to=john.smith など)。データタイプ:文字列 |
| sysparm_display_value | 返されるデータ (データベースからの実際の値またはフィールドの表示値) のタイプを決定します。表示値は、データベース内の実際の値と、ユーザーやシステムの設定と環境設定に基づいて操作されます。 表示値を返す場合、返される値はフィールドタイプに依存します。
データタイプ:文字列 有効な値:
デフォルト値:false 注: このパラメーター設定に推奨方法はありません。ただし、表示値を指定すると、データベースから直接読み取られず、その他のフィールドやレコードを参照することがあるため、パフォーマンスに問題が発生する可能性があります。表示値と実際の値の詳細については、「テーブル API FAQ (KB0534905)」を参照してください。 |
| sysparm_exclude_reference_link | 参照フィールドのテーブル API リンクを除外するかどうかを示すフラグ。 有効な値:
データタイプ:ブール デフォルト値:false |
| sysparm_fields | 応答で返すカンマで区切られたフィールドのリストです。 データタイプ:文字列 |
| sysparm_limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。 この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。 注: 異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。 データタイプ:数値 デフォルト:10000 |
| sysparm_no_count | テーブルに対して select count(*) クエリを実行して、関連テーブルの行数を返すかどうかを示すフラグ。有効な値:
データタイプ:ブール デフォルト値:false |
| sysparm_offset | レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。 たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「 データタイプ:数値 デフォルト:0 |
| sysparm_query | 結果セットをフィルタリングするために使用されるエンコードされたクエリ。UI フィルターを使用して、適切にエンコードクエリーを取得できます。 構文: sysparm_query=<col_name><operator><value>。
すべてのパラメーターで大文字と小文字が区別されます。クエリには、sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>] のように、複数のエントリを含めることができます。 例:
エンコードクエリーは、機能別の順番もサポートしています。特定のフィールドに基づいて回答を並べ替えるには、 構文:
例: このクエリは、すべてのアクティブなレコードをフィルタリングし、結果を番号で昇順に並べ替えた後、カテゴリで降順に並べ替えます。 フィールド名が無効というようにクエリの一部が無効であると、インスタンスは無効な部分を無視します。次に、クエリの有効部分のみを使用して行を返します。この動作は glide.invalid_query.returns_no_rows プロパティを使用してコントロールできます。無効なクエリに行を返さないようにするには、このプロパティを true に設定します。 注: glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンスのすべてのクエリの動作を管理します。 データタイプ:文字列 |
| sysparm_query_category | クエリに使用するカテゴリの名前。 データタイプ:文字列 |
| sysparm_query_no_domain | ログインユーザーが設定されているドメインだけにレコード検索を制限するかどうかを示すフラグ。 有効な値:
データタイプ:ブール デフォルト値:false 注: sysparm_query_no_domain パラメーターは、システム管理者または、query_no_domain_table_api ロールを持つユーザーのみが利用できるパラメーターです。 |
| sysparm_suppress_pagination_header | 応答からリンクヘッダーを削除するかどうかを示すフラグ。リンクヘッダーは、返されたレコードセットをページネーションするために使用できるレコードセット内の相対ページへのさまざまな URL を提供します。 有効な値:
データタイプ:ブール デフォルト値:false |
| sysparm_view | データをレンダリングする UI ビュー。応答で返されるフィールドを指定します。 有効な値:
sysparm_fields パラメーターが優先されます (指定した場合)。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この 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 要求
問題テーブルから最初のレコードを取得します。
curl "https://instance.servicenow.com/api/now/table/problem?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
応答には、要求されたレコードの名前と値のペアが含まれます。
{
"result": [
{
"parent": "",
"made_sla": "true",
"watch_list": "",
"upon_reject": "cancel",
"sys_updated_on": "2016-01-19 04:52:04",
"approval_history": "",
"number": "PRB0000050",
"sys_updated_by": "glide.maint",
"opened_by": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
"value": "glide.maint"
},
"user_input": "",
"sys_created_on": "2016-01-19 04:51:19",
"sys_domain": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"state": "4",
"sys_created_by": "glide.maint",
"knowledge": "false",
"order": "",
"closed_at": "2016-01-19 04:52:04",
"cmdb_ci": {
"link": "https://instance.servicenow.com/api/now/table/cmdb_ci/55b35562c0a8010e01cff22378e0aea9",
"value": "55b35562c0a8010e01cff22378e0aea9"
},
"delivery_plan": "",
"impact": "3",
"active": "false",
"work_notes_list": "",
"business_service": "",
"priority": "4",
"sys_domain_path": "/",
"time_worked": "",
"expected_start": "",
"rejection_goto": "",
"opened_at": "2016-01-19 04:49:47",
"business_duration": "1970-01-01 00:00:00",
"group_list": "",
"work_end": "",
"approval_set": "",
"wf_activity": "",
"work_notes": "",
"short_description": "Switch occasionally drops connections",
"correlation_display": "",
"delivery_task": "",
"work_start": "",
"assignment_group": "",
"additional_assignee_list": "",
"description": "Switch occasionally drops connections",
"calendar_duration": "1970-01-01 00:02:17",
"close_notes": "updated firmware",
"sys_class_name": "problem",
"closed_by": "",
"follow_up": "",
"sys_id": "04ce72c9c0a8016600b5b7f75ac67b5b",
"contact_type": "phone",
"urgency": "3",
"company": "",
"reassignment_count": "",
"activity_due": "",
"assigned_to": "",
"comments": "",
"approval": "not requested",
"sla_due": "",
"comments_and_work_notes": "",
"due_date": "",
"sys_mod_count": "1",
"sys_tags": "",
"escalation": "0",
"upon_approval": "proceed",
"correlation_id": "",
"location": ""
}
]
}
テーブル - 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 | レコードの取得元のテーブルの名前。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| sysparm_display_value | 返されるデータ (データベースからの実際の値またはフィールドの表示値) のタイプを決定します。表示値は、データベース内の実際の値と、ユーザーやシステムの設定と環境設定に基づいて操作されます。 表示値を返す場合、返される値はフィールドタイプに依存します。
データタイプ:文字列 有効な値:
デフォルト値:false 注: このパラメーター設定に推奨方法はありません。ただし、表示値を指定すると、データベースから直接読み取られず、その他のフィールドやレコードを参照することがあるため、パフォーマンスに問題が発生する可能性があります。表示値と実際の値の詳細については、「テーブル API FAQ (KB0534905)」を参照してください。 |
| sysparm_exclude_reference_link | 参照フィールドのテーブル API リンクを除外するかどうかを示すフラグ。 有効な値:
データタイプ:ブール デフォルト値:false |
| sysparm_fields | 応答で返すカンマで区切られたフィールドのリストです。 データタイプ:文字列 |
| sysparm_query_no_domain | ログインユーザーが設定されているドメインだけにレコード検索を制限するかどうかを示すフラグ。 有効な値:
データタイプ:ブール デフォルト値:false 注: sysparm_query_no_domain パラメーターは、システム管理者または、query_no_domain_table_api ロールを持つユーザーのみが利用できるパラメーターです。 |
| sysparm_view | データをレンダリングする UI ビュー。応答で返されるフィールドを指定します。 有効な値:
sysparm_fields パラメーターが優先されます (指定した場合)。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この 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 要求
インシデントテーブルからレコードを取得します。
curl "https://instance.servicenow.com/api/now/table/incident/a9e30c7dc61122760116894de7bcc7bd" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
応答には、要求されたレコードの名前と値のペアが含まれます。
{
"result": {
"upon_approval": "",
"location": {
"link": "https://instance.servicenow.com/api/now/table/cmn_location/105cf7f3c611227501e75e08b14a38ba",
"value": "105cf7f3c611227501e75e08b14a38ba"
},
"expected_start": "",
"reopen_count": "",
"close_notes": "",
"additional_assignee_list": "",
"impact": "1",
"urgency": "3",
"correlation_id": "",
"sys_tags": "",
"sys_domain": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"description": "",
"group_list": "",
"priority": "3",
"delivery_plan": "",
"sys_mod_count": "4",
"work_notes_list": "",
"business_service": "",
"follow_up": "",
"closed_at": "",
"sla_due": "2015-11-11 22:04:15",
"delivery_task": "",
"sys_updated_on": "2015-11-01 22:37:27",
"parent": "",
"work_end": "",
"number": "INC0000046",
"closed_by": "",
"work_start": "",
"calendar_stc": "",
"category": "software",
"business_duration": "",
"incident_state": "1",
"activity_due": "",
"correlation_display": "",
"company": "",
"active": "true",
"due_date": "",
"assignment_group": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a4dde73c6112278017a6a4baf547aa7",
"value": "8a4dde73c6112278017a6a4baf547aa7"
},
"caller_id": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7",
"value": "46c6f9efa9fe198101ddf5eed9adf6e7"
},
"knowledge": "false",
"made_sla": "false",
"comments_and_work_notes": "",
"parent_incident": "",
"state": "1",
"user_input": "",
"sys_created_on": "2015-11-01 22:05:30",
"approval_set": "",
"reassignment_count": "1",
"rfc": "",
"child_incidents": "",
"opened_at": "2015-11-02 22:04:15",
"short_description": "Can't access SFA software",
"order": "",
"sys_updated_by": "glide.maint",
"resolved_by": "",
"notify": "1",
"upon_reject": "",
"approval_history": "",
"problem_id": {
"link": "https://instance.servicenow.com/api/now/table/problem/a9e4890bc6112276003d7a5a5c774a74",
"value": "a9e4890bc6112276003d7a5a5c774a74"
},
"work_notes": "",
"calendar_duration": "",
"close_code": "",
"sys_id": "a9e30c7dc61122760116894de7bcc7bd",
"approval": "not requested",
"caused_by": "",
"severity": "3",
"sys_created_by": "admin",
"resolved_at": "",
"assigned_to": "",
"business_stc": "",
"wf_activity": "",
"sys_domain_path": "/",
"cmdb_ci": {
"link": "https://instance.servicenow.com/api/now/table/cmdb_ci/a9c0c8d2c6112276018f7705562f9cb0",
"value": "a9c0c8d2c6112276018f7705562f9cb0"
},
"opened_by": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7",
"value": "46c6f9efa9fe198101ddf5eed9adf6e7"
},
"subcategory": "",
"rejection_goto": "",
"sys_class_name": "incident",
"watch_list": "",
"time_worked": "",
"contact_type": "phone",
"escalation": "0",
"comments": ""
}
}
テーブル - 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 | 指定されたレコードがあるテーブルの名前。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| sysparm_display_value | 返されるデータ (データベースからの実際の値またはフィールドの表示値) のタイプを決定します。表示値は、データベース内の実際の値と、ユーザーやシステムの設定と環境設定に基づいて操作されます。 表示値を返す場合、返される値はフィールドタイプに依存します。
データタイプ:文字列 有効な値:
デフォルト値:false 注: このパラメーター設定に推奨方法はありません。ただし、表示値を指定すると、データベースから直接読み取られず、その他のフィールドやレコードを参照することがあるため、パフォーマンスに問題が発生する可能性があります。表示値と実際の値の詳細については、「テーブル API FAQ (KB0534905)」を参照してください。 |
| sysparm_fields | 応答で返すカンマで区切られたフィールドのリストです。 データタイプ:文字列 |
| sysparm_input_display_value | 表示値または実際の値を使用してフィールド値を設定するかを示すフラグ。さまざまなフィールドタイプに応じて、エンドポイントは、渡された表示値を処理して適正値をデータベースに格納します。たとえば参照フィールドの表示名を送信すると、エンドポイントはその値の sys_id をデータベースに格納します。日付と時刻のフィールドの場合、このパラメーターが true であると、日付と時刻の値は現在のユーザーのタイムゾーンに合わせて調整されます。false の場合、日付と時刻の値は GMT タイムゾーンを使用して挿入されます。 有効な値:
データタイプ:ブール デフォルト値:false。これは、データ検索 (GET メソッド) 中に返されるデータタイプ (実際の値) と一致します。 注: 暗号化されたフィールドの値を設定するには、このパラメーターを true に設定する必要があります。このパラメーターを true に設定しない場合、暗号化されたフィールドに送信される値は保存されません。さらに、要求側ユーザーは、適切な暗号化コンテキストがある状態で要求を送信する必要があります。暗号化されたフィールドは、適切な暗号化コンテキストがないユーザーには表示されません。フィールド暗号化の詳細については、「 Column Level Encryption」を参照してください。 |
| sysparm_query_no_domain | ログインユーザーが設定されているドメインだけにレコード検索を制限するかどうかを示すフラグ。 有効な値:
データタイプ:ブール デフォルト値:false 注: sysparm_query_no_domain パラメーターは、システム管理者または、query_no_domain_table_api ロールを持つユーザーのみが利用できるパラメーターです。 |
| sysparm_view | データをレンダリングする UI ビュー。応答で返されるフィールドを指定します。 有効な値:
sysparm_fields パラメーターが優先されます (指定した場合)。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| 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 要求
インシデントテーブルのレコードを更新します。
curl "https://instance.servicenow.com/api/now/table/incident/ef43c6d40a0a0b5700c77f9bf387afe3" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'assigned_to':'681b365ec0a80164000fb0b05854a0cd','urgency':'1','comments':'Elevating urgency, this is a blocking issue'}" \
--user 'username':'password'
応答には、更新されたレコードの名前と値のペアが含まれます。
{
"result": {
"upon_approval": "proceed",
"location": {
"link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f",
"value": "108752c8c611227501d4ab0e392ba97f"
},
"expected_start": "",
"reopen_count": "",
"close_notes": "",
"additional_assignee_list": "",
"impact": "1",
"urgency": "1",
"correlation_id": "",
"sys_tags": "",
"sys_domain": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"description": "",
"group_list": "",
"priority": "1",
"delivery_plan": "",
"sys_mod_count": "7",
"work_notes_list": "",
"business_service": "",
"follow_up": "",
"closed_at": "",
"sla_due": "2017-07-05 05:58:24",
"delivery_task": "",
"sys_updated_on": "2016-01-22 14:12:37",
"parent": "",
"work_end": "",
"number": "INC0000050",
"closed_by": "",
"work_start": "",
"calendar_stc": "",
"category": "hardware",
"business_duration": "",
"incident_state": "2",
"activity_due": "2016-01-22 16:12:37",
"correlation_display": "",
"company": {
"link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec",
"value": "31bea3d53790200044e0bfc8bcbe5dec"
},
"active": "true",
"due_date": "",
"assignment_group": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3",
"value": "8a5055c9c61122780043563ef53438e3"
},
"caller_id": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c",
"value": "5b7c200d0a640069006b3845b5d0fa7c"
},
"knowledge": "false",
"made_sla": "true",
"comments_and_work_notes": "",
"parent_incident": "",
"state": "2",
"user_input": "",
"sys_created_on": "2015-11-02 18:05:40",
"approval_set": "",
"reassignment_count": "0",
"rfc": "",
"child_incidents": "",
"opened_at": "2015-11-02 21:58:24",
"short_description": "Can't access Exchange server - is it down?",
"order": "",
"sys_updated_by": "admin",
"resolved_by": "",
"notify": "1",
"upon_reject": "cancel",
"approval_history": "",
"problem_id": "",
"work_notes": "",
"calendar_duration": "",
"close_code": "",
"sys_id": "ef43c6d40a0a0b5700c77f9bf387afe3",
"approval": "not requested",
"caused_by": "",
"severity": "3",
"sys_created_by": "glide.maint",
"resolved_at": "",
"assigned_to": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd",
"value": "681b365ec0a80164000fb0b05854a0cd"
},
"business_stc": "",
"wf_activity": "",
"sys_domain_path": "/",
"cmdb_ci": {
"link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6",
"value": "281190e3c0a8000b003f593aa3f20ca6"
},
"opened_by": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
"value": "glide.maint"
},
"subcategory": "",
"rejection_goto": "",
"sys_class_name": "incident",
"watch_list": "",
"time_worked": "",
"contact_type": "phone",
"escalation": "3",
"comments": ""
}
}
テーブル - POST /now/table/{tableName}
指定されたテーブルに 1 つのレコードを挿入します。このメソッドでは、複数のレコードの挿入はサポートされていません。
URL 形式
バージョニングされた URL:/api/now/{api_version}/table/{tableName}
デフォルトの URL:/api/now/table/{tableName}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| tableName | レコードを保存するテーブルの名前。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| sysparm_display_value | 返されるデータ (データベースからの実際の値またはフィールドの表示値) のタイプを決定します。表示値は、データベース内の実際の値と、ユーザーやシステムの設定と環境設定に基づいて操作されます。 表示値を返す場合、返される値はフィールドタイプに依存します。
データタイプ:文字列 有効な値:
デフォルト値:false 注: このパラメーター設定に推奨方法はありません。ただし、表示値を指定すると、データベースから直接読み取られず、その他のフィールドやレコードを参照することがあるため、パフォーマンスに問題が発生する可能性があります。表示値と実際の値の詳細については、「テーブル API FAQ (KB0534905)」を参照してください。 |
| sysparm_exclude_reference_link | 参照フィールドのテーブル API リンクを除外するかどうかを示すフラグ。 有効な値:
データタイプ:ブール デフォルト値:false |
| sysparm_fields | 応答で返すカンマで区切られたフィールドのリストです。 データタイプ:文字列 |
| sysparm_input_display_value | 表示値または実際の値を使用してフィールド値を設定するかを示すフラグ。さまざまなフィールドタイプに応じて、エンドポイントは、渡された表示値を処理して適正値をデータベースに格納します。たとえば参照フィールドの表示名を送信すると、エンドポイントはその値の sys_id をデータベースに格納します。日付と時刻のフィールドの場合、このパラメーターが true であると、日付と時刻の値は現在のユーザーのタイムゾーンに合わせて調整されます。false の場合、日付と時刻の値は GMT タイムゾーンを使用して挿入されます。 有効な値:
データタイプ:ブール デフォルト値:false。これは、データ検索 (GET メソッド) 中に返されるデータタイプ (実際の値) と一致します。 注: 暗号化されたフィールドの値を設定するには、このパラメーターを true に設定する必要があります。このパラメーターを true に設定しない場合、暗号化されたフィールドに送信される値は保存されません。さらに、要求側ユーザーは、適切な暗号化コンテキストがある状態で要求を送信する必要があります。暗号化されたフィールドは、適切な暗号化コンテキストがないユーザーには表示されません。フィールド暗号化の詳細については、「 Column Level Encryption」を参照してください。 |
| sysparm_view | データをレンダリングする UI ビュー。応答で返されるフィールドを指定します。 有効な値:
sysparm_fields パラメーターが優先されます (指定した場合)。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| name-value pairs | 指定されたレコードで定義する各パラメーターのフィールド名および関連付けられた値。 注: 指定されておらず、システムによって自動生成されないフィールドは、関連付けられたデータタイプの null 値に設定されます。レコード内のすべてのフィールドは更新できない場合があります。たとえば、「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 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 201 | 要求が正常に完了したことを示します。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 404 | 見つかりません。要求アイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| name-value pairs | 新しく作成されたレコード内のすべてのパラメーターのフィールド名と値、またはクエリパラメーターで指定されたフィールド名と値。 |
cURL 要求
新規レコードをインシデントテーブルに挿入します。
curl "https://instance.servicenow.com/api/now/table/incident" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'short_description':'Unable to connect to office wifi','assignment_group':'287ebd7da9fe198100f92cc8d1d2154e','urgency':'2','impact':'2'}" \
--user 'username':'password'
応答には、新規レコードの名前と値のペアが含まれます。
{
"result": {
"upon_approval": "proceed",
"location": "",
"expected_start": "",
"reopen_count": "0",
"close_notes": "",
"additional_assignee_list": "",
"impact": "2",
"urgency": "2",
"correlation_id": "",
"sys_tags": "",
"sys_domain": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"description": "",
"group_list": "",
"priority": "3",
"delivery_plan": "",
"sys_mod_count": "0",
"work_notes_list": "",
"business_service": "",
"follow_up": "",
"closed_at": "",
"sla_due": "",
"delivery_task": "",
"sys_updated_on": "2016-01-22 14:28:24",
"parent": "",
"work_end": "",
"number": "INC0010002",
"closed_by": "",
"work_start": "",
"calendar_stc": "",
"category": "inquiry",
"business_duration": "",
"incident_state": "1",
"activity_due": "",
"correlation_display": "",
"company": "",
"active": "true",
"due_date": "",
"assignment_group": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"caller_id": "",
"knowledge": "false",
"made_sla": "true",
"comments_and_work_notes": "",
"parent_incident": "",
"state": "1",
"user_input": "",
"sys_created_on": "2016-01-22 14:28:24",
"approval_set": "",
"reassignment_count": "0",
"rfc": "",
"child_incidents": "0",
"opened_at": "2016-01-22 14:28:24",
"short_description": "Unable to connect to office wifi",
"order": "",
"sys_updated_by": "admin",
"resolved_by": "",
"notify": "1",
"upon_reject": "cancel",
"approval_history": "",
"problem_id": "",
"work_notes": "",
"calendar_duration": "",
"close_code": "",
"sys_id": "c537bae64f411200adf9f8e18110c76e",
"approval": "not requested",
"caused_by": "",
"severity": "3",
"sys_created_by": "admin",
"resolved_at": "",
"assigned_to": "",
"business_stc": "",
"wf_activity": "",
"sys_domain_path": "/",
"cmdb_ci": "",
"opened_by": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"subcategory": "",
"rejection_goto": "",
"sys_class_name": "incident",
"watch_list": "",
"time_worked": "",
"contact_type": "phone",
"escalation": "0",
"comments": ""
}
}
テーブル - 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 | レコードがあるテーブルの名前。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| sysparm_display_value | 返されるデータ (データベースからの実際の値またはフィールドの表示値) のタイプを決定します。表示値は、データベース内の実際の値と、ユーザーやシステムの設定と環境設定に基づいて操作されます。 表示値を返す場合、返される値はフィールドタイプに依存します。
データタイプ:文字列 有効な値:
デフォルト値:false 注: このパラメーター設定に推奨方法はありません。ただし、表示値を指定すると、データベースから直接読み取られず、その他のフィールドやレコードを参照することがあるため、パフォーマンスに問題が発生する可能性があります。表示値と実際の値の詳細については、「テーブル API FAQ (KB0534905)」を参照してください。 |
| sysparm_exclude_reference_link | 参照フィールドのテーブル API リンクを除外するかどうかを示すフラグ。 有効な値:
データタイプ:ブール デフォルト値:false |
| sysparm_fields | 応答で返すカンマで区切られたフィールドのリストです。 データタイプ:文字列 |
| sysparm_input_display_value | 表示値または実際の値を使用してフィールド値を設定するかを示すフラグ。 有効な値:
データタイプ:ブール デフォルト値:false 注:
|
| sysparm_query_no_domain | ログインユーザーが設定されているドメインだけにレコード検索を制限するかどうかを示すフラグ。 有効な値:
データタイプ:ブール デフォルト値:false 注: sysparm_query_no_domain パラメーターは、システム管理者または、query_no_domain_table_api ロールを持つユーザーのみが利用できるパラメーターです。 |
| sysparm_view | データをレンダリングする UI ビュー。応答で返されるフィールドを指定します。 有効な値:
sysparm_fields パラメーターが優先されます (指定した場合)。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| 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 要求
インシデントテーブルのレコードを更新します。
curl "https://instance.servicenow.com/api/now/table/incident/ef43c6d40a0a0b5700c77f9bf387afe3" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'assigned_to':'681b365ec0a80164000fb0b05854a0cd','urgency':'1','comments':'Elevating urgency, this is a blocking issue'}" \
--user 'username':'password'
応答には、更新されたレコードの名前と値のペアが含まれます。
{
"result": {
"upon_approval": "proceed",
"location": {
"link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f",
"value": "108752c8c611227501d4ab0e392ba97f"
},
"expected_start": "",
"reopen_count": "",
"close_notes": "",
"additional_assignee_list": "",
"impact": "1",
"urgency": "1",
"correlation_id": "",
"sys_tags": "",
"sys_domain": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"description": "",
"group_list": "",
"priority": "1",
"delivery_plan": "",
"sys_mod_count": "7",
"work_notes_list": "",
"business_service": "",
"follow_up": "",
"closed_at": "",
"sla_due": "2017-07-05 05:58:24",
"delivery_task": "",
"sys_updated_on": "2016-01-22 14:12:37",
"parent": "",
"work_end": "",
"number": "INC0000050",
"closed_by": "",
"work_start": "",
"calendar_stc": "",
"category": "hardware",
"business_duration": "",
"incident_state": "2",
"activity_due": "2016-01-22 16:12:37",
"correlation_display": "",
"company": {
"link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec",
"value": "31bea3d53790200044e0bfc8bcbe5dec"
},
"active": "true",
"due_date": "",
"assignment_group": {
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3",
"value": "8a5055c9c61122780043563ef53438e3"
},
"caller_id": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c",
"value": "5b7c200d0a640069006b3845b5d0fa7c"
},
"knowledge": "false",
"made_sla": "true",
"comments_and_work_notes": "",
"parent_incident": "",
"state": "2",
"user_input": "",
"sys_created_on": "2015-11-02 18:05:40",
"approval_set": "",
"reassignment_count": "0",
"rfc": "",
"child_incidents": "",
"opened_at": "2015-11-02 21:58:24",
"short_description": "Can't access Exchange server - is it down?",
"order": "",
"sys_updated_by": "admin",
"resolved_by": "",
"notify": "1",
"upon_reject": "cancel",
"approval_history": "",
"problem_id": "",
"work_notes": "",
"calendar_duration": "",
"close_code": "",
"sys_id": "ef43c6d40a0a0b5700c77f9bf387afe3",
"approval": "not requested",
"caused_by": "",
"severity": "3",
"sys_created_by": "glide.maint",
"resolved_at": "",
"assigned_to": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd",
"value": "681b365ec0a80164000fb0b05854a0cd"
},
"business_stc": "",
"wf_activity": "",
"sys_domain_path": "/",
"cmdb_ci": {
"link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6",
"value": "281190e3c0a8000b003f593aa3f20ca6"
},
"opened_by": {
"link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
"value": "glide.maint"
},
"subcategory": "",
"rejection_goto": "",
"sys_class_name": "incident",
"watch_list": "",
"time_worked": "",
"contact_type": "phone",
"escalation": "3",
"comments": ""
}
}