List Maintenance Schedules

GET 
/aggregates/maintenance/scheduler/jobs/orgId/:orgId

Get all active maintenance schedules.

Request

Path Parameters

orgId stringrequired

The Organization ID for which you want to get the active maintenance schedules.

Query Parameters

active boolean

When set to 'true' you would get only active scheduled jobs. When set to 'false' you would get only deactivated scheduled jobs. If not present, you would get all scheduled jobs.

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "responseCreated": "2022-04-02T14:34:23.585278Z",
  "response": [
    {
      "job_id": "3740f5fd-a6b8-45fb-a3ab-313bf8481af3",
      "organization_Id": "default",
      "full_build": false,
      "time_expression": "0 0 4 ? * * *",
      "created_by_user": "admin",
      "created_at": "2022-03-31T15:18:50.311944Z",
      "latest_execution": {
        "id": "8fe6e402-843b-4d04-a441-38ae4cc330b3",
        "jobId": "3740f5fd-a6b8-45fb-a3ab-313bf8481af3",
        "executedAt": "2022-04-02T10:56:35.160070Z"
      },
      "path": "time-based"
    }
  ]
}

Example

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "responseCreated": "2022-04-02T14:34:23.585278Z",
  "response": [
    {
      "job_id": "3740f5fd-a6b8-45fb-a3ab-313bf8481af3",
      "organization_Id": "default",
      "full_build": false,
      "time_expression": "0 0 4 ? * * *",
      "created_by_user": "admin",
      "created_at": "2022-03-31T15:18:50.311944Z",
      "latest_execution": {
        "id": "8fe6e402-843b-4d04-a441-38ae4cc330b3",
        "jobId": "3740f5fd-a6b8-45fb-a3ab-313bf8481af3",
        "executedAt": "2022-04-02T10:56:35.160070Z"
      },
      "path": "time-based"
    }
  ]
}

400

Invalid request for example: Invalid parameters, missing parameters.

401

Unauthorized. This error will occur if calling user does not have access right for the API.

404

Unauthorized. This error will occur if calling user does not have access right for the API.

500

A server error occurred. Check the logs for more details.

Loading...