Workflows

What you can do with Workflow

Workflow Properties

title REQUIRED	Type: string|null
type REQUIRED	Type: string
workspace REQUIRED	Type: string (format: iri-reference)
credentials	Type: string|null (format: iri-reference)
notificationEmails	Type: array
enabled REQUIRED	Type: boolean Example:
lastRunDate	Type: string|null (format: date-time)
period REQUIRED	Type: string applies only to out
integration	Type: object|null Example: "integration": { "title": "string|null", "type": "string", "workspace": "string", "credentials": "string|null", "notificationEmails": "array", "enabled": true, "lastRunDate": "string|null", "period": "string", "integration": "object|null", "firstTimeSetupPassed": "boolean", "tags": "array", "id": "string", "integrationType": "string|null", "passive": "boolean", "remote": "boolean", "firstTimeSetupRequired": "boolean", "runInProgress": "boolean" } title: type: workspace: credentials: notificationEmails: enabled: lastRunDate: period: applies only to out integration: firstTimeSetupPassed: tags: id: integrationType: passive: On TrackMage side nothing happens. Workflow doesn't have an executor. remote: The external system controls this integration. firstTimeSetupRequired: runInProgress:
firstTimeSetupPassed	Type: boolean
tags	Type: array
id READ-ONLY	Type: string (format: uuid)
integrationType READ-ONLY	Type: string|null
passive READ-ONLY	Type: boolean On TrackMage side nothing happens. Workflow doesn't have an executor.
remote READ-ONLY	Type: boolean The external system controls this integration.
firstTimeSetupRequired READ-ONLY	Type: boolean
runInProgress READ-ONLY	Type: boolean

Endpoints

GET

/workflows

Retrieves the collection of Workflow resources.

Query Parameters

Name	In	Is Required	Type	Description
page	query	No	integer	The collection page number The default value: 1
itemsPerPage	query	No	integer	The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500
type	query	No	string
type[]	query	No	array	Array of Strings.
period	query	No	string
period[]	query	No	array	Array of Strings.
title	query	No	string
order[createdAt]	query	No	string	Allowed values: asc|desc
tag	query	No	string
exists[integration]	query	No	boolean
firstTimeSetupPassed	query	No	boolean
first_time_setup_required	query	No	string

GET

/workflows/{id}

Retrieves a Workflow resource.

Query Parameters

Name	In	Is Required	Type	Description
id	path	Yes	string	Resource identifier

GET

/workflows/{id}/runs

Retrieves a Workflow resource.

Query Parameters

Name	In	Is Required	Type	Description
id	path	Yes	string	Workflow identifier
page	query	No	integer	The collection page number The default value: 1
itemsPerPage	query	No	integer	The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500
status	query	No	string
status[]	query	No	array	Array of Strings.
order[createdAt]	query	No	string	Allowed values: asc|desc

GET

/workspaces/{id}/workflows

Retrieves a Workspace resource.

Query Parameters

Name	In	Is Required	Type	Description
id	path	Yes	string	Workspace identifier
page	query	No	integer	The collection page number The default value: 1
itemsPerPage	query	No	integer	The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500
type	query	No	string
type[]	query	No	array	Array of Strings.
period	query	No	string
period[]	query	No	array	Array of Strings.
title	query	No	string
order[createdAt]	query	No	string	Allowed values: asc|desc
tag	query	No	string
exists[integration]	query	No	boolean
firstTimeSetupPassed	query	No	boolean
first_time_setup_required	query	No	string

GET

/workspaces/{id}/workflows/{workflows}/runs

Retrieves a Workspace resource.

Query Parameters

Name	In	Is Required	Type	Description
id	path	Yes	string	Workspace identifier
workflows	path	Yes	string	Workflow identifier
page	query	No	integer	The collection page number The default value: 1
itemsPerPage	query	No	integer	The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500
status	query	No	string
status[]	query	No	array	Array of Strings.
order[createdAt]	query	No	string	Allowed values: asc|desc

GET

/teams/{id}/workspaces/{workspaces}/workflows

Retrieves a Team resource.

Query Parameters

Name	In	Is Required	Type	Description
id	path	Yes	string	Team identifier
workspaces	path	Yes	string	Workspace identifier
page	query	No	integer	The collection page number The default value: 1
itemsPerPage	query	No	integer	The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500
type	query	No	string
type[]	query	No	array	Array of Strings.
period	query	No	string
period[]	query	No	array	Array of Strings.
title	query	No	string
order[createdAt]	query	No	string	Allowed values: asc|desc
tag	query	No	string
exists[integration]	query	No	boolean
firstTimeSetupPassed	query	No	boolean
first_time_setup_required	query	No	string

GET

/teams/{id}/workspaces/{workspaces}/workflows/{workflows}/runs

Retrieves a Team resource.

Query Parameters

Name	In	Is Required	Type	Description
id	path	Yes	string	Team identifier
workspaces	path	Yes	string	Workspace identifier
workflows	path	Yes	string	Workflow identifier
page	query	No	integer	The collection page number The default value: 1
itemsPerPage	query	No	integer	The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500
status	query	No	string
status[]	query	No	array	Array of Strings.
order[createdAt]	query	No	string	Allowed values: asc|desc

POST

/workflows

Creates a Workflow resource.

Query Parameters

Name	In	Is Required	Type	Description

Request Body Parameters

title REQUIRED	Type: string|null
type REQUIRED	Type: string
workspace REQUIRED	Type: string (format: iri-reference)
credentials	Type: object|null Example: "credentials": { "type": "string", "team": "string|null" } type: team:
notificationEmails	Type: array
enabled REQUIRED	Type: boolean Example:
period REQUIRED	Type: string applies only to out
integration	Type: object|null Example: "integration": { "title": "string|null", "type": "string", "workspace": "string", "credentials": { "type": "string", "team": "string|null" }, "notificationEmails": "array", "enabled": true, "period": "string", "integration": "object|null", "firstTimeSetupPassed": "boolean" } title: type: workspace: credentials: notificationEmails: enabled: period: applies only to out integration: firstTimeSetupPassed:
firstTimeSetupPassed	Type: boolean

POST

/workflows/execute

Creates a Workflow resource.

Query Parameters

Name	In	Is Required	Type	Description

Request Body Parameters

No properties

POST

/workflows/submit-suggestion

Creates a Workflow resource.

Query Parameters

Name	In	Is Required	Type	Description

Request Body Parameters

comment

Type: string|null

PUT

/workflows/{id}

Replaces the Workflow resource.

Query Parameters

Name	In	Is Required	Type	Description
id	path	Yes	string	Resource identifier

Request Body Parameters

title REQUIRED	Type: string|null
type REQUIRED	Type: string
workspace REQUIRED	Type: string (format: iri-reference)
credentials	Type: string|null (format: iri-reference)
notificationEmails	Type: array
enabled REQUIRED	Type: boolean Example:
period REQUIRED	Type: string applies only to out
integration	Type: object|null Example: "integration": { "title": "string|null", "type": "string", "workspace": "string", "credentials": "string|null", "notificationEmails": "array", "enabled": true, "period": "string", "integration": "object|null", "firstTimeSetupPassed": "boolean" } title: type: workspace: credentials: notificationEmails: enabled: period: applies only to out integration: firstTimeSetupPassed:
firstTimeSetupPassed	Type: boolean

DELETE

/workflows/{id}

Removes the Workflow resource.

Query Parameters

Name	In	Is Required	Type	Description
id	path	Yes	string	Resource identifier