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 | 文字列 |
タイムゾーン
|
locale | 文字列 | ロケール |
description | 文字列 | メモ |
phone | 文字列 | 電話番号 |
mobilePhone | 文字列 | 携帯電話番号 |
extensionNumber | 文字列 | 内線番号 |
文字列 | メールアドレス | |
callto | 文字列 | SkypeID |
url | 文字列 | URL |
employeeNumber | 文字列 | 従業員番号 |
birthDate | 文字列 | 誕生日 「YYYY-MM-DD」形式の日付文字列です。 未設定の場合は null です。 |
joinDate | 文字列 | 入社日 「YYYY-MM-DD」形式の日付文字列です。 未設定の場合は null です。 |
primaryOrganization | 数値 | 優先する組織 組織 ID です。 組織を設定していない場合は null です。 |
sortOrder | 数値 | 表示優先度 |
customItemValues | 配列( CustomItemValue 型) | カスタマイズ項目の項目コードと値 |
サンプル
|
|
Organization 型
キー | 型 | 内容 |
---|---|---|
id | ID 型 | 組織 ID |
code | 文字列 | 組織コード |
name | 文字列 | 組織名 |
localName | 文字列 | 別言語での表示名 |
localNameLocale | 文字列 | 「別言語での表示名」で使用する言語 |
parentCode | 文字列 | 親組織のコード 親が root の場合には 「null」が返ります。 |
description | 文字列 | メモ |
サンプル
|
|
Title 型
キー | 型 | 内容 |
---|---|---|
id | ID 型 | 役職 ID |
code | 文字列 | 役職コード |
name | 文字列 | 役職名 |
description | 文字列 | メモ |
サンプル
|
|
Group 型
キー | 型 | 内容 |
---|---|---|
id | ID 型 | グループ ID |
code | 文字列 | グループコード |
name | 文字列 | グループ名 |
description | 文字列 | メモ |
サンプル
|
|
OrganizationTitle 型
キー | 型 | 内容 |
---|---|---|
organization | Organization 型 | 組織情報 |
title | Title 型 | 役職情報 未設定の場合には、 null が返ります。 |
サンプル
|
|
UserTitle 型
キー | 型 | 内容 |
---|---|---|
user | User 型 | ユーザ情報 |
title | Title 型 | 役職情報 未設定の場合には、null が返ります。 |
サンプル
|
|
CustomItemValue 型
非公開に設定されたカスタマイズ項目は、cybozu.com 共通管理者のみ取得できます。
キー | 型 | 内容 |
---|---|---|
code | 文字列 | コード |
value | 文字列 | 値 |
サンプル
|
|