このページでは、CData Cloud でのDocuSign への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

DocuSign への接続

接続の確立 は、CData Cloud にデータベースを作成するためのDocuSign への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してDocuSign からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、DocuSign に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

DocuSign への接続

UseSandbox
UseSandbox は現在のユーザーアカウントがサンドボックスかそうでないかを示します。デフォルトはfalse です。サンドボックスアカウントを使用する場合はtrue に設定します。以下のOAuth フローはすべて、UseSandbox が事前に設定済みであることを前提として書かれています。

AccountId
AccountId はオプションの接続プロパティです。認証が成功すると自動的に設定されます。 または、複数のAccount Id にアクセスできる場合は、接続文字列で手動で設定できます。アカウントId を取得するには、UserInfo ビューをクエリします。

DocuSign への認証

DocuSign はOAuth 認証標準を利用しています。OAuth を使って認証するには、カスタムアプリを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得する必要があります。Cloud は、OAuth JWT 認証もサポートしています。カスタムアプリケーションの作成について詳しくは、カスタムOAuth アプリの作成 を参照してください。

OAuth

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

OAuth JWT

AuthScheme をOAuthJWT に設定します。

Obtaining a User ID

Retrieve your User ID by navigating, in the DocuSign UI, to Settings > Apps and Keys > My Account Information > User ID.

Obtaining an Integration Key

Follow the procedure below to obtain an integration key:

1. Log in to a DocuSign developer account.
2. Navigate to My Apps and Keys.
3. You will see a dialog box to enter your application's name. Give your application a short, but descriptive name.
4. Click ADD to add your application. Your application is automatically assigned an integration key (GUID) value that cannot be changed. Save this value.

Application Consent

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.

Method 1: Administrative Consent

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:

• Your account must include the Access Management with SSO feature, though it is not required that you install SSO.
  • If your developer demo account (demo.docusign.net) does not include this feature, send an email to [email protected] and request that the feature be added to your account. Remember to include your developer demo account ID.
• You must claim your email DNS domain via the DocuSign administration tool. A domain can be claimed both by the DocuSign developer demo system (for testing and development), and by your production DocuSign account.
• Your users’ email domains must match the claimed email domain.
• Your integration key’s management account must be one of the accounts in the DocuSign organization.

If you meet these requirements, grant consent as follows:

1. In DocuSign Admin, open your organization home page.
2. In the navigation pane on the left side of the page, select Connected Apps.
3. Click Authorize Application and choose an application from the drop-down menu.
4. In the Add New Application dialog, specify the permissions you want to grant to your application.
5. Click ADD.

Method 2: Individual Consent

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:

1. Run the GetConsentURL stored procedure. The procedure returns a URL.
2. Open the returned URL in your browser. A permissions page will display.
3. Click Accept to grant consent.

Method 3: Administrative Consent for Third-party (ISV) Applications

You can grant administrative consent to third party (ISV) applications.

This method of obtaining consent has the following prerequisites:

• All prerequisites for standard Administrative Consent apply (see section above).
• ISVs should also support individual consent as a backup, since SSO not all customers will be able to use administative consent.
• If you are an ISV using the JWT grant flow, then the management account tied to your application’s integration key should be a DocuSign account that your company controls.

If you meet these requirements, obtain consent as follows. Each user must perform the following steps.

1. Run the GetConsentURL stored procedure. The procedure returns a URL.
2. Open the returned URL in your browser. A permissions page will display.
3. Click Accept to grant consent.

Configuring OAuth JWT Credentials

Using the information you gathered in the above sections, set the following connection properties in the Cloud:

• OAuthJWTCert: The location of your private key. This should end with ".key".
• OAuthJWTCertType: PEMKEY_FILE
• OAuthJWTSubject: Your user ID.
• OAuthJWTIssuer: Your integration key.

カスタムOAuth アプリケーションの作成

すべてのOAuth フローで、カスタムOAuth アプリケーションが必須です。

次の手順で、カスタムOAuth アプリケーションを作成し、そのアプリケーションをDocuSign Admin Console に登録して、特定のOAuth 認証フローで接続プロパティを取得します。

1. Admin panel > Integrations > API およびKeys に移動します。
2. 次の設定を行います。
   • OAuthClientId：アプリケーションの登録時に割り当てられたIntegrator Key。
   • OAuthClientSecret：アプリケーションの登録時に割り当てられたSecret Key。
   • Redirect URI：
     • デスクトップアプリケーションの場合は、リダイレクトURI をhttp://localhost:portnumber に設定します。使用可能な任意のポートを指定できます。
     • Web アプリケーションの場合は、リダイレクトURI をユーザーがアプリケーションにアクセス権を付与した後に返されるWeb サイト上のページに設定してください。
     • ヘッドレスマシンの場合は、リダイレクトURI をhttp://localhost:portnumber に設定します。利用可能な任意のポートを使用できます。

アプリケーションがAdmin Console に登録されたら、 OAuthClientId プロパティとして使用するIntegrator Key、 OAuthClientSecret プロパティとして使用するSecret Key、 CallbackURL プロパティとして使用するRedirect URI を保存します。

データアクセスのファインチューニング

• AccountId：複数アカウントにアクセスできる場合に指定できるオプションのアカウントId。
• DirectoryRetrievalDepth：使用可能なフォルダをリストするときにスキャンするフォルダの深さ（つまり、サブフォルダの深さ）。
• IncludeCustomFields：エンベロープまたはテンプレートのカスタムフィールド値を取得する場合は、True に設定。
• URL：アカウントに関連付けられたBase API URL。AccountId 同様にデフォルト設定。
• UseSandbox：サンドボックスを使用する場合はTrue に設定。

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にCloud が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

概要

このセクションでは、利用可能なAPI オブジェクトを示し、DocuSign API へのSQL の実行について詳しく説明します。

主要機能

