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

Schedules endpoint	Schedule endpoint description
`/schedules`	GET - Retrieve a list of schedules for running report definitions, optionally filtered by template, category, status, name, frequency, and effective date range.
`/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. The operation is idempotent and returns a `204 No Content` HTTP status code even when no schedules remain.
`/reports/{reportId}/schedules/{scheduleId}`	DELETE - Delete a specific schedule associated with a given report definition. The schedule must belong to the specified report definition.
`/schedules/{scheduleId}`	PUT - Update an existing schedule. All updatable fields are replaced with the values provided in the request.
`/schedules/{scheduleId}`	GET - Retrieve full metadata for a single schedule.
`/schedules/{scheduleId}`	DELETE - Delete a schedule. The operation is idempotent and returns a `204 No Content` HTTP status code when the schedule has already been deleted.

List schedules

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

Request URL:

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

List schedules request

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

Parameter name	Parameter format	Parameter description
`templateId`	uuid	Filter by template UUID(s) (via the underlying report definition). Multiple values are combined as a union.
`categoryId`	uuid	Filter by report category UUID(s) (via the underlying report definition). Multiple values are combined as a union.
`enabled`	boolean	Filter by enabled status.
`scheduleType`	string enum	Filter by schedule type: `ONE_TIME` or `RECURRING`.
`frequency`	array of objects	Filter by recurrence frequency (multiple values combined as a union; only recurring schedules are returned when set).
`name`	string	Filter by schedule name (case-insensitive substring match).
`startDateFrom`	date, ISO-8601	Effective from this date onwards (ISO-8601 format, inclusive).
`startDateTo`	date, ISO-8601	Effective up to this date (ISO-8601 format, inclusive).
`offset`	integer	Number of items to skip (for pagination). Must be greater than or equal to 0. Defaults to 0.
`limit`	int32	Maximum number of items to return. Must be 1 to 100. Defaults to 25.
`sortBy`	string enum	Field to sort by. Allowed: `NAME`, `CREATED_AT`, `NEXT_RUN_AT`, `TEMPLATE_NAME`. `CATEGORY_NAME`, `FREQUENCY`. Defaults to `CREATED_AT`.
`sortOrder`	string enum	Sort direction. Allowed: `ASC` or `DESC`. Defaults to `ASC`.

List schedules request example

curl --request GET \
     --url 'https://platform-reporting.vertexcloud.com/api/v1/schedules?templateId=a3b9e1d2-54fb-4f32-8f02-6e9e8a8d7f10&enabled=true&scheduleType=RECURRING' \
     --header 'accept: application/json'

List schedules 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. Must be greater than or equal to 0.
`offset`	integer	Number of items skipped. Must be greater than or equal to 0.
`limit`	integer	Maximum items per page. Must be greater than or equal to 1.
`value`	array	Array of `ScheduleListResponse` objects.

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

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`reportId`	uuid	The uuid of the report definition associated with this schedule.
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`templateName`	string	Name of template associated with scheduled report.
`templateDisplayName`	string	Display name of template associated with scheduled report.
`categoryName`	string \| null	Name of template category associated with scheduled report.
`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. Allowed: `ONE_TIME` or `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. Allowed: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`.
`dayOfMonth`	int32 \| null	The day of the month the schedule runs when using monthly recurrence. Must be 1 to 31.
`monthOfYear`	int32 \| null	Month of year (1-12) on which the schedule runs when using `QUARTERLY` or `ANNUAL` frequency. Must be 1 to 12.

List schedules response example

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "value": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "templateName": "string",
      "templateDisplayName": "string",
      "categoryName": "string",
      "enabled": true,
      "timeOfDay": "09:30",
      "startDate": "2026-06-11",
      "createdDateTime": "2026-06-11T03:01:02.893Z",
      "modifiedDateTime": "2026-06-11T03:01:02.893Z",
      "lastRunDateTime": "2026-06-11T03:01:02.893Z",
      "nextRunDateTime": "2026-06-11T03:01:02.893Z",
      "scheduleType": "ONE_TIME"
    }
  ]
}

List schedules for report definition

Retrieve all schedules associated with a specific report definition.

Request URL:

