文档首页/ 工单管理/ API参考/ API v2（推荐）/ 协议管理/ 签署协议
更新时间：2023-12-18 GMT+08:00
查看PDF
分享

签署协议

功能介绍

签署协议

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/servicerequest/agreements/{id}/signed

表1 路径参数

参数

是否必选

参数类型

描述

id

是

Integer

协议id

最小值：1

最大值：32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：1

最大长度：5000

X-Language

否

String

语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。

会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。

最小长度：1

最大长度：32

X-Time-Zone

否

String

环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。

涉及时间的数据会根据环境时区处理。

最小长度：1

最大长度：32
表3 请求Body参数

参数

是否必选

参数类型

描述

relation_id

否

String

关联id

最小长度：1

最大长度：32

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

agreement_signed_record_id

Integer

签署记录id

最小值：0

最大值：2147483647

请求示例

GET https://{endpoint}/v2/servicerequest/agreements/0/signed

{
  "relation_id" : "relationId"
}

响应示例

状态码： 200

成功返回200

{
  "agreement_signed_record_id" : "1"
}

状态码

状态码

描述

200

成功返回200

错误码

请参见错误码。

父主题： 协议管理

相关文档