POST/workflow/users/{userId}/documents/attachments

決裁文書作成に利用する添付ファイルを追加する。

API を利用したコンテンツのアップロード方法は ファイルアップロード / ダウンロード を確認してください。

Authorization

oauth2

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

Scope

workflow

HTTP Request

POSThttps://www.worksapis.com/v1.0/workflow/users/{userId}/documents/attachments

Path Parameters

ParameterTypeDescription
userId string 

ユーザー ID またはログイン ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
documentFormId string 

申請フォーマット ID


required
minLength : 1
maxLength : 100 
componentId string 

申請フォーマット内のコンポーネント ID


required
minLength : 1
maxLength : 100 
fileName string 

添付ファイル名


required
minLength : 1
maxLength : 200 
fileSize integer 

添付ファイルサイズ（単位：バイト）


required
minimum : 1
maximum : 2147483648 

Request Example

example

1{2  "documentFormId": "7679350f-1234-1234-1234-03d446661405",3  "componentId": "96b02530-1234-1234-1234-3055c74e705e",4  "fileName": "ExampleFile.pdf",5  "fileSize": 102400006}

Response

HTTP 200

OK

PropertyTypeDescription
documentFormId string 

申請フォーマット ID


required 
componentId string 

申請フォーマット内のコンポーネント ID


required 
fileId string 

ファイル ID


required 
uploadUrl string 

添付ファイル アップロード URL


required
format : uri 

Response Example

example

1{2  "documentFormId": "7679350f-1234-1234-1234-03d446661405",3  "componentId": "96b02530-1234-1234-1234-3055c74e705e",4  "fileId": "1560c57b-1234-1234-1234-a92b758a0f83",5  "uploadUrl": "https://apis-storage.worksmobile.com/workplace/tmp/1560c57b-1234-1234-1234-a92b758a0f83"6}