Task

Manage tasks, which represent asynchronous or scheduled operations in the system.
You can create, update, delete, and search for tasks with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/task/index

Returns a paginated and filterable list of tasks.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching tasks

object

filter

object

task_id

The unique identifier for the task.

string format: uuid

handler

The name of the handler assigned to the task.

string

user_id

The unique identifier for the user associated with the task.

string

entity_id

The unique identifier for the entity associated with the task (optional).

string

nullable

status

The current status of the task (e.g., pending, completed, etc.).

string

request

The JSON request data related to the task.

string format: json

nullable

response

The JSON response data related to the task.

string format: json

nullable

created_at

The timestamp when the task was created.

string format: date

updated_at

The timestamp when the task was last updated.

string format: date

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "handler": "ImportHandler",
    "status": "pending"
  },
  "per-page": 10,
  "page": 1,
  "sort": "created_at"
}

Responses

200

List of tasks

Array<object>

object

task_id

The unique identifier for the task.

string format: uuid

handler

The name of the handler assigned to the task.

string

user_id

The unique identifier for the user associated with the task.

string

entity_id

The unique identifier for the entity associated with the task (optional).

string

nullable

status

The current status of the task (e.g., pending, completed, etc.).

string

request

The JSON request data related to the task.

string format: json

nullable

response

The JSON response data related to the task.

string format: json

nullable

created_at

The timestamp when the task was created.

string format: date

updated_at

The timestamp when the task was last updated.

string format: date

Example

{
  "task_id": "task-1",
  "handler": "ImportHandler",
  "user_id": "user-1",
  "status": "pending",
  "created_at": "2024-01-01",
  "updated_at": "2024-01-02"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

create

POST

/v2/task/create

Create a new task by providing the required details.

Request Body ^required

Task object to be created

object

task_id

The unique identifier for the task.

string format: uuid

handler

The name of the handler assigned to the task.

string

user_id

The unique identifier for the user associated with the task.

string

entity_id

The unique identifier for the entity associated with the task (optional).

string

nullable

status

The current status of the task (e.g., pending, completed, etc.).

string

request

The JSON request data related to the task.

string format: json

nullable

response

The JSON response data related to the task.

string format: json

nullable

created_at

The timestamp when the task was created.

string format: date

updated_at

The timestamp when the task was last updated.

string format: date

Example

{
  "handler": "ExportHandler",
  "user_id": "user-2",
  "status": "pending"
}

Responses

201

Task created successfully

object

task_id

The unique identifier for the task.

string format: uuid

handler

The name of the handler assigned to the task.

string

user_id

The unique identifier for the user associated with the task.

string

entity_id

The unique identifier for the entity associated with the task (optional).

string

nullable

status

The current status of the task (e.g., pending, completed, etc.).

string

request

The JSON request data related to the task.

string format: json

nullable

response

The JSON response data related to the task.

string format: json

nullable

created_at

The timestamp when the task was created.

string format: date

updated_at

The timestamp when the task was last updated.

string format: date

Example

{
  "task_id": "task-2",
  "handler": "ExportHandler",
  "user_id": "user-2",
  "status": "pending"
}

view

GET

/v2/task/view/{id}

Retrieve a task by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the task to retrieve

Responses

200

Task found

object

task_id

The unique identifier for the task.

string format: uuid

handler

The name of the handler assigned to the task.

string

user_id

The unique identifier for the user associated with the task.

string

entity_id

The unique identifier for the entity associated with the task (optional).

string

nullable

status

The current status of the task (e.g., pending, completed, etc.).

string

request

The JSON request data related to the task.

string format: json

nullable

response

The JSON response data related to the task.

string format: json

nullable

created_at

The timestamp when the task was created.

string format: date

updated_at

The timestamp when the task was last updated.

string format: date

Example

{
  "task_id": "task-1",
  "handler": "ImportHandler",
  "user_id": "user-1",
  "status": "pending",
  "created_at": "2024-01-01",
  "updated_at": "2024-01-02"
}

404

Task not found

delete

DELETE

/v2/task/delete/{id}

Delete a task by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

string format: uuid

ID of the task to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Task deleted successfully

400

If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned

update

PUT

/v2/task/update/{id}

Update an existing task by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the task to update

Request Body ^required

Task object with updated data

object

task_id

The unique identifier for the task.

string format: uuid

handler

The name of the handler assigned to the task.

string

user_id

The unique identifier for the user associated with the task.

string

entity_id

The unique identifier for the entity associated with the task (optional).

string

nullable

status

The current status of the task (e.g., pending, completed, etc.).

string

request

The JSON request data related to the task.

string format: json

nullable

response

The JSON response data related to the task.

string format: json

nullable

created_at

The timestamp when the task was created.

string format: date

updated_at

The timestamp when the task was last updated.

string format: date

Example

{
  "status": "completed"
}

Responses

200

Task updated successfully

object

task_id

The unique identifier for the task.

string format: uuid

handler

The name of the handler assigned to the task.

string

user_id

The unique identifier for the user associated with the task.

string

entity_id

The unique identifier for the entity associated with the task (optional).

string

nullable

status

The current status of the task (e.g., pending, completed, etc.).

string

request

The JSON request data related to the task.

string format: json

nullable

response

The JSON response data related to the task.

string format: json

nullable

created_at

The timestamp when the task was created.

string format: date

updated_at

The timestamp when the task was last updated.

string format: date

Example

{
  "task_id": "task-1",
  "status": "completed"
}

404

Task not found