Custom API Action(カスタムAPIアクション)
ServiceNow REST APIに対してカスタムの認証済みHTTP呼び出しを行います。使用可能な処理の詳細については、「ServiceNow APIリファレンス」を参照してください。
オプション
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
リクエストタイプ |
カスタムAPI呼び出しでサポートされているHTTPリクエストメソッド、つまりHTTP動詞を以下に示します(「HTTPリクエストメソッド」を参照)。
|
ドロップダウン | TRUE |
GETリクエストに対して返されるレコードの最大数はsysparm_limit
によって設定されます。sysparm_limit
の例については、「テーブルAPI GET」を参照してください。警告:異常に大きなsysparm_limit
値はシステムパフォーマンスに影響を及ぼす可能性があります。
入力
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Relative URL(相対URL) |
対話を試みるWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。「?」を使用して相対URL内にクエリパラメータを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメータを指定したりすることができます。 たとえば、ServiceNow APIエンドポイントがhttps://myservicenow11456.service-now.com/api/now/table/taskであれば、相対URLは/api/now/table/taskとなります。 |
文字列 | TRUE |
Query(クエリ) |
URLで実行されるアクションを定めるJSONオブジェクト。
例:{"name":"something-urgent"} |
オブジェクトまたは文字列 | FALSE |
Headers(ヘッダー) |
リクエストのコンテンツタイプを定めるJSONオブジェクト。通常、次のようになります。
例:{"Content-type":"application/json"} |
オブジェクト | FALSE |
出力
フィールド | 定義 | タイプ |
---|---|---|
Response (レスポンス) | ||
ステータスコード | 操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例:
発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。 |
数値 |
ヘッダー | 出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。 | オブジェクト |
本文 |
選択したHTTPリクエストから返されたデータ。 たとえば、GETリクエストからのデータ。 |
オブジェクト |