获取退货单对象描述接口
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": "ReturnedGoodsInvoiceObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-a0cf004155d64419",
"data": {
"describe": {
"api_name": "ReturnedGoodsInvoiceObj",
"display_name_r": "退货单",
"fields": {
"lock_rule": {
"describe_api_name": "ReturnedGoodsInvoiceObj",
"is_index": true,
"is_active": true,
"create_time": 1560615281826,
"description": "锁定规则",
"is_unique": false,
"rules": [],
"default_value": "default_lock_rule",
"label": "锁定规则",
"type": "lock_rule",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_rule",
"define_type": "package",
"is_extend": false,
"is_single": false,
"is_index_field": false,
"index_name": "s_4",
"help_text": "锁定规则"
},
"current_level": {
"describe_api_name": "ReturnedGoodsInvoiceObj",
"default_is_expression": false,
"is_index": false,
"is_active": false,
"create_time": 1560615281826,
"length": 14,
"is_unique": false,
"default_value": "0",
"label": "已审批节点数量",
"type": "number",
"decimal_places": 0,
"default_to_zero": true,
"is_need_convert": false,
"is_required": false,
"api_name": "current_level",
"define_type": "system",
"is_single": false,
"is_index_field": false,
"index_name": "d_1",
"config": {
"edit": 0,
"enable": 0,
"display": 0,
"help_text": 1
},
"round_mode": 4,
"max_length": 14
},
"UDAttach1__c": {
"describe_api_name": "ReturnedGoodsInvoiceObj",
"file_amount_limit": 10,
"is_index": true,
"is_active": true,
"create_time": 1559302077231,
"description": "自定义附件",
"is_unique": false,
"label": "自定义附件",
"type": "file_attachment",
"field_num": 356,
"file_size_limit": 10485760,
"is_need_convert": false,
"is_required": false,
"api_name": "UDAttach1__c",
"define_type": "custom",
"is_extend": true,
"is_index_field": false,
"is_single": false,
"index_name": "a_3",
"support_file_types": []
},
"extend_obj_data_id": {
"describe_api_name": "ReturnedGoodsInvoiceObj",
"default_is_expression": false,
"is_index": false,
"is_active": true,
"create_time": 1523348161439,
"pattern": "",
"is_unique": false,
"default_value": "",
"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": "system",
"is_extend": false,
"is_single": false,
"is_index_field": false,
"index_name": "t_1",
"max_length": 200
},
"UDMoney1__c": {
"describe_api_name": "ReturnedGoodsInvoiceObj",
"is_index": true,
"is_active": true,
"create_time": 1559302077239,
"length": 14,
"description": "自定义金额",
"is_unique": false,
"label": "自定义金额",
"type": "currency",
"currency_unit": "￥",
"decimal_places": 2,
"field_num": 141,
"is_need_convert": false,
"is_required": false,
"api_name": "UDMoney1__c",
"define_type": "custom",
"is_extend": true,
"is_single": false,
"is_index_field": false,
请求参数
Body 参数application/json
返回响应
扫码加入交流群