获取审批流实例对象描述接口
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": "ApprovalInstanceObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-aef33d7a28a44cd1",
"data": {
"describe": {
"fields": {
"current_candidate_ids": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1611663045724,
"is_unique": false,
"label": "当前处理人",
"type": "employee",
"is_required": false,
"api_name": "current_candidate_ids",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "当前处理人",
"index_name": "a_4"
},
"rejecter": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1545708955383,
"length": 8,
"description": "拒绝人",
"is_unique": false,
"label": "拒绝人",
"type": "employee",
"decimal_places": 0,
"is_need_convert": true,
"is_required": false,
"api_name": "rejecter",
"define_type": "package",
"is_index_field": false,
"is_single": true,
"label_r": "拒绝人",
"index_name": "a_3",
"round_mode": 4
},
"life_status_before_invalid": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": false,
"is_active": true,
"create_time": 1545708955383,
"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_9",
"max_length": 256
},
"owner": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": false,
"is_active": true,
"create_time": 1545708955374,
"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
},
"name": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1545708955383,
"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
},
"source_workflow_id": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": false,
"is_active": true,
"create_time": 1545708955390,
"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_10",
"max_length": 256
},
"relevant_team": {
"describe_api_name": "ApprovalInstanceObj",
"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": 1545708955379,
"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": "相关团队"
},
"state": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1545708955390,
"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"
}
],
"define_type": "package",
"option_id": "40ea84461f1407cebb1cc9841e4eae70",
"is_index_field": false,
"is_single": false,
"label_r": "流程状态",
"index_name": "s_4",
"config": {}
},
"canceler": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1545708955383,
"length": 8,
"description": "撤回人",
"is_unique": false,
"label": "撤回人",
"type": "employee",
"decimal_places": 0,
"is_need_convert": true,
"is_required": false,
"api_name": "canceler",
"define_type": "package",
"is_index_field": false,
"is_single": true,
"label_r": "撤回人",
"index_name": "a_2",
"round_mode": 4
},
"record_type": {
"describe_api_name": "ApprovalInstanceObj",
"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": 1545708955383,
"label": "业务类型",
"is_need_convert": false,
"api_name": "record_type",
"is_index_field": false,
"config": {},
"help_text": ""
},
"object_data_id": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": false,
"is_active": true,
"create_time": 1545708955379,
"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_5",
"max_length": 256
},
"end_time": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1545708955379,
"is_unique": false,
"label": "流程结束时间",
"time_zone": "GMT+8",
"type": "date_time",
"is_required": false,
"api_name": "end_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"
},
"trigger_type": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1545708955379,
"pattern": "",
"is_unique": false,
"label": "触发类型",
"type": "text",
"is_required": false,
"api_name": "trigger_type",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "触发类型",
"index_name": "t_4",
"max_length": 256
},
"life_status": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": false,
"is_active": true,
"create_time": 1545708955379,
"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_2",
"config": {}
},
"last_modify_time": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": false,
"is_active": true,
"create_time": 1545708955374,
"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"
},
"relatedObject": {
"describe_api_name": "ApprovalInstanceObj",
"description": "流程发起对象,包含对象类型和对象数据",
"is_unique": true,
"group_type": "what",
"type": "group",
"is_required": false,
"define_type": "package",
"is_single": false,
"label_r": "所属对象",
"index_name": "s_1",
"is_index": false,
"is_active": true,
"create_time": 1545708955374,
"label": "所属对象",
"api_name": "relatedObject",
"fields": {
"id_field": "object_data_id",
"api_name_field": "object_api_name"
},
"is_index_field": false,
"help_text": ""
},
"workflow_name": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1545708955374,
"pattern": "",
"is_unique": false,
"label": "流程名称",
"type": "text",
"is_required": false,
"api_name": "workflow_name",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "流程名称",
"index_name": "t_3",
"max_length": 256
},
"workflow_instance_version": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": false,
"is_active": true,
"create_time": 1545708955374,
"pattern": "",
"is_unique": false,
"label": "流程版本",
"type": "text",
"is_required": false,
"api_name": "workflow_instance_version",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "流程版本",
"index_name": "t_2",
"max_length": 256
},
"workflow_id": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": false,
"is_active": true,
"create_time": 1545708955374,
"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_1",
"max_length": 256
},
"submitter": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1545708955374,
"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
},
"remind_latency": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": false,
"is_active": true,
"create_time": 1573006424246,
"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": "流程期限",
"index_name": "d_3",
"round_mode": 4
},
"timeout_time": {
"describe_api_name": "ApprovalInstanceObj",
"expression_type": "js",
"return_type": "number",
"is_index": true,
"expression": "IF($is_timeout$,$duration$-$remind_latency$,0)",
"is_active": true,
"create_time": 1573006424246,
"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": "超时时长",
"index_name": "d_2"
},
"is_timeout": {
"describe_api_name": "ApprovalInstanceObj",
"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": 1573006424246,
"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": "是否超时",
"index_name": "b_1"
},
"duration": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": false,
"is_active": true,
"create_time": 1573006424246,
"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": "实例耗时",
"index_name": "d_1",
"round_mode": 4
},
"reject_reason": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1545708955379,
"pattern": "",
"description": "拒绝原因",
"is_unique": false,
"label": "拒绝原因",
"type": "long_text",
"is_required": false,
"api_name": "reject_reason",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "拒绝原因",
"index_name": "t_6",
"max_length": 5000
},
"cancel_reason": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1545708955383,
"pattern": "",
"description": "撤回原因",
"is_unique": false,
"label": "撤回原因",
"type": "long_text",
"is_required": false,
"api_name": "cancel_reason",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "撤回原因",
"index_name": "t_7",
"max_length": 5000
},
"object_api_name": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": false,
"is_active": true,
"create_time": 1545708955383,
"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_8",
"max_length": 256
},
"start_time": {
"describe_api_name": "ApprovalInstanceObj",
"is_index": true,
"is_active": true,
"create_time": 1545708955383,
"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_3"
},
"_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": 1545708950348,
"describe_api_name": "ApprovalInstanceObj"
},
"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": 1545708950348,
"describe_api_name": "ApprovalInstanceObj"
},
"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": 1545708950348,
"describe_api_name": "ApprovalInstanceObj"
},
"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": 1545708950348,
"describe_api_name": "ApprovalInstanceObj"
},
"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": 1545708950348,
"describe_api_name": "ApprovalInstanceObj"
},
"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": 1545708950348,
"describe_api_name": "ApprovalInstanceObj"
},
"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": 1545708950348,
"describe_api_name": "ApprovalInstanceObj"
},
"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": 1545708950348,
"config": {
"display": 0
},
"describe_api_name": "ApprovalInstanceObj"
},
"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": 1545708950348,
"describe_api_name": "ApprovalInstanceObj"
},
"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": 1545708950348,
"describe_api_name": "ApprovalInstanceObj"
},
"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": 1545708950348,
"describe_api_name": "ApprovalInstanceObj"
}
},
"api_name": "ApprovalInstanceObj",
"created_by": "-1000",
"display_name_r": "审批流实例"
},
"detailObjectDescribeList": []
},
"errorDescription": "success",
"errorMessage": "success",
"errorCode": 0
}请求参数
Body 参数application/json
返回响应
扫码加入交流群