Flow Versions | API Reference (WIP) | Product documentation

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

enabledBy
enabledBy_count
enabledByExists
flowVersion
flowVersion_count
flowVersionExists
virtualEnvironment
virtualEnvironment_count
virtualEnvironmentExists
package
package_count
packageExists
user
user_count
userExists

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

created_at

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/deployments

GET /api/v1/flow-versions/{flow_version}/deployments HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "virtual_environment_id": 1,
      "flow_version_id": 1,
      "priority": 1,
      "cron_string": "example_cron_string",
      "microservice": "example_microservice",
      "config": "example_config",
      "flow_step_route_id": 1,
      "variables": "example_variables",
      "parent_id": 1,
      "type": "example_type",
      "key": "example_key",
      "value": "example_value",
      "date_format": "example_date_format",
      "secret": "example_secret",
      "enabled_at": "2025-01-15T10:30:00.000000Z",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "flow_id": 1,
      "flow_name": "example_flow_name",
      "flow_priority": "example_flow_priority",
      "iteration": "example_iteration",
      "status": "Draft",
      "is_deployed": true,
      "is_editable": true,
      "deployed_at": "2025-01-15T10:30:00.000000Z",
      "deployed_by": {},
      "deployed_by_user": {},
      "deployments": [],
      "has_callback_step": [],
      "steps": [],
      "runs": "example_runs",
      "latest_run": "example_latest_run",
      "schedules": "example_schedules",
      "filters": [],
      "steps_count": 5,
      "pivot": "example_pivot"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/flow-versions/{flow_version}/deployments",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/flow-versions/{flow_version}/deployments?page=1",
    "last": "https://api.example.com/api/v1/flow-versions/{flow_version}/deployments?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

virtual_environment_id

flow_version_id

☑

priority

integer

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Body

virtual_environment_idstring · nullableOptional

flow_version_idstringRequired

priorityinteger · nullableOptional

deploy_disabledboolean · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/deployments

POST /api/v1/flow-versions/{flow_version}/deployments HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "virtual_environment_id": 1,
  "flow_version_id": 1,
  "priority": 1,
  "deploy_disabled": true
}

{
  "data": {
    "id": 1,
    "virtual_environment_id": 1,
    "flow_version_id": 1,
    "priority": 1,
    "cron_string": "example_cron_string",
    "microservice": "example_microservice",
    "config": "example_config",
    "flow_step_route_id": 1,
    "variables": "example_variables",
    "parent_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_name": "example_flow_name",
    "flow_priority": "example_flow_priority",
    "iteration": "example_iteration",
    "status": "Draft",
    "is_deployed": true,
    "is_editable": true,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": {},
    "deployed_by_user": {},
    "deployments": [],
    "has_callback_step": [],
    "steps": [],
    "runs": "example_runs",
    "latest_run": "example_latest_run",
    "schedules": "example_schedules",
    "filters": [],
    "steps_count": 5,
    "pivot": "example_pivot"
  }
}

Show

get

Get a single deployment.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

deploymentstringRequired

The deployment identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/deployments/{deployment}

GET /api/v1/flow-versions/{flow_version}/deployments/{deployment} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "virtual_environment_id": 1,
    "flow_version_id": 1,
    "priority": 1,
    "cron_string": "example_cron_string",
    "microservice": "example_microservice",
    "config": "example_config",
    "flow_step_route_id": 1,
    "variables": "example_variables",
    "parent_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_name": "example_flow_name",
    "flow_priority": "example_flow_priority",
    "iteration": "example_iteration",
    "status": "Draft",
    "is_deployed": true,
    "is_editable": true,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": {},
    "deployed_by_user": {},
    "deployments": [],
    "has_callback_step": [],
    "steps": [],
    "runs": "example_runs",
    "latest_run": "example_latest_run",
    "schedules": "example_schedules",
    "filters": [],
    "steps_count": 5,
    "pivot": "example_pivot"
  }
}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

virtual_environment_id

priority

integer

enabled_at

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

deploymentstringRequired

The deployment identifier.

Body

virtual_environment_idstring · nullableOptional

priorityinteger · nullableOptional

enabled_atstring · date-time · nullableOptional

