カテゴリー内の他の記事

申請データの取得(GET)

フォローする

Index

申請データの全件取得(クエリで条件を指定)

申請データを全件取得できます。

HTTP メソッド

GET

URI

クラウド版

https://(サブドメイン名).cybozu.com/g/api/v1/workflow/admin/requests

パッケージ版(Windows環境)

http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/workflow/admin/requests

パッケージ版(Linux環境)

http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/workflow/admin/requests

必要なアクセス権

ワークフローの運用管理者権限

使用可能なガルーンのバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon バージョン 5.0.0以降

リクエストパラメータ

パラメータ名 指定する値 必須 説明
limit 数値

省略可

取得する申請データの制限数を指定します。

要求パラメータで指定された条件に一致する申請データががさらにある場合でも、申請データ数は指定した値より少なくなる可能性があります。
使用できる値は1〜1000です。

デフォルト値 :100

offset 数値 省略可

取得する申請データの先頭からスキップする数を指定します。
指定できる数値は0から無制限です。

デフォルト値 :0

fields

文字列

省略可

取得するプロパティを指定します。
カンマで区切って複数の値を指定できます。
例: fields=id, number

requestオブジェクトのプロパティのうち、

「availableOperations」「folders」を除くプロパティを指定できます。

デフォルト値 :指定できるすべてのプロパティ

orderBy

文字列

省略可

ソート条件は、プロパティ名とソート順で指定します。

  • プロパティ名
    - createdAt
  • 並べ替え順
    - asc
    - desc

プロパティ名と並べ替え順の間に半角スペースをいれてください。
例: createdAt desc

デフォルト値 :createdAt asc

rangeStartApprovedAt

文字列 省略可

最終承認日時(取得期間の開始日時)をRFC3339形式で指定します。

例:

  • UTCで指定する場合:2017-10-19T00:10:30Z
  • JSTで指定する場合:2017-10-19T00:19:30+09:00

"rangeEndApprovedAt"が指定されている場合、"rangeEndApprovedAt"より前の値を指定する必要があります。

デフォルト値 :全期間

rangeEndApprovedAt

文字列 省略可

最終承認日時(取得期間の終了日時)をRFC3339形式で指定します。
フォーマットは"rangeEndApprovedAt"と同じです。
"rangeStartApprovedAt"を指定する場合は、"rangeStartApprovedAt"より後の値を指定する必要があります。

デフォルト値 :全期間

form 文字列 省略可

申請フォームIDを指定します。

デフォルト値 :全申請フォーム

status 文字列 省略可

ステータスを指定します。
カンマで区切って複数の値を指定できます。
例: status=APPROVED,COMPLETED

  • 申請後、処理前:UNPROCESSING
  • 承認後、最終承認前:IN_PROGRESS 
  • 却下:REJECTED 
  • 取戻後、申請前:WITHDRAWN
  • 申請者に差戻後、申請前:SENT_BACK
  • 申請者に差戻後、キャンセル:CANCELLED
  • 最終承認後、確認経路あり:APPROVED
  • 最終承認後、確認経路なし:COMPLETED

誤ったステータスが指定された場合、正しいステータスの条件のみ返します。

デフォルト値 :全ステータス

リクエストの例 

GET /g/api/v1/workflow/admin/requests HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Typeヘッダは不要です。

レスポンスの例

処理が成功すると、申請データの内容がJSON形式で返されます。 

プロパティ

プロパティ名 説明
requests[] 配列

request オブジェクトの配列です。
※各フィールドの形式については ワークフローのrequestオブジェクトをご確認ください。

  • 「folder」「availableOperations」プロパティは取得できません。
  • 以下のプロパティは GaroonユーザーIDが取得できます。
    • request.applicant
    • request.applicant.proxy
    • request.steps.step.processors
    • request.steps.step.processors.proxy
hasNext 真偽値

次の申請データがある場合は true を返します。

申請データに添付されたファイルの取得

申請データに添付されたファイルを取得できます。

HTTP メソッド

GET

URI

クラウド版

https://(サブドメイン名).cybozu.com/g/api/v1/workflow/admin/files/{id}

パッケージ版(Windows環境)

http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/workflow/admin/files/{id}

パッケージ版(Linux環境)

http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/workflow/admin/files/{id}

使用可能なガルーンのバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon バージョン 5.0.0以降

必要なアクセス権

ワークフローの運用管理者権限

リクエストパラメータ

パラメータ名 指定する値 必須 説明
id 数値

必須

取得する申請データのファイルIDを指定します。

リクエストの例

GET /g/api/v1/workflow/admin/files/1 HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Typeヘッダは不要です。

レスポンスの例

処理が成功すると、リクエストパラメータで指定された条件で、申請データに添付されたファイルの内容がJSON形式で返されます。

プロパティ

プロパティ名 説明
id 文字列

ファイルID

contentType 文字列 ファイルのコンテンツタイプ
name 文字列 ファイル名
size 文字列 ファイルサイズ(バイト)
content 文字列 ファイルの内容をBASE64エンコードした値

制限事項

共通仕様の制限事項 をご確認ください。

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

Avatar
Yoshiyuki Kuwajima

applicantのproxy(代理申請者)情報は、REST APIの「申請データの取得(GET)」のレスポンスで取得できますか?
こちらのマニュアル(https://jp.cybozu.help/g/ja/user/application/workflow/proxy_applicant )を元に申請の代理提出を行いましたが、「申請データの取得(GET)」のレスポンスには、proxy配下の情報が返ってこないようです。取得できるタイミング(例えば、ワークフローが完了した場合のみ)が限定されていたり、何か考慮すべき点(出力をONにする設定項目があるなど)がございましたらご教示いただけますでしょうか。

 

Yoshiyuki Kuwajimaにより編集されました
ログインしてコメントを残してください。