アプリのプロセス管理の設定を取得します。
URI
URIは、運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。
運用環境の設定を取得する場合
https://(サブドメイン名).cybozu.com/k/v1/app/status.json
ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/app/status.json
動作テスト環境の設定を取得する場合
https://(サブドメイン名).cybozu.com/k/v1/preview/app/status.json
ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/status.json
HTTPメソッド
GET
必要なアクセス権
運用環境の設定を取得する場合、次のいずれかの権限が必要です。
- アプリのレコード閲覧権限
- アプリのレコード追加権限
動作テスト環境の設定を取得する場合
- アプリ管理権限
※2020年4月版からAPIトークンを利用してAPIを実行できます。
リクエストパラメータ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
app | 数値又は文字列 | 必須 | アプリのIDを指定します。 |
lang | 文字列 | アプリ名やアプリの説明に「言語ごとの名称」を設定している場合に、取得する名称の言語を指定します。
|
リクエストの例
送信するリクエストは、パラメータの送信方法によって異なります。パラメータパラメータ「app」と「lang」を指定したリクエストの例は、次のとおりです。
URLにパラメータを含める場合
GET /k/v1/app/status.json?app=1&lang=ja HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
リクエストボディにパラメーターを含める場合
ヘッダ
GET /k/v1/app/status.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
ボディ
レスポンスパラメータ
パラメータ名 | 値の種類 | 説明 |
---|---|---|
enable | 真偽値 | プロセス管理が有効かどうかの設定です。
|
states | オブジェクト | ステータスの情報を表すオブジェクトです。プロセス管理を一度も設定していないアプリの場合はnullを返します。 |
states.(ステータス名).name | 文字列 | ステータス名です。 |
states.(ステータス名).index | 文字列 | ステータスの順番(0から始まる昇順)です。 |
states.(ステータス名).assignee | オブジェクト | ステータスの作業者を表すオブジェクトです。 |
states.(ステータス名).assignee.type | 文字列 |
ステータスの作業者のタイプです。
|
states.(ステータス名).assignee.entities | 配列 | ステータスの作業者の情報を表す配列です。順番は画面と同じになります。 |
states.(ステータス名).assignee.entities[].entity | オブジェクト | ステータスの作業者のユーザー情報を表すオブジェクトです。削除済みや無効なユーザー、組織、グループが指定されている場合、および削除済みのカスタマイズ項目が指定されている場合はレスポンスに含めません。 |
states.(ステータス名).assignee.entities[].entity.type | 文字列 | ステータスの作業者の指定形式です。
|
states.(ステータス名).assignee.entities[].entity.code |
文字列
|
ステータスの作業者のコードです。entity.typeが次の項目の場合は、それぞれに示す値が返ります。
|
states.(ステータス名).assignee.entities[].includeSubs | 真偽値 | 設定を下位組織に継承するかどうかを指定します。
entity.typeがORGANIZATIONかFIELD_ENTITYで組織選択フィールドが指定されている場合のみ、trueとなります。 |
actions | 配列 | アクションの情報を示す配列です。順番は画面と同じになります。プロセス管理を一度も設定していないアプリの場合はnullを返します。 |
actions[].name | 文字列 | アクションの名前です。 |
actions[].from | 文字列 | アクション実行前のステータス名です。 |
actions[].to | 文字列 | アクション実行後のステータス名です。 |
actions[].filterCond | 文字列 | アクションの実行条件です。 |
revision | 文字列 | アプリの設定のリビジョン番号です。 |
レスポンスの例
JavaScriptサンプル
XMLHttpRequest
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。