3.4 合同文件上传

test-测试环境

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

POST

/api/hitf/v2p/rest/invoke/SFpFUk86QkFTRTpvYy1iYXNlLmhjYm0tc291cmNlLWNvbnRyYWN0LW9yZy51cGxvYWRGaWxl

上传合同正文、合同附件，每次只能上传一个文件
提供该接口支持的文件类型

正文类型文件支持格式：docx、doc、pdf、xlsx、xls

附件类型文件支持格式：zip、rar、doc、docx、pdf、xlsx、jpg、jpeg、png、bmp
文件名称不能包含以下特殊字符：%,+,\r,\n,&,?

请求参数

Header 参数

Content-Type

string

可选

示例值:

multipart/form-data

Authorization

string

可选

默认值:

Body 参数multipart/form-data

fileType

enum<string>

必需

文件类型，当导入的合同为归档状态的合同时，可以通过ARCHIVE类型的文件创建归档数据

枚举值:

DOCUMENTATTACHMENTARCHIVE

示例值:

DOCUMENT

sourceSystem

string

来源系统代码

必需

示例值:

oms

sourceDocumentNumber

string

必需

来源单据号,指创建合同时提供的来源单据号，一般为您内部系统中的合同编号. 需和创建合同API中的 sourceCode 字段保持一致

示例值:

DEMO_20250101007

fileName

string

必需

文件名称，必须为包含文件后缀的完整文件名称，如：demo.pdf

示例值:

示例合同.docx

file

文件对象

必需

示例值:

file:///Users/cyj/Desktop/空白合同.docx

needSignature

boolean

可选

附件是否需要签署,默认true

示例值:

true

needArchive

boolean

可选

附件是否需要归档,默认true

示例值:

true

attachmentType

string

可选

默认 default，参考数据字典：
311-ATTACHMENT_TYPE

fileKey

string

可选

fileKey和file两者选其一，可先通过「3.15 通用附件上传」上传文件获取 fileKey

示例代码

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/SFpFUk86QkFTRTpvYy1iYXNlLmhjYm0tc291cmNlLWNvbnRyYWN0LW9yZy51cGxvYWRGaWxl' \
--header 'Authorization: bearer eb2446a6-93f9-456b-b713-5cb6f6adf765' \
--header 'Content-Type: multipart/form-data' \
--form 'fileType="DOCUMENT"' \
--form 'sourceSystem="oms"' \
--form 'sourceDocumentNumber="DEMO_20250101007"' \
--form 'fileName="示例合同.docx"' \
--form 'file=@"/Users/cyj/Desktop/空白合同.docx"' \
--form 'needSignature="true"' \
--form 'needArchive="true"' \
--form 'attachmentType=""' \
--form 'fileKey=""'

返回响应

🟢200成功

application/json

Body

success

boolean

必需

message

string

必需

result

object

必需

errcode

string

必需

errmsg

string

必需

data

object

必需

示例

{
    "success": true,
    "message": "execute success",
    "result": {
        "errcode": "0",
        "errmsg": "上传成功",
        "data": {
            "objectVersionNumber": 1,
            "_token": "1UtcMtQqTmSqd+Hcz0TAHfrtoAuUdnULJrnllH4afAGzJip5h/yhuH2e/GMBawwF5OinWMvgLMov3IRmeP8Wng==",
            "id": 6716,
            "sourceSystem": "oms",
            "sourceDocumentNumber": "DEMO_20250101001",
            "fileType": "DOCUMENT",
            "fileName": "示例合同.docx",
            "fileKey": "hcbm-contract/source-contract-file/1273/HUAWEI_CLOUD/2025Y/04M/583aa1ce2c424ecb8b1ca28fa1f56b4e@示例合同.docx",
            "tenantId": 1273,
            "needSignature": true,
            "needArchive": true,
            "attachmentType": ""
        }
    }
}

3.19 查询合同是否存在在途的变更

3.5 获取文件预览链接