ジャンプ先

• リクエスト
• レスポンス
• 例

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

put

/services/rest/v1/jobs/scheduleJob

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

リクエスト

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

先頭に戻る

レスポンス

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

• application/text

200レスポンス

スケジュールしたジョブのジョブIDを返します。

本文 ()

ルート・スキーマ: ScheduleRequest

型: object

ソースを表示

• bookBindingOutputOption(オプション): boolean
  trueの場合は、ブック・バインドを使用するかどうかを保存します
• burstringOption(オプション): boolean
  trueの場合は、バーストを有効にします。
• chunkingOption(オプション): boolean
  trueの場合は、チャンクを有効にします。
• compressDeliveryOutputOption(オプション): boolean
  trueの場合は、配信前に出力内容を圧縮します。
• cronExpression(オプション): string
  繰返しジョブのスケジューリングのためのCron式。
• dataModelUrl(オプション): string
  データ・モデルのURL。
• DeliveryChannels(オプション): object DeliveryChannels
• endDate(オプション): string
  ジョブの終了日時。W3CDTF日付書式文字列を使用します。たとえば、2010-05-21T21:24:19Zのようになります。
• jobLocale(オプション): string
  ジョブ出力のロケール
• jobTZ(オプション): string
  ジョブ実行のタイムゾーン
• mergeOutputOption(オプション): boolean
  trueの場合、出力内容をマージします。
• notificationPassword(オプション): string
  通知サーバーのパスワード。
• notificationServer(オプション): string
  通知サーバー。
• notificationTo(オプション): string
  通知の送信先となるユーザー。
• notificationUserName(オプション): string
  通知サーバーのユーザー名。
• notifyHttpWhenFailed(オプション): boolean
  trueの場合は、ジョブが失敗したときにユーザーにHTTP通知を送信します(デフォルト - false)。
• notifyHttpWhenSkipped(オプション): boolean
  trueの場合は、ジョブがスキップされたときにユーザーにHTTP通知を送信します(デフォルトはfalse)。
• notifyHttpWhenSuccess(オプション): boolean
  trueの場合は、ジョブが成功したときにユーザーにHTTP通知を送信します(デフォルトはfalse)。
• notifyHttpWhenWarning(オプション): boolean
  trueの場合は、ジョブが警告状態のときにユーザーにHTTP通知を送信します(デフォルトはfalse)。
• notifyWhenFailed(オプション): boolean
  trueの場合は、ジョブが失敗したときにユーザーに通知を送信します(デフォルトはfalse)。
• notifyWhenSkipped(オプション): boolean
  trueの場合は、ジョブがスキップされたときにユーザーに通知を送信します(デフォルトはfalse)。
• notifyWhenSuccess(オプション): boolean
  trueの場合は、ジョブが成功したときにユーザーに通知を送信します(デフォルトはfalse)。
• notifyWhenWarning(オプション): boolean
  trueの場合は、ジョブが警告状態のときにユーザーに通知を送信します(デフォルトはfalse)。
• publicOption(オプション): boolean
  trueの場合は、出力内容をパブリックとして設定します。
• repeatCount(オプション): integer
  ジョブの繰返し回数。
• ReportRequest(オプション): object ReportRequest
• saveDataOption(オプション): boolean
  trueの場合は、履歴ページでダウンロード用にXMLデータを表示できるように、XMLデータを保存します。
• saveOutputOption(オプション): boolean
  trueの場合は、履歴ページで出力内容を表示できるように、出力内容を保存します。
• startDate(オプション): string
  ジョブの開始日時。W3CDTF日付書式文字列を使用します。たとえば、2010-05-21T21:24:19Zのようになります。
• userJobDesc(オプション): string
  ユーザー定義ジョブの説明
• userJobName(オプション): string
  ユーザー定義ジョブの名前
• UTF8Option(オプション): boolean
  trueの場合は、UTF8エンコーディングを有効にします。

