Documents
Retrieve and query information related to documents.
テーブル固有の情報
SELECT
本製品 は CloudSign API を使用して、以下のカラムと演算子で構築されたWHERE句条件を処理します。その他のフィルタはクライアント側で本製品 内部で処理されます。
| カラム | サポートされる演算子 |
| DocumentId | = |
| Status | = |
| TeamDocuments | = |
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Documents WHERE DocumentId = 'caa8f083-6e48-4b4b-9f42-d27544c4e662'
SELECT * FROM Documents WHERE Status = 0
SELECT * FROM Documents WHERE TeamDocuments = true
INSERT
DocumentId、CreatedAt、DeclineCancelReason、Status、UpdatedAt、UserId 以外のすべてのカラムを指定できます。
INSERT INTO Documents (Title, Note, Message, CanTransfer, TemplateId) VALUES ('Insert Document Title', 'Insert Note', 'Insert Message', false, '808d24d4-c366-4f21-831d-20fabe1f5f73')
UPDATE
DocumentId、CreatedAt、DeclineCancelReason、Status、UpdatedAt、UserId 以外のすべてのカラムを更新できます。UPDATE には、抽出条件にDocumentId が必要です。
UPDATE Documents SET Note = 'Update Note', CanTransfer = true, Message = 'Update Message', Title = 'Update Document Title' WHERE DocumentId = 'b4569785-8e87-4595-a435-88649dc3c644'
DELETE
DELETE はこのテーブルではサポートされていません。
Columns
| Name | Type | ReadOnly | Description |
| DocumentId [KEY] | String | True |
Document Id. |
| CanTransfer | Boolean | False |
Flag to allow recipients to forward. The default is false. |
| CreatedAt | Datetime | True |
Creation date. |
| Message | String | False |
A message added to the confirmation request mail. |
| Note | String | False |
Notes about documents. It is not displayed to the recipient. |
| Status | Integer | True |
Document status. {0: Draft}, {1: Undergoing checking in progress}, {2: Conclusion completed}, {3: Canceled or rejected}, {4: Template} |
| Title | String | False |
Title of the document. |
| UpdatedAt | Datetime | True |
Update date. |
| UserId | String | True |
Creator ID. |
| TemplateId | String | False |
The document ID of the template that is the source of document creation from the existing template. |
| DeclineCancelReason | String | True |
The reason the document was declined or cancelled. |
Pseudocolumns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるデータを詳細に制御することができます。
| Name | Type | Description |
| TeamDocuments | Boolean |
Acquisition of documents lists of all members. |