服务端API



获取标签列表

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/oa/tags/list
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": 200,
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "uuid": "CD798A77-0EAD-4606-B72E-8EE5465E626E",
                "title": "系统人才夹",
                "input_type": "checkbox",
                "required": 1,
                "status": 1,
                "source": 1,
                "create_time": 1609957197000,
                "update_time": 1609957197000,
                "company_id": "SOKE3wL1Rt1678436255",
                "tags_value": [
                    {
                        "uuid": "6B0B1BAA-208C-45CB-ABE6-4EFCBF229975",
                        "title": "储备人才",
                        "target_id": "CD798A77-0EAD-4606-B72E-8EE5465E626E",
                        "status": 1,
                        "is_default": 0,
                        "create_time": 1609957197000,
                        "update_time": 1609957197000
                    },
                    {
                        "uuid": "8CF30C0E-6842-47FD-8A9E-21151358EEF9",
                        "title": "高潜人才",
                        "target_id": "CD798A77-0EAD-4606-B72E-8EE5465E626E",
                        "status": 1,
                        "is_default": 0,
                        "create_time": 1609957197000,
                        "update_time": 1609957197000
                    }
                ]
            }
        ],
        "has_more": 0
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的标签列表
uuid String 标签ID,同company_id组织内唯一,最大长度36字符
title String 标签中文名,最大长度50字符,
input_type String 字段类型:
radio 单选
checkbox 多选
input 文本框
required Int 是否必填:
0 非必填
1 必填
status Int 标签状态:
0 未启用
1 已启用
-1 已删除
source Int 标签来源:
1 企业自建
2 超管内置
3 人事系统
create_time Int 创建时间,Unix时间戳,单位毫秒
update_time Int 更新时间,Unix时间戳,单位毫秒
company_id String 所属企业ID,最大长度64字符
tags_value Array 标签值列表
->uuid String 标签值ID,同company_id组织内唯一,最大长度36字符
->title String 标签值名称,最大长度50字符
->target_id String 标签值所属标签ID
->status Int 标签状态:
0 未启用
1 已启用
-1 已删除
->is_default Int 是否默认值:
0 否
1 是
->create_time Int 创建时间,Unix时间戳,单位毫秒
->update_time Int 更新时间,Unix时间戳,单位毫秒
has_more Int 是否还有数据没返回:
1 还有
0 没有



创建标签

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/tags/create
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
title String 是 标签中文名,同组织内唯一,长度限制为1~50个字符
input_type String 是 字段类型:
radio 单选
checkbox 多选
input 文本框
required Int 否 是否必填,默认0:
0 非必填
1 必填
weight Int 否 排序值(正序)


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "tags_id":"376053D7-73B6-44FE-8EF2-4A27E5CC81C6" //创建成功的标签ID
    }
}



更新标签

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/tags/update
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
tags_id String 是 要更新的标签ID
title String 否 标签中文名,同组织内唯一,长度限制为1~50个字符
input_type String 否 字段类型:
radio 单选
checkbox 多选
input 文本框
注意:单选、多选可以互改,单选、多选不能改为文本框,文本框不能改为单选、多选
required Int 否 是否必填,默认0:
0 非必填
1 必填
weight Int 否 排序值(正序)


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}



删除标签

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/tags/delete
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
tags_id String 是 要删除的标签ID


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}



创建标签值

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/tagsValue/create
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
tags_id String 是 标签ID
title String 是 标签值,同标签内唯一,长度限制为1~50个字符
is_default Int 否 是否是默认值,默认0:
0 非默认值
1 默认值
注意:同一标签只能设置一个默认值,若设置多个会将最后一次设置的值为默认值
weight Int 否 排序值(正序)


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "tags_value_id":"576053D7-73B6-44FE-8EF2-4A27E5CC81C7" //创建成功的标签值ID
    }
}



更新标签值

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/tagsValue/update
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
tags_id String 是 要更新的标签ID
tags_value_id String 是 要更新的标签值ID
title String 否 标签值,同标签内唯一,长度限制为1~50个字符
is_default Int 否 是否是默认值,默认0:
0 非默认值
1 默认值
注意:只能设置一个默认值
weight Int 否 排序值(正序)


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}



删除标签值

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/tagsValue/delete
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
tags_id String 是 要删除的标签ID
tags_value_id String 是 要删除的标签值ID


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}



更新用户标签

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/tagsUser/update
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_user_id String 是 要更新的UserID
user_tags String 是 用户标签设置,格式为JSON字符串{"${tags_id}":["${tags_value_id1}","${tags_value_id2}"]}
举例:{"2C41FCBD-8CF2-422A-945A-CC75D7AC70A4":["03AE5FCB-4BDB-49FC-A94F-3DC09B759DDE","98BB1C57-DFA3-4771-ABCD-AFCA13AD18B5"]}


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}