REST API for Oracle BI Publisher

All REST Endpoints

Manage Reports

Manage Oracle BI Publisher Reports

Create report: Method: post

Path: /v1/reports
Create template: Method: post

Path: /v1/reports/{reportPath}/templates/{templateId}
Create translation file (XLIFF): Method: post

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}
Delete template: Method: delete

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report definition: Method: get

Path: /v1/reports/{reportPath}
Get report parameters: Method: post

Path: /v1/reports/{reportPath}/parameters
Get report sample data: Method: get

Path: /v1/reports/{reportPath}/sampleData
Get report template: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report template parameters: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}/parameters
Get XDO schema: Method: get

Path: /v1/reports/{reportPath}/xdoSchema
Run report: Method: post

Path: /v1/reports/{reportPath}/run
Update report definition: Method: put

Path: /v1/reports/{reportPath}
Update template: Method: put

Path: /v1/reports/{reportPath}/templates/{templateId}
Update translation file (XLIFF): Method: put

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}

All Endpoints

Create report: Method: post

Path: /v1/reports
Create template: Method: post

Path: /v1/reports/{reportPath}/templates/{templateId}
Create translation file (XLIFF): Method: post

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}
Delete template: Method: delete

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report definition: Method: get

Path: /v1/reports/{reportPath}
Get report parameters: Method: post

Path: /v1/reports/{reportPath}/parameters
Get report sample data: Method: get

Path: /v1/reports/{reportPath}/sampleData
Get report template: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report template parameters: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}/parameters
Get XDO schema: Method: get

Path: /v1/reports/{reportPath}/xdoSchema
Run report: Method: post

Path: /v1/reports/{reportPath}/run
Update report definition: Method: put

Path: /v1/reports/{reportPath}
Update template: Method: put

Path: /v1/reports/{reportPath}/templates/{templateId}
Update translation file (XLIFF): Method: put

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}

Manage Reports

Manage Oracle BI Publisher Reports

Create report: Method: post

Path: /v1/reports
Get report definition: Method: get

Path: /v1/reports/{reportPath}
Update report definition: Method: put

Path: /v1/reports/{reportPath}
Get report parameters: Method: post

Path: /v1/reports/{reportPath}/parameters
Run report: Method: post

Path: /v1/reports/{reportPath}/run
Get report sample data: Method: get

Path: /v1/reports/{reportPath}/sampleData
Create translation file (XLIFF): Method: post

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}
Update translation file (XLIFF): Method: put

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}
Delete template: Method: delete

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report template: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}
Create template: Method: post

Path: /v1/reports/{reportPath}/templates/{templateId}
Update template: Method: put

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report template parameters: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}/parameters
Get XDO schema: Method: get

Path: /v1/reports/{reportPath}/xdoSchema

All Endpoints

Create report: Method: post

Path: /v1/reports
Get report definition: Method: get

Path: /v1/reports/{reportPath}
Update report definition: Method: put

Path: /v1/reports/{reportPath}
Get report parameters: Method: post

Path: /v1/reports/{reportPath}/parameters
Run report: Method: post

Path: /v1/reports/{reportPath}/run
Get report sample data: Method: get

Path: /v1/reports/{reportPath}/sampleData
Create translation file (XLIFF): Method: post

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}
Update translation file (XLIFF): Method: put

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}
Delete template: Method: delete

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report template: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}
Create template: Method: post

Path: /v1/reports/{reportPath}/templates/{templateId}
Update template: Method: put

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report template parameters: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}/parameters
Get XDO schema: Method: get

Path: /v1/reports/{reportPath}/xdoSchema

Manage Reports

Manage Oracle BI Publisher Reports

Delete template: Method: delete

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report definition: Method: get

Path: /v1/reports/{reportPath}
Get report sample data: Method: get

Path: /v1/reports/{reportPath}/sampleData
Get report template: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report template parameters: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}/parameters
Get XDO schema: Method: get

Path: /v1/reports/{reportPath}/xdoSchema
Create report: Method: post

Path: /v1/reports
Get report parameters: Method: post

Path: /v1/reports/{reportPath}/parameters
Run report: Method: post

Path: /v1/reports/{reportPath}/run
Create translation file (XLIFF): Method: post

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}
Create template: Method: post

Path: /v1/reports/{reportPath}/templates/{templateId}
Update report definition: Method: put

Path: /v1/reports/{reportPath}
Update translation file (XLIFF): Method: put

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}
Update template: Method: put

Path: /v1/reports/{reportPath}/templates/{templateId}

All Endpoints

Delete template: Method: delete

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report definition: Method: get

Path: /v1/reports/{reportPath}
Get report sample data: Method: get

Path: /v1/reports/{reportPath}/sampleData
Get report template: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}
Get report template parameters: Method: get

Path: /v1/reports/{reportPath}/templates/{templateId}/parameters
Get XDO schema: Method: get

Path: /v1/reports/{reportPath}/xdoSchema
Create report: Method: post

Path: /v1/reports
Get report parameters: Method: post

Path: /v1/reports/{reportPath}/parameters
Run report: Method: post

Path: /v1/reports/{reportPath}/run
Create translation file (XLIFF): Method: post

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}
Create template: Method: post

Path: /v1/reports/{reportPath}/templates/{templateId}
Update report definition: Method: put

Path: /v1/reports/{reportPath}
Update translation file (XLIFF): Method: put

Path: /v1/reports/{reportPath}/templateFiles/{templateFileName}/xliffs/{locale}
Update template: Method: put

Path: /v1/reports/{reportPath}/templates/{templateId}