Garoon REST API は、スケジュールやワークフローなどの Garoon のデータを操作できる API です。
プロトコル
HTTPS
フォーマット
JSON
文字コード
UTF-8
エスケープ文字
\ を使用します。
認証
認証 を確認してください。
リクエスト
URL
クラウド版
https://sample.cybozu.com/g/api/v1/アプリケーション名/リソース
パッケージ版
- Windows 環境
- http://
サーバーの IP アドレスまたはホスト名/scripts/インストール識別子/grn.exe/api/v1/アプリケーション名/リソースヘルプに記載している Windows のディレクトリー構成
でインストールしたときの例です。
インストールするディレクトリーを変更している場合は、パスを読み替えてください。 - Linux 環境
- http://
サーバーの IP アドレスまたはホスト名/cgi-bin/インストール識別子/grn.cgi/api/v1/アプリケーション名/リソースヘルプに記載している Linux のディレクトリー構成
でインストールしたときの例です。
インストールするディレクトリーを変更している場合は、パスを読み替えてください。
リクエストヘッダー
次のリクエストヘッダーを指定します。
Garoon REST API リクエストを送信する API を使って Garoon REST API を実行する場合には、リクエストヘッダーの指定は不要です。
| パラメーター名 | 必須 | 説明 |
|---|---|---|
| Host | 必須 | sample.cybozu.com:443 |
| Content-Type | 省略可 | application/json リクエストボディに JSON 文字列を指定する場合は必須です。 |
| X-Cybozu-Authorization | 条件必須 | 「ログイン名:パスワード」を Base64 エンコードした値 パスワードを使って認証する場合は必須です。 詳細は、 パスワード認証 を参照してください。 |
| X-Requested-With | 条件必須 | XMLHttpRequest または空文字列以外の文字列 セッションで認証する場合は必須です。 |
| Authorization | 条件必須 | 「Basic 」と「Basic認証のユーザー名:Basic認証のパスワード を Base64 エンコードした値」を結合した値Basic 認証 を設定している場合、必須です。詳細は、 Basic 認証を設定している環境 を参照してください。 |
レスポンス
HTTP ステータスコード
リクエストに成功した場合、200 番台のステータスコードが返ります。
リクエストに失敗した場合、200 番台以外のステータスコードとエラー番号が返ります。
エラー番号の詳細は、ヘルプ（
クラウド版
／
パッケージ版
）を参照してください。
| パラメーター名 | 型 | 説明 |
|---|---|---|
| errorCode | 文字列 | エラーの種類を表すコード |
| message | 文字列 | エラーメッセージ API を実行したユーザーの 表示言語の設定 ごとに内容が異なります。 |
| cause | 文字列 | エラーの原因 |
レスポンスヘッダー
| ヘッダー名 | 内容 |
|---|---|
| X-ConcurrencyLimit-Limit | 同時接続数の上限値 必ず 100 が返ります。 |
| X-ConcurrencyLimit-Running | 現在の同時接続数 |
制限事項
- 同時に実行できる REST API の数には制限があります。初期値は 100 です。
- 添付ファイルをアップロードする場合、アップロードできるファイルサイズの上限は、Base64 エンコードした後の値で 300MB まです。
Garoon のシステム設定で、ファイルサイズの上限を「無制限」に設定した場合も同様です。 - サービスに関する制限事項は、
サイボウズのクラウドサービス制限事項
を参照してください。