{
    "type":"object",
    "properties":{
        "ReportRequest":{
            "$ref":"#/definitions/ReportRequest"
        },
        "DeliveryChannels":{
            "$ref":"#/definitions/DeliveryChannels"
        },
        "dataModelUrl":{
            "type":"string",
            "description":"URL of the data model."
        },
        "publicOption":{
            "type":"boolean",
            "description":"If true, sets the output as public.\n"
        },
        "burstringOption":{
            "type":"boolean",
            "description":"If true, enables bursting.\n"
        },
        "chunkingOption":{
            "type":"boolean",
            "description":"If true, enables chunking.\n"
        },
        "compressDeliveryOutputOption":{
            "type":"boolean",
            "description":"If true, compresses the output before delivery.\n"
        },
        "UTF8Option":{
            "type":"boolean",
            "description":" If true, enable UTF8 encoding.\n"
        },
        "saveOutputOption":{
            "type":"boolean",
            "description":"If true, saves the output so that the output is visible in the history page.\n"
        },
        "saveDataOption":{
            "type":"boolean",
            "description":"If true, saves the XML data so that the XML data is visible for download in the history page.\n"
        },
        "mergeOutputOption":{
            "type":"boolean",
            "description":"If true, merges the output.\n"
        },
        "bookBindingOutputOption":{
            "type":"boolean",
            "description":"If true, saves Is the book binding used?\n"
        },
        "userJobName":{
            "type":"string",
            "description":"User defined job name"
        },
        "userJobDesc":{
            "type":"string",
            "description":"User defined job description"
        },
        "jobLocale":{
            "type":"string",
            "description":"Locale for the job output"
        },
        "jobTZ":{
            "type":"string",
            "description":"Time zone for the job run"
        },
        "notifyWhenSuccess":{
            "type":"boolean",
            "description":"If true, sends notification to the user when the job is successful (default is false).\n"
        },
        "notifyWhenWarning":{
            "type":"boolean",
            "description":"If true, sends notification to the user when the job is in warning state (default is false). \n"
        },
        "notifyWhenFailed":{
            "type":"boolean",
            "description":"If true, sends notification to the user when the job fails (default is false).\n"
        },
        "notifyWhenSkipped":{
            "type":"boolean",
            "description":"If true, sends notification to the user when the job is skipped (default is false).\n"
        },
        "notificationTo":{
            "type":"string",
            "description":"User to send notification.\n"
        },
        "notifyHttpWhenSuccess":{
            "type":"boolean",
            "description":"If true, sends HTTP notification to user when the job is successful (default is  false).\n"
        },
        "notifyHttpWhenWarning":{
            "type":"boolean",
            "description":"If true, sends HTTP notification to user when the job is in warning state (default is false).\n"
        },
        "notifyHttpWhenFailed":{
            "type":"boolean",
            "description":"If true, sends HTTP notification to user when the job fails (default - false).\n"
        },
        "notifyHttpWhenSkipped":{
            "type":"boolean",
            "description":"If true, sends HTTP notification to user when job is skipped (default is false).\n"
        },
        "notificationServer":{
            "type":"string",
            "description":"Notification server."
        },
        "notificationUserName":{
            "type":"string",
            "description":"User name for the notification server."
        },
        "notificationPassword":{
            "type":"string",
            "description":"Password for the notification server."
        },
        "startDate":{
            "type":"string",
            "description":"Start date and time for the job. Use the W3CDTF date format string. For example, 2010-05-21T21:24:19Z"
        },
        "endDate":{
            "type":"string",
            "description":"End date and time for the job. Use the W3CDTF date format string. For example, 2010-05-21T21:24:19Z"
        },
        "repeatCount":{
            "type":"integer",
            "description":"Repeat count for the job."
        },
        "cronExpression":{
            "type":"string",
            "description":"Cron expression for scheduling the recurring jobs."
        }
    }
}

ネストされたスキーマ: DeliveryChannels

型: object

ソースを表示

• emailOptions(オプション): object ArrayOfEmailDeliveryOption
• faxOptions(オプション): object ArrayOfFaxDeliveryOption
• ftpOptions(オプション): object ArrayOfFTPDeliveryOption
• localOptions(オプション): object ArrayOfLocalDeliveryOption
• printOptions(オプション): object ArrayOfPrintDeliveryOption
• wccOptions(オプション): object ArrayOfWCCDeliveryOption
• webDAVOptions(オプション): object ArrayOfWebDavDeliveryOption

{
    "properties":{
        "emailOptions":{
            "$ref":"#/definitions/ArrayOfEmailDeliveryOption"
        },
        "faxOptions":{
            "$ref":"#/definitions/ArrayOfFaxDeliveryOption"
        },
        "ftpOptions":{
            "$ref":"#/definitions/ArrayOfFTPDeliveryOption"
        },
        "localOptions":{
            "$ref":"#/definitions/ArrayOfLocalDeliveryOption"
        },
        "printOptions":{
            "$ref":"#/definitions/ArrayOfPrintDeliveryOption"
        },
        "wccOptions":{
            "$ref":"#/definitions/ArrayOfWCCDeliveryOption"
        },
        "webDAVOptions":{
            "$ref":"#/definitions/ArrayOfWebDavDeliveryOption"
        }
    }
}

