Widgets
入力項目に関する情報を取得およびクエリします。
Select
本製品 は CloudSign API を使用して、以下のカラムと演算子で構築されたWHERE句条件を処理します。その他のフィルタはクライアント側で本製品 内部で処理されます。
- DocumentId カラムは = 演算子をサポートしています。
- TeamDocuments 疑似カラムは = 演算子をサポートしています。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Widgets WHERE DocumentId = 'caa8f083-6e48-4b4b-9f42-d27544c4e662'
SELECT * FROM Widgets WHERE TeamDocuments = true
INSERT
Status、H、W 以外のすべてのカラムを指定できます。INSERT には、DocumentId、FileId、ParticipantId、WidgetType、Page、X、Y が必須です。
INSERT INTO Widgets (DocumentId, FileId, ParticipantId, Text, WidgetType, Page, X, Y, Label) VALUES ('b4569785-8e87-4595-a435-88649dc3c644', 'be175a71-b132-48ca-aceb-868203975cc5', '0bf35cc7-6ca6-479c-9c60-d100cb926bf0', 'Insert Widgets Text', '1', '1', '100', '200', 'Insert Label')
Update
Status、H、W 以外のすべてのカラムを更新できます。UPDATE には、WidgetType が必須です。UPDATE には、抽出条件にDocumentId、FileId、WidgetId が必要です。
UPDATE Widgets SET ParticipantId = '0bf35cc7-6ca6-479c-9c60-d100cb926bf0', Text = 'Update Text', WidgetType = '0', Page = '2', X = '300', Y = '400', Label = 'Update Label' WHERE DocumentId = 'b4569785-8e87-4595-a435-88649dc3c644' AND FileId = 'be175a71-b132-48ca-aceb-868203975cc5' AND WidgetId = 'f1c623a0-393f-4423-a91b-719b7e361907'
Delete
DocumentId、FileId、WidgetId を指定して入力項目を削除できます。
DELETE FROM Widgets WHERE DocumentId = 'b4569785-8e87-4595-a435-88649dc3c644' AND FileId = 'be175a71-b132-48ca-aceb-868203975cc5' AND WidgetId = 'f1c623a0-393f-4423-a91b-719b7e361907'
Columns
Name | Type | ReadOnly | Description |
DocumentId [KEY] | String | False |
書類ID。 |
Title | String | False |
書類のタイトル。 |
FileId [KEY] | String | False |
入力対象のファイルのID。 |
WidgetId [KEY] | String | False |
入力項目のID。 |
ParticipantId | String | False |
入力が割り当てられている宛先のID。 |
Status | Integer | True |
入力項目の状態。 |
Text | String | False |
入力項目に入力されたテキスト。 |
WidgetType | Integer | False |
入力項目の種類(0-押印、1-フリーテキスト)。 |
Page | Integer | False |
入力項目が設定されている対象ファイルのページ番号。 |
X | Integer | False |
入力項目左上の対象ファイル/対象ページにおける設置位置のX 座標。 |
Y | Integer | False |
入力項目左上の対象ファイル/対象ページにおける設置位置のY 座標。 |
H | Integer | True |
入力項目の高さ。 |
W | Integer | True |
入力項目の幅。 |
Label | String | False |
入力項目に入力されたラベル。 |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
TeamDocuments | Boolean |
メンバー全員がやり取りした書類一覧の取得。 |