调用GetOrderBaseInfo获取工单基本信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dms:GetOrderBaseInfo |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Tid |
integer |
否 |
租户 ID。 说明
取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息。 |
-1 |
| OrderId |
integer |
是 |
工单 ID。 |
12345 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| OrderBaseInfo |
object |
工单基本信息。 |
|
| RelatedUserNickList |
object |
||
| UserNicks |
array |
工单相关人昵称列表。 |
|
|
string |
工单相关人昵称。 |
nickname |
|
| Comment |
string |
备注信息。 |
test |
| CreateTime |
string |
工单创建时间。 |
2019-10-10 00:00:00 |
| Committer |
string |
提交者。 |
xxx |
| WorkflowInstanceId |
integer |
审批流 ID。 |
1 |
| CommitterId |
integer |
提交者 ID,注意不是提交者的阿里云 UID。 |
1 |
| LastModifyTime |
string |
工单最后修改时间。 |
2019-10-10 00:00:00 |
| StatusCode |
string |
工单状态码,取值如下:
|
success |
| RelatedUserList |
object |
||
| UserIds |
array |
工单相关人 ID 列表。 |
|
|
string |
工单相关人 ID。 |
1 |
|
| WorkflowStatusDesc |
string |
审批描述信息。 |
approved |
| StatusDesc |
string |
状态描述信息。 |
success |
| PluginType |
string |
工单类型。取值及说明可参考 CreateOrder 接口的相应入参说明。 |
DC_COMMON |
| OrderId |
integer |
工单号。 |
12345 |
| AttachmentKey |
string |
工单附件 Key。仅当工单创建时上传了附件,才会返回此信息。 |
upload_order_info_856887_f356366f-f0f8-42fc-ba57-4a509303e814_18072d8a9bce876e3073bc655c2865f.png |
| OriginAttachmentName |
string |
工单附件原始文件名。仅当工单创建时上传了附件,才会返回此信息。 |
18072d8a9bce876e3073bc655c2865f.png |
| RequestId |
string |
请求 ID。 |
7133DF67-5B25-460F-8285-C4CC93472C2F |
| ErrorCode |
string |
错误码。 |
UnknownError |
| ErrorMessage |
string |
错误信息。 |
UnknownError |
| Success |
boolean |
请求是否成功。 |
true |
示例
正常返回示例
JSON格式
{
"OrderBaseInfo": {
"RelatedUserNickList": {
"UserNicks": [
"nickname"
]
},
"Comment": "test",
"CreateTime": "2019-10-10 00:00:00",
"Committer": "xxx",
"WorkflowInstanceId": 1,
"CommitterId": 1,
"LastModifyTime": "2019-10-10 00:00:00",
"StatusCode": "success",
"RelatedUserList": {
"UserIds": [
"1"
]
},
"WorkflowStatusDesc": "approved",
"StatusDesc": "success",
"PluginType": "DC_COMMON",
"OrderId": 12345,
"AttachmentKey": "upload_order_info_856887_f356366f-f0f8-42fc-ba57-4a509303e814_18072d8a9bce876e3073bc655c2865f.png",
"OriginAttachmentName": "18072d8a9bce876e3073bc655c2865f.png"
},
"RequestId": "7133DF67-5B25-460F-8285-C4CC93472C2F",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。