1. Oracle Analytics ServerでのOracle Analytics PublisherのためのREST API
  2. タスク
  3. ジョブの管理

パラメータを指定したジョブのスケジュール

put

/services/rest/v1/jobs/scheduleJob

パラメータ値を指定してジョブをスケジュールします。

リクエスト

この操作のリクエスト・パラメータはありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

200レスポンス

スケジュールしたジョブのジョブIDを返します。
本文 ()
ルート・スキーマ: ScheduleRequest
型: object
ソースを表示
ネストされたスキーマ: DeliveryChannels
型: object
ソースを表示
ネストされたスキーマ: ReportRequest
型: object
ソースを表示
ネストされたスキーマ: ArrayOfEmailDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: ArrayOfFaxDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: ArrayOfFTPDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: ArrayOfLocalDeliveryOption
型: object
ソースを表示
ネストされたスキーマ : ArrayOfObjectStorageDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: ArrayOfPrintDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: ArrayOfWCCDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: ArrayOfWebDavDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: item
型: array
EMailDeliveryOptionの配列
ソースを表示
ネストされたスキーマ: EMailDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: item
型: array
FaxDeliveryOptionの配列
ソースを表示
ネストされたスキーマ: FaxDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: item
型: array
FTPDeliveryOptionの配列
ソースを表示
ネストされたスキーマ: FTPDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: item
型: array
LocalDeliveryOptionの配列
ソースを表示
ネストされたスキーマ: LocalDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: item
型: array
ObjectStorageDeliveryOptionの配列
ソースを表示
ネストされたスキーマ : ObjectStorageDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: item
型: array
PrintDeliveryOptionの配列
ソースを表示
ネストされたスキーマ: PrintDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: item
型: array
WCCDeliveryOptionの配列
ソースを表示
ネストされたスキーマ: WCCDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: item
型: array
WebDavDeliveryOptionの配列
ソースを表示
ネストされたスキーマ: WebDavDeliveryOption
型: object
ソースを表示
ネストされたスキーマ: BIPDataSource
型: object
ソースを表示
ネストされたスキーマ: ParamNameValues
型: object
ソースを表示
ネストされたスキーマ: MetaDataList
型: object
ソースを表示
ネストされたスキーマ: FileDataSource
型: object
ソースを表示
  • 特定のサーバー上に存在するデータソースへのパスを指定するには、データソースへのフルパスを指定し、temporaryDataSourceをfalseに設定します。たとえば、"D:\BI\OracleBI\xmlp\XMLP\DemoFiles\Balance.xml")"となります。ファイルがシステムの一時ディレクトリにある場合は、temporaryDataSourceをtrueに設定して、ファイル名をここで指定します。たとえば、"Balance.xml"となります。
  • デフォルト値: false
    ファイル・データソースがシステム一時ディレクトリにある場合はtrueに設定します。dynamicDataSourcePathでフルパスを指定する場合はfalseに設定します。
ネストされたスキーマ: JDBCDataSource
型: object
ソースを表示
  • Oracle BI Publisherデータ・ソース定義ページでデータ・ソースに割り当てられたデータ・ソース名です(たとえば、Oracle)。
  • データソースのJDBCドライバ・クラスです(たとえば、oracle.jdbc.OracleDriver)。
  • Oracle BI Publisherデータ・ソース定義ページで定義されているドライバのタイプです(たとえば、Oracle10g/11g/12c)。
  • Oracle BI Publisherデータ・ソース定義ページで定義されている、データ・ソースのパスワードです。
  • データソースの接続文字列です(たとえば、jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl)。
  • Oracle BI Publisherデータ・ソース定義ページで定義されている、データ・ソースのユーザー名です。
  • 接続が閉じたときに実行するPL/SQLファンクションを入力します(後処理)。
  • 接続が作成されたときに実行するPL/SQLファンクションを入力します(前処理)。
  • デフォルト値: false
    プロキシ認証を有効化します。
