获取批次对象描述接口
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": "BatchObj"
}'响应示例响应示例
{
"errorCode": 0,
"errorMessage": "success",
"data": {
"describe": {
"fields": {
"product_id": {
"describe_api_name": "BatchObj",
"is_unique": false,
"type": "object_reference",
"is_required": true,
"wheres": [
{
"connector": "OR",
"filters": [
{
"operator": "EQ",
"field_name": "product_status",
"field_values": [
"1"
]
},
{
"operator": "EQ",
"field_name": "batch_sn",
"field_values": [
"2"
]
}
]
}
],
"define_type": "package",
"is_extend": false,
"is_single": false,
"index_name": "s_4",
"is_index": true,
"is_active": true,
"create_time": 1595321768417,
"label": "产品名称",
"target_api_name": "ProductObj",
"target_related_list_name": "target_related_list_batch_product",
"target_related_list_label": "批次",
"action_on_target_delete": "set_null",
"is_need_convert": false,
"api_name": "product_id",
"is_index_field": true
},
"total_batch_stock": {
"describe_api_name": "BatchObj",
"return_type": "number",
"is_unique": false,
"type": "count",
"decimal_places": 2,
"sub_object_describe_apiname": "BatchStockObj",
"is_required": false,
"wheres": [],
"define_type": "package",
"is_extend": false,
"is_single": false,
"index_name": "d_2",
"field_api_name": "batch_id",
"is_index": false,
"is_active": true,
"create_time": 1595321768386,
"count_type": "sum",
"count_field_api_name": "batch_real_stock",
"label": "批次总库存",
"is_need_convert": false,
"api_name": "total_batch_stock",
"count_field_type": "number",
"is_index_field": false
},
"begin_warning_date": {
"describe_api_name": "BatchObj",
"is_index": true,
"is_active": true,
"create_time": 1595321768387,
"is_unique": false,
"label": "预警开始日期",
"time_zone": "GMT+8",
"type": "date",
"is_need_convert": false,
"is_required": false,
"api_name": "begin_warning_date",
"define_type": "package",
"date_format": "yyyy-MM-dd",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "l_1"
},
"expiry_date": {
"describe_api_name": "BatchObj",
"is_index": true,
"is_active": true,
"create_time": 1595321768387,
"is_unique": false,
"label": "有效日期",
"time_zone": "GMT+8",
"type": "date",
"is_need_convert": false,
"is_required": false,
"api_name": "expiry_date",
"define_type": "package",
"date_format": "yyyy-MM-dd",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "l_2"
},
"manufacture_date": {
"describe_api_name": "BatchObj",
"is_index": true,
"is_active": true,
"create_time": 1595321768387,
"is_unique": false,
"label": "生产日期",
"time_zone": "GMT+8",
"type": "date",
"is_need_convert": false,
"is_required": false,
"api_name": "manufacture_date",
"define_type": "package",
"date_format": "yyyy-MM-dd",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "l_3"
},
"relevant_team": {
"describe_api_name": "BatchObj",
"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": true,
"is_active": true,
"create_time": 1595321768418,
"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,
"index_name": "a_team",
"help_text": "相关团队"
},
"owner": {
"describe_api_name": "BatchObj",
"is_index": true,
"is_active": true,
"create_time": 1595321768415,
"is_unique": false,
"label": "负责人",
"type": "employee",
"is_need_convert": false,
"is_required": true,
"api_name": "owner",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": true,
"index_name": "owner"
},
"lock_user": {
"describe_api_name": "BatchObj",
"is_index": false,
"is_active": true,
"create_time": 1595321768394,
"description": "加锁人",
"is_unique": false,
"label": "加锁人",
"type": "employee",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_user",
"define_type": "package",
"is_index_field": false,
"is_single": true,
"index_name": "a_1"
},
"lock_rule": {
"describe_api_name": "BatchObj",
"is_index": false,
"is_active": true,
"create_time": 1595321768393,
"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,
"index_name": "s_1"
},
"remark": {
"describe_api_name": "BatchObj",
"is_index": false,
"is_active": true,
"create_time": 1595321768387,
"pattern": "",
"is_unique": false,
"label": "备注",
"type": "long_text",
"is_need_convert": false,
"is_required": false,
"api_name": "remark",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "t_1",
"max_length": 1000
},
"warning_days_in_advance": {
"describe_api_name": "BatchObj",
"is_unique": false,
"type": "number",
"decimal_places": 0,
"default_to_zero": true,
"is_required": false,
"define_type": "package",
"is_extend": false,
"is_single": false,
"index_name": "d_1",
"max_length": 14,
"is_index": true,
"is_active": true,
"create_time": 1595321768416,
"length": 12,
"label": "临到期预警天数",
"is_need_convert": false,
"api_name": "warning_days_in_advance",
"is_index_field": false,
"round_mode": 4
},
"record_type": {
"describe_api_name": "BatchObj",
"is_index": true,
"is_active": true,
"create_time": 1595321768419,
"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",
"is_index_field": false,
"is_single": false,
"index_name": "r_type",
"config": {}
},
"lock_status": {
"describe_api_name": "BatchObj",
"is_index": true,
"is_active": true,
"create_time": 1595321768394,
"description": "锁定状态",
"is_unique": false,
"default_value": "0",
"label": "锁定状态",
"type": "select_one",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_status",
"options": [
{
"label": "未锁定",
"value": "0"
},
{
"label": "锁定",
"value": "1"
}
],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "s_2",
"config": {}
},
"life_status": {
"describe_api_name": "BatchObj",
"is_index": true,
"is_active": true,
"create_time": 1595321768394,
"description": "生命状态",
"is_unique": false,
"default_value": "normal",
"label": "生命状态",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"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",
"is_index_field": false,
"is_single": false,
"index_name": "s_3",
"config": {}
},
"extend_obj_data_id": {
"describe_api_name": "BatchObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595321768388,
"pattern": "",
"is_unique": false,
"label": "extend_obj_data_id",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "extend_obj_data_id",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "t_2",
"max_length": 256
},
"life_status_before_invalid": {
"describe_api_name": "BatchObj",
"is_index": false,
"is_active": true,
"create_time": 1595321768394,
"pattern": "",
"description": "作废前生命状态",
"is_unique": false,
"label": "作废前生命状态",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "life_status_before_invalid",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "t_3",
"max_length": 256
},
"name": {
"describe_api_name": "BatchObj",
"default_is_expression": false,
"pattern": "",
"description": "name",
"is_unique": true,
"type": "text",
"default_to_zero": false,
"is_required": true,
"define_type": "system",
"is_extend": false,
"is_single": false,
"index_name": "name",
"max_length": 256,
"is_index": true,
"is_active": true,
"create_time": 1595321768388,
"label": "批次编号",
"is_need_convert": false,
"api_name": "name",
"is_index_field": false
},
"owner_department": {
"describe_api_name": "BatchObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595321768388,
"pattern": "",
"is_unique": false,
"label": "负责人所在部门",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "owner_department",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "owner_dept",
"max_length": 256
},
"_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": 1595321768433
},
"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": 1595321768433
},
"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": 1595321768433
},
"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": 1595321768433
},
"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": 1595321768433
},
"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": 1595321768433
},
"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": 1595321768433
},
"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": 1595321768433,
"config": {
"display": 0
}
},
"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": 1595321768433
},
"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": 1595321768433
},
"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": 1595321768433
}
},
"api_name": "BatchObj"
},
"detailObjectDescribeList": []
},
"traceId": "E-O.80736.1000-f19091714e634634-00224"
}请求参数
Body 参数application/json
返回响应
扫码加入交流群