• Cloud はドキュメント、フォルダ、およびグループなどのDocuSign エンティティをリレーショナルビューとしてモデル化し、SQL を記述してDocuSign データをクエリできるようにします。
• ストアドプロシージャを使用すると、アクセストークンの取得やOAuth 2.0でのリフレッシュの維持など、DocuSign の操作を実行できます。
• これらのオブジェクトへのライブ接続により、Cloud を使用するとDocuSign アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビュー では、利用可能なビューを説明します。ビューは、Accounts、Documents、Folders などを静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャ は、DocuSign のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、DocuSign の操作を実行できます。

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - 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.
AccountPermissionProfiles	An account permission profile is assigned to a group of users, enabling you to set permissions for all of the users in the group at the same time.
Accounts	The Accounts resource provides methods that allow you to manage your accounts.
AgentUserAuthorizations	Returns the user authorizations for which the user specified by userId is the agent user.
BillingInvoices	Retrieves a list of invoices for the account.
BillingPayments	Retrieves a list containing information about one or more payments.
BillingPlans	Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.
BulkSendBatch	Returns a summary of bulk send batches.
BulkSendBatchStatus	Gets the general status of a specific bulk send batch.
CloudStorage	Retrieves a list of the user's items from the specified cloud storage provider.
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.
EnvelopeFolders	Get data associated to the folder an envelope exists in.
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 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.
PrincipalUserAuthorizations	Returns the user authorizations for which the user specified by userId is the principal user.
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.
SharedAccessEnvelopes	Retrieves the list of information about the shared envelopes.
SharedAccessFolders	Retrieves the list of information about the shared folders.
SharedAccessTemplates	Retrieves the list of information about the shared templates.
SharedAccessUser	Retrieves the information about the user requesting the shared information.
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.

View Specific Information

The Cloud 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 Cloud.

• BrandId supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM AccountBrands WHERE BrandId = '4701f9c2-1038-45cf-bf35-66ae143a5656'

Columns

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.
BrandLanguages	String		An array of two-letter codes for the languages that you want to use with the brand.
Colors	String		An array of name-value pairs specifying the colors that the brand uses for the following elements:Button background, Button text, Header background, Header text
DefaultBrandLanguage	String		The two-letter code for the language that you want to use as the brand default.

The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

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.

An account permission profile is assigned to a group of users, enabling you to set permissions for all of the users in the group at the same time.

View Specific Information

The Cloud uses 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 Cloud.

• PermissionProfileId supports the '=' operator.

For example, the following query is processed server-side:

SELECT * FROM AccountPermissionProfiles where PermissionProfileId = '20894443';

Columns

Name	Type	References	Description
PermissionProfileId [KEY]	String		The ID of the permission profile.
PermissionProfileName	String		The name of the account permission profile.
ModifiedByUsername	String		The username of the user who last modified the permission profile.
ModifiedDateTime	Datetime		The date and time when the permission profile was last modified.
UserCount	String		The total number of users in the group associated with the account permission profile.
Settings	String		This object specifies the permissions that are associated with the account permission profile.
Users	String		A list of user objects containing information about the users who are associated with the account permission profile.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Include	String		A comma-separated list of additional properties to return in the response. Valid values are: user_count, closed_users, account_management, metadata

The Accounts resource provides methods that allow you to manage your accounts.

View Specific Information

The Cloud 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 Cloud.

• AccountIdGuid supports the '='.

For example, the following queries are processed server side:

SELECT * FROM Envelopes WHERE AccountIdGuid = '764c564c-b540-42d1-a667-ccee6813ef7b'

Columns

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.
ConnectPermission	String		Value is full when Connect is enabled for this account.
DistributorCode	String		The code that identifies the billing plan groups and plans for the new account.
DocuSignLandingUrl	String		URL of the landing page used to create the account.
ForgottenPasswordQuestionsCount	String		A complex element that contains up to four Question/Answer pairs for forgotten password information for a user.
SeatsAllowed	String		The number of active users the account can have at one time.
SeatsInUse	String		The number of users currently active on the account.
SuspensionDate	Date		The date on which the account was suspended.
SuspensionStatus	String		Indicates whether the account is currently suspended.

Returns the user authorizations for which the user specified by userId is the agent user.

The Cloud 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 Cloud.

• Permission supports the '=' operator.
• Email supports the '=' operator.
• Name supports the '=' operator.
• UserId supports the '=' operator.
• ActiveOnly supports the '=' operator.
• IncludeClosedUsers supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM AgentUserAuthorizations WHERE UserId = 'b3367191-5269-458b-bb21-c177a10b6d25'

Columns

Name	Type	References	Description
AuthorizationId [KEY]	String		The ID of the user authorization.
Created	Datetime		The UTC DateTime when the workspace user authorization was created.
CreatedBy	String		The name and email of the user who created the authorization.
EndDate	Datetime		The UTC DateTime at which the authorization will expire.
Modified	Datetime		The UTC DateTime when the workspace user authorization was last updated.
ModifiedBy	String		The name and email of the user who created the authorization.
Permission	String		The permission level to grant the agent. Valid values are : Send, Manage, Sign, Edit
AccountId	String		The account ID.
Email	String		The email address of the authorization user.
Name	String		The name of the authorization user.
UserId	String		The ID of the authorization user.
StartDate	Datetime		The UTC DateTime at which the authorization will start.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
ActiveOnly	Boolean		When true, only active users are returned. The default value is false.
IncludeClosedUsers	Boolean		When true, returns active and scheduled authorizations of closed users. The default value is true. This value is only applied when active_only is false.

Retrieves a list of invoices for the account.

View Specific Information

The Cloud 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 Cloud.

• InvoiceId supports the '='.

For example, the following query is processed server side:

SELECT * FROM BillingInvoices WHERE InvoiceId = '3caf8d81-1c18-4ff6-bc1b-39e4ab8c2692'

Columns

Name	Type	References	Description
InvoiceId [KEY]	String		ID for the invoices.
Amount	String		The total amount of the purchase.
Balance	String		Balance reserved for Docusign.
DueDate	Date		Due date reserved for Docusign.
InvoiceItems	String		Billing Invoice Items.
InvoiceNumber	String		Invoices number.
InvoiceUri	String		Contains a URI for an endpoint that you can use to retrieve invoice information.
NonTaxableAmount	String		Non Taxable Amount
PdfAvailable	String		Pdf Available
TaxableAmount	String		Taxable Amount

Retrieves a list containing information about one or more payments.

View Specific Information

The Cloud 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 Cloud.

• PaymentId supports the '='.

For example, the following query is processed server side:

SELECT * FROM BillingPayments WHERE PaymentId = '3caf8d81-1c18-4ff6-bc1b-39e4ab8c2692'

