User API所使用的数据结构

aki发表于:2019年10月29日 10:38:41更新于:2022年05月11日 10:25:06

Index

ID类型

作为实体ID所使用的类型。
值范围为1〜Long.MAX的数值。

user类型

键名类型内容
idID类型用户ID
code字符串登录名称
ctimeISO-8601日期与时间字符串创建时间
mtimeISO-8601日期与时间字符串更新时间
valid布尔值是否有效用户
name字符串用户的显示名称
surName字符串
givenName字符串
surNameReading字符串拼音(姓)
givenNameReading字符串拼音(名)
localName字符串其他语言下的显示名称
localNameLocale字符串“其他语言下的显示名称”中使用的语言
timezone字符串

时区(ID)
※时区列表请参考帮助

locale字符串语言
description字符串说明
phone字符串电话号码
mobilePhone字符串手机
extensionNumber字符串分机号
email字符串邮箱地址
callto字符串Skype用户名
url字符串URL
employeeNumber字符串员工编号
birthDate

“YYYY-MM-DD”格式的日期字符串或null

生日
joinDate

“YYYY-MM-DD”格式的日期字符串或nulll

入职日期
primaryOrganization数值 或 null优先组织的ID
sortOrder数值显示优先度
customItemValuescustomItemValue配列自定义项目的项目编号和值的对照表

organization类型

键名类型内容
idID类型组织ID
code字符串组织代码
name字符串组织名称
localName字符串其他语言下的显示名称
localNameLocale字符串“其他语言下的显示名称”中使用的语言
parentCode字符串上级组织代码(上级为root时为null)
description字符串说明

title类型

键名类型内容
idID类型职务ID
code字符串职务代码
name字符串职务名称
description字符串说明

group类型

键名类型内容
idID类型组ID
code字符串组代码
name字符串组名称
description字符串说明

organizationTitle类型

键名类型内容
organizationorganization类型组织信息
titletitle类型or null职务信息、"no title"时为null

范例

{    
    "organization":{    
        "id":1,    
        "code":"DEV_ba27fP",    
        "name":"DEV",    
        "localName":"开发部",    
        "localNameLocale":"zh",    
        "parentCode":null,    
        "descriptioon":"程序开发部"    
    },    
    "title":{    
        "id":2,    
        "code":"开发人员_OLJ9P0",    
        "name":"开发人员",    
        "descriptioon":"程序员"    
    }    
}
{    
    "organization":{    
        "id":1,    
        "code":"DEV_ba27fP",    
        "name":"DEV",    
        "localName":"开发总部",    
        "localNameLocale":"DEV",    
        "parentCode":null,    
        "descriptioon":"程序开发部总部"    
    },    
        "title": null    
}

userTitle类型

键名类型内容
useruser类型用户信息
titletitle类型or null职务信息("no title"时为null)

范例

{    
    "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":"zh",    
        "locale":"",    
        "mobilePhone":"",    
        "mtime":"2013-07-22T09:00:45Z",    
        "name":"a",    
        "phone":"",    
        "primaryOrganization":null,    
        "sortOrder":2147483647,    
        "surName":"a",    
        "surNameReading":"",    
        "timezone":"Asia/Shanghai",    
        "url":"",    
        "valid":true    
    },    
    "title":{    
        "id":2,    
        "code":"开发人员_OLJ9P0",    
        "name":"开发人员",    
        "descriptioon":"程序员"    
    }    
}
{    
    "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":"zh",    
        "locale":"",    
        "mobilePhone":"",    
        "mtime":"2013-07-22T09:00:45Z",    
        "name":"a",    
        "phone":"",    
        "primaryOrganization":null,    
        "sortOrder":2147483647,    
        "surName":"a",    
        "surNameReading":"",    
        "timezone":"Asia/Shanghai",    
        "url":"",    
        "valid":true    
    },    
    "title": null    
}

customItemValue类型

键名
内容
code字符串代码
value字符串

范例

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

注意事项

只有 cybozu.cn 的共通管理员才能获取设置为非公开的自定义项目。


    注意:贴代码时请注意格式并使用"代码语言",与本文无关的问题请至“讨论社区”提问。