DOCUMENTATIONAPI REFERENCEAI-Link
DownloadsSupport
Loading search results...
Aggregate Creation Schedule

Aggregate Creation Schedule

List history

HTTP REQUEST: GET

Get all aggregate creation schedules.

GET/org/{orgId}/aggregates-creation/builds/history
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID for which you want to get the aggregate creation schedules.
RESPONSES
CodeDescription
200Success.
400Invalid request for example: Invalid parameters, missing parameters.
401Unauthorized. This error will occur if calling user does not have access right for the API.
404Unauthorized. This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "response": {
    "data": [
      {
        "batchType": "materialize-pending-instances",
        "createDate": "2023-04-13T22:39:38.826297Z",
        "cubeId": "dea39a20-9920-4a79-51f3-1ff3a399fbd3",
        "endTime": "2023-04-13T22:39:38.869098Z",
        "estimateTime": 0,
        "id": "a50fa6cd-a159-47ca-9b99-0261894e8dca",
        "organizationId": "default",
        "projectId": "7051865d-74a8-4aad-4904-ebf88d56880c",
        "startTime": "0001-01-01T00:00:00Z",
        "status": "done"
      }
    ],
    "force_pull": false,
    "limit": 10,
    "offset": 0
  },
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  }
}

Create and view schedule

HTTP REQUEST: GET

Get creation schedules for a cube.

GET/org/{orgId}/project/{projectId}/cube/{cubeId}/aggregates-creation/scheduler
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID for which you want to list schedules.
projectIdstringThe Project ID for which you want to list schedules.
cubeIdstringThe Cube ID for which you want to list schedules.
RESPONSES
CodeDescription
200Success.
400Invalid request for example: Invalid parameters, missing parameters.
401Unauthorized. This error will occur if calling user does not have access right for the API.
404Unauthorized. This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "response": [
    {
      "created_at": "2023-05-22T08:50:56.138663Z",
      "created_by_user": "admin",
      "cube_id": "b89a2fb7-74f4-4828-706e-70f7186e10a0",
      "full_build": true,
      "job_id": "da67817b-22db-4dbf-91a8-05124e241f77",
      "latest_execution": {
        "executedAt": "0001-01-01T00:00:00Z",
        "id": "",
        "jobId": ""
      },
      "organization_Id": "default",
      "path": "aggregate/create",
      "project_id": "956a27dd-32b1-482e-7d5c-2488fdb9c943",
      "time_expression": "0 25 06 ? * *"
    }
  ],
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  }
}

HTTP REQUEST: POST

Create a new schedule using cron time expression.

POST/org/{orgId}/project/{projectId}/cube/{cubeId}/aggregates-creation/scheduler
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID for which you want to create a schedule.
projectIdstringThe Project ID for which you want to create a schedule.
cubeIdstringThe Cube ID for which you want to create a schedule.
QUERY PARAMETERS
NameTypeDescription
time_expressionstringWhen the schedule should be executed. Defined similarly to Cron job time format, with one more field (seconds) in the beginning. For example: 0 25 06 ? * *
pathstringUse the following value: aggregate/create
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
Request Body
{
  "time_expression": "0 25 06 ? * *",
  "path": "aggregate/create"
}
200 Response Body
{
  "response": {
    "created_at": "2023-05-22T08:50:56.138663Z",
    "created_by_user": "admin",
    "cube_id": "b89a2fb7-74f4-4828-706e-70f7186e10a0",
    "full_build": true,
    "job_id": "da67817b-22db-4dbf-91a8-05124e241f77",
    "latest_execution": {
      "executedAt": "0001-01-01T00:00:00Z",
      "id": "",
      "jobId": ""
    },
    "organization_Id": "default",
    "path": "aggregate/create",
    "project_id": "956a27dd-32b1-482e-7d5c-2488fdb9c943",
    "time_expression": "0 25 06 ? * *"
  },
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  }
}

Trigger new job

HTTP REQUEST: POST

Trigger a new aggregate creation job.

POST/org/{orgId}/project/{projectId}/cube/{cubeId}/aggregates-creation/execute
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID for which you want to trigger a new job.
projectIdstringThe Project ID for which you want to trigger a new job.
cubeIdstringThe Cube ID for which you want to trigger a new job.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "response": {
    "success": true
  },
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  }
}

Delete schedule

HTTP REQUEST: DELETE

Delete the schedule with the specified ID.

DELETE/org/{orgId}/project/{projectId}/cube/{cubeId}/aggregates-creation/scheduler/jobId/{jobId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID for which you want to delete a schedule.
projectIdstringThe Project ID for which you want to delete a schedule.
cubeIdstringThe Cube ID for which you want to delete a schedule.
jobIdstringID of the schedule that you want to delete.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "response": "successfully deleted jobId: [da67817b-22db-4dbf-91a8-05124e241f77]",
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  }
}

Cube schedule history

HTTP REQUEST: GET

Get the history of the schedule with the specified ID.

GET/org/{orgId}/project/{projectId}/cube/{cubeId}/aggregates-creation/scheduler/history/jobId/{jobId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID for which you want to delete a schedule.
projectIdstringThe Project ID for which you want to delete a schedule.
cubeIdstringThe Cube ID for which you want to delete a schedule.
jobIdstringID of the schedule that you want to delete.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "response": {
    "history": [
      {
        "executedAt": "2023-05-22T11:30:47.412504Z",
        "id": "9b9ce2f2-b631-4d3b-8dc7-f75bd046f208",
        "jobId": "7b1c5866-87d6-4db5-b4d4-ddc0c042fd31"
      }
    ],
    "job_id": "7b1c5866-87d6-4db5-b4d4-ddc0c042fd31"
  },
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  }
}