获取订单产品对象描述接口
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": "SalesOrderProductObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-a0477df5300941e3",
"data": {
"describe": {
"icon_index": 0,
"api_name": "SalesOrderProductObj",
"icon_path": "",
"display_name_r": "订单产品",
"fields": {
"lock_rule": {
"describe_api_name": "SalesOrderProductObj",
"is_index": false,
"is_active": true,
"create_time": 1563530279070,
"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_4"
},
"price_book_product_id": {
"describe_api_name": "SalesOrderProductObj",
"is_index": true,
"is_active": false,
"create_time": 1559275875115,
"description": "价目表明细",
"is_unique": false,
"label": "价目表明细",
"target_api_name": "PriceBookProductObj",
"type": "object_reference",
"target_related_list_name": "pricebookproduct_salesorderproduct_list",
"target_related_list_label": "订单产品",
"action_on_target_delete": "cascade_delete",
"is_need_convert": false,
"is_required": true,
"wheres": [
{
"connector": "OR",
"filters": [
{
"value_type": 0,
"operator": "EQ",
"field_name": "product_status",
"field_values": [
"1"
]
}
]
}
],
"api_name": "price_book_product_id",
"define_type": "package",
"is_single": false,
"label_r": "价目表明细",
"is_index_field": false,
"index_name": "s_7",
"config": {
"edit": 1,
"enable": 0,
"display": 0,
"attrs": {
"target_related_list_label": 1,
"wheres": 1,
"is_required": 0,
"default_value": 0,
"label": 1,
"help_text": 1
}
}
},
"discount": {
"describe_api_name": "SalesOrderProductObj",
"default_is_expression": false,
"pattern": "",
"description": "折扣",
"is_unique": false,
"type": "percentile",
"default_to_zero": true,
"is_required": false,
"define_type": "package",
"is_single": false,
"label_r": "折扣",
"index_name": "d_3",
"max_length": 100,
"is_index": false,
"is_active": true,
"create_time": 1559275875115,
"default_value": "100",
"label": "折扣",
"is_need_convert": false,
"api_name": "discount",
"is_index_field": false,
"config": {
"add": 0,
"edit": 1,
"enable": 1,
"display": 1,
"remove": 0,
"attrs": {
"is_required": 1,
"api_name": 0,
"is_unique": 0,
"default_value": 1,
"label": 1,
"help_text": 1
}
},
"help_text": ""
},
"product_price": {
"describe_api_name": "SalesOrderProductObj",
"default_is_expression": false,
"description": "价格（元）",
"is_uniqu请求参数
Body 参数application/json
返回响应
扫码加入交流群修改于 2022-02-21 08:16:56