アプリのプロセス管理の設定の変更

フォローする

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

URI

https://(サブドメイン名).cybozu.com/k/v1/preview/app/status.json

ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/status.json

HTTPメソッド

PUT

アクセス権

  • アプリの管理権限が必要です。
  • このAPIの実行には、APIトークンは使用できません。

リクエスト

パラメータ

リクエストのパラメータの一覧です。指定を省略したパラメータの設定項目は、更新されません。

パラメータ名 指定する値 必須 説明
app 数値または文字列 必須 アプリのIDを指定します。
enable 真偽値または文字列  

プロセス管理の有効/無効を指定します。

  • true:プロセス管理が有効
  • false:プロセス管理が無効
states オブジェクト   ステータスの情報を表すオブジェクトです。
states.(ステータス名) オブジェクト   各ステータスの設定を表すオブジェクトです。「(ステータス名)」には更新前のステータス名を指定します。
存在しないステータスを「(ステータス名)」に指定した場合は、新規のステータスとして追加します。
存在するステータスを「(ステータス名)」に指定しなかった場合は、そのステータスは削除されます。
states.(ステータス名).name 文字列 条件必須 ステータスの名前を、64文字以内で指定します。
新しいステータスを追加する場合は必須となり、「states.(ステータス名)」のキー名と同じ値を指定します。
states.(ステータス名).index 数値または文字列 条件必須 ステータスの順番(0から始まる昇順)を指定します。
states.(ステータス名).assignee オブジェクト   ステータスの作業者を表すオブジェクトです。
states.(ステータス名).assignee.type 文字列 条件必須

ステータスの作業者の指定形式を指定します。

  • ONE : 次のユーザーから作業者を選択
  • ALL  : 次のユーザー全員
  • ANY : 次のユーザーのうち一人
「assignee」パラメータを指定する場合、このパラメータは必須です。
states.(ステータス名).assignee.entities  配列  条件必須

ステータスの作業者の情報を各entityで指定します。
「assignee」パラメータを指定する場合、このパラメータは必須です。

states.(ステータス名).assignee.entities[].entity オブジェクト 条件必須 ステータスの作業者のユーザー情報を表すオブジェクトです。
「entities」内で必須です。
states.(ステータス名).assignee.entities[].entity.type 文字列 条件必須

ステータスの作業者の種類を指定します。

  • USER: ユーザー
  • GROUP: グループ
  • ORGANIZATION: 組織
  • FIELD_ENTITY: ユーザーフィールド
  • CREATOR: アプリ作成者
  • CUSTOM_FIELD: .com共通管理のカスタマイズ項目
各「entity」で必須です。ゲストスペースのアプリでは、組織を指定することはできません。
states.(ステータス名).assignee.entities[].entity.code 文字列 条件必須

ステータスの作業者のコードを指定します。

「entity.type」に「FIELD_ENTITY」を指定した場合は、次のフィールドのフィールドコードを指定できます。

  • 作成者
  • 更新者
  • ユーザー選択
  • 組織選択
  • グループ選択
「entity.type」に「CUSTOM_FIELD」を指定した場合は、カスタマイズ項目コードを指定します。
「entity.type」が「CREATOR」の場合のみ指定不要で、それ以外の場合は必須です。ゲストユーザーを指定する場合、ログイン名の前に「guest/」を付けます。
states.(ステータス名).assignee.entities[].includeSubs 真偽値または文字列  

作業者に下位組織を含めるかを指定します。

  • true: 含める
  • false: 含めない(初期値)
「entity.type」に「ORGANIZATION」か、「FIELD_ENTITY」でかつ「組織選択フィールド」を指定した場合のみ有効です。それ以外の場合は設定を無視します。
actions 配列   アクションの情報を表す配列です。
actions[].name 文字列 条件必須

アクション名を64文字以内で指定します。
「actions」パラメータを指定する場合、このパラメータは必須です。

actions[].from 文字列  条件必須

アクション実行前のステータス名を指定します。
「actions」パラメータを指定する場合、このパラメータは必須です。
ステータス名を変更した場合は、変更後の名前を指定します。

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

XMLHttpRequest

 

 

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

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk