3.7 合同正文及附件下载

test-测试环境

https://oc-test.onecontract-cloud.com

POST

/api/hitf/v2p/rest/invoke/SFpFUk86T1JDSEVTVFJBVElPTjpISVRGLkFQSS5EQVRBX1FVRVJZ

使用场景：下载合同正文和附件，返回 zip 格式压缩包

请求参数

Query 参数

domain

string

必需

合同正文/附件批量下载接口固定编码

示例值:

CONTRACT_FILE

userIdType

string

必需

userId类型，userIdType=EMAIL时填邮箱，userIdType=USERID时填合同系统的USERID，userIdType=LOGINNAME时填合同系统的登录名

示例值:

LOGINNAME

userId

string

必需

userId，LOGINNAME 登录账号, EMAIL 邮箱, USERID 合同系统用户ID

示例值:

zhenling_openapi_admin

Header 参数

Authorization

string

可选

默认值:

Body 参数application/json

fileType

enum<string>

文件类型

可选

DOCUMENT 正文、ATTACHMENT 附件
不传时默认下载正文和附件

枚举值:

DOCUMENTATTACHMENT

zipFileName

string

压缩文件名称

可选

默认为：租户ID_合同文件_yyyyMMddhhmiss

page

integer

页数

必需

size

integer

页码

必需

startTime

string

最后更新时间从

必需

endTime

string

最后更新时间至

必需

condition

object

查询条件

必需

contractSerialNumber

string

合同流水号

必需

contractNumber

string

合同编码

必需

contractName

string

合同名称

必需

contractStatusCode

string

合同状态编码

必需

示例

{
    "fileType": "",
    "zipFileName": "",
    "page": 1,
    "size": 10,
    "startTime": "2025-04-01 00:00:00",
    "endTime": "2025-04-30 00:00:00",
    "condition": {
        "contractSerialNumber": "202504100002"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://oc-test.onecontract-cloud.com/api/hitf/v2p/rest/invoke/SFpFUk86T1JDSEVTVFJBVElPTjpISVRGLkFQSS5EQVRBX1FVRVJZ?domain=CONTRACT_FILE&userIdType=LOGINNAME&userId=zhenling_openapi_admin' \
--header 'Authorization: bearer eb2446a6-93f9-456b-b713-5cb6f6adf765' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileType": "",
    "zipFileName": "",
    "page": 1,
    "size": 10,
    "startTime": "2025-04-01 00:00:00",
    "endTime": "2025-04-30 00:00:00",
    "condition": {
        "contractSerialNumber": "202504100002"
    }
}'

返回响应

🟢200成功

application/json

Body

message

string

接口响应信息

必需

result

object

接口响应结果

必需

errcode

string

业务错误编码

必需

0代表处理成功

errmsg

string

业务错误信息

必需

data

object

业务错误数据

必需

success

boolean

接口响应是否成功

必需

示例

成功示例成功示例

{
    "message": "execute success",
    "result": {
        "errcode": "0",
        "errmsg": "ok",
        "data": {
            "totalElements": "1",
            "content": {
                "md5": "d23e34a80b8fec2feba7f2c50510ad06",
                "fileKey": "hcbm-contract/1273/HUAWEI_CLOUD/2025Y/04M/762892fce72049a8bcba985a0d07a8c2@1273_合同文件_20250425143954.zip",
                "fileTokenUrl": "https://test-oc-huawei-main.obs.cn-east-3.myhuaweicloud.com:443/hcbm-contract/1273/HUAWEI_CLOUD/2025Y/04M/762892fce72049a8bcba985a0d07a8c2%401273_%E5%90%88%E5%90%8C%E6%96%87%E4%BB%B6_20250425143954.zip?AccessKeyId=0CGQEHUIGV7NTURNNSHX&Expires=1745563495&response-cache-control=must-revalidate%2C+post-check%3D0%2C+pre-check%3D0&response-content-disposition=attachment%3Bfilename%3D1273_%25E5%2590%2588%25E5%2590%258C%25E6%2596%2587%25E4%25BB%25B6_20250425143954.zip&response-expires=1745563196243&Signature=zGBiLjfKRJjl8jgqToeIM5%2BJ0E8%3D"
            }
        }
    },
    "success": true
}

3.6 模板变量查询

3.11 通过fileKey下载文件