工单管理相关操作
创建工单(CreateTicket)
可以使用CreateTicket创建工单。
例如：
CreateTicket name=Cloud_Ticket requests='[{"requestName": "create vm","apiName": "org.zstack.header.vm.APICreateVmInstanceMsg","executeTimes":1,"apiBody": {"name": "vm name","instanceOfferingUuid": "46466abc6c8931fdaab7a8df43e4f175","imageUuid": "43e997234af63863b28a5e9987e1d122","l3NetworkUuids": ["ddd66c7ba30598cdc7ab835e04f96"],"hostUuid":"3c84aa23e55f42758485db459202bdc3"}}]' flowCollectionUuid=1c4db59a73b63f968889764bcb2bae9d accountSystemType=iam2 accountSystemContext='{"projectUuid": "28c9a199e3e842d28c9805eb89be56cb","virtualIDUuid": "1c255722caf34cb888b57d11a744248c"}'参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| name | 资源名称 | 3.0.0 | ||
| description | 资源的详细描述 | 是 | 3.0.0 | |
| requests | 3.0.0 | |||
| flowCollectionUuid | 是 | 3.0.0 | ||
| accountSystemType | 3.0.0 | |||
| accountSystemContext | 3.0.0 | |||
| resourceUuid | 是 | 3.0.0 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.0.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.0.0 | |
| timeout | 是 |
更新工单请求(UpdateTicketRequest)
可以使用UpdateTicketRequest更新工单请求。
例如：
UpdateTicketRequest uuid=b86c9016b4f24953a9edefb53ca0678c requests=requests='[{"requestName": "create vm","apiName": "org.zstack.header.vm.APICreateVmInstanceMsg","executeTimes":1,"apiBody": {"name": "vm name","instanceOfferingUuid": "46466abc6c8931fdaab7a8df43e4f175","imageUuid": "43e997234af63863b28a5e9987e1d122","l3NetworkUuids": ["ddd66c7ba30598cdc7ab835e04f96"],"hostUuid":"3c84aa23e55f42758485db459202bdc3"}}]'参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标示该资源 | 3.0.0 | ||
| requests | 3.0.0 | |||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.0.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.0.0 | |
| timeout | 是 |
修改工单状态(ChangeTicketStatus)
可以使用ChangeTicketStatus修改工单状态。
例如：
ChangeTicketStatus uuid= statusEvent=open comment=this is the comment for change status operation参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标示该资源 | 3.0.0 | ||
| statusEvent |
|
3.0.0 | ||
| comment | 备注 | 是 | 3.0.0 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.0.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.0.0 | |
| timeout | 是 |
查询工单(QueryTicket)
管理员可以使用QueryTicket查询工单。例如：
QueryTicket name=test Ticket原生域查询（Primitive Fields of Query）
查询归档的工单(QueryArchiveTicket)
管理员可以使用QueryArchiveTicket查询归档的工单。例如：
QueryArchiveTicket name=Ticket-1查询工单历史(QueryTicketHistory)
管理员可以使用QueryTicketHistory查询工单历史。例如：
QueryTicketHistory name=ZSatck创建工单流程(CreateIAM2TickFlowCollection)
可以使用CreateIAM2TickFlowCollection创建工单流程。
例如：
CreateIAM2TickFlowCollection name=ZStack projectUuid=1c4db59a73b63f968889764bcb2bae9d参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| flows | 是 | 3.0.0 | ||
| name | 资源名称 | 3.0.0 | ||
| description | 资源的详细描述 | 是 | 3.0.0 | |
| isDefault | 是 | 3.0.0 | ||
| resourceUuid | 是 | 3.0.0 | ||
| projectUuid | 3.0.0 | |||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.0.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.0.0 | |
| timeout | 是 |
删除工单流程(DeleteTicketFlowCollection)
可以使用DeleteTicketFlowCollection删除工单流程。
例如：
DeleteTicketFlowCollection uuid=657b0e4c4b21394db32f1c7c1066efa9 参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 3.0.0 | |||
| deleteMode | 是 | 3.0.0 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.0.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.0.0 | |
| timeout | 是 |
修改工单流程(UpdateIAM2TicketFlowCollection)
可以使用UpdateIAM2TicketFlowCollection修改工单流程。
例如：
UpdateIAM2TicketFlowCollection uuid=b86c9016b4f24953a9edefb53ca0678c name=cloud-1参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| flows | 是 | 3.0.0 | ||
| uuid | 资源的UUID，唯一标示该资源 | 3.0.0 | ||
| name | 资源名称 | 是 | 3.0.0 | |
| description | 资源的详细描述 | 是 | 3.0.0 | |
| isDefault | 是 | 3.0.0 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.0.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.0.0 | |
| timeout | 是 |
查询工单流程(QueryTicketFlowCollection)
管理员可以使用QueryTicketFlowCollection查询工单流程。例如：
QueryTicketFlowCollection name=Tom原生域查询（Primitive Fields of Query）
嵌套和扩展域查询（Nested And Expanded Fields of Query）
| 域（Field） | 清单（Inventory） | 描述 | 起始支持版本 |
|---|---|---|---|
| flow | flow Inventory | 工单流程一个步骤 | 2.4.0 |
| flows | flow Inventory | 工单流程多个步骤 | 2.4.0 |
修改工单流程状态(ChangeTicketFlowCollectionState)
可以使用ChangeTicketFlowCollectionState修改工单流程状态。
例如：
ChangeTicketFlowCollectionState uuid=b86c9016b4f24953a9edefb53ca0678c stateEvent=enable参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标示该资源 | 3.0.0 | ||
| stateEvent |
|
3.0.0 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.0.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.0.0 | |
| timeout | 是 |
查询工单步骤(QueryTicketFlow)
管理员可以使用QueryTicketFlow查询工单步骤。例如：
QueryTicketFlow name=Flow-1原生域查询（Primitive Fields of Query）
嵌套和扩展域查询（Nested And Expanded Fields of Query）
| 域（Field） | 清单（Inventory） | 描述 | 起始支持版本 |
|---|---|---|---|
| collection | collection Inventory | 流程集合 | 3.0.0 |
添加自定义审批的步骤(AddIAM2TicketFlow)
可以使用AddIAM2TicketFlow添加自定义审批的步骤。
例如：
AddIAM2TicketFlow approverUuid=2b1b555f19531df9a94ce42c8959fa9 name=Flow-1 collectionUuid=82b6111a0d7f47bd955f385f959b1eb7 参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| approverUuid | 3.0.0 | |||
| approverTitle | 资源名称 | 是 | 3.0.0 | |
| name | 资源的详细描述 | 3.0.0 | ||
| description | 是 | 3.0.0 | ||
| collectionUuid | 3.0.0 | |||
| parentFlowUuid | 是 | 3.0.0 | ||
| resourceUuid | 是 | 3.0.0 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.0.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.0.0 | |
| timeout | 是 |
修改自定义审批的步骤(UpdateIAM2TicketFlow)
可以使用UpdateIAM2TicketFlow修改自定义审批的步骤。
例如：
UpdateIAM2TicketFlow uuid=b86c9016b4f24953a9edefb53ca0678c name=Cloud-1参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标示该资源 | 3.0.0 | ||
| name | 资源名称 | 是 | 3.0.0 | |
| description | 资源的详细描述 | 是 | 3.0.0 | |
| approverUuid | 是 | 3.0.0 | ||
| approverTitle | 是 | 3.0.0 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.0.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.0.0 | |
| timeout | 是 |
删除自定义审批的步骤(DeleteIAM2TicketFlow)
可以使用DeleteIAM2TicketFlow删除自定义审批的步骤。
例如：
DeleteIAM2TicketFlow uuid=b86c9016b4f24953a9edefb53ca0678c参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标示该资源 | 3.0.0 | ||
| deleteMode | 是 | 3.0.0 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.0.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.0.0 | |
| timeout | 是 |
增加工单审批流程对应的工单类型(AddTicketTypesToTicketFlowCollection)
可以使用AddTicketTypesToTicketFlowCollection增加工单审批流程对应的工单类型。
例如：
AddTicketTypesToTicketFlowCollection ticketFlowCollectionUuid=3b933e9aaf2d49b9a3dcf0c92867790f ticketTypeUuids=ef064ef45fb446d381db7b7d5f71695c参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| ticketFlowCollectionUuid | 工单流程UUID | 3.6.0 | ||
| ticketTypeUuids | 工单类型UUID | 3.6.0 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.6.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.6.0 | |
| timeout | 是 |
移除工单流程关联的工单类型(RemoveTicketTypesFromTicketFlowCollection)
用户可以使用RemoveTicketTypesFromTicketFlowCollection移除工单流程关联的工单类型。
例如：
RemoveTicketTypesFromTicketFlowCollection ticketFlowCollectionUuid=3b933e9aaf2d49b9a3dcf0c92867790f ticketTypeUuids=ef064ef45fb446d381db7b7d5f71695c参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| ticketFlowCollectionUuid | 工单流程UUID | 3.6.0 | ||
| ticketTypeUuids | 工单类型UUID | 3.6.0 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.6.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.6.0 | |
| timeout | 是 |
查询工单类型(QueryTicketType)
管理员可以使用QueryTicketType查询工单类型。例如：
QueryTicketType uuid=3b933e9aaf2d49b9a3dcf0c92867790f