ネストされたスキーマ: ReportRequest

型: object

ソースを表示

• attributeCalendar(オプション): string
  レポート・リクエストに対して使用するフォーマット・カレンダです。有効な値: "Gregorian"、"Arabic Hijrah"、"English Hijrah"、"Japanese Imperial"、"Thai Buddha"、"ROC Official"
• attributeFormat(オプション): string
  要求されたレポートの出力フォーマット。
• attributeLocale(オプション): string
  レポートのロケール選択例: fr-FR
• attributeTemplate(オプション): string
  レポートに適用するテンプレートたとえば、Employeelisting.rtfです。
• attributeTimezone(オプション): string
  リクエストに対して使用するタイムゾーンを、サポートされているJavaタイムゾーンIDを使用して指定します。たとえば、"America/Los_Angeles"。
• attributeUILocale(オプション): string
  レポートのロケール選択例: fr-FR
• byPassCache(オプション): boolean
  デフォルト値: false

  trueは、ドキュメント・キャッシュをバイパスすることを示します。
• dynamicDataSource(オプション): object BIPDataSource
• flattenXML(オプション): boolean
  デフォルト値: false

  trueは、XMLがフラット化されることを意味します。ExcelではXMLデータ型をフラット化する必要があるため、このフラグはAnalyzer for Microsoft Excelに対して使用されます。
• parameterNameValues(オプション): object ParamNameValues
• xdopropertyList(オプション): object MetaDataList

{
    "type":"object",
    "properties":{
        "parameterNameValues":{
            "$ref":"#/definitions/ParamNameValues"
        },
        "byPassCache":{
            "type":"boolean",
            "default":false,
            "description":"True indicates to bypass document cache."
        },
        "xdopropertyList":{
            "$ref":"#/definitions/MetaDataList"
        },
        "attributeFormat":{
            "description":"The output format of the requested report.",
            "type":"string"
        },
        "attributeLocale":{
            "description":"The locale selection for the report. Example: fr-FR",
            "type":"string"
        },
        "attributeTemplate":{
            "description":"The template to apply to the report. For example, Employeelisting.rtf.",
            "type":"string"
        },
        "attributeTimezone":{
            "description":"Specifies the time zone to use for the request, using a supported Java time zone ID. For example, \"America/Los_Angeles\".",
            "type":"string"
        },
        "attributeCalendar":{
            "description":"The formatting calendar to use for the report request. Valid values are: \"Gregorian\", \"Arabic Hijrah\", \"English Hijrah\", \"Japanese Imperial\", \"Thai Buddha\", and \"ROC Official\".",
            "type":"string"
        },
        "attributeUILocale":{
            "description":"The locale selection for the report. Example: fr-FR",
            "type":"string"
        },
        "dynamicDataSource":{
            "description":"If the data source for the report is not defined, you can dynamically define it.",
            "$ref":"#/definitions/BIPDataSource"
        },
        "flattenXML":{
            "description":"True indicates that the XML is to be flattened. This flag is used for the Analyzer for Microsoft Excel because Excel requires XML data type to be flattened.",
            "type":"boolean",
            "default":false
        }
    }
}

ネストされたスキーマ: ArrayOfEmailDeliveryOption

型: object

ソースを表示

• item(オプション): array item
  EMailDeliveryOptionの配列

{
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"An array of EMailDeliveryOption",
            "items":{
                "$ref":"#/definitions/EMailDeliveryOption"
            }
        }
    }
}

ネストされたスキーマ: ArrayOfFaxDeliveryOption

型: object

ソースを表示

• item(オプション): array item
  FaxDeliveryOptionの配列

{
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"An array of FaxDeliveryOption",
            "items":{
                "$ref":"#/definitions/FaxDeliveryOption"
            }
        }
    }
}

ネストされたスキーマ: ArrayOfFTPDeliveryOption

型: object

ソースを表示

• item(オプション): array item
  FTPDeliveryOptionの配列

{
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"An array of FTPDeliveryOption",
            "items":{
                "$ref":"#/definitions/FTPDeliveryOption"
            }
        }
    }
}

ネストされたスキーマ: ArrayOfLocalDeliveryOption

型: object

ソースを表示

• item(オプション): array item
  LocalDeliveryOptionの配列

{
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"An array of LocalDeliveryOption",
            "items":{
                "$ref":"#/definitions/LocalDeliveryOption"
            }
        }
    }
}

ネストされたスキーマ: ArrayOfPrintDeliveryOption

型: object

ソースを表示