deploy_disabledboolean · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/flow-versions/{flow_version}/deployments/{deployment}

PUT /api/v1/flow-versions/{flow_version}/deployments/{deployment} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "virtual_environment_id": 1,
  "priority": 1,
  "enabled_at": "2025-01-15T10:30:00.000000Z",
  "deploy_disabled": true
}

{
  "data": {
    "id": 1,
    "virtual_environment_id": 1,
    "flow_version_id": 1,
    "priority": 1,
    "cron_string": "example_cron_string",
    "microservice": "example_microservice",
    "config": "example_config",
    "flow_step_route_id": 1,
    "variables": "example_variables",
    "parent_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_name": "example_flow_name",
    "flow_priority": "example_flow_priority",
    "iteration": "example_iteration",
    "status": "Draft",
    "is_deployed": true,
    "is_editable": true,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": {},
    "deployed_by_user": {},
    "deployments": [],
    "has_callback_step": [],
    "steps": [],
    "runs": "example_runs",
    "latest_run": "example_latest_run",
    "schedules": "example_schedules",
    "filters": [],
    "steps_count": 5,
    "pivot": "example_pivot"
  }
}

Destroy

delete

Delete a deployment.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

deploymentstringRequired

The deployment identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/deployments/{deployment}

DELETE /api/v1/flow-versions/{flow_version}/deployments/{deployment} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}

Disable

post

Disable for disable.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

deploymentstringRequired

The deployment identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/deployments/{deployment}/disable

POST /api/v1/flow-versions/{flow_version}/deployments/{deployment}/disable HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Enable

post

Enable for enable.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

deploymentstringRequired

The deployment identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/deployments/{deployment}/enable

POST /api/v1/flow-versions/{flow_version}/deployments/{deployment}/enable HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Get Graph

get

Get Graph for graph.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/graph

GET /api/v1/flow-versions/{flow_version}/graph HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Create Connections

post

Create Connections for connections.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/graph/connections

POST /api/v1/flow-versions/{flow_version}/graph/connections HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Paste Steps

post

Paste Steps for paste steps.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/graph/paste-steps

POST /api/v1/flow-versions/{flow_version}/graph/paste-steps HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Update Positions

patch

Update Positions for positions.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

patch

/api/v1/flow-versions/{flow_version}/graph/positions

PATCH /api/v1/flow-versions/{flow_version}/graph/positions HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Store

post

Create a new step.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/graph/steps

POST /api/v1/flow-versions/{flow_version}/graph/steps HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Destroy

delete

Delete a step.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/graph/steps

DELETE /api/v1/flow-versions/{flow_version}/graph/steps HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Show

get

Get a single step.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/graph/steps/{step}

GET /api/v1/flow-versions/{flow_version}/graph/steps/{step} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Destroy

delete

Delete a step.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/graph/steps/{step}

DELETE /api/v1/flow-versions/{flow_version}/graph/steps/{step} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Destroy

delete

Delete a connection.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/graph/steps/{step}/connection

DELETE /api/v1/flow-versions/{flow_version}/graph/steps/{step}/connection HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Index

get

List all notes.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/notes

GET /api/v1/flow-versions/{flow_version}/notes HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Store

post

Create a new note.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/notes

POST /api/v1/flow-versions/{flow_version}/notes HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Update Positions

patch

Update Positions for positions.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

patch

/api/v1/flow-versions/{flow_version}/notes/positions

PATCH /api/v1/flow-versions/{flow_version}/notes/positions HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Show

get

Get a single note.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

notestringRequired

The note identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/notes/{note}

GET /api/v1/flow-versions/{flow_version}/notes/{note} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Update

put

Update an existing note.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

notestringRequired

The note identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/flow-versions/{flow_version}/notes/{note}

PUT /api/v1/flow-versions/{flow_version}/notes/{note} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Destroy

delete

Delete a note.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

notestringRequired

The note identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/notes/{note}

DELETE /api/v1/flow-versions/{flow_version}/notes/{note} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

flowVersion
flowVersion_count
flowVersionExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

flow_version_id
cron_string

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/schedules

