Executions API

This API allows managing workflow executions in the system. It provides endpoints to create, list, update, and obtain detailed information about executions, as well as to handle their inputs, outputs, and states.

The Execution Object

The Execution object represents a workflow execution in the system.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "principalId": "user123",
  "workflowId": "workflow456",
  "workflowAlias": "credit-score",
  "workflowVersion": "1.0.0",
  "workflowType": "scoring",
  "batchId": "batch789",
  "billableId": "bill123",
  "executionBatch": {
    "id": "992e4567-e89b-1432-a456-426614175837",
    "itemIndex": 5
  },
  "borrowerId": "borrower456",
  "status": "complete",
  "isSuccess": true,
  "isBillable": true,
  "isReScoring": false,
  "tags": ["credit", "automated"],
  "createdAt": "2023-04-01T12:00:00Z"
}

Attributes

Attribute	Description	Type
id	Unique identifier of the execution	String
principalId	ID of the user who initiated the execution	String
workflowId	ID of the executed workflow	String
workflowAlias	Alias of the workflow	String
workflowVersion	Version of the workflow	String
workflowType	Type of workflow (optional)	String
batchId	ID of the execution batch (optional, deprecated)	String
billableId	ID of the billable item (optional)	String
executionBatch	Object with metadata of the batch to which the execution belongs (optional)	Object
borrowerId	ID of the associated borrower (optional)	String
status	Current status of the execution	String
isSuccess	Indicates if the execution was successful	Boolean
isBillable	Indicates if the execution is billable	Boolean
isReScoring	Indicates if it is a re-evaluation	Boolean
tags	Tags associated with the execution	Array of String
createdAt	Date and time of execution creation	String (ISO 8601)

The ExecutionInput Object

The ExecutionInput object represents the input of a workflow execution in the system.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workflowId": "workflow456",
  "workflowAlias": "credit-score",
  "workflowVersion": "1.0.0",
  "input": {
    "borrowerId": "borrower789",
    "loanAmount": 50000,
    "loanTerm": 36
  },
  "createdAt": "2023-04-01T12:00:00Z"
}

Attributes

Attribute	Description	Type
id	Unique identifier of the execution input	String
workflowId	ID of the associated workflow	String
workflowAlias	Alias of the workflow	String
workflowVersion	Version of the workflow	String
input	Object with the input data for the execution	Object
createdAt	Date and time of input creation	String (ISO 8601)

The ExecutionOutput Object

The ExecutionOutput object represents the output of a workflow execution in the system.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "billableId": "bill123",
  "borrowerId": "borrower789",
  "workflowId": "workflow456",
  "workflowAlias": "credit-score",
  "workflowVersion": "1.0.0",
  "workflowType": "evaluation",
  "statusCode": 200,
  "isSuccess": true,
  "output": {
    "creditScore": 750,
    "recommendation": "approve"
  },
  "customOutput": {
    "additionalInfo": "Low-risk client"
  },
  "hasAttachments": true,
  "notices": [
    {
        "message": "Income verification completed",
        "severity": "info"
    }
  ],
  "notes": ["Manual review of credit history required"],
  "errorMessage": null,
  "createdAt": "2023-04-01T12:05:00Z"
}

Attributes

Attribute	Description	Type
id	Unique identifier of the execution output	String
billableId	ID of the billable item (optional)	String
borrowerId	ID of the associated borrower (optional)	String
workflowId	ID of the executed workflow	String
workflowAlias	Alias of the workflow	String
workflowVersion	Version of the workflow	String
workflowType	Type of workflow (optional)	String
statusCode	Execution status code	Integer
isSuccess	Indicates if the execution was successful	Boolean
output	Object with the output data of the execution	Object
customOutput	Custom output data (optional)	Any
hasAttachments	Indicates if the output has attachments	Boolean
notices	List of notices related to the output	Array of Object
notes	List of notes related to the output	Array of String
errorMessage	Error message if the execution failed (optional)	String
createdAt	Date and time of output creation	String (ISO 8601)

Get Execution Input

Retrieves the input of a specific execution.

GET /v1/executions/:execution_id/input

Path Parameters

Parameter	Description
execution_id	ID of the execution

Successful Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workflowId": "workflow456",
  "workflowAlias": "credit-score",
  "workflowVersion": "1.0.0",
  "input": {
    "borrowerId": "borrower789",
    "loanAmount": 50000,
    "loanTerm": 36
  },
  "createdAt": "2023-04-01T12:00:00Z"
}

Get Execution Output

Retrieves the output of a specific execution.

GET /v1/executions/:execution_id/output

Path Parameters

Parameter	Description
execution_id	ID of the execution

Successful Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "billableId": "bill123",
  "borrowerId": "borrower789",
  "workflowId": "workflow456",
  "workflowAlias": "credit-score",
  "workflowVersion": "1.0.0",
  "workflowType": "scoring",
  "statusCode": 200,
  "isSuccess": true,
  "output": {
    "creditScore": 750,
    "recommendation": "approve"
  },
  "customOutput": {
    "additionalInfo": "Low-risk client"
  },
  "hasAttachments": true,
  "notices": [
    {
        "message": "Income verification completed",
        "severity": "info"
    }
  ],
  "notes": ["Manual review of credit history required"],
  "errorMessage": null,
  "createdAt": "2023-04-01T12:05:00Z"
}

Operations

List Executions

Retrieves a paginated list of executions with filtering and sorting options.

GET /v1/executions

Query Parameters

Parameter	Description	Type
billable-id	Filter by billable ID	String
borrower-id	Filter by borrower ID	String
workflow-id	Filter by workflow ID	String
workflow-version	Filter by workflow version	String
workflow-alias	Filter by workflow alias	String
workflow-type	Filter by workflow type	String
page	Page number (default: 1)	Integer
per-page	Items per page (default: 10)	Integer
search	Text to search in executions	String
sort-by	Field to sort by	String
sort-direction	Sorting direction (asc or desc)	String
tags	Filter by tags	String
date-from	Start date for filtering	String
date-to	End date for filtering	String
status	Filter by execution status	String
exclude-tests	Exclude test executions	Boolean
exclude-batch-executions	Exclude executions belonging to a batch	Boolean

Successful Response

The response will be a paginated list of Execution objects.

Get an Execution

Retrieves detailed information of a specific execution.

GET /v1/executions/:execution_id

Path Parameters

Parameter	Description
execution_id	ID of the execution to retrieve

Successful Response

The response will be a complete Execution object.

Get Execution Output

Retrieves the output of a specific execution.

GET /v1/executions/:execution_id/output

Path Parameters

Parameter	Description
execution_id	ID of the execution

Successful Response

The response will be an ExecutionOutput object.

Get Execution Input

Retrieves the input of a specific execution.

GET /v1/executions/:execution_id/input

Path Parameters

Parameter	Description
execution_id	ID of the execution

Successful Response

The response will be an ExecutionInput object.

Get Execution State

Retrieves the current state of a specific execution.

GET /v1/executions/:execution_id/state

Path Parameters

Parameter	Description
execution_id	ID of the execution

Successful Response

The response will be an ExecutionState object.

Retry Execution

Retries a specific execution.

POST /v1/executions/:execution_id/retry

Path Parameters

Parameter	Description
execution_id	ID of the execution to retry

Input Parameters

Parameter	Description	Type
skipTasks	List of tasks to skip in the retry	Array of String

Request Example

{
  "skipTasks": ["dataValidation", "creditCheck"]
}

Successful Response

The response will include information about the execution retry.

Error Handling

The API may return the following error codes:

Code	Description
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Errors will include a descriptive message in the response body.

On this page