• item(オプション): array item
  PrintDeliveryOptionの配列

{
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"An array of PrintDeliveryOption",
            "items":{
                "$ref":"#/definitions/PrintDeliveryOption"
            }
        }
    }
}

ネストされたスキーマ: ArrayOfWCCDeliveryOption

型: object

ソースを表示

• item(オプション): array item
  WCCDeliveryOptionの配列

{
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"An array of WCCDeliveryOption",
            "items":{
                "$ref":"#/definitions/WCCDeliveryOption"
            }
        }
    }
}

ネストされたスキーマ: ArrayOfWebDavDeliveryOption

型: object

ソースを表示

• item(オプション): array item
  WebDavDeliveryOptionの配列

{
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"An array of WebDavDeliveryOption",
            "items":{
                "$ref":"#/definitions/WebDavDeliveryOption"
            }
        }
    }
}

ネストされたスキーマ: item

型: array

EMailDeliveryOptionの配列

ソースを表示

• 配列: object EMailDeliveryOption

{
    "type":"array",
    "description":"An array of EMailDeliveryOption",
    "items":{
        "$ref":"#/definitions/EMailDeliveryOption"
    }
}

ネストされたスキーマ: EMailDeliveryOption

型: object

ソースを表示

• eMailAttachmentName(オプション): string
  電子メール添付フィールド。
• eMailBCC(オプション): string
  電子メールBccフィールド。
• eMailBody(オプション): string
  電子メール本文フィールド。
• eMailCC(オプション): string
  電子メールCcフィールド。
• eMailDeliveryStatusNotification(オプション): boolean
  電子メール・ステータス通知フィールド。
• eMailFrom(オプション): string
  電子メール送信者フィールド。
• eMailReplyTo(オプション): string
  電子メール返信先フィールド。
• eMailReturnReceipt(オプション): boolean
  電子メール受信確認フィールド。
• eMailServerName(オプション): string
  電子メール・サーバー名。
• eMailSubject(オプション): string
  電子メール件名フィールド。
• eMailTo(オプション): string
  電子メール宛先フィールド。

{
    "type":"object",
    "properties":{
        "eMailServerName":{
            "type":"string",
            "description":"The email server name."
        },
        "eMailFrom":{
            "type":"string",
            "description":"email from field."
        },
        "eMailTo":{
            "type":"string",
            "description":"email to field."
        },
        "eMailCC":{
            "type":"string",
            "description":"The email cc field."
        },
        "eMailBCC":{
            "type":"string",
            "description":"The email bcc field."
        },
        "eMailReplyTo":{
            "type":"string",
            "description":"The email reply-to field."
        },
        "eMailSubject":{
            "type":"string",
            "description":"The email subject field."
        },
        "eMailBody":{
            "type":"string",
            "description":"The email body field."
        },
        "eMailAttachmentName":{
            "type":"string",
            "description":"The email attachment field."
        },
        "eMailDeliveryStatusNotification":{
            "type":"boolean",
            "description":"The email status notification field."
        },
        "eMailReturnReceipt":{
            "type":"boolean",
            "description":"The email return receipt field."
        }
    }
}

ネストされたスキーマ: item

型: array

FaxDeliveryOptionの配列

ソースを表示

• 配列: object FaxDeliveryOption

{
    "type":"array",
    "description":"An array of FaxDeliveryOption",
    "items":{
        "$ref":"#/definitions/FaxDeliveryOption"
    }
}

ネストされたスキーマ: FaxDeliveryOption

型: object

ソースを表示

• faxNumber(オプション): string
  FAXサーバー番号。
• faxServer(オプション): string
  FAXサーバー名。

{
    "type":"object",
    "properties":{
        "faxNumber":{
            "type":"string",
            "description":"The fax server number."
        },
        "faxServer":{
            "type":"string",
            "description":"fax server name."
        }
    }
}

ネストされたスキーマ: item

型: array

FTPDeliveryOptionの配列

ソースを表示

• 配列: object FTPDeliveryOption

{
    "type":"array",
    "description":"An array of FTPDeliveryOption",
    "items":{
        "$ref":"#/definitions/FTPDeliveryOption"
    }
}

ネストされたスキーマ: FTPDeliveryOption

型: object

ソースを表示

• fTPServerName(オプション): string
  FTPサーバー名。
• fTPuserName(オプション): string
  FTPユーザー名。
• fTPuserPWD(オプション): string
  FTPユーザー・パスワード。
• remoteFilePath(オプション): string
  リモート・ファイル・パス。
• sFTPOption(オプション): boolean
  SFTPオプション。

