获取子规则对象描述接口
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": "GoalRuleDetailObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-4d82a4650ef44389",
"data": {
"describe": {
"fields": {
"subgoal_fieldtype": {
"describe_api_name": "GoalRuleDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1545708954611,
"pattern": "",
"is_unique": false,
"label": "子目标字段类型",
"type": "text",
"is_required": false,
"api_name": "subgoal_fieldtype",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "t_3",
"help_text": "",
"max_length": 256
},
"subgoal_comparison": {
"describe_api_name": "GoalRuleDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1545708954611,
"pattern": "",
"is_unique": false,
"label": "子目标维度比较符",
"type": "text",
"is_required": false,
"api_name": "subgoal_comparison",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "t_1",
"help_text": "",
"max_length": 256
},
"subgoal_value": {
"describe_api_name": "GoalRuleDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1545708954611,
"is_unique": false,
"label": "子目标值",
"type": "array",
"is_required": false,
"api_name": "subgoal_value",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "子目标值",
"index_name": "a_1",
"help_text": ""
},
"name": {
"describe_api_name": "GoalRuleDetailObj",
"default_is_expression": false,
"pattern": "",
"description": "name",
"is_unique": false,
"type": "text",
"default_to_zero": false,
"is_required": false,
"define_type": "system",
"is_extend": false,
"is_single": false,
"label_r": "主属性",
"index_name": "name",
"max_length": 100,
"is_index": false,
"is_active": false,
"create_time": 1545708954611,
"default_value": "",
"label": "主属性",
"api_name": "name",
"is_index_field": false,
"help_text": ""
},
"subgoal_name": {
"describe_api_name": "GoalRuleDetailObj",
"is_index": true,
"is_active": true,
"create_time": 1545708954611,
"pattern": "",
"is_unique": false,
"label": "子目标命名",
"type": "text",
"is_required": false,
"api_name": "subgoal_name",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "子目标命名",
"index_name": "t_2",
"help_text": "",
"max_length": 256
},
"goal_rule_id": {
"describe_api_name": "GoalRuleDetailObj",
"pattern": "",
"is_unique": false,
"type": "master_detail",
"is_required": true,
"define_type": "package",
"is_single": false,
"label_r": "目标规则配置id",
"index_name": "s_1",
"is_index": true,
"is_active": true,
"create_time": 1545708954611,
"label": "目标规则配置id",
"target_api_name": "GoalRuleObj",
"target_related_list_name": "goal_rule_detail_list",
"target_related_list_label": "子目标规则",
"api_name": "goal_rule_id",
"is_create_when_master_create": true,
"is_index_field": false,
"is_required_when_master_create": false
},
"_id": {
"type": "text",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"max_length": 200,
"pattern": "",
"label": "_id",
"is_active": true,
"api_name": "_id",
"description": "_id",
"index_name": "_id",
"create_time": 1545708950200,
"describe_api_name": "GoalRuleDetailObj"
},
"version": {
"type": "number",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"round_mode": 4,
"length": 8,
"decimal_places": 0,
"label": "version",
"api_name": "version",
"description": "version",
"index_name": "version",
"create_time": 1545708950200,
"describe_api_name": "GoalRuleDetailObj"
},
"created_by": {
"type": "employee",
"define_type": "system",
"is_index": true,
"is_need_convert": true,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "created_by",
"label": "创建人",
"is_active": true,
"index_name": "crt_by",
"create_time": 1545708950200,
"describe_api_name": "GoalRuleDetailObj"
},
"last_modified_by": {
"type": "employee",
"define_type": "system",
"is_index": true,
"is_need_convert": true,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "last_modified_by",
"is_active": true,
"index_name": "md_by",
"label": "最后修改人",
"create_time": 1545708950200,
"describe_api_name": "GoalRuleDetailObj"
},
"create_time": {
"type": "date_time",
"define_type": "system",
"is_index": true,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"time_zone": "",
"date_format": "yyyy-MM-dd HH:mm:ss",
"label": "创建时间",
"api_name": "create_time",
"description": "create_time",
"index_name": "crt_time",
"create_time": 1545708950200,
"describe_api_name": "GoalRuleDetailObj"
},
"last_modified_time": {
"type": "date_time",
"define_type": "system",
"is_index": true,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"time_zone": "",
"date_format": "yyyy-MM-dd HH:mm:ss",
"label": "最后修改时间",
"api_name": "last_modified_time",
"description": "last_modified_time",
"index_name": "md_time",
"create_time": 1545708950200,
"describe_api_name": "GoalRuleDetailObj"
},
"is_deleted": {
"type": "true_or_false",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"label": "is_deleted",
"api_name": "is_deleted",
"description": "is_deleted",
"default_value": false,
"index_name": "is_del",
"create_time": 1545708950200,
"describe_api_name": "GoalRuleDetailObj"
},
"out_tenant_id": {
"type": "text",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"max_length": 200,
"pattern": "",
"label": "外部企业",
"is_active": true,
"api_name": "out_tenant_id",
"description": "out_tenant_id",
"index_name": "o_ei",
"create_time": 1545708950200,
"config": {
"display": 0
},
"describe_api_name": "GoalRuleDetailObj"
},
"out_owner": {
"type": "employee",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "out_owner",
"index_name": "o_owner",
"label": "外部负责人",
"is_active": true,
"config": {
"display": 1
},
"create_time": 1545708950200,
"describe_api_name": "GoalRuleDetailObj"
},
"data_own_department": {
"type": "department",
"define_type": "package",
"is_index": true,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "data_own_department",
"label": "归属部门",
"is_active": true,
"index_name": "data_owner_dept_id",
"create_time": 1545708950200,
"describe_api_name": "GoalRuleDetailObj"
},
"order_by": {
"type": "number",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"round_mode": 4,
"length": 8,
"decimal_places": 0,
"label": "order_by",
"api_name": "order_by",
"description": "order_by",
"index_name": "l_by",
"create_time": 1545708950200,
"describe_api_name": "GoalRuleDetailObj"
}
},
"api_name": "GoalRuleDetailObj",
"created_by": "-1000",
"icon_index": 12,
"display_name_r": "子目标规则配置"
},
"detailObjectDescribeList": []
},
"errorDescription": "success",
"errorMessage": "success",
"errorCode": 0
}请求参数
Body 参数application/json
返回响应
扫码加入交流群