GET /api/v1/flow-versions/{flow_version}/schedules HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "virtual_environment_id": 1,
      "flow_version_id": 1,
      "priority": 1,
      "cron_string": "example_cron_string",
      "microservice": "example_microservice",
      "config": "example_config",
      "flow_step_route_id": 1,
      "variables": "example_variables",
      "parent_id": 1,
      "type": "example_type",
      "key": "example_key",
      "value": "example_value",
      "date_format": "example_date_format",
      "secret": "example_secret",
      "enabled_at": "2025-01-15T10:30:00.000000Z",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "flow_id": 1,
      "flow_name": "example_flow_name",
      "flow_priority": "example_flow_priority",
      "iteration": "example_iteration",
      "status": "Draft",
      "is_deployed": true,
      "is_editable": true,
      "deployed_at": "2025-01-15T10:30:00.000000Z",
      "deployed_by": {},
      "deployed_by_user": {},
      "deployments": [],
      "has_callback_step": [],
      "steps": [],
      "runs": "example_runs",
      "latest_run": "example_latest_run",
      "schedules": "example_schedules",
      "filters": [],
      "steps_count": 5,
      "pivot": "example_pivot"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/flow-versions/{flow_version}/schedules",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/flow-versions/{flow_version}/schedules?page=1",
    "last": "https://api.example.com/api/v1/flow-versions/{flow_version}/schedules?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

cron_string

string

☑

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Body

cron_stringstringRequired

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/schedules

POST /api/v1/flow-versions/{flow_version}/schedules HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "cron_string": "example_cron_string",
  "deployed_at": "2025-01-15T10:30:00.000000Z"
}

{
  "data": {
    "id": 1,
    "virtual_environment_id": 1,
    "flow_version_id": 1,
    "priority": 1,
    "cron_string": "example_cron_string",
    "microservice": "example_microservice",
    "config": "example_config",
    "flow_step_route_id": 1,
    "variables": "example_variables",
    "parent_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_name": "example_flow_name",
    "flow_priority": "example_flow_priority",
    "iteration": "example_iteration",
    "status": "Draft",
    "is_deployed": true,
    "is_editable": true,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": {},
    "deployed_by_user": {},
    "deployments": [],
    "has_callback_step": [],
    "steps": [],
    "runs": "example_runs",
    "latest_run": "example_latest_run",
    "schedules": "example_schedules",
    "filters": [],
    "steps_count": 5,
    "pivot": "example_pivot"
  }
}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

cron_string

string

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

schedulestringRequired

The schedule identifier.

Body

cron_stringstringOptional

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/flow-versions/{flow_version}/schedules/{schedule}

PUT /api/v1/flow-versions/{flow_version}/schedules/{schedule} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "cron_string": "example_cron_string",
  "deployed_at": "2025-01-15T10:30:00.000000Z"
}

{
  "data": {
    "id": 1,
    "virtual_environment_id": 1,
    "flow_version_id": 1,
    "priority": 1,
    "cron_string": "example_cron_string",
    "microservice": "example_microservice",
    "config": "example_config",
    "flow_step_route_id": 1,
    "variables": "example_variables",
    "parent_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_name": "example_flow_name",
    "flow_priority": "example_flow_priority",
    "iteration": "example_iteration",
    "status": "Draft",
    "is_deployed": true,
    "is_editable": true,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": {},
    "deployed_by_user": {},
    "deployments": [],
    "has_callback_step": [],
    "steps": [],
    "runs": "example_runs",
    "latest_run": "example_latest_run",
    "schedules": "example_schedules",
    "filters": [],
    "steps_count": 5,
    "pivot": "example_pivot"
  }
}

Destroy

delete

Delete a schedule.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

schedulestringRequired

The schedule identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/schedules/{schedule}

DELETE /api/v1/flow-versions/{flow_version}/schedules/{schedule} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

flowVersion
flowVersion_count
flowVersionExists
endpoint
endpoint_count
endpointExists
endpoint.system
endpoint.system.logo
children
children_count
childrenExists
connector
connector_count
connectorExists
filters
filters_count
filtersExists
parentFlowStep
parentFlowStep_count
parentFlowStepExists
routes
routes_count
routesExists
variables
variables_count
variablesExists
scriptVersion
scriptVersion_count
scriptVersionExists
scriptVersion.script
scriptVersion.content
cache
cache_count
cacheExists
flow
flow_count
flowExists
notificationGroup
notificationGroup_count
notificationGroupExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

