链接复制成功!
查看最新发布版本协议详情
功能介绍
查看最新发布版本协议详情
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/servicerequest/agreements/published-agreement
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
agreement_type |
否 |
String |
协议类型,0 新建工单-普通用户,1 新建工单-ISV用户,2 授权 最小长度:1 最大长度:32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
case_agreement |
AgreementVO object |
协议信息 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
协议id 最小长度:1 最大长度:11 |
agreement_name |
String |
协议名称 最小长度:1 最大长度:128 |
agreement_type |
String |
协议类型,0 新建工单-普通用户,1 新建工单-ISV用户,2 授权 最小长度:1 最大长度:32 |
agreement_type_name |
String |
协议类型名称 最小长度:1 最大长度:128 |
content |
String |
内容 最小长度:1 最大长度:2147483647 |
version |
Integer |
版本 最小值:0 最大值:2147483647 |
请求示例
GET https://{endpoint}/v2/servicerequest/agreements/published-agreement?agreement_type=5 null
响应示例
状态码: 200
成功返回200
{
"case_agreement" : {
"id" : "123",
"agreement_name" : "新建工单",
"agreement_type" : "0",
"agreement_type_name" : "新建工单",
"content" : "content",
"version" : "1.0.0"
}
}
状态码
状态码 |
描述 |
---|---|
200 |
成功返回200 |
错误码
请参见错误码。