アプリのプロセス管理の設定を変更します。
このAPI は、動作テスト環境のアプリに変更を反映します。
本番環境に変更を反映する場合、このAPI を実行した後に、アプリ設定の運用環境への反映 API を実行してください。
URI
https://(サブドメイン名).cybozu.com/k/v1/preview/app/status.json
ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/status.json
HTTPメソッド
PUT
必要なアクセス権
アプリ管理権限
※2020年4月版からAPIトークンを利用してAPIを実行できます。
リクエストパラメータ
リクエストのパラメータの一覧です。指定を省略したパラメータの設定項目は、更新されません。
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
app | 数値または文字列 | 必須 | アプリのIDを指定します。 |
enable | 真偽値または文字列 |
プロセス管理の有効/無効を指定します。
|
|
states | オブジェクト | ステータスの情報を表すオブジェクトです。 | |
states.(ステータス名) | オブジェクト |
各ステータスの設定を表すオブジェクトです。「(ステータス名)」には更新前のステータス名を指定します。
|
|
states.(ステータス名).name | 文字列 | 条件必須 | ステータスの名前を、64文字以内で指定します。 新しいステータスを追加する場合は必須となり、「states.(ステータス名)」のキー名と同じ値を指定します。 |
states.(ステータス名).index | 数値または文字列 | 条件必須 |
ステータスの順番(0から始まる昇順)を指定します。 「(ステータス名)」を指定する場合、必須です。 |
states.(ステータス名).assignee | オブジェクト | ステータスの作業者を表すオブジェクトです。 | |
states.(ステータス名).assignee.type | 文字列 | 条件必須 |
ステータスの作業者の指定形式を指定します。
|
states.(ステータス名).assignee.entities | 配列 | 条件必須 |
ステータスの作業者の情報を各entityで指定します。 |
states.(ステータス名).assignee.entities[].entity | オブジェクト | 条件必須 | ステータスの作業者のユーザー情報を表すオブジェクトです。 「entities」内で必須です。 |
states.(ステータス名).assignee.entities[].entity.type | 文字列 | 条件必須 |
ステータスの作業者の種類を指定します。
|
states.(ステータス名).assignee.entities[].entity.code | 文字列 | 条件必須 |
ステータスの作業者のコードを指定します。 「entity.type」に「FIELD_ENTITY」を指定した場合は、次のフィールドのフィールドコードを指定できます。
「entity.type」に「CUSTOM_FIELD」を指定した場合は、カスタマイズ項目コードを指定します。
「entity.type」が「CREATOR」の場合のみ指定不要で、それ以外の場合は必須です。ゲストユーザーを指定する場合、ログイン名の前に「guest/」を付けます。
|
states.(ステータス名).assignee.entities[].includeSubs | 真偽値または文字列 |
作業者に下位組織を含めるかを指定します。
「entity.type」に「ORGANIZATION」か、「FIELD_ENTITY」でかつ「組織選択フィールド」を指定した場合のみ有効です。それ以外の場合は設定を無視します。
|
|
actions | 配列 | アクションの情報を表す配列です。 | |
actions[].name | 文字列 | 条件必須 |
アクション名を64文字以内で指定します。 |
actions[].from | 文字列 | 条件必須 |
アクション実行前のステータス名を指定します。 |
actions[].to | 文字列 | 条件必須 | アクション実行後のステータス名を指定します。 「actions」パラメータを指定する場合、このパラメータは必須です。 ステータス名を変更した場合は、変更後の名前を指定します。 |
actions[].filterCond | 文字列 |
アクションの実行条件をクエリ形式で指定します。クエリ形式については、次のページを参照してください。
|
|
revision | 数値または文字列 | アプリの設定を変更する前のリビジョン番号を指定します。指定したリビジョンが最新ではない場合、リクエストはエラーになります。指定を省略、または「-1」を指定すると、リビジョンはチェックされません。 |
リクエストの例
ヘッダ
PUT /k/v1/preview/app/status.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
ボディ
レスポンスパラメータ
パラメータ名 | 値の種類 | 説明 |
---|---|---|
revision | 文字列 | アプリの設定を変更したあとのリビジョン番号です。 |
レスポンスの例
JavaScriptサンプル
kintone REST APIリクエストを送信する API を使ったリクエスト
XMLHttpRequest を使ったリクエスト
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。