Participants

宛先に関する情報を取得およびクエリします。

Select

connector は CloudSign API を使用して、以下のカラムと演算子で構築されたWHERE句条件を処理します。その他のフィルタはクライアント側でconnector 内部で処理されます。

DocumentId カラムは = 演算子をサポートしています。
TeamDocuments 疑似カラムは = 演算子をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Participants WHERE DocumentId = 'caa8f083-6e48-4b4b-9f42-d27544c4e662'

SELECT * FROM Participants WHERE TeamDocuments = true

Insert

Title、Order、Status、AccessExpiresAt 以外のすべてのカラムを指定できます。挿入には、DocumentId、Email、Name が必須です。

INSERT INTO Participants (DocumentId, AccessCode, Email, LanguageCode, Name, Organization) VALUES ('b4569785-8e87-4595-a435-88649dc3c644', '1234', '[email protected]', 'ja', 'Name', 'CData')

Update

Title、Order、Status、AccessExpiresAt 以外のすべてのカラムを指定できます。UPDATE には、抽出条件にDocumentId、ParticipantId が必要です。

UPDATE Participants SET Email = '[email protected]', Name = 'Name Update', Organization = 'CData Update', AccessCode = '56789', LanguageCode = 'zh-CHS' WHERE DocumentId = 'b4569785-8e87-4595-a435-88649dc3c644' AND ParticipantId = '0bf35cc7-6ca6-479c-9c60-d100cb926bf0';

Delete

DocumentId、ParticipantId を指定して宛先を削除できます。

DELETE FROM Participants WHERE DocumentId = 'b4569785-8e87-4595-a435-88649dc3c644' AND ParticipantId = '0bf35cc7-6ca6-479c-9c60-d100cb926bf0'

Columns


Name	Type	ReadOnly	Description
DocumentId [KEY]	String	False	書類ID。
Title	String	True	書類のタイトル。
AccessCode	Integer	False	宛先に設定されているアクセスコード。API を使用しているユーザーが値を設定した場合のみレスポンスに含まれる。
Email	String	False	宛先のメールアドレス。
ParticipantId [KEY]	String	False	宛先ID。
LanguageCode	String	False	宛先の言語設定。ja（日本語）、en（英語）、zh-CHS（簡体字）、zh-CHT（繁体字）のいずれか。何も指定しない場合の値は ja。
Name	String	False	宛先の名前。
Order	Integer	True	書類内の宛先の順序（送信者は 0）。
Organization	String	False	宛先の会社名など。
Status	Integer	True	宛先の状態。
AccessExpiresAt	Datetime	True	URL 有効期限（RFC3339準拠）。Status が4の場合のみレスポンスに含まれる。

Pseudo-Columns

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


Name	Type	Description
TeamDocuments	Boolean	メンバー全員がやり取りした書類一覧の取得。