获取采购订单对象描述接口

POST

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

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

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

请求示例

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

响应示例

{
    "traceId": "E-O.fktest188.1453-7323917784854c7b",
    "data": {
        "describe": {
            "created_by": "1453",
            "icon_index": 15,
            "api_name": "PurchaseOrderObj",
            "fields": {
                "lock_rule": {
                    "describe_api_name": "PurchaseOrderObj",
                    "is_index": false,
                    "is_active": true,
                    "create_time": 1614223920581,
                    "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"
                },
                "data_own_organization": {
                    "describe_api_name": "PurchaseOrderObj",
                    "is_index": true,
                    "is_active": true,
                    "create_time": 1614223920594,
                    "is_unique": false,
                    "label": "归属组织",
                    "type": "department",
                    "is_need_convert": false,
                    "is_required": false,
                    "api_name": "data_own_organization",
                    "define_type": "package",
                    "is_index_field": false,
                    "is_single": true,
                    "index_name": "a_1"
                },
                "discount": {
                    "describe_api_name": "PurchaseOrderObj",
                    "is_index": false,
                    "is_active": true,
                    "create_time": 1614223920574,
                    "is_unique": false,
                    "default_value": "100",
                    "label": "整单折扣",
                    "type": "percentile",
                    "is_need_convert": false,
                    "is_required": false,
                    "api_name": "discount",
                    "define_type": "package",
                    "is_extend": false,
                    "is_index_field": false,
                    "is_single": false,
                    "label_r": "整单折扣",
                    "index_name": "d_2"
                },
                "remark": {
                    "describe_api_name": "PurchaseOrderObj",
                    "is_index": false,
                    "is_active": true,
                    "create_time": 1614223920576,
                    "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,
                    "label_r": "备注",
                    "index_name": "t_1",
                    "max_length": 1000
                },
                "lock_user": {
                    "describe_api_name": "PurchaseOrderObj",
                    "is_index": false,
                    "is_active": true,
                    "create_time": 1614223920581,
                    "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_2"
                },
                "extend_obj_data_id": {
                    "describe_api_name": "PurchaseOrderObj",
                    "default_is_expression": false,
                    "is_index": true,
                    "is_active": true,
                    "create_time": 1614223920578,
                    "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_single": false,
                    "is_index_field": false,
                    "index_name": "t_2",
                    "max_length": 256
                },
                "is_deleted": {
                    "describe_api_name": "PurchaseOrderObj",

请求参数

Body 参数application/json

corpAccessToken

string

必需

企业应用访问公司合法性凭证

corpId

string

企业ID

必需

currentOpenUserId

string

必需

当前操作人OpenUserID

includeDetail

boolean

可选

是否包含从对象描述信息

apiName

string

必需

对象的api_name

示例

返回响应

🟢200成功

application/json

Body

traceId

string

必需

data

object

接口返回数据

必需

describe

object

必需

detailObjectDescribeList

array [object {6}]

必需

errorDescription

string

必需

对返回码的文本描述内容

errorMessage

string

必需

对返回码的文本描述内容

errorCode

integer

返回码

必需

变更采购订单对象的负责人

根据条件查询退货单关联的产品对象的列表