kintone APIドキュメント

アプリのアクション設定を取得する

目次

アプリのアクション設定を取得する

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

アプリのアクション設定を取得します。
同名のアクションがアプリに存在する場合は、このAPIを実行するとエラーが発生します。

URL

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

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

運用環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/app/actions.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/actions.json
動作テスト環境の設定を取得する
通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/actions.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/actions.json

HTTPメソッド

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

GET

必要なアクセス権

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

  • アプリ管理権限

リクエスト

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

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

https://sample.cybozu.com/k/v1/app/actions.json?app=8&lang=ja

ヘッダー
1
2
3

{
  "X-Cybozu-API-Token": "API_TOKEN"
}

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

リクエストの例（リクエストボディにパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/app/actions.json

ヘッダー
1
2
3
4

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

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

ボディ
1
2
3
4

{
  "app": 8,
  "lang": "ja"
}

レスポンス

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

プロパティ
プロパティ名 型 説明
actions オブジェクト アクションの設定
actions.アクション名 オブジェクト 各アクションの設定
langを指定した場合でも、デフォルトの言語で設定されたアクション名が返ります。
actions.アクション名.name 文字列 アクション名
langを指定した場合は、「言語ごとの名称」で設定された値が返ります。
actions.アクション名.id 文字列 アクションID
actions.アクション名.index 文字列 アクションの並び順
0から始まります。
actions.アクション名.destApp オブジェクト コピー先のアプリの情報
コピー先のアプリにレコード閲覧権限、レコード追加権限、アプリ管理権限のいずれもない場合は「null」が返ります。
actions.アクション名.destApp.app 文字列 コピー先のアプリのアプリID
actions.アクション名.destApp.code 文字列 コピー先のアプリのアプリコード
アプリコードを設定していない場合は、空文字が返ります。
actions.アクション名.mappings 配列 フィールドの関連付けの一覧
関連付けが設定されていない場合は、空配列が返ります。
コピー先のアプリにレコード閲覧権限、レコード追加権限、アプリ管理権限のいずれもない場合は「null」が返ります。
actions.アクション名.mappings[].srcType 文字列 コピー元の種類
  • FIELD：フィールド
  • RECORD_URL：レコードのURL
actions.アクション名.mappings[].srcField 文字列 コピー元に指定されたフィールドのフィールドコード
mappings[].srcTypeが「FIELD」の場合のみ返ります。
actions.アクション名.mappings[].destField 文字列 コピー先に指定されたフィールドのフィールドコード
actions.アクション名.entities 配列 アクションの利用者の一覧
actions.アクション名.entities[].type 文字列 アクションの利用者の種類
  • USER：ユーザー
  • GROUP：グループ
  • ORGANIZATION：組織
actions.アクション名.entities[].code 文字列 アクションの利用者のコード
entities[].codeの値によって異なります。
  • 「USER」の場合：ユーザーのログイン名
  • 「GROUP」の場合：グループコード
  • 「ORGANIZATION」の場合：組織コード
ゲストユーザーの場合、ログイン名の頭に「guest/」が付きます。
revision 文字列 アプリの設定のリビジョン番号
レスポンスの例
 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

{
  "actions": {
    "アクションA": {
      "name": "アクションA",
      "id": "1",
      "index": "0",
      "destApp": {
        "app": "2",
        "code": "APPB"
      },
      "mappings": [
        {
          "srcType": "FIELD",
          "srcField": "数値_0",
          "destField": "数値_0"
        },
        {
          "srcType": "RECORD_URL",
          "destField": "リンク_0"
        }
      ],
      "entities": [
        {
          "type": "USER",
          "code": "userA"
        }
      ]
    }
  },
  "revision": "2"
}

サンプルコード

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

curlを使ったリクエスト
1
2
3
4
5
6
7

curl -X GET 'https://sample.cybozu.com/k/v1/app/actions.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": "8",
    "lang": "ja"
  }'
kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する 

1
2
3
4
5
6

const body = {
  app: kintone.app.getId(),
  lang: 'ja'
};

await kintone.api(kintone.api.url('/k/v1/app/actions.json', true), 'GET', body);