Columns

Name	Type	References	Description
PaymentId [KEY]	String		The ID of the payment.
Amount	String		The total amount of the purchase.
Description	String		A sender-defined description of the line item.
PaymentDate	Date		The date of the payment.
PaymentNumber	String		When true, a PDF version of the invoice is available.

Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
PlanId [KEY]	String		Docusign's ID for the account plan.
AppStoreReceiptExpirationDate	Date		App Store Receipt Expiration Date.
AppStoreReceiptPurchaseDate	Date		App Store Receipt Purchase Date.
BillingPlanAddOns	String		Billing Plan Add Ons.
BillingAddress1	String		The first line of the address.
BillingAddress2	String		The second line of the address.
BillingAddressCity	String		The city associated with the address.
BillingAddressCountry	String		The country associated with the address.
BillingAddressEmail	String		The email address associated with the account.
BillingAddressFax	String		The fax number associated with the account.
BillingAddressFirstName	String		The first name of the user associated with the account
BillingAddressLastName	String		The last name of the user associated with the account.
BillingAddressPhone	String		The phone number associated with the account.
BillingAddressPostalCode	String		The postal code associated with the address.
BillingAddressState	String		The state or province associated with the address
BillingAddressIsCreditCardAddress	Boolean		When true, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different.
CanUpgrade	Boolean		When true, specifies that you can upgrade the account through the API. For GET methods, you must set the include_metadata query parameter to true for this property to appear in the response.
CreditCardAddress1	String		The first line of the user's address.
CreditCardAddress2	String		The second line of the user's address
CreditCardCity	String		The user's city.
CreditCardCountry	String		The user's country.
CreditCardFax	String		A fax number associated with the address, if one is available.
CreditCardPhone	String		A phone number associated with the address.
CreditCardPostalCode	String		The user's postal code.
CreditCardState	String		The user's state or province.
CardLastDigits	Integer		The Card Last Digits.
CardNumber	String		The Card Number.
CardType	String		The Card Type.
CVNumber	Integer		The cv Number.
CurrencyCode	String		Specifies the ISO 4217 currency code to use for the account.
OtherDiscountPercent	String		Any other percentage discount for the plan.
EnableSupport	Boolean		When true, customer support is provided as part of the account plan.
ExpirationMonth	String		The Expiration Month for Card.
ExpirationYear	String		The Expiration Year for Card.
IncludedSeats	String		The number of seats (users) included in the plan.
NameOnCard	String		The exact name as it appears on the credit card.
OtherDiscountPercent	String		Any other percentage discount for the plan.
PaymentCycle	String		The payment cycle associated with the plan. Valid values are Monthly,Annually
PaymentMethod	String		The payment method used with the plan. Valid values are CreditCard, PurchaseOrder, Premium, or Freemium.
PerSeatPrice	String		The per-seat price associated with the plan.
PaymentMethod	String		The payment method used for the billing plan.Valid values are NotSupported, CreditCard, PurchaseOrder, Premium, Freemium, FreeTrial, AppStore, DigitalExternal, DirectDebit
PlanClassification	String		Identifies the type of plan.
PlanName	String		The name of the Billing Plan.
PlanStartDate	String		The date that the Account started using the current plan.
SeatDiscounts	String		A complex type that contains any seat discount information.
SubscriptionStartDate	Date		Subscription Start Date
SuccessorPlans	String		A list of billing plans that the current billing plan can be rolled into.
SupportIncidentFee	String		The support incident fee charged for each support incident.
SupportPlanFee	String		The support plan fee charged for this plan.

Returns a summary of bulk send batches.

View Specific Information

The Cloud uses 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 Cloud.

• BatchId supports the '=, IN' operators.
• DateToSearch supports the '=, <, <=, >, >=' operators.
• Status supports the '=' operator.
• UserId supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM BulkSendBatch where batchid = '3b85e723-dee0-44db-ab3d-c45f5db88b6f';
SELECT * FROM BulkSendBatch where batchid in ('3b85e723-dee0-44db-ab3d-c45f5db88b6f','0afbac04-dc4a-4586-8740-7e05f658aa08');
SELECT * FROM BulkSendBatch where status = 'queued';
SELECT * FROM BulkSendBatch where datetosearch = '2017-01-02';
SELECT * FROM BulkSendBatch where datetosearch <= '2024-12-12';
SELECT * FROM BulkSendBatch where datetosearch < '2024-12-12';
SELECT * FROM BulkSendBatch where datetosearch >= '2017-01-02';
SELECT * FROM BulkSendBatch where datetosearch > '2017-01-02'; 
SELECT * FROM BulkSendBatch where userid = 'b3367191-5269-458b-bb21-c177a10b6d26';

Columns

Name	Type	References	Description
BatchId [KEY]	String		The batch ID.
BatchName	String		The name of the batch.
BatchSize	String		The number of envelopes in the batch.
BatchUri	String		The batch details URI.
Failed	String		Number of envelopes that failed to send.
Action	String		Action of batch.
ActionStatus	String		Action status of batch.
Queued	String		Number of envelopes pending processing.
Sent	String		Number of envelopes that have been sent.
SubmittedDate	Datetime		The time stamp of when the batch was created in ISO 8601 format.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
DateToSearch	Datetime		Date to search for a date range in UTC DateTime format. デフォルト値は2016-01-01です。
Status	String		The kind of results to collect. Must be one of: all, failed, sent, queued 使用できる値は次のとおりです。all, failed, sent, queued
UserId	String		The User ID.

Gets the general status of a specific bulk send batch.

View Specific Information

In order to make a successful request on this view, you must specify:

• BulkSendBatchId - Id of bulk send batch.

For example:

SELECT * FROM BulkSendBatchStatus where bulksendbatchid='2a554c07-6c-bccda356db31'

Columns

Name	Type	References	Description
BulkSendBatchId	String		An identifier that 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		The Uri of the bulk envelopes.
SubmittedDate	Datetime		The date the request 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 EnvelopeId or TemplateId.
Action	String		The action taken.
ActionStatus	String		The status of the action taken.
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's User Id.
ResendsRemaining	String		The number of resends remaining.
SenderUserId	String		The sender's User Id.

