Skip to main content
POST
Publish a book to organisation administrators.

Authorizations

Authorization
string
header
required

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

Body

Required BookName for a Derivitec book owned by the caller.

Book selection for publishing it to eligible organisation administrators.

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

Organisation-scoped name of the book to select. The value must not be null or empty.

Example:

"Example book"

Response

Returns whether the expected administrator grants were made, with ownership, recipient, or same-name collision errors.

Outcome of publishing the selected book.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.BookAccess.ApiBookPublishResponse, 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.