Get Flow Info

Description

The Get Flow Info API returns detailed information about a specific flow or a sub-flow, focusing on the DateModify field, which gets updated when changes are made from the canvas. This field is essential for accurate modification tracking, allowing users to reliably determine the last update time of a flow or sub-flow.

The DateModify field is triggered and updated in the following scenarios:

  • Updating the main flow from the canvas increments the flow version and updates the DateModify field for the main flow only.
  • Updating the sub-flow from the canvas increments the sub-flow’s version and updates the DateModify field for the sub-flow only.
  • Updating the sub-flow, which also increments the main flow’s version, does not update the DateModify field for the main flow.

Request URL

http://{controllerMachine}:{controllerPort}/api/v4/flowinfo/{itemId}

Input parameters

Field Type Description Comments
itemId string

Required: Unique identifier for items in the Asset hierarchy

The itemId can be from the following types of items:
- 'Flow'
- 'SubFlow'

Examples

Curl


curl -X GET --header 'Accept: application/json' --header 'AccessKey: {yourAccessKey}' 'http://{controllerMachine}:{controllerPort}/api/v4/flowinfo/{itemId}'

PowerShell 

$headers = @{}
$headers.Add("AccessKey","123qwe")
Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v4/flowinfo/{itemId}" -ContentType "application/json" -Headers $headers -Method GET

Response Body

List of Variables

{
  "Title": "New Flow 1234",
  "Type": "Flow",
  "DateCreation": "05-09-2023 03:42:11 +00:00",
  "DateModify": "29-09-2023 10:49:20 +00:00",
  "IsDeleted": 0,
  "TimeoutSeconds": 600,
  "DefaultTimeoutSec": 10,
  "EnvironmentId": "D6F833B9-3349-44B0-BECA-09128DB802FB",
  "Status": "Draft",
  "AssigneeUserId": "B3B58F22-DEF7-4CF8-819A-8D6755657802",
  "AgentConfigurationId": "124B2413-1E43-4C18-A77B-86B15F254DF1"
}

 

Response Object

Field Type Description Values
Title string Title of the flow or sub-flow  
Type string Type of item

'Flow',

'SubFlow'

DateCreation string

Static creation date of the flow or sub-flow

Format: 'MM-DD-YYYY HH:MM:SS +00:00'

DateModify string

Last modification date of the flow or sub-flow

Format: 'MM-DD-YYYY HH:MM:SS +00:00'

IsDeleted

int Deletion status

0: not deleted

1: deleted

TimeoutSeconds

int

Timeout in seconds

 

DefaultTimeoutSec

int

Default timeout in seconds

 

EnvironmentId

string

Unique identifier for the environment

 

Status

string

Current status of the flow

Draft,

Publish,

Back to draft,

Retire

AssigneeUserId

string

Unique identifier for the user assigned to the flow

 

AgentConfigurationId

string

Unique identifier for the agent configuration

 


Response Code

200 (OK)

404 (Not Found)

401 (Unauthorized, Incorrect access Keys)

400 (Bad Request)

404 (Asset Not Found)

500 (Internal Server Error)