CData Sync App は、DocuSign データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
DocuSign コネクタはCData Sync アプリケーションから使用可能で、DocuSign からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、DocuSign API を利用してDocuSign への双方向アクセスを実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
AccountId
AccountId はオプションの接続プロパティです。認証が成功すると自動的に設定されます。
または、複数のAccount Id にアクセスできる場合は、接続文字列で手動で設定できます。アカウントId を取得するには、UserInfo ビューをクエリします。
DocuSign はOAuth 認証標準を利用しています。OAuth を使って認証するには、カスタムアプリを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得する必要があります。Sync App は、OAuth JWT 認証もサポートしています。カスタムアプリケーションの作成について詳しくは、カスタムOAuth アプリの作成 を参照してください。
AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。
AuthScheme をOAuthJWT に設定します。
Retrieve your User ID by navigating, in the DocuSign UI, to Settings > Apps and Keys > My Account Information > User ID.
Follow the procedure below to obtain an integration key:
In order to connect, you must give consent to the application. DocuSign offers three different software patterns for granting consent to an integration key. Grant consent to your application using one of the following methods.
This is the best option for customer-oriented developers, because it requires nothing from your users.
Note: This pattern can't be used by ISVs.
This method of obtaining consent has the following prerequisites:
If you meet these requirements, grant consent as follows:
This option has no prerequisites and can be used by customer-oriented developers and the customers of ISVs. Each user must perform the following steps.
To obtain individual consent:
You can grant administrative consent to third party (ISV) applications.
This method of obtaining consent has the following prerequisites:
If you meet these requirements, obtain consent as follows. Each user must perform the following steps.
このセクションでは、DocuSign Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、DocuSign にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、DocuSign API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なビューを説明します。ビューは、Accounts、Documents、Folders などを静的にモデル化するように定義されています。
ストアドプロシージャ は、DocuSign のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、DocuSign の操作を実行できます。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| AccountBrands | The AcccountBrands resource provides methods that allow you to manage the account brand associated with an account. |
| AccountCustomFields | The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account. |
| Accounts | The Accounts resource provides methods that allow you to manage your accounts. |
| BulkSendBatchStatus | Gets the general status of a specific bulk send batch . |
| CloudStorageProviders | The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account. |
| CustomTabs | The CustomTabs resource provides methods that allow you to manage custom tabs based on the existing DocuSign tabs. |
| Documents | The Documents resource provides methods that manage documents in an envelope or template. |
| DocumentTabs | The DocumentTabs resource provides methods that allow you to manage various tabs in envelopes or templates. |
| DocumentVisibility | The Document Visibility resource provides methods that manage document views and insights in an envelope or template. |
| EnvelopeAttachments | The EnvelopeAttachments resource provides methods that allow you to manage attachments. |
| EnvelopeConsumerDisclosures | The EnvelopeConsumerDisclosures resource provides a method that allows you to retrieve the consumer disclosure for an envelope. |
| EnvelopeFormData | Returns envelope tab data for an existing envelope.To use this feature, the Sending Setting Allow sender to download form data must be enabled for the account. |
| Envelopes | The Envelope resource provides methods that allow you to manage envelopes. |
| EnvelopeTemplates | The EnvelopeTemplates resource provides methods that allow you to add and delete templates on envelopes and documents. |
| Folders | Retrieves a list of the folders for the account. |
| GroupBrands | The GroupBrands resource provides methods that allow you to manage brands in a group. |
| Groups | The Groups resource provides methods that allow you to manage groups for the account. |
| GroupUsers | The GroupUsers resource provides methods that allow you to manage the users in a group. |
| Locks | The Locks resource provides methods that allow you to manage locks on an envelope or template. |
| PowerForms | The PowerForms resource provides methods that allow you to manage power forms. |
| Recipients | The Recipients resource allows you manage the recipients of an envelope or template. |
| RecipientTabs | The RecipientTabs resource provides methods that let you add, update, and delete tabs from an envelope or template. |
| SendListBulkCopies | Represents an instance or copy of an envelope |
| SendListRecipients | This method returns all of the details of recipents associated with a specific bulk send list that belongs to the current user. |
| SendLists | A list of bulk send lists belonging to the current user, as well as basic information about each list. |
| SigningGroups | Returns data from a sample table. |
| SigningGroupUsers | The SigningGroupUsers resource provides methods that allow you to manage users in Signing Groups. |
| Templates | The Template resource provides methods that allow you to manage templates. |
| UserInfo | The UserInfo resource provides methods that allow you to manage your current user info. |
| Users | The Users resource provides methods that allow you to manage users for an account. |
| UserSignatures | The UserSignatures resource provides methods that allow you manage the intials and signature images for a user. |
| Workspaces | The Workspaces resource provides methods that allow you to manage workspaces. |
The AcccountBrands resource provides methods that allow you to manage the account brand associated with an account.
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM AccountBrands WHERE BrandId = '4701f9c2-1038-45cf-bf35-66ae143a5656'
| Name | Type | References | Description |
| BrandId [KEY] | String | Id of the brand. | |
| BrandName | String | Name of the brand. | |
| BrandCompany | String | The name of the company associated with this brand. | |
| IsOverridingCompanyName | Boolean | When is set to true, brand name is the name of the company. | |
| IsSendingDefault | Boolean | When is set to true, it is sending default. | |
| IsSigningDefault | Boolean | When is set to true, it is signing default. |
The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account.
DocuSign does not support any column for filtering this view. All filters will be executed client side.
| Name | Type | References | Description |
| FieldId [KEY] | Integer | An ID used to specify a custom field. | |
| Name | String | The name of the custom field. | |
| CustomFieldType | String | Type of the custom field. | |
| ListOfValues | String | Comma separated value of the . | |
| Show | Boolean | A boolean indicating if the value should be displayed. If this value is set to true, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to false, then it does not appear in the certificate of completion. | |
| Required | Boolean | When set to true, the signer is required to fill out this tab | |
| ConfigurationType | String | If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce. |
The Accounts resource provides methods that allow you to manage your accounts.
DocuSign does not support any column for filtering this view. All filters will be executed client side.
| Name | Type | References | Description |
| AccountId [KEY] | Integer | Id of the account. | |
| AccountIdGuid | String | The GUID associated with the account ID. | |
| AccountName | String | The name of the current account. | |
| CreatedDate | Datetime | The date when account was created. | |
| CurrencyCode | String | Specifies the ISO currency code for the account. | |
| CurrentPlanId | String | Identifies the plan that was used create this account. | |
| PlanName | String | The name of the Billing Plan. | |
| PlanClassification | String | Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. | |
| PlanStartDate | Datetime | The date that the Account started using the current plan. | |
| PlanEndDate | Datetime | The date that the current plan will end. | |
| PaymentMethod | String | Method of the payment. | |
| EnvelopeUnitPrice | String | Price of an envelope. | |
| EnvelopeSendingBlocked | Boolean | When set to true, user can not send envelopes. | |
| BillingProfile | String | The name of the Billing Profile. | |
| BillingPeriodStartDate | Datetime | The UTC DateTime that account billing started. | |
| BillingPeriodEndDate | Datetime | The UTC DateTime that account billing finish. | |
| BillingPeriodDaysRemaining | Integer | Number of remaining billing days. | |
| BillingPeriodEnvelopesSent | Integer | Number of sent envelopes. | |
| BillingPeriodEnvelopesAllowed | String | Specifies the allowed number of sent envelopes. | |
| CanCancelRenewal | Boolean | When set to true, specifies that you can cancel renewal. | |
| CanUpgrade | Boolean | When set to true, specifies that you can upgrade the account through the API. | |
| IsDowngrade | Boolean | When set to true, specifies that your account is downgraded. | |
| AllowTransactionRooms | Boolean | When set to true, the transaction rooms feature exposed through the Workspaces API is enabled. |
Gets the general status of a specific bulk send batch .
In order to make a successful request on this view, you have to specify:
For example:
SELECT * FROM BulkSendBatchStatus where bulksendbatchid='2a554c07-6c-bccda356db31'
| Name | Type | References | Description |
| BulkSendBatchId | String | Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches. | |
| BatchSize | Integer | The number of items returned in this response. | |
| EnvelopesUri | String | Uri of the bulk envelopes. | |
| SubmittedDate | Datetime | The date that it is submitted. | |
| Sent | Integer | The number of entries with a status of sent. | |
| Failed | Integer | The number of entries with a status of failed. | |
| Queued | Integer | The number of entries with a status of queued. | |
| EnvelopeIdOrTemplateId | String | The number of entries with a status of queued. | |
| Action | String | Action. | |
| ActionStatus | String | Action Status. | |
| BatchName | String | The batch name. | |
| BulkErrors | String | Bulk Errors. | |
| EnvelopesInfo | String | Envelopes Info. | |
| MailingListId | String | The ID of the mailing list used to create the batch. | |
| MailingListName | String | The name of the mailing list used to create the batch. | |
| OwnerUserId | String | The Owner User Id. | |
| ResendsRemaining | String | Resends Remaining. | |
| SenderUserId | String | Sender User Id. |
The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.
In order to make a successful request on this view, you have to specify UserId.
For example:
SELECT * FROM CloudStorageProviders WHERE UserId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a'
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM CloudStorageProviders WHERE userId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a' AND ServiceId = '440189'
| Name | Type | References | Description |
| UserId | String | Id of the user account | |
| ServiceId | String | The DocuSign generated ID for the cloud storage provider | |
| Service [KEY] | String | The service name for the cloud storage provider. | |
| AuthenticationUrl | String | The authentication URL used for the cloud storage provider. | |
| RedirectUrl | String | The URL the user is redirected to after the cloud storage provider authenticates the user. |
The CustomTabs resource provides methods that allow you to manage custom tabs based on the existing DocuSign tabs.
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM CustomTabs WHERE CustomTabId = '926770b6-1cb6-487c-918c-dacf8c9caa2a'
| Name | Type | References | Description |
| CustomTabId [KEY] | String | The DocuSign generated custom tab ID for the custom tab to be applied. | |
| Name | String | Name of the tab. | |
| Type | String | The type of this tab. | |
| TabLabel | String | The label string associated with the tab. | |
| Font | String | The font to be used for the tab value. | |
| Bold | Boolean | When set to true, the information in the tab is bold. | |
| Italic | Boolean | When set to true, the information in the tab is italic. | |
| Underline | Boolean | When set to true, the information in the tab is underlined. | |
| FontColor | String | The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White. | |
| FontSize | String | The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72. | |
| Width | Integer | Width of the tab in pixels. | |
| Height | Integer | Height of the tab in pixels. | |
| Editable | Boolean | When set to true, the custom tab is editable. Otherwise the custom tab cannot be modified. | |
| DisableAutoSize | Boolean | When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. | |
| CreatedByUserId | String | The userId of the DocuSign user who created this object. | |
| CreatedByDisplayName | String | The user name of the DocuSign user who created this object. | |
| Locked | Boolean | When set to true, the signer cannot change the data of the custom tab. | |
| LastModified | Datetime | The UTC DateTime this object was last modified. This is in ISO8601 format. | |
| LastModifiedByUserId | String | The userId of the DocuSign user who last modified this object. | |
| LastModifiedByDisplayName | String | The User Name of the DocuSign user who last modified this object. |
The Documents resource provides methods that manage documents in an envelope or template.
In order to make a successful request on this view, you have to specify:
For example:
SELECT * FROM Documents WHERE Type = 'envelopes' AND Id = '764c564c-b540-42d1-a667-ccee6813ef7b' SELECT * FROM Documents WHERE Type = 'templates' AND Id = 'd5c67830-b37a-4171-9e87-3de377b35a90'
| Name | Type | References | Description |
| Id | String | Id of the Envelope or Template. | |
| Type | String | Specifies where the tab is applied. Possible options are envelopes or templates | |
| DocumentId [KEY] | String | Specifies the document Id number that the tab is placed on. This must refer to an existing Document's ID attribute. | |
| DocumentName | String | Specifies the document name. | |
| DocumentType | String | Specifies the document type. | |
| Uri | String | Uri of the document. | |
| Display | String | This string sets the display and behavior properties of the document during signing. The possible values are: modal - The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. download - The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window. inline - The document is shown in the normal signing window. | |
| Order | Integer | An optional value that sets the direction order used to sort the item list. Valid values are: asc = ascending sort order. desc = descending sort order. | |
| Pages | Integer | Number of pages in a document. | |
| DocumentGroup | String | Group of the document. | |
| AttachmentTabId | String | Id of the attachment tab. | |
| AuthoritativeCopy | Boolean | Specifies whether all documents in this envelope are authoritative copies. A document can set its own authoritativeCopy property to override this value. For example you can set the authoritativeCopy on an envelope level to true but can turn it off for a specific document. | |
| ContainsPdfFormFields | String | Indicates pdf form fields. | |
| IncludeInDownload | Boolean | When set to true, the document is included in the combined document download. The default value is true. | |
| SignerMustAcknowledge | String | Sets how the signer interacts with the supplemental document. The possible values are: no_interaction - No recipient action is required. view- The recipient is required to view the document. accept - The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. view_accept - The recipient is required to view and accept the document. |
The DocumentTabs resource provides methods that allow you to manage various tabs in envelopes or templates.
In order to make a successful request on this view, you have to specify:
For example:
SELECT * FROM DocumentTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND DocumentId = '1' SELECT * FROM DocumentTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND DocumentId = '1'
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM DocumentTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND DocumentId = '1' AND PageNumber = 1 SELECT * FROM DocumentTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND DocumentId = '1' AND PageNumber = 3
| Name | Type | References | Description |
| Id | String | Id of the Envelope or Template. | |
| Type | String | Specifies where the tab is applied. Possible options are envelopes or templates | |
| DocumentId | String |
Documents.DocumentId | Specifies the document ID that the tab is placed on. |
| RecipientId | String | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | |
| PageNumber | Integer | Specifies the page number on which the tab is located. Must be 1 for supplemental documents. | |
| TabId [KEY] | String | The unique identifier for the tab. | |
| CustomTabId | String | The DocuSign generated custom tab ID for the custom tab to be applied. | |
| TabName | String | Name of the tab. | |
| Value | String | Specifies the value of the tab. | |
| Status | String | Status of the tab. | |
| TabLabel | String | The label string associated with the tab. | |
| Font | String | The font to be used for the tab value. | |
| Bold | Boolean | When set to true, the information in the tab is bold. | |
| Italic | Boolean | When set to true, the information in the tab is italic. | |
| Underline | Boolean | When set to true, the information in the tab is underlined. | |
| FontColor | String | The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White. | |
| FontSize | String | The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72. | |
| XPosition | Integer | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. | |
| YPosition | Integer | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | |
| AnchorString | String | Specifies the anchor string. | |
| AnchorXOffset | String | Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. | |
| AnchorYOffset | String | Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. | |
| AnchorUnits | String | Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. | |
| AnchorIgnoreIfNotPresent | Boolean | When set to true, this tab is ignored if anchorString is not found in the document. | |
| TemplateLocked | Boolean | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | |
| TemplateRequired | Boolean | When set to true, the sender may not remove the recipient. Used only when working with template recipients. | |
| ConditionalParentLabel | String | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. | |
| ConditionalParentValue | String | For conditional fields, this is the value of the parent tab that controls the tab's visibility. |
The Document Visibility resource provides methods that manage document views and insights in an envelope or template.
In order to make a successful request on this view, you have to specify:
For example:
SELECT * FROM DocumentVisibility WHERE Type = 'envelopes' AND Id = '764c564c-b540-42d1-a667-ccee6813ef7b' AND RecipientId = 77419544 SELECT * FROM DocumentVisibility WHERE Type = 'templates' AND Id = 'd194aa0a-723e-4db9-a8be-801dffbb63ff' AND RecipientId = 75619544
| Name | Type | References | Description |
| Id [KEY] | String | Id of the Envelope or Template. | |
| Type | String | Specifies where the tab is applied. Possible options are envelopes or templates | |
| RecipientId | Integer | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | |
| DocumentId | String |
Documents.DocumentId | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
| Visible | Boolean | When set to true, the document is visible. | |
| Rights | String | Rights of the recipient for this document. |
The EnvelopeAttachments resource provides methods that allow you to manage attachments.
In order to make a successful request on this view, you have to specify EnvelopeId.
For example:
SELECT * FROM EnvelopeAttachments WHERE EnvelopeId = '56e3ca38-8008-441e-a29e-eb23dd3269e1'
| Name | Type | References | Description |
| EnvelopeId | String |
Envelopes.EnvelopeId | The envelope ID. |
| AttachmentId [KEY] | String | Id of the attachment. | |
| AttachmentType | String | Type of the attachment. | |
| Name | String | Name of the attachment. | |
| Label | String | Label of the attachment. | |
| AccessControl | String | AccessControl of the attachment. |
The EnvelopeConsumerDisclosures resource provides a method that allows you to retrieve the consumer disclosure for an envelope.
In order to make a successful request on this view, you have to specify EnvelopeId and RecipientId.
For example:
SELECT * FROM [EnvelopeConsumerDisclosures] WHERE EnvelopeId = '7cc4251f-31ca-4a79-8221-53451222292d' AND RecipientId = 68364179
| Name | Type | References | Description |
| EnvelopeId | String | The envelope ID. | |
| RecipientId | String | Unique Id for the recipient. | |
| AccountEsignId [KEY] | String | A GUID identifying the account associated with the consumer disclosure. | |
| CompanyName | String | The name of the company associated with the consumer disclosure. | |
| CompanyPhone | String | The phone number of the company associated with the consumer disclosure. | |
| ChangeEmail | String | Email of the account. | |
| ChangeEmailOther | String | Other email information. | |
| CopyCostPerPage | String | Copy cost for a page. | |
| CopyFeeCollectionMethod | String | Specifies the fee collection method for cases in which the customer requires paper copies of the document. | |
| EnableEsign | String | When is set to true, Esign is enabled. | |
| EsignAgreement | String | The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting. | |
| EsignText | String | Text of the Esign. | |
| MustAgreeToEsign | String | When is set ti true, customer must agree. | |
| PdfId | String | The pdfId property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. | |
| AllowCDWithdraw | String | Indicates whether the customer can withdraw their acceptance of the consumer disclosure. | |
| WithdrawAddressLine1 | String | Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. | |
| WithdrawAddressLine2 | String | Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. | |
| WithdrawByEmail | String | Indicates whether the customer can withdraw consent by email. | |
| WithdrawByMail | String | Indicates whether the customer can withdraw consent by postal mail. | |
| WithdrawByPhone | String | Indicates whether the customer can withdraw consent by phone. | |
| WithdrawCity | String | Contains the city of the postal address to which a customer can send a consent withdrawal notification. | |
| WithdrawConsequences | String | Indicates the consequences of withdrawing consent. | |
| WithdrawEmail | String | Contains the email address to which a customer can send a consent withdrawal notification. | |
| WithdrawOther | String | Indicates other information need to withdraw consent. | |
| WithdrawPhone | String | Contains the phone number which a customer can call to register consent withdrawal notification. | |
| withdrawPostalCode | String | Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. | |
| WithdrawState | String | Contains the state of the postal address to which a customer can send a consent withdrawal notification. |
Returns envelope tab data for an existing envelope.To use this feature, the Sending Setting Allow sender to download form data must be enabled for the account.
In order to make a successful request on this view, you have to specify EnvelopeId and AccountId.
For example:
SELECT * FROM EnvelopeFormData WHERE EnvelopeId='ea5f242a-0cb8-4e81-ae69-2be80ceabd84' AND AccountId='5cbbef28-5902-402d-a065-6da3525c9d9d'
| Name | Type | References | Description |
| EnvelopeId [KEY] | String | The envelope ID. | |
| AccountId | String | The ID of the account. | |
| PreFillFormDataSenderEmail | String | The sender's email address. | |
| PreFillFormDataFormData | String | An array of Pre FillForm Form Data. | |
| PreFillFormDataSendUserId | String | The User ID of the sender. | |
| PreFillFormDataSenderName | String | The sender's name. | |
| FormData | String | An array of formDataItem objects. | |
| EmailSubject | String | The subject line of the email message that is sent to all recipients. | |
| Status | String | Indicates the envelope status. Valid values are: sent,created. | |
| SentDateTime | Datetime | Indicates the sent date time | |
| RecipientFormData | String | An array of form data for each recipient of the envelope. |
The Envelope resource provides methods that allow you to manage envelopes.
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Envelopes WHERE EnvelopeId = '764c564c-b540-42d1-a667-ccee6813ef7b' SELECT * FROM Envelopes WHERE StartDateToSearch = '2019-6-24T10:00:04-00:00' SELECT * FROM Envelopes WHERE StartDateToSearch = '2019-6-24T10:00:04-00:00' AND EndDateToSearch = '2019-8-24T10:00:04-00:00' SELECT * FROM Envelopes WHERE StartDateToSearch = '2019-6-24T10:00:04-00:00' AND EndDateToSearch = '2019-8-24T10:00:04-00:00' AND Status = 'sent'
| Name | Type | References | Description |
| EnvelopeId [KEY] | String | The envelope ID. | |
| EnvelopeUri | String | Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. | |
| Status | String | Indicates the envelope status. Valid values are: completed - The envelope has been completed and all tags have been signed. created - The envelope is created as a draft. It can be modified and sent later. declined - The envelope has been declined by the recipients. delivered - The envelope has been delivered to the recipients. sent - The envelope is sent to the recipients. signed - The envelope has been signed by the recipients. voided - The envelope is no longer valid and recipients cannot access or sign the envelope. | |
| EnvelopeIdStamping | String | When set to true, Envelope ID Stamping is enabled. | |
| EmailSubject | String | Specifies the subject of the email that is sent to all recipients. | |
| EmailBlurb | String | This is the same as the email body. | |
| DocumentsUri | String | Contains a URI for an endpoint that you can use to retrieve the documents. | |
| DocumentsCombinedUri | String | Contains a URI for an endpoint that you can use to retrieve the combined documents. | |
| AttachmentsUri | String | Contains a URI for an endpoint that you can use to retrieve the attachments. | |
| RecipientsUri | String | Contains a URI for an endpoint that you can use to retrieve the recipients. | |
| CustomFieldsUri | String | Contains a URI for an endpoint to retrieve the custom fields. | |
| CertificateUri | String | Retrieves a URI for an endpoint allowing you to easily retrieve certificate information. | |
| NotificationUri | String | Contains a URI for an endpoint that you can use to retrieve the notifications. | |
| SigningLocation | String | Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. | |
| BrandId | String | The unique identifier of a brand. | |
| BrandLock | String | Lock of the brand. | |
| SentDateTime | Datetime | The date and time the envelope was sent. | |
| CompletedDateTime | Datetime | Specifies the date and time this item was completed. | |
| CreatedDateTime | Datetime | Indicates the date and time the item was created. | |
| DeclinedDateTime | Datetime | The date and time the recipient declined the document. | |
| LastModifiedDateTime | Datetime | The date and time the item was last modified. | |
| DeletedDateTime | Datetime | Specifies the data and time the item was deleted. | |
| StatusChangedDateTime | Datetime | The data and time the status changed. | |
| VoidedDateTime | Datetime | The date and time the envelope was voided. | |
| VoidedReason | String | The reason the envelope was voided. | |
| MessageLock | String | When set to true, prevents senders from changing the contents of emailBlurb and emailSubject properties for the envelope. | |
| RecipientsLock | String | When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope. | |
| PurgeState | String | Shows the current purge state for the envelope. The possible values are: unpurged: There has been no successful request to purge documents. documents_queued: The envelope documents have been added to the purge queue, but have not been purged. documents_dequeued: The envelope documents have been taken out of the purge queue. documents_and_metadata_queued: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. documents_purged: The envelope documents have been successfully purged. documents_and_metadata_purged: The envelope documents and metadata have been successfully purged. | |
| EnableWetSign | String | When set to true, the signer is allowed to print the document and sign it on paper. | |
| EnforceSignerVisibility | String | When set to true, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. | |
| AllowReassign | String | When set to true, the recipient can redirect an envelope to a more appropriate recipient. | |
| AllowMarkup | String | When set to true, Document Markup is enabled for envelope. | |
| Asynchronous | String | When set to true, the envelope is queued for processing and the value of the status property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. | |
| AuthoritativeCopy | String | Specifies whether all documents in this envelope are authoritative copies. | |
| AuthoritativeCopyDefault | String | The default authoritativeCopy setting for documents in this envelope that do not have authoritativeCopy set. | |
| AutoNavigation | String | Specifies whether auto navigation is set for the recipient. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| FolderId | String | Id of the folder where envelope is located. | |
| GetFullInfo | Bool | Id of the folder where envelope is located. |
The EnvelopeTemplates resource provides methods that allow you to add and delete templates on envelopes and documents.
In order to make a successful request on this view, you have to specify EnvelopeId.
For example:
SELECT * FROM EnvelopeTemplates WHERE EnvelopeId = '11dc472d-5675-47b7-ac4e-96c47e473dfe'
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM EnvelopeTemplates WHERE EnvelopeId = 'cd7a0feb-2911-4595-a28e-deaa4a51f55d' AND DocumentId = '3'
| Name | Type | References | Description |
| EnvelopeId [KEY] | String |
Envelopes.EnvelopeId | The envelope ID. |
| TemplateId | String |
Templates.TemplateId | The unique identifier of the template. If this is not provided, DocuSign will generate a value. |
| Name | String | Name of the template. | |
| DocumentId | String |
Documents.DocumentId | Specifies the document ID number. |
| DocumentName | String | Name of the document. | |
| Applied | Boolean | When set to true, template is applied. | |
| Uri | String | Uri of the template. |
Retrieves a list of the folders for the account.
DocuSign does not support any column for filtering this view. All filters will be executed client side.
| Name | Type | References | Description |
| FolderId [KEY] | String | The ID of the folder being accessed. | |
| ParentFolderId | String | Id of the parent folder. | |
| ParentFolderUri | String | Uri of the parent folder. | |
| Name | String | Name of the folder. | |
| Type | String | Type of the folder. | |
| Uri | String | Uri of the folder. | |
| OwnerUserId | String | Owner id of the folder. | |
| OwnerUserName | String | Owner name of the folder. | |
| OwnerEmail | String | Owner email of the folder. |
The GroupBrands resource provides methods that allow you to manage brands in a group.
In order to make a successful request on this view, you have to specify GroupId.
For example:
SELECT * FROM GroupBrands WHERE GroupId = 6160665
| Name | Type | References | Description |
| GroupId | Integer |
Groups.GroupId | The DocuSign group ID for the group. |
| BrandId [KEY] | String |
AccountBrands.BrandId | Id of the brand. |
| InternalId | String | Internal Id of the brand. | |
| BrandName | String | Name of the brand. | |
| BrandCompany | String | The name of the company associated with this brand. |
The Groups resource provides methods that allow you to manage groups for the account.
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Groups WHERE GroupType = 'everyoneGroup'
| Name | Type | References | Description |
| GroupId [KEY] | Integer | The DocuSign group ID for the group. | |
| GroupName | String | The name of the group. | |
| GroupType | String | The group type. | |
| UsersCount | Integer | Total number of users of the group. | |
| PermissionProfileId | String | The ID of the permission profile associated with the group. |
The GroupUsers resource provides methods that allow you to manage the users in a group.
In order to make a successful request on this view, you have to specify GroupId.
For example:
SELECT * FROM GroupUsers WHERE GroupId = 6071932
| Name | Type | References | Description |
| GroupId | Integer |
Groups.GroupId | The DocuSign group ID for the group. |
| UserId [KEY] | String |
Users.UserId | Id of the user account |
| UserName | String | Name of the user account | |
| String | Email of the user account | ||
| UserType | String | Type of the user account | |
| UserStatus | String | Status of the user account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled. | |
| Uri | String | Uri of the user account | |
| LoginStatus | String | Status of login. | |
| SendActivationEmail | Boolean | When set to true, an activation email can be sent. | |
| ActivationAccessCode | String | Activation code for access. |
The Locks resource provides methods that allow you to manage locks on an envelope or template.
In order to make a successful request on this view, you have to specify:
For example:
SELECT * FROM Locks WHERE Type = 'templates' AND Id = '22093429-0c89-47d3-a984-8b919768b963' SELECT * FROM Locks WHERE Type = 'envelopes' AND Id = '03ea05dc-b5ba-45d2-8b0c-3bf0f5ae8d59'
| Name | Type | References | Description |
| Id [KEY] | String |
Envelopes.EnvelopeId or Templates.TemplateId | Id of the Envelope or Template. |
| Type | String | Specifies where the tab is applied. Possible options are envelopes or templates | |
| LockedByUserName | String | Name of the user. | |
| LockedByUserId | String | The user ID of the user being accessed. | |
| LockedByUserEmail | String | Email of the user. | |
| LockedByUri | String | Uri of the user. | |
| LockedByApp | String | Specifies the friendly name of the application that is locking the envelope. | |
| LockType | String | The type of envelope lock. Currently | |
| LockToken | String | A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock. | |
| LockedUntilDateTime | Datetime | The datetime until the envelope lock expires. | |
| LockDurationInSeconds | String | Sets the time, in seconds, until the lock expires when there is no activity on the envelope. | |
| UseScratchPad | String | Indicates whether a scratchpad is used for editing information. |
The PowerForms resource provides methods that allow you to manage power forms.
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PowerForms WHERE PowerFormId = '3caf8d81-1c18-4ff6-bc1b-39e4ab8c2692'
| Name | Type | References | Description |
| PowerFormId [KEY] | String | The unique identifier of the power form. | |
| Name | String | PowerForm name. | |
| PowerFormUrl | String | Contains a URI for an endpoint that you can use to retrieve the PowerForms. | |
| PowerFormV2Url | String | Contains V2 URI for an endpoint that you can use to retrieve the PowerForms. | |
| Uri | String | Uri of the powerforms. | |
| TemplateId | String |
Templates.TemplateId | The unique identifier of the template. If this is not provided, DocuSign will generate a value. |
| TemplateName | String | Name of the template. | |
| CreatedBy | String | Creator name. | |
| CreatedDateTime | Datetime | Indicates the date and time the item was created. | |
| SenderName | String | Name of the sender. | |
| SenderUserId | String | User Id of the sender. | |
| EmailBody | String | Email body of the message sent to the recipient. | |
| EmailSubject | String | The subject of the email that is sent to all recipients. | |
| SigningMode | String | Specifies the mode of the signing. | |
| Instructions | String | Specifies the PowerForm instructions. | |
| IsActive | Boolean | Indicates the status of the PowerForm. | |
| TimesUsed | Integer | Indicates number of times the item was used. | |
| LastUsed | Datetime | Indicates the date and time the item was used for the last time. | |
| MaxUseEnabled | Boolean | The maximum of using times for the item. | |
| UsesRemaining | Integer | The remaining number of times the item can be used. | |
| LimitUseIntervalEnabled | Boolean | Status of the LimitUseInterval. | |
| LimitUseInterval | String | Specifies the interval of the uses limit. | |
| LimitUseIntervalUnits | String | Unit type of the LimitUseInterval. |
The Recipients resource allows you manage the recipients of an envelope or template.
In order to make a successful request on this view, you have to specify:
For example:
SELECT * FROM Recipients WHERE Type = 'templates' AND Id = '22093429-0c89-47d3-a984-8b919768b963' SELECT * FROM Recipients WHERE Type = 'envelopes' AND Id = '03ea05dc-b5ba-45d2-8b0c-3bf0f5ae8d59'
| Name | Type | References | Description |
| Type | String | Specifies where the tab is applied. Possible options are envelopes or templates | |
| Id | String | Id of the Envelope or Template. | |
| RecipientId [KEY] | Integer | Unique Id for the recipient. | |
| RecipientIdGuid | String | Id guid of the recipient. | |
| RecipientType | String | Type of the recipient. | |
| UserId | String | The user ID of the user being accessed. | |
| Name | String | Name of the recipient. | |
| String | Email of the recipient. | ||
| RoleName | String | Optional element. Specifies the role name associated with the recipient. | |
| Note | String | A note sent to the recipient in the signing email. This note is unique to this recipient. | |
| CreationReason | String | Reason of the creation. | |
| ClientUserId | String | Specifies whether the recipient is embedded or remote. If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. | |
| AccessCode | String | If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. | |
| RequireIdLookup | Boolean | When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. | |
| DeliveryMethod | String | Method of the delivery. | |
| DeliveredDateTime | Datetime | Date and time of the delivery. | |
| SignedDateTime | Datetime | The date and time the envelope was signed. | |
| SigningGroupId | String | The display Id for the signing group. | |
| SigningGroupName | String | The display name for the signing group. | |
| CanSignOffline | Boolean | When set to true, specifies that the signer can perform the signing ceremony offline. | |
| Status | String | Recipient status. |
The RecipientTabs resource provides methods that let you add, update, and delete tabs from an envelope or template.
In order to make a successful request on this view, you have to specify:
For example:
SELECT * FROM RecipientTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND RecipientId = 7296558 SELECT * FROM RecipientTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND RecipientId = 44407249
| Name | Type | References | Description |
| Id | String | Id of the Envelope or Template. | |
| Type | String | Specifies where the tab is applied. Possible options are envelopes or templates | |
| DocumentId | String |
Documents.DocumentId | Specifies the document ID number that the tab is placed on. |
| RecipientId | Integer |
Recipients.RecipientId | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |
| TabId [KEY] | String | The unique identifier for the tab. | |
| CustomTabId | String |
CustomTabs.CustomTabId | The DocuSign generated custom tab ID for the custom tab to be applied. |
| Name | String | Name of the tab. | |
| Status | String | Status of the tab. | |
| TabLabel | String | The label string associated with the tab. | |
| Font | String | The font to be used for the tab value. | |
| Bold | Boolean | When set to true, the information in the tab is bold. | |
| Italic | Boolean | When set to true, the information in the tab is italic. | |
| Underline | Boolean | When set to true, the information in the tab is underlined. | |
| FontColor | String | The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White. | |
| FontSize | String | The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72. | |
| TabOrder | String | A positive integer that sets the order the tab is navigated to during signing. | |
| PageNumber | Integer | Specifies the page number on which the tab is located. Must be 1 for supplemental documents. | |
| XPosition | Integer | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. | |
| YPosition | Integer | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | |
| AnchorString | String | Specifies the anchor string. | |
| AnchorXOffset | String | Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. | |
| AnchorYOffset | String | Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. | |
| AnchorUnits | String | Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. | |
| AnchorIgnoreIfNotPresent | String | When set to true, this tab is ignored if anchorString is not found in the document. | |
| TemplateLocked | Boolean | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | |
| TemplateRequired | Boolean | When set to true, the sender may not remove the recipient. Used only when working with template recipients. | |
| ConditionalParentLabel | String | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. | |
| ConditionalParentValue | String | For conditional fields, this is the value of the parent tab that controls the tab's visibility. |
Represents an instance or copy of an envelope
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM SendListBulkCopies SELECT * FROM SendListBulkCopies WHERE BulkSendListId = 'asd-wdas-dw'
| Name | Type | References | Description |
| BulkSendListId | String |
SendLists.BulkSendListId | The GUID of the bulk send list. |
| Recipients | String | Unique Id for the recipient. | |
| DocGenFormFields | String | Specifies the recipient's email address. | |
| EmailBlurb | String | The email body for this copy of the envelope. | |
| EmailSubject | String | The email subject line for this copy of the envelope. | |
| CustomFields | String | An optional array of strings that allows the sender to provide custom data about the recipient. |
This method returns all of the details of recipents associated with a specific bulk send list that belongs to the current user.
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM SendListRecipients SELECT * FROM SendListRecipients WHERE BulkSendListId = 'asd-wdas-dw'
| Name | Type | References | Description |
| BulkSendListId | String |
SendLists.BulkSendListId | The GUID of the bulk send list. |
| RecipientId | String | Unique Id for the recipient. | |
| String | Specifies the recipient's email address. | ||
| Name | String | Specifies the recipient's name. | |
| ClientUserId | String | Specifies whether the recipient is embedded or remote. | |
| CustomFields | String | An optional array of strings that allows the sender to provide custom data about the recipient. | |
| DeliveryMethod | String | The delivery method. | |
| EmailNotification | String | This optional property allows you to set a specific email subject and body for this recipient's notification email. | |
| EmbeddedRecipientStartURL | String | Specifies a sender-provided valid URL string for redirecting an embedded recipient. | |
| HostEmail | String | The email address of the signing host. | |
| HostName | String | The name of the signing host. | |
| IdCheckConfigurationName | String | The name of the authentication check to use. | |
| IdCheckInformationInput | String | An object that contains input information related to a recipient ID check. | |
| IdentificationMethod | String | Identification Method. | |
| IdentityVerification | String | Specifies the ID Verification workflow applied on an envelope by workflow ID. | |
| PhoneAuthentication | String | When idCheckConfigurationName is set to Phone Auth \$, you use this complex type to provide the recipient authentication method details. | |
| RecipientSignatureProviders | String | The default signature provider is the DocuSign Electronic signature system. | |
| RoleName | String | The name of the role associated with the recipient. | |
| Note | String | A note sent to the recipient in the signing email. This note is unique to this recipient. | |
| SignerName | String | The in-person signer's full legal name. | |
| SigningGroupId | String | The ID of the signing group. | |
| AccessCode | String | If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. | |
| PhoneNumber | String | This is only used if the Identification field value is Phone or SMS. | |
| SMSAuthentication | String | When idCheckConfigurationName is set to SMS Auth \$, you use this complex type to provide the recipient authentication method details. | |
| Tabs | String | A list of tabs associated with the recipient. |
A list of bulk send lists belonging to the current user, as well as basic information about each list.
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM SendLists SELECT * FROM SendLists WHERE BulkSendListId = 'asd-wdas-dw'
| Name | Type | References | Description |
| BulkSendListId | String | The GUID of the bulk send list. | |
| CreatedByUser | String | The GUID of the user who created the bulk send list. | |
| CreatedDate | Datetime | The UTC DateTime that the bulk send list was created. | |
| Name | String | Specifies the recipient's name. |
Returns data from a sample table.
DocuSign does not support any column for filtering this view. All filters will be executed client side.
| Name | Type | References | Description |
| SigningGroupId [KEY] | String | Id of the signing group. | |
| GroupName | String | The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. | |
| GroupType | String | The group type. | |
| GroupEmail | String | Email of the group. | |
| Created | String | The UTC DateTime when the workspace user authorization was created. | |
| CreatedBy | String | Creator of the group. | |
| Modified | Datetime | The UTC DateTime when the workspace user authorization was modified. | |
| ModifiedBy | String | Modifier of the group. |
The SigningGroupUsers resource provides methods that allow you to manage users in Signing Groups.
In order to make a successful request on this view, you have to specify SigningGroupId.
For example:
SELECT * FROM SigningGroupUsers WHERE SigningGroupId = '6071932'
| Name | Type | References | Description |
| SigningGroupId | String |
SigningGroups.SigningGroupId | Id of the signing group. |
| UserName | String | The name of the group member. | |
| Email [KEY] | String | The email of the group member. |
The Template resource provides methods that allow you to manage templates.
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Templates WHERE TemplateId = '5fe47399-31e9-4ddc-bbd1-5200760e4658'
SELECT * FROM Templates WHERE FolderId = '7137682d-f33c-4425-96a2-d556389df80f'
SELECT * FROM Templates WHERE FolderId IN ('7137682d-f33c-4425-96a2-d556389df80f', 'ff7cc98e-4502-4009-93ce-8d3ad96485a6')
SELECT * FROM Templates WHERE FolderName = 'testTemplate'
| Name | Type | References | Description |
| TemplateId [KEY] | String | Id of the template. | |
| Name | String | Name of the template. | |
| Password | String | Password of the template. | |
| Description | String | Description of the template. | |
| Shared | String | When set to true, this template is shared. | |
| Created | Datetime | The date and time the item was created. | |
| LastModified | Datetime | The date and time the item was last modified. | |
| PageCount | String | Number of pages. | |
| Uri | String | Contains a URI to retrieve the templates. | |
| FolderName | String | Name of the template folder. | |
| FolderId | String |
Folders.FolderId | Id of the folder. |
| FolderUri | String | Uri of the folder. | |
| OwnerUserName | String | Name of the user. | |
| OwnerEmail | String | Email of the user. | |
| OwnerUserId | String | Id of the user. | |
| EmailBlurb | String | Blurb of the email | |
| EmailSubject | String | Subject of the email. | |
| AllowReassign | String | When set to true, the recipient can redirect an envelope to a more appropriate recipient. | |
| AuthoritativeCopy | String | Specifies whether all documents in this template are authoritative copies. A document can set its own authoritativeCopy property to override this value. | |
| EnableWetSign | String | When set to true, the signer is allowed to print the document and sign it on paper. | |
| EnforceSignerVisibility | String | When set to true, documents with tabs can only be viewed by signers that have a tab on that document. |
The UserInfo resource provides methods that allow you to manage your current user info.
| Name | Type | References | Description |
| AccountId [KEY] | String | The ID of the account. | |
| AccountName | String | The name associated with this account. | |
| Url | String | The base URI that is used for making API calls on behalf of this account. | |
| IsDefault | Boolean | If true, this account is the account holder's default account. |
The Users resource provides methods that allow you to manage users for an account.
The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Users WHERE UserId = '9degfd10-2704-4af4-ae3e-ac6r4d4bcf0a' SELECT * FROM Users WHERE Email = '[email protected]' SELECT * FROM Users WHERE UserStatus = 'Active' SELECT * FROM Users WHERE UserStatus = 'Active' AND Email = '[email protected]'"
| Name | Type | References | Description |
| UserId [KEY] | String | The user ID of the user being accessed. | |
| UserName | String | The user's full name. | |
| UserStatus | String | Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled. | |
| UserType | String | The user type. | |
| IsAdmin | Boolean | Determines if the feature set is actively set as part of the plan. | |
| String | The user's email address. | ||
| Uri | String | Uri of the user. | |
| PermissionProfileId | Integer | User's permission profile id. | |
| permissionProfileName | String | User's permission profile name. | |
| JobTitle | String | Title of the job. | |
| Title | String | Salutation for the user, such as Ms, Dr, Capt., etc. | |
| CreatedDateTime | Datetime | Indicates the date and time the item was created. | |
| LastLogin | Datetime | The date-time when the user last logged on to the system. |
The UserSignatures resource provides methods that allow you manage the intials and signature images for a user.
In order to make a successful request on this view, you have to specify UserId.
For example:
SELECT * FROM UserSignatures WHERE UserId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a'
| Name | Type | References | Description |
| UserId | String |
Users.UserId | The user ID of the user being accessed. |
| SignatureId [KEY] | String | Specifies the signature ID associated with the signature name. | |
| SignatureImageUri | String | Contains the URI for an endpoint that you can use to retrieve the signature image. | |
| InitialsImageUri | String | Contains the URI for an endpoint that you can use to retrieve the initials image. | |
| SignatureInitials | String | The initials associated with the signature. | |
| UserSignatureName | String | Specifies the user signature name. | |
| SignatureType | String | Type of the signature. | |
| CreatedDateTime | Datetime | Indicates the date and time the item was created. | |
| AdoptedDateTime | Datetime | The date and time the user adopted their signature. | |
| IsDefault | Boolean | Specifies if the signature is default or not. |
The Workspaces resource provides methods that allow you to manage workspaces.
DocuSign does not support any column for filtering this view. All filters will be executed client side.
| Name | Type | References | Description |
| WorkspaceId [KEY] | String | The id of the workspace, always populated. | |
| WorkspaceName | String | The name of the workspace. | |
| WorkspaceUri | String | The relative URI that may be used to access the workspace. | |
| WorkspaceBaseUrl | String | The relative URL that may be used to access the workspace. | |
| Created | Datetime | The UTC DateTime when the workspace user authorization was created. | |
| LastModified | Datetime | Utc date and time the comment was last updated (can only be done by creator.) | |
| Status | String | Workspace status. |
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to DocuSign. |
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュール。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AccountId | AccountId of the currently authenticated user. |
| DirectoryRetrievalDepth | The depth to scan for available folders. |
| IncludeCustomFields | Set to true if you want to retrieve custom fields values for an envelope or template. |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| URL | Base API url associated with your account. |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
| UseSandbox | Set to true if you you are using sandbox account. |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to DocuSign. |
The type of authentication to use when connecting to DocuSign.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
JWT 証明書のストア。
クライアント証明書のための証明書ストア名。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
| MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
| CA | 証明機関の証明書。 |
| ROOT | ルート証明書。 |
| SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。
JWT 証明書を格納するキーストアの種類。
このプロパティには次の値の一つを設定できます。
| USER | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note：この種類はJava では利用できません。 |
| MACHINE | Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note：この種類はJava では利用できません。 |
| PFXFILE | この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。 |
| PFXBLOB | この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 |
| JKSFILE | この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。 Note：この種類はJava のみで利用できます。 |
| JKSBLOB | この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note：この種類はJava のみで利用できます。 |
| PEMKEY_FILE | この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。 |
| PEMKEY_BLOB | この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。 |
| PUBLIC_KEY_FILE | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。 |
| PUBLIC_KEY_BLOB | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。 |
| SSHPUBLIC_KEY_FILE | この証明書ストアは、SSH 公開キーを含むファイルの名前です。 |
| SSHPUBLIC_KEY_BLOB | この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。 |
| P7BFILE | この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。 |
| PPKFILE | この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。 |
| XMLFILE | この証明書ストアは、XML 形式の証明書を含むファイルの名前です。 |
| XMLBLOB | この証明書ストアは、XML 形式の証明書を含む文字列の名前です。 |
OAuth JWT 証明書のパスワード。
証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。
OAuth JWT 証明書のサブジェクト。
証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。
完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。
それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。
"*" に設定すると、証明書ストアの1番目の証明書が選択されます。
証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所（市町村名） |
| S | 法人の住所（都道府県） |
| C | 国名 |
| E | Eメールアドレス |
フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。
Java Web Token の発行者。
Java Web Token の発行者。 通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります：
| 説明 | 例 |
| フルPEM 証明書（例では省略されています） | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵（例では省略されています） | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint （hex 値はスペースおよびコロン区切り） | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint （hex 値はスペースおよびコロン区切り） | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
| タイプ | デフォルトポート | 説明 |
| TUNNEL | 80 | これが設定されている場合、Sync App はDocuSign への接続を開き、プロキシを経由して通信が行われます。 |
| SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
| AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\DocuSign Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：
| Platform | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| AccountId | AccountId of the currently authenticated user. |
| DirectoryRetrievalDepth | The depth to scan for available folders. |
| IncludeCustomFields | Set to true if you want to retrieve custom fields values for an envelope or template. |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| URL | Base API url associated with your account. |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
| UseSandbox | Set to true if you you are using sandbox account. |
AccountId of the currently authenticated user.
If it's not specified, it will be set by default. Please query the UserInfo view if you want to set it manually.
The depth to scan for available folders.
This property must be set in the connection string or the driver will use a default of Depth=-1 (specifies that all subfolders are scanned).
Set to true if you want to retrieve custom fields values for an envelope or template.
Set to true if you want to retrieve custom fields values for an envelope or template.
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
Base API url associated with your account.
If it's not specified, it will be set by default. Please query UserInfo view if you want to set it manually.
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Account WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。
Set to true if you you are using sandbox account.
Set to true if you you are using sandbox account.