https://platform-reporting.vertexcloud.com/api/v1/reports/{reportId}/schedules

List schedules for report definition request

Only the reportId is required as a path parameter.

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

These query parameters are optional.

Parameter name	Parameter format	Parameter description
`offset`	integer	Number of items to skip (for pagination). Must be greater than or equal to 0. Defaults to 0.
`limit`	int32	Maximum number of items to return. Must be 1 to 100. Defaults to 25.
`sortBy`	string enum	Field to sort by. Allowed: `NAME`, `CREATED_AT`, `NEXT_RUN_AT`, `TEMPLATE_NAME`. `CATEGORY_NAME`, `FREQUENCY`. Defaults to `CREATED_AT`.
`sortOrder`	string enum	Sort direction. Allowed: `ASC` or `DESC`. Defaults to `ASC`.

List schedules for report definition request example

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

List schedules for report definition 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. Must be greater than or equal to 0.
`offset`	integer	Number of items skipped. Must be greater than or equal to 0.
`limit`	integer	Maximum items per page. Must be greater than or equal to 1.
`value`	array	Array of `ScheduleListResponse` objects.

Fields you receive inside each item in the value[] array.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`reportId`	uuid	The uuid of the report definition associated with this schedule.
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`templateName`	string	Name of template associated with scheduled report.
`templateDisplayName`	string	Display name of template associated with scheduled report.
`categoryName`	string \| null	Name of template category associated with scheduled report.
`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. Allowed: `ONE_TIME` or `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. Allowed: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`.
`dayOfMonth`	int32 \| null	The day of the month the schedule runs when using monthly recurrence. Must be 1 to 31.
`monthOfYear`	int32 \| null	Month of year (1-12) on which the schedule runs when using `QUARTERLY` or `ANNUAL` frequency. Must be 1 to 12.

List schedules for report definition response example

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "value": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "templateName": "string",
      "templateDisplayName": "string",
      "categoryName": "string",
      "enabled": true,
      "timeOfDay": "09:30",
      "startDate": "2026-06-11",
      "createdDateTime": "2026-06-11T03:01:02.893Z",
      "modifiedDateTime": "2026-06-11T03:01:02.893Z",
      "lastRunDateTime": "2026-06-11T03:01:02.893Z",
      "nextRunDateTime": "2026-06-11T03:01:02.893Z",
      "scheduleType": "ONE_TIME"
    }
  ]
}

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 URL:

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

Create schedule request

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

The body parameters for a ONE_TIME schedule type.

Parameter name	Parameter format	Parameter description
`reportId` Required	uuid	The uuid of the report definition to schedule.
`name` Required	string	Human-readable name of the schedule. Length must be 1 to 64 characters.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Indicates whether the schedule is enabled when created. Defaults to `TRUE`.
`timeOfDay` Required	string	Time of day at which the schedule triggers, in `HH:mm` format.
`startDate` Required	date	First date on which the schedule can run (inclusive).
`scheduleType` Required	string enum	The type of schedule. In this case `ONE_TIME`.

The body parameters for a RECURRING schedule type.

Parameter name	Parameter format	Parameter description
`reportId` Required	uuid	The uuid of the report definition to schedule.
`name` Required	string	Human-readable name of the schedule.
`description`	string \| null	Optional description of the schedule.
`enabled` Required	boolean	Indicates whether the schedule is enabled when created.
`timeOfDay` Required	string	Time of day at which the schedule triggers, in `HH:mm` format.
`startDate` Required	date	First date on which the schedule can run (inclusive).
`scheduleType` Required	string enum	The type of schedule. In this case `RECURRING`.
`frequency` Required	string enum	Required. Recurrence frequency for a schedule. Allowed: `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `ANNUAL`.
`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. Allowed: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`.
`dayOfMonth`	int32 \| null	Day of the month on which the schedule runs when using `MONTHLY` frequency. Must be 1 to 31.
`monthOfYear`	int32 \| null	Month of year (1-12) on which the schedule runs when using `QUARTERLY` or `ANNUAL` frequency. Must be 1 to 12.

Create schedule request example

