5.4. IM-LogicDesigner タスク説明¶
5.4.1. クラウドサインタスクの一覧¶
クラウドサインタスクは、下記一覧に記載の26個を利用することが可能です。IM-LogicDesignerの各タスクにおける入力値、および出力値については、クラウドサインの入出力値と一致します。「クラウドサイン Web API」を参照してください。APIのバージョンは 0.17.0 に対応しています。
コラム
ロジックフロー定義編集画面にて、クラウドサインのカテゴリおよびタスクのアイコンが表示されない場合、アイコンのリカバリを実行することで表示されるようになる場合があります。
詳細は、「IM-LogicDesigner ユーザ操作ガイド」 - 「ユーザアイコンをリカバリする」を参照してください。
5.4.1.1. タスク一覧¶
| LDタスク名 | 説明 | メソッド | URI |
|---|---|---|---|
| im_cloudsignGetToken | アクセストークンの取得 | POST | /token |
| im_cloudsignSwitchUser | ユーザ切り替え | （後述） | （後述） |
| im_cloudsignCreateDocument | 書類の作成 | POST | /documents |
| im_cloudsignGetDocuments | 書類一覧の取得 | GET | /documents |
| im_cloudsignGetDocument | 書類データの取得 | GET | /documents/{documentID} |
| im_cloudsignUpdateDocument | 書類データの更新 | PUT | /documents/{documentID} |
| im_cloudsignDeleteDocument | 書類データの削除 | DELETE | /documents/{documentID} |
| im_cloudsignSendOrRemind | 送信またはリマインド | POST | /documents/{documentID} |
| im_cloudsignGetAttribute | 書類情報の取得 | GET | /documents/{documentID}/attribute |
| im_cloudsignCreateOrUpdateAttribute | 書類情報の作成はまたは更新 | PUT | /documents/{documentID}/attribute |
| im_cloudsignGetCertificate | 合意締結証明書の取得 | GET | /documents/{documentID}/certificate |
| im_cloudsignDecline | 確認中の書類を却下する | PUT | /documents/{documentID}/decline |
| im_cloudsignAttachFile | ファイルの添付 | POST | /documents/{documentID}/files |
| im_cloudsignGetAttachmentFile | ファイルの取得 | GET | /documents/{documentID}/files/{fileID} |
| im_cloudsignDeleteAttachmentFile | 添付ファイルの削除 | DELETE | /documents/{documentID}/files/{fileID} |
| im_cloudsignAddParticipant | 宛先の追加 | POST | /documents/{documentID}/participants |
| im_cloudsignUpdateParticipant | 宛先の更新 | PUT | /documents/{documentID}/participants/{participantID} |
| im_cloudsignDeleteParticipant | 宛先の削除 | DELETE | /documents/{documentID}/participants/{participantID} |
| im_cloudsignAddWidget | 入力項目の追加 | POST | /documents/{documentID}/files/{fileID}/widgets |
| im_cloudsignUpdateWidget | 入力項目の内容変更 | PUT | /documents/{documentID}/files/{fileID}/widgets/{widgetID} |
| im_cloudsignDeleteWidget | 入力項目の削除 | DELETE | /documents/{documentID}/files/{fileID}/widgets/{widgetID} |
| im_cloudsignGetTeamDocuments | チームドキュメントの取得 | GET | /team_documents |
| im_cloudsignGetMe | ユーザ情報及びチーム情報取得 | GET | /me |
| im_cloudsignAddReportee | 共有先の追加 | POST | /documents/{documentID}/reportees |
| im_cloudsignUpdateReportee | 共有先の更新 | PUT | /documents/{documentID}/reportees/{reporteeID} |
| im_cloudsignDeleteReportee | 共有先の削除 | DELETE | /documents/{documentID}/reportees/{reporteeID} |
5.4.1.2. ユーザ切り替えタスク¶
タスク一覧に記載の im_cloudsignSwitchUser （ユーザ切り替え）タスクは特殊タスクです。データマッピングでクライアントIDを受け渡すと、以降のクラウドサイン関連のタスクではクライアントIDが切り替わって処理が行われます。このタスクを配置したロジックフローにおいて、このタスク以降のクラウドサインタスクに影響します。
コラム
本タスクは 2020 Winter(Azalea)以降で利用可能です。
コラム
クラウドサイン連携における クライアントID の解決は以下の順にて行われます。
- ユーザ切り替えタスクによる指定（当該設定）
- 外部システムユーザ識別子による指定
- 設定ファイルによる指定
5.4.1.3. 入力値¶
im_cloudsignSwitchUser <object>
└─ clientId <string> *
| 項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
|---|---|---|---|---|
| im_cloudsignSwitchUser | 任意 | object | なし | -
|
| clientId | 必須 | string | なし | クラウドサインのクライアントIDです。
|
5.4.1.4. 出力値¶
im_cloudsignSwitchUser <any>
| 項目名 | 型 | 配列/リスト | 説明 |
|---|---|---|---|
| im_cloudsignSwitchUser | object | なし | 出力値として利用可能な値はありません。
|