{
    "type":"object",
    "properties":{
        "fTPServerName":{
            "type":"string",
            "description":"The ftp server name."
        },
        "fTPuserName":{
            "type":"string",
            "description":"ftp user name."
        },
        "fTPuserPWD":{
            "type":"string",
            "description":"ftp user password."
        },
        "sFTPOption":{
            "type":"boolean",
            "description":"sftp option."
        },
        "remoteFilePath":{
            "type":"string",
            "description":"remote file path."
        }
    }
}

ネストされたスキーマ: item

型: array

LocalDeliveryOptionの配列

ソースを表示

• 配列: object LocalDeliveryOption

{
    "type":"array",
    "description":"An array of LocalDeliveryOption",
    "items":{
        "$ref":"#/definitions/LocalDeliveryOption"
    }
}

ネストされたスキーマ: LocalDeliveryOption

型: object

ソースを表示

• destination(オプション): string
  ローカル宛先パス。

{
    "type":"object",
    "properties":{
        "destination":{
            "type":"string",
            "description":"The local destination path."
        }
    }
}

ネストされたスキーマ: item

型: array

PrintDeliveryOptionの配列

ソースを表示

• 配列: object PrintDeliveryOption

{
    "type":"array",
    "description":"An array of PrintDeliveryOption",
    "items":{
        "$ref":"#/definitions/PrintDeliveryOption"
    }
}

ネストされたスキーマ: PrintDeliveryOption

型: object

ソースを表示

• printerName(オプション): string
  プリンタ名。
• printNumberOfCopy(オプション): string
  印刷部数。
• printOrientation(オプション): string
  横方向または縦方向。
• printRange(オプション): string
  ページ範囲。たとえば、1-3。
• printSide(オプション): string
  片面または両面。
• printTray(オプション): string
  デフォルトまたはトレイ番号。

{
    "type":"object",
    "properties":{
        "printerName":{
            "type":"string",
            "description":"The printer name."
        },
        "printNumberOfCopy":{
            "type":"string",
            "description":"number of copies."
        },
        "printSide":{
            "type":"string",
            "description":"Single Sided or Double Sided."
        },
        "printTray":{
            "type":"string",
            "description":"Dafault or tray number."
        },
        "printOrientation":{
            "type":"string",
            "description":"portrait or landscape."
        },
        "printRange":{
            "type":"string",
            "description":"page range e.g 1-3."
        }
    }
}

ネストされたスキーマ: item

型: array

WCCDeliveryOptionの配列

ソースを表示

• 配列: object WCCDeliveryOption

{
    "type":"array",
    "description":"An array of WCCDeliveryOption",
    "items":{
        "$ref":"#/definitions/WCCDeliveryOption"
    }
}

ネストされたスキーマ: WCCDeliveryOption

型: object

ソースを表示

• wccAccount(オプション): string
  WCCアカウント
• wccAuthor(オプション): string
  WCC作成者。
• wccComments(オプション): string
  WCCコメント。
• wccFileName(オプション): string
  WCCファイル名。
• wccFolderPath(オプション): string
  WCCフォルダ・パス。
• wccIncludeMetadata(オプション): boolean
  メタデータを含めるかどうかを示すtrue/false
• wccSecurityGroup(オプション): string
  WCCセキュリティ・グループ。
• wccServerName(オプション): string
  WCCサーバー名。
• wccTitle(オプション): string
  WCCタイトル。

{
    "type":"object",
    "properties":{
        "wccServerName":{
            "type":"string",
            "description":"The wcc server name."
        },
        "wccSecurityGroup":{
            "type":"string",
            "description":"wcc security group."
        },
        "wccAccount":{
            "type":"string",
            "description":"wcc account"
        },
        "wccAuthor":{
            "type":"string",
            "description":"wcc author."
        },
        "wccTitle":{
            "type":"string",
            "description":"wcc title."
        },
        "wccFileName":{
            "type":"string",
            "description":"wcc file name."
        },
        "wccFolderPath":{
            "type":"string",
            "description":"wcc folder path."
        },
        "wccComments":{
            "type":"string",
            "description":"wcc comments."
        },
        "wccIncludeMetadata":{
            "type":"boolean",
            "description":"incude metadata true/false"
        }
    }
}

ネストされたスキーマ: item

型: array

WebDavDeliveryOptionの配列

ソースを表示

• 配列: object WebDavDeliveryOption

{
    "type":"array",
    "description":"An array of WebDavDeliveryOption",
    "items":{
        "$ref":"#/definitions/WebDavDeliveryOption"
    }
}

