獲取應用的動作設置

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

獲取應用的動作設置

獲取應用的動作設置。
如果您的應用中存在同名動作,則運行此 API 將導致錯誤。

URL

用於檢索生產環境設置的 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 的使用者設置為顯示語言的語言
    如果語言設置為“與網路瀏覽器的設定相同”,則要檢索的語言取決於是否存在“Accept-Language”標頭。
    • 帶標頭:“Accept-Language”標頭中指定的語言
    • 無標頭:在通用管理的” 區域設置 (External link) ”中設置 cybozu.com 語言
  • default:預設
如果省略,則獲取預設名稱。
範例請求(如果在網址中包含參數 )
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 物件 目標應用程式
actions.動作名稱.destApp.app 字串 目標應用的應用ID
actions.動作名稱.destApp.code 字串 目標應用的應用代碼
如果尚未設置應用程式代碼,則返回空字串。
actions.動作名稱.mappings 陣列 相關欄位清單
如果未設置關聯,則返回空陣列。
actions.動作名稱.mappings[].srcType 字串 源類型
  • FIELD:欄位
  • RECORD_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 REST API請求的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);