获取审批流任务对象描述接口
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": "ApprovalTaskObj"
}'
响应示例响应示例
{ "traceId": "E-O.fktest188.1453-d28cd6006c364bae", "data": { "describe": { "fields": { "submitter": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1546076215678, "length": 8, "description": "审批提交人", "is_unique": false, "label": "审批提交人", "type": "employee", "decimal_places": 0, "is_need_convert": true, "is_required": false, "api_name": "submitter", "define_type": "package", "is_index_field": false, "is_single": true, "label_r": "审批提交人", "index_name": "a_1", "round_mode": 4 }, "owner": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1546076215678, "length": 8, "description": "负责人", "is_unique": false, "label": "负责人", "type": "employee", "decimal_places": 0, "is_need_convert": true, "is_required": false, "api_name": "owner", "define_type": "package", "is_index_field": false, "is_single": true, "label_r": "负责人", "index_name": "owner", "round_mode": 4 }, "task_name": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1546076215678, "pattern": "", "is_unique": false, "label": "任务节点名称", "type": "text", "is_required": false, "api_name": "task_name", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "任务节点名称", "index_name": "t_1", "max_length": 256 }, "name": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1546076215696, "pattern": "", "description": "name", "is_unique": false, "label": "任务主题", "type": "text", "is_required": false, "api_name": "name", "define_type": "system", "is_index_field": false, "is_single": false, "label_r": "任务主题", "index_name": "name", "max_length": 256 }, "candidate_ids": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1557241973919, "is_unique": false, "label": "任务待处理人\t", "type": "employee", "is_required": false, "api_name": "candidate_ids", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "任务待处理人\t" }, "duration": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1572014909788, "length": 18, "is_unique": false, "label": "任务耗时", "type": "number", "decimal_places": 0, "is_required": false, "api_name": "duration", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "任务耗时", "round_mode": 4 }, "workflow_instance_id": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1584115041356, "is_unique": false, "label": "流程主题", "target_api_name": "ApprovalInstanceObj", "type": "object_reference", "target_related_list_name": "target_related_list_approval_instance_task__c", "target_related_list_label": "审批流任务", "action_on_target_delete": "do_not_allow", "is_required": false, "api_name": "workflow_instance_id", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "流程主题", "index_name": "s_5" }, "trigger_type": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1584115041356, "quote_field_type": "text", "is_unique": false, "label": "触发类型", "type": "quote", "quote_field": "workflow_instance_id__r.trigger_type", "is_required": false, "api_name": "trigger_type", "define_type": "package", "is_index_field": false, "is_single": false, "index_name": "t_10" }, "is_tag": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1584115041357, "is_unique": false, "label": "加签节点", "type": "true_or_false", "is_required": false, "api_name": "is_tag", "define_type": "package", "is_index_field": false, "is_single": false, "index_name": "b_3" }, "last_modify_by": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1546076215696, "length": 8, "description": "最后修改人", "is_unique": false, "label": "最后修改人", "type": "employee", "decimal_places": 0, "is_need_convert": true, "is_required": false, "api_name": "last_modify_by", "define_type": "package", "is_index_field": false, "is_single": true, "label_r": "最后修改人", "index_name": "a_2", "round_mode": 4 }, "record_type": { "describe_api_name": "ApprovalTaskObj", "description": "record_type", "is_unique": false, "type": "record_type", "is_required": false, "options": [ { "is_active": true, "api_name": "default__c", "description": "预设业务类型", "label": "预设业务类型" } ], "define_type": "package", "option_id": "504eae3cf17c3d7223be4a3e0e893ecb", "is_extend": false, "is_single": false, "label_r": "业务类型", "index_name": "r_type", "is_index": false, "is_active": true, "create_time": 1546076215695, "label": "业务类型", "is_need_convert": false, "api_name": "record_type", "is_index_field": false, "config": {}, "help_text": "" }, "relevant_team": { "describe_api_name": "ApprovalTaskObj", "embedded_fields": { "teamMemberEmployee": { "is_index": true, "is_need_convert": true, "is_required": false, "api_name": "teamMemberEmployee", "is_unique": false, "define_type": "package", "description": "成员员工", "label": "成员员工", "type": "employee", "is_single": true, "help_text": "成员员工" }, "teamMemberRole": { "is_index": true, "is_need_convert": false, "is_required": false, "api_name": "teamMemberRole", "options": [ { "label": "负责人", "value": "1" }, { "label": "普通成员", "value": "4" } ], "is_unique": false, "define_type": "package", "description": "成员角色", "label": "成员角色", "type": "select_one", "help_text": "成员角色" }, "teamMemberPermissionType": { "is_index": true, "is_need_convert": false, "is_required": false, "api_name": "teamMemberPermissionType", "options": [ { "label": "只读", "value": "1" }, { "label": "读写", "value": "2" } ], "is_unique": false, "define_type": "package", "description": "成员权限类型", "label": "成员权限类型", "type": "select_one", "help_text": "成员权限类型" } }, "is_index": false, "is_active": true, "create_time": 1546076215687, "is_unique": false, "label": "相关团队", "type": "embedded_object_list", "is_need_convert": false, "is_required": false, "api_name": "relevant_team", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "相关团队", "index_name": "a_team", "help_text": "相关团队" }, "object_data_id": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1546076215686, "pattern": "", "is_unique": false, "label": "发起流程数据", "type": "text", "is_required": false, "api_name": "object_data_id", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "发起流程数据", "index_name": "t_3", "max_length": 256 }, "life_status": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1546076215686, "description": "", "is_unique": false, "default_value": "normal", "label": "生命状态", "type": "select_one", "is_required": false, "api_name": "life_status", "options": [ { "label": "未生效", "value": "ineffective" }, { "label": "审核中", "value": "under_review" }, { "label": "正常", "value": "normal" }, { "label": "变更中", "value": "in_change" }, { "label": "作废", "value": "invalid" } ], "define_type": "package", "option_id": "18de2c4eae8cf7a180ffb0f175010e6f", "is_index_field": false, "is_single": false, "label_r": "生命状态", "index_name": "s_3", "config": {} }, "relatedObject": { "describe_api_name": "ApprovalTaskObj", "description": "所属对象,包含对象类型和对象数据", "is_unique": true, "group_type": "what", "type": "group", "is_required": false, "define_type": "package", "is_single": false, "label_r": "所属对象", "index_name": "s_2", "is_index": true, "is_active": true, "create_time": 1546076215678, "label": "所属对象", "api_name": "relatedObject", "fields": { "id_field": "object_data_id", "api_name_field": "object_api_name" }, "is_index_field": false, "help_text": "" }, "workflow_id": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1546076215678, "pattern": "", "is_unique": false, "label": "流程版本号", "type": "text", "is_required": false, "api_name": "workflow_id", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "流程版本号", "index_name": "t_2", "max_length": 256 }, "remind_status": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1595498921065, "is_unique": false, "label": "是否已催办", "type": "true_or_false", "is_required": false, "api_name": "remind_status", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "是否已催办", "index_name": "b_6" }, "link_app_type": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1571326169698, "length": 18, "is_unique": false, "label": "外部应用类型", "type": "number", "decimal_places": 0, "is_required": false, "api_name": "link_app_type", "define_type": "package", "is_index_field": false, "is_single": false, "round_mode": 4 }, "source_workflow_id": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1546076215705, "pattern": "", "is_unique": false, "label": "流程的apiName", "type": "text", "is_required": false, "api_name": "source_workflow_id", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "流程的apiName", "index_name": "t_7", "max_length": 256 }, "last_modify_time": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1546076215678, "is_unique": false, "label": "任务最后更新时间", "time_zone": "GMT+8", "type": "date_time", "is_required": false, "api_name": "last_modify_time", "define_type": "package", "date_format": "yyyy-MM-dd HH:mm:ss", "is_index_field": false, "is_single": false, "label_r": "任务最后更新时间", "index_name": "l_1" }, "state": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1536895865649, "is_unique": false, "label": "任务状态", "type": "select_one", "is_required": false, "api_name": "state", "options": [ { "label": "进行中", "value": "in_progress" }, { "label": "通过", "value": "pass" }, { "label": "取消", "value": "cancel" }, { "label": "异常", "value": "error" }, { "label": "拒绝", "value": "reject" }, { "label": "加签中", "value": "tag_waiting" } ], "define_type": "package", "option_id": "f1e086ac32d54da07cf170e4e1f8d183", "is_index_field": false, "is_single": false, "label_r": "任务状态", "index_name": "s_1", "config": {} }, "opinions": { "describe_api_name": "ApprovalTaskObj", "embedded_fields": { "reply_user": { "is_index": true, "is_need_convert": true, "is_required": false, "api_name": "reply_user", "is_unique": false, "define_type": "package", "description": "审批人", "label": "审批人", "type": "employee", "is_single": true, "help_text": "审批人" }, "action_type": { "is_index": true, "is_need_convert": false, "is_required": false, "api_name": "action_type", "options": [ { "label": "同意", "value": "agree" }, { "label": "拒绝", "value": "reject" }, { "label": "取消", "value": "cancel" } ], "is_unique": false, "define_type": "package", "description": "处理类型", "label": "处理类型", "type": "select_one", "help_text": "处理类型" }, "reply_time": { "is_index": true, "is_active": true, "is_required": false, "api_name": "reply_time", "is_unique": false, "define_type": "package", "label": "审批处理时间", "type": "date_time" }, "opinion": { "is_index": false, "is_active": true, "is_required": false, "api_name": "opinion", "is_unique": false, "define_type": "package", "label": "审批意见", "type": "long_text" } }, "is_index": true, "is_active": true, "create_time": 1546076215696, "is_unique": false, "label": "审批记录", "type": "embedded_object_list", "is_need_convert": false, "is_required": false, "api_name": "opinions", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "审批记录", "index_name": "s_6", "help_text": "审批记录" }, "rejected_from": { "describe_api_name": "ApprovalTaskObj", "expression_type": "js", "return_type": "true_or_false", "is_index": true, "expression": "!OR(ISNULL($rejected_from_person$),ISNULL($rejected_from_reason$))", "is_active": true, "create_time": 1571046552056, "is_unique": false, "label": "是否由节点驳回", "type": "formula", "is_required": false, "api_name": "rejected_from", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "是否由节点驳回" }, "timeout_time": { "describe_api_name": "ApprovalTaskObj", "expression_type": "js", "return_type": "number", "is_index": true, "expression": "IF($is_timeout$,$duration$-$remind_latency$,0)", "is_active": true, "create_time": 1571048482217, "is_unique": false, "label": "超时时长", "type": "formula", "decimal_places": 2, "is_required": false, "api_name": "timeout_time", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "超时时长" }, "is_timeout": { "describe_api_name": "ApprovalTaskObj", "expression_type": "js", "return_type": "true_or_false", "is_index": true, "expression": "AND($remind_latency$\u0003>0,$duration$-$remind_latency$\u0003>0)", "is_active": true, "create_time": 1570882605965, "is_unique": false, "label": "是否超时", "type": "formula", "is_required": false, "api_name": "is_timeout", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "是否超时" }, "rejected_from_reason": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1572014909788, "pattern": "", "description": "由节点驳回的原因", "is_unique": false, "label": "驳回原因", "type": "long_text", "is_required": false, "api_name": "rejected_from_reason", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "驳回原因", "max_length": 5000 }, "read_employee": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1577373239205, "is_unique": false, "label": "已读人员", "type": "employee", "is_required": false, "api_name": "read_employee", "define_type": "package", "is_index_field": false, "is_single": false, "index_name": "a_6" }, "remind_latency": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1572014909788, "length": 18, "is_unique": false, "label": "节点停留时长", "type": "number", "decimal_places": 0, "is_required": false, "api_name": "remind_latency", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "节点停留时长", "round_mode": 4 }, "rejected_from_person": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1572014909788, "length": 8, "description": "由节点驳回的处理人", "is_unique": false, "label": "节点驳回人", "type": "employee", "decimal_places": 0, "is_need_convert": true, "is_required": false, "api_name": "rejected_from_person", "define_type": "package", "is_index_field": false, "is_single": true, "label_r": "节点驳回人", "round_mode": 4 }, "task_type": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1546076215711, "is_unique": false, "label": "任务类型", "type": "select_one", "is_required": false, "api_name": "task_type", "options": [ { "label": "单人审批", "value": "single" }, { "label": "多人审批", "value": "one_pass" }, { "label": "会签审批", "value": "all_pass" } ], "define_type": "package", "option_id": "08c05a1cf901c23738e9d7c889dad800", "is_index_field": false, "is_single": false, "label_r": "任务类型", "index_name": "s_7", "config": {} }, "dealed_persons": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1546076215696, "description": "已处理人", "is_unique": false, "label": "已处理人", "type": "employee", "is_required": false, "api_name": "dealed_persons", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "已处理人", "index_name": "a_3" }, "activity_id": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1546076215696, "pattern": "", "is_unique": false, "label": "流程节点定义Id", "type": "text", "is_required": false, "api_name": "activity_id", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "流程节点定义Id", "index_name": "t_6", "max_length": 256 }, "life_status_before_invalid": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1546076215696, "pattern": "", "description": "作废前生命状态", "is_unique": false, "label": "作废前生命状态", "type": "text", "is_required": false, "api_name": "life_status_before_invalid", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "作废前生命状态", "index_name": "t_5", "max_length": 256 }, "object_api_name": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1546076215696, "pattern": "", "is_unique": false, "label": "流程关联对象", "type": "text", "is_required": false, "api_name": "object_api_name", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "流程关联对象", "index_name": "t_4", "max_length": 256 }, "start_time": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1546076215696, "is_unique": false, "label": "任务开始时间", "time_zone": "GMT+8", "type": "date_time", "is_required": false, "api_name": "start_time", "define_type": "package", "date_format": "yyyy-MM-dd HH:mm:ss", "is_index_field": false, "is_single": false, "label_r": "任务开始时间", "index_name": "l_2" }, "link_app_id": { "describe_api_name": "ApprovalTaskObj", "is_index": false, "is_active": true, "create_time": 1571326169698, "pattern": "", "is_unique": false, "label": "外部应用id", "type": "text", "is_required": false, "api_name": "link_app_id", "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "外部应用id", "max_length": 256 }, "execution_type": { "describe_api_name": "ApprovalTaskObj", "is_index": true, "is_active": true, "create_time": 1608118065446, "is_unique": false, "label": "任务节点类型", "type": "select_one", "is_required": false, "api_name": "execution_type", "options": [ { "label": "编辑", "value": "update" } ], "define_type": "package", "option_id": "11a34d8f82ad697c1b71a126e93b0108", "is_index_field": false, "is_single": false, "label_r": "任务节点类型", "index_name": "s_8", "config": {} }, "_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": 1545708950417, "describe_api_name": "ApprovalTaskObj" }, "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": 1545708950417, "describe_api_name": "ApprovalTaskObj" }, "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": 1545708950417, "describe_api_name": "ApprovalTaskObj" }, "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": 1545708950417, "describe_api_name": "ApprovalTaskObj" }, "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": 1545708950417, "describe_api_name": "ApprovalTaskObj" }, "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": 1545708950417, "describe_api_name": "ApprovalTaskObj" }, "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": 1545708950417, "describe_api_name": "ApprovalTaskObj" }, "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": 1545708950417, "config": { "display": 0 }, "describe_api_name": "ApprovalTaskObj" }, "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": 1545708950417, "describe_api_name": "ApprovalTaskObj" }, "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": 1545708950417, "describe_api_name": "ApprovalTaskObj" }, "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": 1545708950417, "describe_api_name": "ApprovalTaskObj" } }, "api_name": "ApprovalTaskObj", "created_by": "-1000", "display_name_r": "审批流程任务" }, "detailObjectDescribeList": [] }, "errorDescription": "success", "errorMessage": "success", "errorCode": 0 }
请求参数
Body 参数application/json