Get a book

get

/epm/rest/v1/books/{id}

Request

Path Parameters
Query Parameters
  • A comma separated list of fields to return for each Book. If no fields are specified, the default fields (bookId, name, description, createdBy, creationDate, modifiedDate, pathName) will be included.
    • Allowed Values: [ "all", "bookId", "name", "description", "createdBy", "creationDate", "modifiedDate", "lastAccessed", "systemPath", "pathName", "output", "validationMessages", "datasourceNames", "globalPov" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Request successful
Body ()
Root Schema : Book
Type: object
Management Reporting Book
Show Source
Nested Schema : datasourceNames
Type: array
Read Only: true
The list of datasources referenced by this Book instance.
Show Source
Nested Schema : ItemCollectionPOVDimension
Type: object
Show Source
Nested Schema : output
Type: array
Read Only: true
A link to generate Book output in pdf or xlsx.
Show Source
Nested Schema : validationMessages
Type: array
Read Only: true
The errors found when trying to validate the Book.
Show Source
Nested Schema : items
Type: array
Read Only: true
Show Source
Nested Schema : POVDimension
Type: object
A Dimension that has a set of members to select from for Report execution.
Show Source
Nested Schema : suggestedMembers
Type: array
Read Only: true
The dimension's members suggested for use when executing the Report.
Show Source
Nested Schema : POVMember
Type: object
A member that can be selected as part of the point of view or as the value for a Report prompt.
Show Source

400 Response

Invalid parameter

404 Response

Book UUID not found

500 Response

Service Error
Back to Top