8.2. Red Hat Developer Hub でサポートされている ServiceNow カスタムアクション
ServiceNow カスタムアクションを使用すると、Red Hat Developer Hub でレコードを管理できます。カスタムアクションは、API 要求で次の HTTP メソッドをサポートします。
-
GET
: 指定したリソースのエンドポイントから指定した情報を取得する -
POST
: リソースを作成または更新する -
PUT
: リソースを変更する -
PATCH
: リソースを更新する -
DELETE
: リソースを削除する
8.2.1. ServiceNow カスタムアクション
- [GET] servicenow:now:table:retrieveRecord
Developer Hub のテーブルから指定のレコードの情報を取得します。
表8.1 入力パラメーター 名前 型 要件 説明 tableName
string
必須
レコードの取得元のテーブル名
sysId
string
必須
取得するレコードの一意の識別子
sysparmDisplayValue
enum("true", "false", "all")
任意
true
に設定してフィールド表示値を返すか、false
に設定して実際の値を返すか、またはその両方を返します。デフォルト値はfalse
です。sysparmExcludeReferenceLink
boolean
任意
参照フィールドのテーブル API リンクを除外するには、
true
に設定します。デフォルト値はfalse
です。sysparmFields
string[]
任意
応答で返されるフィールドの配列
sysparmView
string
任意
指定された UI ビューに従って応答を表示します。
sysparm_fields
を使用してこのパラメーターをオーバーライドできます。sysparmQueryNoDomain
boolean
任意
ドメイン間でデータにアクセスするには (許可されている場合)、
true
に設定します。デフォルト値はfalse
です。表8.2 出力パラメーター 名前 型 説明 result
Record<PropertyKey, unknown>
要求の応答ボディー
- [GET] servicenow:now:table:retrieveRecords
Developer Hub のテーブルから複数のレコードに関する情報を取得します。
表8.3 入力パラメーター 名前 型 要件 説明 tableName
string
必須
レコードの取得元のテーブル名
sysparamQuery
string
任意
結果をフィルタリングするために使用するエンコードされたクエリー文字列
sysparmDisplayValue
enum("true", "false", "all")
任意
true
に設定してフィールド表示値を返すか、false
に設定して実際の値を返すか、またはその両方を返します。デフォルト値はfalse
です。sysparmExcludeReferenceLink
boolean
任意
参照フィールドのテーブル API リンクを除外するには、
true
に設定します。デフォルト値はfalse
です。sysparmSuppressPaginationHeader
boolean
任意
ページネーションヘッダーを抑制するには、
true
に設定します。デフォルト値はfalse
です。sysparmFields
string[]
任意
応答で返されるフィールドの配列
sysparmLimit
int
任意
ページごとに返される結果の最大数。デフォルト値は
10,000
です。sysparmView
string
任意
指定された UI ビューに従って応答を表示します。
sysparm_fields
を使用してこのパラメーターをオーバーライドできます。sysparmQueryCategory
string
任意
クエリーに使用するクエリーカテゴリーの名前
sysparmQueryNoDomain
boolean
任意
ドメイン間でデータにアクセスするには (許可されている場合)、
true
に設定します。デフォルト値はfalse
です。sysparmNoCount
boolean
任意
テーブルに対して select count (*) を実行しません。デフォルト値は
false
です。表8.4 出力パラメーター 名前 型 説明 result
Record<PropertyKey, unknown>
要求の応答ボディー
- [POST] servicenow:now:table:createRecord
Developer Hub のテーブルにレコードを作成します。
表8.5 入力パラメーター 名前 型 要件 説明 tableName
string
必須
レコードの保存先のテーブル名
requestBody
Record<PropertyKey, unknown>
任意
指定のレコードで定義する各パラメーターのフィールド名と関連する値
sysparmDisplayValue
enum("true", "false", "all")
任意
true
に設定してフィールド表示値を返すか、false
に設定して実際の値を返すか、またはその両方を返します。デフォルト値はfalse
です。sysparmExcludeReferenceLink
boolean
任意
参照フィールドのテーブル API リンクを除外するには、
true
に設定します。デフォルト値はfalse
です。sysparmFields
string[]
任意
応答で返されるフィールドの配列
sysparmInputDisplayValue
boolean
任意
true
に設定して表示値を使用するか、false
に設定して実際の値を使用してフィールド値を設定します。デフォルト値はfalse
です。sysparmSuppressAutoSysField
boolean
任意
システムフィールドの自動生成を抑制するには、
true
に設定します。デフォルト値はfalse
です。sysparmView
string
任意
指定された UI ビューに従って応答を表示します。
sysparm_fields
を使用してこのパラメーターをオーバーライドできます。表8.6 出力パラメーター 名前 型 説明 result
Record<PropertyKey, unknown>
要求の応答ボディー
- [PUT] servicenow:now:table:modifyRecord
Developer Hub のテーブルのレコードを変更します。
表8.7 入力パラメーター 名前 型 要件 説明 tableName
string
必須
レコードを変更するテーブルの名前
sysId
string
必須
変更するレコードの一意の識別子
requestBody
Record<PropertyKey, unknown>
任意
指定のレコードで定義する各パラメーターのフィールド名と関連する値
sysparmDisplayValue
enum("true", "false", "all")
任意
true
に設定してフィールド表示値を返すか、false
に設定して実際の値を返すか、またはその両方を返します。デフォルト値はfalse
です。sysparmExcludeReferenceLink
boolean
任意
参照フィールドのテーブル API リンクを除外するには、
true
に設定します。デフォルト値はfalse
です。sysparmFields
string[]
任意
応答で返されるフィールドの配列
sysparmInputDisplayValue
boolean
任意
true
に設定して表示値を使用するか、false
に設定して実際の値を使用してフィールド値を設定します。デフォルト値はfalse
です。sysparmSuppressAutoSysField
boolean
任意
システムフィールドの自動生成を抑制するには、
true
に設定します。デフォルト値はfalse
です。sysparmView
string
任意
指定された UI ビューに従って応答を表示します。
sysparm_fields
を使用してこのパラメーターをオーバーライドできます。sysparmQueryNoDomain
boolean
任意
ドメイン間でデータにアクセスするには (許可されている場合)、
true
に設定します。デフォルト値はfalse
です。表8.8 出力パラメーター 名前 型 説明 result
Record<PropertyKey, unknown>
要求の応答ボディー
- [PATCH] servicenow:now:table:updateRecord
Developer Hub のテーブルのレコードを更新します。
表8.9 入力パラメーター 名前 型 要件 説明 tableName
string
必須
レコードを更新するテーブルの名前
sysId
string
必須
更新するレコードの一意の識別子
requestBody
Record<PropertyKey, unknown>
任意
指定のレコードで定義する各パラメーターのフィールド名と関連する値
sysparmDisplayValue
enum("true", "false", "all")
任意
true
に設定してフィールド表示値を返すか、false
に設定して実際の値を返すか、またはその両方を返します。デフォルト値はfalse
です。sysparmExcludeReferenceLink
boolean
任意
参照フィールドのテーブル API リンクを除外するには、
true
に設定します。デフォルト値はfalse
です。sysparmFields
string[]
任意
応答で返されるフィールドの配列
sysparmInputDisplayValue
boolean
任意
true
に設定して表示値を使用するか、false
に設定して実際の値を使用してフィールド値を設定します。デフォルト値はfalse
です。sysparmSuppressAutoSysField
boolean
任意
システムフィールドの自動生成を抑制するには、
true
に設定します。デフォルト値はfalse
です。sysparmView
string
任意
指定された UI ビューに従って応答を表示します。
sysparm_fields
を使用してこのパラメーターをオーバーライドできます。sysparmQueryNoDomain
boolean
任意
ドメイン間でデータにアクセスするには (許可されている場合)、
true
に設定します。デフォルト値はfalse
です。表8.10 出力パラメーター 名前 型 説明 result
Record<PropertyKey, unknown>
要求の応答ボディー
- [DELETE] servicenow:now:table:deleteRecord
Developer Hub のテーブルからレコードを削除します。
表8.11 入力パラメーター 名前 型 要件 説明 tableName
string
必須
レコードを削除するテーブルの名前
sysId
string
必須
削除するレコードの一意の識別子
sysparmQueryNoDomain
boolean
任意
ドメイン間でデータにアクセスするには (許可されている場合)、
true
に設定します。デフォルト値はfalse
です。