POST/workflow/imported-documents

外部サービスからのインポート ドキュメントを登録する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

workflow

HTTP Request

POSThttps://www.worksapis.com/v1.0/workflow/imported-documents

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required 

Request Body

PropertyTypeDescription
documentNumber string 

文書番号


required
minLength : 1
maxLength : 100 
documentFormName string 

申請フォーマット名


required
minLength : 1
maxLength : 100 
title string 

タイトル


required
minLength : 1
maxLength : 200 
userName string 

作成者


required
minLength : 1
maxLength : 200 
createdDate string 

申請日（形式：YYYY-MM-DD）


required 
completedDate string 

完了日（形式：YYYY-MM-DD）


required 
pdfFileId string 

本文 PDF ファイル ID

 
fileIds array (string) 

添付ファイル情報

 
approvalLines array (ImportedDocumentApprovalLine) 

決裁ライン情報

 
shareType string 

共有範囲

  • PART_SHARE: メンバー指定
  • ALL_SHARE: すべてのメンバー
 
sharedMembers array (ImportedDocumentSharedMembers) 

決裁文書 ID

 

ImportedDocumentApprovalLine

PropertyTypeDescription
sequence integer 

決裁ラインの順序。 決裁順序は 1 から順に入力する。


required 
userName string 

決裁者


required
minLength : 1
maxLength : 200 
approvalTime string 

処理日時（形式：YYYY-MM-DDThh:mm:ssTZD）


required 

ImportedDocumentSharedMembers

PropertyTypeDescription
type string 

共有者タイプ

  • DOMAIN: 会社
  • USER: メンバー

required 
id string 

共有者ID

  • 共有者タイプが会社 (DOMAIN) の場合、ドメイン ID
  • 共有者タイプがメンバー (USER) の場合は userId

required 

Request Example

example

1{2  "documentNumber": "2026-TEST-00001",3  "documentFormName": "休暇申請書",4  "title": "2024.07.01 休暇申請",5  "userName": "ワークスたろう",6  "createdDate": "2026-07-01",7  "completedDate": "2026-07-10",8  "pdfFileId": "65d21127-1234-1234-1234-5daa2748de79",9  "fileIds": [10    "f7cb1554-1234-1234-1234-47295330b0a3"11  ],12  "approvalLines": [13    {14      "sequence": 1,15      "userName": "Susan Nielsen",16      "approvalTime": "2026-07-10T15:10:05+09:00"17    }18  ],19  "shareType": "PART_SHARE",20  "sharedMembers": [21    {22      "type": "USER",23      "id": "56006105-1234-1234-1234-27c0bde4258c"24    }25  ]26}

Response

HTTP 201

OK

PropertyTypeDescription
domainId integer 

ドメインID


required 
approvalDocumentId integer 

決裁文書ID


required 
documentNumber string 

文書番号


required 
documentFormName string 

申請フォーマット名


required 
title string 

タイトル


required 
userName string 

作成者


required 
createdDate string 

作成日（形式：YYYY-MM-DD）


required 
completedDate string 

完了日（形式：YYYY-MM-DD）

 
pdfFileId string 

本文 PDF ファイル ID

 
fileIds array (string) 

添付ファイル情報

 
approvalLines array (ImportedDocumentApprovalLine) 

決裁ライン情報

 
shareType string 

共有者タイプ

 
sharedMembers array (ImportedDocumentShared) 

共有者

 

ImportedDocumentApprovalLine

PropertyTypeDescription
sequence integer 

決裁ラインの順序。 決裁順序は 1 から順に入力する。


required 
userName string 

決裁者


required
minLength : 1
maxLength : 200 
approvalTime string 

処理日時（形式：YYYY-MM-DDThh:mm:ssTZD）


required 

ImportedDocumentShared

PropertyTypeDescription
type string 

共有者タイプ

  • DOMAIN: 会社
  • USER: メンバー

required 
id string 

共有者ID

  • 共有者タイプが会社 (DOMAIN) の場合、ドメイン ID
  • 共有者タイプがメンバー (USER) の場合は userId

required 
name string 

共有者名

  • 共有者タイプが会社 (DOMAIN) の場合、会社名
  • 共有者タイプがメンバー (USER) の場合はユーザー名
 

Response Example

example

1{2  "domainId": 10000001,3  "approvalDocumentId": 10001,4  "documentNumber": "2026-TEST-00001",5  "documentFormName": "休暇申請書",6  "title": "2024.07.01 休暇申請",7  "userName": "ワークス太郎",8  "createdDate": "2026-07-01",9  "completedDate": "2026-07-10",10  "pdfFileId": "65d21127-1234-1234-1234-5daa2748de79",11  "fileIds": [12    "kf7cb1554-1234-1234-1234-47295330b0a3"13  ],14  "approvalLines": [15    {16      "sequence": 1,17      "userName": "Susan Nielsen",18      "approvalTime": "2026-07-10T15:10:05+09:00"19    }20  ],21  "shareType": "PART_SHARE",22  "sharedMembers": [23    {24      "type": "USER",25      "id": "56006105-1234-1234-1234-27c0bde4258c",26      "name": "ワークス花子"27    }28  ]29}

HTTP 403

Forbidden