Retrieves a list of the user's items from the specified cloud storage provider.

View Specific Information

The Cloud 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 Cloud.

• FolderId supports the '='.
• UserId supports the '='.
• Serviceid supports the '='.

For example, the following query is processed server side:

select * from CLOUDSTORAGE where UserId='6de49590-65cf-41d4-ac62-399bd97dc1b3' and serviceid='10834292' and folderid='722ad244-59a0-4e30-99a8-45561090b784'

Columns

Name	Type	References	Description
Id [KEY]	String		The storage provider's ID for the file or folder.
UserId	String		Id of the user account
Serviceid	String		The ID of the service to access.Valid values are the service name (Box) or the numerical serviceId (4136).
FolderId	String		The ID of the folder.
ModifiedDate	Datetime		The UTC date and time that the file or folder was last modified.
Img	String		The file extension for a file.
Name	String		The full name of a file.
Size	String		The size of the file. The file size limit varies based on the cloud storage provider.
Supported	Boolean		When true, Docusign supports the file type for upload.
Type	String		The type of cloud storage item. Valid values are file and folder.
Uri	String		The URI for the file or folder.

The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.

View Specific Information

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 Cloud 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 Cloud.

• ServiceId supports the '='.

For example, the following query is processed server side:

SELECT * FROM CloudStorageProviders WHERE userId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a' AND ServiceId = '440189'

Columns

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.

View Specific Information

The Cloud 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 Cloud.

• CustomTabId supports the '='.

For example, the following query is processed server side:

SELECT * FROM CustomTabs WHERE CustomTabId = '926770b6-1cb6-487c-918c-dacf8c9caa2a'

Columns

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.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

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'

Columns

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
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	String		Detail of the 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.
AddedRecipientIds	String		If recipients were added by converting form fields into tabs, their IDs appear here. This property is read-only.
AvailableDocumentTypes	String		Signature Type.
TemplateLocked	String		When true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
TemplateRequired	String		When true, the sender may not remove the recipient. Used only when working with template recipients.
ItemURL	String		Contains a ItemUrl to retrieve the envelopes.

The DocumentTabs resource provides methods that allow you to manage various tabs in envelopes or templates.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• DocumentId - Id of the document.

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 Cloud 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 Cloud.

• PageNumber supports the '='.

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

Columns

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.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• RecipientId - Id of the recipient.

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

Columns

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.

View Specific Information

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'

Columns

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.

View Specific Information

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

Columns

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.
CopyRequestEmail	String		The email address to which the customer should send a request for copies of a document.
Custom	String		When true, indicates that the consumer disclosure is a custom disclosure. The default is false.
LanguageCode	String		The code for the language version of the disclosure.
UseConsumerDisclosureWithinAccount	String		When true, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.

Get data associated to the folder an envelope exists in.

View Specific Information

The Cloud 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 Cloud.

• EnvelopeId supports the '='.
• FolderId supports the '='.
• Type supports the '='.
• DateToSearch supports the '=,>,>=,<,<='.

For example, the following queries are processed server side:

SELECT * FROM EnvelopeFolders WHERE EnvelopeId = '764c564c-b540-42d1-a667-ccee6813ef7b';
SELECT * FROM EnvelopeFolders WHERE FolderId = '7276150d-f5e0-4e5e-8c9f-cb80495c27ce';
SELECT * FROM EnvelopeFolders WHERE Type = 'draft';
SELECT * from EnvelopeFolders where DateToSearch = '2024-05-15 10:55:11';
SELECT * from EnvelopeFolders where DateToSearch < '2024-05-15 10:55:11';
SELECT * from EnvelopeFolders where DateToSearch <= '2024-05-15 10:55:11';
SELECT * from EnvelopeFolders where DateToSearch >= '2024-05-15 10:55:11';
SELECT * from EnvelopeFolders where DateToSearch > '2024-05-15 10:55:11';
SELECT * from EnvelopeFolders where DateToSearch > '2025-09-16T01:55:11-05:00' AND DateToSearch < '2025-09-16T01:55:11-05:00';

Columns

Name	Type	References	Description
EnvelopeId [KEY]	String		The envelope's ID.
FolderId [KEY]	String		The ID of the folder.
Name	String		Name of the template.
Type	String		The type of folder.
Uri	String		The URI for the folder.
ParentFolderId	String		The ID of the parent folder, or the special value root for the root folder.
ParentFolderUri	String		The URI of the parent folder.
SubFolderCount	Integer		The number of subfolders.
HasAccess	Boolean		When true, the current user has access to the folder.
HasSubFolders	Boolean		When true, the folder has subfolders.
ItemCount	Integer		The number of items in the folder.
OwnerAccountId	String		The account ID associated with the envelope.
OwnerAccountName	String		The name on the account.
OwnerActivationAccessCode	String		Access code provided to the user to activate the account.
OwnerEmailId	String		The user's email address.
OwnerIpAddress	String		The user's IP address.
OwnerLoginStatus	String		When true, indicates that the user is logged in. This is a read-only property.
OwnerMembershipId	String		The user's membership ID.
OwnerUri	String		A URI containing the user ID.
OwnerUserId	String		The ID of the user to access.
OwnerUserName	String		The name of the user.
OwnerUserStatus	String		Status of the user's account.
OwnerUserType	String		The type of user, for example CompanyUser.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
DateToSearch	Datetime		Date to start fetching envelope identifiers from.

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.

View Specific Information

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'

Columns

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 provides methods that allow you to manage envelopes

View Specific Information

The Cloud 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 Cloud.

• EnvelopeId supports the '='.
• Status supports the '='.
• DateToSearch supports the '=,>,>=,<,<='.

For example, the following queries are processed server side:

SELECT * FROM Envelopes WHERE EnvelopeId = '764c564c-b540-42d1-a667-ccee6813ef7b'
SELECT * from Envelopes where DateToSearch <= '2024-05-15 10:55:11'
SELECT * from Envelopes where DateToSearch >= '2024-05-15 10:55:11'

Columns

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.
SenderUserName	String		The sender username associated with the envelope.
SenderUserId	String		The sender user ID associated with the envelope.
SenderAccountId	String		The sender account ID associated with the envelope.
SenderEmail	String		The sender email associated with the envelope.
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.
ItemURL	String		Contains a ItemUrl to retrieve the envelopes.
FoldersAggregate	String		A list of folder objects the envelope exists in.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
DateToSearch	Datetime		Date to search.

