カスタムAPIアクション

DocuSign APIに対して認証済みHTTPリクエストを行います。

このアクションは他のDocuSignカードと異なります。DocuSign開発者向けドキュメントを参照してください。

オプション

フィールド 定義 タイプ 必須
Request Type(リクエストタイプ) これはカスタムAPI呼び出しでサポートされる以下のいずれかのHTTPリクエストメソッド、つまりHTTP動詞です(「HTTPリクエストメソッド」を参照)。
  • GET:パラメーターに基づいてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。
  • POST:パラメーターに基づいてWebサーバーにデータを送信します(ファイルのアップロードなど)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信することを避けるために注意する必要があります。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。
  • PUT:パラメーターに基づいて、Webサーバーの特定の場所に格納するデータを送信します (ファイルのアップロードなど)。POSTリクエストとは異なり、PUTリクエストは冪等です。リクエストが成功なら、同じPUTリクエストを何回実行しても、1回実行したときと同じ結果になります。リクエストが成功した場合、200 (OK)201 (Created)、または204 (No Content)レスポンスメッセージを受信します。
  • PATCH:パラメーターに基づいてWebサーバー上のリソースに部分的な変更を適用します。PATCHは冪等ではありません。複数のPATCHリクエストによって意図しない結果が生じる可能性があります。PATCHが成功した場合、200 (OK)または204 (No Content)レスポンスメッセージが返されます。
  • DELETE:パラメーターに基づいてWebサーバーから特定のリソース(存在する場合)を削除します。DELETEが成功した場合、200 (OK)レスポンスメッセージが返されます。
ドロップダウン TRUE
Select API(APIの選択) eSignature API管理者APIのいずれかを選択します。 ドロップダウン TRUE
Accounts(アカウント) 使用可能なDocuSignアカウントから選択します。 ドロップダウン TRUE

入力

フィールド 定義 タイプ 必須
Relative URL(相対URL)

対話を試みるWebサーバーのURLアドレス。/{version}/{insert_remaining_URL}のように相対URLを指定します。相対URLの先頭にスラッシュを使用します。

「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりすることができます。

たとえば、DocuSign APIエンドポイントがhttps://api.docusign.net/management/v2/organizationsであれば、相対URLは/organizationsとなります。

文字列 TRUE
Query(クエリ) URLで実行されるアクションを定めるJSONオブジェクト。 オブジェクトまたは文字列 FALSE
ヘッダー リクエストのコンテンツタイプを定めるJSONオブジェクト。これは通常、以下の例の複製です。 オブジェクト FALSE

出力

フィールド 定義 タイプ
Response (レスポンス)
Status Code(ステータスコード) 操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例:
  • 201 Createdステータスコードは、アクションが成功し、新しいリソースが作成されたことを示します。
  • 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。

数値
ヘッダー 出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。 オブジェクト
本文 選択したHTTPリクエストから返されたデータ。

たとえば、GETリクエストからのデータ。

オブジェクト

関連項目

DocuSignコネクター

Workflows要素

DocuSign開発者向けドキュメント