Flows | OCP® Learning Center

Get Flow

GET	{{baseUrl}}/orchestrator/api/flows/<flow_id>/	Gets the Flow by `flow_id`.

GET	{{baseUrl}}/orchestrator/api/flows/?name__iexact=<flow name>&group__iexact=<group name>	Gets the Flow by the Flow’s name and group.

Click to see the details

URL Parameters

Name	Type	Description	Example
`flow_id`	uuid	The flow's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Query Parameters

Request a Flow (one or more) in list, which applies to these filters.

Parameter	Type	Description
`name__iexact`	string	The flow's name.
`group__iexact`	string	The flow’s group.

Response (Success)

JSON

HTTP/1.1 200 OK

Returns the Flow (one or a list).

Example

JSON

{
    "name": "my_flow",
    "input_fields": ["inputField1", "inputField2"],
    "output_fields": ["outputField1", "outputField2"],
    "canvas_id": "8101c262-be18-40c7-a85a-78b47dcdf80d"
}

Response (Failed)

JSON

HTTP/1.1 404 NOT_FOUND

Get Flow Status

GET	{{baseUrl}}/orchestrator/api/apps/<flow_id>/status/	Gets the status of the Flow.

Click to see the details

URL Parameters

Name	Type	Description	Example
`flow_id`	uuid	The flow's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 200 OK

Parameter	Type	Description
`status`	string	The flow status.

Example

JSON

{
    "status": "started/stopped/not-deployed"
}

Response (Failed)

JSON

HTTP/1.1 404 NOT_FOUND

Create Flow

POST	{{baseUrl}}/orchestrator/api/flows/	Creates a Flow.

Click to see the details

Name	Type	Default	Description
`name`	string	-	The flow's name.
`input_fields`	array[string]	[ ]	The flow's input fields.
`output_fields`	array[string]	[ ]	The flow's output fields.

Example

JSON

{
    "name": "my_flow",
    "input_fields": ["inputField1", "inputField2"],
    "output_fields": ["outputField1", "outputField2"]
}

Response (Success)

JSON

HTTP/1.1 201 CREATED

The created Flow.

Example

JSON

{
    "name": "my_flow",
    "input_fields": ["inputField1", "inputField2"],
    "output_fields": ["outputField1", "outputField2"],
    "canvas_id": "8101c262-be18-40c7-a85a-78b47dcdf80d"
}

Response (Failed)

JSON

HTTP/1.1 400 BAD_REQUEST

The failed status 400 BAD_REQUEST can be returned if the flow name contains invalid characters (acceptable flow name characters are only alphanumeric [a-Z0-9] and the underscore character '_').

Example

JSON

{
    "name": [
        "Invalid flow name. Flow name must contain only alphanumeric characters and the underscore character."
    ]
}

Update Flow

PUT	{{baseUrl}}/orchestrator/api/flows/<flow_id>/	Updates the Flow.

Click to see the details

URL Parameters

Name	Type	Description	Example
`flow_id`	uuid	The flow's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Request Payload

Some Flow variables for editing.

Name	Type	Description
`input_fields`	array[string]	The flow's input fields.
`output_fields`	array[string]	The flow's output fields.

Example

JSON

{
    "input_fields": ["inputField1", "inputField2"],
    "output_fields": ["outputField1", "outputField2"]
}

Response (Success)

JSON

HTTP/1.1 200 OK

Returns the updated Flow object.

Example

JSON

{
    "name": "my_flow",
    "input_fields": ["inputField1", "inputField2"],
    "output_fields": ["outputField1", "outputField2"],
    "canvas_id": "8101c262-be18-40c7-a85a-78b47dcdf80d"
}

Delete Flow

DELETE	{{baseUrl}}/orchestrator/api/flows/<flow_id>/	Deletes the Flow by its `flow_id`.

Click to see the details

URL Parameters

Name	Type	Description	Example
`flow_id`	uuid	The flow's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 204 NO_CONTENT

Response (Failed)

JSON

HTTP/1.1 404 NOT_FOUND

Response (Failed)

JSON

HTTP/1.1 409 CONFLICT

The failed status 409 CONFLICT can be returned if the Flow is in use by other app/flow.

Example

JSON

{
    "detail": "Cannot delete the Flow, because it is used by these apps/flows: some_app,some_flow"
}