cybozu.com 共通 API 文件

獲取組織

information

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

目錄

獲取組織

連結已複製

獲取組織資訊。
一次最多可以獲取 100 個組織。

有關導出CSV檔的API的更多資訊，請參閱以下頁面。
匯出組織資訊

URL

連結已複製

https://sample.cybozu.com/v1/organizations.json

HTTP 方法

連結已複製

GET

所需存取權限

連結已複製

無

請求

連結已複製

參數
參數名稱 類型 必須 說明
ids 陣列 可省略 組織ID清單
codes 是相互排斥的。
如果同時省略ids 和codes，則最多可獲得100個組織資訊。
codes 陣列 可省略 組織代碼的清單
ids 是相互排斥的。
如果同時省略ids 和codes，則最多可獲得100個組織資訊。
size 數值 可省略 擬收購的組織數量
您可以指定 1 到 100。如果省略，則設置為100。
offset 數值 可省略 要從要獲取的組織開頭跳過的數位
您可以指定一個從 0 到無窮大的數位。
如果省略，則設置為0。
示例請求
URL

https://sample.cybozu.com/v1/organizations.json?ids[0]=Sales01&ids[1]=Sales02

標頭
1
2
3

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

有關請求頭的更多資訊，請參閱以下頁面。
User API通用規範

回應

連結已複製

屬性
屬性名稱 類型 說明
organizations 陣列 組織資訊清單
詳情請參閱以下頁面。
Organization型
排序順序organizations[].id 為升序。
示例回應
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "organizations": [
    {
      "id": "1",
      "code": "Sales01",
      "name": "國內銷售部",
      "localName": "Domestic Sales Department",
      "localNameLocale": "en",
      "parentCode": "Sales00",
      "description": "國內銷售部"
    },
    {
      "id": "2",
      "code": "Sales02",
      "name": "海外銷售部",
      "localName": "International Sales Department",
      "localNameLocale": "en",
      "parentCode": "Sales00",
      "description": "海外銷售部"
    }
  ]
}

示例代碼

連結已複製

使用 curl 的請求
1
2

curl -X GET 'https://sample.cybozu.com/v1/organizations.json?codes%5B0%5D=Sales01&codes%5B1%5D=Sales02' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='