The EnvelopeTemplates resource provides methods that allow you to add and delete templates on envelopes and documents.

View Specific Information

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 Cloud 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 Cloud.

• DocumentId supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM EnvelopeTemplates WHERE EnvelopeId = 'cd7a0feb-2911-4595-a28e-deaa4a51f55d' AND DocumentId = '3'

Columns

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.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

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.
ItemURL	String		ItemUrl of the folder.
HasSubFolders	String		When true, the folder has subfolders
ItemCount	String		The number of items in the folder.

The GroupBrands resource provides methods that allow you to manage brands in a group.

View Specific Information

In order to make a successful request on this view, you have to specify GroupId.

For example:

SELECT * FROM GroupBrands WHERE GroupId = 6160665

Columns

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.
BrandLanguages	String		An array of two-letter codes for the languages that you want to use with the brand
Colors	String		An array of name-value pairs specifying the colors that the brand uses.
DefaultBrandLanguage	String		The two-letter code for the language that you want to use as the brand default.
ErrorDetails	String		This object describes errors that occur. It is only valid for responses and ignored in requests.
IsOrganizationBrand	String		IsOrganizationBrand
IsOrganizationBrandLogo	String		IsOrganizationBrandLogo
IsOverridingCompanyName	String		When true, the brandCompany property is overriding the name of the company in the account settings.
IsSendingDefault	String		When true, the sending brand is the default brand for sending new envelopes
IsSigningDefault	String		When true, the siging brand is the default brand for the signing experience.
LandingPages	String		An array of name/value pairs specifying the pages to which the user is redirected after the following events occur: Signing Completed, Viewed Exit, Finish Later, Decline, Session Timeout, Authentication Failure.If you do not specify landing pages, the Docusign default pages are used.
Links	String		An array of brandLink objects that contain information about the links that the brand uses.
Logos	String		The URIs for retrieving the logos that are associated with the brand.

The Groups resource provides methods that allow you to manage groups for the account.

The Cloud 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 Cloud.

• GroupType supports the '='.

For example, the following query is processed server side:

SELECT * FROM Groups WHERE GroupType = 'everyoneGroup'

Columns

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.

View Specific Information

In order to make a successful request on this view, you have to specify GroupId.

For example:

SELECT * FROM GroupUsers WHERE GroupId = 6071932

Columns

Name	Type	References	Description
GroupId [KEY]	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
Email	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.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

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'

Columns

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.

View Specific Information

The Cloud 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 Cloud.

• PowerFormId supports the '='.

For example, the following query is processed server side:

SELECT * FROM PowerForms WHERE PowerFormId = '3caf8d81-1c18-4ff6-bc1b-39e4ab8c2692'

Columns

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.

Returns the user authorizations for which the user specified by userId is the principal user.

The Cloud 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 Cloud.

• Permission supports the '=' operator.
• Email supports the '=' operator.
• Name supports the '=' operator.
• UserId supports the '=' operator.
• ActiveOnly supports the '=' operator.
• IncludeClosedUsers supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM PrincipalUserAuthorizations WHERE UserId = 'b3367191-5269-458b-bb21-c177a10b6d25'

Columns

Name	Type	References	Description
AuthorizationId [KEY]	String		The ID of the user authorization.
Created	Datetime		The UTC DateTime when the workspace user authorization was created.
CreatedBy	String		The name and email of the user who created the authorization.
EndDate	Datetime		The UTC DateTime at which the authorization will expire.
Modified	Datetime		The UTC DateTime when the workspace user authorization was last updated.
ModifiedBy	String		The name and email of the user who created the authorization.
Permission	String		The permission level to grant the agent. Valid values are : Send, Manage, Sign, Edit
AccountId	String		The account ID.
Email	String		The email address of the authorization user.
Name	String		The name of the authorization user.
UserId	String		The ID of the authorization user.
StartDate	Datetime		The UTC DateTime at which the authorization will start.
AgentUserId	String		The ID of the authorization user agent.
AgentName	String		The name of the authorization user agent.
AgentEmail	String		The email of the authorization user agent.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
ActiveOnly	Boolean		When true, only active users are returned. The default value is false.
IncludeClosedUsers	Boolean		When true, returns active and scheduled authorizations of closed users. The default value is true. This value is only applied when active_only is false.

The Recipients resource allows you manage the recipients of an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

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'

Columns

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.
Email	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.
Agents	String		A list of agent recipients assigned to the documents.
CarbonCopies	String		A list of carbon copy recipients assigned to the documents.
CertifiedDeliveries	String		A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
CurrentRoutingOrder	String		The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.
InPersonSigners	String		Specifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
Intermediaries	String		Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
Notaries	String		A list of notary recipients on the envelope.
Seals	String		A list of electronic seals to apply to the documents
RecipientCount	String		The number of recipients in the envelope.

The RecipientTabs resource provides methods that let you add, update, and delete tabs from an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• RecipientId - Id of the recipient.

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

Columns

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.
IsSealSignTab	String		IsSealSignTab.
ScaleValue	String		The Value for scale
StampType	String		The type of stamp.

Represents an instance or copy of an envelope

View Specific Information

The Cloud uses 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 Cloud.

• BulkSendListId supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SendListBulkCopies
SELECT * FROM SendListBulkCopies WHERE BulkSendListId = 'asd-wdas-dw'

Columns

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.

View Specific Information

The Cloud uses 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 Cloud.

• BulkSendListId supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SendListRecipients
SELECT * FROM SendListRecipients WHERE BulkSendListId = 'asd-wdas-dw'

Columns

Name	Type	References	Description
BulkSendListId	String	SendLists.BulkSendListId	The GUID of the bulk send list.
RecipientId	String		Unique Id for the recipient.
Email	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.

View Specific Information

DocuSign does not support any column for filtering this view. All filters are executed client side.

Columns

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.

Retrieves the list of information about the shared envelopes.

The Cloud 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 Cloud.

• UserUserId supports the '=' and 'IN' operators.
• UserUserStatus supports the '=' operator.
• SearchText supports the '=' operator.
• Shared supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM SharedAccessEncelopes

