選取單個應用的資訊

kintone API

選取單個應用的資訊

連結已複製

獲取單個應用的資訊。

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

請求參數

連結已複製

可以在 URL 或請求正文中指定請求參數。

參數名稱	類型	必須	說明
id	數值或字串	必須	應用程式ID

回應屬性

連結已複製

屬性名稱	類型	說明
appId	字串	應用ID
code	字串	應用程式代碼如果未設置，則返回空字串。
name	字串	應用程式名稱如果為每種語言設置應用程式名稱，則會根據運行API的使用者設置的語言返回應用程式名稱。
description	字串	應用程序的說明如果未設置，則返回空字串。如果為每種語言設置了描述，則將根據運行 API 的使用者設置的語言返回描述。
spaceId	字串	空間ID 不屬於空間的應用程式將返回`null`。
threadId	字串	主題ID 不屬於空間的應用程式將返回`null`。
createdAt	字串	建立時間
creator	物件	建立人資訊
creator.code	字串	建立人的代碼對於已停用/已刪除/非該服務的使用者，將返回一個空字串。
creator.name	字串	建立人的姓名對於已停用/已刪除/非該服務的使用者，將返回一個空字串。
modifiedAt	字串	更新時間
modifier	物件	更新人資訊
modifier.code	字串	更新人的代碼對於已停用/已刪除/非該服務的使用者，將返回一個空字串。
modifier.name	字串	更新人的姓名對於已停用/已刪除/非該服務的使用者，將返回一個空字串。

所需存取權限

連結已複製

您必須具有以下權限之一：

應用程式中記錄的查看權限
應用程式的記錄添加權限

範例

連結已複製

請求範例

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

1

https\://sample.cybozu.com/k/v1/app.json?id=1

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

1
2
3


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

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

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

1

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

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

1
2
3
4


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

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

請求主體

1
2
3


{
  "id": "1"
}

範例回應

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "appId": "1",
  "code": "",
  "name": "案件管理",
  "description": "該應用程式不僅可以記錄每個專案收到訂單的概率和數量，還可以記錄活動的歷史記錄。 ",
  "spaceId": "2",
  "threadId": "3",
  "createdAt": "2021-10-01T05:14:05.000Z",
  "creator": {
    "code": "tanaka",
    "name": "田中太郎"
  },
  "modifiedAt": "2021-10-02T05:22:05.000Z",
  "modifier": {
    "code": "tanaka",
    "name": "田中太郎"
  }
}

範例程式碼

使用kintone.api()傳送請求

有關kintone.api()的說明，請參閱以下頁面。
傳送kintone REST API請求

1
2
3
4
5


const body = {
  id: kintone.app.getId()
};

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

使用curl傳送請求

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

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/app.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1
  }'

補充

連結已複製

您只能獲取已公開的應用程式。

kintone API

kintone API文件

選取單個應用的資訊

目錄

請求參數

回應屬性

所需存取權限

範例

補充