cybozu.com 共通 API 文件

User API 使用的數據結構

information

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

目錄

User API 使用的數據結構

連結已複製

ID型

連結已複製

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

User型

連結已複製

鑰匙 類型 內容
id ID型 使用者ID
code 字串 登入名稱
ctime 字串 建立時間
返回 ISO-8601 日期和時間。
mtime 字串 更新時間
返回 ISO-8601 日期和時間。
valid 布爾值 它是可用使用者
name 字串 顯示名稱
surName 字串 姓
如果未設置，將返回 null。
givenName 字串 名字
如果未設置，將返回 null。
surNameReading 字串 拼音（姓）
如果未設置，將返回 null。
givenNameReading 字串 拼音（名）
如果未設置，將返回 null。
localName 字串 其他語言下的顯示名稱
如果未設置，將返回 null。
localNameLocale 字串 要在以其他語言顯示名稱中使用的語言
如果未設置，將返回 null。
timezone 字串 時區ID
時區 (External link)
locale 字串 地區
如果未設置，將返回 null。
description 字串 備註
如果未設置，將返回 null。
phone 字串 電話號碼
如果未設置，將返回 null。
mobilePhone 字串 手機號碼
如果未設置，將返回 null。
extensionNumber 字串 分機號碼
如果未設置，將返回 null。
email 字串 電子郵件地址
如果未設置，將返回 null。
callto 字串 SkypeID
如果未設置，將返回 null。
url 字串 URL
如果未設置，將返回 null。
employeeNumber 字串 員工編號
如果未設置，將返回 null。
birthDate 字串 生日
格式為「YYYY-MM-DD」的日期字串。
如果未設置，將返回 null。
joinDate 字串 到職日
格式為「YYYY-MM-DD」的日期字串。
如果未設置，將返回 null。
primaryOrganization 數值 優先組織
組織ID。
如果尚未設置組織，將返回 null。
sortOrder 數值 顯示優先度
如果未設置，將返回 null。
customItemValues 陣列（CustomItemValue型）
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": null,
  "code": "a",
  "ctime": "2013-07-22T08:12:18Z",
  "customItemValues": [
    {
      "code": "item1",
      "value": "aitem1"
    },
    {
      "code": "secret",
      "value": "aitem2"
    }
  ],
  "description": null,
  "email": null,
  "employeeNumber": null,
  "extensionNumber": null,
  "givenName": null,
  "givenNameReading": null,
  "id": "1",
  "joinDate": "2013-01-01",
  "localName": null,
  "localNameLocale": "ja",
  "locale": null,
  "mobilePhone": null,
  "mtime": "2013-07-22T09:00:45Z",
  "name": "a",
  "phone": null,
  "primaryOrganization": null,
  "sortOrder": 2147483647,
  "surName": "a",
  "surNameReading": null,
  "timezone": "Asia/Tokyo",
  "url": null,
  "valid": true
}

Organization型

連結已複製

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

{
  "id": 1,
  "code": "DEV_ba27fP",
  "name": "DEV",
  "localName": "開発部",
  "localNameLocale": "ja",
  "parentCode": null,
  "description": "不錯的起點"
}

Title型

連結已複製

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

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

Group型

連結已複製

鑰匙 類型 內容
id ID型 組ID
code 字串 群組代碼
name 字串 群組名稱
description 字串 備註
如果未設置，將返回 null。
樣本
1
2
3
4
5
6

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

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": 1,
    "code": "DEV_ba27fP",
    "name": "DEV",
    "localName": "開発部",
    "localNameLocale": "ja",
    "parentCode": null,
    "description": "不錯的起點"
  },
  "title": {
    "id": 2,
    "code": "開發者_OLJ9P0",
    "name": "開發者",
    "description": "工程師"
  }
}

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": "開發者",
    "description": "工程師"
  }
}

CustomItemValue型

連結已複製

如果將自定義項設為私有，則只有您和您的 cybozu.com 公共管理員才能獲取項的值。

鑰匙 類型 內容
code 字串 代碼
value 字串 價值
樣本
1
2
3
4

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