ネストされたスキーマ: WebDavDeliveryOption

型: object

ソースを表示

• deliveryAuthType(オプション): string
  配信認証タイプ。
• password(オプション): string
  パスワード。
• remoteFilePath(オプション): string
  リモート・ファイル・パス。
• server(オプション): string
  WebDAVサーバー名。
• userName(オプション): string
  ユーザー名。

{
    "type":"object",
    "properties":{
        "server":{
            "type":"string",
            "description":"The webdav server name."
        },
        "remoteFilePath":{
            "type":"string",
            "description":"remote file path."
        },
        "userName":{
            "type":"string",
            "description":"user name"
        },
        "password":{
            "type":"string",
            "description":"password."
        },
        "deliveryAuthType":{
            "type":"string",
            "description":"delivery auth type."
        }
    }
}

ネストされたスキーマ: BIPDataSource

型: object

ソースを表示

• fileDataSource(オプション): object FileDataSource
• jdbcdataSource(オプション): object JDBCDataSource

{
    "type":"object",
    "properties":{
        "fileDataSource":{
            "$ref":"#/definitions/FileDataSource"
        },
        "jdbcdataSource":{
            "$ref":"#/definitions/JDBCDataSource"
        }
    }
}

ネストされたスキーマ: ParamNameValues

型: object

ソースを表示

• listOfParamNameValues(オプション): array listOfParamNameValues
  ParamNameValueの配列

{
    "type":"object",
    "properties":{
        "listOfParamNameValues":{
            "type":"array",
            "description":"An array of ParamNameValue",
            "items":{
                "$ref":"#/definitions/ParamNameValue"
            }
        }
    }
}

ネストされたスキーマ: MetaDataList

型: object

ソースを表示

• metaDataName(オプション): string
  メタデータの名前。
• metaDataValue(オプション): string
  メタデータのコンテンツ。

{
    "type":"object",
    "properties":{
        "metaDataName":{
            "type":"string",
            "description":"The name of the metadata."
        },
        "metaDataValue":{
            "type":"string",
            "description":"The metadata content."
        }
    }
}

ネストされたスキーマ: FileDataSource

型: object

ソースを表示

• dynamicDataSourcePath(オプション): string
  特定のサーバー上に存在するデータソースへのパスを指定するには、データソースへのフルパスを指定し、temporaryDataSourceをfalseに設定します。たとえば、"D:\BI\OracleBI\xmlp\XMLP\DemoFiles\Balance.xml")"となります。ファイルがシステムの一時ディレクトリにある場合は、temporaryDataSourceをtrueに設定して、ファイル名をここで指定します。たとえば、"Balance.xml"となります。
• temporaryDataSource(オプション): boolean
  デフォルト値: false

  ファイル・データソースがシステム一時ディレクトリにある場合はtrueに設定します。dynamicDataSourcePathでフルパスを指定する場合はfalseに設定します。

{
    "type":"object",
    "properties":{
        "dynamicDataSourcePath":{
            "description":"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\")\"\nIf the file is located in the system temporary directory, set temporaryDataSource to true, and specify the file name here. For example: \"Balance.xml\".\n",
            "type":"string"
        },
        "temporaryDataSource":{
            "description":"Set to \"true\" when the file data source is in the system temporary directory. Set to \"false\" when dynamicDataSourcePath specifies the full path.",
            "type":"boolean",
            "default":false
        }
    }
}

ネストされたスキーマ: JDBCDataSource

型: object

ソースを表示

• dataSourceName(オプション): string
  Oracle BI Publisherデータ・ソース定義ページでデータ・ソースに割り当てられたデータ・ソース名です(たとえば、Oracle)。
• jdbcdriverClass(オプション): string
  データソースのJDBCドライバ・クラスです(たとえば、oracle.jdbc.OracleDriver)。
• jdbcdriverType(オプション): string
  Oracle BI Publisherデータ・ソース定義ページで定義されているドライバのタイプです(たとえば、Oracle10g/11g/12c)。
• jdbcpassword(オプション): string
  Oracle BI Publisherデータ・ソース定義ページで定義されている、データ・ソースのパスワードです。
• jdbcurl(オプション): string
  データソースの接続文字列です(たとえば、jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl)。
• jdbcuserName(オプション): string
  Oracle BI Publisherデータ・ソース定義ページで定義されている、データ・ソースのユーザー名です。
• postProcessFunc(オプション): string
  接続が閉じたときに実行するPL/SQLファンクションを入力します(後処理)。
• preProcessFunc(オプション): string
  接続が作成されたときに実行するPL/SQLファンクションを入力します(前処理)。
