Use the Solution Reporting API to manage and automate recurring report execution through flexible scheduling capabilities. The Schedules endpoints let developers create and configure schedules that trigger report definitions at defined intervals. Additionally, they can retrieve lists of all existing schedules or filter them by attributes such as status or next‑run timestamp, update schedule parameters as reporting needs evolve, and fetch detailed metadata for any schedule by ID.

Base URL:

https://platform-reporting.vertexcloud.com/api/v1/schedules

Reports endpoint	Endpoint description
`/schedules`	GET - Retrieve a list of schedules for running report definitions.
`/reports/{reportId}/schedules`	GET - Retrieve all schedules associated with a specific report definition.
`/schedules`	POST - Create a new schedule for running a report definition.
`/reports/{reportId}/schedules`	DELETE - Delete all schedules associated with a specific report definition.
`/schedules/{scheduleId}`	GET - Retrieve full metadata for a single schedule.
`/schedules/{scheduleId}`	PUT - Update an existing schedule.
`/schedules/{scheduleId}`	DELETE - Delete or permanently disable a schedule.

List schedules

Retrieve a list of schedules for running report definitions, optionally filtered by definition, template, category, status, name, and effective date range.

Request

All request parameters are optional. Passing a request with no parameters returns all available records.

Parameter name	Parameter format	Parameter description
`definitionId`	uuid	Filter by report definition UUID.
`templateId`	uuid	Filter by template UUID.
`categoryId`	uuid	Filter by report category UUID.
`enabled`	boolean	Filter by enabled status.
`scheduleType`	string enum	Filter by schedule type. • ONE_TIME • RECURRING
`name`	string	Filter by schedule name (case-insensitive substring match).
`startDateFrom`	date, ISO-8601	Schedule effective on or after the specified date (inclusive).
`startDateTo`	date, ISO-8601	Schedule effective on or before the specified date (inclusive).

Example request

curl --request GET \
     --url 'https://platform-reporting.vertexcloud.com/api/v1/schedules?definitionId=f81d4fae-7dec-11d0-a765-00a0c91e6bf6&enabled=true&scheduleType=RECURRING' \
     --header 'accept: application/json'

Response

The API wraps the results in an envelope with these top-level response fields.

Response field	Type	Description
`count`	integer	Total number of matching schedules.
`value`	array	Array of `ScheduleListResponse` objects.

The following table lists the ScheduleListResponse fields you receive inside each item in the value[] array.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`definitionId`	uuid	Unique identifier for the report definition associated with the schedule.
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Indicates whether the schedule is currently enabled.
`timeOfDay`	string	Time of day at which the schedule triggers, in HH:mm format.
`startDate`	date	First date on which the schedule can run (inclusive).
`createdDateTime`	date-time	Creation timestamp of the schedule.
`modifiedDateTime`	date-time	Last modification timestamp of the schedule.
`lastRunDateTime`	date-time \| null	Timestamp of the most recent run, if available.
`nextRunDateTime`	date-time \| null	Calculated timestamp of the next run, if available.
`scheduleType`	string enum	The type of schedule. • ONE_TIME • RECURRING

The following table describes fields specific to RECURRING schedules.

Response field	Type	Description
`frequency`	string enum	Recurrence frequency for a schedule. • DAILY • WEEKLY • MONTHLY
`endDate`	date \| null	Last date on which the schedule can run (inclusive). `null` means the schedule does not have a fixed end date.
`dayOfWeek`	string \| null enum	The day of the week the schedule runs when using weekly recurrence. • MONDAY • TUESDAY • WEDNESDAY • THURSDAY • FRIDAY • SATURDAY • SUNDAY
`dayOfMonth`	int32 \| null 1 to 31	The day of the month the schedule runs when using monthly recurrence.

Example response

