kintone API文件

獲取多個應用的資訊

information

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

目錄

獲取多個應用的資訊

連結已複製

獲取有關滿足指定條件的應用的資訊。
您一次最多可以獲取 100 個應用。

URL

連結已複製

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

HTTP 方法

連結已複製

GET

所需存取權限

連結已複製

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

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

請求

連結已複製

參數
參數名稱 類型 必須 說明
ids 陣列（數值或字串） 可省略 應用ID
您可以指定一個介於 1 和 9,223,372,036,854,775,807 之間的整數。
您最多可以指定 100 個應用程式 ID。
如果指定「null」或空陣列，則視為省略值。
codes 陣列（字串） 可省略 應用程式代碼
指定 1 到 64 個字元。
需要完全匹配，並且區分大小寫。
您最多可以指定 100 個應用代碼。
如果指定「null」或空陣列，則視為省略值。
name 字串 可省略 應用名稱或其中的一部分
最多指定 64 個字元。
可部分匹配，不區分大小寫。
如果已將應用名稱設置為多種語言，則搜索將包括標準應用名稱和運行API的使用者所設置的顯示語言的對應應用名稱。
如果指定「null」或空陣列，則視為省略值。
spaceIds 陣列（數值或字串） 可省略 空間ID
您可以指定一個介於 1 和 9,223,372,036,854,775,807 之間的整數。
您最多可以指定 100 個空間 ID。
如果指定「null」或空陣列，則視為省略值。
offset 數值或字串 可省略 從要獲取的應用清單的開頭起要跳過的應用數
如果省略，則設置為0。
limit 數值或字串 可省略 要獲取的數量
您可以指定一個介於 1 和 100 之間的整數。
如果省略，則設置為100。
範例請求（如果要在網址中包含參數 ）
URL

https://sample.cybozu.com/k/v1/apps.json?name=TEST&codes[0]=FOO&codes[1]=BAR

標頭
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

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

https://sample.cybozu.com/k/v1/apps.json

標頭
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

內文
1
2
3
4

{
  "codes": ["FOO", "BAR"],
  "name": "TEST"
}

回應

連結已複製

屬性
屬性名稱 類型 說明
apps 陣列 應用程序資訊清單
apps[].appId 字串 應用ID
apps[].code 字串 應用程式代碼
如果未設置，則返回空字串。
apps[].name 字串 應用程序名稱
如果為每種語言設置應用程序名稱，則會根據運行 API 的使用者設置的語言返回應用程序名稱。
apps[].description 字串 應用程序的說明
如果未設置，則返回空字串。
如果為每種語言設置了描述，則將根據運行 API 的使用者設置的語言返回描述。
apps[].spaceId 字串 空間ID
不屬於空間的應用將返回「null」。
apps[].threadId 字串 主題ID
不屬於空間的應用將返回「null」。
apps[].createdAt 字串 建立時間
apps[].creator 物件 建立人資訊
apps[].creator.code 字串 建立人的代碼
對於已停用/已刪除/非該服務的使用者，將返回一個空字串。
apps[].creator.name 字串 建立人的姓名
對於已停用/已刪除/非該服務的使用者，將返回一個空字串。
apps[].modifiedAt 字串 更新時間
apps[].modifier 物件 更新人資訊
apps[].modifier.code 字串 更新人的代碼
對於已停用/已刪除/非該服務的使用者，將返回一個空字串。
apps[].modifier.name 字串 更新人的姓名
對於已停用/已刪除/非該服務的使用者，將返回一個空字串。
應答範例
 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
33
34
35
36
37
38
39
40

{
  "apps": [
    {
      "appId": "1",
      "code": "FOO",
      "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": "田中太郎"
      }
    },
    {
      "appId": "2",
      "code": "BAR",
      "name": "TEST",
      "description": "",
      "spaceId": null,
      "threadId": null,
      "createdAt": "2021-10-10T13:25:05.000Z",
      "creator": {
        "code": "tanaka",
        "name": "田中太郎"
      },
      "modifiedAt": "2021-10-10T13:25:05.000Z",
      "modifier": {
        "code": "tanaka",
        "name": "田中太郎"
      }
    }
  ]
}

示例代碼

連結已複製

使用 curl 的請求
 1
 2
 3
 4
 5
 6
 7
 8
 9
10

curl -X GET 'https://sample.cybozu.com/k/v1/apps.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "codes": [
      "FOO",
      "BAR"
    ],
    "name": "TEST"
  }'
使用發送 kintone REST API 請求的 API發送請求
1
2
3
4
5
6
7
8
9

const body = {
  codes: [
    'FOO',
    'BAR'
  ],
  name: 'TEST'
};

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