• useProxyAuth(オプション): boolean
  デフォルト値: false

  プロキシ認証を有効化します。

{
    "type":"object",
    "properties":{
        "dataSourceName":{
            "description":"The Data Source Name assigned to the data source in the Oracle BI Publisher data source definition page (for example, Oracle).",
            "type":"string"
        },
        "jdbcdriverClass":{
            "description":"The JDBC driver class for the data source (for example, oracle.jdbc.OracleDriver).",
            "type":"string"
        },
        "jdbcdriverType":{
            "description":"The driver type as defined in the Oracle BI Publisher data source definition page (for example, Oracle10g/11g/12c).",
            "type":"string"
        },
        "preProcessFunc":{
            "description":"Enter a PL/SQL function to execute when a connection is created (Pre Process).",
            "type":"string"
        },
        "postProcessFunc":{
            "description":"Enter a PL/SQL function to execute when a connection is closed (Post Process).",
            "type":"string"
        },
        "jdbcurl":{
            "description":"The connection string for the data source (for example, jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl).",
            "type":"string"
        },
        "jdbcuserName":{
            "description":"The user name for the data source as defined in the Oracle BI Publisher data source definition page.",
            "type":"string"
        },
        "jdbcpassword":{
            "description":"The password for the data source as defined in the Oracle BI Publisher data source definition page.",
            "type":"string"
        },
        "useProxyAuth":{
            "description":"Enable Proxy Authentication.",
            "type":"boolean",
            "default":false
        }
    }
}

ネストされたスキーマ: listOfParamNameValues

型: array

ParamNameValueの配列

ソースを表示

• 配列: object ParamNameValue

{
    "type":"array",
    "description":"An array of ParamNameValue",
    "items":{
        "$ref":"#/definitions/ParamNameValue"
    }
}

ネストされたスキーマ: ParamNameValue

型: object

ソースを表示

• dataType(オプション): string
  有効な値: Boolean Date Float Integer String
• dateFormatString(オプション): string
  UITypeがDateの場合は、日付フォーマット文字列を指定します。日付フォーマット文字列にはJava日付フォーマットを使用する必要があります(MM-DD-YYYYなど)。
• dateFrom(オプション): string
  UITypeがDateの場合は、日付の開始値を指定します。
• dateTo(オプション): string
  UITypeがDateの場合は、日付の終了値を指定します。
• defaultValue(オプション): string
  パラメータのデフォルト値を指定します。
• fieldSize(オプション): string
  パラメータ・タイプが"Text"または"Date"の場合に、パラメータのテキスト・フィールド・サイズを指定します。
• label(オプション): string
  パラメータ・タイプが"Hidden"以外の場合に、パラメータの表示ラベルを指定します。
• lovLabels(オプション): array lovLabels
  パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。
• multiValuesAllowed(オプション): boolean
  trueは、パラメータに複数の値が含まれている可能性があることを意味します。
• name(オプション): string
  パラメータ名。
• refreshParamOnChange(オプション): boolean
  パラメータ・タイプが"Text"または"Menu"で、このパラメータの値がtrueの場合は、このパラメータに対する選択が行われたときに他の定義済パラメータがリフレッシュされることを示します。
• selectAll(オプション): boolean
  パラメータ・タイプが"Menu"の場合、trueは値リストのすべての値を選択できることを示します。
• templateParam(オプション): boolean
  trueは、パラメータがRTFテンプレートで定義されていることを示します。
• UIType(オプション): string
  Oracle BI Publisherのデータ・モデル・ユーザー・インタフェースで定義されているパラメータのタイプです。有効な値: Date Hidden Menu Search Text
• useNullForAll(オプション): boolean
  パラメータ・タイプが"Menu"の場合、trueはパラメータのすべての値が選択されるとnullが渡されることを示します。
• values(オプション): array values
  パラメータ値。

