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

目次

User 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 文字列 タイムゾーンのID
タイムゾーン (External link)
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型)
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
}

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,
  "descriptioon": "開発をする部署"
}

Title型

キー 内容
id ID型 役職ID
code 文字列 役職コード
name 文字列 役職名
description 文字列 メモ
サンプル
1
2
3
4
5
6
{
  "id": 2,
  "code": "開発者_OLJ9P0",
  "name": "開発者",
  "descriptioon": "エンジニア"
}

Group型

キー 内容
id ID型 グループID
code 文字列 グループコード
name 文字列 グループ名
description 文字列 メモ
サンプル
1
2
3
4
5
6
{
  "id": 1,
  "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": 1,
    "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共通管理者のみ取得できます。

キー 内容
code 文字列 コード
value 文字列
サンプル
1
2
3
4
{
  "code": "item",
  "value": "item value"
}