Flow Runs

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

• flowVersion.steps

• flow

• flow_count

• flowExists

• flowRunLogs

• flowRunLogs_count

• flowRunLogsExists

• flowRunLogs.flowStep

• trackedData

• trackedData_count

• trackedDataExists

• metrics

• metrics_count

• metricsExists

• cpuTime

• cpuTime_count

• cpuTimeExists

• payloadSize

• payloadSize_count

• payloadSizeExists

• operationsSent

• operationsSent_count

• operationsSentExists

• operationsReceived

• operationsReceived_count

• operationsReceivedExists

• startingPayloads

• startingPayloads_count

• startingPayloadsExists

• retriedFlowRun

• retriedFlowRun_count

• retriedFlowRunExists

• virtualEnvironmentVersion

• virtualEnvironmentVersion_count

• virtualEnvironmentVersionExists

• virtualEnvironmentVersion.virtualEnvironment

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.

• user_id

• flow_id

• flow_version_id

• virtual_environment_id

• trigger

• status

• search

• started_before

• started_after

• started_on

• retried

• has_warnings

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

• trackedData.id

• flow.id

• flow.name

• flowVersion.steps.name

• retriedFlowRun.id

• retriedFlowRun.status

Available Sorts

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

• started_at

Authorizations

ApiKeyAuth

Query parameters

filter[user_id]stringOptional

Filter results by user_id.

filter[flow_id]stringOptional

Filter results by flow_id.

filter[flow_version_id]stringOptional

Filter results by flow_version_id.

filter[virtual_environment_id]stringOptional

Filter results by virtual_environment_id.

filter[trigger]stringOptional

Filter results by trigger.

filter[status]stringOptional

Filter results by status.

filter[search]stringOptional

Filter results by search.

filter[started_before]stringOptional

Filter results by started_before.

filter[started_after]stringOptional

Filter results by started_after.

filter[started_on]stringOptional

Filter results by started_on.

filter[retried]stringOptional

Filter results by retried.

filter[has_warnings]stringOptional

Filter results by has_warnings.

includestringOptional

Comma-separated list of relationships to include. Available: flowVersion, flowVersion.steps, flow, flowRunLogs, errorWarningLogs, flowRunLogs.flowStep, trackedData, metrics, cpuTime, payloadSize, operationsSent, operationsReceived, retriedFlowRun, virtualEnvironmentVersion, virtualEnvironmentVersion.virtualEnvironment

sortstringOptional

Sort field. Prefix with - for descending. Available: started_at

fields[trackedData]stringOptional

Comma-separated list of trackedData fields to return. Available: id

fields[flow]stringOptional

Comma-separated list of flow fields to return. Available: id, name

fields[flowVersion]stringOptional

Comma-separated list of flowVersion fields to return. Available: steps.name

fields[retriedFlowRun]stringOptional

Comma-separated list of retriedFlowRun fields to return. Available: id, status

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-runs

HTTPcURLJavaScriptPython

GET /api/v1/flow-runs HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "My Example",
      "payload.id": "example_payload.id",
      "steps.name": "example_steps.name",
      "status": "Draft",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "flow_id": 1,
      "flow_version_id": 1,
      "virtual_environment_version": {},
      "user_id": 1,
      "trigger": "API",
      "summary": "example_summary",
      "started_at": "2025-01-15T10:30:00.000000Z",
      "finished_at": "2025-01-15T10:30:00.000000Z",
      "duration": {},
      "retry_flow_run_id": 1,
      "retried_flow_run": [],
      "has_warnings": [],
      "flow_run_logs": [],
      "flow": [],
      "flow_version": [],
      "metrics": [],
      "cpu_time": "example_cpu_time",
      "payload_size": "example_payload_size",
      "operations_sent": "example_operations_sent",
      "operations_received": "example_operations_received",
      "score": "example_score",
      "starting_payload_count": 5,
      "starting_payload_size": "example_starting_payload_size",
      "flow_steps_with_errors": "example_flow_steps_with_errors"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/flow-runs",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/flow-runs?page=1",
    "last": "https://api.example.com/api/v1/flow-runs?page=1",
    "prev": null,
    "next": null
  }
}

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

• flowVersion.steps

• flow

• flow_count

• flowExists

• flowRunLogs

• flowRunLogs_count

• flowRunLogsExists

• flowRunLogs.flowStep

• trackedData

• trackedData_count

• trackedDataExists

• metrics

• metrics_count

• metricsExists

• cpuTime

• cpuTime_count

• cpuTimeExists