{
    "type":"object",
    "properties":{
        "UIType":{
            "type":"string",
            "description":"The type of parameter as defined in the Oracle BI Publisher data model user interface.\nValid values include:\nDate\nHidden\nMenu\nSearch\nText\n"
        },
        "dataType":{
            "type":"string",
            "description":"Valid values include:\nBoolean\nDate\nFloat\nInteger\nString\n"
        },
        "dateFormatString":{
            "type":"string",
            "description":"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)."
        },
        "dateFrom":{
            "type":"string",
            "description":"If UIType is \"Date\", this specifies the begin value of the date."
        },
        "dateTo":{
            "type":"string",
            "description":"If UIType is \"Date\", this specifies the end value of the date."
        },
        "defaultValue":{
            "type":"string",
            "description":"Specifies the default value of the parameter."
        },
        "fieldSize":{
            "type":"string",
            "description":"For parameter types \"Text\" and \"Date\", specifies the text field size for the parameter."
        },
        "label":{
            "type":"string",
            "description":"For all parameter types except \"Hidden\", specifies the display label for the parameter."
        },
        "lovLabels":{
            "type":"array",
            "description":"If the parameter type is \"Menu\", specifies the values displayed in the list of values to the user.",
            "items":{
                "type":"string"
            }
        },
        "multiValuesAllowed":{
            "type":"boolean",
            "description":"True indicates that a parameter may contain multiple values."
        },
        "name":{
            "type":"string",
            "description":"The parameter name."
        },
        "refreshParamOnChange":{
            "type":"boolean",
            "description":"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.\n"
        },
        "selectAll":{
            "type":"boolean",
            "description":"For parameter type \"Menu\", a value of true indicates that all values can be selected for the LOV."
        },
        "templateParam":{
            "type":"boolean",
            "description":"A value of true indicates the parameter is defined in the RTF template."
        },
        "useNullForAll":{
            "type":"boolean",
            "description":"For parameter type \"Menu\", a value of true indicates that a null will be passed if all values are selected for the parameter."
        },
        "values":{
            "type":"array",
            "description":"Parameter values.",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: lovLabels

型: array

パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。

ソースを表示

• 配列: string

{
    "type":"array",
    "description":"If the parameter type is \"Menu\", specifies the values displayed in the list of values to the user.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: values

型: array

パラメータ値。

ソースを表示

• 配列: string

{
    "type":"array",
    "description":"Parameter values.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

例

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

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

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

curl -X PUT -u weblogic:welcome1 -H "Content-Type: application/json" ?v ?d '{"dataModelUrl":"my model URL","reportRequest":{"reportAbsolutePath":"/Sample Lite/Published Reporting/Reports/Balance Letter.xdo"}}' https://host.com:9502/xmlpserver/services/rest/v1/jobs/scheduleJob

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

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

curl -X PUT -u weblogic:welcome1 -H "Content-Type: application/json" -v -d
        '{"dataModelUrl" data model
        URL","startDate":"2020-11-01T09:45:00.000","reportRequest":{"reportAbsolutePath":"/Sample
        Lite/Published Reporting/Reports/Balance Letter.xdo"}}' 
https://host.com:9502/xmlpserver/services/rest/v1/jobs/scheduleJob

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

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

curl -X PUT -u admin:welcome1 -H "Content-Type:application/json" -v -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://host.com:9502/xmlpserver/services/rest/v1/jobs/scheduleJob

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

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

curl -X PUT -u admin:welcome1 -H "Content-Type:application/json" -v -d
      '{"dataModelUrl":"/Sample Lite/Published Reporting/Data Models/BalanceLetter
      Datamodel.xdm","startDate":"2020-10-01T09:45:00.000","endDate":"2021-10-01T09:45:00.000","recurrenceExpression":"0
      0 12 * * ?","reportRequest":{"reportAbsolutePath":"/Sample Lite/Published
      Reporting/Reports/Balance Letter.xdo"}}' https://host.com:9502/xmlpserver/services/rest/v1/jobs/scheduleJob

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

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

curl -X PUT -u admin:welcome1 -H "Content-Type:application/json" -v -d
        '{"dataModelUrl":"/Sample Lite/Published Reporting/Data Models/BalanceLetter
        Datamodel.xdm","startDate":"2020-10-01T09:45:00.000","endDate":"2021-10-01T09:45:00.000","recurrenceExpression":"0
        0 12 ? * THU *","reportRequest":{"reportAbsolutePath":"/Sample Lite/Published
        Reporting/Reports/Balance Letter.xdo"}}' https://host.com:9502/xmlpserver/services/rest/v1/jobs/scheduleJob

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

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

curl -X PUT -u weblogic:welcome1 -H "Content-Type: application/json" -v -d
        '{"dataModelUrl" data model URL","userJobName":"test from
        rest","startDate":"2020-10-01T09:45:00.000","reportRequest":{"reportAbsolutePath":"/Sample
        Lite/Published Reporting/Reports/Balance Letter.xdo"}}' https://host.com:9502/xmlpserver/services/rest/v1/jobs/scheduleJob

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

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

curl -X PUT -u admin:welcome1 -H "Content-Type:application/json" -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://host.com:9502/xmlpserver/services/rest/v1/jobs/scheduleJob

先頭に戻る