获取高级外勤对象描述接口
POST
https://open.fxiaoke.com/cgi/crm/v2/object/describe
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.fxiaoke.com/cgi/crm/v2/object/describe' \
--header 'Content-Type: application/json' \
--data-raw '{
"corpAccessToken": "${corpAccessToken}",
"corpId": "${corpId}",
"currentOpenUserId": "${currentOpenUserId}",
"includeDetail": true,
"apiName": "CheckinsObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-74f499f86517462b",
"data": {
"describe": {
"icon_index": 0,
"api_name": "CheckinsObj",
"display_name_r": "高级外勤对象",
"fields": {
"lock_rule": {
"describe_api_name": "CheckinsObj",
"is_index": false,
"is_active": true,
"create_time": 1514449174447,
"description": "锁定规则",
"is_unique": false,
"default_value": "default_lock_rule",
"rules": [],
"label": "锁定规则",
"type": "lock_rule",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_rule",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "锁定规则",
"index_name": "s_3",
"help_text": "锁定规则"
},
"circle_ids": {
"describe_api_name": "CheckinsObj",
"is_index": true,
"is_active": true,
"create_time": 1514450542100,
"is_unique": false,
"label": "部门抄送范围",
"type": "department",
"is_required": false,
"api_name": "circle_ids",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "部门抄送范围",
"index_name": "a_1",
"help_text": ""
},
"checkins_lat": {
"describe_api_name": "CheckinsObj",
"expression_type": "text",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1514449896836,
"pattern": "",
"is_unique": false,
"default_value": "",
"label": "签到纬度",
"type": "text",
"default_to_zero": true,
"is_required": false,
"api_name": "checkins_lat",
"define_type": "package",
"is_single": false,
"label_r": "签到纬度",
"is_index_field": false,
"index_name": "t_9",
"max_length": 100,
"help_text": ""
},
"checkin_city": {
"describe_api_name": "CheckinsObj",
"is_index": true,
"is_active": true,
"create_time": 1567566435304,
"is_unique": false,
"label": "签到市",
"type": "city",
"used_in": "component",
"is_required": false,
"api_name": "checkin_city",
"options": [],
"define_type": "package",
"cascade_parent_api_name": "checkin_province",
"is_index_field": false,
"is_single": false,
"index_name": "s_122",
"config": {}
},
"new_stat_date": {
"describe_api_name": "CheckinsObj",
"is_index": true,
"is_active": true,
"create_time": 1514449688573,
"is_unique": false,
"label": "计划日期",
"time_zone": "GMT+8",
"type": "date",
"is_required": false,
"api_name": "new_stat_date",
"define_type": "package",
"date_format": "yyyy-MM-dd",
"is_index_field": false,
"is_single": false,
"label_r": "计划日期",
"index_name": "l_7",
"help_text": ""
},
"checkout_city": {
"describe_api_name": "CheckinsObj",
"is_index": true,
"is_active": true,
"create_time": 1567566435304,
"is_unique": false,
"label": "签退市",
"type": "city",
"used_in": "component",
"is_required": false,
"api_name": "checkout_city",
"options": [],
"define_type": "package",
"cascade_parent_api_name": "checkout_province",
"is_index_field": false,
"is_single": false,
请求参数
Body 参数application/json
返回响应
扫码加入交流群修改于 2022-02-25 07:56:47