• payloadSize

• payloadSize_count

• payloadSizeExists

• operationsSent

• operationsSent_count

• operationsSentExists

• operationsReceived

• operationsReceived_count

• operationsReceivedExists

• startingPayloads

• startingPayloads_count

• startingPayloadsExists

• retriedFlowRun

• retriedFlowRun_count

• retriedFlowRunExists

• virtualEnvironmentVersion

• virtualEnvironmentVersion_count

• virtualEnvironmentVersionExists

• virtualEnvironmentVersion.virtualEnvironment

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.

• user_id

• flow_id

• flow_version_id

• virtual_environment_id

• trigger

• status

• search

• started_before

• started_after

• started_on

• retried

• has_warnings

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

• trackedData.id

• flow.id

• flow.name

• flowVersion.steps.name

• retriedFlowRun.id

• retriedFlowRun.status

Available Sorts

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

• started_at

Authorizations

ApiKeyAuth

Path parameters

flow_runstringRequired

The flow run identifier.

Query parameters

filter[user_id]stringOptional

Filter results by user_id.

filter[flow_id]stringOptional

Filter results by flow_id.

filter[flow_version_id]stringOptional

Filter results by flow_version_id.

filter[virtual_environment_id]stringOptional

Filter results by virtual_environment_id.

filter[trigger]stringOptional

Filter results by trigger.

filter[status]stringOptional

Filter results by status.

filter[search]stringOptional

Filter results by search.

filter[started_before]stringOptional

Filter results by started_before.

filter[started_after]stringOptional

Filter results by started_after.

filter[started_on]stringOptional

Filter results by started_on.

filter[retried]stringOptional

Filter results by retried.

filter[has_warnings]stringOptional

Filter results by has_warnings.

includestringOptional

Comma-separated list of relationships to include. Available: flowVersion, flowVersion.steps, flow, flowRunLogs, errorWarningLogs, flowRunLogs.flowStep, trackedData, metrics, cpuTime, payloadSize, operationsSent, operationsReceived, retriedFlowRun, virtualEnvironmentVersion, virtualEnvironmentVersion.virtualEnvironment

sortstringOptional

Sort field. Prefix with - for descending. Available: started_at

fields[trackedData]stringOptional

Comma-separated list of trackedData fields to return. Available: id

fields[flow]stringOptional

Comma-separated list of flow fields to return. Available: id, name

fields[flowVersion]stringOptional

Comma-separated list of flowVersion fields to return. Available: steps.name

fields[retriedFlowRun]stringOptional

Comma-separated list of retriedFlowRun fields to return. Available: id, status

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-runs/{flow_run}

HTTPcURLJavaScriptPython

GET /api/v1/flow-runs/{flow_run} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "name": "My Example",
    "payload.id": "example_payload.id",
    "steps.name": "example_steps.name",
    "status": "Draft",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_version_id": 1,
    "virtual_environment_version": {},
    "user_id": 1,
    "trigger": "API",
    "summary": "example_summary",
    "started_at": "2025-01-15T10:30:00.000000Z",
    "finished_at": "2025-01-15T10:30:00.000000Z",
    "duration": {},
    "retry_flow_run_id": 1,
    "retried_flow_run": [],
    "has_warnings": [],
    "flow_run_logs": [],
    "flow": [],
    "flow_version": [],
    "metrics": [],
    "cpu_time": "example_cpu_time",
    "payload_size": "example_payload_size",
    "operations_sent": "example_operations_sent",
    "operations_received": "example_operations_received",
    "score": "example_score",
    "starting_payload_count": 5,
    "starting_payload_size": "example_starting_payload_size",
    "flow_steps_with_errors": "example_flow_steps_with_errors"
  }
}

Download

get

Download for download.

Authorizations

ApiKeyAuth

Path parameters

flow_runstringRequired

The flow run identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-runs/{flow_run}/download

HTTPcURLJavaScriptPython

GET /api/v1/flow-runs/{flow_run}/download HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

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.

• flowRun

• flowRun_count

• flowRunExists

• flowStep

• flowStep_count

• flowStepExists

• flowRunLogMetadata

• flowRunLogMetadata_count

• flowRunLogMetadataExists

• flowRunLogPayloads

• flowRunLogPayloads_count

• flowRunLogPayloadsExists

• flowStep.payloads

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_step_id

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

• flowStep.id

• flowStep.name

• flowStep.payload.id

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

• id

Authorizations

ApiKeyAuth

Path parameters

flow_runstringRequired

The flow run identifier.

Query parameters

