Docusign Connector 1.0 リファレンス - Mule 4
|
可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。 |
DocuSign 用 Anypoint Connector (DocuSign Connector) を使用すると、DocuSign プラットフォームにアクセスして、DocuSign eSignature API v2.1 によって提供される操作を公開できます。 詳細は、 DocuSign API リファレンスサイト
を参照してください。
| このコネクタでは [Envelope Id (エンベロープ ID)] や [Document Id (ドキュメント ID)] などの特定の項目の検証が実行されないため、これらの項目の入力値を API に送信してコネクタの操作およびソースを呼び出す前に検証する必要があります。たとえば、「Validation Module の Matches regex 操作」を使用して、これらの項目の入力値を検証できます。これらの項目の入力値を検証しない場合、パストラバース攻撃を受ける可能性があります。 |
設定
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Name (名前) |
String (文字列) |
この設定の名前。コネクタはこの名前の設定を参照します。 |
x |
|
Connection (接続) |
この設定に指定する接続型。 |
x |
||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
1 |
|
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
MINUTES (分) |
|
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
ストリーミングを使用して要求を送信するかどうか。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
AUTO |
|
Name (名前) |
String (文字列) |
他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。 |
x |
|
Expiration Policy (有効期限ポリシー) |
動的設定インスタンスがアイドル状態を続けられる最小時間。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。 |
接続種別
認証接続プロバイダー (暗黙的許可)
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Default Headers (デフォルトヘッダー) |
||||
Query Parameters (クエリパラメーター) |
||||
Connection Timeout (接続タイムアウト) |
Number (数値) |
リモートサービスへの接続を確立するためのタイムアウト |
30 |
|
Connection Timeout Unit (接続タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Connection Timeou (接続タイムアウト)] 項目の時間単位。 |
SECONDS (秒) |
|
Use Persistent Connections (永続接続を使用) |
Boolean (ブール) |
false の場合、各接続は最初の要求が完了すると終了します。 |
true |
|
Max Connections (最大接続数) |
Number (数値) |
同時に開いておくことができるアウトバウンド接続の最大数。 |
-1 |
|
Connection Idle Timeout (接続アイドルタイムアウト) |
Number (数値) |
接続が終了するまでのアイドル状態を維持できる時間のタイムアウト。 |
30 |
|
Connection Idle Timeout Unit (接続アイドルタイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Connection Idle Timeout (接続アイドルタイムアウト)] 項目の時間単位。 |
SECONDS (秒) |
|
Proxy Config (プロキシ設定) |
プロキシ経由のアウトバウンド接続の再利用可能な設定要素。 |
|||
Stream Response (応答のストリーミング) |
Boolean (ブール) |
受信した応答ストリーミングするかどうか。 |
false |
|
Response Buffer Size (応答バッファサイズ) |
Number (数値) |
HTTP 応答が保存されるバッファの領域 (バイト)。 |
-1 |
|
Base Uri (ベース URI) |
String (文字列) |
各インスタンスまたはテナントのパラメーターベース URI。DocuSign アプリケーションで、[設定] > [アプリとキー] > [アカウント情報] に移動し、アカウントのベース URI を見つけて、 |
|
|
Authorization (認証) |
String (文字列) |
ユーザーが |
||
TLS Configuration (TLS 設定) |
||||
Reconnection (再接続) |
アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。 |
OAuth 接続プロバイダー (認証コード許可)
OAuth 2.0 を使用して、ユーザーアカウントをホストするサービスにユーザー認証を委任します。詳細は、「コネクタの OAuth 2.0 の設定」または「CloudHub でのコネクタの OAuth 2.0 の設定」を参照してください。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Default Headers (デフォルトヘッダー) |
||||
Query Parameters (クエリパラメーター) |
||||
Connection Timeout (接続タイムアウト) |
Number (数値) |
リモートサービスへの接続を確立するためのタイムアウト。 |
30 |
|
Connection Timeout Unit (接続タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Connection Timeou (接続タイムアウト)] 項目の時間単位。 |
SECONDS (秒) |
|
Use Persistent Connections (永続接続を使用) |
Boolean (ブール) |
false の場合、各接続は最初の要求が完了すると終了します。 |
true |
|
Max Connections (最大接続数) |
Number (数値) |
同時に開いておくことができるアウトバウンド接続の最大数。 |
-1 |
|
Connection Idle Timeout (接続アイドルタイムアウト) |
Number (数値) |
接続が終了するまでのアイドル状態を維持できる時間のタイムアウト。 |
30 |
|
Connection Idle Timeout Unit (接続アイドルタイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Connection Idle Timeout (接続アイドルタイムアウト)] 項目の時間単位。 |
SECONDS (秒) |
|
Proxy Config (プロキシ設定) |
プロキシ経由のアウトバウンド接続の再利用可能な設定要素。 |
|||
Stream Response (応答のストリーミング) |
Boolean (ブール) |
受信応答をストリーミングする必要があるかどうか。 |
false |
|
Response Buffer Size (応答バッファサイズ) |
Number (数値) |
HTTP 応答が保存されるバッファの領域 (バイト)。 |
-1 |
|
Base Uri (ベース URI) |
String (文字列) |
各インスタンスまたはテナントのパラメーターベース URI。 |
|
|
TLS Configuration (TLS 設定) |
||||
Reconnection (再接続) |
アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。 |
|||
Consumer Key (コンシューマーキー) |
String (文字列) |
サービスプロバイダーに登録されている OAuth コンシューマーキー。 |
x |
|
Consumer Secret (コンシューマーシークレット) |
String (文字列) |
サービスプロバイダーに登録されている OAuth コンシューマーシークレット。 |
x |
|
Authorization Url (認証 URL) |
String (文字列) |
サービスプロバイダーの認証エンドポイント URL。 |
|
|
Access Token Url (アクセストークン URL) |
String (文字列) |
サービスプロバイダーのアクセストークンエンドポイント URL。 |
|
|
Scopes (スコープ) |
String (文字列) |
OAuth ダンス時に要求される OAuth スコープ。指定しない場合、デフォルトのアノテーションのスコープになります。 |
signature (署名) |
|
Resource Owner Id (リソースオーナー ID) |
String (文字列) |
他に参照されていない場合に各コンポーネントで使用するリソースオーナー ID。 |
||
Before (前) |
String (文字列) |
OAuth ダンスを開始する直前に実行するフローの名前。 |
||
After (後) |
String (文字列) |
アクセストークンが受信された直後に実行するフローの名前。 |
||
リスナー設定 |
String (文字列) |
アクセストークンコールバックエンドポイントを受信するリスナーの作成に使用する HTTP 設定を参照します。 |
x |
|
Callback Path (コールバックパス) |
String (文字列) |
アクセストークンコールバックエンドポイントのパス。 |
x |
|
Authorize Path (認証パス) |
String (文字列) |
OAuth ダンスをトリガーするローカル HTTP エンドポイントのパス。 |
x |
|
External Callback Url (外部コールバック URL) |
String (文字列) |
コールバックエンドポイントがプロキシの背後にあるか、間接 URL でアクセスする場合にコールバックエンドポイントにアクセスするために OAuth プロバイダーで使用する URL。 |
||
Object Store (オブジェクトストア) |
String (文字列) |
各リソースオーナーのデータを保存するオブジェクトストアを設定します。設定されていない場合、Mule ではデフォルトのオブジェクトストアが使用されます。 |
操作のリスト
-
Responsive Html Post Template Document Responsive Html Preview
-
Envelope Workflow Definition Delete Envelope Workflow Definition
-
Envelope Workflow Definition Delete Template Workflow Definition
-
Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id
-
Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id Lang Code
-
Envelope Workflow Definition Get Envelope Workflow Definition
-
Account Identity Verification Get Account Identity Verification
-
Envelope Purge Configuration Get Envelope Purge Configuration
-
Envelope Workflow Definition Get Template Workflow Definition
-
Envelope Workflow Definition Put Envelope Workflow Definition
-
Envelope Purge Configuration Put Envelope Purge Configuration
-
Envelope Workflow Definition Put Template Workflow Definition
On Envelope Status Change Trigger
<docusign:on-envelope-status-change-trigger>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID) |
x |
|
From Date (開始日) |
String (文字列) |
要求でアカウントのエンベロープの状況の変更のチェックがいつ開始されるのかを指定する日時設定。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Primary Node Only (プライマリノードのみ) |
Boolean (ブール) |
クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。 |
||
Scheduling Strategy (スケジュール戦略) |
scheduling-strategy |
ポーリングをトリガーするスケジューラーを設定します。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Redelivery Policy (再配信ポリシー) |
同じメッセージの再配信を処理するためのポリシー。 |
|||
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
操作
Accounts Post Accounts
<docusign:create-v21-accounts>
新しい DocuSign アカウントを作成します。このメソッドを使用して、一度に 1 ～ 100 個のアカウントを作成できます。
注意: このメソッドは、パートナーインテグレーションに制限されます。リクエストボディに含める必要があるディストリビューターコードとディストリビューターパスワードを提供する DocuSign プロフェッショナルサービスまたは DocuSign ビジネス開発と連携する必要があります。X-DocuSign-Authentication ヘッダーを含める必要があります (例: {{integratorKey}})。
1 つのアカウントを作成する場合、リクエストボディは [newAccountRequest] オブジェクトになります。例:
{
"newAccountRequest": [
{
"accountName": "Test Account",
"distributorCode": "MY_DIST_CODE",
"distributorPassword": "MY_DIST_PWD",
"initialUser": {
"email": "user@emaildomain.com",
"firstName": "John",
"middleName": "Harry",
"lastName": "Doe",
"suffixName": "",
"userName": "John Doe",
"jobTitle": "Engineer",
"company": "Test Company"
},
"addressInformation": {
"address1": "1234 Main Street",
"address2": "Suite 100",
"city": "Seattle",
"state": "WA",
"postalCode": "98101",
"country": "US",
"phone": "1234567890",
"fax": "1234567891"
},
"planInformation": {
"planId": "37085696-xxxx-xxxx-xxxx-7ea067752959"
},
"referralInformation": {
"includedSeats": "1",
"referralCode": "code",
"referrerName": "name"
}
}
]
}json要求に成功すると、201 (作成済み) HTTP 応答コードが返されます。新しく作成されたアカウントごとに、応答で新しいアカウント ID、パスワード、デフォルトのユーザー情報が返されます。
複数のアカウントを作成する場合、リクエストボディは、1 つ以上の [newAccountDefinition] オブジェクトが含まれる newAccountRequests オブジェクトになります。これにより、一度に最大 100 個の新しいアカウントを作成できます。JSON では、複数アカウント作成リクエストボディは次のようになります。
{
"newAccountRequests": [
{ "accountName": "accountone", . . . },
{ "accountName": "accounttwo", . . . }
]
}json一部のアカウントを作成できなくても、複数アカウント作成要求が成功することがあります (201 コードがレポートされる)。その場合、応答の errorDetails プロパティに、失敗に関する特定の情報が含まれます。
この操作では、/v2.1/accounts エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
コネクタが要求コンテンツをリモートサービスにストリーミングする方法を指定します。
|
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Payments Post Payment
<docusign:create-v21-accounts-billing-payments-by-account-id>
期日を過ぎた請求書に支払を転記します。このメソッドは、期日を過ぎた請求書の paymentAllowed 値が true の場合にのみ使用できます。これは、 Billing::listInvoicesPastDue をコールすることで判断できます。応答では、1 つの支払、支払のリスト、および支払 ID がエンドポイントで使用されているかどうかに関する情報が返されます。開始日や終了日のクエリまたは支払 ID が使用されていない場合、応答で過去 365 日の支払情報が返されます。1 つの支払 ID に対する要求の場合、nextUri および previousUri プロパティは返されません。
必要な権限: アカウント管理者
この操作では、/v2.1/accounts/{accountId}/billing_payments エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brands Post Brands
<docusign:create-v21-accounts-brands-by-account-id>
このメソッドは、アカウントの 1 つ以上のブランドプロファイルのファイルを作成します。ブランドプロファイルの brandId プロパティがアカウントにすでに設定されている場合、エラーが返されます。既存のブランドプロファイルの新しいバージョンをアップロードするには、プロファイルを削除してから、新しいバージョンをアップロードする必要があります。ブランドプロファイルのファイルをアップロードするには、1 つの zip ファイルに結合して、Content-Type を application/zip に設定します。
注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。
この操作では、/v2.1/accounts/{accountId}/brands エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2CRUD Post Bulk Send List
<docusign:create-v21-accounts-bulk-send-lists-by-account-id>
エンベロープを同時に最大 1,000 人の受信者に送信するために使用できる一括送信リストを作成します。次のエラーが返されます。
| エラーコード | 説明 |
|---|---|
BULK_SEND_MAX_COPIES_EXCEEDED |
一括送信リストで顧客名簿の XXX を超えるコピーを指定することはできません。設定 API エンドポイントをコールして、アカウントで許可されているバッチの最大コピー数を確認します。ほとんどの場合、デフォルトの制限は 1000 です。 |
BULK_SEND_RECIPIENT_IDS_MUST_BE_UNIQUE |
bulkCopy 内で受信者が重複することはできません。通常のエンベロープと同じ制限が適用されます。bulkCopy 内では受信者ごとに一意の受信者 ID を指定します (顧客名簿のエンベロープのモデル)。 |
BULK_SEND_RECIPIENT_ID_REQUIRED |
RoleName が存在しない場合、顧客名簿の bulkCopy で recipientID が必要になります。(テンプレート/エンベロープと結合する) roleName または recipientID を追加します。 |
BULK_SEND_RECIPIENT_NAME_REQUIRED |
受信者 {0} に名前がありません。受信者の名前を指定してください。 |
BULK_SEND_EMAIL_ADDRESS_REQUIRED_FOR_EMAIL_RECIPIENT |
受信者 {0} はメールアドレスのないメール受信者です。メール受信者のメールを指定してください。 |
BULK_SEND_FAX_NUMBER_REQUIRED_FOR_FAX_RECIPIENT |
受信者 {0} は Fax 番号のない Fax 受信者です。Fax 受信者の Fax 番号を指定してください。 |
BULK_SEND_FAX_NUMBER_NOT_VALID |
受信者 {0} が指定した Fax 番号 {1} が無効です。Fax 受信者の有効な Fax 番号を指定してください。 |
BULK_SEND_EMAIL_ADDRESS_NOT_VALID |
受信者 {0} が指定したメールアドレス {1} が無効です。受信者の有効なメールアドレスを指定してください。 |
BULK_SEND_PHONE_NUMBER_REQURED_FOR_SMS_AUTH |
受信者 {0} が SMS 認証を指定しましたが、番号が指定されていません。SMS 認証受信者の電話番号を指定してください。 |
BULK_SEND_PHONE_NUMBER_INVALID_FOR_SMS_AUTH |
受信者 {0} が指定した SMS 認証の電話番号 {1} が無効です。SMS 認証受信者の有効な電話番号を指定してください。 |
BULK_SEND_ROLE_NAMES_MUST_BE_UNIQUE |
受信者のロール名は重複できません。ロール {duplicateRecipientRole} が複数回出現しています。受信者の一意の roleNames を使用してください。 |
BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_ON_SAME_RECIPIENT |
受信者に ID とロールの両方を設定することはできません。{0} には両方が設定されています。同じ受信者には roleName と recipientId の両方ではなくいずれかを指定してください。 |
BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_IN_SAME_LIST |
同じリストで受信者ロールと受信者 ID の両方を使用することはできません。同じリストでは roleName と recipientId の両方ではなくいずれかを指定してください。 |
BULK_SEND_INVALID_ID_CHECK_CONFIGURATION |
受信者 {0} が SMS 認証を指定しましたが、SMS 認証設定が指定されていません。SMS 認証が指定されている場合は、SMS 認証設定 (適切な ID 設定) を指定してください。 |
BULK_SEND_INVALID_SBS_INPUT_CONFIGURATION |
受信者 {0} に複数の署名プロバイダーが指定されているか、signingProviderName が指定されていないか、署名プロバイダー {0} が不明またはこのアカウントで使用できないか、1 つ以上の SBS 設定が欠落しているか、無効です。エラーの詳細には、詳しい情報が記載されています。 |
BULK_SEND_TAB_LABELS_MUST_BE_UNIQUE |
タブの表示ラベル {0} が重複しています。一意である必要があります。一意のタブの表示ラベルを使用してください。 |
BULK_SEND_TAB_LABEL_REQUIRED |
タブの表示ラベルは必須です。タブの表示ラベルを指定してください。 |
BULK_SEND_TAB_VALUE_REQUIRED |
タブの表示ラベルの値は必須です。タブの表示ラベルの値を指定してください。 |
BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_MUST_BE_UNIQUE |
カスタム項目には個別の名前を使用する必要があります。項目 {0} がコピーに複数回出現します。カスタム項目の一意の名前を使用してください。 |
BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_REQUIRED |
すべてのカスタム項目に名前が必要です。カスタム項目の名雨を指定してください。 |
BULK_SEND_ENVELOPE_CUSTOM_FIELD_VALUE_REQUIRED |
カスタム項目 {0} に値がありません。カスタム項目に空の値は設定できますが、null 値は設定できません。カスタム項目の値を指定してください。 |
この操作では、/v2.1/accounts/{accountId}/bulk_send_lists エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
アカウントの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2Send Post Bulk Send Request
<docusign:create-v21-accounts-bulk-send-lists-send-by-account-id-bulk-send-list-id>
一括送信プロセスを開始します。既存の一括送信リストおよびエンベロープまたはテンプレートに基づいて一括送信要求を生成します。送信するエンベロープまたはテンプレートとの互換性を確保するために、まず、createBulkSendTestRequest メソッドを使用して一括送信リストをテストすることを検討してください。エンベロープが非同期処理のキューに正常に登録されると、バッチの状況を取得するために使用できる batchId が応答に含まれます。エラーが発生すると、API でエラーメッセージが返されます。
注意: 通常、部分的な成功または失敗は発生しません。非同期処理のキューに登録されるのは、バッチ全体のみです。
このメソッドは、次のエラーを返します。
| エラーコード | 説明 |
|---|---|
BULK_SEND_ENVELOPE_NOT_IN_SENDABLE_STATE |
エンベロープ {0} が送信可能な状態ではありません。エンベロープは不完全です。送信可能な状況 ( |
BULK_SEND_ENVELOPE_LIST_CONTAINS_NO_COPIES |
コピーが含まれていない一括送信リストでは、エンベロープを送信できません。一括送信しようとしているリストが空です。使用する一括送信リストに受信者が含まれていることを確認してください。 |
BULK_SEND_ENVELOPE_LIST_CONTAINS_TOO_MANY_COPIES |
一括送信リストに {0} 個を超えるコピーが含まれています。一括送信しようとしているリストをアカウントで使用すると、すべてのアカウントに適用されるコピーの制限 (1,000 個) を超えます。個別のリストを複数送信してください。 |
BULK_SEND_ENVELOPE_CANNOT_BE_NULL |
エンベロープのない一括リストは送信できません。一括送信するエンベロープのエンベロープ ID またはテンプレート ID を指定してください。 |
BULK_SEND_BLOB_STORE_ERROR |
一括送信リストのコピーを保存できませんでした。データベースへの書き込み中にエラーが発生しました。もう一度お試しください。エラーが解決されない場合は、DocuSign サポートにお問い合わせください。 |
BULK_SEND_ACCOUNT_HAS_TOO_MANY_QUEUED_ENVELOPES |
一括送信リストを送信すると、インフライトエンベロープの最大数 ({maxCopies}) を超えるため、一括送信リストを送信できません。現在、このアカウントには、処理を待機している {unprocessedEnvelopes} エンベロープがあります。後でもう一度お試しください。 後でもう一度試すか、DocuSign に連絡して階層を上げるように要求してください。 |
BULK_SEND_ENVELOPE_NOT_FOUND |
エンベロープ {envelopeOrTemplateId} が存在していないか、このエンベロープにアクセスする権限がありません。指定された envelopeId または templateId が見つかりませんでした。有効な値を指定してください。 |
BULK_SEND_LIST_NOT_FOUND |
一括送信リスト {listId} が存在しないか、このリストにアクセスする権限がありません。指定された mailingListId が見つかりませんでした。有効な値を指定してください。 |
BULK_SEND_ENVELOPE_HAS_NO_RECIPIENTS |
一括送信のコピーには受信者が含まれていますが、指定されたエンベロープには含まれていません。エンベロープの受信者と一括送信リストが一致していません。エンベロープとリストに送信の互換性があることを確認してください。 |
BULK_SEND_RECIPIENT_ID_DOES_NOT_EXIST_IN_ENVELOPE |
受信者 {0} がエンベロープに存在しません。欠落している受信者をエンベロープに追加してください。 |
BULK_SEND_RECIPIENT_ID_DOES_NOT_MATCH |
受信者 ID {envelopeMember.ID} が一致していません。リストとエンベロープの受信者情報が一致していることを確認してください。 |
BULK_SEND_ENVELOPE_HAS_BULK_RECIPIENT |
受信者 {0} は一括受信者です。これはサポートされていません。従来の「一括受信者」は許可されていません。eSignature API の v2.1 では、一括受信者の代わりに一括送信リストを使用する必要があります。詳細は、API のドキュメントを参照してください。 |
BULK_SEND_RECIPIENT_ROLE_DOES_NOT_MATCH |
受信者ロール {envelopeMember.RoleName} が一致していません。リストとエンベロープの受信者情報に互換性があることを確認してください。 |
BULK_SEND_DUPLICATE_RECIPIENT_DETECTED |
エンベロープで受信者の一意のルーティング順序が指定されていない限り、重複する受信者 ({0}) は許可されません。 |
BULK_SEND_ENVELOPE_HAS_NO_TABS |
一括送信のコピーにはタブが含まれていますが、指定されたエンベロープには含まれていません。リストとエンベロープのタブは結合できません。これらに送信の互換性があることを確認してください。 |
BULK_SEND_TAB_LABEL_DOES_NOT_EXIST_IN_ENVELOPE |
表示ラベルが {0} のタブがエンベロープに存在しません。タブの表示ラベルをエンベロープに追加するか、リストから表示ラベルを削除するか、正しいリストとエンベロープを指定していることを確認してください。 |
BULK_SEND_TAB_DOES_NOT_MATCH |
タブ {0} がエンベロープの {0} と一致していません。一致していないリストにタブが存在するか、エンベロープにタブがありません。リストとエンベロープのタブが一致していることを確認してください。 |
BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_CUSTOM_FIELDS |
一括送信のコピーにはカスタム項目が含まれていますが、指定されたエンベロープには含まれていません。エンベロープにないカスタム項目がリストにあります。リストとエンベロープのカスタム項目が一致していることを確認してください。 |
BULK_SEND_ENVELOPE_CUSTOM_FIELD_DOES_NOT_EXIST_IN_ENVELOPE |
カスタム項目 {0} がエンベロープに存在しません。リストのカスタム項目をエンベロープに追加するか、リストからカスタム項目を削除するか、正しいリストとエンベロープを指定していることを確認してください。 |
BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_DOES_NOT_MATCH |
カスタム項目名は、一致している必要があります。{0} と {1} が一致していません。リストとエンベロープのカスタム項目名が一致していません。両方に同じ名前を使用してください。 |
この操作では、/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Bulk Send List Id (一括送信リスト ID) |
String (文字列) |
一括送信リストの GUID。このプロパティは、新しい一括送信リストを投稿した後に作成されます。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2Test Post Bulk Send Test Request
<docusign:create-v21-accounts-bulk-send-lists-test-by-account-id-bulk-send-list-id>
このメソッドは、一括送信リストをテストして、送信するエンベロープまたはテンプレートとの互換性を確認します。たとえば、3 つのロールがあるテンプレートは、2 人の受信者しかいない一括送信リストとは互換性がありません。このため、まず互換性をテストすることをお勧めします。テストに成功した場合、結果で canBeSent プロパティに true が返されます。テストに失敗した場合は、発生したエラーに関する情報が含まれる JSON 応答が返されます。テストに成功したら、BulkSendRequest メソッドを使用してエンベロープまたはテンプレートを送信できます。
エンベロープの互換性チェック
このセクションでは、システムで実行されるエンベロープの互換性チェックについて説明します。
最上位の問題
-
エンベロープは送信可能な状態になっている必要があります。
-
一括送信リストに 1 つ以上のコピー (エンベロープのインスタンス) が含まれていて、アカウントで許可されている最大コピー数を超えていない必要があります。
-
エンベロープは null ではなく、現在のユーザーが参照できる必要があります。
-
アカウントで設定された最大数を超えるエンベロープをキューに登録することはできません。
-
一括送信リストが存在している必要があります。
-
-
Recipients (受信者)
-
エンベロープには受信者が含まれている必要があります。
-
エンベロープを使用する場合、一括送信リストで定義されたすべての受信者にエンベロープ定義の対応する受信者 ID が設定されている必要があります。テンプレートを使用する場合、受信者 ID またはロール ID が一致している必要があります。
-
エンベロープには、一括受信者 (DocuSign の従来のバージョンの一括送信機能のアーティファクト) を含めることはできません。
-
-
受信者タブ
-
一括送信リストの各
recipient ID, tab label ペアは、エンベロープのタブに対応している必要があります。
-
-
カスタム項目
-
一括送信リストのエンベロープレベルの各カスタム項目は、エンベロープ定義の
customField の名前と一致している必要があります。受信者レベルのカスタム項目は、一致している必要はありません。
-
この操作では、/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Bulk Send List Id (一括送信リスト ID) |
String (文字列) |
一括送信リストの GUID。このプロパティは、新しい一括送信リストを投稿した後に作成されます。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Chunked Uploads Post Chunked Uploads
<docusign:create-v21-accounts-chunked-uploads-by-account-id>
このメソッドは、コンテンツの最初の部分で新しいチャンクに分割されたアップロードを開始します。この操作では、/v2.1/accounts/{accountId}/chunked_uploads エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Post Connect Configuration
<docusign:create-v21-accounts-connect-by-account-id>
アカウントのカスタム DocuSign Connect 定義を作成します。DocuSign Connect により、リアルタイムデータ更新を外部アプリケーションに送信できます。これらの更新は、エンベロープのアクションが完了するまでの進捗に合わせて、ユーザートランザクションで生成されます。Connect サービスは、これらのトランザクションの状況に関する更新情報を提供し、ドキュメントフォーム項目の実際のコンテンツが含まれる更新を返します。これらの更新にドキュメント自体が含まれる場合と含まれない場合があります。
注意: この関数を使用するには、アカウントで Connect が有効になっている必要があります。これを使用して、Salesforce または eOriginalConnect の Connect 設定をセットアップすることはできません。
この操作では、/v2.1/accounts/{accountId}/connect エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Contacts Post Contacts
<docusign:create-v21-accounts-contacts-by-account-id>
このメソッドは、CSV、JSON、XML ファイルから複数の新しい連絡先を連絡先リストにインポートします。このメソッドを使用するには、サポートされているいずれかの形式でリクエストボディを指定し、適切な値の content-type ヘッダーを含める必要があります。この操作では、/v2.1/accounts/{accountId}/contacts エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Custom Fields Post Account Custom Fields
<docusign:create-v21-accounts-custom-fields-by-account-id>
このメソッドは、カスタム項目を作成し、アカウントに関連付けられているすべての新しいエンベロープで使用できるようにします。この操作では、/v2.1/accounts/{accountId}/custom_fields エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Apply to templates (テンプレートに適用) |
String (文字列) |
(省略可能) true に設定すると、新しいカスタム項目がアカウントのすべてのテンプレートに適用されます。 |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelopes Post Envelopes
<docusign:create-v21-accounts-envelopes-by-account-id>
エンベロープを作成して送信したり、ドラフトエンベロープを作成したりします。エンベロープは、DocuSign プラットフォームの基本的なリソースです。このメソッドでは、次の作業を実行できます。
-
ドキュメント、受信者、タブが含まれるエンベロープを作成して送信する。
-
テンプレートからエンベロープを作成して送信する。
-
ドキュメントとテンプレートを組み合わせてエンベロープを作成して送信する。
-
ドラフトエンベロープを作成する。
このメソッドを使用して、1 つの要求でエンベロープを作成して送信する場合、リクエストボディの次のパラメーターが必要になります。
| パラメーター | 説明 |
|---|---|
|
エンベロープを受信者に送信するには、 |
|
エンベロープを送信するために使用される件名。 |
|
署名される [documents][]。 |
|
エンベロープ受信者のメールアドレス。 |
注意: エンベロープにワークフロー定義があり、workflowStatus が paused の場合、status が sent であってもエンベロープはすぐに送信されません。エンベロープの使用方法は数多く存在します。1 つの API 要求でエンベロープを作成して送信することも、複数の API 要求でエンベロープを作成、入力、送信することもできます。
この操作では、/v2.1/accounts/{accountId}/envelopes エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Cdse mode (CDSE モード) |
String (文字列) |
DocuSign 用に予約済み。 |
||
Change routing order (ルーティング順序を変更) |
String (文字列) |
true の場合、ユーザーは署名のためにドキュメントを送信するときに受信者のルーティング順序を定義できます。 |
||
Completed documents only (完了したドキュメントのみ) |
String (文字列) |
DocuSign 用に予約済み。 |
||
Merge roles on draft (ドラフトのロールをマージ) |
String (文字列) |
true に設定すると、テンプレートロールがマージされ、空の受信者は削除されます。このパラメーターは、複数のテンプレートでドラフトエンベロープを作成するときに適用されます。ドラフトエンベロープを作成するには、 |
||
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Custom Fields Post Custom Fields
<docusign:create-v21-accounts-envelopes-custom-fields-by-account-id-envelope-id>
ドラフトおよび処理中のエンベロープのカスタム項目を更新します。エンベロープに割り当てることができるカスタム項目は最大 3 つです。この制限には、アカウント (ドキュメント) のカスタム項目は含まれません。エンベロープで使用される各カスタム項目には一意の名前が必要です。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Document Fields Post Document Fields
<docusign:create-v21-accounts-envelopes-documents-fields-by-account-id-envelope-id-document-id>
既存のエンベロープドキュメントのカスタムドキュメント項目を作成します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Post Document Responsive Html Preview
<docusign:create-v21-accounts-envelopes-documents-responsive-html-preview-by-account-id-envelope-id-document-id>
特定のドキュメントの レスポンシブ HTML バージョンのプレビューを作成します。このメソッドを使用すると、送信前に各デバイス種別で PDF ドキュメントがどのようにレスポンシブ HTML に変換されるのかをプレビューできます。リクエストボディは documentHtmlDefinition オブジェクトです。このオブジェクトにあるレスポンシブ署名パラメーターで、署名ドキュメントの HTML バージョンの生成方法が定義されます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Post Document Tabs
<docusign:create-v21-accounts-envelopes-documents-tabs-by-account-id-envelope-id-document-id>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Post Document Templates
<docusign:create-v21-accounts-envelopes-documents-templates-by-account-id-envelope-id-document-id>
指定されたエンベロープのドキュメントにテンプレートを追加します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Preserve template recipient (テンプレート受信者を保持) |
String (文字列) |
Preserve template recipient (テンプレート受信者を保持) |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Email Settings Post Email Settings
<docusign:create-v21-accounts-envelopes-email-settings-by-account-id-envelope-id>
メールの上書き設定を追加します。これにより、エンベロープのメールアーカイブ情報のメールアドレス、名前、BCC に返信するメールアドレスが変更されます。メール設定の追加は、追加後に発生したメールコミュニケーションにのみ影響します。
BCC メールアドレス機能は、外部アーカイブのためにすべてのメールコミュニケーションのコピーを提供するように設計されています。DocuSign では、メールアーカイブ用の BCC 機能を使用して送信されたエンベロープ (BCC メール上書きオプションを含む) に署名者認証オプションを追加することが推奨されています。署名が不要な受信者にエンベロープのコピーを送信するには、[Carbon Copy (カーボンコピー)] または [Certified Delivery (署名済み配信)] 受信者種別を使用します。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Lock Post Envelope Lock
<docusign:create-v21-accounts-envelopes-lock-by-account-id-envelope-id>
このメソッドは、指定されたエンベロープをロックしてその有効期限を設定し、他のユーザーまたは受信者がエンベロープを変更しないようにします。この要求への応答では、lockToken パラメーターが返されます。既存のロックを更新または削除するには、lockToken を使用する必要があります。また、ロック中にエンベロープに対して実行するすべての PUT コールのヘッダーに lockToken を含める必要があります。lockToken を含めない場合、システムから次のエラーが返されます。
{ "errorCode": "EDIT_LOCK_NOT_LOCK_OWNER", "message": "The user is not the owner of the lock. The template is locked by another user or in another application" }
注意: この関数を使用するには、ユーザーのエンベロープロック機能を有効にしておく (ユーザーの canLockEnvelopes を true にしておく) 必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Post Recipients
<docusign:create-v21-accounts-envelopes-recipients-by-account-id-envelope-id>
1 人以上の受信者をエンベロープに追加します。処理中のエンベロープ (送信されたが完了していないか無効化されているエンベロープ) の場合、ルーティング順序に達した新しい受信者にメールが送信されます。新しい受信者のルーティング順序がエンベロープの次の受信者より前か同じ場合、省略可能な resend_envelope クエリ文字列が true に設定されていないとメールが送信されません。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Resend envelope (エンベロープを再送信) |
String (文字列) |
true に設定されている場合、リクエストボディで指定した受信者にエンベロープを再送信します。元のメール通知を削除した受信者にエンベロープを再送信するには、このパラメーターを使用します。 注意: エンベロープの修正は、別のプロセスになります。ここで入力した値に関係なく、エンベロープを修正すると必ず DocuSign からエンベロープが再送信されます。 |
||
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Post Recipient Proof File Resource Token
<docusign:create-v21-accounts-envelopes-recipients-identity-proof-token-by-account-id-envelope-id-recipient-id>
送信者のリソーストークンを作成します。このトークンにより、送信者は ID 証拠 API を使用して受信者の ID データを返すことができます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
アカウント ID。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
|
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Post Recipient Tabs
<docusign:create-v21-accounts-envelopes-recipients-tabs-by-account-id-envelope-id-recipient-id>
受信者の 1 つ以上のタブを追加します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Post Responsive Html Preview
<docusign:create-v21-accounts-envelopes-responsive-html-preview-by-account-id-envelope-id>
エンベロープのすべてのドキュメントの レスポンシブ HTML バージョンのプレビューを作成します。このメソッドを使用すると、送信前に各デバイス種別で PDF ドキュメントがどのようにレスポンシブ HTML に変換されるのかをプレビューできます。リクエストボディは documentHtmlDefinition オブジェクトです。このオブジェクトにあるレスポンシブ署名パラメーターで、ドキュメントの HTML バージョンの生成方法が定義されます。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Post Envelope Templates
<docusign:create-v21-accounts-envelopes-templates-by-account-id-envelope-id>
指定されたエンベロープにテンプレートを追加します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Preserve template recipient (テンプレート受信者を保持) |
String (文字列) |
Preserve template recipient (テンプレート受信者を保持) |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Transfer Rules Post Envelope Transfer Rules
<docusign:create-v21-accounts-envelopes-transfer-rules-by-account-id>
エンベロープ転送ルールを作成します。エンベロープ転送ルールを作成するときに、次のプロパティを指定します。
-
eventType -
fromGroups -
toUser -
toFolder -
carbonCopyOriginalOwner -
enabled
注意: エンベロープ転送ルールは、システム管理者のみが作成できます。また、エンベロープ転送ルールを使用するには、アカウントで [Transfer Custody (転送の管理)] 機能が有効になっている必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/transfer_rules エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Correct View
<docusign:create-v21-accounts-envelopes-views-correct-by-account-id-envelope-id>
アプリケーションに DocuSign UI のエンベロープ修正ビューを埋め込むことができる URL を返します。 重要: 画面スペースの問題のため、モバイルデバイスでは埋め込み操作に iFrame を使用しないでください。DocuSign では、iOS デバイスに WebView を使用することが推奨されています。
注意: この URL は、同じ URL に対してリクエストボディなしで DELETE コールを実行して取り消すことができます。情報セキュリティ通知: このメソッドでは、送信アカウントへのフルアクセスが提供されます。このビューを使用する場合、現在のユーザーにアカウントへのフルアクセスが付与されます。アカウントに管理者権限があると、このメソッドでも管理者アクセス権が提供されます。送信前に送信者がドラフトエンベロープの更新や他の変更を実行できるようにする必要があるユースケースの場合、次のいずれかの手順を実行します。
-
この API メソッドを使用するための個別のユーザーアカウントを送信者ごとに設定する。
-
このメソッドが必要なくなるように API インテグレーションを強化する。インテグレーションでは、必要に応じてタブ、受信者、およびその他のエンベロープ設定を作成できます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Edit View
<docusign:create-v21-accounts-envelopes-views-edit-by-account-id-envelope-id>
アプリケーションに DocuSign UI の編集ビューを埋め込むことができる URL を返します。これは、ユーザーを DocuSign 編集ビューに配置できるようにする 1 回限りのログイントークンです。送信が完了すると、ユーザーは API アプリケーションによって提供される戻り URL に戻ります。
画面スペースの問題のため、モバイルデバイスでは埋め込み操作に iFrame を使用しないでください。DocuSign では、iOS デバイスに WebView を使用することが推奨されています。
この URL は、同じ URL に対してリクエストボディなしで DELETE コールを実行して取り消すことができます。
情報セキュリティ通知: このメソッドでは、送信アカウントへのフルアクセスが提供されます。このビューを使用する場合、現在のユーザーにアカウントへのフルアクセスが付与されます。アカウントに管理者権限があると、このメソッドでも管理者アクセス権が提供されます。
送信前に送信者がドラフトエンベロープの更新や他の変更を実行できるようにする必要があるユースケースの場合、次のいずれかの手順を実行します。
-
この API メソッドを使用するための個別のユーザーアカウントを送信者ごとに設定する。
-
このメソッドが必要なくなるように API インテグレーションを強化する。インテグレーションでは、必要に応じてタブ、受信者、およびその他のエンベロープ設定を作成できます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Recipient View
<docusign:create-v21-accounts-envelopes-views-recipient-by-account-id-envelope-id>
アプリケーションに DocuSign UI の受信者ビューを埋め込むことができる URL を返します。受信者が署名者の場合、ビューでは署名セレモニーが提供されます。
注意: クライアントをこの URL にリダイレクトしてください。 特に、受信者がモバイルまたはタブレットを使用している場合は、iFrame を使用しないでください。このメソッドは、エンベロープの状況が sent の場合にのみ使用します。このメソッドを使用する場合、アプリケーションで受信者または署名者の ID を認証します。パラメーター assertionId、authenticationInstant、authenticationMethod、clientUserId、securityDomain を使用して、受信者がどのように認証されたのかに関する情報を記録します。最低でも、authenticationMethod と clientUserId は必要です。指定した情報は、エンベロープの完了の証明書に含まれます。
Redirect (リダイレクト)
署名者が署名セレモニーを完了または終了すると、DocuSign は、指定した returnUrl を使用してユーザーのブラウザーをアプリケーションにリダイレクトします。ユーザーは、エンベロープを送信するアカウントのリージョンに応じて、異なるサブドメインでリダイレクトされます。ドメインの許可リストを確認してください。
イベントの状況パラメーター
DocuSign は、署名セレモニーの結果を使用して、URL に event クエリパラメーターを送信します。アプリケーションは、このイベントパラメーターを使用して、エンベロープの次のステップを決定できます。Envelopes::get や類似するメソッドを使用して、エンベロープの状況をフェッチしないでください。このようなメソッドを使用すると、ポーリングに対する DocuSign ルールが破損する可能性があります。
注意: ユーザーはリダイレクトをキャンセルする可能性があるため、署名後にブラウザーを閉じるか、ランディング URL を偽装します。ReturnUrl にアクセスする以外にも、インテグレーションのエンベロープの状況を取得できるようにしておく必要があります。
期限のある URL
このメソッドで返される URL は 1 回限り有効で、生成後数分以内に使用または表示する必要があります。受信者ビューにリダイレクトされたら、受信者は DocuSign システムと定期的にやりとりする必要があります。定期的なやりとりがないと、セッションがタイムアウトします。URL には期限があるため、保存したり、メールで送信したりしないでください。受信したらすぐにユーザーのブラウザーを URL にリダイレクトします。メールで埋め込み署名セッションに招待する場合、メールの招待の URL をアプリケーションに送信する必要があります。アプリケーションは、呼び出されたときに DocuSign に recipientView URL を要求し、署名者をその URL にリダイレクトする必要があります。
状態の保持
受信者は、受信者ビュー (または署名セレモニー) を完了すると、アプリケーションにリダイレクトされます。アプリケーションは、情報を Cookie に保存するか、https://myapp.eg.com/docusign_return?myState=12345 のようにクエリパラメーターを returnUrl 項目に含めることで、トランザクションに関する状態情報を復元できます。ユーザーがアプリケーションにリダイレクトされると、event クエリパラメーターが追加されます。この例では、推測できない値を状態値として使用することで偽装を防止します。
注意: この URL は、同じ URL に対してリクエストボディなしで DELETE コールを実行して取り消すことができます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Recipient Preview
<docusign:create-v21-accounts-envelopes-views-recipient-preview-by-account-id-envelope-id>
このメソッドは、アプリケーションに埋め込むことができる DocuSign UI のエンベロープ受信者プレビューの URL を返します。送信者が受信者の環境をプレビューできるようにするには、このメソッドを使用します。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Sender View
<docusign:create-v21-accounts-envelopes-views-sender-by-account-id-envelope-id>
アプリケーションに DocuSign UI の送信者ビューを埋め込むことができる URL を返します。返される URL は、生成直後にのみリダイレクトできます。これは、1 回のみ使用できます。そのため、ユーザーをリダイレクトする直前に URL を要求します。
最適なユーザーエクスペリエンスを実現するために、iFrame は使用しないでください。DocuSign では、iOS デバイスに WebView を使用することが推奨されています。クライアントの状況の管理には、複数のソリューションを使用できます。 ユーザーが送信ビューを完了すると、ブラウザーが指定された returnUrl にリダイレクトされます。デフォルトでは、エンベロープにすでに 1 つ以上のドキュメントが含まれている場合、URL へのリダイレクト時にドキュメントタギングビューが最初に表示されます。
代わりにエンベロープの受信者およびドキュメントビューで開始するには、メソッドの応答の URL を確認します。次に、クエリパラメーターを send=1 から send=0 に変更して、受信者/ドキュメントビューで開始するようにします。
注意: この URL は、同じ URL に対してリクエストボディなしで DELETE コールを実行して取り消すことができます。
情報セキュリティ通知: このメソッドでは、送信アカウントへのフルアクセスが提供されます。このビューを使用する場合、現在のユーザーにアカウントへのフルアクセスが付与されます。アカウントに管理者権限があると、このメソッドでも管理者アクセス権が提供されます。
送信前に送信者がドラフトエンベロープの更新や他の変更を実行できるようにする必要があるユースケースの場合、次のいずれかの手順を実行します。
-
この API メソッドを使用するための個別のユーザーアカウントを送信者ごとに設定する。
-
このメソッドが必要なくなるように API インテグレーションを強化する。インテグレーションでは、必要に応じてタブ、受信者、およびその他のエンベロープ設定を作成できます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Recipient Shared View
<docusign:create-v21-accounts-envelopes-views-shared-by-account-id-envelope-id>
アプリケーションに DocuSign UI の共有エンベロープの受信者ビューを埋め込むことができる URL を返します。同じアカウントの受信者が共有するエンベロープのビューがユーザーに表示されます。
画面スペースの問題のため、モバイルデバイスでは埋め込み操作に iFrame を使用しないでください。DocuSign では、iOS デバイスに WebView を使用することが推奨されています。
この URL は、同じ URL に対してリクエストボディなしで DELETE コールを実行して取り消すことができます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Groups Post Groups
<docusign:create-v21-accounts-groups-by-account-id>
アカウントの 1 つ以上のグループを作成します。グループを使用すると、ユーザーをグループに関連付けてユーザーを簡単に管理できるようになります。グループを権限プロファイルに関連付けることができます。これにより、ユーザーごとに userSettings プロパティを設定することなく、そのグループのユーザーのユーザー権限を設定できます。グループの権限プロファイルを設定する必要はありませんが、設定すると、多数のユーザーのユーザー権限を管理しやすくなります。また、テンプレート共有でグループを使用して、ユーザーのテンプレートへのアクセスを制限することもできます。
この操作では、/v2.1/accounts/{accountId}/groups エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Permission Profiles Post Permission Profiles
<docusign:create-v21-accounts-permission-profiles-by-account-id>
このメソッドは、アカウントの新しい権限プロファイルを作成します。この操作では、/v2.1/accounts/{accountId}/permission_profiles エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
include (含める) |
String (文字列) |
応答で返される追加プロパティのカンマ区切りリスト。この要求で有効な値は |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Post Power Form
<docusign:create-v21-accounts-powerforms-by-account-id>
このメソッドは、新しい PowerForm を作成します。リクエストボディの templateId に基づいて、既存の DocuSign テンプレートから PowerForm を作成します。テンプレートから作成する PowerForms は、Web PowerForms として参照されます。
RADmin コンソールでは、アクティブなフォーム項目のある PDF ファイルをアップロードして PowerForm を作成することもできます (PDF PowerForm として参照される)。ただし、PDF PowerForms は非推奨であるため、API ではサポートされていません。
PowerForm には、1 人の送信者のみを含めることができます。PowerForms は必ずしもメールで送信する必要がないため、このユーザーは PowerForm イニシエーターとしても参照されます。 複数の送信者を PowerForm に関連付ける必要がある場合、同じテンプレートを使用して PowerForm の複数のコピーを作成します (送信者ごとに 1 つのコピー)。デフォルトでは、送信者は PowerForm を作成する PowerForm 管理者です。
署名モード
PowerForm では、次のいずれかの署名モードを使用できます。email このモードでは、受信者がドキュメントを署名する前にメール認証を使用して受信者の ID を検証します。受信者は、ランディングページでメールアドレスを入力して [Begin Signing (署名を開始)] をクリックし、署名プロセスを開始します。その後、システムによって、検証コードが含まれるメールメッセージが受信者に送信されます。受信者が有効なメールアドレスを入力していないと、アクセスコードが含まれるメールメッセージを受信できないため、ドキュメントを開いて署名することができません。
代わりに、メール認証のみを使用してアクセスコードを省略することで署名者のプロセスを簡単にすることもできます。これを行うには、activateonly フラグを PowerForm URL に追加し、値 1 を渡して true に設定します。フラグがアクティブな場合、リンクが含まれるメールを最初の受信者が受信します。このリンクを使用すると、アクセスコードを入力せずに署名セッションを開始できます。例: activateonly=1 direct。このモードでは、認証が必要がありません。
受信者がランディングページでメールアドレスを入力して [Begin Signing (署名を開始)] をクリックすると、新しいブラウザータブが開き、受信者は署名プロセスをすぐに開始できます。direct 署名モードでは、メール認証を使用して受信者の ID が検証されないため、DocuSign では、受信者の ID がすでに認証されているか、DocuSign テンプレートで別の認証形式 (アクセスコード、電話認証、ID チェックなど) が受信者に指定されているセキュアなポータルの背後で PowerForm にアクセスできる場合を除き、このモードを使用しないことが強く推奨されています。 注意: signingMode として direct を使用するには、アカウント設定で enablePowerFormDirect が true になっている必要があります。
リダイレクト URL
PowerForm の署名後に署名者をリダイレクトする URL を制御できます。ただし、URL は PowerForm 作成プロセス以外のどこかで指定します。詳細は、[How do I specify a URL to redirect to when a PowerForm is completed? (PowerForm の完了時にリダイレクトする URL を指定する方法は?)](https://support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed) を参照してください。
この操作では、/v2.1/accounts/{accountId}/powerforms エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Post Report In Product Create
<docusign:create-v21-accounts-reports-by-account-id>
この操作では、/v2.1/accounts/{accountId}/reports エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
BCCEmail Archive Post BCCEmail Archive
<docusign:create-v21-accounts-settings-bcc-email-archives-by-account-id>
このメソッドは、アカウントの BCC メールアーカイブ設定を作成します (DocuSign で生成されるメールをアーカイブするために BCC メールアドレスをアカウントに追加する)。リクエストボディで設定する必要のあるプロパティは、使用する BCC メールアドレスのみです。
注意: アカウントでは、最大 5 個のアクティブおよび保留中のメールアーカイブアドレスを組み合わせることができますが、このメソッドを使用して 1 つずつそれらをアカウントに追加する必要があります。各メールアドレスは、個別の BCC メールアーカイブ設定として考慮されます。
この操作では、/v2.1/accounts/{accountId}/settings/bcc_email_archives エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Post Account Signatures
<docusign:create-v21-accounts-signatures-by-account-id>
この操作では、/v2.1/accounts/{accountId}/signatures エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Decode only (デコードのみ) |
String (文字列) |
Decode only (デコードのみ) |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Post Signing Groups
<docusign:create-v21-accounts-signing-groups-by-account-id>
1 つ以上の署名グループを作成します。1 つのコールで複数の署名グループを作成できます。署名グループを作成できるのは、アカウント管理者権限を持つユーザーのみです。アカウントには、最大 50 個の署名グループを設定できます。各署名グループには、最大 50 人のグループメンバーを含めることができます。署名グループは、任意のアカウントユーザーが使用できます。この操作では、/v2.1/accounts/{accountId}/signing_groups エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Post Tab Definitions
<docusign:create-v21-accounts-tab-definitions-by-account-id>
定義済みのプロパティを含むタブを作成します。たとえば、特定のフォントタイプと検証パターンを含むテキストタブを作成します。ユーザーは DocuSign Web アプリケーションから文書を送信するときにカスタムタブにアクセスできます。カスタムタブは次のタブで作成できます: 承認、チェックボックス、会社、日付、署名日、拒否、メール、メールアドレス、エンベロープ ID、名、数式、氏名、ここにイニシャル、姓、リスト、メモ、数値、ラジオ、ここに署名、署名者の添付ファイル、SSN、テキスト、タイトル、zip。この操作では、/v2.1/accounts/{accountId}/tab_definitions エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Post Templates
<docusign:create-v21-accounts-templates-by-account-id>
テンプレートごとにマルチパート要求を使用して、1 つ以上のテンプレート定義を作成します。同じまたは同様の文書を頻繁に送信する場合や、異なる文書を同じ人グループに送信する場合、テンプレートを使用すると送信プロセスを容易に合理化できます。テンプレートを作成するときにプレースホルダーロールを定義します。個人を指定するのではなく、テンプレートを使用するトランザクションに定期的に参加するロールを指定します。その後、テンプレートに基づいてエンベロープを作成または送信するときに、実際の受信者をテンプレートの各ロールに割り当てます。受信者は、テンプレート内の該当のロールに対して定義されたすべてのワークフロー (タブやルーティング情報など) を自動的に継承します。コード例や詳細は、 REST API テンプレートを参照してください。
テンプレートのメールの件名の差し込み項目
プレースホルダーロールには、DocuSign から送信されるメール通知をパーソナライズする差し込み項目が関連付けられています。たとえば、受信者のロールに基づいて受信者の名前とメールアドレスのプレースホルダーをメールの件名行内に追加することで、テンプレートでメールメッセージを自動的にパーソナライズします。送信者が受信者の名前とメール情報を追加してエンベロープを送信すると、受信者の情報がメールの件名行の該当の項目に自動的に差し込まれます。テンプレートに関連付けられたメールの件名行内の情報は送信者と受信者の両方に表示されます。これにより、送信者はエンベロープを開いて受信者が誰であるかを確認することなく、エンベロープメールを容易に整理できます。
受信者情報を件名行に差し込むことで件名行が 100 文字を超える場合、100 文字制限を超える文字は件名行に含まれません。受信者名またはメールが長いことが予想される場合は、差し込み項目をメールの件名の先頭に配置することを考慮する必要があります。
受信者の名前を件名行に挿入するには、テンプレートを作成するときに、次のテキストを emailSubject プロパティに追加します。
[[<roleName>_UserName]]
例:
"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",
受信者のメールアドレスを件名行に追加するには、テンプレートを作成するとき、またはテンプレートからエンベロープを送信するときに、次のテキストを emailSubject プロパティに追加します。
[[<roleName>_Email]]
例:
"emailSubject":"[[Signer 1_Email]], Please sign this NDA",
この例では、テンプレートで指定されたロール名は「Signer 1 (署名者 1)」です。 エンベロープが送信されると、このプレースホルダーは受信者の名前またはメールに動的に置き換えられます。
複数のテンプレートの作成
複数のテンプレートを作成するには、JSON ファイルの zip ファイルを提供します。また、is_download クエリパラメーターを指定した Templates::ListTemplates メソッドを使用して、既存のテンプレートが含まれる zip ファイルをダウンロードし、そのテンプレートをガイドとして使用することもできます。この API では .zip ファイル形式と .gzip ファイル形式の両方が入力としてサポートされます。
次のヘッダーも設定する必要があります。
-
Content-Length -
Content-Type -
Content-Disposition
例:
Content-Length: 71068 Content-Type: application/zip Content-Disposition: file; filename="DocuSignTemplates_Nov_25_2019_20_40_21.zip"; fileExtension=.zip
この操作では、/v2.1/accounts/{accountId}/templates エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
(必須) 外部アカウント番号 (整数) またはアカウント ID GUID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Custom Fields Post Template Custom Fields
<docusign:create-v21-accounts-templates-custom-fields-by-account-id-template-id>
既存のテンプレート文書のカスタム文書項目を作成します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Document Fields Post Template Document Fields
<docusign:create-v21-accounts-templates-documents-fields-by-account-id-template-id-document-id>
既存のテンプレート文書のカスタム文書項目を作成します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Post Template Document Responsive Html Preview
<docusign:create-v21-accounts-templates-documents-responsive-html-preview-by-account-id-template-id-document-id>
特定のテンプレート文書の反応型の HTML バージョンのプレビューを作成します。このメソッドを使用すると、送信前に各デバイス種別で PDF ドキュメントがどのようにレスポンシブ HTML に変換されるのかをプレビューできます。リクエストボディは documentHtmlDefinition オブジェクトです。このオブジェクトにあるレスポンシブ署名パラメーターで、署名ドキュメントの HTML バージョンの生成方法が定義されます。
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Post Template Document Tabs
<docusign:create-v21-accounts-templates-documents-tabs-by-account-id-template-id-document-id>
このメソッドではテンプレート文書タブを作成します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Lock Post Template Lock
<docusign:create-v21-accounts-templates-lock-by-account-id-template-id>
指定されたテンプレートをロックし、ロックの有効期限が切れるまでの時間を設定して、他のユーザーまたは受信者がテンプレートを変更できないようにします。この要求への応答では、lockToken パラメーターが返されます。既存のロックを更新または削除するには、lockToken を使用する必要があります。テンプレートがロックされている間、テンプレートで実行する PUT コールごとにヘッダーに lockToken も含める必要があります。lockToken を含めない場合、システムから次のエラーが返されます。
{ "errorCode": "EDIT_LOCK_NOT_LOCK_OWNER", "message": "The user is not the owner of the lock. The template is locked by another user or in another application" }
この関数を使用するには、ユーザーはエンベロープのロック機能を有効にする必要があります (ユーザーの userSetting プロパティ canLockEnvelopes を true に設定する必要があります)。
|
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/lock エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Post Template Recipients
<docusign:create-v21-accounts-templates-recipients-by-account-id-template-id>
1 人以上の受信者をテンプレートに追加します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Resend envelope (エンベロープを再送信) |
String (文字列) |
true に設定されている場合、リクエストボディで指定した受信者にエンベロープを再送信します。元のメール通知を削除した受信者にエンベロープを再送信するには、このパラメーターを使用します。 注意: エンベロープの修正は、別のプロセスになります。ここで入力した値に関係なく、エンベロープを修正すると必ず DocuSign からエンベロープが再送信されます。 |
||
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Post Template Recipient Tabs
<docusign:create-v21-accounts-templates-recipients-tabs-by-account-id-template-id-recipient-id>
受信者の 1 つ以上のタブを追加します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Post Template Responsive Html Preview
<docusign:create-v21-accounts-templates-responsive-html-preview-by-account-id-template-id>
テンプレートに関連付けられているすべての文書の[反応型](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/api-overview)の HTML バージョンのプレビューを作成します。このメソッドを使用すると、送信前に各デバイス種別で PDF ドキュメントがどのようにレスポンシブ HTML に変換されるのかをプレビューできます。リクエストボディは documentHtmlDefinition オブジェクトです。このオブジェクトにあるレスポンシブ署名パラメーターで、ドキュメントの HTML バージョンの生成方法が定義されます。
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Template Edit View
<docusign:create-v21-accounts-templates-views-edit-by-account-id-template-id>
このメソッドは、DocuSign テンプレート UI を使用するテンプレートの編集ビューを開始する URL を返します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/views/edit エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Template Recipient Preview
<docusign:create-v21-accounts-templates-views-recipient-preview-by-account-id-template-id>
このメソッドは、アプリケーションに埋め込むことができる DocuSign UI のテンプレート受信者プレビューの URL を返します。送信者が受信者の環境をプレビューできるようにするには、このメソッドを使用します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Users Post Users
<docusign:create-v21-accounts-users-by-account-id>
新しいユーザーをアカウントに追加します。このリクエストボディは newUsers オブジェクトの配列です。新しいユーザーごとに少なくとも userName および email プロパティを提供する必要があります。userSettings プロパティでは、ユーザーが実行できるアクションを指定します。以下の例では、Tal Mason がエンベロープを送信できるようになります。また、locale が fr に設定されているため、アクティベーションメールはフランス語です。
POST /restapi/v2.1/accounts/{accountId}/users
Content-Type: application/json
{
"newUsers": [{
"userName": "Claire Horace",
"email": "claire@example.com"
}, {
"userName": "Tal Mason",
"email": "talmason@example.com",
"company": "TeleSel",
"userSettings": {
"locale": "fr",
"canSendEnvelope": true
}
}]
}json正常な応答は、新しく作成されたユーザーに関する情報が含まれる newUsers 配列です。ユーザーの作成で問題が発生した場合、そのユーザーエントリには、何が誤っていたかを説明する errorDetails プロパティが含まれます。
{
"newUsers": [{
"userId": "18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade",
"uri": "/users/18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade",
"email": "claire@example.com",
"userName": "Claire Horace",
"createdDateTime": "0001-01-01T08:00:00.0000000Z",
"errorDetails": {
"errorCode": "USER_ALREADY_EXISTS_IN_ACCOUNT",
"message": "Username and email combination already exists for this account."
}
}, {
"userId": "be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33",
"uri": "/users/be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33",
"email": "talmason@example.com",
"userName": "Tal Mason",
"userStatus": "ActivationSent",
"createdDateTime": "2020-05-26T23:25:30.7330000Z"
}]
}jsonこの操作では、/v2.1/accounts/{accountId}/users エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Cloud Storage Post Cloud Storage
<docusign:create-v21-accounts-users-cloud-storage-by-account-id-user-id>
指定されたユーザーの 1 つ以上のクラウドストレージプロバイダーのリダイレクト URL 情報を設定します。リダイレクト URL を認証 URL に追加して、戻りルートを完了します。この操作では、/v2.1/accounts/{accountId}/users/{userId}/cloud_storage エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Signatures Post User Signatures
<docusign:create-v21-accounts-users-signatures-by-account-id-user-id>
ユーザーの署名画像またはユーザーのイニシャル画像を、指定されたユーザーに追加します。エンドポイントで指定された userId プロパティが認証済みユーザーの userId と一致する必要があり、ユーザーがアカウントのメンバーである必要があります。これに関連付けられるルールとプロセスは次のとおりです。
-
Content-Type が application/json に設定されている場合、名前と DocuSign フォントに基づいて、デフォルトの署名画像を作成するデフォルトの動作が使用されます。 -
Content-Type が multipart/form-data に設定されている場合、要求の最初のパートにユーザーの署名情報が含まれ、その後のパートに画像が含まれている必要があります。
各画像パートの Content-Disposition ヘッダーには「filename」の値が含まれており、この値を使用して JSON の signatureName または signatureInitials プロパティを画像にマップします。例: Content-Disposition: file; filename="Ron Test20121127083900"。
(filename の値で) 一致する画像が見つからない場合、画像は設定されません。このコールで署名画像とイニシャル画像のいずれかまたは両方を設定できます。また、いずれも設定しないこともできます。
画像が含まれるパートのヘッダーに Content-Transfer-Encoding: base64 ヘッダーを設定して、画像の形式がバイナリではなく base64 であることを示すことができます。
成功した場合、200-OK が返され、署名情報が含まれる JSON 構造が提供されます。署名構造を変更すると、現在の署名が閉じて新しい署名レコードが作成されるため、signatureId は API POST、PUT、または DELETE のたびに変わる可能性があります。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/signatures エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Account Console View
<docusign:create-v21-accounts-views-console-by-account-id>
アプリケーションに DocuSign UI の認証ビューを埋め込むことができる URL を返します。 注意: この URL は、同じ URL に対してリクエストボディなしで DELETE コールを実行して取り消すことができます。
情報セキュリティに関する警告: このメソッドでは、アカウントへのフル管理者アクセス権が提供されます。
この操作では、/v2.1/accounts/{accountId}/views/console エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Workspace Post Workspace
<docusign:create-v21-accounts-workspaces-by-account-id>
このメソッドでは新しいワークスペースを作成します。この操作では、/v2.1/accounts/{accountId}/workspaces エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Workspace File Post Workspace Files
<docusign:create-v21-accounts-workspaces-folders-files-by-account-id-workspace-id-folder-id>
このメソッドではファイルをワークスペースに追加します。この操作では、/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Folder Id (フォルダー ID) |
String (文字列) |
フォルダーの ID。 |
x |
|
Workspace Id (ワークスペース ID) |
String (文字列) |
ワークスペースの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notary Post Notary
<docusign:create-v21-current-user-notary>
現在のユーザーを公証人として登録します。この操作では、/v2.1/current_user/notary エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notary Jurisdictions Post Notary Jurisdictions
<docusign:create-v21-current-user-notary-jurisdictions>
管轄区域オブジェクトを作成します。この操作では、/v2.1/current_user/notary/jurisdictions エンドポイントに対する HTTP POST 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brands Delete Brands
<docusign:delete-v21-accounts-brands-by-account-id>
このメソッドでは、brandsRequest に含めたブランド ID に基づいてアカウントから 1 つ以上のブランドプロファイルを削除します。
署名または送信のいずれかのブランド設定がアカウントで有効になっている必要があります (canSelfBrandSend、canSelfBrandSign、またはこれらのアカウント設定の両方が true である必要があります)。
|
この操作では、/v2.1/accounts/{accountId}/brands エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brand Delete Brand
<docusign:delete-v21-accounts-brands-by-account-id-brand-id>
このメソッドではアカウントからブランドを削除します。
注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。
この操作では、/v2.1/accounts/{accountId}/brands/{brandId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Brand Id (ブランド ID) |
String (文字列) |
ブランドの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brand Logo Delete Brand Logo
<docusign:delete-v21-accounts-brands-logos-by-account-id-brand-id-logo-type>
このメソッドではアカウントブランドから 1 つのロゴを削除します。 注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。この操作では、/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Brand Id (ブランド ID) |
String (文字列) |
ブランドの ID。 |
x |
|
Logo Type (ロゴタイプ) |
String (文字列) |
ロゴのタイプ。有効な値: - |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2CRUD Delete Bulk Send List
<docusign:delete-v21-accounts-bulk-send-lists-by-account-id-bulk-send-list-id>
このメソッドでは一括送信リストを削除します。この操作では、/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Bulk Send List Id (一括送信リスト ID) |
String (文字列) |
一括送信リストの GUID。このプロパティは、新しい一括送信リストを投稿した後に作成されます。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Accounts Delete Account
<docusign:delete-v21-accounts-by-account-id>
指定されたアカウントを閉じます。アカウントを閉じるには、アカウント管理者である必要があります。閉じられたアカウントは DocuSign によって再度開かれる必要があります。この操作では、/v2.1/accounts/{accountId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Captive Recipients Delete Captive Recipients Part
<docusign:delete-v21-accounts-captive-recipients-by-account-id-recipient-part>
このメソッドでは、1 つ以上の埋め込み受信者レコードの署名を削除します。これは主にテストで使用されます。この機能を使用すると、クライアントのユーザー ID に関連付けられた署名をリセットできるため、次にクライアントのユーザー ID を使用するときに新しい署名を作成できます。
この操作では、/v2.1/accounts/{accountId}/captive_recipients/{recipientPart} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Recipient Part (受信者パート) |
String (文字列) |
サポートされる値は署名のみです。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Chunked Uploads Delete Chunked Upload
<docusign:delete-v21-accounts-chunked-uploads-by-account-id-chunked-upload-id>
コミットされ、まだコンシュームされていないチャンクアップロードを削除します。次の種別のチャンクアップロードはこのメソッドを使用して削除できません。これらはシステムにより自動的に削除されます。
-
別の API コールでの用途によりコンシュームされたチャンクアップロード。
-
有効期限が切れたチャンクアップロード。
注意: 破棄できるチャンクアップロードを認識している場合は、ベストプラクティスとしてそのチャンクアップロードを明示的に削除することをお勧めします。チャンクアップロードの有効期限が切れた後、システムにより自動的に削除されるまで待っている場合、チャンクアップロードは引き続き割り当てに含まれます。
この操作では、/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Chunked Upload Id (チャンクアップロード ID) |
String (文字列) |
チャンクアップロードの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Delete Connect Config
<docusign:delete-v21-accounts-connect-by-account-id-connect-id>
指定された DocuSign Connect 設定を削除します。
注意: この関数を使用するには、アカウントで Connect が有効になっている必要があります。
この操作では、/v2.1/accounts/{accountId}/connect/{connectId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Connect Id (Connect ID) |
String (文字列) |
アクセスするカスタム Connect 設定の ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Failures Delete Connect Failure Log
<docusign:delete-v21-accounts-connect-failures-by-account-id-failure-id>
指定されたエントリの Connect エラーログ情報を削除します。この操作では、/v2.1/accounts/{accountId}/connect/failures/{failureId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Failure Id (エラー ID) |
String (文字列) |
Connect POST エラーの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Log Delete Connect Logs
<docusign:delete-v21-accounts-connect-logs-by-account-id>
アカウントの Connect ログエントリのリストを削除します。この操作では、/v2.1/accounts/{accountId}/connect/logs エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Log Delete Connect Log
<docusign:delete-v21-accounts-connect-logs-by-account-id-log-id>
指定されたエントリを Connect ログから削除します。この操作では、/v2.1/accounts/{accountId}/connect/logs/{logId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Log Id (ログ ID) |
String (文字列) |
Connect ログエントリの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Contacts Delete Contacts
<docusign:delete-v21-accounts-contacts-by-account-id>
このメソッドではアカウントに関連付けられている複数の取引先責任者を削除します。この操作では、/v2.1/accounts/{accountId}/contacts エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Contacts Delete Contact With Id
<docusign:delete-v21-accounts-contacts-by-account-id-contact-id>
このメソッドではアカウントに関連付けられている取引先責任者を削除します。この操作では、/v2.1/accounts/{accountId}/contacts/{contactId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Contact Id (取引先責任者 ID) |
String (文字列) |
アカウントのアドレスブック内の取引先責任者の ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Custom Fields Delete Account Custom Fields
<docusign:delete-v21-accounts-custom-fields-by-account-id-custom-field-id>
このメソッドでは既存のカスタムアカウント項目を削除します。この操作では、/v2.1/accounts/{accountId}/custom_fields/{customFieldId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Custom Field Id (カスタム項目 ID) |
String (文字列) |
カスタム項目の ID。 |
x |
|
Apply to templates (テンプレートに適用) |
String (文字列) |
Apply to templates (テンプレートに適用) |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Attachments Delete Attachments
<docusign:delete-v21-accounts-envelopes-attachments-by-account-id-envelope-id>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Custom Fields Delete Custom Fields
<docusign:delete-v21-accounts-envelopes-custom-fields-by-account-id-envelope-id>
ドラフトおよび処理中のエンベロープのカスタムエンベロープ項目を削除します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Documents Delete Documents
<docusign:delete-v21-accounts-envelopes-documents-by-account-id-envelope-id>
まだ完了していない既存のエンベロープから 1 つ以上の文書を削除します。文書を削除するには、envelopeDefinition の関連パートのみを使用します。たとえば、次のリクエストボディでは、documentId が「1」の文書を削除することが指定されています。
{ "documents": [ { "documentId": "1" } ] }
エンベロープの状況は次のいずれかである必要があります。
-
created -
sent -
delivered
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Document Fields Delete Document Fields
<docusign:delete-v21-accounts-envelopes-documents-fields-by-account-id-envelope-id-document-id>
既存のエンベロープ文書からカスタム文書項目を削除します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Pages Delete Page
<docusign:delete-v21-accounts-envelopes-documents-pages-by-account-id-envelope-id-document-id-page-number>
ページ番号に基づいてエンベロープ内の文書からページを削除します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Page Number (ページ番号) |
String (文字列) |
アクセスするページ番号。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Delete Document Tabs
<docusign:delete-v21-accounts-envelopes-documents-tabs-by-account-id-envelope-id-document-id>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Delete Document Templates
<docusign:delete-v21-accounts-envelopes-documents-templates-by-account-id-envelope-id-document-id-template-id>
指定されたテンプレートを既存のエンベロープ内の文書から削除します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Email Settings Delete Email Settings
<docusign:delete-v21-accounts-envelopes-email-settings-by-account-id-envelope-id>
エンベロープのすべての既存のメール上書き設定を削除します。個々のメール上書き設定を削除する場合は、PUT を使用して値を空の文字列に設定します。メール設定の削除は、削除後に実行されるメールコミュニケーションにのみ影響します。今後のメールコミュニケーションではアカウントの通常のメール設定が使用されます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Lock Delete Envelope Lock
<docusign:delete-v21-accounts-envelopes-lock-by-account-id-envelope-id>
指定されたエンベロープからロックを削除します。ユーザーは、lockByUser プロパティで指定されたユーザーに一致する必要があり、渡すインテグレーターキーはインテグレーターキー情報に一致する必要があります。ロックの所有権を証明する lockToken と lockDurationInSeconds が含まれる X-DocuSign-Edit ヘッダーも含める必要があります。
このヘッダーで必要なトークンは POST および GET メソッドの応答で返されます (例: X-DocuSign-Edit:{{lockToken}})。
重要: クエリパラメーター save_changes を使用して、ロックを削除するときにユーザーの変更をコミットするかどうかを示す必要があります。true に設定すると、ロックがアクティブになっていた間にユーザーが行った変更がコミットされます。false に設定すると、ユーザーの変更は破棄されます。現在、このクエリパラメーターはこのページのクエリパラメーターのリストには表示されません。ただし、ユーザーの変更を必要に応じて確実に保存または破棄するには、これを含めることが重要です。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Delete Recipients
<docusign:delete-v21-accounts-envelopes-recipients-by-account-id-envelope-id>
ドラフトまたは送信済みのエンベロープから 1 人以上の受信者を削除します。削除する受信者のリストをリクエストボディに含めます。このメソッドでは、受信者を削除するためのキーとして recipientId を使用します。エンベロープが In Process の場合、エンベロープは送信済みで、まだ完了していないか取り消されていないことを意味し、アクションを完了した受信者を削除することはできません。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Delete Recipient
<docusign:delete-v21-accounts-envelopes-recipients-by-account-id-envelope-id-recipient-id>
draft または sent のエンベロープから受信者を削除します。エンベロープが「In Process (処理中)」の場合 (エンベロープが送信済みで、まだ完了していないか取り消されていない場合)、アクションを完了した受信者を削除することはできません。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Delete Recipient Tabs
<docusign:delete-v21-accounts-envelopes-recipients-tabs-by-account-id-envelope-id-recipient-id>
ドラフトのエンベロープ内の受信者に関連付けられた 1 つ以上のタブを削除します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Transfer Rules Delete Envelope Transfer Rules
<docusign:delete-v21-accounts-envelopes-transfer-rules-by-account-id-envelope-transfer-rule-id>
このメソッドではエンベロープ転送ルールを削除します。
注意: エンベロープ転送ルールを削除できるのは、システム管理者のみです。また、エンベロープ転送ルールを使用するには、アカウントで [Transfer Custody (転送の管理)] 機能が有効になっている必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Transfer Rule Id (エンベロープ転送ルール ID) |
String (文字列) |
エンベロープ転送ルールの ID。この ID は、ルールの最初の作成時に生成されます。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Delete Envelope Correct View
<docusign:delete-v21-accounts-envelopes-views-correct-by-account-id-envelope-id>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Workflow Definition Delete Envelope Workflow Definition
<docusign:delete-v21-accounts-envelopes-workflow-by-account-id-envelope-id>
指定されたエンベロープのワークフロー定義がある場合、そのワークフロー定義を削除します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Favorite Templates Un Favorite Template
<docusign:delete-v21-accounts-favorite-templates-by-account-id>
この操作では、/v2.1/accounts/{accountId}/favorite_templates エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brands Delete Group Brands
<docusign:delete-v21-accounts-groups-brands-by-account-id-group-id>
このメソッドではグループから 1 つ以上のブランドを削除します。この操作では、/v2.1/accounts/{accountId}/groups/{groupId}/brands エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Group Id (グループ ID) |
String (文字列) |
グループの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Groups Delete Groups
<docusign:delete-v21-accounts-groups-by-account-id>
既存のユーザーグループを削除します。グループを削除する場合、groupId のみをリクエストボディに含めます。
例: { "groups": [ { "groupId": "12345" } }
この操作では、/v2.1/accounts/{accountId}/groups エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Groups Delete Group Users
<docusign:delete-v21-accounts-groups-users-by-account-id-group-id>
1 人以上のユーザーをグループから削除します。この要求では、削除するユーザーが含まれる userInfoList を使用します。この操作では、/v2.1/accounts/{accountId}/groups/{groupId}/users エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Group Id (グループ ID) |
String (文字列) |
アクセスするグループの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Permission Profiles Delete Permission Profiles
<docusign:delete-v21-accounts-permission-profiles-by-account-id-permission-profile-id>
このメソッドではアカウントから権限プロファイルを削除します。権限プロファイルを削除するには、権限プロファイルにユーザーが関連付けられていない必要があります。このメソッドを使用して権限プロファイルを削除するときに、move_users_to クエリパラメーターを使用すると、権限プロファイルに関連付けられているユーザーを新しい権限プロファイルに同時に再割り当てすることができます。この操作では、/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Permission Profile Id (権限プロファイル ID) |
String (文字列) |
権限プロファイルの ID。可能な値: - |
x |
|
Move users to (ユーザーの移動先) |
String (文字列) |
Move users to (ユーザーの移動先) |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Delete Power Forms List
<docusign:delete-v21-accounts-powerforms-by-account-id>
このメソッドでは 1 つ以上の PowerForm を削除します。リクエストボディでは、powerFormId に基づいて削除される PowerForm オブジェクトの配列を使用します。この操作では、/v2.1/accounts/{accountId}/powerforms エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Delete Power Form
<docusign:delete-v21-accounts-powerforms-by-account-id-power-form-id>
このメソッドでは PowerForm を削除します。この操作では、/v2.1/accounts/{accountId}/powerforms/{powerFormId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Power Form Id (パワーフォーム Id) |
String (文字列) |
PowerForm の ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Delete Report In Product
<docusign:delete-v21-accounts-reports-by-account-id-id>
この操作では、/v2.1/accounts/{accountId}/reports/{id} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
ID |
String (文字列) |
Salesforce オブジェクトの一意の ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
BCCEmail Archive Delete BCCEmail Archive
<docusign:delete-v21-accounts-settings-bcc-email-archives-by-account-id-bcc-email-archive-id>
このメソッドではアカウントから BCC メールアーカイブ設定を削除します。このメソッドを使用すると、BCC メールアーカイブ設定の状況が closed に切り替わり、DocuSign により生成されたメールメッセージをアーカイブするのに BCC メールアドレスは使用されなくなります。
この操作では、/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Bcc Email Archive Id (BCC メールアーカイブ ID) |
String (文字列) |
BCC メールアーカイブ設定の ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
ENote Configuration Delete ENote Configuration
<docusign:delete-v21-accounts-settings-enote-configuration-by-account-id>
この操作では、/v2.1/accounts/{accountId}/settings/enote_configuration エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Delete Account Signature
<docusign:delete-v21-accounts-signatures-by-account-id-signature-id>
この操作では、/v2.1/accounts/{accountId}/signatures/{signatureId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Delete Account Signature Image
<docusign:delete-v21-accounts-signatures-by-account-id-signature-id-image-type>
この操作では、/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Image Type (画像の種類) |
String (文字列) |
画像の種類を指定します。有効な値: - |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Delete Signing Groups
<docusign:delete-v21-accounts-signing-groups-by-account-id>
指定されたアカウント内の 1 つ以上の署名グループを削除します。この操作では、/v2.1/accounts/{accountId}/signing_groups エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Delete Signing Group Users
<docusign:delete-v21-accounts-signing-groups-users-by-account-id-signing-group-id>
指定された署名グループから 1 人以上のメンバーを削除します。この操作では、/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Signing Group Id (署名グループ ID) |
String (文字列) |
省略可能。[署名グループ](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups)の |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tab Delete Custom Tab
<docusign:delete-v21-accounts-tab-definitions-by-account-id-custom-tab-id>
指定されたアカウントからカスタムを削除します。この操作では、/v2.1/accounts/{accountId}/tab_definitions/{customTabId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Custom Tab Id (カスタムタブ ID) |
String (文字列) |
DocuSign により生成された、適用するカスタムタブのカスタムタブ ID。これは、受信者用の新規タブを追加する場合にのみ使用できます。使用時に、新規タブはすべてのカスタムタブプロパティを継承します。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Delete Template Part
<docusign:delete-v21-accounts-templates-by-account-id-template-id-template-part>
指定されたテンプレートに対するメンバーグループの共有権限を削除します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Template Part (テンプレートパート) |
String (文字列) |
現在、定義されたパートは groups のみです。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Custom Fields Delete Template Custom Fields
<docusign:delete-v21-accounts-templates-custom-fields-by-account-id-template-id>
テンプレートのカスタムエンベロープ項目を削除します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Documents Delete Template Documents
<docusign:delete-v21-accounts-templates-documents-by-account-id-template-id>
このメソッドでは既存のテンプレートから 1 つ以上の文書を削除します。文書を削除するには、envelopeDefinition の関連パートのみを使用します。たとえば、次のリクエストボディでは、documentId が「1」の文書を削除することが指定されています: { "documents": [ { "documentId": "1" } ] }
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Document Fields Delete Template Document Fields
<docusign:delete-v21-accounts-templates-documents-fields-by-account-id-template-id-document-id>
既存のテンプレート文書からカスタム文書項目を削除します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Pages Delete Template Page
<docusign:delete-v21-accounts-templates-documents-pages-by-account-id-template-id-document-id-page-number>
ページ番号に基づいてテンプレート内の文書からページを削除します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Page Number (ページ番号) |
String (文字列) |
アクセスするページ番号。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Delete Template Document Tabs
<docusign:delete-v21-accounts-templates-documents-tabs-by-account-id-template-id-document-id>
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Lock Delete Template Lock
<docusign:delete-v21-accounts-templates-lock-by-account-id-template-id>
このメソッドではテンプレートからロックを削除します。ロックの所有権を証明する lockToken と lockDurationInSeconds が含まれる X-DocuSign-Edit ヘッダーを含める必要があります。このヘッダーで必要なトークンが POST および GET メソッドの応答で返されます (例: X-DocuSign-Edit:{{lockToken}})。
重要: クエリパラメーター save_changes を使用して、ロックを削除するときにユーザーの変更をコミットするかどうかを示す必要があります。true に設定すると、ロックがアクティブになっていた間にユーザーが行った変更がコミットされます。false に設定すると、ユーザーの変更は破棄されます。現在、技術的な問題のため、このクエリパラメーターはこのページのクエリパラメーターのリストには表示されません。ただし、ユーザーの変更を必要に応じて確実に保存または破棄するには、これを含めることが重要です。
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/lock エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Delete Template Bulk Recipients File
<docusign:delete-v21-accounts-templates-recipients-bulk-recipients-by-account-id-template-id-recipient-id>
テンプレートの一括受信者リストを削除します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Delete Template Recipients
<docusign:delete-v21-accounts-templates-recipients-by-account-id-template-id>
テンプレートから 1 人以上の受信者を削除します。削除する受信者のリストが要求に含まれ、recipientId が受信者を削除するためのキーとして使用されます。
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Delete Template Recipient
<docusign:delete-v21-accounts-templates-recipients-by-account-id-template-id-recipient-id>
指定されたテンプレートから、指定された受信者ファイルを削除します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Delete Template Recipient Tabs
<docusign:delete-v21-accounts-templates-recipients-tabs-by-account-id-template-id-recipient-id>
テンプレート内の受信者に関連付けられた 1 つ以上のタブを削除します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Workflow Definition Delete Template Workflow Definition
<docusign:delete-v21-accounts-templates-workflow-by-account-id-template-id>
指定されたテンプレートのワークフロー定義がある場合、そのワークフロー定義を削除します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/workflow エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Users Delete Users
<docusign:delete-v21-accounts-users-by-account-id>
アカウント内の 1 つ以上のユーザーレコードを閉じます。ユーザーはアカウントからは削除されませんが、ユーザーを閉じるとユーザーはアカウント機能を使用できなくなります。応答では、API の実行が成功したか (200 - OK)、失敗したか (400 - Error) が示されます。応答には、要求と同様のユーザー構造と、ユーザーの変更が含まれます。
いずれかのユーザーの DELETE 操作中にエラーが発生した場合、そのユーザーの応答には、errorCode および message プロパティを含む errorDetails プロパティが含まれます。
この操作では、/v2.1/accounts/{accountId}/users エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
delete |
String (文字列) |
削除するユーザーの ID。このパラメーターでは、 |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Cloud Storage Delete Cloud Storage Providers
<docusign:delete-v21-accounts-users-cloud-storage-by-account-id-user-id>
1 つ以上のクラウドストレージプロバイダーのユーザー認証情報を削除します。ユーザーは次にクラウドストレージプロバイダーにアクセスするときに、通常の認証に合格する必要があります。この操作では、/v2.1/accounts/{accountId}/users/{userId}/cloud_storage エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Cloud Storage Delete Cloud Storage
<docusign:delete-v21-accounts-users-cloud-storage-by-account-id-user-id-service-id>
指定されたクラウドストレージプロバイダーのユーザー認証情報を削除します。ユーザーは次にクラウドストレージプロバイダーにアクセスするときに、このクラウドストレージプロバイダーの通常の認証に合格する必要があります。この操作では、/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Service Id (サービス ID) |
String (文字列) |
アクセスするサービスの ID。有効な値はサービス名 (「Box」) または数値の serviceId (「4136」) です。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Custom Settings Delete Custom Settings
<docusign:delete-v21-accounts-users-custom-settings-by-account-id-user-id>
1 人のユーザーの指定されたカスタムユーザー設定を削除します。
グループ化されたカスタムユーザー設定の削除
削除するカスタムユーザー設定がグループ化されている場合、X-DocuSign-User-Settings-Key:group_name を要求のヘッダーの Content-Type 以降に含める必要があります。ここで group_name は、顧客のユーザー設定のグループに指定された名前です。この追加のヘッダー情報が含まれていない場合、グループなしで追加されたカスタムユーザー設定のみが削除されます。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/custom_settings エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Profile Image Delete User Profile Image
<docusign:delete-v21-accounts-users-profile-image-by-account-id-user-id>
指定されたユーザープロファイルからユーザープロファイル画像を削除します。エンドポイントで指定された userId パラメーターは認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーは、指定されたアカウントのメンバーである必要があります。この操作では、/v2.1/accounts/{accountId}/users/{userId}/profile/image エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Signatures Delete User Signature
<docusign:delete-v21-accounts-users-signatures-by-account-id-user-id-signature-id>
ユーザーの署名情報を削除します。エンドポイントで指定された userId パラメーターは認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーはアカウントのメンバーである必要があります。signatureId では署名 ID または署名の名前を受け入れます。名前によっては、URL に適切にエンコードされない文字が含まれている場合があるため、署名 ID (signatureId) を使用することをお勧めします。ユーザー名を使用する場合、名前にスペースが含まれている可能性があります。この場合、エンドポイントでこの名前を使用する前に名前を URL エンコードします。たとえば、「Bob Smith」を「Bob%20Smith」としてエンコードします。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Signatures Delete User Signature Image
<docusign:delete-v21-accounts-users-signatures-by-account-id-user-id-signature-id-image-type>
指定されたユーザーの指定されたイニシャル画像または署名画像を削除します。この関数ではこの画像の種類のどちらかを削除します。イニシャル画像と署名画像の両方を削除するには、エンドポイントを 2 回コールする必要があります。エンドポイントで指定された userId パラメーターは認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーはアカウントのメンバーである必要があります。
signatureId パラメーターでは署名 ID または署名の名前を受け入れます。名前によっては、URL に適切にエンコードされない文字が含まれている場合があるため、署名 ID (signatureId) を使用することをお勧めします。ユーザー名を使用する場合、名前にスペースが含まれている可能性があります。この場合、エンドポイントでこの名前を使用する前に名前を URL エンコードします。たとえば、「Bob Smith」を「Bob%20Smith」としてエンコードします。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Image Type (画像の種類) |
String (文字列) |
画像の種類を指定します。有効な値: - |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Workspace Delete Workspace
<docusign:delete-v21-accounts-workspaces-by-account-id-workspace-id>
既存のワークスペースを (論理的に) 削除します。この操作では、/v2.1/accounts/{accountId}/workspaces/{workspaceId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Workspace Id (ワークスペース ID) |
String (文字列) |
ワークスペースの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Workspace Folder Delete Workspace Items
<docusign:delete-v21-accounts-workspaces-folders-by-account-id-workspace-id-folder-id>
このメソッドではワークスペースフォルダーまたはルートから 1 つ以上のファイルまたはサブフォルダーを削除します。注意: ワークスペースから項目を削除するには、ワークスペースの status が active である必要があります。この操作では、/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Folder Id (フォルダー ID) |
String (文字列) |
フォルダーの ID。 |
x |
|
Workspace Id (ワークスペース ID) |
String (文字列) |
ワークスペースの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notary Jurisdictions Delete Notary Jurisdiction
<docusign:delete-v21-current-user-notary-jurisdictions-by-jurisdiction-id>
指定された管轄区域を削除します。この操作では、/v2.1/current_user/notary/jurisdictions/{jurisdictionId} エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Jurisdiction Id (管轄区域 ID) |
String (文字列) |
管轄区域の ID。次の管轄区域がサポートされています。
|
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
APIRequest Log Delete Request Logs
<docusign:delete-v21-diagnostics-request-logs>
要求ログファイルを削除します。この操作では、/v2.1/diagnostics/request_logs エンドポイントに対する HTTP DELETE 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Service Information Get Service Information
<docusign:get-service-information>
使用可能な REST API バージョンを取得します。DocuSign 本番システム: https://www.docusign.net/restapi/service_information DocuSign デモシステム: https://demo.docusign.net/restapi/service_information REST API バージョンとリソースを表示するのにインテグレーターキーは不要です。この操作では、/service_information エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Service Information Get Resource Information
<docusign:get-v21>
DocuSign REST API で使用可能なベースリソースを取得します。REST API バージョンとリソースを表示するのにインテグレーターキーは不要です。たとえば、 https://demo.docusign.net/restapi/v2 では、DocuSign デモシステムの REST API バージョン 2 で使用可能なすべてのベースリソースがリストされます。すべてのバージョンのサービス操作の説明およびサンプルを表示するには、バージョン番号を削除して /help を URL に追加します。たとえば、 https://demo.docusign.net/restapi/help では、XML および JSON の要求と応答のサンプルを含め、DocuSign デモシステムの REST API 操作がリストされます。
この操作では、/v2.1 エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Charges Get Account Billing Charges
<docusign:get-v21-accounts-billing-charges-by-account-id>
アカウントの定期的な料金および使用料金のリストを取得します。これを使用して、料金構造と、料金プラン項目の使用量を確認できます。必要な権限: アカウント管理者。この操作では、/v2.1/accounts/{accountId}/billing_charges エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Include charges (料金を含める) |
String (文字列) |
返す請求料金を指定します。有効な値: * envelopes * seats |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Invoices Get Billing Invoices
<docusign:get-v21-accounts-billing-invoices-by-account-id>
アカウントの請求書のリストを取得します。開始日または終了日のクエリが指定されていない場合、応答では過去 365 日間の請求書が返されます。必要な権限: アカウント管理者。この操作では、/v2.1/accounts/{accountId}/billing_invoices エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
From date (開始日) |
String (文字列) |
取得する、アカウント内の最も古い請求書の日時を指定します。 |
||
To date (終了日) |
String (文字列) |
取得する、アカウント内の最も新しい請求書の日時を指定します。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Invoices Get Billing Invoice
<docusign:get-v21-accounts-billing-invoices-by-account-id-invoice-id>
指定された請求書を取得します。
注意: 応答の pdfAvailable プロパティが true に設定されている場合、請求書の PDF バージョンをダウンロードできます。PDF をダウンロードするには、再度コールして、ヘッダーの Accept プロパティの値を Accept: application/pdf に変更します。
必要な権限: アカウント管理者
応答では、料金のリストと料金に関する情報が返されます。通常、数量は [unlimited (無制限)] または整数として表示されます。金額はアカウントに設定された通貨で表示されます。
この操作では、/v2.1/accounts/{accountId}/billing_invoices/{invoiceId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Invoice Id (請求書 ID) |
String (文字列) |
Invoice Id (請求書 ID) |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Invoices Get Billing Invoices Past Due
<docusign:get-v21-accounts-billing-invoices-past-due-by-account-id>
アカウントの期日を過ぎた請求書のリストとメモ (REST API を介して支払を実行できる場合) を返します。
必要な権限: アカウント管理者
この操作では、/v2.1/accounts/{accountId}/billing_invoices_past_due エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Payments Get Payment List
<docusign:get-v21-accounts-billing-payments-by-account-id>
1 つ以上の支払に関する情報が含まれるリストを取得します。開始日または終了日のクエリが使用されていない場合、応答では過去 365 日間の支払情報が返されます。
必要な権限: アカウント管理者
この操作では、/v2.1/accounts/{accountId}/billing_payments エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
From date (開始日) |
String (文字列) |
取得する、アカウント内の最も古い支払の日時を指定します。 |
||
To date (終了日) |
String (文字列) |
取得する、アカウント内の最も新しい支払の日時を指定します。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Payments Get Payment
<docusign:get-v21-accounts-billing-payments-by-account-id-payment-id>
特定の支払に関する情報を取得します。必要な権限: アカウント管理者。この操作では、/v2.1/accounts/{accountId}/billing_payments/{paymentId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Payment Id (支払い ID) |
String (文字列) |
Payment Id (支払い ID) |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Plan Get Billing Plan
<docusign:get-v21-accounts-billing-plan-by-account-id>
指定されたアカウントの請求プラン情報 (現在の請求プラン、後継プラン、請求先住所、請求クレジットカードなど) を取得します。デフォルトでは、後継プランとクレジットカード情報が応答に含まれます。この情報を応答から除外するには、該当する省略可能なクエリ文字列を追加して false に設定することができます。
応答では、プランの通貨コードを含め請求プラン情報が返されます。
注意: クレジットカード番号情報が表示される場合、応答にマスクが適用されるため、カード番号の最後の 4 桁のみが表示されます。
この操作では、/v2.1/accounts/{accountId}/billing_plan エンドポイントに対する HTTP GET 要求を行います
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Include credit card information (クレジットカード情報を含める) |
String (文字列) |
true に設定すると、クレジットカード情報を含む支払情報が、返される応答に表示されます。 |
||
Include metadata (メタデータを含める) |
String (文字列) |
true に設定すると、 |
||
Include successor plans (後継プランを含める) |
String (文字列) |
true に設定すると、後継情報が応答から除外されます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Plan Get Credit Card Info
<docusign:get-v21-accounts-billing-plan-credit-card-by-account-id>
このメソッドは、アカウントに関連付けられたクレジットカードに関する情報を返します。この操作では、/v2.1/accounts/{accountId}/billing_plan/credit_card エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Plan Get Downgrade Request Billing Info
<docusign:get-v21-accounts-billing-plan-downgrade-by-account-id>
この操作では、/v2.1/accounts/{accountId}/billing_plan/downgrade エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brands Get Brands
<docusign:get-v21-accounts-brands-by-account-id>
このメソッドは、デフォルトのブランドプロファイルを含め、アカウントに関連付けられたすべてのブランドの詳細を返します。
注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。
この操作では、/v2.1/accounts/{accountId}/brands エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Exclude distributor brand (ディストリビューターブランドを除外) |
String (文字列) |
true の場合、ディストリビューターブランド情報が応答セットから除外されます。 |
||
Include logos (ロゴを含める) |
String (文字列) |
true の場合、ブランドに関連付けられたロゴの URI が応答に含まれます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brand Get Brand
<docusign:get-v21-accounts-brands-by-account-id-brand-id>
このメソッドはアカウントブランドの詳細を返します。
注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。
この操作では、/v2.1/accounts/{accountId}/brands/{brandId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Brand Id (ブランド ID) |
String (文字列) |
ブランドの ID。 |
x |
|
Include external references (外部参照を含める) |
String (文字列) |
true の場合、ブランドに関連付けられたランディングページとリンクが応答に含まれます。 |
||
Include logos (ロゴを含める) |
String (文字列) |
true の場合、ブランドに関連付けられたロゴの URI が応答に含まれます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brand Export Get Brand Export File
<docusign:get-v21-accounts-brands-file-by-account-id-brand-id>
このメソッドではブランドに関する情報を XML ファイルにエクスポートします。
注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。
この操作では、/v2.1/accounts/{accountId}/brands/{brandId}/file エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Brand Id (ブランド ID) |
String (文字列) |
ブランドの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brand Logo Get Brand Logo
<docusign:get-v21-accounts-brands-logos-by-account-id-brand-id-logo-type>
このメソッドは、ブランドで使用される特定のロゴを返します。
注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。
この操作では、/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Brand Id (ブランド ID) |
String (文字列) |
ブランドの ID。 |
x |
|
Logo Type (ロゴタイプ) |
String (文字列) |
ロゴのタイプ。有効な値: - |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brand Resources Get Brand Resources List
<docusign:get-v21-accounts-brands-resources-by-account-id-brand-id>
このメソッドは、アカウントに関連付けられたブランディングリソースに関するメタデータを返します。
注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。
この操作では、/v2.1/accounts/{accountId}/brands/{brandId}/resources エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Brand Id (ブランド ID) |
String (文字列) |
ブランドの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brand Resources Get Brand Resources
<docusign:get-v21-accounts-brands-resources-by-account-id-brand-id-resource-content-type>
このメソッドは特定のブランディングリソースファイルを返します。ブランドでは、送信、署名、メールメッセージ、および埋め込み署名環境の制御に一連のブランドリソースファイルが使用されます。これらのファイルでデフォルトのメールメッセージと形式を変更し、ファイルをブランドにアップロードして、ユーザーエクスペリエンスをカスタマイズできます。
重要: 変更したリソースファイルをアップロードすると、マスターリソースファイルとは異なる要素のみがリソースファイルとして保存されます。同様に、リソースファイルをダウンロードすると、変更した要素のみがファイルに含まれます。
注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。
この操作では、/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Brand Id (ブランド ID) |
String (文字列) |
ブランドの ID。 |
x |
|
Resource Content Type (リソースコンテンツタイプ) |
String (文字列) |
返すブランドリソースファイルの種別。有効な値: - |
x |
|
langcode (言語コード) |
String (文字列) |
ブランドでサポートされる言語の ISO 3166-1 alpha-2 コード。 |
||
Return master (マスターを返す) |
String (文字列) |
返すリソースファイルデータを指定します。true の場合、マスターリソースファイルのみが返されます。false の場合、変更した要素のみが返されます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2Batch Get Bulk Send Batches
<docusign:get-v21-accounts-bulk-send-batch-by-account-id>
この操作では、/v2.1/accounts/{accountId}/bulk_send_batch エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Batch ids (バッチ ID) |
String (文字列) |
Batch ids (バッチ ID) |
||
count (数) |
String (文字列) |
返す結果の最大数。 |
||
Start position (開始位置) |
String (文字列) |
どの位置以降の値を返すかを示す、合計結果セット内の開始位置。thumbnail の値を使用すると、ページ画像を返すことができます。 |
||
status (状況) |
String (文字列) |
項目の状況。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2Batch Get Bulk Send Batch Status
<docusign:get-v21-accounts-bulk-send-batch-by-account-id-bulk-send-batch-id>
この操作では、/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Bulk Send Batch Id (一括送信バッチ ID) |
String (文字列) |
Bulk Send Batch Id (一括送信バッチ ID) |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2CRUD Get Bulk Send Lists
<docusign:get-v21-accounts-bulk-send-lists-by-account-id>
このメソッドは、現在のユーザーに属している一括送信リストのリストと、各リストの基本情報を返します。この操作では、/v2.1/accounts/{accountId}/bulk_send_lists エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2CRUD Get Bulk Send List
<docusign:get-v21-accounts-bulk-send-lists-by-account-id-bulk-send-list-id>
このメソッドは、現在のユーザーに属している特定の一括送信リストに関連付けられたすべての詳細を返します。この操作では、/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Bulk Send List Id (一括送信リスト ID) |
String (文字列) |
一括送信リストの GUID。このプロパティは、新しい一括送信リストを投稿した後に作成されます。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Accounts Get Account
<docusign:get-v21-accounts-by-account-id>
指定されたアカウントのアカウント情報を取得します。
応答 canUpgrade プロパティには、API を介してアカウントをアップグレードできるかどうかを示すブール値が含まれます。
この操作では、/v2.1/accounts/{accountId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Include account settings (アカウント設定を含める) |
String (文字列) |
true に設定すると、([ |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Chunked Uploads Get Chunked Upload
<docusign:get-v21-accounts-chunked-uploads-by-account-id-chunked-upload-id>
チャンクアップロードの詳細を返します (ただしコンテンツは返しません)。
注意: 期限切れになったか、削除されたか、他のアクションでコンシュームされたチャンクアップロードの詳細は取得できません。
この操作では、/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Chunked Upload Id (チャンクアップロード ID) |
String (文字列) |
チャンクアップロードの ID。 |
x |
|
include (含める) |
String (文字列) |
(省略可能) このパラメーターを使用すると、追加の属性データを応答に含めることができます。このメソッドの有効な値は |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Get Connect Configs
<docusign:get-v21-accounts-connect-by-account-id>
指定されたアカウントのすべてのカスタム DocuSign Connect 定義を取得します。
注意: この関数を使用するには、アカウントで Connect が有効になっている必要があります。Box、eOriginal、または Salesforce の Connect 設定に関する情報は取得しません。
この操作では、/v2.1/accounts/{accountId}/connect エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Get Connect Config
<docusign:get-v21-accounts-connect-by-account-id-connect-id>
指定された DocuSign Connect 設定に関する情報を取得します。
注意: この関数を使用するには、アカウントで Connect が有効になっている必要があります。
この操作では、/v2.1/accounts/{accountId}/connect/{connectId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Connect Id (Connect ID) |
String (文字列) |
アクセスするカスタム Connect 設定の ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Failures Get Connect Logs
<docusign:get-v21-accounts-connect-failures-by-account-id>
Connec エラーログ情報を取得します。このログを使用して、POST に失敗したエンベロープを確認し、再パブリッシュ要求を作成できます。この操作では、/v2.1/accounts/{accountId}/connect/failures エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
From date (開始日) |
String (文字列) |
日付範囲の開始日 (UTC 日時形式)。 注意: このプロパティが null の場合、日付検索条件は適用されません。 |
||
To date (終了日) |
String (文字列) |
検索日付範囲の終了 (UTC 日時形式)。このパラメーターを使用すると、この日時までに作成されたテンプレートのみが返されます。 注意: このプロパティが null の場合、値はデフォルトで現在の日付になります。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Log Get Connect Logs
<docusign:get-v21-accounts-connect-logs-by-account-id>
アカウントの Connect ログエントリのリストを取得します。
注意: ロギングを有効にするには、Connect 設定の enableLog を true に設定する必要があります。ロギングが有効になっていない場合、ログエントリは記録されません。
この操作では、/v2.1/accounts/{accountId}/connect/logs エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
From date (開始日) |
String (文字列) |
日付範囲の開始日 (UTC 日時形式)。 注意: このプロパティが null の場合、日付検索条件は適用されません。 |
||
To date (終了日) |
String (文字列) |
検索日付範囲の終了 (UTC 日時形式)。このパラメーターを使用すると、この日時までに作成されたテンプレートのみが返されます。 注意: このプロパティが null の場合、値はデフォルトで現在の日付になります。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Log Get Connect Log
<docusign:get-v21-accounts-connect-logs-by-account-id-log-id>
アカウントの指定された Connect ログエントリを取得します。
注意: ロギングを有効にするには、Connect 設定の enableLog を true に設定する必要があります。ロギングが有効になっていない場合、ログエントリは記録されません。
この操作では、/v2.1/accounts/{accountId}/connect/logs/{logId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Log Id (ログ ID) |
String (文字列) |
Connect ログエントリの ID。 |
x |
|
Additional info (追加情報) |
String (文字列) |
true に設定すると、応答に |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Get Connect Users
<docusign:get-v21-accounts-connect-users-by-account-id-connect-id>
設定済みの Connect サービスからユーザーを返します。この操作では、/v2.1/accounts/{accountId}/connect/{connectId}/users エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Connect Id (Connect ID) |
String (文字列) |
アクセスするカスタム Connect 設定の ID。 |
x |
|
List included users (含まれているユーザーをリスト) |
String (文字列) |
List included users (含まれているユーザーをリスト) |
||
count (数) |
String (文字列) |
省略可能。返す項目の数。 |
||
Email substring (メールのサブ文字列) |
String (文字列) |
返されたユーザーレコードを完全なメールアドレスまたはメールアドレスのサブ文字列で絞り込みます。 |
||
User name substring (ユーザー名のサブ文字列) |
String (文字列) |
結果を完全なユーザー名または部分的なユーザー名に基づいて絞り込みます。 注意: 部分的なユーザー名を入力する場合、ワイルドカード文字は使用しません。 |
||
status (状況) |
String (文字列) |
結果をユーザーの状況で絞り込みます。次の状況のカンマ区切りリストを指定できます。* ActivationRequired * ActivationSent * Active * Closed * Disabled |
||
Start position (開始位置) |
String (文字列) |
どの位置以降の値を返すかを示す、合計結果セット内の開始位置。thumbnail の値を使用すると、ページ画像を返すことができます。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Consumer Disclosure Get Consumer Disclosure
<docusign:get-v21-accounts-consumer-disclosure-by-account-id>
アカウントに関連付けられたデフォルトの HTML 形式の「電子記録および電子署名の開示条件 (ERSD)」を取得します。DocuSign が提供するデフォルトの ERSD 開示条件は、米国を拠点とするお客様の便宜のためにのみ提供されます。このデフォルトの開示条件は、米国を拠点とする当事者間の取引でのみ有効です。取得する開示条件の言語を設定するには、省略可能な langCode クエリパラメーターを使用します。
この操作では、/v2.1/accounts/{accountId}/consumer_disclosure エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Lang Code (言語コード) |
String (文字列) |
(省略可能) 取得する開示条件の署名者言語バージョンのコード。サポートされる言語: - アラビア語 ( |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Consumer Disclosure Get Consumer Disclosure Lang Code
<docusign:get-v21-accounts-consumer-disclosure-by-account-id-lang-code>
アカウントに関連付けられた HTML 形式の「電子記録および電子署名の開示条件 (ERSD)」を取得します。取得する開示条件の言語を設定するには、省略可能な langCode クエリパラメーターを使用します。
注意: デフォルトの開示条件テキストの言語は常に英語ですが、カスタムの開示条件を使用しており、異なる署名者言語でいくつかのバージョンを作成している場合は、langCode パラメーターを使用して、取得する署名者言語バージョンを指定できます。
この操作では、/v2.1/accounts/{accountId}/consumer_disclosure/{langCode} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Lang Code (言語コード) |
String (文字列) |
(省略可能) 取得する開示条件の署名者言語バージョンのコード。サポートされる言語: - アラビア語 ( |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Contacts Get Contact By Id
<docusign:get-v21-accounts-contacts-by-account-id-contact-id>
このメソッドは、DocuSign アカウントに関連付けられている 1 人以上の取引先責任者を返します。cloud_provider クエリパラメーターを使用すると、接続済みの[クラウドストレージ][CloudStorage]プロバイダーから取引先責任者を取得することもできます。デフォルトでは、取引先責任者は DocuSign アカウントのデフォルトのアドレスブックから取得されます。特定の取引先責任者を返すには、contactId クエリパラメーターを使用します。アカウントに関連付けられたすべての取引先責任者を返すには、このパラメーターを省略します。[CloudStorage]: /esign-rest-api/reference/CloudStorage/
この操作では、/v2.1/accounts/{accountId}/contacts/{contactId} エンドポイントに対する HTTP GET 要求を行います
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Contact Id (取引先責任者 ID) |
String (文字列) |
アカウントのアドレスブック内の取引先責任者の ID。 |
x |
|
Cloud provider (クラウドプロバイダー) |
String (文字列) |
(省略可能) 取引先責任者の取得元であるクラウドプロバイダー。有効な値: - |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Custom Fields Get Account Custom Fields
<docusign:get-v21-accounts-custom-fields-by-account-id>
このメソッドは、アカウントに関連付けられたエンベロープおよび文書のカスタム項目のリストを返します。この操作では、/v2.1/accounts/{accountId}/custom_fields エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Attachments Get Attachments
<docusign:get-v21-accounts-envelopes-attachments-by-account-id-envelope-id>
添付ファイルを取得します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments エンドポイントに対する HTTP GET 要求を行います
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Attachments Get Attachment
<docusign:get-v21-accounts-envelopes-attachments-by-account-id-envelope-id-attachment-id>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Attachment Id (アタッチメント ID) |
String (文字列) |
添付ファイルの一意の識別子。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Audit Events Get Audit Events
<docusign:get-v21-accounts-envelopes-audit-events-by-account-id-envelope-id>
指定されたエンベロープのエンベロープ監査イベントを取得します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelopes Get Envelopes
<docusign:get-v21-accounts-envelopes-by-account-id>
要求に一致するエンベロープのリストを取得します。多数の省略可能な検索条件を使用して、日付、エンベロープ ID、または状況コードで絞り込むことができます。要求には次のパラメーターを 1 つ以上含める必要があります。
-
from_date -
envelope_ids -
transaction_ids
transaction_ids を使用したエンベロープの状況の取得はオフライン署名の状況で役立ちます。これを使用して、エンベロープが作成されたかどうかを判断できます。エンベロープの状況が返される前にネットワーク接続が失われた場合にこれを使用できます。
不必要なデータベースクエリを回避するため、DocuSign 署名プラットフォームは、まず要求をチェックして、指定された検索条件セットでゼロサイズの応答が生成されないことを確認してからデータベースを照会します。たとえば、要求の from_to_status が delivered で現在の status が created,sent の場合、DocuSign は常に空のリストを返します。これは要求が「from_date から to_date の間に配信されたエンベロープのうち、現在の状況が created または sent のエンベロープを検索する」と解釈されるためです。配信されたエンベロープは created または sent の状況になる可能性はないため、ゼロサイズの応答が生成されます。
この場合、DocuSign ではデータベースを照会することなく空のリストをすぐに返します。次の表に、要求内の各状況修飾子 (from_to_status パラメーター) に対する有効な現在のエンベロープ状況 (status パラメーター) を示します。
API 要求内の状況と状況修飾子に [有効な現在の状況] 列で示された値が含まれない場合、空のリストが返されます。クライアントアプリケーションでは、要求している状況 (status パラメーター) が、指定された from_to_status パラメーター値にとって意味のあるものかどうかを確認する必要があります。
状況修飾子 (from_to_status) |
有効な状況修飾子 | 有効な現在の状況 |
|---|---|---|
any (changed) (任意 (変更済み)) |
StatusChanged |
any (任意)、created (作成済み)、sent (送信済み)、delivered (配信済み)、signed (署名済み)、completed (完了)、declined (拒否済み)、voided (取り消し済み)、deleted (削除済み) |
created (作成済み) |
Created (作成済み) |
any (任意)、created (作成済み)、sent (送信済み)、delivered (配信済み)、signed (署名済み)、completed (完了)、declined (拒否済み)、voided (取り消し済み)、deleted (削除済み) |
sent (送信済み) |
Sent |
any (任意)、sent (送信済み)、delivered (配信済み)、signed (署名済み)、completed (完了)、declined (拒否済み)、voided (取り消し済み)、deleted (削除済み) |
delivered (配信済み) |
StatusChanged |
any (任意)、delivered (配信済み)、signed (署名済み)、completed (完了)、declined (拒否済み)、voided (取り消し済み)、deleted (削除済み) |
signed (符号あり) |
StatusChanged |
any (任意)、signed (署名済み)、completed (完了)、declined (拒否済み)、voided (取り消し済み)、deleted (削除済み) |
completed (完了) |
Completed (完了) |
any (任意)、completed (完了)、declined (拒否済み)、voided (取り消し済み)、deleted (削除済み) |
declined (拒否済み) |
StatusChanged |
any (任意)、declined (拒否済み)、voided (取り消し済み)、deleted (削除済み) |
timedout (タイムアウト) では常にゼロの結果が返される |
StatusChanged |
any (任意)、voided (取り消し済み)、deleted (削除済み) |
voided (取り消し済み) |
Voided |
any (任意)、voided (取り消し済み)、deleted (削除済み) |
delete (削除済み) |
StatusChanged |
無関係な結果
場合によって、特定のエンベロープ状況の要求で他の状況のエンベロープが含まれることがあります。たとえば、from_date が 2017-01-01、to_date が 2017-01-07、状況修飾子 (from_to_status) が delivered に設定されている要求では、この期間に作成され、この期間に配信されなかったエンベロープが応答セットに含まれる場合があります。回避策として、必要に応じて結果セット内でエンベロープの状況値を確認します。
この操作では、/v2.1/accounts/{accountId}/envelopes エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Include purge information (パージ情報を含める) |
String (文字列) |
true に設定すると、削除されたエンベロープに関する情報が応答に含まれます。 |
||
Continuation token (継続トークン) |
String (文字列) |
前の API コールの応答に返されたトークン。これを使用して、検索クエリを特定の位置から再開します。 |
||
count (数) |
String (文字列) |
省略可能。返す項目の数。現在、返すことができる項目数に対する暗黙的な最大制限はありません。 |
||
From to status (期間の状況) |
String (文字列) |
確認するエンベロープ状況。可能な値: - |
||
Email (メール) |
String (文字列) |
このメールアドレスを持つアカウントユーザーが送信したエンベロープに結果を制限します。 |
||
Search text (検索テキスト) |
String (文字列) |
返されるエンベロープのリストを絞り込むために使用できる自由テキストの検索条件。 |
||
Ac status (AC 状況) |
String (文字列) |
エンベロープの正式コピー (Authoritative Copy) の状況を指定します。可能な値: - |
||
Envelope ids (エンベロープ ID) |
String (文字列) |
|
||
Folder types (フォルダー種別) |
String (文字列) |
エンベロープの取得元であるフォルダー種別のカンマ区切りリスト。有効な値: - |
||
powerformids (PowerForm ID) |
String (文字列) |
|
||
User ID (ユーザー ID) |
String (文字列) |
取得するエンベロープを作成したユーザーの ID。アカウントには複数のユーザーが含まれている可能性があります。アカウントアクセス権を持つユーザーはアカウントから user_id でエンベロープを取得できます。 |
||
block (ブロック) |
String (文字列) |
DocuSign 用に予約済み。 |
||
Requester date format (リクエスターの日付形式) |
String (文字列) |
Requester date format (リクエスターの日付形式) |
||
User filter (検索条件を使用) |
String (文字列) |
現在のユーザーが受信者、送信者、または受信者のみになっているエンベロープを返します。(例: |
||
注文 |
String (文字列) |
エンベロープを昇順 ( |
||
status (状況) |
String (文字列) |
応答に含める現在のエンベロープの状況のカンマ区切りリスト。可能な値: * |
||
Intersecting folder ids (交差フォルダー ID) |
String (文字列) |
エンベロープの取得元であるフォルダーのカンマ区切りリスト。有効な値: - |
||
Query budget (クエリバジェット) |
String (文字列) |
データを返すまでにクエリが実行される時間 (秒)。 |
||
Order by (並び替え基準) |
String (文字列) |
特定のプロパティに従って結果を並び替えます。有効な値: - |
||
include (含める) |
String (文字列) |
エンベロープに関して返す追加の情報を指定します。カンマ区切りリスト ( |
||
Custom field (カスタム項目) |
String (文字列) |
省略可能。エンベロープ内で検索するカスタムエンベロープ項目の名前と値を指定します。形式: |
||
From date (開始日) |
String (文字列) |
状況の変化の検索をどの日時から開始するかを指定します。 |
||
exclude (除外) |
String (文字列) |
応答から情報を除外します。カンマ区切りリスト ( |
||
Last queried date (最終クエリ日) |
String (文字列) |
指定された日時よりも前に変更されたエンベロープを返します。例: |
||
Folder ids (フォルダー ID) |
String (文字列) |
特定のフォルダーからエンベロープを返します。有効なフォルダー GUID または次の値のカンマ区切りリストとして入力します: - |
||
Cdse mode (CDSE モード) |
String (文字列) |
DocuSign 用に予約済み。 |
||
ユーザー名 |
String (文字列) |
このユーザー名を持つアカウントユーザーが送信したエンベロープに結果を制限します。 |
||
Start position (開始位置) |
String (文字列) |
この値はサポートされており、現在、暗黙的な最大項目数はありません。 |
||
Transaction ids (トランザクション ID) |
String (文字列) |
エンベロープのトランザクション ID のカンマ区切りリスト。トランザクション ID は 7 日間のみ有効です。 |
||
To date (終了日) |
String (文字列) |
状況の変化の検索を停止する日時を指定します。デフォルトは現在の日時です。NET システムライブラリの [ |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelopes Get Envelope
<docusign:get-v21-accounts-envelopes-by-account-id-envelope-id>
指定されたエンベロープの全体的な状況を取得します。エンベロープのリストの状況を取得するには、 Envelope: listStatusChanges を使用します。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Advanced update (高度な更新) |
String (文字列) |
true の場合、エンベロープ情報を追加または変更できます。 |
||
include (含める) |
String (文字列) |
エンベロープに関して返す追加の情報を指定します。カンマ区切りリスト ( |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Comments Get Comments Transcript
<docusign:get-v21-accounts-envelopes-comments-transcript-by-account-id-envelope-id>
送信者および受信者がエンベロープ内の文書に追加したすべてのコメントが含まれる PDF ファイルを取得します。
注意: デフォルトではコメントは無効になっています。コメント機能を使用するには、アカウント管理者はアカウントでコメントを有効にする (accountSettingsInformation オブジェクトで enableSigningExtensionComments プロパティを true に設定する) 必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
encoding |
String (文字列) |
(省略可能) ファイルで使用するエンコード。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Custom Fields Get Custom Fields
<docusign:get-v21-accounts-envelopes-custom-fields-by-account-id-envelope-id>
指定されたエンベロープのカスタム項目情報を取得します。この項目をアカウントのエンベロープで使用して、エンベロープに関する情報を記録したり、エンベロープの検索を容易にしたり、情報を追跡したりできます。カスタムエンベロープ項目は、ユーザーが DocuSign メンバーコンソールでエンベロープを作成するときに [Envelope Settings (エンベロープ設定)] セクションに表示されます。カスタムエンベロープ項目はエンベロープ受信者には表示されません。カスタムエンベロープ項目にはテキストとリストの 2 つの種別があります。テキストのカスタム項目では、送信者は項目の値を入力できます。リストのカスタム項目では、送信者は項目の値を、あらかじめ作成されたリストから選択できます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Documents Get Documents
<docusign:get-v21-accounts-envelopes-documents-by-account-id-envelope-id>
指定されたエンベロープに関連付けられた文書のリストを取得します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Include tabs (タブを含める) |
String (文字列) |
true に設定すると、文書に関連付けられたタブに関する情報が応答に含まれます。 |
||
Shared user ID (共有ユーザー ID) |
String (文字列) |
文書リストのビューを取得するために偽装する共有ユーザーの ID。このパラメーターは共有受信箱のコンテキストで (つまり、RADmin コンソールを使用してユーザー間でエンベロープを共有する場合に) 使用します。 |
||
Include metadata (メタデータを含める) |
String (文字列) |
true に設定すると、送信者が編集できるプロパティが示されているメタデータが応答に含まれます。 |
||
Include document size (文書サイズを含める) |
String (文字列) |
Include document size (文書サイズを含める) |
||
Documents by userid (ユーザー ID での文書の取得) |
String (文字列) |
true に設定すると、受信者はユーザー ID で文書を取得できます。 たとえば、表示が異なる 2 つの異なるルーティング順序にユーザーが含まれる場合、このパラメーターを使用すると、両方のルーティング順序からすべての文書が返されます。 |
||
Recipient ID (受信者 ID) |
String (文字列) |
送信者は、制御する受信者の 1 人として文書を取得できます。これを機能させるには、 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Documents Get Document
<docusign:get-v21-accounts-envelopes-documents-by-account-id-envelope-id-document-id>
指定された文書をエンベロープから取得します。アカウントで [Highlight Data Changes (データ変更の強調表示)] 機能が有効になっている場合は、エンベロープ内の変更を強調表示するように要求するオプションがあります。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
このパラメーターでは次の特殊キーワードを使用します。- |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
certificate (証明書) |
String (文字列) |
false に設定すると、エンベロープの署名証明書がダウンロードから削除されます。 |
||
Shared user ID (共有ユーザー ID) |
String (文字列) |
文書リストのビューを取得するために偽装する共有ユーザーの ID。このパラメーターは共有受信箱のコンテキストで (つまり、RADmin コンソールを使用してユーザー間でエンベロープを共有する場合に) 使用します。 |
||
暗号化 |
String (文字列) |
true に設定すると、DocuSign アカウントで設定されているすべての Key Manager で、応答に返される PDF バイトが暗号化されます。文書は、Key Manager DecryptDocument API メソッドを使用して復号化できます。Key Manager についての詳細は、DocuSign から組織に提供されている『DocuSign Security Appliance Installation Guide (DocuSign セキュリティアプライアンスインストールガイド)』を参照してください。 |
||
encoding |
String (文字列) |
DocuSign 用に予約済み。 |
||
Documents by userid (ユーザー ID での文書の取得) |
String (文字列) |
true に設定すると、受信者はユーザー ID で文書を取得できます。 たとえば、表示が異なる 2 つの異なるルーティング順序にユーザーが含まれる場合、このパラメーターを使用すると、両方のルーティング順序からすべての文書が返されます。 |
||
言語 |
String (文字列) |
応答内の完了証明書の言語を指定します。サポートされる言語: 中国語 (簡体字) (zh_CN)、中国語 (繁体字) (zh_TW)、オランダ語 (nl)、英語 (米国) (en)、フランス語 (fr)、ドイツ語 (de)、イタリア語 (it)、日本語 (ja)、韓国語 (ko)、ポルトガル語 (pt)、ポルトガル語 (ブラジル) (pt_BR)、ロシア語 (ru)、スペイン語 (es)。 |
||
Show changes (変更を表示) |
String (文字列) |
true に設定すると、返された PDF の変更された項目が黄色で強調表示され、省略可能な署名とイニシャルが赤で囲まれます。 |
||
Recipient ID (受信者 ID) |
String (文字列) |
送信者は、制御する受信者の 1 人として文書を取得できます。これを機能させるには、 |
||
ウォーターマーク |
String (文字列) |
true に設定すると、アカウントでウォーターマーク機能が有効になっており、エンベロープが完了していない場合、アカウントのウォーターマークが PDF 文書に追加されます。このオプションではウォーターマークを削除できます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Document Fields Get Document Fields
<docusign:get-v21-accounts-envelopes-documents-fields-by-account-id-envelope-id-document-id>
既存のエンベロープ文書からカスタム文書項目の情報を取得します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Get Envelope Document Html Definitions
<docusign:get-v21-accounts-envelopes-documents-html-definitions-by-account-id-envelope-id-document-id>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Pages Get Page Images
<docusign:get-v21-accounts-envelopes-documents-pages-by-account-id-envelope-id-document-id>
指定されたパラメーターに基づいて、文書内のページの表示用の画像を返します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Max width (最大幅) |
String (文字列) |
返される画像の最大幅をピクセル単位で設定します。 |
||
count (数) |
String (文字列) |
返す結果の最大数。 |
||
Max height (最大高さ) |
String (文字列) |
返される画像の最大高さをピクセル単位で設定します。 |
||
dpi |
String (文字列) |
結果の画像の 1 インチあたりのドット数 (DPI)。有効な値は 1-310 DPI です。デフォルト値は 94 です。 |
||
nocache |
String (文字列) |
true の場合、キャッシュの使用が無効化され、画像情報はデータベースから取得されます。 デフォルト値は True です。 |
||
Show changes (変更を表示) |
String (文字列) |
true の場合、変更がユーザーインターフェースに表示されます。 |
||
Start position (開始位置) |
String (文字列) |
どの位置以降の値を返すかを示す、合計結果セット内の開始位置。thumbnail の値を使用すると、ページ画像を返すことができます。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Pages Get Page Image
<docusign:get-v21-accounts-envelopes-documents-pages-page-image-by-account-id-envelope-id-document-id-page-number>
文書内のページの表示用の画像を返します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Page Number (ページ番号) |
String (文字列) |
アクセスするページ番号。 |
x |
|
dpi |
String (文字列) |
返される画像の 1 インチあたりのドット数 (DPI) を設定します。 |
||
Max height (最大高さ) |
String (文字列) |
ページ画像の最大高さをピクセル単位で設定します。DPI はこの設定に基づいて再計算されます。 |
||
Max width (最大幅) |
String (文字列) |
ページ画像の最大幅をピクセル単位で設定します。DPI はこの設定に基づいて再計算されます。 |
||
Show changes (変更を表示) |
String (文字列) |
true の場合、変更がユーザーインターフェースに表示されます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Get Page Tabs
<docusign:get-v21-accounts-envelopes-documents-pages-tabs-by-account-id-envelope-id-document-id-page-number>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Page Number (ページ番号) |
String (文字列) |
アクセスするページ番号。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Get Document Tabs
<docusign:get-v21-accounts-envelopes-documents-tabs-by-account-id-envelope-id-document-id>
このメソッドは文書に関連付けられたタブを返します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Page numbers (ページ番号) |
String (文字列) |
指定されたページのタブに絞り込みます。ページ GUID のカンマ区切りリストとして入力します。例: |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Get Document Templates
<docusign:get-v21-accounts-envelopes-documents-templates-by-account-id-envelope-id-document-id>
指定されたエンベロープ内の文書に関連付けられたテンプレートを取得します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
include (含める) |
String (文字列) |
結果を制限するカンマ区切りリスト。有効な値: * |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Email Settings Get Email Settings
<docusign:get-v21-accounts-envelopes-email-settings-by-account-id-envelope-id>
指定されたエンベロープのメール上書き設定を取得します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Form Data Get Form Data
<docusign:get-v21-accounts-envelopes-form-data-by-account-id-envelope-id>
このメソッドでは、自分が送信したか自分が共有している処理中のエンベロープ、完了したエンベロープ、またはキャンセルされたエンベロープからエンベロープと項目データをダウンロードします。アカウントの完全な管理者でもある受信者は、アカウントの別のユーザーが自分に送信したエンベロープのフォームデータを表示できます。
注意: この機能を使用するには、アカウントの [Sending Setting (送信設定)] の [Allow sender to download form data (差出人にフォームデータのダウンロードを許可する)] を有効にする必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Get Envelope Html Definitions
<docusign:get-v21-accounts-envelopes-html-definitions-by-account-id-envelope-id>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Lock Get Envelope Lock
<docusign:get-v21-accounts-envelopes-lock-by-account-id-envelope-id>
エンベロープのロックに関する一般情報を取得します。ロックしたユーザーからコールが実行され、要求に元のインテグレーターキーと同じインテグレーターキーが含まれる場合、X-DocuSign-Edit ヘッダーと追加のロック情報が応答に含まれます。ユーザーはこの情報を使用して、失われた編集セッショントークンと X-DocuSign-Edit ヘッダーを回復できます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notification Get Envelopes Envelope Id Notification
<docusign:get-v21-accounts-envelopes-notification-by-account-id-envelope-id>
エンベローブ通知、リマインダー、有効期限など、既存のエンベロープの情報を取得します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Get Recipients
<docusign:get-v21-accounts-envelopes-recipients-by-account-id-envelope-id>
1 つのエンベロープ内のすべての受信者の状況を取得し、ルーティングリスト内の現在の受信者を識別します。このメソッドを使用してタブ値を取得することもできます。応答の currentRoutingOrder プロパティには現在の受信者の routingOrder 値が含まれます。これは、この受信者にエンベロープは送信されたが受信者がアクションを完了していないことを示します。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Include anchor tab locations (アンカータブの場所を含める) |
String (文字列) |
true に設定し、 |
||
Include extended (拡張を含める) |
String (文字列) |
true に設定すると、拡張プロパティが応答に含まれます。 |
||
Include metadata (メタデータを含める) |
String (文字列) |
受信者 (テンプレートではなくエンベロープの受信者のみ) に関連付けられたメタデータを含めるかどうかを指定するブール値。 |
||
Include tabs (タブを含める) |
String (文字列) |
true に設定すると、受信者に関連付けられたタブ情報が応答に含まれます。このパラメーターを指定しない場合、デフォルトの動作 (false) になります。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id
<docusign:get-v21-accounts-envelopes-recipients-consumer-disclosure-by-account-id-envelope-id-recipient-id>
指定されたエンベロープのデフォルトの HTML 形式の「電子記録および電子署名の開示条件 (ERSD)」を取得します。DocuSign が提供するデフォルトの ERSD 開示条件は、米国を拠点とするお客様の便宜のためにのみ提供されます。このデフォルトの開示条件は、米国を拠点とする当事者間の取引でのみ有効です。取得する開示条件の言語を設定するには、省略可能な langCode クエリパラメーターを使用します。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Lang Code (言語コード) |
String (文字列) |
(省略可能) 取得する開示条件の署名者言語バージョンのコード。サポートされる言語: - アラビア語 ( |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id Lang Code
<docusign:get-v21-accounts-envelopes-recipients-consumer-disclosure-by-account-id-envelope-id-recipient-id-lang-code>
指定されたエンベロープ受信者の HTML 形式の「電子記録および電子署名の開示条件 (ERSD)」を取得します。エンベロープに適用された署名ブランドと受信者の言語設定によっては、この開示条件はアカウントレベルの開示条件とは異なる場合があります。取得する開示条件の言語を設定するには、langCode をパスパラメーターまたはクエリパラメーターとして指定します。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Lang Code (言語コード) |
String (文字列) |
(省略可能) 取得する開示条件の署名者言語バージョンのコード (パスパラメーターとして)。サポートされる言語: - アラビア語 ( |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Lang Code (言語コード) |
String (文字列) |
(省略可能) 取得する開示条件の署名者言語バージョンのコード (クエリパラメーターとして)。サポートされる言語: - アラビア語 ( |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Get Recipient Document Visibility
<docusign:get-v21-accounts-envelopes-recipients-document-visibility-by-account-id-envelope-id-recipient-id>
このメソッドは、受信者の文書表示に関する情報を返します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Get Recipient Initials Image
<docusign:get-v21-accounts-envelopes-recipients-initials-image-by-account-id-envelope-id-recipient-id>
指定されたユーザーのイニシャル画像を取得します。画像はアップロードされたときと同じ形式で返されます。要求では、画像と共にクローム (イニシャル画像の周囲に追加された線と識別子) を返すかどうかを指定できます。エンドポイントで指定されたユーザー ID は認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーはアカウントのメンバーである必要があります。
signatureIdOrName パラメーターでは署名 ID または署名の名前を受け入れます。名前によっては適切に URL エンコードされない文字が含まれている場合があるため、署名 ID (signatureId) を使用することをお勧めします。ユーザー名を使用する場合、名前にスペースが含まれている可能性があります。エンドポイントでこの名前を使用する前に名前を URL エンコードすることが必要になる場合があります。たとえば、「Bob Smith」を「Bob%20Smith」にエンコードします。古いエンベロープにはクローム化画像のみが含まれている場合があります。クローム化されていない画像の取得が失敗する場合は、クローム化画像を取得してください。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Include chrome (クロームを含める) |
String (文字列) |
イニシャル画像の周囲に追加された線と識別子。注意: 古いエンベロープにはクローム化画像のみが含まれている場合があります。クローム化されていない画像の取得が失敗する場合は、クローム化画像を取得してください。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Get Recipient Signature
<docusign:get-v21-accounts-envelopes-recipients-signature-by-account-id-envelope-id-recipient-id>
署名者または直接署名受信者の署名情報を取得します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Get Recipient Signature Image
<docusign:get-v21-accounts-envelopes-recipients-signature-image-by-account-id-envelope-id-recipient-id>
指定されたユーザー署名画像を取得します。画像はアップロードされたときと同じ形式で返されます。要求では、画像と共にクローム (イニシャル画像の周囲に追加された線と識別子) を返すかどうかを指定できます。
エンドポイントで指定されたユーザー ID は認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーはアカウントのメンバーである必要があります。
signatureIdOrName パラメーターでは署名 ID または署名の名前を受け入れます。名前によっては適切に URL エンコードされない文字が含まれている場合があるため、署名 ID (signatureId) を使用することをお勧めします。ユーザー名を使用する場合、名前にスペースが含まれている可能性があります。エンドポイントでこの名前を使用する前に名前を URL エンコードすることが必要になる場合があります。たとえば、「Bob Smith」を「Bob%20Smith」にエンコードします。古いエンベロープにはクローム化画像のみが含まれている場合があります。クローム化されていない画像の取得が失敗する場合は、クローム化画像を取得してください。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Include chrome (クロームを含める) |
String (文字列) |
true に設定すると、応答には署名画像のクローム化バージョンが含まれます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Get Recipient Tabs
<docusign:get-v21-accounts-envelopes-recipients-tabs-by-account-id-envelope-id-recipient-id>
受信者に関連付けられたタブに関する情報を取得します。1 つの API コールを実行して、ドラフトのエンベロープに加えて特定の完了したエンベロープからすべてのタブ値と情報を取得できます。タブ値は、クエリパラメーターの include_tabs を「true」に設定した EnvelopeRecipients:list メソッドを使用して取得できます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Include anchor tab locations (アンカータブの場所を含める) |
String (文字列) |
true に設定すると、アンカータブプロパティを持つすべてのタブが応答に含まれます。デフォルト値は false です。 |
||
Include metadata (メタデータを含める) |
String (文字列) |
true に設定すると、応答には編集可能なプロパティを示すメタデータが含まれます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Blob Get Tabs Blob
<docusign:get-v21-accounts-envelopes-tabs-blob-by-account-id-envelope-id>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Get Envelope Templates
<docusign:get-v21-accounts-envelopes-templates-by-account-id-envelope-id>
エンベロープで使用されているサーバー側テンプレート、その名前および ID のリストを返します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
include (含める) |
String (文字列) |
可能な値は |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Transfer Rules Get Envelope Transfer Rules
<docusign:get-v21-accounts-envelopes-transfer-rules-by-account-id>
このメソッドでは、アカウントに関連付けられたエンベロープ転送ルールのリストを取得します。
注意: エンベロープ転送ルールを作成および使用できるのは、システム管理者のみです。また、エンベロープ転送ルールを使用するには、アカウントで [Transfer Custody (転送の管理)] 機能が有効になっている必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/transfer_rules エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
count (数) |
String (文字列) |
(省略可能) 返す結果の最大数。 |
||
Start position (開始位置) |
String (文字列) |
(省略可能) どの位置以降の値を返すかを示す、合計結果セット内の開始位置。thumbnail の値を使用すると、ページ画像を返すことができます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Workflow Definition Get Envelope Workflow Definition
<docusign:get-v21-accounts-envelopes-workflow-by-account-id-envelope-id>
envelopeId で指定されたエンベロープのワークフロー定義がある場合、そのワークフロー定義を返します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Favorite Templates Get Favorite Templates
<docusign:get-v21-accounts-favorite-templates-by-account-id>
この操作では、/v2.1/accounts/{accountId}/favorite_templates エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Folders Get Folders
<docusign:get-v21-accounts-folders-by-account-id>
フォルダー階層を含め、アカウントのフォルダーのリストを取得します。template クエリ文字列パラメーターを設定することで、テンプレートフォルダーのみを返すか、テンプレートフォルダーと通常のフォルダーを返すかを指定できます。この操作では、/v2.1/accounts/{accountId}/folders エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User filter (検索条件を使用) |
String (文字列) |
結果のフォルダーリストを次の値で絞り込みます。- |
||
Include items (アイテムを含める) |
String (文字列) |
フォルダー項目を応答に含めるかどうかを示します。このパラメーターを省略した場合、デフォルトは false です。 |
||
include (含める) |
String (文字列) |
応答に含めるフォルダー種別のカンマ区切りリスト。有効な値: - |
||
template (テンプレート) |
String (文字列) |
このパラメーターは、バージョン 2.1 で非推奨になりました。代わりに |
||
Start position (開始位置) |
String (文字列) |
どの位置以降の値を返すかを示す、合計結果セット内の開始位置。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Array of String (文字列の配列) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Folders Get Folder Items
<docusign:get-v21-accounts-folders-by-account-id-folder-id>
指定されたフォルダー内のエンベロープのリストを取得します。クエリ文字列パラメーターで検索条件を指定して、クエリを絞り込むことができます。この操作では、/v2.1/accounts/{accountId}/folders/{folderId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Folder Id (フォルダー ID) |
String (文字列) |
フォルダーの ID。 |
x |
|
Search text (検索テキスト) |
String (文字列) |
DocuSign 用に予約済み。 |
||
Owner name (オーナー名) |
String (文字列) |
DocuSign 用に予約済み。 |
||
Include items (アイテムを含める) |
String (文字列) |
フォルダー項目を応答に含めるかどうかを示します。このパラメーターを省略した場合、デフォルトは false です。 |
||
status (状況) |
String (文字列) |
DocuSign 用に予約済み。 |
||
From date (開始日) |
String (文字列) |
DocuSign 用に予約済み。 |
||
Start position (開始位置) |
String (文字列) |
DocuSign 用に予約済み。 |
||
Owner email (オーナーメール) |
String (文字列) |
DocuSign 用に予約済み。 |
||
To date (終了日) |
String (文字列) |
DocuSign 用に予約済み。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brands Get Group Brands
<docusign:get-v21-accounts-groups-brands-by-account-id-group-id>
このメソッドは、グループに関連付けられたブランドに関する情報を返します。この操作では、/v2.1/accounts/{accountId}/groups/{groupId}/brands エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Group Id (グループ ID) |
String (文字列) |
グループの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Groups Get Groups
<docusign:get-v21-accounts-groups-by-account-id>
アカウントに関連付けられたグループに関する情報を取得します。この操作では、/v2.1/accounts/{accountId}/groups エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
count (数) |
String (文字列) |
返すレコードの数。この数は 1 より大きく 100 以下である必要があります。 |
||
Search text (検索テキスト) |
String (文字列) |
指定されたテキストに基づいて GET 要求の結果を絞り込みます。 |
||
Group type (グループ種別) |
String (文字列) |
Group type (グループ種別) |
||
Include usercount (ユーザー数を含める) |
String (文字列) |
true に設定すると、応答で返されるグループごとに、グループ内のユーザーの総数が含まれる |
||
Start position (開始位置) |
String (文字列) |
リストの開始値。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Groups Get Group Users
<docusign:get-v21-accounts-groups-users-by-account-id-group-id>
グループ内のユーザーのリストを取得します。この操作では、/v2.1/accounts/{accountId}/groups/{groupId}/users エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Group Id (グループ ID) |
String (文字列) |
アクセスするグループの ID。 |
x |
|
count (数) |
String (文字列) |
返すレコードの数。この数は 1 より大きく 100 以下である必要があります。 |
||
Start position (開始位置) |
String (文字列) |
リストの開始値。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Identity Verification Get Account Identity Verification
<docusign:get-v21-accounts-identity-verification-by-account-id>
このメソッドは、アカウントで使用できる ID 検証ワークフローのリストを返します。 注意: このメソッドを使用するには、アカウント管理者または送信者である必要があります。この操作では、/v2.1/accounts/{accountId}/identity_verification エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Payment Gateway Accounts Get All Payment Gateway Accounts
<docusign:get-v21-accounts-payment-gateway-accounts-by-account-id>
このメソッドは、支払ゲートウェイアカウントとその基本情報のリストを返します。この操作では、/v2.1/accounts/{accountId}/payment_gateway_accounts エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Permission Profiles Get Permission Profiles
<docusign:get-v21-accounts-permission-profiles-by-account-id>
このメソッドは、アカウントに関連付けられた権限プロファイルのリストを返します。この操作では、/v2.1/accounts/{accountId}/permission_profiles エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
include (含める) |
String (文字列) |
応答で返される追加プロパティのカンマ区切りリスト。有効な値: - |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Permission Profiles Get Permission Profile
<docusign:get-v21-accounts-permission-profiles-by-account-id-permission-profile-id>
このメソッドは、アカウントに関連付けられた特定の権限プロファイルに関する情報を返します。この操作では、/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Permission Profile Id (権限プロファイル ID) |
String (文字列) |
権限プロファイルの ID。可能な値: - |
x |
|
include (含める) |
String (文字列) |
応答で返される追加プロパティのカンマ区切りリスト。この要求で有効な値は |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Get Power Forms List
<docusign:get-v21-accounts-powerforms-by-account-id>
このメソッドは、ユーザーが使用できる PowerForm のリストを返します。この操作では、/v2.1/accounts/{accountId}/powerforms エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
From date (開始日) |
String (文字列) |
(省略可能) 日付範囲の開始日。 注意: 値が指定されていない場合、日付検索条件は適用されません。 |
||
注文 |
String (文字列) |
(省略可能) 結果の並び替え順。有効な値: * |
||
Order by (並び替え基準) |
String (文字列) |
(省略可能) 結果の並び替えで使用するファイル属性。有効な値: * |
||
To date (終了日) |
String (文字列) |
(省略可能) 日付範囲の終了日。 注意: 値が指定されていない場合、このプロパティはデフォルトで現在の日付になります。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Get Power Form
<docusign:get-v21-accounts-powerforms-by-account-id-power-form-id>
このメソッドは、特定の PowerForm の詳細情報を返します。この操作では、/v2.1/accounts/{accountId}/powerforms/{powerFormId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Power Form Id (パワーフォーム Id) |
String (文字列) |
PowerForm の ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Get Power Form Data
<docusign:get-v21-accounts-powerforms-form-data-by-account-id-power-form-id>
このメソッドを使用すると、Powerform 管理者または PowerForm の送信者は、受信者が PowerForm に入力したデータをダウンロードできます。Accept ヘッダーのデータをどの形式で取得するかを指定します。
このヘッダーは次の値を受け入れます。
-
application/json: JSON 形式 -
application/xml: XML 形式 -
text/csv: カンマ区切り値 (CSV) 形式
注意: PowerForm に関連付けられたデータをダウンロードできるのは、PowerForm 管理者または PowerForm 送信者のみです。
この操作では、/v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Power Form Id (パワーフォーム Id) |
String (文字列) |
PowerForm の ID。 |
x |
|
Data layout (データレイアウト) |
String (文字列) |
PowerForm データを返すレイアウト。有効な値: - |
||
From date (開始日) |
String (文字列) |
日付範囲の開始日 (UTC 日時形式)。 注意: このプロパティが null の場合、日付検索条件は適用されません。 |
||
To date (終了日) |
String (文字列) |
日付範囲の終了日 (UTC 日時形式)。デフォルト値は |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Get Power Forms Senders
<docusign:get-v21-accounts-powerforms-senders-by-account-id>
このメソッドは、PowerForm を送信したユーザーのリストを返します。この操作では、/v2.1/accounts/{accountId}/powerforms/senders エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Start position (開始位置) |
String (文字列) |
どの位置以降の値を返すかを示す、合計結果セット内の開始位置。thumbnail の値を使用すると、ページ画像を返すことができます。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Accounts Get Provisioning
<docusign:get-v21-accounts-provisioning>
アカウントのアカウントプロビジョニング情報を取得します。この操作では、/v2.1/accounts/provisioning エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipient Names Get Recipient Names
<docusign:get-v21-accounts-recipient-names-by-account-id>
渡すメールアドレスに関連付けられたすべての名前のリストを取得します。 このリストには、複数の異なる受信者の名前に加えて、署名で使用される 1 人の受信者の名前のバリエーションが含まれている可能性があります。
この操作では、/v2.1/accounts/{accountId}/recipient_names エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
(必須) 外部アカウント番号 (整数) またはアカウント ID GUID。 |
x |
|
Email (メール) |
String (文字列) |
受信者名を取得するメールアドレス。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Get Report In Product List
<docusign:get-v21-accounts-reports-by-account-id>
この操作では、/v2.1/accounts/{accountId}/reports エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Get Report In Product
<docusign:get-v21-accounts-reports-by-account-id-id>
この操作では、/v2.1/accounts/{accountId}/reports/{id} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
ID |
String (文字列) |
Salesforce オブジェクトの一意の ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signature Providers Get Seal Providers
<docusign:get-v21-accounts-seals-by-account-id>
この操作では、/v2.1/accounts/{accountId}/seals エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Search Folders Get Search Folder Contents
<docusign:get-v21-accounts-search-folders-by-account-id-search-folder-id>
このメソッドは、API v2.1 で非推奨になりました。代わりに Envelopes::listStatusChanges を使用します。クエリで指定された条件に一致する項目のリストを取得します。コールを実行したユーザーのユーザー ID が、返されたいずれかの受信者のユーザー ID と同じ場合、ユーザー ID プロパティが、該当の受信者の返された情報に追加されます。この操作では、/v2.1/accounts/{accountId}/search_folders/{searchFolderId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
検索フォルダー ID |
String (文字列) |
要求で検索するエンベロープグループを指定します。これは論理グループであり、実際のフォルダー名ではありません。有効な値: drafts、awaiting_my_signature、completed、out_for_signature. |
x |
|
count (数) |
String (文字列) |
キャッシュに返すレコードの数を指定します。この数は 0 より大きく 100 以下である必要があります。 |
||
all (すべて) |
String (文字列) |
条件に一致するすべてのエンベロープを返すことを指定します。 |
||
Include recipients (受信者を含める) |
String (文字列) |
true に設定すると、受信者情報が応答に返されます。 |
||
注文 |
String (文字列) |
リストを返す順序を指定します。有効な値: |
||
Order by (並び替え基準) |
String (文字列) |
リストの並び替えで使用するプロパティを指定します。有効な値: |
||
From date (開始日) |
String (文字列) |
返す日付範囲の開始を指定します。値が指定されていない場合、デフォルトの検索は過去 30 日です。 |
||
Start position (開始位置) |
String (文字列) |
返されるアイテムの結果セット内の開始位置を指定します。 |
||
To date (終了日) |
String (文字列) |
返す日付範囲の終了を指定します。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
BCCEmail Archive Get BCCEmail Archive List
<docusign:get-v21-accounts-settings-bcc-email-archives-by-account-id>
このメソッドでは、アカウントに関連付けられたすべての BCC メールアーカイブ設定を取得します。この操作では、/v2.1/accounts/{accountId}/settings/bcc_email_archives エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
count (数) |
String (文字列) |
(省略可能) 返す結果の最大数。 |
||
Start position (開始位置) |
String (文字列) |
(省略可能) どの位置以降の値を返すかを示す、合計結果セット内の開始インデックス位置。デフォルト値は |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
BCCEmail Archive Get BCCEmail Archive History List
<docusign:get-v21-accounts-settings-bcc-email-archives-by-account-id-bcc-email-archive-id>
このメソッドは、アカウントの特定の BCC メールアーカイブ設定と、メールアドレスの変更履歴を返します。この操作では、/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Bcc Email Archive Id (BCC メールアーカイブ ID) |
String (文字列) |
BCC メールアーカイブ設定の ID。 |
x |
|
count (数) |
String (文字列) |
(省略可能) 返す結果 (変更) の最大数。 |
||
Start position (開始位置) |
String (文字列) |
(省略可能) どの位置以降の値を返すかを示す、合計結果セット内の開始インデックス位置。デフォルト値は |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Settings Get Settings
<docusign:get-v21-accounts-settings-by-account-id>
指定されたアカウントのアカウント設定情報を取得します。この操作では、/v2.1/accounts/{accountId}/settings エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
ENote Configuration Get ENote Configuration
<docusign:get-v21-accounts-settings-enote-configuration-by-account-id>
この操作では、/v2.1/accounts/{accountId}/settings/enote_configuration エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Purge Configuration Get Envelope Purge Configuration
<docusign:get-v21-accounts-settings-envelope-purge-configuration-by-account-id>
エンベロープパージ設定を使用すると、アカウント管理者は、完了したエンベロープと取り消されたエンベロープから文書とその項目データを、指定された保持期間 (retentionDays) の後、完全に削除できます。このメソッドでは、アカウントの現在のエンベロープパージ設定を取得します。
注意: このメソッドを使用するには、アカウント管理者である必要があります。
この操作では、/v2.1/accounts/{accountId}/settings/envelope_purge_configuration エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notification Defaults Get Notification Defaults
<docusign:get-v21-accounts-settings-notification-defaults-by-account-id>
このメソッドは、エンベロープに関して署名者と送信者が受け取るメール通知のデフォルト設定を返します。この操作では、/v2.1/accounts/{accountId}/settings/notification_defaults エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Password Rules Get Account Password Rules
<docusign:get-v21-accounts-settings-password-rules-by-account-id>
このメソッドでは、アカウントのパスワードルールを取得します。この操作では、/v2.1/accounts/{accountId}/settings/password_rules エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tab Settings Get Tab Settings
<docusign:get-v21-accounts-settings-tabs-by-account-id>
このメソッドは、アカウントで現在有効になっているタブ種別とタブ機能に関する情報を返します。この操作では、/v2.1/accounts/{accountId}/settings/tabs エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Shared Access Get Shared Access
<docusign:get-v21-accounts-shared-access-by-account-id>
1 人以上のユーザーの共有項目の状況と項目の種別を取得します。アカウント管理権限を持つユーザーは、すべてのアカウントユーザーの共有アクセス情報を取得できます。アカウント管理者権限を持たないユーザーは、自分の共有アクセス情報のみを取得でき、返される情報は、フォルダーをそのユーザーと共有しているアカウントのメンバーの状況の取得に制限されます。これは、shared パラメーターを shared_from に設定することと同じです。
この操作では、/v2.1/accounts/{accountId}/shared_access エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
count (数) |
String (文字列) |
応答に含める結果の最大数を指定します。値が指定されていない場合、デフォルトの 1000 になります。 |
||
Search text (検索テキスト) |
String (文字列) |
指定された文字列に基づいて、ユーザー名を絞り込みます。文字列ではワイルドカード「*」 (アスタリスク) を使用できます。 |
||
shared (共有) |
String (文字列) |
応答に含めるユーザーを指定する共有条件のカンマ区切りリスト。- |
||
Envelopes not shared user status (エンベロープを共有していないユーザーの状況) |
String (文字列) |
このクエリパラメーターは、 |
||
Folder ids (フォルダー ID) |
String (文字列) |
どのフォルダーの共有項目情報を返すかを示すフォルダー ID のカンマ区切りリスト。 |
||
User ids (ユーザー ID) |
String (文字列) |
どのユーザーの共有項目情報を要求しているかを示すユーザー ID のカンマ区切りリスト。 |
||
Item type (項目種別) |
String (文字列) |
要求している共有項目の種別を指定します。可能な値: - |
||
Start position (開始位置) |
String (文字列) |
応答の数が |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signature Providers Get Signature Providers
<docusign:get-v21-accounts-signature-providers-by-account-id>
指定されたアカウントで使用できる署名プロバイダーのリストを返します。この操作では、/v2.1/accounts/{accountId}/signatureProviders エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Get Account Signatures
<docusign:get-v21-accounts-signatures-by-account-id>
この操作では、/v2.1/accounts/{accountId}/signatures エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Stamp format (スタンプ形式) |
String (文字列) |
Stamp format (スタンプ形式) |
||
Stamp name (スタンプ名) |
String (文字列) |
Stamp name (スタンプ名) |
||
Stamp type (スタンプ種別) |
String (文字列) |
Stamp type (スタンプ種別) |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Get Account Signature
<docusign:get-v21-accounts-signatures-by-account-id-signature-id>
この操作では、/v2.1/accounts/{accountId}/signatures/{signatureId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Get Account Signature Image
<docusign:get-v21-accounts-signatures-by-account-id-signature-id-image-type>
この操作では、/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Image Type (画像の種類) |
String (文字列) |
画像の種類を指定します。有効な値: - |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
Include chrome (クロームを含める) |
String (文字列) |
true の場合、署名画像にクローム (追加された線と識別子が含まれるフレーム) が付属します。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Get Signing Groups
<docusign:get-v21-accounts-signing-groups-by-account-id>
指定されたアカウント内のすべての署名グループのリストを取得します。この操作では、/v2.1/accounts/{accountId}/signing_groups エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Group type (グループ種別) |
String (文字列) |
Group type (グループ種別) |
||
Include users (ユーザーを含める) |
String (文字列) |
true に設定すると、応答には署名グループメンバーが含まれます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Get Signing Group
<docusign:get-v21-accounts-signing-groups-by-account-id-signing-group-id>
グループメンバー情報を含め、指定された署名グループの情報を取得します。この操作では、/v2.1/accounts/{accountId}/signing_groups/{signingGroupId} エンドポイントに対する HTTP GET 要求を行います
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Signing Group Id (署名グループ ID) |
String (文字列) |
省略可能。[署名グループ](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups)の |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Get Signing Group Users
<docusign:get-v21-accounts-signing-groups-users-by-account-id-signing-group-id>
指定された署名グループ内のメンバーのリストを取得します。この操作では、/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Signing Group Id (署名グループ ID) |
String (文字列) |
省略可能。[署名グループ](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups)の |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Supported Languages Get Supported Languages
<docusign:get-v21-accounts-supported-languages-by-account-id>
エンベロープの作成時に個々の受信者に設定できるサポート対象言語とその単純型列挙値のリストを取得します。これらは、各受信者の標準のメール形式と署名ビューに設定できる言語です。たとえば、受信者のメール通知では、署名の要求について記述する最初の標準の説明文などの要素にこの設定が影響します。また、メール通知と署名環境の両方のボタンとタブで使用する言語もこの設定で決まります。
注意: 受信者の言語の設定は DocuSign の標準テキストにのみ影響します。通知の emailBody と emailSubject に入力されたカスタムテキストは翻訳されず、入力したとおりに表示されます。
この操作では、/v2.1/accounts/{accountId}/supported_languages エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Get Tab Definitions
<docusign:get-v21-accounts-tab-definitions-by-account-id>
アカウントに関連付けられたすべてのタブのリストを取得します。この操作では、/v2.1/accounts/{accountId}/tab_definitions エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Custom tab only (カスタムタブのみ) |
String (文字列) |
true に設定すると、カスタムタブのみが応答に返されます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tab Get Custom Tab
<docusign:get-v21-accounts-tab-definitions-by-account-id-custom-tab-id>
指定されたアカウントの要求されたカスタムタブに関する情報を取得します。この操作では、/v2.1/accounts/{accountId}/tab_definitions/{customTabId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Custom Tab Id (カスタムタブ ID) |
String (文字列) |
DocuSign により生成された、適用するカスタムタブのカスタムタブ ID。これは、受信者用の新規タブを追加する場合にのみ使用できます。使用時に、新規タブはすべてのカスタムタブプロパティを継承します。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Get Templates
<docusign:get-v21-accounts-templates-by-account-id>
指定されたアカウントのテンプレートのリストを取得します。要求を特定のフォルダーに制限することができます。この操作では、/v2.1/accounts/{accountId}/templates エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Shared by me (自分と共有) |
String (文字列) |
|
||
count (数) |
String (文字列) |
キャッシュに返すレコードの数。 |
||
Is download (ダウンロード) |
String (文字列) |
true に設定すると、1 つの zip ファイルで JSON 定義のコレクションとして |
||
Search text (検索テキスト) |
String (文字列) |
テンプレートの名前を検索するために使用する検索テキスト。 |
||
Used to date (使用日付範囲の終了日) |
String (文字列) |
検索日付範囲の終了。この日時までに使用または編集されたテンプレートのみを返します。値が指定されていない場合、デフォルトで現在の日付になります。 |
||
Used from date (使用日付範囲の開始日) |
String (文字列) |
検索日付範囲の開始。この日時以降に使用または編集されたテンプレートのみを返します。値が指定されていない場合、最も早い使用日の制限はありません。 |
||
Template ids (テンプレート ID) |
String (文字列) |
ダウンロードするテンプレートの ID のカンマ区切りリスト。この値は、 |
||
Search fields (検索項目) |
String (文字列) |
検索する追加のテンプレートプロパティのカンマ区切りリスト。- |
||
Folder types (フォルダー種別) |
String (文字列) |
対象のフォルダー種別。このフォルダー種別のテンプレートを返します。可能な値: - |
||
Created to date (作成日付範囲の終了日) |
String (文字列) |
この日付より前に更新されたテンプレートをリストします。 |
||
User ID (ユーザー ID) |
String (文字列) |
ユーザーの ID。 |
||
Created from date (作成日付範囲の開始日) |
String (文字列) |
この日付以降に作成されたテンプレートをリストします。 |
||
User filter (検索条件を使用) |
String (文字列) |
応答内でテンプレートを絞り込みます。有効な値: - |
||
注文 |
String (文字列) |
検索結果の並び替え順を指定します。有効な値: - |
||
Order by (並び替え基準) |
String (文字列) |
検索結果をリストする方法を指定します。有効な値: - |
||
include (含める) |
String (文字列) |
応答に含める追加のテンプレート属性のカンマ区切りリスト。有効な値: - |
||
From date (開始日) |
String (文字列) |
検索日付範囲の開始。この日時以降に作成されたテンプレートのみを返します。値が指定されていない場合、最も早い作成日の制限はありません。 |
||
Folder ids (フォルダー ID) |
String (文字列) |
フォルダー ID GUID のカンマ区切りリスト。 |
||
Modified to date (更新日付範囲の終了日) |
String (文字列) |
この日付より前に更新されたテンプレートをリストします。 |
||
Start position (開始位置) |
String (文字列) |
応答に表示する最初のテンプレートの開始値 0 のインデックス位置。この値は |
||
Modified from date (更新日付範囲の開始日) |
String (文字列) |
この日付以降に更新されたテンプレートをリストします。 |
||
To date (終了日) |
String (文字列) |
検索日付範囲の終了 (UTC 日時形式)。このパラメーターを使用すると、この日時までに作成されたテンプレートのみが返されます。 注意: このプロパティが null の場合、値はデフォルトで現在の日付になります。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Get Template
<docusign:get-v21-accounts-templates-by-account-id-template-id>
指定されたテンプレートの定義を取得します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
include (含める) |
String (文字列) |
応答に含める追加のテンプレート属性のカンマ区切りリスト。有効な値: - |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Custom Fields Get Template Custom Fields
<docusign:get-v21-accounts-templates-custom-fields-by-account-id-template-id>
既存のテンプレートからカスタム文書項目の情報を取得します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Documents Get Template Documents
<docusign:get-v21-accounts-templates-documents-by-account-id-template-id>
指定されたテンプレートに関連付けられた文書のリストを取得します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Include tabs (タブを含める) |
String (文字列) |
DocuSign 用に予約済み。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Documents Get Template Document
<docusign:get-v21-accounts-templates-documents-by-account-id-template-id-document-id>
このメソッドでは、指定されたテンプレートから 1 つ以上の PDF 文書を取得します。取得する文書の ID を指定できます。また、値 combined を渡すと、テンプレート内のすべての文書を 1 つの PDF ファイルとして取得できます。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
暗号化 |
String (文字列) |
true に設定すると、DocuSign アカウントで設定されているすべての Key Manager で、応答に返される PDF バイトが暗号化されます。文書は、Key Manager DecryptDocument API メソッドを使用して復号化できます。Key Manager についての詳細は、DocuSign から組織に提供されている『DocuSign Security Appliance Installation Guide (DocuSign セキュリティアプライアンスインストールガイド)』を参照してください。 |
||
Show changes (変更を表示) |
String (文字列) |
true に設定すると、返された PDF 文書で、受信者が変更した文書項目が黄色で強調表示され、省略可能な署名とイニシャルが赤で囲まれます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Document Fields Get Template Document Fields
<docusign:get-v21-accounts-templates-documents-fields-by-account-id-template-id-document-id>
このメソッドでは、既存のテンプレート文書のカスタム文書項目を取得します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Get Template Document Html Definitions
<docusign:get-v21-accounts-templates-documents-html-definitions-by-account-id-template-id-document-id>
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Pages Get Template Page Images
<docusign:get-v21-accounts-templates-documents-pages-by-account-id-template-id-document-id>
指定されたパラメーターに基づいて、テンプレート文書内のページの表示用の画像を返します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
(必須) 外部アカウント番号 (整数) またはアカウント ID GUID。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
(必須) 文書の ID。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
(必須) テンプレートの ID。 |
x |
|
Max width (最大幅) |
String (文字列) |
返される画像の最大幅をピクセル単位で設定します。 |
||
count (数) |
String (文字列) |
返す結果の最大数。 |
||
Max height (最大高さ) |
String (文字列) |
返される画像の最大高さをピクセル単位で設定します。 |
||
dpi |
String (文字列) |
結果の画像の 1 インチあたりのドット数 (DPI)。有効な値は 1-310 DPI です。デフォルト値は 94 です。 |
||
nocache |
String (文字列) |
true の場合、キャッシュの使用が無効化され、画像情報はデータベースから取得されます。 デフォルト値は True です。 |
||
Show changes (変更を表示) |
String (文字列) |
true の場合、変更がユーザーインターフェースに表示されます。 |
||
Start position (開始位置) |
String (文字列) |
どの位置以降の値を返すかを示す、合計結果セット内の開始位置。thumbnail の値を使用すると、ページ画像を返すことができます。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Pages Get Template Page Image
<docusign:get-v21-accounts-templates-documents-pages-page-image-by-account-id-template-id-document-id-page-number>
指定されたテンプレートから表示用のページ画像を取得します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Page Number (ページ番号) |
String (文字列) |
アクセスするページ番号。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
dpi |
String (文字列) |
結果の画像の 1 インチあたりのドット数 (DPI)。有効な値は 1-310 DPI です。デフォルト値は 94 です。 |
||
Max height (最大高さ) |
String (文字列) |
返される画像の最大高さをピクセル単位で設定します。 |
||
Max width (最大幅) |
String (文字列) |
返される画像の最大幅をピクセル単位で設定します。 |
||
Show changes (変更を表示) |
String (文字列) |
Show changes (変更を表示) |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Get Template Page Tabs
<docusign:get-v21-accounts-templates-documents-pages-tabs-by-account-id-template-id-document-id-page-number>
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Page Number (ページ番号) |
String (文字列) |
アクセスするページ番号。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Get Template Document Tabs
<docusign:get-v21-accounts-templates-documents-tabs-by-account-id-template-id-document-id>
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Page numbers (ページ番号) |
String (文字列) |
指定されたページのタブに絞り込みます。ページ GUID のカンマ区切りリストとして入力します。例: |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Get Template Html Definitions
<docusign:get-v21-accounts-templates-html-definitions-by-account-id-template-id>
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/html_definitions エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Lock Get Template Lock
<docusign:get-v21-accounts-templates-lock-by-account-id-template-id>
テンプレートロックに関する一般情報を取得します。ロックを持つユーザーからコールが実行され、要求に元のインテグレーションキーと同じインテグレーションキーが含まれる場合、X-DocuSign-Edit ヘッダー項目と追加のロック情報が応答に含まれます。これにより、ユーザーは失われた編集セッショントークンと X-DocuSign-Edit ヘッダーを回復できます。
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/lock エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notification Get Templates Template Id Notification
<docusign:get-v21-accounts-templates-notification-by-account-id-template-id>
エンベローブ通知、リマインダー、有効期限など、既存のテンプレートの情報を取得します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/notification エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Get Template Bulk Recipients
<docusign:get-v21-accounts-templates-recipients-bulk-recipients-by-account-id-template-id-recipient-id>
一括受信者が含まれるテンプレートから一括受信者ファイル情報を取得します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Include tabs (タブを含める) |
String (文字列) |
true に設定すると、受信者に関連付けられたタブ情報が応答に含まれます。このパラメーターを指定しない場合、デフォルトの動作 (false) になります。 |
||
Start position (開始位置) |
String (文字列) |
結果セットの開始位置。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Get Template Recipients
<docusign:get-v21-accounts-templates-recipients-by-account-id-template-id>
指定されたテンプレート内のすべての受信者の情報を取得します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Include anchor tab locations (アンカータブの場所を含める) |
String (文字列) |
true に設定し、 |
||
Include extended (拡張を含める) |
String (文字列) |
true に設定すると、拡張プロパティが応答に含まれます。 |
||
Include tabs (タブを含める) |
String (文字列) |
true に設定すると、受信者に関連付けられたタブ情報が応答に含まれます。このパラメーターを指定しない場合、デフォルトの動作 (false) になります。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Get Template Recipient Document Visibility
<docusign:get-v21-accounts-templates-recipients-document-visibility-by-account-id-template-id-recipient-id>
このメソッドは、テンプレート受信者の文書表示に関する情報を返します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Get Template Recipient Tabs
<docusign:get-v21-accounts-templates-recipients-tabs-by-account-id-template-id-recipient-id>
テンプレート内の署名者または直接署名受信者のタブ情報を取得します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Include anchor tab locations (アンカータブの場所を含める) |
String (文字列) |
true に設定すると、アンカータブプロパティを持つすべてのタブが応答に含まれます。デフォルト値は false です。 |
||
Include metadata (メタデータを含める) |
String (文字列) |
true に設定すると、応答には編集可能なプロパティを示すメタデータが含まれます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Workflow Definition Get Template Workflow Definition
<docusign:get-v21-accounts-templates-workflow-by-account-id-template-id>
templateId で指定されたテンプレートのワークフロー定義がある場合、そのワークフロー定義を返します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/workflow エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Unsupported File Types Get Unsupported File Types
<docusign:get-v21-accounts-unsupported-file-types-by-account-id>
DocuSign システムからのアップロードがサポートされないファイルの種類 (MIME タイプおよびファイル拡張子) のリストを取得します。この操作では、/v2.1/accounts/{accountId}/unsupported_file_types エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Users Get Users
<docusign:get-v21-accounts-users-by-account-id>
指定されたアカウントのユーザーのリストを取得します。応答では、アカウントのユーザーのリストが結果セットに関する情報と共に返されます。additional_info クエリがエンドポイントに追加され、true に設定されている場合、ユーザーごとに完全なユーザー情報が返されます。この操作では、/v2.1/accounts/{accountId}/users エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
(必須) 外部アカウント番号 (整数) またはアカウント ID GUID。 |
x |
|
Group ID (グループ ID) |
String (文字列) |
結果を 1 つ以上のグループ ID に基づいて絞り込みます。 |
||
count (数) |
String (文字列) |
返すレコードの数。この数は |
||
email (メール) |
String (文字列) |
返すユーザーに関連付けられたメールアドレスに基づいて結果を絞り込みます。 注意: このパラメーターまたは |
||
Include usersettings for csv (csv のユーザー設定を含める) |
String (文字列) |
true に設定すると、応答には |
||
Email substring (メールのサブ文字列) |
String (文字列) |
結果をメールアドレスの一部に基づいて絞り込みます。たとえば、「 |
||
Additional info (追加情報) |
String (文字列) |
true に設定すると、アカウント内のユーザーごとにカスタム設定情報が返されます。このパラメーターを省略した場合、デフォルトの動作は false です。 |
||
Login status (ログイン状況) |
String (文字列) |
true に設定すると、応答には各ユーザーのログイン状況が含まれます。 |
||
User name substring (ユーザー名のサブ文字列) |
String (文字列) |
結果を完全なユーザー名または部分的なユーザー名に基づいて絞り込みます。 注意: 部分的なユーザー名を入力する場合、ワイルドカード文字は使用しません。 |
||
Not group ID (除外グループ ID) |
String (文字列) |
指定されたグループ ID を除くユーザーレコードを返します。 |
||
status (状況) |
String (文字列) |
結果をユーザーアカウントの状況で絞り込みます。可能な値: * |
||
Start position (開始位置) |
String (文字列) |
どの位置以降の値を返すかを示す、合計結果セット内の開始位置。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Get User
<docusign:get-v21-accounts-users-by-account-id-user-id>
指定されたユーザーのユーザー情報を取得します。最終ログイン日、ログイン状況、およびユーザーのパスワード期限の詳細を含む追加のユーザー情報を返すには、省略可能な additional_info クエリ文字列パラメーターを true に設定します。この操作では、/v2.1/accounts/{accountId}/users/{userId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Additional info (追加情報) |
String (文字列) |
このパラメーターの設定はこの操作には影響しません。 |
||
Email (メール) |
String (文字列) |
このパラメーターの設定はこの操作には影響しません。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Cloud Storage Get Cloud Storage Providers
<docusign:get-v21-accounts-users-cloud-storage-by-account-id-user-id>
アカウントで有効になっているクラウドストレージプロバイダーのリストとユーザーの設定情報を取得します。この操作では、/v2.1/accounts/{accountId}/users/{userId}/cloud_storage エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Redirect Url (リダイレクト URL) |
String (文字列) |
クラウドストレージプロバイダーでユーザーが認証された後、ユーザーがリダイレクトされる URL。これを使用すると、redirectUrl が authenticationUrl に追加されます。redirectUrl is は docusign.com または docusign.net ドメインの URL に制限されます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Cloud Storage Get Cloud Storage
<docusign:get-v21-accounts-users-cloud-storage-by-account-id-user-id-service-id>
アカウントで有効になっているクラウドストレージプロバイダーのリストとユーザーの設定情報を取得します。この操作では、/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Service Id (サービス ID) |
String (文字列) |
アクセスするサービスの ID。有効な値はサービス名 (「Box」) または数値の serviceId (「4136」) です。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Redirect Url (リダイレクト URL) |
String (文字列) |
クラウドストレージプロバイダーでユーザーが認証された後、ユーザーがリダイレクトされる URL。これを使用すると、redirectUrl が authenticationUrl に追加されます。redirectUrl is は docusign.com または docusign.net ドメインの URL に制限されます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Cloud Storage Folder Get Cloud Storage Folder All
<docusign:get-v21-accounts-users-cloud-storage-folders-by-account-id-user-id-service-id>
指定されたクラウドストレージプロバイダーの指定されたフォルダー内のすべての項目のリストを取得します。この操作では、/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Service Id (サービス ID) |
String (文字列) |
アクセスするサービスの ID。有効な値はサービス名 (「Box」) または数値の serviceId (「4136」) です。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
count (数) |
String (文字列) |
応答に含まれる項目数を設定する省略可能な値。このデフォルト設定は 25 です。 |
||
Search text (検索テキスト) |
String (文字列) |
このパラメーターを使用して特定のテキストを検索します。 |
||
注文 |
String (文字列) |
(省略可能) 結果の並び替え順。有効な値: * |
||
Order by (並び替え基準) |
String (文字列) |
(省略可能) 結果の並び替えで使用するファイル属性。有効な値: * |
||
Start position (開始位置) |
String (文字列) |
応答セットに含まれる最初の項目の開始位置を示します。開始値 0 のインデックスを使用します。このデフォルト設定は 0 です。 |
||
Cloud storage folder path (クラウドストレージフォルダーパス) |
String (文字列) |
要求に含まれるフォルダー ID のカンマ区切りリスト。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Cloud Storage Folder Get Cloud Storage Folder
<docusign:get-v21-accounts-users-cloud-storage-folders-by-account-id-user-id-service-id-folder-id>
指定されたクラウドストレージプロバイダーからのユーザーの項目のリストを取得します。返される項目のスコープを制限するには、要求でフォルダー ID のカンマ区切りリストを指定します。この操作では、/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Folder Id (フォルダー ID) |
String (文字列) |
フォルダーの ID。 |
x |
|
Service Id (サービス ID) |
String (文字列) |
アクセスするサービスの ID。有効な値はサービス名 (「Box」) または数値の serviceId (「4136」) です。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
count (数) |
String (文字列) |
応答に含まれる項目数を設定する省略可能な値。このデフォルト設定は 25 です。 |
||
Search text (検索テキスト) |
String (文字列) |
このパラメーターを使用して特定のテキストを検索します。 |
||
注文 |
String (文字列) |
(省略可能) 結果の並び替え順。有効な値: * |
||
Order by (並び替え基準) |
String (文字列) |
(省略可能) 結果の並び替えで使用するファイル属性。有効な値: * |
||
Cloud storage folderid plain (クラウドストレージフォルダー ID プレーン) |
String (文字列) |
既存のフォルダー ID の代わりに使用できるプレーンテキストのフォルダー ID。 このプロパティは主に rooms で使用されます。複数のフォルダー ID をカンマ区切りリストとして入力します。 |
||
Start position (開始位置) |
String (文字列) |
どの位置以降の値を返すかを示す、結果セット内の開始インデックス位置。デフォルト設定は |
||
Cloud storage folder path (クラウドストレージフォルダーパス) |
String (文字列) |
クラウドストレージフォルダーへのファイルパス。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Custom Settings Get Custom Settings
<docusign:get-v21-accounts-users-custom-settings-by-account-id-user-id>
1 人のユーザーのカスタムユーザー設定のリストを取得します。カスタム設定を使用すると、独自のシステムで使用できるカスタムユーザー設定を柔軟に保存および取得できます。
注意: カスタムユーザー設定はユーザーアカウント設定と同じではありません。
グループ化されたカスタムユーザー設定の取得
取得するカスタムユーザー設定がグループ化されている場合、X-DocuSign-User-Settings-Key:group_name を要求のヘッダーの Content-Type 以降に含める必要があります。ここで group_name は、顧客のユーザー設定のグループに指定された名前です。この追加のヘッダー情報が含まれていない場合、グループなしで追加されたカスタムユーザー設定のみが取得されます。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/custom_settings エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Profile Get Profile
<docusign:get-v21-accounts-users-profile-by-account-id-user-id>
指定されたユーザーのユーザープロファイル情報、プライバシー設定、および個人情報 (住所、電話番号など) を取得します。エンドポイントで指定された userId パラメーターは認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーは、指定されたアカウントのメンバーである必要があります。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/profile エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Profile Image Get User Profile Image
<docusign:get-v21-accounts-users-profile-image-by-account-id-user-id>
指定されたユーザーのユーザープロファイル写真を取得します。画像はアップロードされたときと同じ形式で返されます。エンドポイントで指定された userId パラメーターは認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーは、指定されたアカウントのメンバーである必要があります。成功した場合、応答で 200 - OK とユーザープロファイル画像が返されます。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/profile/image エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
encoding |
String (文字列) |
DocuSign 用に予約済み。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Settings Get User Settings
<docusign:get-v21-accounts-users-settings-by-account-id-user-id>
指定されたユーザーのアカウント設定とメール通知情報のリストを取得します。応答では、指定されたユーザーのアカウント設定名/値の情報とメール通知設定が返されます。さまざまなユーザー設定についての詳細は、 「User Settings (ユーザー設定)」を参照してください。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/settings エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Signatures Get User Signatures
<docusign:get-v21-accounts-users-signatures-by-account-id-user-id>
このメソッドでは、指定されたユーザーの署名定義を取得します。エンドポイントで指定された userId パラメーターは認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーはアカウントのメンバーである必要があります。
signatureId パラメーターでは署名 ID または署名の名前を受け入れます。名前によっては、URL に適切にエンコードされない文字が含まれている場合があるため、署名 ID (signatureId) を使用することをお勧めします。ユーザー名を使用する場合、名前にスペースが含まれている可能性があります。この場合、エンドポイントでこの名前を使用する前に名前を URL エンコードします。たとえば、「Bob Smith」を「Bob%20Smith」としてエンコードします。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/signatures エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Stamp type (スタンプ種別) |
String (文字列) |
返すスタンプの種別。有効な値: - |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Signatures Get User Signature
<docusign:get-v21-accounts-users-signatures-by-account-id-user-id-signature-id>
1 つの署名の構造と既知の署名の名前を取得します。エンドポイントで指定されたユーザー ID は認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーはアカウントのメンバーである必要があります。
signatureId パラメーターでは署名 ID または署名の名前を受け入れます。名前によっては、URL に適切にエンコードされない文字が含まれている場合があるため、署名 ID (signatureId) を使用することをお勧めします。ユーザー名を使用する場合、名前にスペースが含まれている可能性があります。この場合、エンドポイントでこの名前を使用する前に名前を URL エンコードします。たとえば、「Bob Smith」を「Bob%20Smith」としてエンコードします。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Signatures Get User Signature Image
<docusign:get-v21-accounts-users-signatures-by-account-id-user-id-signature-id-image-type>
指定されたユーザーの指定されたイニシャル画像または署名画像を取得します。画像はアップロードされたときと同じ形式で返されます。要求では、画像と共にクローム (イニシャル画像の周囲に追加された線と識別子) を返すかどうかを指定できます。エンドポイントで適切に指定されたユーザー ID は認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーはアカウントのメンバーである必要があります。
signatureId パラメーターでは署名 ID または署名の名前を受け入れます。名前によっては、URL に適切にエンコードされない文字が含まれている場合があるため、署名 ID (signatureId) を使用することをお勧めします。ユーザー名を使用する場合、名前にスペースが含まれている可能性があります。この場合、エンドポイントでこの名前を使用する前に名前を URL エンコードします。たとえば、「Bob Smith」を「Bob%20Smith」としてエンコードします。
注意: 古いエンベロープにはクローム化画像のみが含まれている場合があります。クローム化されていない画像の取得が失敗する場合は、クローム化画像を取得してください。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Image Type (画像の種類) |
String (文字列) |
画像の種類を指定します。有効な値: - |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Include chrome (クロームを含める) |
String (文字列) |
true の場合、署名画像にクローム (追加された線と識別子が含まれるフレーム) が付属します。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Watermark Get Watermark
<docusign:get-v21-accounts-watermark-by-account-id>
この操作では、/v2.1/accounts/{accountId}/watermark エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Workspace Get Workspaces
<docusign:get-v21-accounts-workspaces-by-account-id>
作成されたワークスペースに関する情報を取得します。この操作では、/v2.1/accounts/{accountId}/workspaces エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Workspace Get Workspace
<docusign:get-v21-accounts-workspaces-by-account-id-workspace-id>
一意のワークスペース ID を指定してワークスペースに関するプロパティを取得します。この操作では、/v2.1/accounts/{accountId}/workspaces/{workspaceId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Workspace Id (ワークスペース ID) |
String (文字列) |
ワークスペースの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Workspace Folder Get Workspace Folder
<docusign:get-v21-accounts-workspaces-folders-by-account-id-workspace-id-folder-id>
このメソッドは、サブフォルダーとファイルが含まれている可能性があるワークスペースフォルダーのコンテンツを返します。この操作では、/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Folder Id (フォルダー ID) |
String (文字列) |
フォルダーの ID。 |
x |
|
Workspace Id (ワークスペース ID) |
String (文字列) |
ワークスペースの ID。 |
x |
|
count (数) |
String (文字列) |
返す結果の最大数。 |
||
Include thumbnails (サムネイルを含める) |
String (文字列) |
true に設定すると、応答ではサムネイルが返されます。デフォルトは false です。 |
||
Include user detail (ユーザーの詳細を含める) |
String (文字列) |
true に設定すると、応答にはユーザーに関する追加の詳細が含まれます。デフォルトは false です。 |
||
Include sub folders (サブフォルダーを含める) |
String (文字列) |
true に設定すると、応答には現在のフォルダーのサブフォルダーに関する情報が含まれます。デフォルトは false です。 |
||
Include files (ファイルを含める) |
String (文字列) |
true に設定すると、応答には (フォルダー情報に加えて) ファイル情報が含まれます。デフォルトは false です。 |
||
Start position (開始位置) |
String (文字列) |
どの位置以降の値を返すかを示す、合計結果セット内の開始位置。 |
||
Workspace user ID (ワークスペースユーザー ID) |
String (文字列) |
設定すると、応答には、指定された |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Workspace File Get Workspace File
<docusign:get-v21-accounts-workspaces-folders-files-by-account-id-workspace-id-folder-id-file-id>
このメソッドは、ワークスペース内のファイルのバイナリバージョンを返します。この操作では、/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
File Id (ファイル ID) |
String (文字列) |
ファイルの ID。 |
x |
|
Folder Id (フォルダー ID) |
String (文字列) |
フォルダーの ID。 |
x |
|
Workspace Id (ワークスペース ID) |
String (文字列) |
ワークスペースの ID。 |
x |
|
Is download (ダウンロード) |
String (文字列) |
true に設定すると、 |
||
Pdf version (PDF バージョン) |
String (文字列) |
true に設定すると、ファイルは PDF 形式で返されます。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Workspace File Pages Get Workspace File Pages
<docusign:get-v21-accounts-workspaces-folders-files-pages-by-account-id-workspace-id-folder-id-file-id>
このメソッドは、ワークスペースファイルをラスタライズされたページとして返します。この操作では、/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
File Id (ファイル ID) |
String (文字列) |
ファイルの ID。 |
x |
|
Folder Id (フォルダー ID) |
String (文字列) |
フォルダーの ID。 |
x |
|
Workspace Id (ワークスペース ID) |
String (文字列) |
ワークスペースの ID。 |
x |
|
Max width (最大幅) |
String (文字列) |
返される画像の最大幅をピクセル単位で設定します。 |
||
count (数) |
String (文字列) |
返す結果の最大数。 |
||
Max height (最大高さ) |
String (文字列) |
返される画像の最大高さをピクセル単位で設定します。 |
||
dpi |
String (文字列) |
結果の画像の 1 インチあたりのドット数 (DPI)。有効な値は 1-310 DPI です。デフォルト値は 94 です。 |
||
Start position (開始位置) |
String (文字列) |
どの位置以降の値を返すかを示す、合計結果セット内の開始位置。thumbnail の値を使用すると、ページ画像を返すことができます。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Plans Get Billing Plans
<docusign:get-v21-billing-plans>
ディストリビューターに関連付けられた請求プランのリストを取得します。この操作では、/v2.1/billing_plans エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Plans Get Billing Plan
<docusign:get-v21-billing-plans-by-billing-plan-id>
指定された請求プラン ID の請求プランの詳細を取得します。この操作では、/v2.1/billing_plans/{billingPlanId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Billing Plan Id (請求プラン ID) |
String (文字列) |
アクセスする請求プランの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notary Get Notary
<docusign:get-v21-current-user-notary>
公証人ユーザーの設定を取得します。現在のユーザーは公証人である必要があります。この操作では、/v2.1/current_user/notary エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Include jurisdictions (管轄区域を含める) |
String (文字列) |
true の場合、応答には、現在のユーザーのサポートされるすべての管轄区域の配列を含む |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notary Journals Get Notary Journals
<docusign:get-v21-current-user-notary-journals>
この操作では、/v2.1/current_user/notary/journals エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
count (数) |
String (文字列) |
返す結果の最大数。 |
||
Search text (検索テキスト) |
String (文字列) |
このパラメーターを使用して特定のテキストを検索します。 |
||
Start position (開始位置) |
String (文字列) |
どの位置以降の値を返すかを示す、合計結果セット内の開始位置。thumbnail の値を使用すると、ページ画像を返すことができます。 |
||
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notary Jurisdictions Get Notary Jurisdictions
<docusign:get-v21-current-user-notary-jurisdictions>
公証人が登録されている管轄区域のリストを返します。 現在のユーザーは公証人である必要があります。この操作では、/v2.1/current_user/notary/jurisdictions エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notary Jurisdictions Get Notary Jurisdiction
<docusign:get-v21-current-user-notary-jurisdictions-by-jurisdiction-id>
現在のユーザーの管轄区域オブジェクトを取得します。次の制限が適用されます。
-
現在のユーザーは公証人である必要があります。
-
jurisdictionId は、公証人が登録されている管轄区域である必要があります。
この操作では、/v2.1/current_user/notary/jurisdictions/{jurisdictionId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Jurisdiction Id (管轄区域 ID) |
String (文字列) |
管轄区域の ID。サポートされる管轄区域: - |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Password Rules Get Password Rules
<docusign:get-v21-current-user-password-rules>
この操作では、/v2.1/current_user/password_rules エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
APIRequest Log Get Request Logs
<docusign:get-v21-diagnostics-request-logs>
ログエントリのリストを JSON または xml オブジェクトとして取得するか、エントリを含む zip ファイルとして取得します。Accept ヘッダーが application/zip に設定されている場合、応答は個々のテキストファイルを含む zip ファイルになり、各テキストファイルが API 要求を表します。Accept ヘッダーが application/json または application/xml に設定されている場合、応答ではログエントリのリストが JSON または XML 形式で返されます。JSON レスポンス本文の例を以下に示します。
この操作では、/v2.1/diagnostics/request_logs エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
encoding |
String (文字列) |
DocuSign 用に予約済み。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
APIRequest Log Get Request Log
<docusign:get-v21-diagnostics-request-logs-by-request-log-id>
1 つのログエントリの情報を取得します。
要求 ログエントリのリストを取得することで、requestLogfId プロパティを取得できます。Content-Transfer-Encoding ヘッダーを base64 に設定すると、API 要求/応答を base 64 文字列として取得できます。それ以外の場合は、要求/応答のバイトが返されます。
応答 Content-Transfer-Encoding ヘッダーを base64 に設定した場合、ログは base64 文字列として返されます。
この操作では、/v2.1/diagnostics/request_logs/{requestLogId} エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Request Log Id (要求ログ ID) |
String (文字列) |
Request Log Id (要求ログ ID) |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
APIRequest Log Get Request Log Settings
<docusign:get-v21-diagnostics-settings>
ユーザーの現在の API 要求ログ設定と残りのログエントリ数を取得します。
応答 応答には、ユーザーの現在の API 要求ログ設定と、最大ログエントリ数および残りのログエントリ数が含まれます。
この操作では、/v2.1/diagnostics/settings エンドポイントに対する HTTP GET 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Unauthorize
<docusign:unauthorize>
特定のリソースオーナー ID のアクセストークン情報をすべて削除して、認証ダンスを再度実行しない限り、そのユーザー向けの操作を実行できないようにします。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Resource Owner Id (リソースオーナー ID) |
String (文字列) |
アクセスの無効化が必要なリソースオーナーの ID。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
次の設定の場合
Billing Plan Put Billing Plan
<docusign:update-v21-accounts-billing-plan-by-account-id>
指定されたアカウントの請求プラン情報、請求先住所、およびクレジットカード情報を更新します。この操作では、/v2.1/accounts/{accountId}/billing_plan エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Preview billing plan (プレビュー請求プラン) |
String (文字列) |
true に設定すると、プレビュー請求プランを使用してアカウントが更新されます。 |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Plan Put Downgrade Account Billing Plan
<docusign:update-v21-accounts-billing-plan-downgrade-by-account-id>
この操作では、/v2.1/accounts/{accountId}/billing_plan/downgrade エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Purchased Envelopes Put Purchased Envelopes
<docusign:update-v21-accounts-billing-plan-purchased-envelopes-by-account-id>
予約済み: 現時点では、このエンドポイントは DocuSign の内部使用のみに限定されています。アカウントのエンベロープの購入を完了してください。実際の購入は、内部ワークフローでのエンベロープベンダーとのやりとりの一環として実行されます。
この操作では、/v2.1/accounts/{accountId}/billing_plan/purchased_envelopes エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brand Put Brand
<docusign:update-v21-accounts-brands-by-account-id-brand-id>
このメソッドではアカウントブランドを更新します。
注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。
この操作では、/v2.1/accounts/{accountId}/brands/{brandId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Brand Id (ブランド ID) |
String (文字列) |
ブランドの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brand Logo Put Brand Logo
<docusign:update-v21-accounts-brands-logos-by-account-id-brand-id-logo-type>
このメソッドでは 1 つのブランドロゴを更新します。Content-Disposition ヘッダーでリソースの新しいバージョンを渡します。例: Content-Disposition: form-data; name="file"; filename="logo.jpg"
注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。
この操作では、/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Brand Id (ブランド ID) |
String (文字列) |
ブランドの ID。 |
x |
|
Logo Type (ロゴタイプ) |
String (文字列) |
ロゴのタイプ。有効な値: - |
x |
|
Body (本文) |
String (文字列) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brand Resources Put Brand Resources
<docusign:update-v21-accounts-brands-resources-by-account-id-brand-id-resource-content-type>
このメソッドではブランディングリソースファイルを更新します。Content-Disposition ヘッダーでリソースファイルの新しいバージョンを渡します。例: Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"
注意: アカウントで署名または送信のいずれかのブランディングが有効になっている必要があります (これらのアカウント設定の canSelfBrandSend、canSelfBrandSign または両方が true になっている必要がある)。
重要: リソースファイルのカスタマイズは高度なブランド設定であり、アカウントに大きな影響を及ぼす可能性があるため、XML および HTML の専門知識を持つ担当者のみが実行する必要があります。マスターリソースファイルは予告なしに変更される可能性があります。リソースファイルをカスタマイズする場合は、各リリースの後で変更を確認し、必要に応じてカスタムファイルを更新することをお勧めします。変更したリソースファイルをアップロードすると、マスターリソースファイルとは異なる要素のみがリソースファイルとして保存されます。同様に、リソースファイルをダウンロードすると、変更した要素のみがファイルに含まれます。
この操作では、/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Brand Id (ブランド ID) |
String (文字列) |
ブランドの ID。 |
x |
|
Resource Content Type (リソースコンテンツタイプ) |
String (文字列) |
更新するブランドリソースファイルの種別。有効な値: - |
x |
|
File Xml - Body (ファイル XML - 本文) |
String (文字列) |
「fileXml」パートのコンテンツ。 |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2CRUD Put Bulk Send List
<docusign:update-v21-accounts-bulk-send-lists-by-account-id-bulk-send-list-id>
このメソッドでは、既存の一括送信リストの定義を置き換えます。この操作では、/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Bulk Send List Id (一括送信リスト ID) |
String (文字列) |
一括送信リストの GUID。このプロパティは、新しい一括送信リストを投稿した後に作成されます。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Chunked Uploads Put Chunked Uploads
<docusign:update-v21-accounts-chunked-uploads-by-account-id-chunked-upload-id>
このメソッドでは、チャンクアップロードの整合性を確認した後、チャンクアップロードをコミットします。この要求が成功すると、チャンクアップロードを他の API コールで参照できるようになります。要求が失敗する場合は、Update メソッドを使用して、すべてのパートをアップロードしたことを確認してください。
注意: チャンクアップロードをコミットしたら、チャンクアップロードで追加のパートは受け入れられなくなります。
この操作では、/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
(必須) 外部アカウント番号 (整数) またはアカウント ID GUID。 |
x |
|
Chunked Upload Id (チャンクアップロード ID) |
String (文字列) |
(必須) コミットするチャンクアップロードの ID。 |
x |
|
action (アクション) |
String (文字列) |
(必須) このクエリパラメーターは値 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Chunked Uploads Put Chunked Upload Part
<docusign:update-v21-accounts-chunked-uploads-by-account-id-chunked-upload-id-chunked-upload-part-seq>
既存のチャンクアップロードにチャンクまたはパートを追加します。Create メソッドを使用して新しいチャンクアップロードを初期化し、最初のパートをアップロードしたら、このメソッドを使用して後続のパートをアップロードします。簡単にするために、パートをその順番 (1、2、3、4 などの順番) にアップロードすることをお勧めします。Create メソッドは、最初のパートを追加してそのパートに sequence 値 0 を割り当てます。このため、このメソッドを使用する場合は、sequence 値 1 から開始し、元のコンテンツ全体を DocuSign にアップロードするまでパートを連続してアップロードすることをお勧めします。
例: PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3
注意: DocuSign ですでに受け取ったパートを置き換えることはできません。また、すでに正常にコミットされたチャンクアップロードにパートを追加することはできません。
この操作では、/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Chunked Upload Id (チャンクアップロード ID) |
String (文字列) |
チャンクアップロードの ID。 |
x |
|
Chunked Upload Part Seq (チャンクアップロードパートシーケンス) |
String (文字列) |
チャンクアップロード内のパートのシーケンスまたは順序。デフォルトでは、Create 要求の一環としてアップロードされる最初のパートのシーケンスは |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Put Connect Configuration
<docusign:update-v21-accounts-connect-by-account-id>
アカウント内の指定された DocuSign Connect 設定を更新します。
注意: この関数を使用するには、アカウントで Connect が有効になっている必要があります。Box、eOriginal、または Salesforce の Connect 設定の更新でこれを使用することはできません。
この操作では、/v2.1/accounts/{accountId}/connect エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Publish Put Connect Retry
<docusign:update-v21-accounts-connect-envelopes-retry-queue-by-account-id>
指定されたエンベロープセットの Connect 情報を再パブリッシュします。主な使用法は、POST に失敗したエンベロープのエンベロープ ID を要求に含めることで Connect POST エラーを再パブリッシュすることです。適切に POST できなかったエンベロープ ID のリストを取得するには、 Connect::listEventLogs をコールしてエラーログを取得することができます。
この操作では、/v2.1/accounts/{accountId}/connect/envelopes/retry_queue エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Publish Put Connect Retry By Envelope
<docusign:update-v21-accounts-connect-envelopes-retry-queue-by-account-id-envelope-id>
指定されたエンベロープの Connect 情報を再パブリッシュします。この操作では、/v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Consumer Disclosure Put Consumer Disclosure
<docusign:update-v21-accounts-consumer-disclosure-by-account-id-lang-code>
アカウント管理者はこのメソッドを使用して次の作業を実行できます。
-
デフォルト開示条件の値をカスタマイズする。
-
独自のテキストと HTML 書式を使用するカスタム開示条件に切り替える。
-
既存のコンシューマー開示条件の値を変更する。
更新する開示条件の署名者言語バージョンを指定するには、省略可能な langCode クエリパラメーターを使用します。
注意: このメソッドを使用できるのはアカウント管理者のみです。開示条件のコンテンツを変更するたびに、未処理の文書のすべての未署名の受信者は、新しいバージョンを受け入れる必要があります。
デフォルト開示条件の更新
デフォルト開示条件を更新する場合、次のプロパティ以外のすべてのプロパティを編集できます。
-
accountEsignId: このプロパティは参照のみです。 -
custom: デフォルト値は false です。このプロパティを編集すると、デフォルト開示条件がカスタム開示条件に切り替えられます。 -
esignAgreement: このプロパティは参照のみです。 -
esignText:custom が false に設定されている場合、このプロパティを編集することはできません。API では 200 OK HTTP 応答が返されますが、esignText は更新されません。 -
メタデータプロパティ: このプロパティは参照のみです。
注意: デフォルト開示条件のテキストの言語は常に英語です。
カスタム開示条件への切り替え
カスタム開示条件に切り替えるには、custom プロパティを true に設定し、eSignText プロパティの値をカスタマイズします。次のプロパティ以外のすべてのプロパティを編集することもできます。
-
accountEsignId: このプロパティは参照のみです。 -
esignAgreement: このプロパティは参照のみです。 -
メタデータプロパティ: このプロパティは参照のみです。
注意: カスタム開示条件を使用する場合、異なる署名者言語でそのいくつかのバージョンを作成し、langCode パラメーターを使用して、更新する署名者言語バージョンを指定できます。
重要: デフォルトからカスタムの開示条件に切り替える場合は、次の点に注意してください。
-
デフォルト開示条件の使用に戻ることはできなくなります。
-
現在選択されている署名者言語の開示条件のみが保存されます。DocuSign では、カスタム開示条件は自動的に翻訳されません。署名者が使用する言語ごとに、開示条件を作成する必要があります。
カスタム開示条件の更新
カスタム開示条件を更新する場合、次のプロパティ以外のすべてのプロパティを更新できます。
-
accountEsignId: このプロパティは参照のみです。 -
esignAgreement: このプロパティは参照のみです。 -
メタデータプロパティ: このプロパティは参照のみです。
重要: 現在選択されている署名者言語の開示条件のみが保存されます。DocuSign では、カスタム開示条件は自動的に翻訳されません。署名者が使用する言語ごとに、開示条件を作成する必要があります。
この操作では、/v2.1/accounts/{accountId}/consumer_disclosure/{langCode} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Lang Code (言語コード) |
String (文字列) |
(省略可能) 更新する開示条件の署名者言語バージョンのコード。サポートされる言語: - アラビア語 ( |
x |
|
Include metadata (メタデータを含める) |
String (文字列) |
(省略可能) true に設定すると、応答には編集可能なプロパティを示すメタデータが含まれます。 |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Contacts Put Contacts
<docusign:update-v21-accounts-contacts-by-account-id>
このメソッドでは、アカウントに関連付けられている 1 人以上の取引先責任者を更新します。この操作では、/v2.1/accounts/{accountId}/contacts エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Custom Fields Put Account Custom Fields
<docusign:update-v21-accounts-custom-fields-by-account-id-custom-field-id>
このメソッドでは既存のカスタムアカウント項目を更新します。この操作では、/v2.1/accounts/{accountId}/custom_fields/{customFieldId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Custom Field Id (カスタム項目 ID) |
String (文字列) |
カスタム項目の ID。 |
x |
|
Apply to templates (テンプレートに適用) |
String (文字列) |
Apply to templates (テンプレートに適用) |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Attachments Put Attachments
<docusign:update-v21-accounts-envelopes-attachments-by-account-id-envelope-id>
サポートされる添付ファイル形式: .asp、.bmp、.csv、.doc、.docm、.docx、.dot、.dotm、.dotx、.gif、.htm、.html、.jpeg、.jpg、.msg、.pdf、.png、.pot、.potx、.pps、.ppt、.pptm、.pptx、.ps、.rtf、.tif、.tiff、.txt、.wpd、.xls、.xlsm、.xlsx、.xml、.xps.サポートされるファイル形式についての詳細は、 「サポートされているファイル形式」を参照してください。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Attachments Put Attachment
<docusign:update-v21-accounts-envelopes-attachments-by-account-id-envelope-id-attachment-id>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Attachment Id (アタッチメント ID) |
String (文字列) |
添付ファイルの一意の識別子。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelopes Put Envelope
<docusign:update-v21-accounts-envelopes-by-account-id-envelope-id>
このメソッドでは、エンベロープを変更できます。このメソッドは次の目的で使用できます。
-
ドラフトエンベロープを送信する * 処理中のエンベロープを取り消す
-
ドラフトエンベロープを変更する * 文書とエンベロープのメタデータを DocuSign プラットフォームからパージするこのメソッドのリクエストボディは完全なエンベロープ定義ですが、提供する必要があるのは更新するプロパティのみです。
ドラフトエンベロープの送信
ドラフトエンベロープを送信するには、次のコードをリクエストボディに含めます。
{ "status": "sent" }
エンベロープを送信する前にワークフローを添付できます。
{ "status": "sent", "workflow": { "workflowSteps": [ { "action": "pause_before", "description": "pause_before routing order 2", "itemId": 2, "triggerOnItem": "routing_order" } ] } }
ワークフローの処理
ワークフローの一時停止を解除するには、リクエストボディに `json { "workflow": { "workflowStatus": "in_progress" } } ` を含める必要があります。
処理中のエンベロープの取り消し
処理中のエンベロープを取り消すには、次のコードをリクエストボディに含めます。
{ "status": "voided", "voidedReason": "The reason for voiding the envelope" }
エンベロープのメール情報の変更
メールの件名とドラフトエンベロープのメッセージを変更するには、次のコードをリクエストボディに含めます。
{ "emailSubject": "new email subject", "emailBlurb": "new email message" }
DocuSign からの文書のパージ
文書のみをパージキューに配置し、対応する添付ファイルとタブを DocuSign プラットフォームに残すには、purgeState プロパティを documents_queued に設定します。
{ "purgeState": "documents_queued" }
文書、添付ファイル、およびタブをパージキューに配置するには、purgeState プロパティを documents_and_metadata_queued に設定します。
{ "purgeState": "documents_and_metadata_queued" }
文書は、正式コピーとしてマークされていない完了したエンベロープからのみパージできます。パージを要求するユーザーには文書をパージする権限が必要です。また、そのユーザーは送信者または送信者の代理である必要があります。パージ要求が開始されると、パージされる項目は削除目的でパージキューに 14 日間配置されます。
送信者と、エンベロープに関連付けられた DocuSign アカウントを持つすべての受信者は、文書が 14 日後に削除されるというメール通知を受け取ります。この通知には文書へのリンクが含まれます。7 日後に 2 番目のメール通知が送信されます。14 日期間の最後に文書はシステムから削除されます。DocuSign アカウントを持たない受信者はメール通知を受け取りません。
アカウントに文書保持ポリシーがある場合、エンベロープ文書は自動的にパージキューに配置され、保持期間の最後に通知メールが送信されます。自動保持ポリシーを設定することは、文書のパージスケジュールを設定することと同じです。
パージキューからの文書の削除
パージキューから文書を削除するには、次のコードをリクエストボディに含めます。{ "purgeState": "documents_dequeued" }
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Advanced update (高度な更新) |
String (文字列) |
true に設定すると、コール元は受信者、タブ、カスタム項目、通知、メール設定、および他のエンベロープ属性を更新できます。 |
||
Resend envelope (エンベロープを再送信) |
String (文字列) |
true に設定すると、指定されたエンベロープが再度送信されます。 |
||
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Custom Fields Put Custom Fields
<docusign:update-v21-accounts-envelopes-custom-fields-by-account-id-envelope-id>
ドラフトおよび処理中のエンベロープのカスタムエンベロープ項目を更新します。エンベロープで使用される各カスタム項目には一意の名前が必要です。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Documents Put Documents
<docusign:update-v21-accounts-envelopes-documents-by-account-id-envelope-id>
1 つ以上の文書を既存のエンベロープ文書に追加します。
注意: 処理中のエンベロープの文書を追加または変更する場合は、変更を行う前にエンベロープをロックすることをお勧めします。文書のファイル名に Unicode 文字が含まれる場合、Content-Disposition ヘッダーを含める必要があります。
例: ヘッダー: Content-Disposition 値: file; filename=\"name\";fileExtension=ext;documentId=1
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Documents Put Document
<docusign:update-v21-accounts-envelopes-documents-by-account-id-envelope-id-document-id>
既存のドラフトエンベロープに文書を追加します。文書のバイトによってリクエストボディが構成されます。
注意: 処理中のエンベロープの文書を追加または変更する場合は、変更を行う前にエンベロープをロックすることをお勧めします。文書のファイル名に Unicode 文字が含まれる場合、Content-Disposition ヘッダーを含める必要があります。
例: ヘッダー: Content-Disposition 値: file; filename=\"name\";fileExtension=ext;documentId=1
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Document Fields Put Document Fields
<docusign:update-v21-accounts-envelopes-documents-fields-by-account-id-envelope-id-document-id>
既存のエンベロープ文書の既存のカスタム文書項目を更新します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Pages Put Page Image
<docusign:update-v21-accounts-envelopes-documents-pages-page-image-by-account-id-envelope-id-document-id-page-number>
表示用のエンベロープのページ画像を回転します。ページ画像は左または右に回転できます。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Page Number (ページ番号) |
String (文字列) |
アクセスするページ番号。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Put Document Tabs
<docusign:update-v21-accounts-envelopes-documents-tabs-by-account-id-envelope-id-document-id>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Email Settings Put Email Settings
<docusign:update-v21-accounts-envelopes-email-settings-by-account-id-envelope-id>
指定されたエンベロープの既存のメール上書き設定を更新します。メール設定の変更は、変更後に実行されるメールコミュニケーションにのみ影響します。これを使用して個々のメール上書き設定を削除するには、削除する値で空の文字列を使用することができます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Lock Put Envelope Lock
<docusign:update-v21-accounts-envelopes-lock-by-account-id-envelope-id>
指定されたエンベロープのロック期間または lockedByApp プロパティを更新します。ユーザーは、lockByUser プロパティで指定されたユーザーに一致する必要があり、渡すインテグレーターキーはインテグレーターキー情報に一致する必要があります。ロックの所有権を証明する lockToken と lockDurationInSeconds が含まれる X-DocuSign-Edit ヘッダーも含める必要があります。このヘッダーで必要なトークンは POST および GET メソッドの応答で返されます。
例: X-DocuSign-Edit:{{lockToken}}
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notification Put Envelopes Envelope Id Notification
<docusign:update-v21-accounts-envelopes-notification-by-account-id-envelope-id>
このメソッドでは、既存のエンベロープの通知 (リマインダーと有効期限) を設定します。リクエストボディでは、リマインダーと有効期限の設定が含まれる構造を送信します。また、要求に指定された設定またはエンベロープに関するアカウントのデフォルト通知設定のどちらを使用するかも指定します。この要求では、通知を送信するタイミングのみを指定します。メールメッセージの送信は開始されません。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Put Recipients
<docusign:update-v21-accounts-envelopes-recipients-by-account-id-envelope-id>
ドラフトエンベロープの受信者を更新するか、処理中のエンベロープの受信者情報を修正します。ドラフトエンベロープにまだ存在しない受信者の情報を送信すると、その受信者がエンベロープに追加されます (EnvelopeRecipients::Create メソッドと同様)。このメソッドを使用し、resend_envelope オプションを使用して、エンベロープを受信者に再送信することもできます。
送信済みエンベロープの更新
エンベロープを送信したら、次のプロパティのみを編集できます。
-
accessCode -
agentCanEditName -
agentCanEditEmail -
customFields -
deliveryMethod -
documentVisibility -
email -
emailNotification -
idCheckConfigurationName -
name -
note -
phoneAuthentication -
recipientType (これを機能させるには、受信者種別に一致するように受信者オブジェクトも変更する必要があります)。 -
requireIdLookup -
routingOrder -
routingOrder -
signingGroupId (この ID を変更すると、異なる署名グループおよびそれに対応する受信者セットに切り替えることができます)。 -
smsAuthentication -
suppressEmails -
userName
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Combine same order recipients (同一順序の受信者を結合) |
String (文字列) |
true に設定すると、受信者は一致する受信者と結合またはマージされます。受信者の照合は、[テンプレートの照合](https://docs.docusign.com/DocuSignHelp/Content/automatic-template-matching.htm)の一環として実行され、受信者ロールとルーティング順序に基づきます。 |
||
Offline signing (オフライン署名) |
String (文字列) |
ネットワーク接続を使用できない場合に受信者のオフライン署名を有効にするかどうかを示します。 |
||
Resend envelope (エンベロープを再送信) |
String (文字列) |
true に設定されている場合、リクエストボディで指定した受信者にエンベロープを再送信します。元のメール通知を削除した受信者にエンベロープを再送信するには、このパラメーターを使用します。 注意: エンベロープの修正は、別のプロセスになります。ここで入力した値に関係なく、エンベロープを修正すると必ず DocuSign からエンベロープが再送信されます。 |
||
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Put Recipients Document Visibility
<docusign:update-v21-accounts-envelopes-recipients-document-visibility-by-account-id-envelope-id>
このメソッドでは、リクエストボディに含めた recipientId および visible の値に基づいて 1 人以上の受信者の文書表示を更新します。
注意: 受信者に割り当てられたタブが文書にある場合、その受信者に対して文書を非表示にすることはできません。カーボンコピー、認定配信 (署名が必要)、編集者、および代理人の各受信者は常にすべての文書を表示できます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Put Recipient Document Visibility
<docusign:update-v21-accounts-envelopes-recipients-document-visibility-by-account-id-envelope-id-recipient-id>
このメソッドでは、受信者の文書表示を更新します。
注意: 受信者に割り当てられたタブが文書にある場合、その受信者に対して文書を非表示にすることはできません。カーボンコピー、認定配信 (署名が必要)、編集者、および代理人の各受信者は常にすべての文書を表示できます。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Put Recipient Initials Image
<docusign:update-v21-accounts-envelopes-recipients-initials-image-by-account-id-envelope-id-recipient-id>
DocuSign アカウントを持たない署名者のイニシャル画像を更新します。このファイルでサポートされる画像形式: gif、png、jpeg、bmp。ファイルサイズは 200 K 未満である必要があります。このコールの認証/承認では、ログイン情報がエンベロープの送信者に一致する必要があり、受信者がアカウントなしの署名者または直接署名者である必要があります。アカウントの CanSendEnvelope プロパティが true に設定され、SendingUser 構造の ExpressSendOnly プロパティが false に設定されている必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Put Recipient Signature Image
<docusign:update-v21-accounts-envelopes-recipients-signature-image-by-account-id-envelope-id-recipient-id>
アカウントなしの署名者の署名画像を更新します。このファイルでサポートされる画像形式: gif、png、jpeg、bmp。ファイルサイズは 200 K 未満である必要があります。このコールの認証/承認では、ログイン情報がエンベロープの送信者に一致する必要があり、受信者がアカウントなしの署名者または直接署名者である必要があります。アカウントの CanSendEnvelope プロパティが true に設定され、SendingUser 構造の ExpressSendOnly プロパティが false に設定されている必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Put Recipient Tabs
<docusign:update-v21-accounts-envelopes-recipients-tabs-by-account-id-envelope-id-recipient-id>
ドラフトエンベロープの受信者の 1 つ以上のタブを更新します。
注意: エンベロープがまだ完了していない場合、Update メソッドを使用できます。既存のタブを更新するには、リクエストボディに tabId を含める必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelopes Put Status
<docusign:update-v21-accounts-envelopes-status-by-account-id>
一連のエンベロープの状況を取得します。次のクエリパラメーターのいずれかを指定する必要があります。
| パラメーター | 説明 |
|---|---|
|
有効な UTC 日時: |
|
エンベロープ ID のカンマ区切りリストまたは特別な値 |
|
トランザクション ID のカンマ区切りリストまたは特別な値 |
特別な値 request_body を使用する場合、リクエストボディは次のようになります。
{ "envelopeIds": [ "44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15", "8e26040d-xxxx-xxxx-xxxx-1e29b924d237", "c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95" ] }
注意: リクエストボディを完全に省略しないでください。リクエストボディは、少なくとも {} である必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/status エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
count (数) |
String (文字列) |
返す結果の最大数。 |
||
From to status (期間の状況) |
String (文字列) |
確認するエンベロープ状況。可能な値: - |
||
Email (メール) |
String (文字列) |
送信者のメールアドレス。 |
||
Ac status (AC 状況) |
String (文字列) |
エンベロープの正式コピー (Authoritative Copy) の状況を指定します。可能な値: - |
||
Envelope ids (エンベロープ ID) |
String (文字列) |
結果に含めるエンベロープ ID。このプロパティの可能な値: - エンベロープ ID のカンマ区切りリスト - 特別な値 |
||
block (ブロック) |
String (文字列) |
true に設定すると、指定された |
||
status (状況) |
String (文字列) |
検索するエンベロープ状況のカンマ区切りリスト。可能な値: - |
||
From date (開始日) |
String (文字列) |
要求でアカウントのエンベロープの状況の変更のチェックがいつ開始されるのかを指定する日時設定。パラメーター |
||
ユーザー名 |
String (文字列) |
このユーザー名を持つアカウントユーザーが送信したエンベロープに結果を制限します。 |
||
Start position (開始位置) |
String (文字列) |
検索の開始インデックス位置。 |
||
Transaction ids (トランザクション ID) |
String (文字列) |
結果に含めるトランザクション ID。トランザクション ID は 7 日間有効です。このプロパティの可能な値: - トランザクション ID のカンマ区切りリスト - 特別な値 |
||
To date (終了日) |
String (文字列) |
結果セット内のエンベロープ状況の変化の最終日時を指定する省略可能な日時設定。デフォルト値は、メソッドをコールした日時です。 |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Blob Put Tabs Blob
<docusign:update-v21-accounts-envelopes-tabs-blob-by-account-id-envelope-id>
この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Transfer Rules Put Envelope Transfer Rules
<docusign:update-v21-accounts-envelopes-transfer-rules-by-account-id>
このメソッドでは、リクエストボディの envelopeTransferRuleId に基づいて 1 つ以上のエンベロープ転送ルールの状況を変更します。このメソッドを使用して、ルールを有効にするかどうかを変更します。
注意: エンベロープ転送ルールに関するその他の情報は変更できません。エンベロープ転送ルールを更新できるのは、システム管理者のみです。また、エンベロープ転送ルールを使用するには、アカウントで [Transfer Custody (転送の管理)] 機能が有効になっている必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/transfer_rules エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Transfer Rules Put Envelope Transfer Rule
<docusign:update-v21-accounts-envelopes-transfer-rules-by-account-id-envelope-transfer-rule-id>
このメソッドではエンベロープ転送ルールの状況を変更します。このメソッドを使用して、ルールを有効にするかどうかを変更します。envelopeTransferRuleId をクエリパラメーターとして含めるほか、リクエストボディにも含める必要があります。
注意: エンベロープ転送ルールに関するその他の情報は変更できません。エンベロープ転送ルールを更新できるのは、システム管理者のみです。また、エンベロープ転送ルールを使用するには、アカウントで [Transfer Custody (転送の管理)] 機能が有効になっている必要があります。
この操作では、/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Transfer Rule Id (エンベロープ転送ルール ID) |
String (文字列) |
エンベロープ転送ルールの ID。この ID は、ルールの最初の作成時に生成されます。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Workflow Definition Put Envelope Workflow Definition
<docusign:update-v21-accounts-envelopes-workflow-by-account-id-envelope-id>
指定されたエンベロープのワークフロー定義がある場合、そのワークフロー定義を更新します。この操作では、/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Envelope Id (エンベロープ ID) |
String (文字列) |
エンベロープの GUID。例: |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Favorite Templates Put Favorite Template
<docusign:update-v21-accounts-favorite-templates-by-account-id>
この操作では、/v2.1/accounts/{accountId}/favorite_templates エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Folders Put Folder By Id
<docusign:update-v21-accounts-folders-by-account-id-folder-id>
現在のフォルダーから、指定されたフォルダーにエンベロープを移動します。このメソッドを使用して folderId パラメーターに recyclebin を指定すると、エンベロープを削除できます。処理中のエンベロープ (エンベロープの状況が sent または delivered) をごみ箱に配置すると、エンベロープが無効になります。このメソッドを使用して、envelopeIds プロパティにエンベロープ ID ではなくテンプレート ID を指定し、folderId パラメーターに recyclebin を指定すると、テンプレートを削除することもできます。
この操作では、/v2.1/accounts/{accountId}/folders/{folderId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Folder Id (フォルダー ID) |
String (文字列) |
フォルダーの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brands Put Group Brands
<docusign:update-v21-accounts-groups-brands-by-account-id-group-id>
このメソッドでは、groupId に基づいて 1 つ以上の既存のブランドをグループに追加します。この操作では、/v2.1/accounts/{accountId}/groups/{groupId}/brands エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Group Id (グループ ID) |
String (文字列) |
アクセスするグループの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Groups Put Groups
<docusign:update-v21-accounts-groups-by-account-id>
グループ名を更新し、グループの権限プロファイルを変更 (設定) します。この操作では、/v2.1/accounts/{accountId}/groups エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Groups Put Group Users
<docusign:update-v21-accounts-groups-users-by-account-id-group-id>
既存のグループに 1 人以上の既存の DocuSign ユーザーを追加します。この操作では、/v2.1/accounts/{accountId}/groups/{groupId}/users エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Group Id (グループ ID) |
String (文字列) |
アクセスするグループの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Permission Profiles Put Permission Profiles
<docusign:update-v21-accounts-permission-profiles-by-account-id-permission-profile-id>
このメソッドではアカウント権限プロファイルを更新します。この操作では、/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Permission Profile Id (権限プロファイル ID) |
String (文字列) |
権限プロファイルの ID。可能な値: - |
x |
|
include (含める) |
String (文字列) |
応答で返される追加プロパティのカンマ区切りリスト。この要求で有効な値は |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Put Power Form
<docusign:update-v21-accounts-powerforms-by-account-id-power-form-id>
このメソッドでは既存の PowerForm を更新します。この操作では、/v2.1/accounts/{accountId}/powerforms/{powerFormId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Power Form Id (パワーフォーム Id) |
String (文字列) |
PowerForm の ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Put Report In Product Save
<docusign:update-v21-accounts-reports-by-account-id-id>
この操作では、/v2.1/accounts/{accountId}/reports/{id} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
ID |
String (文字列) |
Salesforce オブジェクトの一意の ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Put Report In Product Run Results
<docusign:update-v21-accounts-reports-report-results-by-account-id>
この操作では、/v2.1/accounts/{accountId}/reports/report_results エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Put Report Results Csv
<docusign:update-v21-accounts-reports-report-results-csv-by-account-id>
この操作では、/v2.1/accounts/{accountId}/reports/report_results_csv エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Settings Put Settings
<docusign:update-v21-accounts-settings-by-account-id>
指定されたアカウントのアカウント設定を更新します。この操作では、/v2.1/accounts/{accountId}/settings エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
ENote Configuration Put ENote Configuration
<docusign:update-v21-accounts-settings-enote-configuration-by-account-id>
この操作では、/v2.1/accounts/{accountId}/settings/enote_configuration エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Purge Configuration Put Envelope Purge Configuration
<docusign:update-v21-accounts-settings-envelope-purge-configuration-by-account-id>
エンベロープパージ設定を使用すると、アカウント管理者は、完了したエンベロープと取り消されたエンベロープから文書とその項目データを、指定された保持期間 (retentionDays) の後、完全に削除できます。このメソッドでは、アカウントのエンベロープパージ設定を定義します。
注意: このメソッドを使用するには、アカウント管理者である必要があります。詳細は、 「エンベロープの消去」を参照してください。
この操作では、/v2.1/accounts/{accountId}/settings/envelope_purge_configuration エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notification Defaults Put Notification Defaults
<docusign:update-v21-accounts-settings-notification-defaults-by-account-id>
このメソッドでは、エンベロープに関して署名者と送信者が受け取るメール通知のデフォルト設定を変更します。この操作では、/v2.1/accounts/{accountId}/settings/notification_defaults エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Password Rules Put Account Password Rules
<docusign:update-v21-accounts-settings-password-rules-by-account-id>
このメソッドでは、アカウントのパスワードルールを更新します。
注意: アカウントのパスワードルールを更新するには、アカウント管理者である必要があります。
この操作では、/v2.1/accounts/{accountId}/settings/password_rules エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tab Settings Put Settings
<docusign:update-v21-accounts-settings-tabs-by-account-id>
このメソッドでは、タブ種別と、アカウントで有効なタブ機能を変更します。この操作では、/v2.1/accounts/{accountId}/settings/tabs エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Shared Access Put Shared Access
<docusign:update-v21-accounts-shared-access-by-account-id>
この操作では、1 人以上のユーザーまたは 1 つ以上のテンプレートの共有アクセス状況を設定します。ユーザーの共有アクセスを設定する場合、エンベロープの共有アクセス状況を設定できるのはアカウント管理権限を持つユーザーのみです。テンプレートの共有アクセスを設定する場合、テンプレートの共有アクセスを設定できるのはテンプレートを余裕して共有権限を持つユーザーまたはアカウント管理権限を持つユーザーのみです。共有項目状況に対する変更は加算的ではありません。変更すると、必ず現在の状況が置き換えられます。
テンプレートの共有アクセスを変更するには、クエリパラメーター item_type = templates を要求に追加します。これを設定した場合、ユーザーおよびエンベロープのプロパティは必要ありません。
注意: この機能は Update Group Share の機能を新しくしたバージョンです。
この操作では、/v2.1/accounts/{accountId}/shared_access エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Item type (項目種別) |
String (文字列) |
設定する共有項目の種別を指定します: - |
||
Preserve existing shared access (既存の共有アクセスを保持) |
String (文字列) |
true の場合、既存の共有アクセス設定を保持します。 |
||
User ids (ユーザー ID) |
String (文字列) |
共有項目アクセスを設定するユーザーの ID のカンマ区切りのリスト。 |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Put Account Signature
<docusign:update-v21-accounts-signatures-by-account-id>
この操作では、/v2.1/accounts/{accountId}/signatures エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Put Account Signature By Id
<docusign:update-v21-accounts-signatures-by-account-id-signature-id>
この操作では、/v2.1/accounts/{accountId}/signatures/{signatureId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
Close existing signature (既存の署名をクローズ) |
String (文字列) |
true に設定すると、現在の署名をクローズします。 |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Put Account Signature Image
<docusign:update-v21-accounts-signatures-by-account-id-signature-id-image-type>
この操作では、/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Image Type (画像の種類) |
String (文字列) |
画像の種類を指定します。有効な値: - |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
Transparent png (透過的な png) |
String (文字列) |
Transparent png (透過的な png) |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Put Signing Groups
<docusign:update-v21-accounts-signing-groups-by-account-id>
1 つ以上の既存の署名グループの名前を更新します。この操作では、/v2.1/accounts/{accountId}/signing_groups エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Put Signing Group
<docusign:update-v21-accounts-signing-groups-by-account-id-signing-group-id>
署名グループ名とメンバー情報を更新します。署名グループに新規メンバーを追加することもできます。署名グループに含めることができるメンバーは最大 50 人です。この操作では、/v2.1/accounts/{accountId}/signing_groups/{signingGroupId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Signing Group Id (署名グループ ID) |
String (文字列) |
省略可能。署名グループの ID。 注意: エンベロープを署名グループに送信すると、グループ内の誰でもエンベロープを開いて署名できます。このため、署名者以外の受信者 (カーボンコピー受信者など) を署名者の受信者と同じ署名グループに含めないことをお勧めします。ただし、署名者以外の受信者用に 2 番目の署名グループを作成し、デフォルトアクションの [Needs to Sign (署名が必要)] を [Receives a Copy (コピーを受け取る)] などの異なる値に変更することができます。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Put Signing Group Users
<docusign:update-v21-accounts-signing-groups-users-by-account-id-signing-group-id>
署名グループに 1 人以上の新規メンバーを追加します。署名グループに含めることができるメンバーは最大 50 人です。この操作では、/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Signing Group Id (署名グループ ID) |
String (文字列) |
省略可能。[署名グループ](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups)の |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tab Put Custom Tab
<docusign:update-v21-accounts-tab-definitions-by-account-id-custom-tab-id>
指定されたアカウントのカスタムタブの情報を更新します。この操作では、/v2.1/accounts/{accountId}/tab_definitions/{customTabId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Custom Tab Id (カスタムタブ ID) |
String (文字列) |
DocuSign により生成された、適用するカスタムタブのカスタムタブ ID。これは、受信者用の新規タブを追加する場合にのみ使用できます。使用時に、新規タブはすべてのカスタムタブプロパティを継承します。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Put Template
<docusign:update-v21-accounts-templates-by-account-id-template-id>
既存のテンプレートを更新します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Put Template Part
<docusign:update-v21-accounts-templates-by-account-id-template-id-template-part>
テンプレートを指定されたメンバーのグループと共有します。
注意: この機能の新バージョンについては、 「Accounts::Update Shared Access (アカウント: 共有アクセスの更新)」を参照してください。
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Template Part (テンプレートパート) |
String (文字列) |
現在、定義されたパートは groups のみです。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Custom Fields Put Template Custom Fields
<docusign:update-v21-accounts-templates-custom-fields-by-account-id-template-id>
テンプレートのカスタム項目を更新します。テンプレートで使用する各カスタム項目には一意の名前を付ける必要があります。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Documents Put Template Documents
<docusign:update-v21-accounts-templates-documents-by-account-id-template-id>
既存のテンプレートドキュメントに 1 つ以上のドキュメントを追加します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Documents Put Template Document
<docusign:update-v21-accounts-templates-documents-by-account-id-template-id-document-id>
このメソッドでは、既存のテンプレートドキュメントを更新します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Is envelope definition (エンベロープ定義である) |
String (文字列) |
Is envelope definition (エンベロープ定義である) |
||
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Document Fields Put Template Document Fields
<docusign:update-v21-accounts-templates-documents-fields-by-account-id-template-id-document-id>
既存のテンプレートドキュメントの既存のカスタムドキュメント項目を更新します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Pages Put Template Page Image
<docusign:update-v21-accounts-templates-documents-pages-page-image-by-account-id-template-id-document-id-page-number>
表示用にテンプレートからのページ画像を回転します。ページ画像は左または右に回転できます。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Page Number (ページ番号) |
String (文字列) |
アクセスするページ番号。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Put Template Document Tabs
<docusign:update-v21-accounts-templates-documents-tabs-by-account-id-template-id-document-id>
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Document Id (ドキュメント ID) |
String (文字列) |
|
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Lock Put Template Lock
<docusign:update-v21-accounts-templates-lock-by-account-id-template-id>
このメソッドでは、指定されたテンプレートのロック期間または lockedByApp プロパティ情報を更新します。ユーザーとインテグレーターキーは lockByUser プロパティおよびインテグレーターキー情報でしてされたユーザーに一致する必要があります。ロックの所有権を証明する lockToken と lockDurationInSeconds が含まれる X-DocuSign-Edit ヘッダーも含める必要があります。このヘッダーで必要なトークンは POST および GET メソッドの応答で返されます。
例: X-DocuSign-Edit:{{lockToken}}
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/lock エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notification Put Templates Template Id Notification
<docusign:update-v21-accounts-templates-notification-by-account-id-template-id>
既存のテンプレートの通知構造を更新します。このエンドポイントを使用して、リマインダーと有効期限に関する通知を設定します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/notification エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Put Template Bulk Recipients
<docusign:update-v21-accounts-templates-recipients-bulk-recipients-by-account-id-template-id-recipient-id>
ファイルのアップロードを使用してテンプレート内の一括受信者を更新します。一括受信者ファイルのアップロードにサポートされる Content-Type は CSV (text/csv) です。REST API では、一括受信者ファイル内の個別の行または値の変更はサポートされていません。ファイル全体の追加または新規ファイルへの置換のみ可能です。
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Put Template Recipients
<docusign:update-v21-accounts-templates-recipients-by-account-id-template-id>
テンプレート内の受信者を更新します。次のプロパティを編集できます: email、userName、routingOrder、faxNumber、deliveryMethod、accessCode、requireIdLookup。
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Resend envelope (エンベロープを再送信) |
String (文字列) |
true に設定されている場合、リクエストボディで指定した受信者にエンベロープを再送信します。元のメール通知を削除した受信者にエンベロープを再送信するには、このパラメーターを使用します。 注意: エンベロープの修正は、別のプロセスになります。ここで入力した値に関係なく、エンベロープを修正すると必ず DocuSign からエンベロープが再送信されます。 |
||
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Put Template Recipients Document Visibility
<docusign:update-v21-accounts-templates-recipients-document-visibility-by-account-id-template-id>
このメソッドでは、リクエストボディに含めた recipientId 値と visible 値に基づいて 1 人以上のテンプレート受信者のドキュメントの表示を更新します。
注意: 受信者に割り当てられたタブが文書にある場合、その受信者に対して文書を非表示にすることはできません。カーボンコピー、認定配信 (署名が必要)、編集者、および代理人の各受信者は常にすべての文書を表示できます。
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Put Template Recipient Document Visibility
<docusign:update-v21-accounts-templates-recipients-document-visibility-by-account-id-template-id-recipient-id>
このメソッドでは、テンプレート受信者のドキュメントの表示を更新します。
注意: 受信者に割り当てられたタブが文書にある場合、その受信者に対して文書を非表示にすることはできません。カーボンコピー、認定配信 (署名が必要)、編集者、および代理人の各受信者は常にすべての文書を表示できます。
この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Put Template Recipient Tabs
<docusign:update-v21-accounts-templates-recipients-tabs-by-account-id-template-id-recipient-id>
テンプレート内の受信者の 1 つ以上のタブを更新します。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Recipient Id (受信者 ID) |
String (文字列) |
送信者が受信者を他のオブジェクト (特定のドキュメントタブなど) にマップするために使用するローカル参照。各 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Binary (バイナリ) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Workflow Definition Put Template Workflow Definition
<docusign:update-v21-accounts-templates-workflow-by-account-id-template-id>
指定されたテンプレートのワークフロー定義を更新します (ワークフロー定義がある場合)。この操作では、/v2.1/accounts/{accountId}/templates/{templateId}/workflow エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Template Id (テンプレート ID) |
String (文字列) |
テンプレートの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Users Put Users
<docusign:update-v21-accounts-users-by-account-id>
このメソッドでは、1 人以上のアカウントユーザーに関する情報を更新します。この操作では、/v2.1/accounts/{accountId}/users エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Put User
<docusign:update-v21-accounts-users-by-account-id-user-id>
特定のユーザーのユーザー情報を更新するには、この操作のリクエストボディに更新した項目値を含めて [Users](#Users) オブジェクトを送信します。この操作では、/v2.1/accounts/{accountId}/users/{userId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Custom Settings Put Custom Settings
<docusign:update-v21-accounts-users-custom-settings-by-account-id-user-id>
指定されたユーザーのカスタムユーザー設定を追加または更新します。
*注意: カスタムユーザー設定はユーザーアカウント設定と同じではありません。カスタム設定により、カスタムユーザー情報を柔軟に保存して取得し、自分のシステムで使用できます。
重要: 1 人のユーザーのすべてのカスタムユーザー設定のサイズには制限があります。制限は 4,000 文字で、これには設定の XML および JSON 構造が含まれます。
カスタムユーザー設定のグループ化
カスタムユーザー設定は、追加するときにグループ化できます。グループ化することにより、すべてのユーザーのカスタム設定を取得する代わりに、特定のグループ内の設定を取得できます。カスタムユーザー設定をグループ化するには、Content-Type の後に次の情報を追加します: X-DocuSign-User-Settings-Key:group_name。ここで、group_name は顧客のユーザー設定のグループの指定名です。
グループ化されたカスタムユーザー設定を取得または削除する場合、追加のヘッダー情報を含める必要があります。カスタムユーザー設定のグループ化は必須ではなく、追加のヘッダー情報を含めなかった場合、カスタムユーザー設定は通常どおりに追加され、追加のヘッダーを含めることなく取得または削除できます。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/custom_settings エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Profile Put Profile
<docusign:update-v21-accounts-users-profile-by-account-id-user-id>
ユーザー ID カード内のユーザーの詳細情報、プロファイル情報、プライバシーの設定、個人情報を更新します。userDetails プロパティ内の情報を変更することで、ユーザーの名前を変更することもできます。ユーザーの名前を変更する場合、userName プロパティ内の情報を変更することも、firstName、middleName、lastName, suffixName、title プロパティ内の情報を変更することもできます。firstName、middleName、lastName、suffixName、title プロパティに対する変更は、userName プロパティに対する変更よりも優先されます。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/profile エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Profile Image Put User Profile Image
<docusign:update-v21-accounts-users-profile-image-by-account-id-user-id>
ユーザープロファイルに画像をアップロードして、ユーザープロファイル画像を更新します。サポートされる画像形式は gif、png、jpeg、bmp です。ファイルは 200K 未満である必要があります。最適な表示結果を得るために、DocuSign では画像の幅と高さが 79 ピクセルを超えないようにすることが推奨されています。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/profile/image エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Settings Put User Settings
<docusign:update-v21-accounts-users-settings-by-account-id-user-id>
指定されたユーザーのアカウント設定リストとメール通知種別を更新します。この操作では、/v2.1/accounts/{accountId}/users/{userId}/settings エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
String (文字列) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Signatures Put User Signature
<docusign:update-v21-accounts-users-signatures-by-account-id-user-id>
この操作では、/v2.1/accounts/{accountId}/users/{userId}/signatures エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Signatures Put User Signature By Id
<docusign:update-v21-accounts-users-signatures-by-account-id-user-id-signature-id>
指定されたユーザーの署名のフォントとイニシャルを作成または更新します。署名を作成する場合、このリソースを使用して署名の名前を作成し、署名とイニシャルの画像を署名に追加できます。
注意: これにより、ユーザーのデフォルトの署名も作成されます (存在していない場合)。
エンドポイントで適切に指定されたユーザー ID は認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーはアカウントのメンバーである必要があります。signatureId パラメーターは署名 ID を受け入れます。名前によっては、URL に適切にエンコードされない文字が含まれている場合があるため、署名 ID (signatureId) を使用することをお勧めします。ユーザー名を使用する場合、名前にスペースが含まれている可能性があります。この場合、エンドポイントでこの名前を使用する前に名前を URL エンコードします。たとえば、「Bob Smith」を「Bob%20Smith」としてエンコードします。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Close existing signature (既存の署名をクローズ) |
String (文字列) |
true に設定すると、現在の署名をクローズします。 |
||
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
User Signatures Put User Signature Image
<docusign:update-v21-accounts-users-signatures-by-account-id-user-id-signature-id-image-type>
指定されたユーザーのユーザー署名画像またはユーザーイニシャル画像を更新します。このファイルでサポートされる画像形式: gif、png、jpeg、bmp。ファイルは 200K 未満である必要があります。
エンドポイントで適切に指定されたユーザー ID は認証済みユーザーのユーザー ID と一致する必要があり、そのユーザーはアカウントのメンバーである必要があります。signatureId パラメーターでは署名 ID または署名の名前を受け入れます。名前によっては、URL に適切にエンコードされない文字が含まれている場合があるため、署名 ID (signatureId) を使用することをお勧めします。ユーザー名を使用する場合、名前にスペースが含まれている可能性があります。この場合、エンドポイントでこの名前を使用する前に名前を URL エンコードします。たとえば、「Bob Smith」を「Bob%20Smith」としてエンコードします。
この操作では、/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Image Type (画像の種類) |
String (文字列) |
画像の種類を指定します。有効な値: - |
x |
|
Signature Id (署名 ID) |
String (文字列) |
アクセスする署名の ID。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
アクセスするユーザーの ID。一般に、これは現在の認証済みユーザーの ID ですが、認証済みユーザーがアカウントの管理者の場合、 |
x |
|
Transparent png (透過的な png) |
String (文字列) |
Transparent png (透過的な png) |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Watermark Put Watermark
<docusign:update-v21-accounts-watermark-by-account-id>
この操作では、/v2.1/accounts/{accountId}/watermark エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Watermark Preview Put Watermark Preview
<docusign:update-v21-accounts-watermark-preview-by-account-id>
この操作では、/v2.1/accounts/{accountId}/watermark/preview エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Workspace Put Workspace
<docusign:update-v21-accounts-workspaces-by-account-id-workspace-id>
特定のワークスペースに関する情報を更新します。この操作では、/v2.1/accounts/{accountId}/workspaces/{workspaceId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
Workspace Id (ワークスペース ID) |
String (文字列) |
ワークスペースの ID。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Workspace File Put Workspace File
<docusign:update-v21-accounts-workspaces-folders-files-by-account-id-workspace-id-folder-id-file-id>
このメソッドでは、ワークスペース内の 1 つ以上の特定のファイルまたはフォルダーのメタデータを更新します。この操作では、/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Account Id (アカウント ID) |
String (文字列) |
外部アカウント番号 (int) またはアカウント ID (GUID)。 |
x |
|
File Id (ファイル ID) |
String (文字列) |
ファイルの ID。 |
x |
|
Folder Id (フォルダー ID) |
String (文字列) |
フォルダーの ID。 |
x |
|
Workspace Id (ワークスペース ID) |
String (文字列) |
ワークスペースの ID。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
#[null] |
||
Custom Headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notary Put Notary
<docusign:update-v21-current-user-notary>
現在のユーザーの公証人情報を取得します。この操作では、/v2.1/current_user/notary エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Notary Jurisdictions Put Notary Jurisdiction
<docusign:update-v21-current-user-notary-jurisdictions-by-jurisdiction-id>
公証人に関する管轄情報を更新します。次の制限が適用されます。
-
現在のユーザーは公証人である必要があります。
-
jurisdictionId パスパラメーターは、その公証人が登録されている管轄である必要があります。 -
jurisdictionId パスパラメーターは、リクエストボディの jurisdiction.jurisdictionId に一致する必要があります。
リクエストボディには、管轄プロパティの jurisdiction オブジェクトをすべて含める必要があります。その最適な方法は、getNotaryJurisdiction を使用して現在の値を取得し、変更するプロパティを更新する方法です。たとえば、getNotaryJurisdiction によって次が返されるとします。
{
"jurisdiction": {
"jurisdictionId": "15",
"name": "Iowa",
"county": "",
"enabled": "true",
"countyInSeal": "false",
"commissionIdInSeal": "true",
"stateNameInSeal": "true",
"notaryPublicInSeal": "true",
"allowSystemCreatedSeal": "true",
"allowUserUploadedSeal": "false"
},
"commissionId": "123456",
"commissionExpiration": "2020-08-31T07:00:00.0000000Z",
"registeredName": "Bob Notary",
"county": "Adams",
"sealType": "system_created"
}json公証人の名前を「Bob Notary」から「Robert Notary」に変更する場合、リクエストボディは次のようになります。
{
"jurisdiction": {
"jurisdictionId": "15",
"name": "Iowa",
"county": "",
"enabled": "true",
"countyInSeal": "false",
"commissionIdInSeal": "true",
"stateNameInSeal": "true",
"notaryPublicInSeal": "true",
"allowSystemCreatedSeal": "true",
"allowUserUploadedSeal": "false"
},
"commissionId": "123456",
"commissionExpiration": "2020-08-31T07:00:00.0000000Z",
"registeredName": "Robert Notary",
"county": "Adams",
"sealType": "system_created"
}jsonこの操作では、/v2.1/current_user/notary/jurisdictions/{jurisdictionId} エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Jurisdiction Id (管轄区域 ID) |
String (文字列) |
管轄区域の ID。サポートされる管轄区域: - |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
APIRequest Log Put Request Log Settings
<docusign:update-v21-diagnostics-settings>
トラブルシューティングのために API 要求の記録を有効化または無効化します。有効化 (apiRequestLogging が true) すると、ユーザーの REST API 要求と応答がログに追加されます。ログには最大 50 件の要求/応答を含めることができ、ログエントリの現在の件数は設定を取得することで判断できます。ログの上限である 50 件に達すると、記録は自動的に無効化されます。
Diagnostics::getRequestLog または Diagnostics::listRequestLogs をコールしてログファイルをダウンロードできます (個別に、または zip ファイルとして)。現在のエントリを削除してログをクリアするには、 Diagnostics::deleteRequestLogs をコールします。
パスワードやインテグレーターキー情報などのプライベート情報は通常コールヘッダーにあり、要求/応答ログでは省略されます。API 要求の記録で取得するのは、認証済みユーザーからの要求のみです。ユーザーを認証せず、userId を解決しないコールは記録されません。
この操作では、/v2.1/diagnostics/settings エンドポイントに対する HTTP PUT 要求を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Body (本文) |
Any (任意) |
使用するコンテンツ |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Streaming Strategy (ストリーミング戦略) |
|
Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。 |
||
Custom Query Parameters (カスタムクエリパラメーター) |
Object (オブジェクト) |
|||
Custom headers (カスタムヘッダー) |
Object (オブジェクト) |
|||
Response Timeout (応答タイムアウト) |
Number (数値) |
リモートサービスへの要求のタイムアウト。 |
||
Response Timeout Unit (応答タイムアウト単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Response Timeout (応答タイムアウト)] 項目の時間単位。 |
||
Streaming Type (ストリーミング種別) |
Enumeration (列挙)。次のいずれかになります。
|
要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力を評価する式。式の結果は対象変数に保存されます。 |
#[payload] |
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
出力
型 |
Any (任意) |
Attributes Type (属性型) |
次の設定の場合
スロー
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
型
Default Header (デフォルトヘッダー)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Key (キー) |
String (文字列) |
x |
||
Value (値) |
String (文字列) |
x |
Default Query Param (デフォルトクエリパラメーター)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Key (キー) |
String (文字列) |
x |
||
Value (値) |
String (文字列) |
x |
Proxy (プロキシ)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Host (ホスト) |
String (文字列) |
x |
||
Port (ポート) |
Number (数値) |
x |
||
Username (ユーザー名) |
String (文字列) |
|||
Password (パスワード) |
String (文字列) |
|||
Non Proxy Hosts (非プロキシホスト) |
String (文字列) |
TLS
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Enabled Protocols (有効化されたプロトコル) |
String (文字列) |
このコンテキストで有効化されたプロトコルのカンマ区切りリスト。 |
||
Enabled Cipher Suites (有効化された暗号化スイート) |
String (文字列) |
このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。 |
||
トラストストア |
||||
Key Store (キーストア) |
||||
Revocation Check (取り消し確認) |
Trust Store (トラストストア)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Path (パス) |
String (文字列) |
トラストストアへのパス。Mule では、可能であれば、現在のクラスパスとファイルシステムへの相対的なパスを解決します。 |
||
Password (パスワード) |
String (文字列) |
トラストストアを保護するために使用するパスワード。 |
||
Type (型) |
String (文字列) |
使用するトラストストアの型。 |
||
Algorithm (アルゴリズム) |
String (文字列) |
トラストストアで使用するアルゴリズム。 |
||
Insecure (安全ではない) |
Boolean (ブール) |
|
Key Store (キーストア)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Path (パス) |
String (文字列) |
キーストアへのパス。Mule では、可能であれば、現在のクラスパスとファイルシステムへの相対的なパスを解決します。 |
||
Type (型) |
String (文字列) |
使用するキーストアの型。 |
||
Alias (別名) |
String (文字列) |
キーストアに多数の非公開キーがある場合、この属性は、使用するキーの別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。 |
||
Key Password (キーパスワード) |
String (文字列) |
非公開キーを保護するために使用するパスワード。 |
||
Password (パスワード) |
String (文字列) |
キーストアを保護するために使用するパスワード。 |
||
Algorithm (アルゴリズム) |
String (文字列) |
キーストアで使用するアルゴリズム。 |
Standard Revocation Check (標準の取り消し確認)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Only End Entities (最後のエンティティのみ) |
Boolean (ブール) |
証明書チェーンの最後の要素のみを確認します。 |
||
Prefer Crls (CRL を優先) |
Boolean (ブール) |
最初に OCSP ではなく CRL を試みます。 |
||
No Fallback (代替なし) |
Boolean (ブール) |
第 2 の確認方法 (以前に選択されていない方法) を使用しません。 |
||
Soft Fail (ソフトフェール) |
Boolean (ブール) |
取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。 |
Custom OCSP Responder (カスタム OCSP レスポンダー)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Url |
String (文字列) |
OCSP レスポンダーの URL。 |
||
Cert Alias (証明書の別名) |
String (文字列) |
(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。 |
CRL File (CRL ファイル)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Path (パス) |
String (文字列) |
CRL ファイルへのパス。 |
Reconnection (再接続)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Fails Deployment (デプロイに失敗) |
Boolean (ブール) |
アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。 |
||
Reconnection Strategy (再接続戦略) |
使用する再接続戦略。 |
Reconnect (再接続)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Frequency (頻度) |
Number (数値) |
再接続する頻度 (ミリ秒)。 |
||
Blocking |
Boolean (ブール) |
false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。 |
||
Count (数) |
Number (数値) |
再接続の試行回数。 |
Reconnect Forever (繰り返し再接続)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Frequency (頻度) |
Number (数値) |
再接続する頻度 (ミリ秒)。 |
||
Blocking |
Boolean (ブール) |
false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。 |
Expiration Policy (有効期限ポリシー)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Max Idle Time (最大アイドル時間) |
Number (数値) |
有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値 |
||
Time Unit (時間単位) |
Enumeration (列挙)。次のいずれかになります。
|
maxIdleTime 属性の時間単位 |
HTTP Response Attributes (HTTP 応答属性)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Status Code (状況コード) |
Number (数値) |
x |
||
Headers (ヘッダー) |
Object (オブジェクト) |
x |
||
Reason Phrase (理由を示す語句) |
String (文字列) |
x |
Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
メモリ内ストリーミング戦略を設定します。この戦略を使用した場合、データがバッファサイズを超えた場合、要求は失敗します。ユースケースで最適なバッファサイズは、必ずパフォーマンステストを実施して決めてください。
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Initial Buffer Size (初期バッファサイズ) |
Number (数値) |
ストリームをコンシュームしてランダムにアクセスするために割り当てられるメモリ量。ストリームのデータ量がこのバッファサイズを超える場合は、[Buffer Size Increment (バッファサイズ増分)] 値に従って、[Max In Memory Size (最大メモリ内サイズ)] 値を上限としてバッファが拡張されます。 |
||
Buffer Size Increment (バッファサイズ増分) |
Number (数値) |
バッファサイズが初期サイズを超えた場合に、拡張する量。値を |
||
Max Buffer Size (最大バッファサイズ) |
Number (数値) |
使用するメモリの最大量。これを超えると、STREAM_MAXIMUM_SIZE_EXCEEDED エラーが発生します。0 以下の値は無制限を意味します。 |
||
Buffer Unit (バッファ単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Initial Buffer Size (初期バッファサイズ)] 項目、[Buffer Size Increment (バッファサイズ増分)] 項目、[Buffer Unit (バッファ単位)] 項目のサイズの単位。 |
Repeatable File Store Stream (反復可能なファイルストアストリーム)
反復可能なファイルストアストリーミング戦略を設定します。この戦略を使用した場合、Mule では、ストリームデータの一部をメモリ内に格納します。ストリームのコンテンツが、設定されたバッファサイズよりも大きい場合、Mule はバッファのコンテンツをディスクにバックアップしてからメモリをクリアします。
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
In Memory Size (メモリ内サイズ) |
Number (数値) |
データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクのコンテンツがバッファされます。 |
||
Buffer Unit (バッファ単位) |
Enumeration (列挙)。次のいずれかになります。
|
maxInMemorySize で表される単位 |
反復不可能ストリーム
反復可能ストリーム機能を無効にして反復不可能ストリームを使用します。これにより、パフォーマンスオーバーヘッド、メモリ使用量、およびコストが抑えられます。
Redelivery Policy (再配信ポリシー)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Max Redelivery Count (最大再配信数) |
Number (数値) |
正常に処理されずにプロセス失敗メッセージがトリガーされるまでにメッセージを再配信できる最大回数。 |
||
Message Digest Algorithm (メッセージダイジェストアルゴリズム) |
String (文字列) |
使用するセキュアハッシュアルゴリズム。設定しない場合、デフォルトの SHA-256 になります。 |
||
Message Identifier (メッセージ識別子) |
メッセージを識別するために使用する戦略を定義します。 |
|||
Object Store (オブジェクトストア) |
ObjectStore |
各メッセージの再配信カウンターが保存されるオブジェクトストア。 |
Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Use Secure Hash (セキュアハッシュを使用) |
Boolean (ブール) |
再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。 |
||
Id Expression (ID 式) |
String (文字列) |
メッセージがいつ再配信されたのかを判断するために使用する 1 つ以上の式を定義します。このプロパティは、useSecureHash が false の場合にのみ設定できます。 |
Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Initial Buffer Size (初期バッファサイズ) |
Number (数値) |
ストリームを使用し、ランダムアクセスを提供するために、最初にメモリ内に保持するインスタンスの数。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。デフォルト値は 100 インスタンスです。 |
||
Buffer Size Increment (バッファサイズ増分) |
Number (数値) |
バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、STREAM_MAXIMUM_SIZE_EXCEEDED エラーが発生します。デフォルト値は 100 インスタンスです。 |
||
Max Buffer Size (最大バッファサイズ) |
Number (数値) |
使用するメモリの最大量。これを超えると、STREAM_MAXIMUM_SIZE_EXCEEDED エラーが発生します。0 以下の値は無制限を意味します。 |
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
In Memory Objects (メモリ内オブジェクト) |
Number (数値) |
メモリ内に保持されるインスタンスの最大数。これ以上の量が必要な場合、ディスク上のコンテンツがバッファされます。 |
||
Buffer Unit (バッファ単位) |
Enumeration (列挙)。次のいずれかになります。
|
maxInMemorySize で表される単位 |