curl --request POST \
     --url https://platform-reporting.vertexcloud.com/api/v1/schedules \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "scheduleType": "RECURRING",
  "frequency": "DAILY",
  "reportId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "name": "Example",
  "description": "Test Report",
  "enabled": true,
  "timeOfDay": "09:30",
  "startDate": "2026-02-01"
}
'

Create schedule response

The ONE_TIME schedule details provided in the request response.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`reportId`	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. In this case `ONE_TIME`.

The RECURRING schedule details provided in the request response.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`reportId`	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. In this case `RECURRING`.
`frequency`	string enum	Recurrence frequency for a schedule. Allowed: `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `ANNUAL`.
`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	The day of the week the schedule runs when using weekly recurrence. Allowed: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`.
`dayOfMonth`	int32 \| null	Day of the month on which the schedule runs when using `MONTHLY` frequency. Must be 1 to 31.
`monthOfYear`	int32 \| null	Month of year (1-12) on which the schedule runs when using `QUARTERLY` or `ANNUAL` frequency. Must be 1 to 12.

Create schedule response example

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Daily",
  "description": "Daily Sales Summary",
  "templateName": "string",
  "templateDisplayName": "string",
  "categoryName": "string",
  "enabled": true,
  "timeOfDay": "09:30",
  "startDate": "2026-06-11",
  "createdDateTime": "2026-06-11T03:01:02.893Z",
  "modifiedDateTime": "2026-06-11T03:01:02.893Z",
  "lastRunDateTime": "2026-06-11T03:01:02.893Z",
  "nextRunDateTime": "2026-06-11T03:01:02.893Z",
  "scheduleType": "ONE_TIME"
}

Delete all schedules for a report definition

Delete all schedules associated with a specific report definition.

Request URL:

https://platform-reporting.vertexcloud.com/api/v1/reports/{reportId}/schedules

Delete all schedules for a report definition request

Only the reportId parameter is required as a path parameter.

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

Delete all schedules for a report definition request example

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

Delete all schedules for a report definition response

All schedules deleted successfully or were already absent.

A 204 No Content HTTP status code indicates that the request succeeded. There is no other content or message body.

Delete a specific schedule for a report definition

Delete a specific schedule associated with a given report definition. The schedule must belong to the specified report definition.

Request URL:

https://platform-reporting.vertexcloud.com/api/v1/reports/{reportId}/schedules/{scheduleId}

Delete a specific schedule for a report definition request

The reportId and scheduleId are required as path parameters.

Parameter name	Parameter format	Parameter description
`reportId` Required	uuid	The uuid of the report definition.
`scheduleId` Required	uuid	The uuid of the report schedule.

Delete a specific schedule for a report definition request example

curl --request DELETE \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports/f81d4fae-7dec-11d0-a765-00a0c91e6bf6/schedules/3c7d9ab1-4e77-4b53-ac7f-324b920b5c11 \
     --header 'accept: application/json'

Delete a specific schedule for a report definition response

Schedule deleted successfully.

A 204 No Content HTTP status code indicates that the request succeeded. There is no other content or message body.

Update schedule

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

Request URL:

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

Update schedule request

The scheduleId is required as a path parameter.

Parameter name	Parameter format	Parameter description
`scheduleId` Required	uuid	The uuid of the schedule.

Include these parameters in the request body when updating a schedule.

Response field	Type	Description
`name` Required	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`enabled`	boolean	Indicates whether the schedule is enabled. Defaults to `true`.
`scheduleType` Required	string enum	The type of schedule: `ONE_TIME`, `RECURRING`.
`frequency`	string enum	Recurrence frequency for a schedule: `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `ANNUAL`.
`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	Day of the month on which the schedule runs when using `MONTHLY` frequency. Must be 1 to 31.
`monthOfYear`	int32 \| null	Month of year (1-12) on which the schedule runs when using `QUARTERLY` or `ANNUAL` frequency. Must be 1 to 12.
`timeOfDay`	string	Time of day at which the schedule triggers, in `HH:mm` format

Update schedule request example

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
}
'

Update schedule response

The ONE_TIME schedule details provided in the response.

Response field	Type	Description
`id`	string (UUID)	UUID for the schedule.
`reportId`	uuid	UUID for the report definition associated with the schedule.
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`templateName`	string	Name of template associated with scheduled report.
`templateDisplayName`	string	Display name of template associated with scheduled report.
`categoryName`	string \| null	Name of template category associated with scheduled report.
`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. In this case `ONE_TIME`.