Columns

Name	Type	References	Description
UserUserId [KEY]	String		Information about the user who owns the shared item. The ID of the user to access.
Shared	String		How the item is shared. One of: not_shared, shared_to, shared_from, shared_to_and_from.
UserAccountId	String		Information about the user who owns the shared item. The account ID associated with the envelope.
UserAccountName	String		Information about the user who owns the shared item. The name on the account.
UserActivationAccessCode	String		Information about the user who owns the shared item. Access code provided to the user to activate the account.
UserEmail	String		Information about the user who owns the shared item. The user's email address.
UserIpAddress	String		Information about the user who owns the shared item. The user's ip address.
UserLoginStatus	String		Information about the user who owns the shared item. When true, indicates that the user is logged in.
UserMembershipId	String		Information about the user who owns the shared item. The user's membership ID.
UserUri	String		Information about the user who owns the shared item. A URI containing the user ID.
UserUserName	String		Information about the user who owns the shared item. The name of the user.
UserUserStatus	String		Information about the user who owns the shared item. Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
UserUserType	String		Information about the user who owns the shared item. The type of user.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
SearchText	String		Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.

Retrieves the list of information about the shared folders.

The Cloud 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 Cloud.

• FolderId supports the '=' and 'IN' operators.
• UserUserId supports the '=' and 'IN' operators.
• UserUserStatus supports the '=' operator.
• SearchText supports the '=' operator.
• Shared supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM SharedAccessFolders

Columns

Name	Type	References	Description
FolderId [KEY]	String		The ID of the folder.
FolderName	String		The name of the folder.
OwnerAccountId	String		Information about the user who owns the folder. The account ID associated with the folder.
OwnerAccountName	String		Information about the user who owns the folder. The name on the account.
OwnerActivationAccessCode	String		Information about the user who owns the folder. Access code provided to the user to activate the account.
OwnerEmail	String		Information about the user who owns the folder. The user's email address.
OwnerIpAddress	String		Information about the user who owns the folder. The user's ip address.
OwnerLoginStatus	String		Information about the user who owns the folder. When true, indicates that the user is logged in.
OwnerMembershipId	String		Information about the user who owns the folder. The user's membership ID.
OwnerUri	String		Information about the user who owns the folder. A URI containing the user ID.
OwnerUserId	String		Information about the user who owns the folder. The ID of the user to access.
OwnerUserName	String		Information about the user who owns the folder. The name of the user.
OwnerUserStatus	String		Information about the user who owns the folder. Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
OwnerUserType	String		Information about the user who owns the folder. The type of user.
ParentFolderId	String		The ID of the parent folder.
ParentFolderUri	String		The URI for the parent folder.
Shared	String		Indicates how the folder is shared. Valid values are: shared_to, not_shared.
SharedGroups	String		A list of groups that shared the folder.
SharedUsers	String		A list of users who share the folder.
Uri	String		A URI containing the user ID.
UserAccountId	String		Information about the user associated with the folder. The account ID associated with the folder.
UserAccountName	String		Information about the user associated with the folder. The name on the account.
UserActivationAccessCode	String		Information about the user associated with the folder. Access code provided to the user to activate the account.
UserEmail	String		Information about the user associated with the folder. The user's email address.
UserIpAddress	String		Information about the user associated with the folder. The user's ip address.
UserLoginStatus	String		Information about the user associated with the folder. When true, indicates that the user is logged in.
UserMembershipId	String		Information about the user associated with the folder. The user's membership ID.
UserUri	String		Information about the user associated with the folder. A URI containing the user ID.
UserUserId	String		Information about the user associated with the folder. The ID of the user to access.
UserUserName	String		Information about the user associated with the folder. The name of the user.
UserUserStatus	String		Information about the user associated with the folder. Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
UserUserType	String		Information about the user associated with the folder. The type of user.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
SearchText	String		Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.

Retrieves the list of information about the shared templates.

The Cloud 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 Cloud.

• TemplateId supports the '=' and 'IN' operators.
• SearchText supports the '=' operator.
• Shared supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM SharedAccessTemplates

Columns

Name	Type	References	Description
TemplateId [KEY]	String		The unique identifier of the template. If this is not provided, Docusign will generate a value.
TemplateName	String		The name of the shared template.
OwnerAccountId	String		Information about the user who owns the template. The account ID associated with the envelope.
OwnerAccountName	String		Information about the user who owns the template. The name on the account.
OwnerActivationAccessCode	String		Information about the user who owns the template. Access code provided to the user to activate the account.
OwnerEmail	String		Information about the user who owns the template. The user's email address.
OwnerIpAddress	String		Information about the user who owns the template. The user's ip address.
OwnerLoginStatus	String		Information about the user who owns the template. When true, indicates that the user is logged in.
OwnerMembershipId	String		Information about the user who owns the template. The user's membership ID.
OwnerUri	String		Information about the user who owns the template. A URI containing the user ID.
OwnerUserId	String		Information about the user who owns the template. The ID of the user to access.
OwnerUserName	String		Information about the user who owns the template. The name of the user.
OwnerUserStatus	String		Information about the user who owns the template. Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled
OwnerUserType	String		Information about the user who owns the template. The type of user.
Password	String		The user's password.
Shared	String		How the template is shared. One of: not_shared, shared_to.
SharedGroups	String		List of groups that share the template.
SharedUsers	String		List of users that share the template.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
SearchText	String		Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.

Retrieves the information about the user requesting the shared information.

The Cloud 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 Cloud.

• UserId supports the '=' and 'IN' operators.
• UserStatus supports the '=' operator.
• SearchText supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM SharedAccessUser

Columns

Name	Type	References	Description
UserId [KEY]	String		The ID of the user to access.
AccountId	String		The account ID associated with the envelope.
AccountName	String		The name on the account.
ActivationAccessCode	String		Access code provided to the user to activate the account.
Email	String		The user's email address.
IpAddress	String		The user's ip address.
LoginStatus	String		When true, indicates that the user is logged in.
MembershipId	String		The user's membership ID.
Uri	String		A URI containing the user ID.
UserName	String		The name of the user.
UserStatus	String		Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled
UserType	String		The type of user.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
SearchText	String		Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.

Returns data from a sample table.

View Specific Information

The Cloud 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 Cloud.