filter[flow_step_id]stringOptional

Filter results by flow_step_id.

includestringOptional

Comma-separated list of relationships to include. Available: flowRun, flowStep, flowRunLogMetadata, flowRunLogPayloads, flowStep.payloads

fields[flowStep]stringOptional

Comma-separated list of flowStep fields to return. Available: id, name, payload.id

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-runs/{flow_run}/flow-run-logs

HTTPcURLJavaScriptPython

GET /api/v1/flow-runs/{flow_run}/flow-run-logs HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "My Example",
      "payload.id": "example_payload.id",
      "steps.name": "example_steps.name",
      "status": "Draft",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "flow_id": 1,
      "flow_version_id": 1,
      "virtual_environment_version": {},
      "user_id": 1,
      "trigger": "API",
      "summary": "example_summary",
      "started_at": "2025-01-15T10:30:00.000000Z",
      "finished_at": "2025-01-15T10:30:00.000000Z",
      "duration": {},
      "retry_flow_run_id": 1,
      "retried_flow_run": [],
      "has_warnings": [],
      "flow_run_logs": [],
      "flow": [],
      "flow_version": [],
      "metrics": [],
      "cpu_time": "example_cpu_time",
      "payload_size": "example_payload_size",
      "operations_sent": "example_operations_sent",
      "operations_received": "example_operations_received",
      "score": "example_score",
      "starting_payload_count": 5,
      "starting_payload_size": "example_starting_payload_size",
      "flow_steps_with_errors": "example_flow_steps_with_errors"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/flow-runs/{flow_run}/flow-run-logs",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/flow-runs/{flow_run}/flow-run-logs?page=1",
    "last": "https://api.example.com/api/v1/flow-runs/{flow_run}/flow-run-logs?page=1",
    "prev": null,
    "next": null
  }
}

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.

• flowRun

• flowRun_count

• flowRunExists

• flowStep

• flowStep_count

• flowStepExists

• flowRunLogMetadata

• flowRunLogMetadata_count

• flowRunLogMetadataExists

• flowRunLogPayloads

• flowRunLogPayloads_count

• flowRunLogPayloadsExists

• flowStep.payloads

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_step_id

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

• flowStep.id

• flowStep.name

• flowStep.payload.id

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

• id

Authorizations

ApiKeyAuth

Path parameters

flow_runstringRequired

The flow run identifier.

flow_run_logstringRequired

The flow run log identifier.

Query parameters

filter[flow_step_id]stringOptional

Filter results by flow_step_id.

includestringOptional

Comma-separated list of relationships to include. Available: flowRun, flowStep, flowRunLogMetadata, flowRunLogPayloads, flowStep.payloads

fields[flowStep]stringOptional

Comma-separated list of flowStep fields to return. Available: id, name, payload.id

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-runs/{flow_run}/flow-run-logs/{flow_run_log}

HTTPcURLJavaScriptPython

GET /api/v1/flow-runs/{flow_run}/flow-run-logs/{flow_run_log} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "name": "My Example",
    "payload.id": "example_payload.id",
    "steps.name": "example_steps.name",
    "status": "Draft",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_version_id": 1,
    "virtual_environment_version": {},
    "user_id": 1,
    "trigger": "API",
    "summary": "example_summary",
    "started_at": "2025-01-15T10:30:00.000000Z",
    "finished_at": "2025-01-15T10:30:00.000000Z",
    "duration": {},
    "retry_flow_run_id": 1,
    "retried_flow_run": [],
    "has_warnings": [],
    "flow_run_logs": [],
    "flow": [],
    "flow_version": [],
    "metrics": [],
    "cpu_time": "example_cpu_time",
    "payload_size": "example_payload_size",
    "operations_sent": "example_operations_sent",
    "operations_received": "example_operations_received",
    "score": "example_score",
    "starting_payload_count": 5,
    "starting_payload_size": "example_starting_payload_size",
    "flow_steps_with_errors": "example_flow_steps_with_errors"
  }
}

Retry

post

Retry for retry.

Authorizations

ApiKeyAuth

Path parameters

flow_runstringRequired

The flow run identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-runs/{flow_run}/retry

HTTPcURLJavaScriptPython

POST /api/v1/flow-runs/{flow_run}/retry HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Stop

post

Stop for stop.

Authorizations

ApiKeyAuth

Path parameters

flow_runstringRequired

The flow run identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-runs/{flow_run}/stop

HTTPcURLJavaScriptPython

POST /api/v1/flow-runs/{flow_run}/stop HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}