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、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、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
削除はこのテーブルではサポートされていません。
Columns
Name | Type | ReadOnly | Description |
DocumentId [KEY] | String | False |
書類ID。 |
CanTransfer | Boolean | False |
受信者に転送を許可するフラグ。デフォルトはfalse。 |
CreatedAt | Datetime | True |
作成日時。 |
Message | String | False |
確認依頼メールに追加されるメッセージ。 |
Note | String | False |
契約相手の名称などのメモ。受信者には表示されない。 |
Status | Integer | True |
書類の状態。 {0:下書き}, {1:先方確認中}, {2:締結済}, {3:取消、または却下}, {4:テンプレート} |
Title | String | False |
書類のタイトル。 |
UpdatedAt | Datetime | True |
更新日時。 |
UserId | String | True |
作成者ID。 |
TemplateId | String | False |
既存のテンプレートから書類作成を行う場合の元となるテンプレートの書類ID。 |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
TeamDocuments | Boolean |
メンバー全員がやり取りした書類一覧の取得。 |