• SigningGroups supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SigningGroups WHERE SigningGroupId = '9degfd10-2704-4af4-ae3e-ac6r4d4bcf0a'

Columns

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.

View Specific Information

In order to make a successful request on this view, you have to specify SigningGroupId.

For example:

SELECT * FROM SigningGroupUsers WHERE SigningGroupId = '6071932'

Columns

Name	Type	References	Description
SigningGroupId [KEY]	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 Cloud 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 Cloud.

• TemplateId supports the '='.
• FolderId supports the '=' and 'IN'. In order to filter by FolderId, showCustomFiled property must be set to false.

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')

Columns

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.
ItemURL	String		Contains a ItemUrl to retrieve the templates.
FolderIds	String		A comma-separated list of folder ID GUIDs.

The UserInfo resource provides methods that allow you to manage your current user info.

Columns

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.

View Specific Information

The Cloud 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 Cloud.

• Users supports the '='.
• UserStatus supports the '='.

For example, the following queries are processed server side:

SELECT * FROM Users WHERE UserId = '9degfd10-2704-4af4-ae3e-ac6r4d4bcf0a'
SELECT * FROM Users WHERE UserStatus = 'Active'

Columns

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.
Email	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.
Company	String		The name of the user's company.
FirstName	String		The user's first name
IsAlternateAdmin	String		When true, the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed.
LastName	String		The user's last name.
MiddleName	String		The user's middle name.

The UserSignatures resource provides methods that allow you manage the intials and signature images for a user.

View Specific Information

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'

The Cloud 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 Cloud.

• UserId supports the '='.
• UserSignatures supports the '='.

For example, the following queries are processed server side:

SELECT * FROM UserSignatures WHERE UserId = '6de49590-65cf-41d4-ac62-399bd97dc1b3'
SELECT * FROM UserSignatures WHERE SignatureId = '956359'

Columns

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.
DisallowUserResizeStamp	String		When true, users may not resize the stamp.
Initials150ImageId	String		The ID of the user's initials image.
NrdsId	String		The National Association of Realtors (NAR) membership ID for a user who is a realtor.
NrdsLastName	String		The realtor's last name.
NrdsStatus	String		The realtor's NAR membership status.
PhoneticName	String		The phonetic spelling of the signatureName.
Signature150ImageId	String		The ID of the user's signature image.
SignatureFont	String		The font type for the signature, if the signature is not drawn. The supported font types are:7_DocuSign,1_DocuSign, 6_DocuSign, 8_DocuSign, 3_DocuSign, Mistral, 4_DocuSign, 2_DocuSign, 5_DocuSign, Rage Italic
SignatureRights	String		The rights that the user has to the signature. Valid values are: none, read and admin.
StampFormat	String		The format of a stamp.
StampImageUri	String		The URI for retrieving the image of the user's stamp.
StampSizeMM	String		The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
StampType	String		The type of stamp.
Status	String		Indicates the envelope status.

The Workspaces resource provides methods that allow you to manage workspaces.

View Specific Information

The Cloud 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 Cloud.

• Workspaces supports the '='.

For example, the following queries are processed server side:

SELECT * FROM Workspaces WHERE WorkspaceId = '9degfd10-2704-4af4-ae3e-ac6r4d4bcf0a'

Columns

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.

ストアドプロシージャはファンクションライクなインターフェースで、DocuSign の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにDocuSign から関連するレスポンスデータを返します。

CData Cloud - DocuSign ストアドプロシージャ

Name	Description
AddDocumentToTemplate	Adds a document to an existing template.
CreateAndSendEnvelope	Creates and sends an envelope or creates a draft envelope.
CreateTemplate	Creates a template definition, using a multipart request for the template.
GetConsentURL	Get the URL for individual consent.
MoveEnvelope	Move envelopes to a specified folder. When destination folder id is recyclebin, you can delete or void an envelope.

Adds a document to an existing template.

Input

Name	Type	Required	Description
TemplateId	String	True	The Id of the template.
FileLocation	String	False	File location. For example: C:\File.pdf
FileName	String	False	Document name. This is required when content is not null.
DocumentId	String	True	Id for the document

Result Set Columns

Name	Type	Description
Success	String	Determines whether the operation is successful or not

Creates and sends an envelope or creates a draft envelope.

Table Specific Information

Execute

Create the envelope.

The required columns to run the stored procedure are EmailSubject, DocumentId, FileLocation or Content. While parsing single signers, the SignersRecipientId column might also be required. If you use CarbonCopies, you might also need to include the CcEmail and CcRecipientId columns.

EXECUTE CreateAndSendEnvelope EmailSubject = 'Please sign this document', FileName = 'sample', DocumentId = '1', CcEmail = '[email protected]', SignersRecipientId = '1', CcRecipientId = '2', FileLocation = 'C:/Users/cdata/Downloads/sample.pdf'

If you are using a document other than PDF, DocumentFileExtension is mandatory.

EXECUTE CreateAndSendEnvelope EmailSubject = 'Please sign this document', FileName = 'sample', DocumentId = '1', DocumentFileExtension = 'docx', CcEmail = '[email protected]', SignersRecipientId = '1', CcRecipientId = '2', Content = InputStream

Create the envelope with customfields. The possible columns for customfields are CustomFieldName, CustomFieldId, CustomFieldShow, CustomFieldRequired, CustomFieldValue, CustomFieldConfigurationType, CustomFieldType and CustomFieldListItems.

INSERT INTO CreateAndSendEnvelope#TEMP (CustomFieldtest, CustomFieldValue, CustomFieldId, CustomFieldType) VALUES ('vk', 'test', 1, TextCustomFields)
EXECUTE CreateAndSendEnvelope EmailSubject = 'Please sign this document', FileName = 'sample', DocumentId = 1, CCEmail = '[email protected]', SignersRecipientId = 2, CcRecipientId = 1, FileLocation = 'C:/Users/cdata/Downloads/sample.pdf', CustomFieldAggregate = 'CreateAndSendEnvelope#TEMP' 

