更新时间:2024-07-15 GMT+08:00
分享

查询环节内容

功能介绍

查询环节内容

URI

POST /v1/{project_id}/trace/trace-sweepcode/batch-link/query-content

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户从IAM申请到的projectid,一般为32位字符串

最小长度:32

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token

最小长度:1

最大长度:65535

表3 请求Body参数

参数

是否必选

参数类型

描述

merchant

String

商户ID

最小长度:1

最大长度:100

linkName

String

环节名称

最小长度:1

最大长度:20

batchCode

String

批次码

最小长度:1

最大长度:100

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

code

String

返回码

message

String

响应内容

data

Array of data objects

环节内容详情

表5 data

参数

参数类型

描述

contentId

String

环节内容ID

最小长度:1

最大长度:100

contentName

String

溯源内容名称

最小长度:1

最大长度:100

contentType

String

溯源内容类型(0.图片、1.PDF、2.文本)

枚举值:

  • 0

  • 1

  • 2

contentText

String

对于文本,直接存储文本内容

最小长度:1

最大长度:250

contentUrl

String

对于图片、PDF等存储url

最小长度:1

最大长度:250

sweepCodeDisplay

String

扫码展示方式:0 不展示,1 展示

枚举值:

  • 0

  • 1

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:100

error_msg

String

错误描述

最小长度:1

最大长度:100

请求示例

{
  "merchant" : "1748189792481312769",
  "linkName" : "清风",
  "batchCode" : "962cc65f20674ebeb67b765f83bcaa24"
}

响应示例

状态码: 200

Success

{
  "code" : "200",
  "message" : "操作成功!",
  "data" : [ {
    "contentId" : 1496395806648717300,
    "contentName" : "测试",
    "contentType" : "0",
    "contentText" : "",
    "contentUrl" : "https://xxx.xxx.xxx.xxx",
    "sweepCodeDisplay" : "0"
  } ]
}

状态码: 500

Error response

{
  "code" : "500",
  "message" : "系统异常"
}

状态码

状态码

描述

200

Success

500

Error response

相关文档