{
  "items": [
    {
      "id": "a3b9e1d2-54fb-4f32-8f02-6e9e8a8d7f10",
      "name": "Monthly Compliance Report",
      "scheduleType": "RECURRING",
      "reportDefinitionId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
      "startDate": "2025-01-01T00:00:00Z",
      "endDate": null,
      "cronExpression": "0 6 1 * *",
      "timezone": "America/New_York",
      "enabled": true,
      "nextRunDate": "2026-02-01T11:00:00Z",
      "lastRunDate": "2026-01-01T11:00:00Z",
      "createdAt": "2024-10-15T18:22:10Z",
      "updatedAt": "2025-12-20T14:34:55Z"
    },
    {
      "id": "c71f9b84-8ef8-4ce8-9ab5-7c31273cc04e",
      "name": "Weekly Summary Report",
      "scheduleType": "RECURRING",
      "reportDefinitionId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
      "startDate": "2024-05-01T00:00:00Z",
      "endDate": null,
      "cronExpression": "0 3 * * MON",
      "timezone": "America/Chicago",
      "enabled": true,
      "nextRunDate": "2026-01-26T09:00:00Z",
      "lastRunDate": "2026-01-19T09:00:00Z",
      "createdAt": "2024-04-10T12:18:44Z",
      "updatedAt": "2025-11-01T07:10:05Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalCount": 2
}

List schedules for report definition

Retrieve all schedules associated with a specific report definition.

Request

Only the reportId parameter is required as a path parameter..

Parameter name	Parameter format	Parameter description
`reportId`	uuid	Unique identifier of the report definition.

Example request

curl --request GET \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports/f81d4fae-7dec-11d0-a765-00a0c91e6bf6/schedules \
     --header 'accept: application/json'

Response

The API wraps the results in an envelope with these top-level response fields.

Response field	Type	Description
`count`	integer	Total number of matching schedules.
`value`	array	Array of `ScheduleListResponse` objects.

Below are the ScheduleListResponse fields you receive inside each item in the value[] array.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`definitionId`	uuid	Unique identifier for the report definition associated with the schedule
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Indicates whether the schedule is currently enabled.
`timeOfDay`	string	Time of day at which the schedule triggers, in HH:mm format.
`startDate`	date	First date on which the schedule can run (inclusive).
`createdDateTime`	date-time	Creation timestamp of the schedule.
`modifiedDateTime`	date-time	Last modification timestamp of the schedule.
`lastRunDateTime`	date-time \| null	Timestamp of the most recent run, if available.
`nextRunDateTime`	date-time \| null	Calculated timestamp of the next run, if available.
`scheduleType`	string enum	The type of schedule. • ONE_TIME • RECURRING

Fields specific to RECURRING schedules.

Response field	Type	Description
`frequency`	string enum	Recurrence frequency for a schedule. • DAILY • WEEKLY • MONTHLY
`endDate`	date \| null	Last date on which the schedule can run (inclusive). `null` means the schedule does not have a fixed end date.
`dayOfWeek`	string \| null enum	The day of the week the schedule runs when using weekly recurrence. • MONDAY • TUESDAY • WEDNESDAY • THURSDAY • FRIDAY • SATURDAY • SUNDAY
`dayOfMonth`	int32 \| null 1 to 31	The day of the month the schedule runs when using monthly recurrence.

Example response

{
  "count": 2,
  "value": [
    {
      "id": "3c7d9ab1-4e77-4b53-ac7f-324b920b5c11",
      "definitionId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
      "name": "One-time Backfill Run",
      "description": "Initial historical load",
      "enabled": true,
      "timeOfDay": "13:00",
      "startDate": "2026-02-01",
      "createdDateTime": "2026-01-05T15:20:44Z",
      "modifiedDateTime": "2026-01-05T15:20:44Z",
      "lastRunDateTime": null,
      "nextRunDateTime": "2026-02-01T13:00:00Z",
      "scheduleType": "ONE_TIME"
    },
    {
      "id": "9f91b8c2-3f44-4d0e-ab37-00d72efc1234",
      "definitionId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
      "name": "Weekly Usage Summary",
      "description": null,
      "enabled": true,
      "timeOfDay": "09:30",
      "startDate": "2024-07-01",
      "endDate": null,
      "frequency": "WEEKLY",
      "dayOfWeek": "MONDAY",
      "dayOfMonth": null,
      "createdDateTime": "2024-06-28T11:50:32Z",
      "modifiedDateTime": "2025-12-12T09:15:10Z",
      "lastRunDateTime": "2026-01-19T09:30:00Z",
      "nextRunDateTime": "2026-01-26T09:30:00Z",
      "scheduleType": "RECURRING"
    }
  ]
}

Create schedule

Use the Create Schedule endpoint to define a new schedule that automatically triggers a report definition at the date and time you specify. This endpoint supports one‑time and recurring schedules, allowing you to automate report execution on a fixed date or on a daily, weekly, or monthly cadence.

Request

The request body defines the schedule type and the key parameters needed to determine when the report should run.

The body parameters for a ONE_TIME schedule type are described in the following table.

Parameter name	Parameter format	Parameter description
`definitionId`	uuid	Required. The unique identifier of the report definition to schedule.
`name`	string	Required. Human-readable name of the schedule.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Required. Indicates whether the schedule should be enabled when created.
`timeOfDay`	string	Time of day at which the schedule triggers, in HH:mm format.
`startDate`	date	Required. First date on which the schedule can run (inclusive).
`scheduleType`	string enum	Required. ONE_TIME.

The body parameters for a RECURRING schedule type, as described in the following table.

Parameter name	Parameter format	Parameter description
`definitionId`	uuid	Required. The unique identifier of the report definition to schedule.
`name`	string	Required. Human-readable name of the schedule.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Required. Indicates whether the schedule should be enabled when created.
`timeOfDay`	string	Time of day at which the schedule triggers, in HH:mm format.
`startDate`	date	Required. First date on which the schedule can run (inclusive).
`scheduleType`	string enum	Required. RECURRING.
`frequency`	string enum	Required. Recurrence frequency for a schedule. • DAILY • WEEKLY • MONTHLY
`endDate`	date \| null	Last date on which the schedule can run (inclusive); `null` means the schedule does not have a fixed end date.
`dayOfWeek`	string \| null enum	Day of the week on which the schedule runs when using WEEKLY frequency. • MONDAY • TUESDAY • WEDNESDAY • THURSDAY • FRIDAY • SATURDAY • SUNDAY
`dayOfMonth`	int32 \| null 1 to 31	Day of the month on which the schedule runs when using MONTHLY frequency.

Example request

curl --request POST \
     --url https://platform-reporting.vertexcloud.com/api/v1/schedules \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "enabled": true,
  "scheduleType": "RECURRING",
  "frequency": "WEEKLY",
  "definitionId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "name": "Weekly Sales Summary",
  "startDate": "2026-02-01"
}
'

Response

The following table lists the ONE_TIME schedule details provided in the request response.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`definitionId`	uuid	Unique identifier for the report definition associated with the schedule.
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Indicates whether the schedule is currently enabled.
`timeOfDay`	string	Time of day at which the schedule triggers, in HH:mm format.
`startDate`	date	First date on which the schedule can run (inclusive).
`createdDateTime`	date-time	Creation timestamp of the schedule.
`modifiedDateTime`	date-time	Last modification timestamp of the schedule.
`lastRunDateTime`	date-time \| null	Timestamp of the most recent run, if available.
`nextRunDateTime`	date-time \| null	Calculated timestamp of the next run, if available.
`scheduleType`	string enum	The type of schedule. • ONE_TIME

The following table lists the RECURRING schedule details provided in the request response.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`definitionId`	uuid	Unique identifier for the report definition associated with the schedule
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Indicates whether the schedule is currently enabled.
`timeOfDay`	string	Time of day at which the schedule triggers, in HH:mm format.
`startDate`	date	First date on which the schedule can run (inclusive).
`createdDateTime`	date-time	Creation timestamp of the schedule.
`modifiedDateTime`	date-time	Last modification timestamp of the schedule.
`lastRunDateTime`	date-time \| null	Timestamp of the most recent run, if available.
`nextRunDateTime`	date-time \| null	Calculated timestamp of the next run, if available.
`scheduleType`	string enum	The type of schedule. • RECURRING
`frequency`	string enum	Recurrence frequency for a schedule • DAILY • WEEKLY • MONTHLY
`endDate`	date \| null	Last date on which the schedule can be run (inclusive). `null` means the schedule does not have a fixed end date.
`dayOfWeek`	string \| null enum	Day of the week on which the schedule runs when using WEEKLY frequency. • MONDAY • TUESDAY • WEDNESDAY • THURSDAY • FRIDAY • SATURDAY • SUNDAY
`dayOfMonth`	int32 \| null 1 to 31	Day of the month on which the schedule runs when using MONTHLY frequency.

Example response

{
  "id": "7b9c2f34-82e5-4a19-9e5e-4d3fa812c001",
  "definitionId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "name": "Weekly Sales Summary",
  "description": null,
  "enabled": true,
  "timeOfDay": "00:00",
  "startDate": "2026-02-01",
  "endDate": null,
  "frequency": "WEEKLY",
  "dayOfWeek": null,
  "dayOfMonth": null,
  "createdDateTime": "2026-01-19T21:56:02Z",
  "modifiedDateTime": "2026-01-19T21:56:02Z",
  "lastRunDateTime": null,
  "nextRunDateTime": null,
  "scheduleType": "RECURRING"
}

Delete all schedules for report definition

Delete all schedules associated with a specific report definition.

Request

Only the reportId parameter is required as a path parameter.

Parameter name	Parameter format	Parameter description
`reportId`	uuid	Unique identifier of the report definition.

Example request

curl --request DELETE \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports/f81d4fae-7dec-11d0-a765-00a0c91e6bf6/schedules \
     --header 'accept: application/json'

Response

All schedules associated with the given report definition are deleted and an HTTP 204 No Content response is returned on successful completion of the request.

Get schedule

Retrieve full metadata for a single schedule.

Request

Only the scheduleId parameter is required as a path parameter.

Parameter name	Parameter format	Parameter description
`scheduleId`	uuid	Unique identifier of the schedule.

Example request

curl --request GET \
     --url https://platform-reporting.vertexcloud.com/api/v1/schedules/f81d4fae-7dec-11d0-a765-00a0c91e6bf6 \
     --header 'accept: application/json'

Response

The following table lists the schedule details provided in the request response for a ONE_TIME schedule type.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`definitionId`	uuid	Unique identifier for the report definition associated with the schedule.
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Indicates whether the schedule is currently enabled.
`timeOfDay`	string	Time of day at which the schedule triggers, in HH:mm format.
`startDate`	date	First date on which the schedule can run (inclusive).
`createdDateTime`	date-time	Creation timestamp of the schedule.
`modifiedDateTime`	date-time	Last modification timestamp of the schedule.
`lastRunDateTime`	date-time \| null	Timestamp of the most recent run, if available.
`nextRunDateTime`	date-time \| null	Calculated timestamp of the next run, if available.
`scheduleType`	string enum	The type of schedule. • ONE_TIME

The following table lists the schedule details provided in the request response for a RECURRING schedule type.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`definitionId`	uuid	Unique identifier for the report definition associated with the schedule.
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Indicates whether the schedule is currently enabled.
`timeOfDay`	string	Time of day at which the schedule triggers, in HH:mm format.
`startDate`	date	First date on which the schedule can run (inclusive).
`createdDateTime`	date-time	Creation timestamp of the schedule.
`modifiedDateTime`	date-time	Last modification timestamp of the schedule.
`lastRunDateTime`	date-time \| null	Timestamp of the most recent run, if available.
`nextRunDateTime`	date-time \| null	Calculated timestamp of the next run, if available.
`scheduleType`	string enum	The type of schedule. • RECURRING
`frequency`	string enum	Recurrence frequency for a schedule. • DAILY • WEEKLY • MONTHLY
`endDate`	date \| null	Last date on which the schedule can be run (inclusive); `null` means the schedule does not have a fixed end date.
`dayOfWeek`	string \| null enum	Day of the week on which the schedule runs when using WEEKLY frequency. • MONDAY • TUESDAY • WEDNESDAY • THURSDAY • FRIDAY • SATURDAY • SUNDAY
`dayOfMonth`	int32 \| null 1 to 31	Day of the month on which the schedule runs when using MONTHLY frequency.

Example response

{
  "id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "definitionId": "3c7d9ab1-4e77-4b53-ac7f-324b920b5c11",
  "name": "Weekly Sales Summary",
  "description": "Generates weekly sales metrics",
  "enabled": true,
  "timeOfDay": "09:30",
  "startDate": "2026-02-01",
  "endDate": null,
  "frequency": "WEEKLY",
  "dayOfWeek": "MONDAY",
  "dayOfMonth": null,
  "createdDateTime": "2026-01-10T14:22:11Z",
  "modifiedDateTime": "2026-01-15T09:41:32Z",
  "lastRunDateTime": "2026-01-19T09:30:00Z",
  "nextRunDateTime": "2026-01-26T09:30:00Z",
  "scheduleType": "RECURRING"
}

Update schedule

Update an existing schedule. All updatable fields are replaced with the values provided in the request.

Request

The scheduleId parameter is required as a path parameter.

Parameter name	Parameter format	Parameter description
`scheduleId`	uuid	Unique identifier of the schedule.

The following parameters can be included in the request body when updating a schedule.

Response field	Type	Description
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`scheduleType`	string enum	The type of schedule. • ONE_TIME • RECURRING
`frequency`	string enum	Recurrence frequency for a schedule • DAILY • WEEKLY • MONTHLY
`endDate`	date \| null	Last date on which the schedule can be run (inclusive); `null` means the schedule does not have a fixed end date.
`dayOfWeek`	string \| null enum	Day of the week on which the schedule runs when using WEEKLY frequency. • MONDAY • TUESDAY • WEDNESDAY • THURSDAY • FRIDAY • SATURDAY • SUNDAY
`dayOfMonth`	int32 \| null 1 to 31	Day of the month on which the schedule runs when using MONTHLY frequency.

Example request

curl --request PUT \
     --url https://platform-reporting.vertexcloud.com/api/v1/schedules/f81d4fae-7dec-11d0-a765-00a0c91e6bf6 \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "name": "Weekly Sales Report",
  "scheduleType": "RECURRING",
  "frequency": "WEEKLY",
  "dayOfWeek": "MONDAY",
  "enabled": true
}
'

