获取产品对象描述接口

POST

https://open.fxiaoke.com/cgi/crm/v2/object/describe

接口说明：获取产品对象的表结构、数据类型等信息。关于此接口的详细介绍请参见description接口说明。接口说明。

此接口对应的返回值即为对象相关字段信息(非字段值)，详情见description接口说明。返回错误代码请参见。全局返回错误码

请求参数

Body 参数application/json

示例

返回响应

🟢200成功

application/json

Body

请求示例

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": "ProductObj"
}'

响应示例

{
    "traceId": "E-O.fktest188.1453-1fd5889b86d34a9f",
    "data": {
        "describe": {
            "icon_index": 0,
            "api_name": "ProductObj",
            "icon_path": "",
            "display_name_r": "产品",
            "fields": {
                "lock_rule": {
                    "describe_api_name": "ProductObj",
                    "is_index": false,
                    "is_active": true,
                    "create_time": 1571974596627,
                    "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_10"
                },
                "off_shelves_time": {
                    "describe_api_name": "ProductObj",
                    "default_is_expression": false,
                    "description": "下架时间",
                    "is_unique": false,
                    "type": "date_time",
                    "default_to_zero": false,
                    "is_required": false,
                    "define_type": "package",
                    "is_extend": false,
                    "is_single": false,
                    "label_r": "下架时间",
                    "index_name": "l_1",
                    "is_index": true,
                    "is_active": true,
                    "create_time": 1544085256633,
                    "default_value": "",
                    "label": "下架时间",
                    "time_zone": "GMT+8",
                    "is_need_convert": false,
                    "api_name": "off_shelves_time",
                    "date_format": "yyyy-MM-dd HH:mm",
                    "is_index_field": false,
                    "config": {
                        "add": 0,
                        "edit": 1,
                        "enable": 1,
                        "display": 1,
                        "remove": 0,
                        "attrs": {
                            "api_name": 0,
                            "is_unique": 0,
                            "default_value": 0,
                            "label": 0,
                            "help_text": 0
                        }
                    },
                    "help_text": ""
                },
                "extend_obj_data_id": {
                    "describe_api_name": "ProductObj",
                    "default_is_expression": false,
                    "is_index": false,
                    "is_active": true,
                    "create_time": 1544085256633,
                    "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",
                    "is_extend": false,
                    "is_single": false,
                    "label_r": "extend_obj_data_id",
                    "is_index_field": false,
                    "index_name": "t_2",
                    "max_length": 100
                },
                "price": {
                    "describe_api_name": "ProductObj",
                    "default_is_expression": true,
                    "description": "价格(元)",
                    "is_unique": false,
                    "type": "currency",
                    "decimal_places": 2,
                    "default_to_zero": true,
                    "is_required": true,
                    "define_type": "package",
                    "is_single": false,
                    "label_r": "价格",
                    "index_name": "d_2",
                    "is_index": true,
                    "is_active": true,
                    "create_time": 1547984200176,
                    "length": 14,
                    "default_value": "0",
                    "label": "价格(元)",
                    "currency_unit": "￥",
                    "is_need_convert": false,
                    "api_name": "price",
                    "is_index_field": false,
                    "config": {
                        "add": 0,
                        "edit": 0,
                        "enable": 0,
                        "display": 1,
                        "remove": 0,
                        "attrs": {
                            "api_name": 0,
                            "is_unique": 0,
                            "default_value": 0,
                            "label": 0,

修改于 2022-01-26 10:17:33

变更产品对象的负责人

修改产品单位对象信息