name

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/steps

GET /api/v1/flow-versions/{flow_version}/steps HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "virtual_environment_id": 1,
      "flow_version_id": 1,
      "priority": 1,
      "cron_string": "example_cron_string",
      "microservice": "example_microservice",
      "config": "example_config",
      "flow_step_route_id": 1,
      "variables": "example_variables",
      "parent_id": 1,
      "type": "example_type",
      "key": "example_key",
      "value": "example_value",
      "date_format": "example_date_format",
      "secret": "example_secret",
      "enabled_at": "2025-01-15T10:30:00.000000Z",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "flow_id": 1,
      "flow_name": "example_flow_name",
      "flow_priority": "example_flow_priority",
      "iteration": "example_iteration",
      "status": "Draft",
      "is_deployed": true,
      "is_editable": true,
      "deployed_at": "2025-01-15T10:30:00.000000Z",
      "deployed_by": {},
      "deployed_by_user": {},
      "deployments": [],
      "has_callback_step": [],
      "steps": [],
      "runs": "example_runs",
      "latest_run": "example_latest_run",
      "schedules": "example_schedules",
      "filters": [],
      "steps_count": 5,
      "pivot": "example_pivot"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/flow-versions/{flow_version}/steps",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/flow-versions/{flow_version}/steps?page=1",
    "last": "https://api.example.com/api/v1/flow-versions/{flow_version}/steps?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

flow_version_id

name

string

☑

microservice

☑

config

parent_id

integer

variables

variables.*.key

string

☑

variables.*.value

string

variables.*.label

string

☑

variables.*.secret

variables.*.locked

variables.*.pivot.alias

string

variables.*.pivot.configurable

variables.*.pivot.required

variables.*.pivot.advanced

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Body

flow_version_idstringOptional

microservicestringRequired

configstringOptional

parent_idintegerOptional

variablesstringOptional

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/steps

POST /api/v1/flow-versions/{flow_version}/steps HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "flow_version_id": 1,
  "microservice": "example_microservice",
  "config": "example_config",
  "parent_id": 1,
  "variables": "example_variables",
  "deployed_at": "2025-01-15T10:30:00.000000Z"
}

{
  "data": {
    "id": 1,
    "virtual_environment_id": 1,
    "flow_version_id": 1,
    "priority": 1,
    "cron_string": "example_cron_string",
    "microservice": "example_microservice",
    "config": "example_config",
    "flow_step_route_id": 1,
    "variables": "example_variables",
    "parent_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_name": "example_flow_name",
    "flow_priority": "example_flow_priority",
    "iteration": "example_iteration",
    "status": "Draft",
    "is_deployed": true,
    "is_editable": true,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": {},
    "deployed_by_user": {},
    "deployments": [],
    "has_callback_step": [],
    "steps": [],
    "runs": "example_runs",
    "latest_run": "example_latest_run",
    "schedules": "example_schedules",
    "filters": [],
    "steps_count": 5,
    "pivot": "example_pivot"
  }
}

Show

get

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

flowVersion
flowVersion_count
flowVersionExists
endpoint
endpoint_count
endpointExists
endpoint.system
endpoint.system.logo
children
children_count
childrenExists
connector
connector_count
connectorExists
filters
filters_count
filtersExists
parentFlowStep
parentFlowStep_count
parentFlowStepExists
routes
routes_count
routesExists
variables
variables_count
variablesExists
scriptVersion
scriptVersion_count
scriptVersionExists
scriptVersion.script
scriptVersion.content
cache
cache_count
cacheExists
flow
flow_count
flowExists
notificationGroup
notificationGroup_count
notificationGroupExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

name

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/steps/{step}

