kintone APIドキュメント

プロセス管理の設定を取得する

目次

caution
警告

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

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

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

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

プロセス管理の設定を取得する

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

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

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

URL

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

URLは運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。

運用環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/app/status.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/status.json
動作テスト環境の設定を取得する場合
通常のアプリ
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メソッド

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

GET

必要なアクセス権

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

運用環境の設定を取得する場合

次のいずれかの権限が必要です。

  • アプリのレコード閲覧権限
  • アプリのレコード追加権限
動作テスト環境の設定を取得する場合
  • アプリ管理権限

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
app 数値または文字列 必須 アプリID
lang 文字列 省略可 取得する名称の言語
カテゴリー名に 言語ごとの名称 (External link) を設定している場合に指定します。
  • ja：日本語
  • en：英語
  • zh：中国語
  • user：APIを実行するユーザーが表示言語に設定している言語
    言語設定が「Webブラウザーの設定に従う」の場合、「Accept-Language」ヘッダーの有無によって、取得する言語が変わります。
    • ヘッダーあり：「Accept-Language」ヘッダーで指定した言語
    • ヘッダーなし：cybozu.com共通管理の ロケールの設定 (External link) で設定した言語
  • default：デフォルト
省略すると、デフォルトの名称を取得します。

レスポンス

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

プロセス管理の設定を取得するAPI のレスポンスに以下の項目が追加されます。

プロパティ
プロパティ名 型 説明
actions[].type 文字列 アクションの種類
  • GENERAL: actions[].executableUserに指定したユーザーが実行できるアクション
  • ASSIGNEE: アクション実行前のステータスで作業者に指定されたユーザーのみが実行できるアクション
actions[].executableUser オブジェクト アクションの実行可能ユーザー
actions[].typeがGENERALの場合のみレスポンスに含まれます。
actions[].executableUser.entities 配列 アクションの実行可能ユーザーの情報
空配列の場合は、レコード閲覧可能なユーザー全員が実行可能なアクションとして扱われます。
actions[].executableUser.entities[].entity オブジェクト アクションの実行可能ユーザーの情報
削除済み、または無効なユーザー、組織およびグループはレスポンスに含まれません。
actions[].executableUser.entities[].entity.type 文字列 アクションの実行可能ユーザーの指定形式
  • USER: ユーザー
  • GROUP: グループ
  • ORGANIZATION: 組織
  • FIELD_ENTITY: ユーザフィールド
actions[].executableUser.entities[].entity.code 文字列 アクションの実行可能ユーザーのコード
entity.typeの値によって異なります。
  • 「USER」の場合：ログイン名
  • 「GROUP」の場合：グループコード
  • 「ORGANIZATION」の場合：組織コード
  • 「FIELD_ENTITY」の場合：「フォームのフィールドを追加」で指定したフィールドのフィールドコード
ゲストユーザーの場合、ログイン名の前に「guest/」が付きます。
actions[].executableUser.entities[].includeSubs 真偽値 設定を下位組織に継承するかどうか
  • true：継承する
  • false：継承しない
entity.typeが「ORGANIZATION」か、「FIELD_ENTITY」で組織選択フィールドが指定されている場合のみ、「true」が返ります。
レスポンスの例
 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

{
    "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"
}