Import a schedule definition

Import a PBRS-exported definition. The import family is selected from exported attributes, in this order: event package when ScheduleAttr.EventPackID and EventPackageAttr are populated; event-based when event definitions or conditions are present; package when ScheduleAttr.PackID and PackageAttr are populated; automation when ScheduleAttr.AutoID and AutomationAttr are populated; otherwise report. There is no single ScheduleType discriminator property on the import request. Preserve compatible exported collections and external prerequisites. The response wraps a string in returnModel; it is not a fixed nested object. Do not assume import is transactional or idempotent. Verify created objects and reconcile before retrying. For automation imports, returnModel contains JSON-encoded diagnostics for the imported attributes, with Value and Type entries. The example corresponds to an automation import with no tasks. Destination IDs are assigned during import. Diagnostic fields can vary with the exported collections.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Example of a disabled automation definition with no tasks. Matching ScheduleAttr.AutoID and AutomationAttr.AutoID select automation import. For migration, use a compatible PBRS export and preserve its dependent records and relationships. Map folder, account and report prerequisites for the selected import family. Send application/json or application/x-www-form-urlencoded. Use JSON to represent nested objects, arrays and explicit null values. For form requests, send individual bracketed fields; do not serialize the entire schedule into a field named model.

Full schedule-import wire schema, including every nested exported attribute. Start with an actual PBRS schedule export compatible with the destination installation. Attribute names and casing are significant documentation identifiers. The required collections depend on the selected schedule type; do not construct a migration payload by combining unrelated schedule types. Importing a definition does not migrate credentials, accounts or external report assets automatically.

ReportAttr
array of objects | null
ReportAttr
ImportScheduleAttributesInput | object,null
DestinationAttr
array of objects | null
DestinationAttr
ReportOptions
array of objects | null
ReportOptions
ReportParameters
array of objects | null
ReportParameters
BlankReportAlerts
array of objects | null
BlankReportAlerts
ImportPGPAttributesInput | object,null
ImportPrinterAttributesInput | object,null
ReportDatasource
array of objects | null
ReportDatasource
PowerBIDatasetRefresh
array of objects | null
PowerBIDatasetRefresh
ImportPowerBIOptionsInput | object,null
PowerBIVisualsDataExportAttr
array of objects | null
PowerBIVisualsDataExportAttr
ReportTable
array of objects | null
ReportTable
PowerBIFilter
array of objects | null
PowerBIFilter
Tasks
array of objects | null
Tasks
PaginatedReportParameters
array of objects | null
PaginatedReportParameters
ImportDataDrivenAttributesInput | object,null
ImportEventPackageAttributesInput | object,null
EventSubAttr
array of objects | null
EventSubAttr
EventSchedule
array of objects | null
EventSchedule
EventConditions
array of objects | null
EventConditions
ImportEventAttributesInput | object,null
ImportAutomationAttributesInput | object,null
PackagedReportAttr
array of objects | null
PackagedReportAttr
ImportPackageAttributesInput | object,null
EventAttr6Packages
array of objects | null
EventAttr6Packages
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json