GET /api/v1/flow-versions/{flow_version}/steps/{step} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "virtual_environment_id": 1,
    "flow_version_id": 1,
    "priority": 1,
    "cron_string": "example_cron_string",
    "microservice": "example_microservice",
    "config": "example_config",
    "flow_step_route_id": 1,
    "variables": "example_variables",
    "parent_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_name": "example_flow_name",
    "flow_priority": "example_flow_priority",
    "iteration": "example_iteration",
    "status": "Draft",
    "is_deployed": true,
    "is_editable": true,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": {},
    "deployed_by_user": {},
    "deployments": [],
    "has_callback_step": [],
    "steps": [],
    "runs": "example_runs",
    "latest_run": "example_latest_run",
    "schedules": "example_schedules",
    "filters": [],
    "steps_count": 5,
    "pivot": "example_pivot"
  }
}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

flow_version_id

name

string

microservice

config

parent_id

integer

variables

variables.*.id

string

☑

variables.*.key

string

variables.*.value

string

variables.*.label

string

variables.*.secret

variables.*.locked

variables.*.pivot.alias

string

variables.*.pivot.configurable

variables.*.pivot.required

variables.*.pivot.advanced

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Body

flow_version_idstringOptional

microservicestringOptional

configstringOptional

parent_idintegerOptional

variablesstringOptional

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/flow-versions/{flow_version}/steps/{step}

PUT /api/v1/flow-versions/{flow_version}/steps/{step} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "flow_version_id": 1,
  "microservice": "example_microservice",
  "config": "example_config",
  "parent_id": 1,
  "variables": "example_variables",
  "deployed_at": "2025-01-15T10:30:00.000000Z"
}

{
  "data": {
    "id": 1,
    "virtual_environment_id": 1,
    "flow_version_id": 1,
    "priority": 1,
    "cron_string": "example_cron_string",
    "microservice": "example_microservice",
    "config": "example_config",
    "flow_step_route_id": 1,
    "variables": "example_variables",
    "parent_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_name": "example_flow_name",
    "flow_priority": "example_flow_priority",
    "iteration": "example_iteration",
    "status": "Draft",
    "is_deployed": true,
    "is_editable": true,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": {},
    "deployed_by_user": {},
    "deployments": [],
    "has_callback_step": [],
    "steps": [],
    "runs": "example_runs",
    "latest_run": "example_latest_run",
    "schedules": "example_schedules",
    "filters": [],
    "steps_count": 5,
    "pivot": "example_pivot"
  }
}

Destroy

delete

Delete a step.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/steps/{step}

DELETE /api/v1/flow-versions/{flow_version}/steps/{step} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

name

string

☑

microservice

☑

config

flow_step_route_id

integer

☑

variables

variables.*.key

string

☑

variables.*.value

string

variables.*.label

string

☑

variables.*.secret

variables.*.locked

variables.*.pivot.alias

string

variables.*.pivot.configurable

variables.*.pivot.required

variables.*.pivot.advanced

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Body

microservicestringRequired

configstringOptional

flow_step_route_idintegerRequired

variablesstringOptional

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/steps/{step}/children

POST /api/v1/flow-versions/{flow_version}/steps/{step}/children HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "microservice": "example_microservice",
  "config": "example_config",
  "flow_step_route_id": 1,
  "variables": "example_variables",
  "deployed_at": "2025-01-15T10:30:00.000000Z"
}

{
  "data": {
    "id": 1,
    "virtual_environment_id": 1,
    "flow_version_id": 1,
    "priority": 1,
    "cron_string": "example_cron_string",
    "microservice": "example_microservice",
    "config": "example_config",
    "flow_step_route_id": 1,
    "variables": "example_variables",
    "parent_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_name": "example_flow_name",
    "flow_priority": "example_flow_priority",
    "iteration": "example_iteration",
    "status": "Draft",
    "is_deployed": true,
    "is_editable": true,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": {},
    "deployed_by_user": {},
    "deployments": [],
    "has_callback_step": [],
    "steps": [],
    "runs": "example_runs",
    "latest_run": "example_latest_run",
    "schedules": "example_schedules",
    "filters": [],
    "steps_count": 5,
    "pivot": "example_pivot"
  }
}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

name

string

☑

microservice

☑

config

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Body

microservicestringRequired

configstringOptional

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/steps/{step}/parents

POST /api/v1/flow-versions/{flow_version}/steps/{step}/parents HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "microservice": "example_microservice",
  "config": "example_config",
  "deployed_at": "2025-01-15T10:30:00.000000Z"
}