Response

The following table lists the schedule details provided in the request response for a ONE_TIME schedule type.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`definitionId`	uuid	Unique identifier for the report definition associated with the schedule
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Indicates whether the schedule is currently enabled.
`timeOfDay`	string	Time of day at which the schedule triggers, in HH:mm format.
`startDate`	date	First date on which the schedule can run (inclusive).
`createdDateTime`	date-time	Creation timestamp of the schedule.
`modifiedDateTime`	date-time	Last modification timestamp of the schedule.
`lastRunDateTime`	date-time \| null	Timestamp of the most recent run, if available.
`nextRunDateTime`	date-time \| null	Calculated timestamp of the next run, if available.
`scheduleType`	string enum	The type of schedule. • ONE_TIME

The following table lists the schedule details provided in the request response for a RECURRING schedule type.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`definitionId`	uuid	Unique identifier for the report definition associated with the schedule
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Indicates whether the schedule is currently enabled.
`timeOfDay`	string	Time of day at which the schedule triggers, in HH:mm format.
`startDate`	date	First date on which the schedule can run (inclusive).
`createdDateTime`	date-time	Creation timestamp of the schedule.
`modifiedDateTime`	date-time	Last modification timestamp of the schedule.
`lastRunDateTime`	date-time \| null	Timestamp of the most recent run, if available.
`nextRunDateTime`	date-time \| null	Calculated timestamp of the next run, if available.
`scheduleType`	string enum	The type of schedule. • RECURRING
`frequency`	string enum	Recurrence frequency for a schedule • DAILY • WEEKLY • MONTHLY
`endDate`	date \| null	Last date on which the schedule can be run (inclusive); `null` means the schedule does not have a fixed end date.
`dayOfWeek`	string \| null enum	Day of the week on which the schedule runs when using WEEKLY frequency. • MONDAY • TUESDAY • WEDNESDAY • THURSDAY • FRIDAY • SATURDAY • SUNDAY
`dayOfMonth`	int32 \| null 1 to 31	Day of the month on which the schedule runs when using MONTHLY frequency.

Example response

{
  "id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "definitionId": "3c7d9ab1-4e77-4b53-ac7f-324b920b5c11",
  "name": "Weekly Sales Report",
  "description": null,
  "enabled": true,
  "timeOfDay": "09:30",
  "startDate": "2026-02-01",
  "endDate": null,
  "frequency": "WEEKLY",
  "dayOfWeek": "MONDAY",
  "dayOfMonth": null,
  "createdDateTime": "2026-01-10T14:22:11Z",
  "modifiedDateTime": "2026-01-19T22:10:45Z",
  "lastRunDateTime": "2026-01-19T09:30:00Z",
  "nextRunDateTime": "2026-01-26T09:30:00Z",
  "scheduleType": "RECURRING"
}

Delete schedule

Delete a schedule.

Request

Only the scheduleId parameter is required as a path parameter.

Parameter name	Parameter format	Parameter description
`scheduleId`	uuid	Unique identifier of the schedule.

Example request

curl --request DELETE \
     --url https://platform-reporting.vertexcloud.com/api/v1/schedules/f81d4fae-7dec-11d0-a765-00a0c91e6bf6 \
     --header 'accept: application/json'

Response

The schedule associated with the given schedule ID is deleted and an HTTP 204 No Content response is returned on successful completion of the request.