DOCUMENTATIONAPI REFERENCEAI-Link
DownloadsSupport
Loading search results...
Aggregate Maintenance

Aggregate Maintenance

Run immediately

Run immediately an aggregate maintenance job.

HTTP REQUEST: POST

Run immediately an aggregate maintenance job.

POST/api/1.0/aggregates/maintenance/orgId/{orgId}/run-immediately
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID for which you want to run a maintenance job
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
503This error will occur if Design Center APIs are not enabled.
RESPONSE BODY DESCRIPTIONS
NameTypeDescription
idstring-
namestring-
propertiesCommonProperties-
attributesAttributeReferences-
partitionsPartitionReferences-
200 Response Body
{
  "status": {
    "code": 200,
    "message": "Maintenance successfully started for default"
  },
  "responseCreated": "2022-03-31T22:01:18.370769Z",
  "response": null
}

Get current job

HTTP REQUEST: GET

Get the running (in progress) maintenance job

GET/aggregates/maintenance/orgId/{orgId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID for which you want to get the running maintenance job.
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
{
  "status": {
    "code": 0,
    "message": "200 OK"
  },
  "responseCreated": "2021-12-17T11:04:12.945567Z",
  "response": {
    "id": "87bcb6ee-896d-4d8c-8fcf-b2e3a1342be1",
    "organizationId": "default",
    "triggerType": "CubeUpdateMaintenance(FirstTimeCubeProcessed)",
    "creationTime": "2021-12-17T10:23:36.534831Z",
    "startTime": "2021-12-17T10:23:36.534832Z",
    "endTime": "2021-12-17T10:23:37.377313Z",
    "status": "inprogress",
    "errorInformation": {}
  }
}

List maintenance jobs

HTTP REQUEST: GET

Get a list of the maintenance jobs for an organization.

GET/aggregates/maintenance/orgId/{orgId}/history
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID for which you want to get the history of maintenance jobs.
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
{
  "status": {
    "code": 0,
    "message": "200 OK"
  },
  "responseCreated": "2022-04-01T14:01:14.372616Z",
  "response": {
    "data": [
      {
        "id": "aba2c665-9535-4377-8eac-66482a0a1cbf",
        "organizationId": "default",
        "triggerType": "TimeBasedMaintenance",
        "creationTime": "2022-04-01T05:53:55.278706Z",
        "startTime": "2022-04-01T05:53:55.278706Z",
        "endTime": "2022-04-01T05:53:55.449299Z",
        "status": "done",
        "errorInformation": {}
      },
      {
        "id": "1169ecd4-1904-42ba-801e-efb649c8531c",
        "organizationId": "default",
        "triggerType": "TimeBasedMaintenance",
        "creationTime": "2022-03-31T22:01:18.371775Z",
        "startTime": "2022-03-31T22:01:18.371776Z",
        "endTime": "2022-03-31T22:01:18.562840Z",
        "status": "done",
        "errorInformation": {}
      },
      {
        "id": "955c391d-63e1-4e36-a3ba-4509ef1dd947",
        "organizationId": "default",
        "triggerType": "CubeUpdateMaintenance(FirstTimeCubeProcessed)",
        "creationTime": "2022-03-31T15:23:07.948496Z",
        "startTime": "2022-03-31T15:23:07.948496Z",
        "endTime": "2022-03-31T15:23:08.236517Z",
        "status": "done",
        "errorInformation": {}
      },
      {
        "id": "47dc8cc8-1ba4-45e4-b23d-a2135b1f3a5e",
        "organizationId": "default",
        "triggerType": "CubeUpdateMaintenance(FirstTimeCubeProcessed)",
        "creationTime": "2022-03-31T15:20:57.113649Z",
        "startTime": "2022-03-31T15:20:57.113650Z",
        "endTime": "2022-03-31T15:20:57.689258Z",
        "status": "done",
        "errorInformation": {}
      }
    ],
    "limit": 10,
    "offset": 0,
    "force_pull": false
  }
}