UpdateIAM2TicketFlow

API Request

URLs
PUT zstack/v1/tickets/flow/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateIAM2TicketFlow": {
    "name": "new ticket flow name",
    "description": "new ticket flow description",
    "approverUuid": "714d3eedb96f32a39598fb11ae0d9927"
  },
  "systemTags": [],
  "userTags": []
}
Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateIAM2TicketFlow":{"name":"new ticket flow name","description":"new ticket flow description","approverUuid":"714d3eedb96f32a39598fb11ae0d9927"}}' http://localhost:8080/zstack/v1/tickets/flow/919e8fbb3b3b30f480b41563e36839cc/actions
Request Parameters
Name Type Location Description Optional Value Starting Version
uuid String url The resource UUID. 3.0.0
name String body (contained in the updateIAM2TicketFlow structure) Optional. The resource name. 3.0.0
description String body(contained in the updateIAM2TicketFlow structure) Optional. The detailed description of the resource. 3.0.0
approverUuid String body (contained in the updateIAM2TicketFlow structure) Optional. 3.0.0
approverTitle String body (contained in the updateIAM2TicketFlow structure) Optional. 3.0.0
systemTags List body Optional. 3.0.0
userTags List body Optional. 3.0.0

API Response

Sample Response
{
  "inventory": {
    "uuid": "1dc3521c3ec74b81813121404e5941e6",
    "name": "flow1",
    "description": "flow description",
    "parentFlowUuid": "bb2897de253e497f94587fc09b5ef969",
    "flowContextType": "{\"approverUuid\":\"da8cc8c2412246b6b29b38328b7dab88\"}",
    "createDate": "Dec 28, 2018 6:39:33 PM",
    "lastOpDate": "Dec 28, 2018 6:39:33 PM",
    "collectionUuid": "2b9bdd8b1c1d4163864e55d16840954f"
  }
}
Name Type Description Starting Version
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 3.0.0
inventory TicketFlowInventory See inventory. 3.0.0
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 3.0.0
description String The brief description of the error. 3.0.0
details String The details about the error. 3.0.0
elaboration String The reserved field. Default value: null. 3.0.0
opaque LinkedHashMap The reserved field. Default value: null. 3.0.0
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 3.0.0
#inventory
Name Type Description Starting Version
uuid String The resource UUID. 3.0.0
name String The resource name. 3.0.0
description String The detailed description of the resource. 3.0.0
parentFlowUuid String 3.0.0
flowContext String 3.0.0
flowContextType String 3.0.0
createDate Timestamp The creation date. 3.0.0
lastOpDate Timestamp The last operation date. 3.0.0
collectionUuid String 3.0.0

SDK Sample

Java SDK
UpdateIAM2TicketFlowAction action = new UpdateIAM2TicketFlowAction();
action.uuid = "919e8fbb3b3b30f480b41563e36839cc";
action.name = "new ticket flow name";
action.description = "new ticket flow description";
action.approverUuid = "714d3eedb96f32a39598fb11ae0d9927";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateIAM2TicketFlowAction.Result res = action.call();
Python SDK
UpdateIAM2TicketFlowAction action = UpdateIAM2TicketFlowAction()
action.uuid = "919e8fbb3b3b30f480b41563e36839cc"
action.name = "new ticket flow name"
action.description = "new ticket flow description"
action.approverUuid = "714d3eedb96f32a39598fb11ae0d9927"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateIAM2TicketFlowAction.Result res = action.call()