1. REST API for Oracle Analytics Publisher in Oracle Analytics Server
  2. Tasks
  3. Manage Jobs

Schedule a job with parameters

put

/services/rest/v1/jobs/scheduleJob

Schedules a job with the parameter values provided.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

Returns the job ID of the scheduled job.
Body ()
Root Schema : ScheduleRequest
Type: object
Show Source
Nested Schema : DeliveryChannels
Type: object
Show Source
Nested Schema : ReportRequest
Type: object
Show Source
Nested Schema : ArrayOfEmailDeliveryOption
Type: object
Show Source
Nested Schema : ArrayOfFaxDeliveryOption
Type: object
Show Source
Nested Schema : ArrayOfFTPDeliveryOption
Type: object
Show Source
Nested Schema : ArrayOfLocalDeliveryOption
Type: object
Show Source
Nested Schema : ArrayOfObjectStorageDeliveryOption
Type: object
Show Source
Nested Schema : ArrayOfPrintDeliveryOption
Type: object
Show Source
Nested Schema : ArrayOfWCCDeliveryOption
Type: object
Show Source
Nested Schema : ArrayOfWebDavDeliveryOption
Type: object
Show Source
Nested Schema : item
Type: array
An array of EMailDeliveryOption
Show Source
Nested Schema : EMailDeliveryOption
Type: object
Show Source
Nested Schema : item
Type: array
An array of FaxDeliveryOption
Show Source
Nested Schema : FaxDeliveryOption
Type: object
Show Source
Nested Schema : item
Type: array
An array of FTPDeliveryOption
Show Source
Nested Schema : FTPDeliveryOption
Type: object
Show Source
Nested Schema : item
Type: array
An array of LocalDeliveryOption
Show Source
Nested Schema : LocalDeliveryOption
Type: object
Show Source
Nested Schema : item
Type: array
An array of ObjectStorageDeliveryOption
Show Source
Nested Schema : ObjectStorageDeliveryOption
Type: object
Show Source
Nested Schema : item
Type: array
An array of PrintDeliveryOption
Show Source
Nested Schema : PrintDeliveryOption
Type: object
Show Source
Nested Schema : item
Type: array
An array of WCCDeliveryOption
Show Source
Nested Schema : WCCDeliveryOption
Type: object
Show Source
Nested Schema : item
Type: array
An array of WebDavDeliveryOption
Show Source
Nested Schema : WebDavDeliveryOption
Type: object
Show Source
Nested Schema : BIPDataSource
Type: object
Show Source
Nested Schema : ParamNameValues
Type: object
Show Source
Nested Schema : MetaDataList
Type: object
Show Source
Nested Schema : FileDataSource
Type: object
Show Source
  • To specify a path to a data source that resides on an available server, specify the full path to the data source and set temporaryDataSource to "false". For example: "D:\BI\OracleBI\xmlp\XMLP\DemoFiles\Balance.xml")" If the file is located in the system temporary directory, set temporaryDataSource to true, and specify the file name here. For example: "Balance.xml".
  • Default Value: false
    Set to "true" when the file data source is in the system temporary directory. Set to "false" when dynamicDataSourcePath specifies the full path.
Nested Schema : JDBCDataSource
Type: object
Show Source
  • The Data Source Name assigned to the data source in the Oracle BI Publisher data source definition page (for example, Oracle).
  • The JDBC driver class for the data source (for example, oracle.jdbc.OracleDriver).
  • The driver type as defined in the Oracle BI Publisher data source definition page (for example, Oracle10g/11g/12c).
  • The password for the data source as defined in the Oracle BI Publisher data source definition page.
  • The connection string for the data source (for example, jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl).
  • The user name for the data source as defined in the Oracle BI Publisher data source definition page.
  • Enter a PL/SQL function to execute when a connection is closed (Post Process).
  • Enter a PL/SQL function to execute when a connection is created (Pre Process).
  • Default Value: false
    Enable Proxy Authentication.
Nested Schema : listOfParamNameValues
Type: array
An array of ParamNameValue
Show Source
Nested Schema : ParamNameValue
Type: object
Show Source
  • Valid values include: Boolean Date Float Integer String
  • If UIType is "Date", this specifies the Date Format String. The date format string must be a Java date format (for example, MM-DD-YYYY).
  • If UIType is "Date", this specifies the begin value of the date.
  • If UIType is "Date", this specifies the end value of the date.
  • Specifies the default value of the parameter.
  • For parameter types "Text" and "Date", specifies the text field size for the parameter.
  • For all parameter types except "Hidden", specifies the display label for the parameter.
  • lovLabels
    If the parameter type is "Menu", specifies the values displayed in the list of values to the user.
  • True indicates that a parameter may contain multiple values.
  • The parameter name.
  • For parameter types "Text" and "Menu", a value of true for this parameter indicates that other defined parameters should be refreshed when a selection is made for this parameter.
  • For parameter type "Menu", a value of true indicates that all values can be selected for the LOV.
  • A value of true indicates the parameter is defined in the RTF template.
  • The type of parameter as defined in the Oracle BI Publisher data model user interface. Valid values include: Date Hidden Menu Search Text
  • For parameter type "Menu", a value of true indicates that a null will be passed if all values are selected for the parameter.
  • values
    Parameter values.
Nested Schema : lovLabels
Type: array
If the parameter type is "Menu", specifies the values displayed in the list of values to the user.
Show Source
Nested Schema : values
Type: array
Parameter values.
Show Source
Back to Top

Examples

The following examples shows how to schedule a job by submitting a PUT request on the REST resource using cURL.

Schedule a job to run now

