Skip to main content
GET
List books available to the current user.

Authorizations

Authorization
string
header
required

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

Response

Returns the accessible book summaries.

id
integer<int32>
required

Book identifier.

Example:

1001

name
string
required

Book display name.

Minimum string length: 1
Example:

"Example book"

$type
enum<string>
required
Available options:
Derivitec.Web.Models.Book.BookInfoViewModel, Derivitec.Web.Models
access_type_id
enum<string>

Access level for this book in the current view.

Available options:
not_set,
view,
edit,
owner
description
string | null

Book description.

is_checked
boolean

Whether this book is marked as checked in the current view.

Example:

true

is_disabled
boolean

Whether this book is disabled in the current view.

Example:

true

number_of_parent_portfolios
integer<int32>

Number of parent portfolios linked to this book.

Example:

0

status
enum<string>

Lifecycle status of this book.

Available options:
not_set,
active,
inactive