kintone API文件

選取單個應用的資訊

information

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

目錄

選取單個應用的資訊

連結已複製

獲取單個應用的資訊。

URL

連結已複製

常規應用程式
https://sample.cybozu.com/k/v1/app.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app.json

HTTP 方法

連結已複製

GET

所需存取權限

連結已複製

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

  • 應用程式中記錄的查看權限
  • 應用程式中新增記錄的權限

請求

連結已複製

參數

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

參數名稱 類型 必須 說明
id 數值或字串 必須 應用ID
範例請求（如果要在網址中包含參數 ）
URL

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

標頭
1
2
3

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

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

要求範例（如果要在要求內文中包含參數）
URL

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

回應

連結已複製

屬性
屬性名稱 類型 說明
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 字串 更新人的姓名
對於已停用/已刪除/非該服務的使用者，將返回一個空字串。
應答範例
 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": "田中太郎"
  }
}

示例代碼

連結已複製

使用 curl 的請求
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()，請參閱以下頁面。
發送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);