REST API for Narrative Reporting

All REST Endpoints

Artifacts

View and manage the Narrative Reporting Library artifacts.

Create a new file or folder artifact: Method: post
Path: /epm/rest/v1/artifacts
Delete a file or folder artifact: Method: delete
Path: /epm/rest/v1/artifacts/{id}
Get all artifacts in a folder: Method: get
Path: /epm/rest/v1/artifacts/{id}/children
Get all top level artifacts: Method: get
Path: /epm/rest/v1/artifacts
Get an artifact: Method: get
Path: /epm/rest/v1/artifacts/{id}

Books

View and manage the Narrative Reporting Books and their content.

Get a book: Method: get
Path: /epm/rest/v1/books/{id}
Get all books: Method: get
Path: /epm/rest/v1/books
Get the book output: Method: post
Path: /epm/rest/v1/books/{id}/output
Get the global point of view selections and member suggestions for book: Method: get
Path: /epm/rest/v1/books/{id}/globalPov

Bursting Definitions

View and manage the Narrative Reporting Bursting Definitions and their content.

Execute the bursting definition: Method: post
Path: /epm/rest/v1/burstingDefinitions/{id}/burst
Get a bursting definition: Method: get
Path: /epm/rest/v1/burstingDefinitions/{id}
Get all bursting definitions: Method: get
Path: /epm/rest/v1/burstingDefinitions

Files

Manage Library and temporary files for the Narrative Reporting service.

Jobs

Execute, view and manage Narrative Reporting jobs and their status.

Create a new Job: Method: post
Path: https://<servername>:<port number>/epm/rest/v1/jobs
Get a Job's status: Method: get
Path: https://<servername>:<port number>/epm/rest/v1/jobs/{jobId}

Report Packages

View and manage the Narrative Reporting Report Packages and their content.

Get a preview of the report package: Method: get
Path: /epm/rest/v1/reportPackages/{id}/preview
Get a published instance of the report package: Method: get
Path: /epm/rest/v1/reportPackages/{id}/publish
Get a report package: Method: get
Path: /epm/rest/v1/reportPackages/{id}
Get all top level report packages: Method: get
Path: /epm/rest/v1/reportPackages
Renders the Report Package's Report Center: Method: get
Path: /epm/rest/v1/reportPackages/{id}/reportCenter

Report Snapshots

View and manage the Narrative Reporting Report Snapshots and their content.

Get a report snapshot: Method: get
Path: /epm/rest/v1/reportSnapshots/{id}
Get all report snapshots: Method: get
Path: /epm/rest/v1/reportSnapshots
Get the report snapshot output: Method: get
Path: /epm/rest/v1/reportSnapshots/{id}/executedReport

Reports

View and manage the Narrative Reporting Reports and their content.

Get a report: Method: get
Path: /epm/rest/v1/reports/{id}
Get all reports: Method: get
Path: /epm/rest/v1/reports
Get the global point of view selections and member suggestions for report: Method: get
Path: /epm/rest/v1/reports/{id}/globalPov
Get the report output: Method: get
Path: /epm/rest/v1/reports/{id}/executedReport
Get the required member selection prompts for report: Method: get
Path: /epm/rest/v1/reports/{id}/prompts