cybozu.com共通APIドキュメント

User APIで使用するデータ構造

目次

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