Skip to main content
POST
Create a book.

Authorizations

Authorization
string
header
required

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

Body

Required non-empty BookName and Description. This request declares no explicit length bounds.

Book name and description used to create a Derivitec-managed book.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Book.ApiBookCreateRequest, Derivitec.Web.Core
book_name
string | null

Name for the new book; it must be non-empty and unique among books linked to the caller.

Example:

"Example book"

description
string | null

Non-empty client-visible description for the new book.

Response

Created

Outcome of creating a book.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Book.ApiBookCreateResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.