Jobs

List jobs

GEThttps://api.erathos.com/developers/workspaces/{workspace_id}/jobs/

Authorization

ApiKeyAuth

Path parameters

workspace_id*string (uuid)

Query parameters

Response

200

Body

application/json

countinteger

Example: 50

next_pagenullable integer

Example: 3

previous_pagenullable integer

Example: 1

page_sizeinteger

Example: 10

total_pagesinteger

Example: 5

current_pageinteger

Example: 2

resultsarray of WorkspaceJob (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/jobs/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 50,
  "next_page": 3,
  "previous_page": 1,
  "page_size": 10,
  "total_pages": 5,
  "current_page": 2,
  "results": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "_created_at": "2024-12-04T19:10:17.039Z",
      "_updated_at": "2024-12-04T19:10:17.039Z",
      "data_source": "text",
      "connector_name": "text",
      "schema_name": "text",
      "name": "text",
      "is_active": false
    }
  ]
}

Cancel job execution

DELETEhttps://api.erathos.com/developers/workspaces/{workspace_id}/jobs/{_id}/cancel/

Authorization

ApiKeyAuth

Path parameters

_id*string (uuid)

workspace_id*string (uuid)

Response

204

No response body

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/jobs/{_id}/cancel/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Trigger job execution

POSThttps://api.erathos.com/developers/workspaces/{workspace_id}/jobs/{_id}/run/

Authorization

ApiKeyAuth

Path parameters

_id*string (uuid)

workspace_id*string (uuid)

Query parameters

Response

201

No response body

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/jobs/{_id}/run/', {
    method: 'POST',
    headers: {},
});
const data = await response.json();