Workflow API

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

参考
ワークフロー管理画面のシステム連携メニューに関しては、ヘルプセンターを参照してください。

申請フォーマット カテゴリー管理 {#manage-workflow-category}

申請フォーマットのカテゴリーは以下の API で管理します。

HTTP RequestDescription
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": "一般"     }]}

申請フォーマットの管理 {#read-workflow-document-form}

申請フォーマットは以下の API で管理します。

HTTP RequestDescription
GET /workflow/document-forms申請フォーマットのリスト取得
GET /workflow/document-forms/{documentFormId}申請フォーマットの取得

入力値リストの管理 {#manage-workflow-linkage-codes}

入力値リストは以下の API で管理します。

HTTP RequestDescription
POST /workflow/linkage-codes入力値リストの作成
GET /workflow/linkage-codes入力値リストの一覧取得
GET /workflow/linkage-codes/{linkageCodeId}入力値リストの取得
PATCH /workflow/linkage-codes/{linkageCodeId}入力値リストの部分更新
POST /workflow/linkage-codes/{linkageCodeId}/linkage-code-items入力値の登録
GET /workflow/linkage-codes入力値の一覧の取得
GET /workflow/linkage-codes/{linkageCodeId}/linkage-code-items/{linkageCodeItemId}入力値の取得
PATCH /workflow/linkage-codes/{linkageCodeId}/linkage-code-items/{linkageCodeItemId}入力値の部分更新
PUT /workflow/linkage-codes/{linkageCodeKey}/linkage-code-items入力値の一括更新

決裁文書の管理 {#manage-workflow-document}

決裁文書は以下の API で管理します。

HTTP RequestDescription
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文書のインポート

添付ファイルの管理 {#manage-workflow-attachment}

決裁文書の添付ファイルは以下の API で管理します。

HTTP RequestDescription
POST /workflow/users/{userId}/documents/attachments決裁文書の添付ファイル追加
POST /workflow/imported-documents/attachmentsインポート用の添付ファイル追加