9.2. Red Hat Developer Hub でサポートされている ServiceNow カスタムアクション
ServiceNow カスタムアクションを使用すると、Red Hat Developer Hub でレコードを管理できます。カスタムアクションは、API 要求で次の HTTP メソッドをサポートします。
-
GET: 指定したリソースのエンドポイントから指定した情報を取得する -
POST: リソースを作成または更新する -
PUT: リソースを変更する -
PATCH: リソースを更新する DELETE: リソースを削除する- [GET] servicenow:now:table:retrieveRecord
Developer Hub のテーブルから指定のレコードの情報を取得します。
Expand 表9.1 入力パラメーター 名前 型 要件 説明 tableNamestring必須
レコードの取得元のテーブル名
sysIdstring必須
取得するレコードの一意の識別子
sysparmDisplayValueenum("true", "false", "all")任意
trueに設定してフィールド表示値を返すか、falseに設定して実際の値を返すか、またはその両方を返します。デフォルト値はfalseです。sysparmExcludeReferenceLinkboolean任意
参照フィールドのテーブル API リンクを除外するには、
trueに設定します。デフォルト値はfalseです。sysparmFieldsstring[]任意
レスポンスで返されるフィールドの配列
sysparmViewstring任意
指定された UI ビューに従ってレスポンスを表示します。
sysparm_fieldsを使用してこのパラメーターをオーバーライドできます。sysparmQueryNoDomainboolean任意
ドメイン間でデータにアクセスするには (許可されている場合)、
trueに設定します。デフォルト値はfalseです。Expand 表9.2 出力パラメーター 名前 型 説明 resultRecord<PropertyKey, unknown>要求のレスポンスボディー
- [GET] servicenow:now:table:retrieveRecords
Developer Hub のテーブルから複数のレコードに関する情報を取得します。
Expand 表9.3 入力パラメーター 名前 型 要件 説明 tableNamestring必須
レコードの取得元のテーブル名
sysparamQuerystring任意
結果をフィルタリングするために使用するエンコードされたクエリー文字列
sysparmDisplayValueenum("true", "false", "all")任意
trueに設定してフィールド表示値を返すか、falseに設定して実際の値を返すか、またはその両方を返します。デフォルト値はfalseです。sysparmExcludeReferenceLinkboolean任意
参照フィールドのテーブル API リンクを除外するには、
trueに設定します。デフォルト値はfalseです。sysparmSuppressPaginationHeaderboolean任意
ページネーションヘッダーを抑制するには、
trueに設定します。デフォルト値はfalseです。sysparmFieldsstring[]任意
レスポンスで返されるフィールドの配列
sysparmLimitint任意
ページごとに返される結果の最大数。デフォルト値は
10,000です。sysparmViewstring任意
指定された UI ビューに従ってレスポンスを表示します。
sysparm_fieldsを使用してこのパラメーターをオーバーライドできます。sysparmQueryCategorystring任意
クエリーに使用するクエリーカテゴリーの名前
sysparmQueryNoDomainboolean任意
ドメイン間でデータにアクセスするには (許可されている場合)、
trueに設定します。デフォルト値はfalseです。sysparmNoCountboolean任意
テーブルに対して select count (*) を実行しません。デフォルト値は
falseです。Expand 表9.4 出力パラメーター 名前 型 説明 resultRecord<PropertyKey, unknown>要求のレスポンスボディー
- [POST] servicenow:now:table:createRecord
Developer Hub のテーブルにレコードを作成します。
Expand 表9.5 入力パラメーター 名前 型 要件 説明 tableNamestring必須
レコードの保存先のテーブル名
requestBodyRecord<PropertyKey, unknown>任意
指定のレコードで定義する各パラメーターのフィールド名と関連する値
sysparmDisplayValueenum("true", "false", "all")任意
trueに設定してフィールド表示値を返すか、falseに設定して実際の値を返すか、またはその両方を返します。デフォルト値はfalseです。sysparmExcludeReferenceLinkboolean任意
参照フィールドのテーブル API リンクを除外するには、
trueに設定します。デフォルト値はfalseです。sysparmFieldsstring[]任意
レスポンスで返されるフィールドの配列
sysparmInputDisplayValueboolean任意
trueに設定して表示値を使用するか、falseに設定して実際の値を使用してフィールド値を設定します。デフォルト値はfalseです。sysparmSuppressAutoSysFieldboolean任意
システムフィールドの自動生成を抑制するには、
trueに設定します。デフォルト値はfalseです。sysparmViewstring任意
指定された UI ビューに従ってレスポンスを表示します。
sysparm_fieldsを使用してこのパラメーターをオーバーライドできます。Expand 表9.6 出力パラメーター 名前 型 説明 resultRecord<PropertyKey, unknown>要求のレスポンスボディー
- [PUT] servicenow:now:table:modifyRecord
Developer Hub のテーブルのレコードを変更します。
Expand 表9.7 入力パラメーター 名前 型 要件 説明 tableNamestring必須
レコードを変更するテーブルの名前
sysIdstring必須
変更するレコードの一意の識別子
requestBodyRecord<PropertyKey, unknown>任意
指定のレコードで定義する各パラメーターのフィールド名と関連する値
sysparmDisplayValueenum("true", "false", "all")任意
trueに設定してフィールド表示値を返すか、falseに設定して実際の値を返すか、またはその両方を返します。デフォルト値はfalseです。sysparmExcludeReferenceLinkboolean任意
参照フィールドのテーブル API リンクを除外するには、
trueに設定します。デフォルト値はfalseです。sysparmFieldsstring[]任意
レスポンスで返されるフィールドの配列
sysparmInputDisplayValueboolean任意
trueに設定して表示値を使用するか、falseに設定して実際の値を使用してフィールド値を設定します。デフォルト値はfalseです。sysparmSuppressAutoSysFieldboolean任意
システムフィールドの自動生成を抑制するには、
trueに設定します。デフォルト値はfalseです。sysparmViewstring任意
指定された UI ビューに従ってレスポンスを表示します。
sysparm_fieldsを使用してこのパラメーターをオーバーライドできます。sysparmQueryNoDomainboolean任意
ドメイン間でデータにアクセスするには (許可されている場合)、
trueに設定します。デフォルト値はfalseです。Expand 表9.8 出力パラメーター 名前 型 説明 resultRecord<PropertyKey, unknown>要求のレスポンスボディー
- [PATCH] servicenow:now:table:updateRecord
Developer Hub のテーブルのレコードを更新します。
Expand 表9.9 入力パラメーター 名前 型 要件 説明 tableNamestring必須
レコードを更新するテーブルの名前
sysIdstring必須
更新するレコードの一意の識別子
requestBodyRecord<PropertyKey, unknown>任意
指定のレコードで定義する各パラメーターのフィールド名と関連する値
sysparmDisplayValueenum("true", "false", "all")任意
trueに設定してフィールド表示値を返すか、falseに設定して実際の値を返すか、またはその両方を返します。デフォルト値はfalseです。sysparmExcludeReferenceLinkboolean任意
参照フィールドのテーブル API リンクを除外するには、
trueに設定します。デフォルト値はfalseです。sysparmFieldsstring[]任意
レスポンスで返されるフィールドの配列
sysparmInputDisplayValueboolean任意
trueに設定して表示値を使用するか、falseに設定して実際の値を使用してフィールド値を設定します。デフォルト値はfalseです。sysparmSuppressAutoSysFieldboolean任意
システムフィールドの自動生成を抑制するには、
trueに設定します。デフォルト値はfalseです。sysparmViewstring任意
指定された UI ビューに従ってレスポンスを表示します。
sysparm_fieldsを使用してこのパラメーターをオーバーライドできます。sysparmQueryNoDomainboolean任意
ドメイン間でデータにアクセスするには (許可されている場合)、
trueに設定します。デフォルト値はfalseです。Expand 表9.10 出力パラメーター 名前 型 説明 resultRecord<PropertyKey, unknown>要求のレスポンスボディー
- [DELETE] servicenow:now:table:deleteRecord
Developer Hub のテーブルからレコードを削除します。
Expand 表9.11 入力パラメーター 名前 型 要件 説明 tableNamestring必須
レコードを削除するテーブルの名前
sysIdstring必須
削除するレコードの一意の識別子
sysparmQueryNoDomainboolean任意
ドメイン間でデータにアクセスするには (許可されている場合)、
trueに設定します。デフォルト値はfalseです。