调用GetOrderBaseInfo获取工单基本信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetOrderBaseInfo |
系统规定参数。取值:GetOrderBaseInfo。 |
OrderId | Long | 是 | 12345 |
工单ID。 |
Tid | Long | 是 | -1 |
租户ID。 说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息。
|
RegionId | String | 否 | cn-hangzhou |
Region化API请求参数。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorCode | String | UnknownError |
错误码。 |
ErrorMessage | String | UnknownError |
错误信息。 |
OrderBaseInfo | Struct |
工单基本信息。 |
|
Comment | String | test |
备注信息。 |
Committer | String | xxx |
提交者。 |
CommitterId | Long | 1 |
提交者ID,注意不是提交者的阿里云UID。 |
CreateTime | String | 2019-10-10 00:00:00 |
工单创建时间。 |
LastModifyTime | String | 2019-10-10 00:00:00 |
工单最后修改时间。 |
OrderId | Long | 12345 |
工单号。 |
PluginType | String | DC_COMMON |
工单类型,取值和说明参考CreateOrder接口相对应入参说明。 |
RelatedUserList | List | 1,2,3 |
工单相关人ID列表。 |
RelatedUserNickList | List | a,b,c |
工单相关人昵称列表。 |
StatusCode | String | success |
工单状态码,取值和说明如下:
|
StatusDesc | String | success |
状态描述信息。 |
WorkflowInstanceId | Long | 1 |
审批流ID。 |
WorkflowStatusDesc | String | approved |
审批描述信息。 |
RequestId | String | 7133DF67-5B25-460F-8285-C4CC93472C2F |
请求ID。 |
Success | Boolean | true |
请求是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetOrderBaseInfo
&OrderId=12345
&Tid=-1
&<公共请求参数>
正常返回示例
XML
格式
<OrderBaseInfo>
<Comment>test</Comment>
<CreateTime>2019-10-10 00:00:00</CreateTime>
<LastModifyTime>2019-10-10 00:00:00</LastModifyTime>
<OrderId>12345</OrderId>
<CommitterId>1</CommitterId>
<PluginType>DC_COMMON</PluginType>
<StatusCode>success</StatusCode>
<RelatedUserNickList>
<UserNicks>a,b,c</UserNicks>
</RelatedUserNickList>
<StatusDesc>success</StatusDesc>
<WorkflowStatusDesc>approved</WorkflowStatusDesc>
<WorkflowInstanceId>1</WorkflowInstanceId>
<Committer>xxx</Committer>
<RelatedUserList>
<UserIds>1,2,3</UserIds>
</RelatedUserList>
</OrderBaseInfo>
<RequestId>7133DF67-5B25-460F-8285-C4CC93472C2F</RequestId>
<ErrorCode>UnknownError</ErrorCode>
<ErrorMessage>UnknownError</ErrorMessage>
<Success>true</Success>
JSON
格式
{"OrderBaseInfo":{"Comment":"test","CreateTime":"2019-10-10 00:00:00","LastModifyTime":"2019-10-10 00:00:00","OrderId":"12345","CommitterId":"1","PluginType":"DC_COMMON","StatusCode":"success","RelatedUserNickList":{"UserNicks":"a,b,c"},"StatusDesc":"success","WorkflowStatusDesc":"approved","WorkflowInstanceId":"1","Committer":"xxx","RelatedUserList":{"UserIds":"1,2,3"}},"RequestId":"7133DF67-5B25-460F-8285-C4CC93472C2F","ErrorCode":"UnknownError","ErrorMessage":"UnknownError","Success":"true"}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交