获取流程实例对象描述接口
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": "BpmInstance"
}'响应示例响应示例
{
"errorCode": 0,
"errorMessage": "success",
"data": {
"describe": {
"api_name": "ProductObj",
"fields": {
"product_status": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008441,
"description": "上下架",
"is_unique": false,
"default_value": "1",
"label": "上下架",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"api_name": "product_status",
"options": [
{
"label": "已上架",
"value": "1"
},
{
"label": "已下架",
"value": "2"
}
],
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40e5",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"config": {
"add": 0,
"edit": 1,
"enable": 1,
"display": 1,
"remove": 0,
"attrs": {
"file_amount_limit": 1,
"api_name": 0,
"label": 1,
"is_watermark": 1,
"help_text": 1
}
}
},
"remark": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008441,
"pattern": "",
"description": "备注",
"is_unique": false,
"label": "备注",
"type": "long_text",
"is_need_convert": false,
"is_required": false,
"api_name": "remark",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40e6",
"is_index_field": false,
"is_single": false,
"max_length": 2000
},
"replacement_period": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": false,
"create_time": 1528998008442,
"length": 20,
"description": "更换周期（天）",
"is_unique": false,
"label": "更换周期（天）",
"type": "number",
"decimal_places": 0,
"is_need_convert": false,
"is_required": false,
"api_name": "replacement_period",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40e7",
"is_index_field": false,
"is_single": false,
"round_mode": 4
},
"product_code": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008442,
"pattern": "",
"description": "产品编码",
"is_unique": false,
"label": "产品编码",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "product_code",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40e8",
"is_index_field": false,
"is_single": false,
"config": {
"edit": 1,
"enable": 1
},
"max_length": 50
},
"on_shelves_time": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008442,
"description": "上架时间",
"is_unique": false,
"label": "上架时间",
"time_zone": "GMT+8",
"type": "date_time",
"is_need_convert": false,
"is_required": false,
"api_name": "on_shelves_time",
"define_type": "package",
"date_format": "yyyy-MM-dd HH:mm",
"_id": "5bc20dac5c6c2538f1ed40ec",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"config": {
"edit": 1,
"enable": 1,
"remove": 0,
"attrs": {
"is_readonly": 0,
"is_required": 0
}
}
},
"safety_stock": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": false,
"create_time": 1528998008443,
"length": 20,
"description": "安全库存",
"is_unique": false,
"label": "安全库存",
"type": "number",
"decimal_places": 0,
"is_need_convert": false,
"is_required": false,
"api_name": "safety_stock",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40ee",
"is_index_field": false,
"is_single": false,
"round_mode": 4
},
"extend_obj_data_id": {
"describe_api_name": "ProductObj",
"default_is_expression": false,
"is_index": false,
"is_active": true,
"create_time": 1528998008443,
"pattern": "",
"description": "extend_obj_data_id",
"is_unique": false,
"default_value": "",
"label": "extend_obj_data_id",
"type": "text",
"default_to_zero": false,
"is_required": false,
"api_name": "extend_obj_data_id",
"define_type": "system",
"_id": "5b22a878a5423c546bd427e2",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"help_text": "",
"max_length": 100
},
"off_shelves_time": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008443,
"description": "下架时间",
"is_unique": false,
"label": "下架时间",
"time_zone": "GMT+8",
"type": "date_time",
"is_need_convert": false,
"is_required": false,
"api_name": "off_shelves_time",
"define_type": "package",
"date_format": "yyyy-MM-dd HH:mm",
"_id": "5bc20dac5c6c2538f1ed40f1",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"config": {
"edit": 1,
"enable": 1,
"remove": 0,
"attrs": {
"is_readonly": 0,
"is_required": 0
}
}
},
"is_deleted": {
"is_index": false,
"is_need_convert": false,
"is_required": false,
"api_name": "is_deleted",
"define_type": "system",
"is_unique": false,
"description": "is_deleted",
"default_value": false,
"label": "is_deleted",
"type": "true_or_false",
"index_name": "is_del"
},
"price": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1547951413974,
"length": 14,
"description": "标准价格",
"is_unique": false,
"label": "标准价格",
"currency_unit": "￥",
"type": "currency",
"decimal_places": 2,
"is_need_convert": false,
"is_required": true,
"api_name": "price",
"define_type": "package",
"_id": "5c43dd35e17c9daa29bdebaa",
"is_index_field": false,
"is_single": false,
"config": {
"edit": 0,
"enable": 0
},
"round_mode": 4,
"max_length": 20
},
"owner_department": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008443,
"pattern": "",
"description": "负责人主属部门",
"is_unique": false,
"label": "负责人主属部门",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "owner_department",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40f5",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"max_length": 100
},
"model": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": false,
"create_time": 1528998008443,
"pattern": "",
"description": "型号",
"is_unique": false,
"label": "型号",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "model",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40f6",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"max_length": 256
},
"out_owner": {
"is_index": false,
"is_need_convert": false,
"is_required": false,
"api_name": "out_owner",
"define_type": "system",
"is_unique": false,
"label": "外部负责人",
"type": "employee",
"is_single": true,
"index_name": "o_owner",
"config": {
"display": 1
}
},
"spu_id": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1547830430070,
"description": "商品名称",
"is_unique": false,
"label": "商品名称",
"target_api_name": "SPUObj",
"type": "object_reference",
"target_related_list_name": "spu_sku_list",
"target_related_list_label": "产品",
"action_on_target_delete": "cascade_delete",
"is_need_convert": false,
"is_required": true,
"api_name": "spu_id",
"define_type": "package",
"_id": "5c42049edf72a6df4e75abcf",
"is_extend": false,
"is_index_field": true,
"is_single": false,
"config": {
"edit": 0,
"enable": 0,
"display": 1
}
},
"barcode": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008443,
"pattern": "",
"description": "条形码",
"is_unique": false,
"label": "条形码",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "barcode",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40f8",
"is_index_field": false,
"is_single": false,
"config": {
"edit": 1,
"enable": 1,
"remove": 0
},
"max_length": 50
},
"maintenance_period": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": false,
"create_time": 1528998008443,
"length": 20,
"description": "保养周期（天）",
"is_unique": false,
"label": "保养周期（天）",
"type": "number",
"decimal_places": 0,
"is_need_convert": false,
"is_required": false,
"api_name": "maintenance_period",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40f9",
"is_index_field": false,
"is_single": false,
"round_mode": 4
},
"owner": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008443,
"length": 18,
"description": "负责人",
"is_unique": false,
"label": "负责人",
"type": "employee",
"decimal_places": 0,
"is_need_convert": true,
"is_required": false,
"api_name": "owner",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40e4",
"is_extend": false,
"is_index_field": false,
"is_single": true,
"config": {
"display": 0
},
"round_mode": 4
},
"picture_path": {
"describe_api_name": "ProductObj",
"file_amount_limit": 20,
"is_index": false,
"is_active": true,
"create_time": 1528998008443,
"description": "产品图片",
"is_unique": false,
"label": "图片",
"type": "image",
"is_watermark": false,
"file_size_limit": 10485760,
"is_need_convert": false,
"is_required": false,
"api_name": "picture_path",
"define_type": "package",
"_id": "5b22a878a5423c546bd427e9",
"is_index_field": false,
"is_single": false,
"config": {
"add": 0,
"edit": 1,
"enable": 1,
"display": 1,
"remove": 0,
"attrs": {
"file_amount_limit": 1,
"api_name": 0,
"label": 1,
"is_watermark": 1,
"help_text": 1
}
},
"support_file_types": []
},
"lock_status": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008446,
"description": "锁定状态",
"is_unique": false,
"default_value": "0",
"label": "锁定状态",
"type": "select_one",
"is_required": false,
"api_name": "lock_status",
"options": [
{
"label": "未锁定",
"value": "0"
},
{
"label": "锁定",
"value": "1"
}
],
"define_type": "package",
"_id": "5b22a878a5423c546bd427ea",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"config": {}
},
"last_modified_time": {
"is_index": true,
"is_unique": false,
"description": "last_modified_time",
"label": "最后修改时间",
"type": "date_time",
"time_zone": "",
"is_need_convert": false,
"is_required": false,
"api_name": "last_modified_time",
"define_type": "system",
"date_format": "yyyy-MM-dd HH:mm:ss",
"index_name": "md_time"
},
"is_giveaway": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": false,
"create_time": 1528998008450,
"description": "是否赠品",
"is_unique": false,
"default_value": "0",
"label": "是否赠品",
"type": "select_one",
"is_required": false,
"api_name": "is_giveaway",
"options": [
{
"label": "否",
"value": "0"
},
{
"label": "是",
"value": "1"
}
],
"define_type": "package",
"_id": "5b22a878a5423c546bd427ec",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"config": {}
},
"create_time": {
"is_index": true,
"is_unique": false,
"description": "create_time",
"label": "创建时间",
"type": "date_time",
"time_zone": "",
"is_need_convert": false,
"is_required": false,
"api_name": "create_time",
"define_type": "system",
"date_format": "yyyy-MM-dd HH:mm:ss",
"index_name": "crt_time"
},
"life_status": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1547830430092,
"description": "生命状态",
"is_unique": false,
"default_value": "normal",
"label": "生命状态",
"type": "select_one",
"is_need_convert": false,
"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",
"_id": "5c42049edf72a6df4e75ac28",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"config": {},
"help_text": "生命状态"
},
"order_field": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1547830430092,
"pattern": "",
"description": "排序字段",
"is_unique": false,
"label": "排序字段",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "order_field",
"define_type": "package",
"_id": "5c42049edf72a6df4e75ac29",
"is_index_field": false,
"is_single": false,
"max_length": 128
},
"last_modified_by": {
"is_index": true,
"is_active": true,
"is_need_convert": true,
"is_required": false,
"api_name": "last_modified_by",
"define_type": "system",
"is_unique": false,
"label": "最后修改人",
"type": "employee",
"is_single": true,
"index_name": "md_by"
},
"technical_parameter": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": false,
"create_time": 1528998008450,
"pattern": "",
"description": "技术参数",
"is_unique": false,
"label": "技术参数",
"type": "long_text",
"is_need_convert": false,
"is_required": false,
"api_name": "technical_parameter",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40e9",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"max_length": 512
},
"out_tenant_id": {
"is_index": false,
"pattern": "",
"is_unique": false,
"description": "out_tenant_id",
"label": "外部企业",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "out_tenant_id",
"define_type": "system",
"index_name": "o_ei",
"config": {
"display": 0
},
"max_length": 200
},
"created_by": {
"is_index": true,
"is_active": true,
"is_need_convert": true,
"is_required": false,
"api_name": "created_by",
"define_type": "system",
"is_unique": false,
"label": "创建人",
"type": "employee",
"is_single": true,
"index_name": "crt_by"
},
"relevant_team": {
"describe_api_name": "ProductObj",
"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": 1528998008450,
"is_unique": false,
"label": "相关团队",
"type": "embedded_object_list",
"is_need_convert": false,
"is_required": false,
"api_name": "relevant_team",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40eb",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"help_text": "相关团队"
},
"record_type": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008453,
"description": "record_type",
"is_unique": false,
"label": "业务类型",
"type": "record_type",
"is_need_convert": false,
"is_required": false,
"api_name": "record_type",
"options": [
{
"is_active": true,
"api_name": "default__c",
"description": "预设业务类型",
"label": "预设业务类型"
}
],
"define_type": "package",
"_id": "5bc2dd9c5c6c2538f1137938",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "record_type",
"config": {},
"help_text": ""
},
"product_line": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008459,
"description": "产品线",
"is_unique": false,
"label": "产品线",
"type": "select_one",
"is_need_convert": false,
"is_required": false,
"api_name": "product_line",
"options": [
{
"label": "产品线1",
"value": "1"
},
{
"label": "产品线2",
"value": "2"
},
{
"label": "产品线3",
"value": "3"
}
],
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40ef",
"is_index_field": false,
"is_single": false,
"config": {
"edit": 0,
"enable": 1,
"remove": 0,
"attrs": {
"is_readonly": 0,
"is_required": 0
}
}
},
"unit": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008465,
"description": "单位",
"is_unique": false,
"label": "单位",
"type": "select_one",
"is_need_convert": false,
"is_required": false,
"api_name": "unit",
"options": [
{
"label": "个",
"value": "1"
},
{
"label": "块",
"value": "2"
},
{
"label": "只",
"value": "3"
}
],
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40f0",
"is_index_field": false,
"is_single": false,
"config": {
"edit": 0,
"enable": 1,
"remove": 0,
"attrs": {
"is_readonly": 0,
"is_required": 0
}
}
},
"product_spec": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008465,
"pattern": "",
"description": "规格属性",
"is_unique": false,
"label": "规格属性",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "product_spec",
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40f3",
"is_index_field": false,
"is_single": false,
"config": {
"edit": 0,
"enable": 0,
"attrs": {
"is_readonly": 0,
"is_required": 0
}
},
"max_length": 100
},
"data_own_department": {
"is_index": true,
"is_active": true,
"is_need_convert": false,
"is_required": false,
"api_name": "data_own_department",
"define_type": "package",
"is_unique": false,
"label": "归属部门",
"type": "department",
"is_single": true,
"index_name": "data_owner_dept_id"
},
"name": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008465,
"pattern": "",
"description": "产品名称",
"is_unique": true,
"label": "产品名称",
"type": "text",
"is_need_convert": false,
"is_required": true,
"api_name": "name",
"define_type": "system",
"_id": "5b22a878a5423c546bd42805",
"is_index_field": false,
"is_single": false,
"config": {
"edit": 1,
"enable": 0,
"attrs": {
"is_readonly": 0,
"is_required": 0
}
},
"max_length": 100
},
"_id": {
"is_index": false,
"pattern": "",
"is_unique": false,
"description": "_id",
"label": "_id",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "_id",
"define_type": "system",
"index_name": "_id",
"max_length": 200
},
"category": {
"describe_api_name": "ProductObj",
"is_index": true,
"is_active": true,
"create_time": 1528998008472,
"description": "分类",
"is_unique": false,
"label": "分类",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"api_name": "category",
"options": [
{
"label": "办公用品",
"value": "1"
},
{
"label": "数码产品",
"value": "2"
},
{
"label": "服务",
"value": "3"
}
],
"define_type": "package",
"_id": "5bc20dac5c6c2538f1ed40f7",
"is_index_field": false,
"is_single": false,
"config": {
"edit": 0,
"enable": 0,
"attrs": {
"is_readonly": 0,
"is_required": 0
}
}
}
}
}
}
}请求参数
Body 参数application/json
返回响应
扫码加入交流群