All REST Endpoints
Artifacts
View and manage the Narrative Reporting Library artifacts.
- Create a new file or folder artifact
- Method: postPath:
/epm/rest/v1/artifacts
- Delete a file or folder artifact
- Method: deletePath:
/epm/rest/v1/artifacts/{id}
- Get all artifacts in a folder
- Method: getPath:
/epm/rest/v1/artifacts/{id}/children
- Get all top level artifacts
- Method: getPath:
/epm/rest/v1/artifacts
- Get an artifact
- Method: getPath:
/epm/rest/v1/artifacts/{id}
Books
View and manage the Narrative Reporting Books and their content.
- Get a book
- Method: getPath:
/epm/rest/v1/books/{id}
- Get all books
- Method: getPath:
/epm/rest/v1/books
- Get the book output
- Method: postPath:
/epm/rest/v1/books/{id}/output
- Get the global point of view selections and member suggestions for book
- Method: getPath:
/epm/rest/v1/books/{id}/globalPov
Bursting Definitions
View and manage the Narrative Reporting Bursting Definitions and their content.
- Execute the bursting definition
- Method: postPath:
/epm/rest/v1/burstingDefinitions/{id}/burst
- Get a bursting definition
- Method: getPath:
/epm/rest/v1/burstingDefinitions/{id}
- Get all bursting definitions
- Method: getPath:
/epm/rest/v1/burstingDefinitions
Files
Manage Library and temporary files for the Narrative Reporting service.
- Download a file
- Method: getPath:
/rest/v1/files/{fileId}
- Upload a temporary file
- Method: postPath:
/rest/v1/files
Jobs
Execute, view and manage Narrative Reporting jobs and their status.
- Create a new Job
- Method: postPath:
https://<servername>:<port number>/epm/rest/v1/jobs
- Get a Job's status
- Method: getPath:
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: getPath:
/epm/rest/v1/reportPackages/{id}/preview
- Get a published instance of the report package
- Method: getPath:
/epm/rest/v1/reportPackages/{id}/publish
- Get a report package
- Method: getPath:
/epm/rest/v1/reportPackages/{id}
- Get all top level report packages
- Method: getPath:
/epm/rest/v1/reportPackages
- Renders the Report Package's Report Center
- Method: getPath:
/epm/rest/v1/reportPackages/{id}/reportCenter
Report Snapshots
View and manage the Narrative Reporting Report Snapshots and their content.
- Get a report snapshot
- Method: getPath:
/epm/rest/v1/reportSnapshots/{id}
- Get all report snapshots
- Method: getPath:
/epm/rest/v1/reportSnapshots
- Get the report snapshot output
- Method: getPath:
/epm/rest/v1/reportSnapshots/{id}/executedReport
Reports
View and manage the Narrative Reporting Reports and their content.
- Get a report
- Method: getPath:
/epm/rest/v1/reports/{id}
- Get all reports
- Method: getPath:
/epm/rest/v1/reports
- Get the global point of view selections and member suggestions for report
- Method: getPath:
/epm/rest/v1/reports/{id}/globalPov
- Get the report output
- Method: getPath:
/epm/rest/v1/reports/{id}/executedReport
- Get the required member selection prompts for report
- Method: getPath:
/epm/rest/v1/reports/{id}/prompts