Workflow API では、ワークフローのカテゴリ、フォーム、決裁文書などを管理することができます。
Workflow API の利用には、LINE WORKSワークフロー オプションが必要です。
User Account 認証または Service Account 認証 (JWT) で取得した Access Token で利用できます。
注意
Workflow API では、path パラメータの {userId} として、me キーワード、または externalKey を利用できません。
Workflow API の利用では、userId として、リソース ID またはログイン ID を指定してください。
Scopes: workflow, workflow.read
参考
ワークフロー管理画面のシステム連携メニューに関しては、ヘルプセンターを参照してください。
申請フォーマットのカテゴリーは以下の API で管理します。
| HTTP Request | Description |
|---|---|
| POST /workflow/categories | カテゴリーの作成 |
| GET /workflow/categories | カテゴリーのリスト取得 |
| GET /workflow/categories/{categoryId} | カテゴリーの取得 |
| PATCH /workflow/categories/{categoryId} | カテゴリーの部分更新 |
| DELETE /workflow/categories/{categoryId} | カテゴリーの削除 |
サービス画面ではカテゴリーに表示順を設定できますが、API ではカテゴリー名 categoryName と多国語名情報 i18nNames のみを指定します。
{ "categoryName": "一般", "i18nNames": [{ "language": "en_US", "name": "General" },{ "language": "ko_KR", "name": "일반" },{ "language": "ja_JP", "name": "一般" }]}申請フォーマットは以下の API で管理します。
| HTTP Request | Description |
|---|---|
| GET /workflow/document-forms | 申請フォーマットのリスト取得 |
| GET /workflow/document-forms/{documentFormId} | 申請フォーマットの取得 |
入力値リストは以下の API で管理します。
決裁文書は以下の API で管理します。
| HTTP Request | Description |
|---|---|
| POST /workflow/users/{userId}/documents | 決裁文書の作成 |
| GET /workflow/documents/{approvalDocumentId} | 決裁文書の取得 |
| GET /workflow/users/{userId}/documents | 決裁文書のリスト取得(メンバー) |
| GET /workflow/documents | 決裁文書のリスト取得(管理者) |
| GET /workflow/users/{userId}/documents/search | 決裁文書の検索 (メンバー) |
| GET /workflow/documents/search | 決裁文書の検索 (管理者) |
| POST /workflow/imported-documents | 文書のインポート |
決裁文書の添付ファイルは以下の API で管理します。
| HTTP Request | Description |
|---|---|
| POST /workflow/users/{userId}/documents/attachments | 決裁文書の添付ファイル追加 |
| POST /workflow/imported-documents/attachments | インポート用の添付ファイル追加 |