CreateIAM2TickFlowCollection

API Request

URLs
POST zstack/v1/tickets/flow-collections
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "flows": [
      {
        "name": "flow1",
        "approverUuid": "1c4db59a73b63f968889764bcb2bae9d"
      },
      {
        "name": "flow2",
        "approverUuid": "eb9dc5050030323281c255864ca6c633"
      }
    ],
    "projectUuid": "bdd993eb57c13134967b15ed38ba33c4",
    "name": "flow collection",
    "description": "flow collection description",
    "isDefault": false
  },
  "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 POST -d '{"params":{"flows":[{"name":"flow1","approverUuid":"1c4db59a73b63f968889764bcb2bae9d"},{"name":"flow2","approverUuid":"eb9dc5050030323281c255864ca6c633"}],"projectUuid":"bdd993eb57c13134967b15ed38ba33c4","name":"flow collection","description":"flow collection description","isDefault":false}}' http://localhost:8080/zstack/v1/tickets/flow-collections
Request Parameters
Name Type Location Description Optional Value Starting Version
flows List body (contained in the params structure) Optional. 3.0.0
name String body (contained in the params structure) The resource name. 3.0.0
description String body (contained in the params structure) Optional. The detailed description of the resource. 3.0.0
isDefault Boolean body (contained in the params structure) Optional. 3.0.0
resourceUuid String body (contained in the params structure) Optional. 3.0.0
systemTags List body Optional. 3.0.0
userTags List body Optional. 3.0.0
projectUuid String body (contained in the params structure) 3.0.0

API Response

Sample Response
{
  "inventory": {
    "state": "Enabled",
    "status": "Valid",
    "lastOpDate": "Dec 28, 2018 6:50:31 PM",
    "isDefault": true,
    "flows": [
      {
        "name": "flow name",
        "description": "flow description",
        "flowContextType": "iam2",
        "createDate": "Dec 28, 2018 6:50:31 PM",
        "lastOpDate": "Dec 28, 2018 6:50:31 PM",
        "collectionUuid": "1dffd5fae83f3f55be42c56a0c2b266b"
      }
    ]
  }
}
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 TicketFlowCollectionInventory 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
state String 3.0.0
status String 3.0.0
createDate Timestamp The creation date. 3.0.0
lastOpDate Timestamp The last operation date. 3.0.0
isDefault Boolean 3.0.0
flows List See flows. 3.0.0
#flows
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 creation date. 3.0.0
collectionUuid String 3.0.0

SDK Sample

Java SDK
CreateIAM2TickFlowCollectionAction action = new CreateIAM2TickFlowCollectionAction();
action.flows = asList([name:flow1, approverUuid:1c4db59a73b63f968889764bcb2bae9d],[name:flow2, approverUuid:eb9dc5050030323281c255864ca6c633]);
action.projectUuid = "bdd993eb57c13134967b15ed38ba33c4";
action.name = "flow collection";
action.description = "flow collection description";
action.isDefault = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateIAM2TickFlowCollectionAction.Result res = action.call();
Python SDK
CreateIAM2TickFlowCollectionAction action = CreateIAM2TickFlowCollectionAction()
action.flows = [[name:flow1, approverUuid:1c4db59a73b63f968889764bcb2bae9d], [name:flow2, approverUuid:eb9dc5050030323281c255864ca6c633]]
action.projectUuid = "bdd993eb57c13134967b15ed38ba33c4"
action.name = "flow collection"
action.description = "flow collection description"
action.isDefault = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateIAM2TickFlowCollectionAction.Result res = action.call()