GET/workflow/users/{userId}/documents/search

指定したメンバーの決裁文書を検索する。
検索期間 (startTime 〜 endTime) は 13ヶ月未満である必要がある。
検索対象 : タイトル、本文、添付ファイルの内容。

Authorization

oauth2

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

Scope

workflow
workflow.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/workflow/users/{userId}/documents/search

Path Parameters

ParameterTypeDescription
userId string 

ユーザー ID


required 

Query Parameters

ParameterTypeDescription
query string 

検索語

  • 大文字と小文字は区別しない。
  • URL エンコードして指定する。

required
minLength : 1
maxLength : 100
example : 出張 
startTime string 

検索の開始日時 (形式: YYYY-MM-DDThh:mm:ssTZD)

  • 申請日時 (createdTime) を基準に検索する。
  • 「+」は 「%2B」にエンコードする。

required
example : 2026-01-01T00:00:00%2B09:00 
endTime string 

検索の終了日時 (形式: YYYY-MM-DDThh:mm:ssTZD)

  • 申請日時 (createdTime) を基準に検索する。
  • 「+」は 「%2B」にエンコードする。

required
example : 2026-12-31T23:59:59%2B09:00 
documentFormId string 

申請フォーマット ID


example : 16d11974-7351-4cc9-9eec-52322ff286ee 
status string 

文書ステータス

  • IN-PROGRESS: 進行中
  • APPROVED: 完了 (承認)
  • REJECTED: 却下
  • CANCELED: 引き戻し
 
orderBy string 

並べ替え項目とソート順をスペース (%20) で区切って指定する。

  • 並べ替え項目: createdTime
  • ソート順: asc(昇順), desc(降順)
  • 指定しない場合には、既定で createdTime desc でソートされる。

example : createdTime%20desc 
count integer 

取得数


default : 20
minimum : 1
maximum : 40
example : 20
format : int32 
cursor string 

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
documents array (Document) 

検索結果文書リスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

Document

PropertyTypeDescription
domainId integer 

ドメイン ID


required 
approvalDocumentId integer 

決裁文書 ID


required 
documentFormId string 

申請フォーマット ID


required 
categoryId integer 

カテゴリー ID


required 
documentNumber string 

文書番号

 
title string 

タイトル

 
status string 

ステータス

  • IN-PROGRESS: 進行中
  • APPROVED: 完了
  • REJECTED: 却下
  • CANCELED: 引き戻し

required 
userId string 

申請者 ID

 
userName string 

申請者名

 
orgUnitId string 

申請者の組織 ID

 
orgUnitName string 

申請者の組織名

 
createdTime string 

申請日時（形式:YYYY-MM-DDThh:mm:ssTZD）


required 
completedTime string 

完了日時（形式:YYYY-MM-DDThh:mm:ssTZD）

 
visible boolean 

文書の公開可否

 
viewUrl string 

文書の参照 URL

 
approvalLines array (ApprovalLine) 

決裁ライン情報

 
shareType string 

共有範囲

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

共有範囲情報

 
opinionCount integer 

コメントの数

 
attachmentCount integer 

添付ファイルの数

 
relatedDocumentCount integer 

参考文書の数

 
recipientCount integer 

このPropertyは利用されていません。

 
recipients object 

このPropertyは利用されていません。


nullable : true 
documentBody object 

決裁文書の作成と読み取り を参照する。

 

ApprovalLine

PropertyTypeDescription
sequence integer 

決裁ラインの順序

 
type string 

決裁ラインの決裁タイプ

  • APPROVAL: 承認
  • REFERENCE: 自動承認
  • AGREEMENT: 合意
  • PARALLEL_APPROVAL: 並列承認
  • PARALLEL_AGREEMENT: 並列合意
 
status string 

決裁処理状態

  • UPCOMING: 予定
  • PENDING: 保留
  • APPROVED: 承認
  • REJECTED: 却下
  • DELEGATED_MANAGER: 管理者による委任
  • DELEGATED_USER: 承認者による委任
  • DELEGATED_AUTO: 自動的な委任
 
userId string 

決裁者 ID

 
userName string 

決裁者名

 
orgUnitId string 

決裁者の組織 ID

 
orgUnitName string 

決裁者の組織名

 
approvalTime string 

決裁日時（形式:YYYY-MM-DDThh:mm:ssTZD）

 

Shared

PropertyTypeDescription
type string 

共有先

  • DOMAIN: すべてのメンバー (ドメイン)
  • USER: メンバー
  • ORGUNIT: 組織
  • ORGUNIT_INCLUDE_SUBS: 下位を含む組織

required 
id string 

共有先の ID

  • 共有範囲が「すべてのメンバー」の場合には、ドメイン ID
  • 共有範囲が「メンバー」の場合、ユーザー ID
  • 共有範囲が「組織」または「下位を含む組織」の場合には、組織 ID

required 
name string 

共有先の名前

  • 共有範囲が「すべてのメンバー」の場合には、会社名
  • 共有範囲が「メンバー」の場合、ユーザー名
  • 共有範囲が「組織」または「下位を含む組織」の場合には、組織名
 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "documents": [3    {4      "domainId": 10000001,5      "approvalDocumentId": 10001,6      "documentFormId": "16d11974-7351-4cc9-9eec-52322ff286ee",7      "categoryId": 10,8      "documentNumber": "2026-CUS001-00001",9      "title": "出張申請",10      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",11      "userName": "ワークス太郎",12      "status": "APPROVED",13      "createdTime": "2026-03-05T09:00:00+09:00",14      "completedTime": "2026-03-05T10:30:00+09:00",15      "visible": true16    }17  ],18  "responseMetaData": {19    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="20  }21}

HTTP 400

Bad Request

HTTP 403

Forbidden