kintone APIドキュメント

プロセス管理の設定を変更する

目次

caution
警告

このページで説明しているAPIは、開発を検討中のAPIです。

アップデートオプション内の「開発中の新機能」から動作をお試しいただけます。
設定方法は、 新機能の有効／無効の切り替え手順 (External link) を参照してください。

API に関するフィードバックを、ユースケースとともに、 kintoneの改善に協力する (External link) フォームへぜひご登録ください。

フィードバックの例
  • APIラボで提供されているAPIを早く本番環境で利用したい
  • こういう用途で使うために、このようなAPIを提供してほしい

プロセス管理の設定を変更する

固定リンクがコピーされました

プロセス管理の設定を変更するAPI で、アクションの種類とアクションの実行可能ユーザーの情報を変更できます。

利用するには開発中の新機能の「プロセス管理の設定で、作業者以外でも実行できるアクションを設定できる機能」を有効にしてください。

このAPIは、動作テスト環境のアプリを変更します。
本番環境に変更を反映する場合、このAPIを実行した後に、アプリ設定を運用環境へ反映するAPIを実行してください。
アプリ設定を運用環境へ反映するAPI

URL

固定リンクがコピーされました

通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/status.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/status.json

HTTPメソッド

固定リンクがコピーされました

PUT

必要なアクセス権

固定リンクがコピーされました

  • アプリ管理権限

リクエスト

固定リンクがコピーされました

プロセス管理の設定を変更するAPI のパラメーターに加えて、以下の項目が変更できます。

パラメーター
パラメーター名 型 必須 説明
actions[].type 文字列 省略可 アクションの種類
  • GENERAL: actions[].executableUserに指定したユーザーが実行できるアクション
  • ASSIGNEE: アクション実行前のステータスで作業者に指定されたユーザーのみが実行できるアクション
省略した場合はactions[].fromに一致するstates.ステータス名.assigneeの設定値によって以下の値が設定されます。
  • 設定されている場合：ASSIGNEE
  • 設定されていない場合：GENERAL
actions[].executableUser オブジェクト 省略可 アクションの実行可能ユーザー
actions[].typeがGENERALの場合に指定します。省略すると、actions[].executableUser.entitiesに空配列が設定されます。空配列の場合は、レコード閲覧可能なユーザー全員が実行可能なアクションとして扱われます。
actions[].typeがASSIGNEEの場合、設定は無視されます。
actions[].executableUser.entities 配列 条件必須 アクションの実行可能ユーザーの情報
executableUserを指定する場合は必須です。
actions[].executableUser.entities[].entity オブジェクト 条件必須 アクションの実行可能ユーザーの情報
entities内で必須です。
actions[].executableUser.entities[].entity.type 文字列 条件必須 アクションの実行可能ユーザーの種類
  • USER：ユーザー
  • GROUP：グループ
  • ORGANIZATION：組織
  • FIELD_ENTITY：「フォームのフィールドを追加」として指定するフィールド

entityを指定する場合は必須です。
ゲストスペースのアプリでは、「ORGANIZATION」は指定できません。
actions[].executableUser.entities[].entity.code 文字列 条件必須 アクションの実行可能ユーザーのコード
entity.typeの値によって異なります。
  • 「USER」の場合：ログイン名
  • 「GROUP」の場合：グループコード
  • 「ORGANIZATION」の場合：組織コード
  • 「FIELD_ENTITY」の場合：次のフィールドのフィールドコードを指定します。
    • 作成者
    • 更新者
    • ユーザー選択
    • 組織選択
    • グループ選択
entityを指定する場合は必須です。
ゲストユーザーを指定する場合、ログイン名の前に「guest/」を付けます。
actions[].executableUser.entities[].includeSubs 真偽値または文字列 省略可 アクションの実行可能ユーザーに下位組織を含めるかどうか
  • true：含める
  • false：含めない
省略すると「false」が設定されます。
entity.typeに「ORGANIZATION」か、「FIELD_ENTITY」で組織選択フィールドを指定した場合のみ指定します。
それ以外の場合に指定すると、設定は無視されます。
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

{
    "app": "5",
    "enable": true,
    "states": {
        "未処理": {
            "name": "未処理",
            "index": "0",
            "assignee": {
                "type": "ONE",
                "entities": [
                ]
            }
        },
        "処理中": {
            "name": "処理中",
            "index": "1",
            "assignee": {
                "type": "ALL",
                "entities": [
                    {
                        "entity": {
                            "type": "USER",
                            "code": "user1"
                        },
                        "includeSubs": false
                    },
                    {
                        "entity": {
                            "type": "FIELD_ENTITY",
                            "code": "creator"
                        },
                        "includeSubs": false
                    },
                    {
                        "entity": {
                            "type": "CUSTOM_FIELD",
                            "code": "上司"
                        },
                        "includeSubs": false
                    }
                ]
            }
        },
        "完了": {
            "name": "完了",
            "index": "2",
            "assignee": {
                "type": "ONE",
                "entities": [
                ]
            }
        }
    },
    "actions": [
        {
            "name": "処理開始",
            "from": "未処理",
            "to": "処理中",
            "filterCond": "レコード番号 = \"1\"",
            "type": "GENERAL",
            "executableUser": {
                 "entities": [
                 ]
            }
        },
        {
            "name": "完了する",
            "from": "処理中",
            "to": "完了",
            "filterCond": "",
            "type": "ASSIGNEE"
        },
        {
            "name": "作業者以外で完了する",
            "from": "処理中",
            "to": "完了",
            "filterCond": "",
            "type": "GENERAL",
            "executableUser": {
                 "entities": [
                      {
                          "entity": {
                              "type": "FIELD_ENTITY",
                              "code": "creator"
                          },
                          "includeSubs": false
                       }
                 ]
            }
        }
    ],
    "revision": "3"
}

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
revision 文字列 アプリの設定を変更したあとのリビジョン番号
レスポンスの例
1
2
3

{
  "revision": "4"
}