INSERT INTO CreateAndSendEnvelope#TEMP (CustomFieldName, CustomFieldValue, CustomFieldId, CustomFieldType) VALUES ('test2', 'test_custom',480730, TextCustomFields)
INSERT INTO CreateAndSendEnvelope#TEMP (CustomFieldName, CustomFieldValue, CustomFieldId, CustomFieldType) VALUES ('test21', 'test_custom1',480731, ListCustomFields)
EXEC CreateandSendEnvelope EmailSubject=?,CustomFieldAggregate=?","test,CreateAndSendEnvelope#TEMP

The second way of using the Stored Procedure is by adding the aggregate itself:

EXEC CreateandSendEnvelope EmailSubject=?,DocumentId=?,FileLocation='D:\\\\Raj Shekhar Gupta\\\\testing.pdf',FileName=?,CustomFieldAggregate='{\"listCustomFields\": [{\"name\": \"Customfieldstest1\",\"show\": \"true\",\"required\": \"true\",\"value\": \"anirudhtest\"}]}'","Please sign this document on priority,122,testing123"

Create the envelope with multiple values of Signers, CarbonCopies and Documents by adding the aggregate itself for SignersAggregate, CarbonCopiesAggregate and DocumentsAggregate. In case

EXEC CreateandSendEnvelope EmailSubject=?,DocumentId=?,FileLocation='D:\\\\Raj Shekhar Gupta\\\\testing.pdf',FileName=?,CarbonCopiesAggregate='[{\"email\": \"[email protected]\",\"name\": \"anirudhk\"}]',CustomFieldAggregate='{\"listCustomFields\": [{\"name\": \"Customfieldstest1\",\"show\": \"true\",\"required\": \"true\",\"value\": \"anirudhtest\"}]}',SignersAggregate='[{\"email\": \"[email protected]\",\"name\": \"raj\",\"recipientId\": \"84570874\",\"tabs\": {\"signHereTabs\": [{\"anchorYOffset\": \"10\",\"anchorString\":\"signature_1\",\"anchorUnits\": \"pixels\",\"anchorXOffset\": \"20\"}]}}]'","Please sign this document on priority,122,testing123

Create the envelope with multiple values of Documents by adding the aggregate itself for DocumentsAggregate and providing the base64encoded value for the document.

EXEC CreateandSendEnvelope EmailSubject='Please reply',CarbonCopiesAggregate='[{\"email\": \"[email protected]\",\"recipientId\": \"7\",\"name\": \"anirudhk\"}]',DocumentsAggregate='[{\"documentBase64\": \"encoded\",\"name\": \"testing\",\"documentId\": \"122\"},{\"documentBase64\": \"encoded\",\"documentId\": \"124\",\"name\":\"anirudh\"}]';

Note: When using this stored procedure, please avoid including a suffix for the file in the FileName input (such as DOCX, PDF, or HTML). Use DocumentFileExtension instead.

Input

Name	Type	Required	Description
Status	String	False	Set the status to 'sent' to send the envelope to recipients immediately, or set the status to 'created' to save the envelope as a draft. The default value is 'created'. 使用できる値は次のとおりです。sent, created
EmailSubject	String	True	The subject line of the email sent to recipients with the envelope.
DocumentId	String	False	The unique identifier for the document within the envelope.
DocumentFileExtension	String	False	The file extension of the document. This input is mandatory if the file is not a PDF. 使用できる値は次のとおりです。docx, pdf, html
FileLocation	String	False	The file location, such as 'C:\File.pdf'. Use if not providing a stream.
FileName	String	False	The name of the document file. Required if Content is provided. Do not include a file extension here. Use DocumentFileExtension instead.
SignersEmail	String	False	The email Id of the document's signer.
SignersRoutingOrder	String	False	The routing order for the document's signers.
SignersRecipientId	String	False	The signer's recipient Id.
SignersName	String	False	The full name of the document signer.
CcEmail	String	False	The email Id of the carbon copy (CC) recipient.
CcName	String	False	The full name of the CC recipient.
CcRecipientId	String	False	The Id of the CC recipient.
CcRoutingOrder	String	False	The routing order for the CC recipients.
CustomFieldAggregate	String	False	Aggregated custom field data. The possible columns are CustomFieldName, CustomFieldId, CustomFieldShow, CustomFieldRequired, CustomFieldValue, CustomFieldConfiguration, and CustomFieldListItems.
CarbonCopiesAggregate	String	False	A structured list of CC recipients. Use instead of individual CC fields for bulk operations.
SignersAggregate	String	False	A structured list of signers with full metadata. Use instead of individual signer fields for bulk signer input.
DocumentsAggregate	String	False	A structured list of documents to include in the envelope. Use when sending multiple documents.

Result Set Columns

Name	Type	Description
Success	String	Determines whether the operation was successful.

Creates a template definition, using a multipart request for the template.

Input

Name	Type	Required	Description
Name	String	True	The name of the template.
Description	String	False	The description of the template.
Shared	String	False	When true, indicates the template is shared with the Everyone group, which includes all users on the account. When false, the template is shared only with the groups you specify.
EmailSubject	String	False	The subject line of the email message that is sent to all recipients.
RecipientsCarbonCopiesAggregate	String	False	A list of carbon copy recipients assigned to the template.
RecipientsSignersAggregate	String	False	A list of signers on the template.
DocumentsAggregate	String	False	A list of documents attached to the template.
EnvelopeId	String	False	The envelope ID of an envelope that you want to use as the basis for the template. The state of the envelope can be draft, sent, or completed.

Result Set Columns

Name	Type	Description
Success	String	Determines whether the operation is successful or not
TemplateId	String	The Id of the template created.
Name	String	Name of the template created.

Get the URL for individual consent.

Input

Name	Type	Required	Description
IntegrationKey	String	True	The integration key to be used.
RedirectUri	String	True	The URL to redirect the client after consent is given.

Result Set Columns

Name	Type	Description
URL	String	Returns the URL to be used for individual consent.

Move envelopes to a specified folder. When destination folder id is recyclebin, you can delete or void an envelope.

Input

Name	Type	Required	Description
EnvelopeId	String	True	Id of the envelope you want to move.
FromFolderId	String	True	Id of the folder where envelope is located.
ToFolderId	String	True	Id of the folder where envelope is going to move.

Result Set Columns

Name	Type	Description
Success	String	Returns True if the envelope moves to the specified folder.

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、DocuSign のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	データベース名。

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Account テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Account' 

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType	String	スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。