QueryTicketFlowCollection

API Request

URLs

GET zstack/v1/tickets/flow-collections

GET zstack/v1/tickets/flow-collections/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/tickets/flow-collections

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/tickets/flow-collections/19575ca3d82838a39763f3081e3f5055

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryTicketFlowCollection, and pressing the Tab key.

API Response

Sample Response

{
  "inventories": [
    {
      "uuid": "aafa04d2d3b447bb866a62457aa24fdd",
      "name": "collection name",
      "state": "Enabled",
      "status": "Valid",
      "isDefault": false,
      "flows": []
    }
  ]
}


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
inventories	List	See inventories.	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

#inventories


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 last operation date.	3.0.0
collectionUuid	String		3.0.0

SDK Sample

Java SDK

QueryTicketFlowCollectionAction action = new QueryTicketFlowCollectionAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryTicketFlowCollectionAction.Result res = action.call();

Python SDK

QueryTicketFlowCollectionAction action = QueryTicketFlowCollectionAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryTicketFlowCollectionAction.Result res = action.call()