The following shows how to schedule a job immediately by submitting a PUT request on the REST resource using cURL. You must specify the data model and the report template.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request PUT –d '{"dataModelUrl":"my model URL","reportRequest":{"reportAbsolutePath":"/Sample Lite/Published Reporting/Reports/Balance Letter.xdo", "attributeFormat":"pdf"}}' 'https://hostname/xmlpserver/services/rest/v1/jobs/scheduleJob'

Schedule a job to run later

The following shows how to schedule a job to run at a specified date and time by submitting a PUT request on the REST resource using cURL. You must specify the data model and the report template.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request PUT -d
        '{"dataModelUrl":"my model URL","startDate":"2024-11-01T09:45:00.000","reportRequest":{"reportAbsolutePath":"/Sample
        Lite/Published Reporting/Reports/Balance Letter.xdo", "attributeFormat":"pdf"}}' '
https://hostname/xmlpserver/services/rest/v1/jobs/scheduleJob'

Schedule a job to save data and output

The following shows how to schedule a job and save data and output by submitting a PUT request on the REST resource using cURL. You must specify the data model, report template, and output format. If you save data and output, you can view and download the XML data and output.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request PUT -d
        '{"dataModelUrl":"/Sample/Published Reporting/Data Models/BalanceLetter
        Datamodel.xdm","saveOutputOption":"true","saveDataOption":"true","reportRequest":{"reportAbsolutePath":"/Sample
        Lite/Published Reporting/Reports/Balance
        Letter.xdo","attributeFormat":"pdf"}}' 'https://hostname/xmlpserver/services/rest/v1/jobs/scheduleJob'

Schedule a job to run daily

The following shows how to schedule a job to run daily at a specified date and time by submitting a PUT request on the REST resource using cURL. You must specify the data model, report template, job start date and time, job end date and time, and the job run frequency.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request PUT -d
      '{"dataModelUrl":"/Sample Lite/Published Reporting/Data Models/BalanceLetter
      Datamodel.xdm","startDate":"2024-10-01T09:45:00.000","endDate":"2025-10-01T09:45:00.000","recurrenceExpression":"0
      0 12 * * ?","reportRequest":{"reportAbsolutePath":"/Sample Lite/Published
      Reporting/Reports/Balance Letter.xdo", "attributeFormat":"pdf"}}' 'https://hostname/xmlpserver/services/rest/v1/jobs/scheduleJob'

Schedule a job to run weekly

The following shows how to schedule a job to run every Thursday by submitting a PUT request on the REST resource using cURL. You must specify the data model, report template, job start date and time, job end date and time, and the day of the week for running the job.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request PUT -d
        '{"dataModelUrl":"/Sample Lite/Published Reporting/Data Models/BalanceLetter
        Datamodel.xdm","startDate":"2024-10-01T09:45:00.000","endDate":"2025-10-01T09:45:00.000","recurrenceExpression":"0
        0 12 ? * THU *","reportRequest":{"reportAbsolutePath":"/Sample Lite/Published
        Reporting/Reports/Balance Letter.xdo"}}' 'https://hostname/xmlpserver/services/rest/v1/jobs/scheduleJob'

Schedule a job with a custom name

The following shows how to schedule a job with a custom job name to run later by submitting a PUT request on the REST resource using cURL. You must specify the data model, report template, and the job start date and time.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request PUT -v -d
        '{"dataModelUrl" "my model URL","userJobName":"test from
        rest","startDate":"2024-10-01T09:45:00.000","reportRequest":{"reportAbsolutePath":"/Sample
        Lite/Published Reporting/Reports/Balance Letter.xdo"}}' 'https://hostname/xmlpserver/services/rest/v1/jobs/scheduleJob'

Schedule a job to deliver output to Object Storage

The following shows how to schedule a job to deliver the output to Object Storage by submitting a PUT request on the REST resource using cURL. You must specify the job name, report path, Object Storage server name, file prefix, and file name.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request PUT -v -d
 '{"userJobName":"restdeliverydemo2","saveOutputOption":"true",
"saveDataOption":"true",
"reportRequest":{"reportAbsolutePath":"~admin/Discrete Job Data Report.xdo","attributeFormat":"pdf"},
"deliveryChannels":{"objectStorageOptions":{"item":
[{"serverName":"obj","filePrefix":"bipdelivery/demo","fileName":"bipdemo3.pdf"}]}}}'
 'https://hostname/xmlpserver/services/rest/v1/jobs/scheduleJob'

Schedule a bursting job

The following shows how to schedule a bursting job immediately by submitting a PUT request on the REST resource using cURL. You must specify the data model and the report template. Make sure that the bursting property is checkmarked in report properties.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request PUT -v –d '{"dataModelUrl":"my model URL","reportRequest":{"reportAbsolutePath":"/Sample Lite/Published Reporting/Reports/Balance Letter.xdo"}}' 'https://hostname/xmlpserver/services/rest/v1/jobs/scheduleJob'

Schedule a bursting job with parameters

The following shows how to schedule a bursting job with parameters by submitting a PUT request on the REST resource using cURL. You must specify the data model and the report template. Make sure that the bursting property is checkmarked in report properties.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request PUT -d
      '{"dataModelUrl":"data model URL","userJobName":"test from rest
      5","scheduleBurstringOption":"true","saveDataOption":"true","reportRequest":{"reportAbsolutePath":"/~admin/00.BIPDS-Test/BurstingQueryWithParameterReport.xdo",
      "parameterNameValues": { "listOfParamNameValues": { "item": [{ "name": "P_DEPT_ID",
      "values":  { "item": [ 20] }} , { "name": "P_TEMPLATE", "values":  { "item":
      ["simple"] } }] }} }} ' 'https://hostname/xmlpserver/services/rest/v1/jobs/scheduleJob'
Back to Top