查询文件必填项填写详情

描述

支持查询草稿或拟定中状态文件必填项的填写详情，有必填项未填写时，返回具体的文档id与必填项参数名。

请求地址

/v2/contract/required/detail

请求方法

POST

请求格式

application/json;charset=UTF-8

请求参数

Y：必填 N：非必填 CY：条件必填，即其他参数的输入情况会影响当前参数是否必填（具体逻辑参照各参数的描述）

参数	类型	是否必传	长度	描述	示例
contractId	String	CY	19	合同ID，合同ID与业务ID二选一，不能同时为空	2931411786447082239
bizId	String	CY	50	业务ID，合同ID与业务ID二选一，不能同时为空	6331411786447082982
tenantName	String	CY	100	子公司名称，若使用业务ID查询合同详情，且合同是以子公司身份创建的，则需要传递该值，用于确定合同主体	阿里巴巴子公司

返回参数

参数	类型	长度	描述
responseCode	Integer		响应码
message	String	200	响应消息
result	RequiredParam		返回数据

RequiredParam（返回数据）：

参数	类型	描述
sponsorComplete	Boolean	发起方是否填参完成
data	Array[Document]	必填参数未填写集合

Document （文档）：

参数	类型	描述
id	String	文档ID
title	String	文档标题
params	Array[Param]	文档参数集合

Param （参数）：

参数	类型	描述
id	String	参数ID
name	String	参数名称
signatoryId	String	签署方ID
signatoryName	String	签署方名称

请求示例

Http示例


POST /v2/contract/required/detail HTTP/1.1
Host: [host]
x-qys-open-timestamp: [替换为请求头生成的Timestamp]
x-qys-open-signature: [替换为请求头生成的Signature]
x-qys-open-accesstoken: [替换为请求头生成的Token]
Content-Type: application/json
Content-Length: 45
{
    "contractId": "3119207966230716468"
}

Java示例


// 初始化sdkClient
String serverUrl = "https://openapi.qiyuesuo.cn";
String accessKey = "替换为您申请的开放平台App Token";
String accessSecret = "替换为您申请的开放平台App Secret";
SdkClient sdkClient = new SdkClient(serverUrl, accessKey, accessSecret);
// 获取必填参数数据集
SignParam signParam = new SignParam();
        signParam.setContractId(3119561132843475557L);
        RequiredParamListRequest request = new RequiredParamListRequest(signParam);
        String response = sdkClient.service(request);
        SdkResponse<RequiredParamgt; responseObj = JSONUtils.toQysResponse(response, RequiredParam.class);
if(responseObj.getCode() == 0) {
    RequiredParam result = responseObj.getResult();
    Boolean sponsorComplete = result.getSponsorComplete();
    List data = result.getData();
    logger.info("获取必填参数，发起方必填参数是否填写:{}, 数据集合 {}", sponsorComplete, data);
} else {
    logger.info("请求失败，错误码:{}，错误信息:{}", responseObj.getCode(), responseObj.getMessage());
}

C#示例


敬请期待

PHP示例


敬请期待

Python示例


敬请期待

Go示例


sdkClient := http.NewSdkClient("https://openapi.qiyuesuo.cn", "替换为您申请的开放平台App Token", "替换为您申请的开放平台App Secret")
req := request.RequiredParamListRequest{}
req.ContractId = "3121651562611475189"
response, err := sdkClient.Service(req)
if err != nil {
    fmt.Println("request failed,", err.Error())
    return
}
fmt.Println(response)