ネストされたスキーマ: listOfParamNameValues
型: array
ParamNameValueの配列
ソースを表示
ネストされたスキーマ: ParamNameValue
型: object
ソースを表示
  • 有効な値: Boolean Date Float Integer String
  • UITypeがDateの場合は、日付フォーマット文字列を指定します。日付フォーマット文字列にはJava日付フォーマットを使用する必要があります(MM-DD-YYYYなど)。
  • UITypeがDateの場合は、日付の開始値を指定します。
  • UITypeがDateの場合は、日付の終了値を指定します。
  • パラメータのデフォルト値を指定します。
  • パラメータ・タイプが"Text"または"Date"の場合に、パラメータのテキスト・フィールド・サイズを指定します。
  • パラメータ・タイプが"Hidden"以外の場合に、パラメータの表示ラベルを指定します。
  • lovLabels
    パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。
  • trueは、パラメータに複数の値が含まれている可能性があることを意味します。
  • パラメータ名。
  • パラメータ・タイプが"Text"または"Menu"で、このパラメータの値がtrueの場合は、このパラメータに対する選択が行われたときに他の定義済パラメータがリフレッシュされることを示します。
  • パラメータ・タイプが"Menu"の場合、trueは値リストのすべての値を選択できることを示します。
  • trueは、パラメータがRTFテンプレートで定義されていることを示します。
  • Oracle BI Publisherのデータ・モデル・ユーザー・インタフェースで定義されているパラメータのタイプです。有効な値: Date Hidden Menu Search Text
  • パラメータ・タイプが"Menu"の場合、trueはパラメータのすべての値が選択されるとnullが渡されることを示します。
  • values
    パラメータ値。
ネストされたスキーマ: lovLabels
型: array
パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。
ソースを表示
ネストされたスキーマ: values
型: array
パラメータ値。
ソースを表示
先頭に戻る

例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行することでジョブをスケジュールする方法を示しています。

今すぐ実行するジョブのスケジュール

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行することで即時のジョブをスケジュールする方法を示しています。データ・モデルとレポート・テンプレートを指定する必要があります。

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'

後で実行するジョブのスケジュール

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行することで指定日に実行されるようにジョブをスケジュールする方法を示しています。データ・モデルとレポート・テンプレートを指定する必要があります。

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'

データと出力内容を保存するジョブのスケジュール

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行することでジョブをスケジュールしデータと出力内容を保存する方法を示しています。データ・モデル、レポート・テンプレートおよび出力形式を指定する必要があります。データと出力内容を保存した場合は、XMLデータと出力内容を表示およびダウンロードできます。

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'

毎日実行するジョブのスケジュール

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行することで指定日時に毎日実行されるようにジョブをスケジュールする方法を示しています。データ・モデル、レポート・テンプレート、ジョブ開始日時、ジョブ終了日時およびジョブ実行頻度を指定する必要があります。

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'

毎週実行するジョブのスケジュール

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行することで毎週木曜日に実行されるようにジョブをスケジュールする方法を示しています。ジョブを実行するには、データ・モデル、レポート・テンプレート、ジョブ開始日時、ジョブ終了日時および曜日を指定する必要があります。

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'

カスタム名を指定したジョブのスケジュール

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行することで、後で実行されるように、カスタム・ジョブ名を指定してジョブをスケジュールする方法を示しています。データ・モデル、レポート・テンプレートおよびジョブ開始日時を指定する必要があります。

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'

出力内容をオブジェクト・ストレージに配信するジョブのスケジュール

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行することで出力内容をオブジェクト・ストレージに配信するようにジョブをスケジュールする方法を示しています。ジョブ名、レポート・パス、オブジェクト・ストレージ・サーバー名、ファイル接頭辞およびファイル名を指定する必要があります。

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'

バースティング・ジョブのスケジュール

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行することで即時にバースティング・ジョブをスケジュールする方法を示しています。データ・モデルとレポート・テンプレートを指定する必要があります。レポート・プロパティでバースティング・プロパティにチェックマークが付いていることを確認してください。

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'

パラメータを指定したバースティング・ジョブのスケジュール

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行することでパラメータを指定したバースティング・ジョブをスケジュールする方法を示しています。データ・モデルとレポート・テンプレートを指定する必要があります。レポート・プロパティでバースティング・プロパティにチェックマークが付いていることを確認してください。

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'
先頭に戻る