{
  "data": {
    "id": 1,
    "virtual_environment_id": 1,
    "flow_version_id": 1,
    "priority": 1,
    "cron_string": "example_cron_string",
    "microservice": "example_microservice",
    "config": "example_config",
    "flow_step_route_id": 1,
    "variables": "example_variables",
    "parent_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_name": "example_flow_name",
    "flow_priority": "example_flow_priority",
    "iteration": "example_iteration",
    "status": "Draft",
    "is_deployed": true,
    "is_editable": true,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": {},
    "deployed_by_user": {},
    "deployments": [],
    "has_callback_step": [],
    "steps": [],
    "runs": "example_runs",
    "latest_run": "example_latest_run",
    "schedules": "example_schedules",
    "filters": [],
    "steps_count": 5,
    "pivot": "example_pivot"
  }
}

Upload

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

private

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Body

privatestringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/upload

POST /api/v1/flow-versions/{flow_version}/upload HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "private": "example_private"
}

{}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

type

string

☑

key

string

☑

value

date_format

string

secret

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

Body

typestringRequired

keystring · min: 1Required

valuestring · max: 1024Optional

date_formatstring · nullableOptional

secretstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/variables

POST /api/v1/flow-versions/{flow_version}/variables HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "type": "example_type",
  "key": "example_key",
  "value": "example_value",
  "date_format": "example_date_format",
  "secret": "example_secret"
}

{
  "data": {
    "id": 1,
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "locked": "example_locked",
    "configurable": "example_configurable",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "modified": "example_modified",
    "pivot": "example_pivot",
    "required": true,
    "advanced": true,
    "alias": "example_alias"
  }
}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

type

string

☑

key

string

☑

value

date_format

string

secret

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

variablestringRequired

The variable identifier.

Body

typestringRequired

keystring · min: 1Required

valuestring · max: 1024Optional

date_formatstring · nullableOptional

secretstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/flow-versions/{flow_version}/variables/{variable}

PUT /api/v1/flow-versions/{flow_version}/variables/{variable} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "type": "example_type",
  "key": "example_key",
  "value": "example_value",
  "date_format": "example_date_format",
  "secret": "example_secret"
}

{
  "data": {
    "id": 1,
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "locked": "example_locked",
    "configurable": "example_configurable",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "modified": "example_modified",
    "pivot": "example_pivot",
    "required": true,
    "advanced": true,
    "alias": "example_alias"
  }
}

Destroy

delete

Delete a variable.

Authorizations

Path parameters

flow_versionstringRequired

The flow version identifier.

variablestringRequired

The variable identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/variables/{variable}

DELETE /api/v1/flow-versions/{flow_version}/variables/{variable} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagShow

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagDisable

hashtagEnable

hashtagGet Graph

hashtagCreate Connections

hashtagPaste Steps

hashtagUpdate Positions

hashtagStore

hashtagDestroy

hashtagShow

hashtagDestroy

hashtagDestroy

hashtagIndex

hashtagStore

hashtagUpdate Positions

hashtagShow

hashtagUpdate

hashtagDestroy

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagStore

hashtagValidation Rules

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagStore

hashtagValidation Rules

hashtagShow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagStore

hashtagValidation Rules

hashtagStore

hashtagValidation Rules

hashtagUpload

hashtagValidation Rules

hashtagStore

hashtagValidation Rules

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

Index

Pagination

Available Includes

Available Sorts

Store

Validation Rules

Show

Update

Validation Rules

Destroy

Disable

Enable

Get Graph

Create Connections

Paste Steps

Update Positions

Store

Destroy

Show

Destroy

Destroy

Index

Store

Update Positions

Show

Update

Destroy

Index

Pagination

Available Includes

Available Filters

Store

Validation Rules

Update

Validation Rules

Destroy

Index

Pagination

Available Includes

Available Filters

Store

Validation Rules

Show

Available Includes

Available Filters

Update

Validation Rules

Destroy

Store

Validation Rules

Store

Validation Rules

Upload

Validation Rules

Store

Validation Rules

Update

Validation Rules

Destroy