获取退款对象描述接口

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

响应示例

{
    "traceId": "E-O.fktest188.1453-5f12e5f7de6c4c8f",
    "data": {
        "describe": {
            "api_name": "RefundObj",
            "display_name_r": "退款",
            "fields": {
                "lock_rule": {
                    "describe_api_name": "RefundObj",
                    "is_index": false,
                    "is_active": true,
                    "create_time": 1560615279540,
                    "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,
                    "label_r": "锁定规则",
                    "index_name": "s_5"
                },
                "UDAttach1__c": {
                    "describe_api_name": "RefundObj",
                    "file_amount_limit": 10,
                    "is_index": true,
                    "is_active": true,
                    "create_time": 1559275000333,
                    "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_4",
                    "support_file_types": []
                },
                "refunded_time": {
                    "describe_api_name": "RefundObj",
                    "is_index": true,
                    "is_active": true,
                    "create_time": 1559275000342,
                    "description": "退款日期",
                    "is_unique": false,
                    "label": "退款日期",
                    "time_zone": "GMT+8",
                    "type": "date",
                    "is_need_convert": false,
                    "is_required": false,
                    "api_name": "refunded_time",
                    "define_type": "package",
                    "date_format": "yyyy-MM-dd",
                    "is_index_field": false,
                    "is_single": false,
                    "label_r": "退款日期",
                    "config": {
                        "edit": 1,
                        "attrs": {
                            "is_required": 0,
                            "default_value": 1,
                            "label": 1,
                            "help_text": 1
                        }
                    },
                    "index_name": "l_2"
                },
                "extend_obj_data_id": {
                    "describe_api_name": "RefundObj",
                    "default_is_expression": false,
                    "is_index": false,
                    "is_active": true,
                    "create_time": 1523348160931,
                    "pattern": "",
                    "description": "extend_obj_data_id",
                    "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,
                    "help_text": ""
                },
                "UDMoney1__c": {
                    "describe_api_name": "RefundObj",
                    "is_index": true,
                    "is_active": true,
                    "create_time": 1559275000343,
                    "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,
                    "index_name": "d_5"

修改于 2022-02-22 08:00:06

创建退款对象

修改子产品分组对象信息