申請データの全件取得(クエリで条件を指定)
申請データを全件取得できます。
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
必要なアクセス権
cybozu.com 共通管理者権限、またはワークフローのアプリケーション管理者権限
使用可能なガルーンのバージョン
-
クラウド版 Garoon
- パッケージ版 Garoon バージョン 5.0.0以降
リクエストパラメータ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
limit | 数値 |
省略可 |
取得する申請データの制限数を指定します。 要求パラメータで指定された条件に一致する申請データががさらにある場合でも、申請データ数は指定した値より少なくなる可能性があります。 デフォルト値 :100 |
offset | 数値 | 省略可 |
取得する申請データの先頭からスキップする数を指定します。 デフォルト値 :0 |
fields |
文字列 |
省略可 |
取得するプロパティを指定します。 requestオブジェクトのプロパティのうち、 「availableOperations」「folders」を除くプロパティを指定できます。 デフォルト値 :指定できるすべてのプロパティ |
orderBy |
文字列 |
省略可 |
ソート条件は、プロパティ名とソート順で指定します。
プロパティ名と並べ替え順の間に半角スペースをいれてください。 デフォルト値 :createdAt asc |
rangeStartApprovedAt |
文字列 | 省略可 |
最終承認日時(取得期間の開始日時)をRFC3339形式で指定します。 例:
"rangeEndApprovedAt"が指定されている場合、"rangeEndApprovedAt"より前の値を指定する必要があります。 デフォルト値 :全期間 |
rangeEndApprovedAt |
文字列 | 省略可 |
最終承認日時(取得期間の終了日時)をRFC3339形式で指定します。 デフォルト値 :全期間 |
form | 文字列 | 省略可 |
申請フォームIDを指定します。 デフォルト値 :全申請フォーム |
status | 文字列 | 省略可 |
ステータスを指定します。
誤ったステータスが指定された場合、正しいステータスの条件のみ返します。 デフォルト値 :全ステータス |
リクエストの例
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 オブジェクトの配列です。
|
hasNext | 真偽値 |
次の申請データがある場合は true を返します。 |
JavaScript サンプル
XMLHttpRequest
申請データに添付されたファイルの取得
申請データに添付されたファイルを取得できます。
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以降
必要なアクセス権
cybozu.com 共通管理者権限、またはワークフローのアプリケーション管理者権限
リクエストパラメータ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
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エンコードした値 |
JavaScript サンプル
XMLHttpRequest
制限事項
共通仕様の制限事項 をご確認ください。
applicantのproxy(代理申請者)情報は、REST APIの「申請データの取得(GET)」のレスポンスで取得できますか?
こちらのマニュアル(https://jp.cybozu.help/g/ja/user/application/workflow/proxy_applicant )を元に申請の代理提出を行いましたが、「申請データの取得(GET)」のレスポンスには、proxy配下の情報が返ってこないようです。取得できるタイミング(例えば、ワークフローが完了した場合のみ)が限定されていたり、何か考慮すべき点(出力をONにする設定項目があるなど)がございましたらご教示いただけますでしょうか。
こちらのAPIで取得した申請の申請ID、ファイル添付項目のファイルIDの値は、SOAP APIで取得した申請の各IDと同じ値となりますか。