アプリのプロセス管理の設定の取得 – cybozu developer network

アプリのプロセス管理の設定を取得します。

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	文字列		アプリ名やアプリの説明に「言語ごとの名称」を設定している場合に、取得する名称の言語を指定します。日本語の名称を取得する場合：ja 英語の名称を取得する場合：en 中国語の名称を取得する場合：zh ログインユーザーの言語設定で取得する場合：user* *ログインユーザーの言語設定が「Webブラウザの設定にしたがう」の場合、 Accept-Languageヘッダがあればその設定が反映され、 Accept-Languageヘッダがなければcybozu.com共通管理の「ローカライズの設定」で設定された言語で取得されます。デフォルトの名称を取得する場合：default 省略すると、デフォルトの名称が取得されます。

リクエストの例

送信するリクエストは、パラメータの送信方法によって異なります。パラメータパラメータ「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	真偽値	プロセス管理が有効かどうかの設定です。 true：プロセス管理が有効 false：プロセス管理が無効
states	オブジェクト	ステータスの情報を表すオブジェクトです。プロセス管理を一度も設定していないアプリの場合はnullを返します。
states.(ステータス名).name	文字列	ステータス名です。
states.(ステータス名).index	文字列	ステータスの順番（0から始まる昇順）です。
states.(ステータス名).assignee	オブジェクト	ステータスの作業者を表すオブジェクトです。
states.(ステータス名).assignee.type	文字列	ステータスの作業者のタイプです。 ONE : 次のユーザーから作業者を選択 ALL : 次のユーザー全員 ANY : 次のユーザーのうち一人先頭のステータス（indexが最も小さいステータス）の場合は常にONEを返します。
states.(ステータス名).assignee.entities	配列	ステータスの作業者の情報を表す配列です。順番は画面と同じになります。
states.(ステータス名).assignee.entities[].entity	オブジェクト	ステータスの作業者のユーザー情報を表すオブジェクトです。削除済みや無効なユーザー、組織、グループが指定されている場合、および削除済みのカスタマイズ項目が指定されている場合はレスポンスに含めません。
states.(ステータス名).assignee.entities[].entity.type	文字列	ステータスの作業者の指定形式です。 USER : ユーザー GROUP : グループ ORGANIZATION : 組織 FIELD_ENTITY : ユーザーフィールド CREATOR : アプリ作成者 CUSTOM_FIELD : .com共通管理のカスタマイズ項目
states.(ステータス名).assignee.entities[].entity.code	文字列	ステータスの作業者のコードです。entity.typeが次の項目の場合は、それぞれに示す値が返ります。 FIELD_ENTITY : フィールドコード CREATOR : null CUSTOM_FIELD : カスタマイズ項目コードゲストユーザーを指定する場合、ログイン名の前に「guest/」を付けます。
states.(ステータス名).assignee.entities[].includeSubs	真偽値	設定を下位組織に継承するかどうかを指定します。継承する場合：true 継承しない場合：false entity.typeがORGANIZATIONかFIELD_ENTITYで組織選択フィールドが指定されている場合のみ、trueとなります。
actions	配列	アクションの情報を示す配列です。順番は画面と同じになります。プロセス管理を一度も設定していないアプリの場合はnullを返します。
actions[].name	文字列	アクションの名前です。
actions[].from	文字列	アクション実行前のステータス名です。
actions[].to	文字列	アクション実行後のステータス名です。
actions[].filterCond	文字列	アクションの実行条件です。
revision	文字列	アプリの設定のリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト

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

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

5MP2 2022年02月23日 11:38

お世話になります。

JavaScriptサンプル
kintone REST APIリクエストを送信する API を使ったリクエスト
のサンプルコードですが、

var body = {
  'app': kintone.app.getId();
};

の部分は、

var body = {
  'app': kintone.app.getId()
};

kintone.app.getId() の後の ';' は無くても良いかと思います。

cybozu Development team 2022年02月24日 05:55

Yoshida 様

お世話になっております。cybozu developer network 運営チームです。

ご指摘のとおりでしたので、記事を修正しました。
ご連絡いただきありがとうございました。

今後ともよろしくお願いいたします。

サインインしてコメントを残してください。