Get a book
get
/epm/rest/v1/books/{id}
Request
Path Parameters
-
id(required): string
The Book UUID being requested.
Query Parameters
-
fields: array[string]
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 TopResponse
Supported Media Types
- application/json
200 Response
Request successful
Root Schema : Book
Type:
object
Management Reporting Book
Show Source
-
bookId: string
Read Only:
true
-
createdBy: string
Read Only:
true
-
creationDate: string
(date-time)
Read Only:
true
-
datasourceNames: array
datasourceNames
Read Only:
true
The list of datasources referenced by this Book instance. -
description: string
Read Only:
true
-
globalPov: object
ItemCollectionPOVDimension
-
lastAccessed: string
(date-time)
Read Only:
true
-
links: array
links
Read Only:
true
-
modifiedDate: string
(date-time)
Read Only:
true
-
name: string
Read Only:
true
-
output: array
output
Read Only:
true
A link to generate Book output in pdf or xlsx. -
pathName: string
Read Only:
true
-
primaryDatasource: string
Read Only:
true
-
systemPath: string
Read Only:
true
-
validationMessages: array
validationMessages
Read Only:
true
The errors found when trying to validate the Book.
Nested Schema : datasourceNames
Type:
array
Read Only:
true
The list of datasources referenced by this Book instance.
Show Source
Nested Schema : ItemCollectionPOVDimension
Type:
Show Source
object
-
count: integer
(int32)
Read Only:
true
-
hasMore: boolean
Read Only:
true
-
items: array
items
Read Only:
true
-
limit: integer
(int32)
-
links: array
links
Read Only:
true
-
offset: integer
(int32)
Read Only:
true
-
totalResults: integer
(int32)
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:
Show Source
true
-
Array of:
object POVDimension
A Dimension that has a set of members to select from for Report execution.
Nested Schema : POVDimension
Type:
object
A Dimension that has a set of members to select from for Report execution.
Show Source
-
dimensionId: string
Read Only:
true
-
fixedSelection: boolean
Read Only:
true
- hidden: boolean
-
links: array
links
Read Only:
true
-
name: string
Read Only:
true
-
suggestedMembers: array
suggestedMembers
Read Only:
true
The dimension's members suggested for use when executing the Report.
Nested Schema : suggestedMembers
Type:
array
Read Only:
true
The dimension's members suggested for use when executing the Report.
Show Source
-
Array of:
object POVMember
A member that can be selected as part of the point of view or as the value for a Report prompt.
Nested Schema : Link
Type:
Show Source
object
-
href: string
-
rel: string
Allowed Values:
[ "self", "next", "prev", "first", "canonical", "parent" ]
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
-
alias: string
Read Only:
true
-
links: array
links
Read Only:
true
-
memberId: string
Read Only:
true
-
name: string
Read Only:
true
400 Response
Invalid parameter
404 Response
Book UUID not found
500 Response
Service Error