Skip to main content
GET
Retrieve a book by identifier.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Path Parameters

id
integer<int32>
required

Required signed 32-bit Risk Portal book identifier constrained by the {id:int} route; no positive-range check is declared. For example, 42.

Response

Returns the accessible book details, or a null body when the identifier is unavailable to the caller.

Detailed book view including related portfolios and entitled users.

description
string
required

Book description.

Required string length: 5 - 255
id
integer<int32>
required

Book identifier.

name
string
required

Book display name.

Required string length: 3 - 100
status
enum<string>
required

Lifecycle status of this book.

Available options:
not_set,
active,
inactive
$type
enum<string>
required
Available options:
Derivitec.Web.Models.Book.BookViewModel, Derivitec.Web.Models
access_type_id
enum<string>

Access level for this book in the current view.

Available options:
not_set,
view,
edit,
owner
number_of_parent_portfolios
integer<int32>

Number of parent portfolios linked to this book.

parent_portfolios
object[] | null
read-only

Parent portfolios linked to this book.

entitled_users
object[] | null
read-only

Users with recorded access to this book.