The RECURRING schedule details provided in the response.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`reportId`	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.
`templateName`	string	Name of template associated with scheduled report.
`templateDisplayName`	string	Display name of template associated with scheduled report.
`categoryName`	string \| null	Name of template category associated with scheduled report.
`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. In this case `RECURRING`.
`frequency`	string enum	Recurrence frequency for a schedule. Allowed: `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `ANNUAL`.
`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	The day of the week the schedule runs when using weekly recurrence. Allowed: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`.
`dayOfMonth`	int32 \| null	Day of the month on which the schedule runs when using `MONTHLY` frequency. Must be 1 to 31.
`monthOfYear`	int32 \| null	Month of year (1-12) on which the schedule runs when using `QUARTERLY` or `ANNUAL` frequency. Must be 1 to 12.

Update schedule response example

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "templateName": "string",
  "templateDisplayName": "string",
  "categoryName": "string",
  "enabled": true,
  "timeOfDay": "09:30",
  "startDate": "2026-06-11",
  "createdDateTime": "2026-06-11T03:01:02.893Z",
  "modifiedDateTime": "2026-06-11T03:01:02.893Z",
  "lastRunDateTime": "2026-06-11T03:01:02.893Z",
  "nextRunDateTime": "2026-06-11T03:01:02.893Z",
  "scheduleType": "ONE_TIME"
}

Get schedule

Retrieve full metadata for a single schedule.

Request URL:

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

Get schedule request

Only the scheduleId parameter is required as a path parameter.

Parameter name	Parameter format	Parameter description
`scheduleId` Required	uuid	The uuid of the schedule.

Get schedule request example

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

Get schedule response

The schedule details provided in the response for a ONE_TIME schedule type.

Response field	Type	Description
`id`	string (UUID)	UUID for the schedule.
`reportId`	uuid	UUID for the report definition associated with the schedule.
`name`	string	Human‑readable schedule name.
`description`	string \| null	Optional description of the schedule.
`templateName`	string	Name of template associated with scheduled report.
`templateDisplayName`	string	Display name of template associated with scheduled report.
`categoryName`	string \| null	Name of template category associated with scheduled report.
`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. In this case `ONE_TIME`.

The schedule details provided in the response for a RECURRING schedule type.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the schedule.
`reportId`	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.
`templateName`	string	Name of template associated with scheduled report.
`templateDisplayName`	string	Display name of template associated with scheduled report.
`categoryName`	string \| null	Name of template category associated with scheduled report.
`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. In this case `RECURRING`.
`frequency`	string enum	Recurrence frequency for a schedule. Allowed: `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `ANNUAL`.
`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	The day of the week the schedule runs when using weekly recurrence. Allowed: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`.
`dayOfMonth`	int32 \| null	Day of the month on which the schedule runs when using `MONTHLY` frequency. Must be 1 to 31.
`monthOfYear`	int32 \| null	Month of year (1-12) on which the schedule runs when using `QUARTERLY` or `ANNUAL` frequency. Must be 1 to 12.

Get schedule response example

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "templateName": "string",
  "templateDisplayName": "string",
  "categoryName": "string",
  "enabled": true,
  "timeOfDay": "09:30",
  "startDate": "2026-06-11",
  "createdDateTime": "2026-06-11T03:01:02.893Z",
  "modifiedDateTime": "2026-06-11T03:01:02.893Z",
  "lastRunDateTime": "2026-06-11T03:01:02.893Z",
  "nextRunDateTime": "2026-06-11T03:01:02.893Z",
  "scheduleType": "ONE_TIME"
}

Delete schedule

Delete a schedule.

Request URL:

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

Delete schedule request

Only the scheduleId parameter is required as a path parameter.

Parameter name	Parameter format	Parameter description
`scheduleId` Required	uuid	The uuid of the schedule.

Delete schedule request example

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

Delete schedule response

Schedule deleted successfully or it no longer exists.

A 204 No Content HTTP status code indicates that the request succeeded. There is no other content or message body.