探马OpenAPI

保存合同字段映射

POST

/api/v3/push-field-mapping/save

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

infoCategory

integer

类别

必需

4：合同

fieldMappings

array [object {3}]

映射字段集合

必需

alias

string

调用方映射的字段别名

必需

desc

string

字段描述

可选

fieldId

number

探马中字段id

必需

通过 “合同扩展字段” 接口查询

示例

{
  "infoCategory": 4,
  "fieldMappings": [
    {
      "alias": "合同类型",
      "desc": "合同类型",
      "fieldId": 3233
    },
    {
      "alias": "合同开始日期",
      "desc": "合同开始日期",
      "fieldId": 3229
    },
    {
      "alias": "合同结束日期",
      "desc": "合同结束日期",
      "fieldId": 3230
    },
    {
      "alias": "多选项",
      "desc": "多选项",
      "fieldId": 3468
    },
    {
      "alias": "合同状态",
      "desc": "合同状态",
      "fieldId": 3227
    },
    {
      "alias": "合同附件",
      "desc": "合同附件",
      "fieldId": 3235
    },
    {
      "alias": "合同签约日期",
      "desc": "合同签约日期",
      "fieldId": 3228
    },
    {
      "alias": "客方签约人",
      "desc": "客方签约人",
      "fieldId": 3231
    },
    {
      "alias": "我方签约人",
      "desc": "我方签约人",
      "fieldId": 3232
    },
    {
      "alias": "付款方式",
      "desc": "付款方式",
      "fieldId": 3234
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v3/push-field-mapping/save' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "infoCategory": 4,
    "fieldMappings": [
        {
            "alias": "合同类型",
            "desc": "合同类型",
            "fieldId": 3233
        },
        {
            "alias": "合同开始日期",
            "desc": "合同开始日期",
            "fieldId": 3229
        },
        {
            "alias": "合同结束日期",
            "desc": "合同结束日期",
            "fieldId": 3230
        },
        {
            "alias": "多选项",
            "desc": "多选项",
            "fieldId": 3468
        },
        {
            "alias": "合同状态",
            "desc": "合同状态",
            "fieldId": 3227
        },
        {
            "alias": "合同附件",
            "desc": "合同附件",
            "fieldId": 3235
        },
        {
            "alias": "合同签约日期",
            "desc": "合同签约日期",
            "fieldId": 3228
        },
        {
            "alias": "客方签约人",
            "desc": "客方签约人",
            "fieldId": 3231
        },
        {
            "alias": "我方签约人",
            "desc": "我方签约人",
            "fieldId": 3232
        },
        {
            "alias": "付款方式",
            "desc": "付款方式",
            "fieldId": 3234
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

message

string

状态描述

必需

示例

{
  "code": 0,
  "message": "success"
}

必读说明

获取合同和回款单自定义字段