獲取應用的動作設置

連結已複製

獲取應用的動作設置。

HTTP 方法	GET
URL	https://sample.cybozu.com/k/v1/app/actions.json
URL（訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/app/actions.json
URL（操作測試環境）	https://sample.cybozu.com/k/v1/preview/app/actions.json
URL（測試環境中的訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/actions.json
認證	密碼驗證 , API令牌認證 , 會話認證 , OAuth認證
Content-Type	application/json（透過查詢字串指定查詢時不需指定此項）

請求參數

連結已複製

參數名稱	類型	必須	說明
app	數值或字串	必須	應用ID
lang	字串	可省略	要選取的名稱的語言如果已為操作設置了多語言對應，請指定。多語言對應 `ja`：日文 `en`：英語 `zh`：中文 `user`：執行 API 的使用者設置為顯示語言的語言如果語言設置為「與網路瀏覽器設定相同」，則要獲取的語言取決於是否存在「Accept-Language」標頭。帶標題：帶標頭：「Accept-Language」標頭中指定的語言無標頭：在cybozu.com通用管理的地區設定中設置的語言地區設定 `default`：預設如果省略，則獲取預設名稱。

應答屬性

連結已複製

屬性名稱	類型	說明
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`：欄位記錄的連結
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/」為前綴。
actions.`動作名稱`.filterCond	字串	應用程式動作的執行可否條件的查詢字串空字串時，等同指定“所有記錄”。如果指定了已刪除的使用者/組織/組，則會報錯。有關查詢的詳細資訊，請參閱以下連結：如何編寫查詢
revision	字串	應用設置的修訂號

所需存取權限

連結已複製

應用程式管理權限

範例

連結已複製

請求範例

請求URL（在URL中包含參數的情況）

1

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

請求標頭（在URL中包含參數的情況）

1
2
3


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

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規格

請求URL（在請求主體中包含參數的情況）

1

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

範例回應

 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


{
  "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"
        }
      ],
      "filterCond": "選擇用戶欄位 in (\"user1\")"
    }
  },
  "revision": "2"
}

範例程式碼

使用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);

使用curl傳送請求

根據您的環境，curl的格式可能會有所不同。
有關說明，請參閱以下頁面。
使用curl命令執行kintone REST API/3.執行API

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

補充

連結已複製

如果您的應用中存在同名動作，則運行此 API 將導致錯誤。
無論是否在「禁用新功能」中禁用「設定應用程式動作的使用條件」，調用以下 API 時返回應答中都會包含本API的資訊。
獲取kintone REST API的Schema資訊

kintone API

kintone API文件

獲取應用的動作設置

目錄

請求參數

應答屬性

所需存取權限

範例

補充