cybozu.com 通用 API 文件

使用者 API 使用的數據結構

information

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

目錄

使用者 API 使用的數據結構

連結已複製

ID 型

連結已複製

用作實體ID的類型。
取值範圍為 1 到 Long.MAX 。

User 型

連結已複製

鑰匙 型 內容
id ID 型 使用者ID
code 字串 登入名稱
ctime 字串 建立時間
返回 ISO-8601 日期和時間。
mtime 字串 更新時間
返回 ISO-8601 日期和時間。
valid 布爾值 它是可用使用者嗎？
name 字串 顯示名稱
surName 字串 姓
givenName 字串 名字
surNameReading 字串 拼音（姓）
givenNameReading 字串 拼音（名）
localName 字串 其他語言下的顯示名稱
localNameLocale 字串 要在以其他語言顯示名稱中使用的語言
timezone 字串 時區 (External link) ID
locale 字串 地區
description 字串 備註
phone 字串 電話號碼
mobilePhone 字串 手機號碼
extensionNumber 字串 外延
email 字串 電子郵件地址
callto 字串 SkypeID
URL 字串 URL
employeeNumber 字串 員工編號
birthDate 字串 生日
格式為"YYYY-MM-DD"的日期字串。
如果未設置，則為 null。
joinDate 字串 到職日
格式為"YYYY-MM-DD"的日期字串。
如果未設置，則為 null。
primaryOrganization 數值 優先組織
組織ID。
如果尚未設置組織，則為 null。
sortOrder 數值 顯示優先度
customItemValues 陣列（ 類型CustomItemValue） 自訂物料物料代碼和值
樣本
 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

{
  "birthDate": "2011-05-01",
  "callto": "",
  "code": "a",
  "ctime": "2013-07-22T08:12:18Z",
  "customItemValues": [
    {
      "code": "item1",
      "value": "aitem1"
    },
    {
      "code": "secret",
      "value": "aitem2"
    }
  ],
  "description": "",
  "email": "",
  "employeeNumber": "",
  "extensionNumber": "",
  "givenName": "",
  "givenNameReading": "",
  "id": "1",
  "joinDate": "2013-01-01",
  "localName": "",
  "localNameLocale": "ja",
  "locale": "",
  "mobilePhone": "",
  "mtime": "2013-07-22T09:00:45Z",
  "name": "a",
  "phone": "",
  "primaryOrganization": null,
  "sortOrder": 2147483647,
  "surName": "a",
  "surNameReading": "",
  "timezone": "Asia/Tokyo",
  "url": "",
  "valid": true
}

組織類型

連結已複製

鑰匙 型 內容
id ID 型 組織 ID
code 字串 組織代碼
name 字串 組織名稱
localName 字串 其他語言下的顯示名稱
localNameLocale 字串 要在以其他語言顯示名稱中使用的語言
parentCode 字串 上級組織代碼
如果父級是 root，則返回"null"。
description 字串 備註
樣本
1
2
3
4
5
6
7
8
9

{
  "id": 4,
  "code": "DEV_ba27fP",
  "name": "DEV",
  "localName": "研發部",
  "localNameLocale": "ja",
  "parentCode": null,
  "descriptioon": "不錯的起點"
}

標題類型

連結已複製

鑰匙 型 內容
id ID 型 作業ID
code 字串 職務代碼
name 字串 職務名稱
description 字串 備註
樣本
1
2
3
4
5
6

{
  "id": 2,
  "code": "開發者_OLJ9P0",
  "name": "開發者",
  "descriptioon": "工程師"
}

組類型

連結已複製

鑰匙 型 內容
id ID 型 組ID
code 字串 群組代碼
name 字串 群組名稱
description 字串 備註
樣本
1
2
3
4
5
6

{
  "id": 4,
  "code": "SALES01",
  "name": "東京營業部",
  "description": ""
}

OrganizationTitle 類型

連結已複製

鑰匙 型 內容
organization Organization 型 組織資訊
title Title 型 職務資訊
如果未設置，則返回 null。
樣本
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "organization": {
    "id": 4,
    "code": "DEV_ba27fP",
    "name": "DEV",
    "localName": "研發部",
    "localNameLocale": "ja",
    "parentCode": null,
    "descriptioon": "不錯的起點"
  },
  "title": {
    "id": 2,
    "code": "開發者_OLJ9P0",
    "name": "開發者",
    "descriptioon": "工程師"
  }
}

UserTitle 型

連結已複製

鑰匙 型 內容
user User 型 用戶資訊
title Title 型 職務資訊
如果未設置，則返回 null。
樣本
 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
41
42
43
44
45
46

{
  "user": {
    "birthDate": "2011-05-01",
    "callto": "",
    "code": "a",
    "ctime": "2013-07-22T08:12:18Z",
    "customItemValues": [
      {
        "code": "item1",
        "value": "aitem1"
      },
      {
        "code": "secret",
        "value": "aitem2"
      }
    ],
    "description": "",
    "email": "",
    "employeeNumber": "",
    "extensionNumber": "",
    "givenName": "",
    "givenNameReading": "",
    "id": "1",
    "joinDate": "2013-01-01",
    "localName": "",
    "localNameLocale": "ja",
    "locale": "",
    "mobilePhone": "",
    "mtime": "2013-07-22T09:00:45Z",
    "name": "a",
    "phone": "",
    "primaryOrganization": null,
    "sortOrder": 2147483647,
    "surName": "a",
    "surNameReading": "",
    "timezone": "Asia/Tokyo",
    "url": "",
    "valid": true
  },
  "title": {
    "id": 2,
    "code": "開發者_OLJ9P0",
    "name": "開發者",
    "descriptioon": "工程師"
  }
}

CustomItemValue 型

連結已複製

設置為"私有"的自定義項只能由 cybozu.com Common 管理員檢索。

鑰匙 型 內容
code 字串 法典
value 字串 價值
樣本
1
2
3
4

{
  "code": "item",
  "value": "item value"
}