CLcloudblue
Reports

GET /reporting/schedules

Changed on

Get the report schedules available in the collection.

Request

  • Base URL
    https://api.connect.cloudblue.com/public/v1
  • Auth
    API key in header Authorization

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

events.created.atstring date-time

Filter for: events.created.at

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

events.last_execution.atstring date-time

Filter for: events.last_execution.at

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

events.next_execution.atstring date-time

Filter for: events.next_execution.at

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

events.updated.atstring date-time

Filter for: events.updated.at

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

namestring

Filter for: name

lookups: eq, ne, like, ilike, in, out

ordering: true

status'enabled' | 'disabled'

Filter for: status

lookups: eq, ne, like, ilike, in, out

ordering: true

template.idstring

Filter for: template.id

lookups: eq, ne, like, ilike, null, in, out

ordering: true

template.local_idstring

Filter for: template.local_id

lookups: eq, ne, like, ilike, in, out

ordering: true

template.namestring

Filter for: template.name

lookups: eq, ne, like, ilike, in, out

ordering: true

template.type'system' | 'custom'

Filter for: template.type

lookups: eq, ne, like, ilike, in, out

ordering: true

trigger.frequency'daily' | 'weekly' | 'monthly'

Filter for: trigger.frequency

lookups: eq, ne, like, ilike, in, out

ordering: true

Response

idstring
namestring required
descriptionstring nullable
notesstring nullable
parametersobject[] nullable required
status'enabled' | 'disabled'
rendererstring

Changes

  • 2de715cbd1f3Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 22a697bcb678Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      deleted the query request parameter limit

    • warning

      deleted the query request parameter offset

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status