docs.jsonld
type: ApiDocumentation
title: DPG SalesApp Symfony API
description: This is the API documentation for the DPG SalesApp Symfony API. It is generated by API Platform and provides a comprehensive overview of the available endpoints, request/response formats, and authentication methods.
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: Booklet
supported class: BusinessArea
supported class: Document
supported class: Favorite
supported class: File
supported class: Notification
supported class: PasswordReset
supported class: ShareLink
supported class: Tag
supported class: User
supported class: UserInvitation
supported class: UserNotification
supported class: Entrypoint
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  returns: Error
  title: getError
description: A representation of common errors.
subclass of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
subclass of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous

Booklet
type: Class
title: Booklet
supported property: SupportedProperty
  property: Booklet/title
  title: title
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/icon
  title: icon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/regions
  title: regions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/keywords
  title: keywords
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/publicationDate
  title: publicationDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/version
  title: version
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/owner
  title: owner
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Booklet/documents
  title: documents
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/tags
  title: tags
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/businessAreas
  title: businessAreas
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Booklet/favoriteId
  title: favoriteId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Booklet/translations
  title: translations
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: Booklet/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Booklet/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Booklet resource.
  method: GET
  returns: Booklet
  title: getBooklet
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Booklet resource.
  expects: Booklet
  method: PUT
  returns: Booklet
  title: putBooklet
supported operation: Operation
  description: Updates the Booklet resource.
  expects: Booklet
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Booklet
  title: patchBooklet
supported operation: Operation
  type: DeleteAction
  description: Deletes the Booklet resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteBooklet

Booklet/title
type: Property
domain: Booklet
the hydra core vocabulary: title
range: string

Booklet/enabled
type: Property
domain: Booklet
the hydra core vocabulary: enabled
range: boolean

Booklet/icon
type: Property
domain: Booklet
the hydra core vocabulary: icon
range: string

Booklet/description
type: Property
domain: Booklet
the hydra core vocabulary: description
range: string

Booklet/regions
type: Property
domain: Booklet
the hydra core vocabulary: regions

Booklet/keywords
type: Property
domain: Booklet
the hydra core vocabulary: keywords
range: string

Booklet/status
type: Property
domain: Booklet
the hydra core vocabulary: status
range: string

Booklet/publicationDate
type: Property
domain: Booklet
the hydra core vocabulary: publicationDate
range: dateTime

Booklet/version
type: Property
domain: Booklet
the hydra core vocabulary: version
range: string

Booklet/owner
type: Property
domain: Booklet
the hydra core vocabulary: owner
max cardinality: 1
range: User

Booklet/documents
type: Property
domain: Booklet
the hydra core vocabulary: documents
range: Document

Booklet/tags
type: Property
domain: Booklet
the hydra core vocabulary: tags
range: Tag

Booklet/businessAreas
type: Property
domain: Booklet
the hydra core vocabulary: businessAreas
range: BusinessArea

Booklet/favoriteId
type: Property
domain: Booklet
the hydra core vocabulary: favoriteId
range: integer

Booklet/translations
type: Property
domain: Booklet
the hydra core vocabulary: translations

Booklet/createdAt
type: Property
domain: Booklet
the hydra core vocabulary: createdAt
range: dateTime

Booklet/updatedAt
type: Property
domain: Booklet
the hydra core vocabulary: updatedAt
range: dateTime

BusinessArea
type: Class
title: BusinessArea
supported property: SupportedProperty
  property: BusinessArea/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: BusinessArea/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: BusinessArea/translations
  title: translations
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: BusinessArea/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: BusinessArea/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a BusinessArea resource.
  method: GET
  returns: BusinessArea
  title: getBusinessArea
supported operation: Operation
  type: ReplaceAction
  description: Replaces the BusinessArea resource.
  expects: BusinessArea
  method: PUT
  returns: BusinessArea
  title: putBusinessArea
supported operation: Operation
  description: Updates the BusinessArea resource.
  expects: BusinessArea
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: BusinessArea
  title: patchBusinessArea
supported operation: Operation
  type: DeleteAction
  description: Deletes the BusinessArea resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteBusinessArea

BusinessArea/name
type: Property
domain: BusinessArea
the hydra core vocabulary: name
range: string

BusinessArea/description
type: Property
domain: BusinessArea
the hydra core vocabulary: description
range: string

BusinessArea/translations
type: Property
domain: BusinessArea
the hydra core vocabulary: translations

BusinessArea/createdAt
type: Property
domain: BusinessArea
the hydra core vocabulary: createdAt
range: dateTime

BusinessArea/updatedAt
type: Property
domain: BusinessArea
the hydra core vocabulary: updatedAt
range: dateTime

Document
type: Class
title: Document
supported property: SupportedProperty
  property: Document/title
  title: title
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/regions
  title: regions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/icon
  title: icon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/keywords
  title: keywords
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/owner
  title: owner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/accessType
  title: accessType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Document/publicationDate
  title: publicationDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/version
  title: version
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/file
  title: file
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/tags
  title: tags
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/businessAreas
  title: businessAreas
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/notes
  title: notes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/favoriteId
  title: favoriteId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/deleted
  title: deleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/allowRemove
  title: allowRemove
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Document/translations
  title: translations
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: Document/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Document/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Document resource.
  method: GET
  returns: Document
  title: getDocument
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Document resource.
  expects: Document
  method: PUT
  returns: Document
  title: putDocument
supported operation: Operation
  description: Updates the Document resource.
  expects: Document
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Document
  title: patchDocument
supported operation: Operation
  type: DeleteAction
  description: Deletes the Document resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteDocument

Document/title
type: Property
domain: Document
the hydra core vocabulary: title
range: string

Document/enabled
type: Property
domain: Document
the hydra core vocabulary: enabled
range: boolean

Document/description
type: Property
domain: Document
the hydra core vocabulary: description
range: string

Document/type
type: Property
domain: Document
the hydra core vocabulary: type
range: string

Document/language
type: Property
domain: Document
the hydra core vocabulary: language
range: string

Document/regions
type: Property
domain: Document
the hydra core vocabulary: regions

Document/icon
type: Property
domain: Document
the hydra core vocabulary: icon
range: string

Document/keywords
type: Property
domain: Document
the hydra core vocabulary: keywords
range: string

Document/owner
type: Property
domain: Document
the hydra core vocabulary: owner
max cardinality: 1
range: User

Document/status
type: Property
domain: Document
the hydra core vocabulary: status
range: string

Document/accessType
type: Property
domain: Document
the hydra core vocabulary: accessType
range: string

Document/publicationDate
type: Property
domain: Document
the hydra core vocabulary: publicationDate
range: dateTime

Document/version
type: Property
domain: Document
the hydra core vocabulary: version
range: string

Document/file
type: Property
domain: Document
the hydra core vocabulary: file
max cardinality: 1
range: File

Document/tags
type: Property
domain: Document
the hydra core vocabulary: tags
range: Tag

Document/businessAreas
type: Property
domain: Document
the hydra core vocabulary: businessAreas
range: BusinessArea

Document/notes
type: Property
domain: Document
the hydra core vocabulary: notes
range: string

Document/favoriteId
type: Property
domain: Document
the hydra core vocabulary: favoriteId
range: integer

Document/deleted
type: Property
domain: Document
the hydra core vocabulary: deleted
range: boolean

Document/deletedAt
type: Property
domain: Document
the hydra core vocabulary: deletedAt
range: dateTime

Document/allowRemove
type: Property
domain: Document
the hydra core vocabulary: allowRemove
range: boolean

Document/translations
type: Property
domain: Document
the hydra core vocabulary: translations

Document/createdAt
type: Property
domain: Document
the hydra core vocabulary: createdAt
range: dateTime

Document/updatedAt
type: Property
domain: Document
the hydra core vocabulary: updatedAt
range: dateTime

Favorite
type: Class
title: Favorite
supported property: SupportedProperty
  property: Favorite/icon
  title: icon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Favorite/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Favorite/owner
  title: owner
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Favorite/document
  title: document
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Favorite/booklet
  title: booklet
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Favorite/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Favorite/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Favorite resource.
  method: GET
  returns: Favorite
  title: getFavorite
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Favorite resource.
  expects: Favorite
  method: PUT
  returns: Favorite
  title: putFavorite
supported operation: Operation
  description: Updates the Favorite resource.
  expects: Favorite
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Favorite
  title: patchFavorite
supported operation: Operation
  type: DeleteAction
  description: Deletes the Favorite resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteFavorite

Favorite/icon
type: Property
domain: Favorite
the hydra core vocabulary: icon
range: string

Favorite/type
type: Property
domain: Favorite
the hydra core vocabulary: type
range: string

Favorite/owner
type: Property
domain: Favorite
the hydra core vocabulary: owner
max cardinality: 1
range: User

Favorite/document
type: Property
domain: Favorite
the hydra core vocabulary: document
max cardinality: 1
range: Document

Favorite/booklet
type: Property
domain: Favorite
the hydra core vocabulary: booklet
max cardinality: 1
range: Booklet

Favorite/createdAt
type: Property
domain: Favorite
the hydra core vocabulary: createdAt
range: dateTime

Favorite/updatedAt
type: Property
domain: Favorite
the hydra core vocabulary: updatedAt
range: dateTime

File
type: Class
title: File
supported property: SupportedProperty
  property: File/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/path
  title: path
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/url
  title: url
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/mimeType
  title: mimeType
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/size
  title: size
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/sizeHumanReadable
  title: sizeHumanReadable
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/dimensions
  title: dimensions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/deleted
  title: deleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: File/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a File resource.
  method: GET
  returns: File
  title: getFile
supported operation: Operation
  type: ReplaceAction
  description: Replaces the File resource.
  expects: File
  method: PUT
  returns: File
  title: putFile
supported operation: Operation
  description: Updates the File resource.
  expects: File
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: File
  title: patchFile
supported operation: Operation
  type: DeleteAction
  description: Deletes the File resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteFile

File/name
type: Property
domain: File
the hydra core vocabulary: name
range: string

File/path
type: Property
domain: File
the hydra core vocabulary: path
range: string

File/url
type: Property
domain: File
the hydra core vocabulary: url
range: string

File/mimeType
type: Property
domain: File
the hydra core vocabulary: mimeType
range: string

File/size
type: Property
domain: File
the hydra core vocabulary: size
range: integer

File/sizeHumanReadable
type: Property
domain: File
the hydra core vocabulary: sizeHumanReadable
range: string

File/dimensions
type: Property
domain: File
the hydra core vocabulary: dimensions

File/deleted
type: Property
domain: File
the hydra core vocabulary: deleted
range: boolean

File/deletedAt
type: Property
domain: File
the hydra core vocabulary: deletedAt
range: dateTime

File/createdAt
type: Property
domain: File
the hydra core vocabulary: createdAt
range: dateTime

File/updatedAt
type: Property
domain: File
the hydra core vocabulary: updatedAt
range: dateTime

Notification
type: Class
title: Notification
supported property: SupportedProperty
  property: Notification/type
  title: type
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/entityId
  title: entityId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/entityType
  title: entityType
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/message
  title: message
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/metadata
  title: metadata
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Notification/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Notification resource.
  method: GET
  returns: Notification
  title: getNotification
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Notification resource.
  expects: Notification
  method: PUT
  returns: Notification
  title: putNotification
supported operation: Operation
  description: Updates the Notification resource.
  expects: Notification
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Notification
  title: patchNotification
supported operation: Operation
  type: DeleteAction
  description: Deletes the Notification resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteNotification

Notification/type
type: Property
domain: Notification
the hydra core vocabulary: type
range: string

Notification/entityId
type: Property
domain: Notification
the hydra core vocabulary: entityId
range: integer

Notification/entityType
type: Property
domain: Notification
the hydra core vocabulary: entityType
range: string

Notification/message
type: Property
domain: Notification
the hydra core vocabulary: message
range: string

Notification/metadata
type: Property
domain: Notification
the hydra core vocabulary: metadata

Notification/createdBy
type: Property
domain: Notification
the hydra core vocabulary: createdBy
max cardinality: 1
range: User

Notification/createdAt
type: Property
domain: Notification
the hydra core vocabulary: createdAt
range: dateTime

Notification/updatedAt
type: Property
domain: Notification
the hydra core vocabulary: updatedAt
range: dateTime

PasswordReset
type: Class
title: PasswordReset
supported property: SupportedProperty
  property: PasswordReset/user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PasswordReset/token
  title: token
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PasswordReset/expiresAt
  title: expiresAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PasswordReset/used
  title: used
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PasswordReset/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PasswordReset/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a PasswordReset resource.
  method: GET
  returns: PasswordReset
  title: getPasswordReset
supported operation: Operation
  type: DeleteAction
  description: Deletes the PasswordReset resource.
  method: DELETE
  returns: owl:Nothing
  title: deletePasswordReset

PasswordReset/user
type: Property
domain: PasswordReset
the hydra core vocabulary: user
max cardinality: 1
range: User

PasswordReset/token
type: Property
domain: PasswordReset
the hydra core vocabulary: token
range: string

PasswordReset/expiresAt
type: Property
domain: PasswordReset
the hydra core vocabulary: expiresAt
range: dateTime

PasswordReset/used
type: Property
domain: PasswordReset
the hydra core vocabulary: used
range: boolean

PasswordReset/createdAt
type: Property
domain: PasswordReset
the hydra core vocabulary: createdAt
range: dateTime

PasswordReset/updatedAt
type: Property
domain: PasswordReset
the hydra core vocabulary: updatedAt
range: dateTime

ShareLink
type: Class
title: ShareLink
supported property: SupportedProperty
  property: ShareLink/token
  title: token
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ShareLink/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ShareLink/expiresAt
  title: expiresAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ShareLink/document
  title: document
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ShareLink/booklet
  title: booklet
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ShareLink/owner
  title: owner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ShareLink/url
  title: url
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ShareLink/urlApp
  title: urlApp
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ShareLink/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ShareLink/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a ShareLink resource.
  method: GET
  returns: ShareLink
  title: getShareLink
supported operation: Operation
  type: ReplaceAction
  description: Replaces the ShareLink resource.
  expects: ShareLink
  method: PUT
  returns: ShareLink
  title: putShareLink
supported operation: Operation
  description: Updates the ShareLink resource.
  expects: ShareLink
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: ShareLink
  title: patchShareLink
supported operation: Operation
  type: DeleteAction
  description: Deletes the ShareLink resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteShareLink

ShareLink/token
type: Property
domain: ShareLink
the hydra core vocabulary: token
range: string

ShareLink/type
type: Property
domain: ShareLink
the hydra core vocabulary: type
range: string

ShareLink/expiresAt
type: Property
domain: ShareLink
the hydra core vocabulary: expiresAt
range: dateTime

ShareLink/document
type: Property
domain: ShareLink
the hydra core vocabulary: document
max cardinality: 1
range: Document

ShareLink/booklet
type: Property
domain: ShareLink
the hydra core vocabulary: booklet
max cardinality: 1
range: Booklet

ShareLink/owner
type: Property
domain: ShareLink
the hydra core vocabulary: owner
max cardinality: 1
range: User

ShareLink/url
type: Property
domain: ShareLink
the hydra core vocabulary: url
range: string

ShareLink/urlApp
type: Property
domain: ShareLink
the hydra core vocabulary: urlApp
range: string

ShareLink/createdAt
type: Property
domain: ShareLink
the hydra core vocabulary: createdAt
range: dateTime

ShareLink/updatedAt
type: Property
domain: ShareLink
the hydra core vocabulary: updatedAt
range: dateTime

Tag
type: Class
title: Tag
supported property: SupportedProperty
  property: Tag/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Tag/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Tag/translations
  title: translations
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: Tag/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Tag/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Tag resource.
  method: GET
  returns: Tag
  title: getTag
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Tag resource.
  expects: Tag
  method: PUT
  returns: Tag
  title: putTag
supported operation: Operation
  description: Updates the Tag resource.
  expects: Tag
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Tag
  title: patchTag
supported operation: Operation
  type: DeleteAction
  description: Deletes the Tag resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteTag

Tag/name
type: Property
domain: Tag
the hydra core vocabulary: name
range: string

Tag/description
type: Property
domain: Tag
the hydra core vocabulary: description
range: string

Tag/translations
type: Property
domain: Tag
the hydra core vocabulary: translations

Tag/createdAt
type: Property
domain: Tag
the hydra core vocabulary: createdAt
range: dateTime

Tag/updatedAt
type: Property
domain: Tag
the hydra core vocabulary: updatedAt
range: dateTime

User
type: Class
title: User
supported property: SupportedProperty
  property: User/email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/roles
  title: roles
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: User/plainPassword
  title: plainPassword
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: User/username
  title: username
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/firstname
  title: firstname
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastname
  title: lastname
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/fullname
  title: fullname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/preferredLocale
  title: preferredLocale
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/region
  title: region
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/location
  title: location
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastLogin
  title: lastLogin
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a User resource.
  method: GET
  returns: User
  title: getUser
supported operation: Operation
  description: Updates the User resource.
  expects: User
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: User
  title: patchUser
supported operation: Operation
  type: DeleteAction
  description: Deletes the User resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteUser

User/email
type: Property
domain: User
the hydra core vocabulary: email
range: string

User/roles
type: Property
domain: User
the hydra core vocabulary: roles

User/plainPassword
type: Property
domain: User
the hydra core vocabulary: plainPassword
range: string

User/username
type: Property
domain: User
the hydra core vocabulary: username
range: string

User/firstname
type: Property
domain: User
the hydra core vocabulary: firstname
range: string

User/lastname
type: Property
domain: User
the hydra core vocabulary: lastname
range: string

User/fullname
type: Property
domain: User
the hydra core vocabulary: fullname
range: string

User/avatar
type: Property
domain: User
the hydra core vocabulary: avatar
range: string

User/language
type: Property
domain: User
the hydra core vocabulary: language
range: string

User/preferredLocale
type: Property
domain: User
the hydra core vocabulary: preferredLocale
range: string

User/region
type: Property
domain: User
the hydra core vocabulary: region
range: string

User/location
type: Property
domain: User
the hydra core vocabulary: location
range: string

User/lastLogin
type: Property
domain: User
the hydra core vocabulary: lastLogin
range: dateTime

User/enabled
type: Property
domain: User
the hydra core vocabulary: enabled
range: boolean

User/createdAt
type: Property
domain: User
the hydra core vocabulary: createdAt
range: dateTime

User/updatedAt
type: Property
domain: User
the hydra core vocabulary: updatedAt
range: dateTime

UserInvitation
type: Class
title: UserInvitation
supported property: SupportedProperty
  property: UserInvitation/token
  title: token
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: UserInvitation/email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserInvitation/roles
  title: roles
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserInvitation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserInvitation/expiresAt
  title: expiresAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserInvitation/invitedBy
  title: invitedBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: UserInvitation/invitedUser
  title: invitedUser
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: UserInvitation/acceptedAt
  title: acceptedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: UserInvitation/metadata
  title: metadata
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: UserInvitation/locale
  title: locale
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: UserInvitation/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: UserInvitation/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: UserInvitation/isExpired
  title: isExpired
  required: false
  readable: true
  writeable: false
  description: Get computed properties for API responses
supported property: SupportedProperty
  property: UserInvitation/isValid
  title: isValid
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: UserInvitation/daysUntilExpiration
  title: daysUntilExpiration
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a UserInvitation resource.
  method: GET
  returns: UserInvitation
  title: getUserInvitation
supported operation: Operation
  description: Updates the UserInvitation resource.
  expects: UserInvitation
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: UserInvitation
  title: patchUserInvitation
supported operation: Operation
  type: DeleteAction
  description: Deletes the UserInvitation resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteUserInvitation

UserInvitation/token
type: Property
domain: UserInvitation
the hydra core vocabulary: token
range: string

UserInvitation/email
type: Property
domain: UserInvitation
the hydra core vocabulary: email
range: string

UserInvitation/roles
type: Property
domain: UserInvitation
the hydra core vocabulary: roles

UserInvitation/status
type: Property
domain: UserInvitation
the hydra core vocabulary: status
range: string

UserInvitation/expiresAt
type: Property
domain: UserInvitation
the hydra core vocabulary: expiresAt
range: dateTime

UserInvitation/invitedBy
type: Property
domain: UserInvitation
the hydra core vocabulary: invitedBy
max cardinality: 1
range: User

UserInvitation/invitedUser
type: Property
domain: UserInvitation
the hydra core vocabulary: invitedUser
max cardinality: 1
range: User

UserInvitation/acceptedAt
type: Property
domain: UserInvitation
the hydra core vocabulary: acceptedAt
range: dateTime

UserInvitation/metadata
type: Property
domain: UserInvitation
the hydra core vocabulary: metadata

UserInvitation/locale
type: Property
domain: UserInvitation
the hydra core vocabulary: locale
range: string

UserInvitation/createdAt
type: Property
domain: UserInvitation
the hydra core vocabulary: createdAt
range: dateTime

UserInvitation/updatedAt
type: Property
domain: UserInvitation
the hydra core vocabulary: updatedAt
range: dateTime

UserInvitation/isExpired
type: Property
domain: UserInvitation
the hydra core vocabulary: isExpired
range: boolean

UserInvitation/isValid
type: Property
domain: UserInvitation
the hydra core vocabulary: isValid
range: boolean

UserInvitation/daysUntilExpiration
type: Property
domain: UserInvitation
the hydra core vocabulary: daysUntilExpiration
range: integer

UserNotification
type: Class
title: UserNotification
supported property: SupportedProperty
  property: UserNotification/user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserNotification/notification
  title: notification
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserNotification/isRead
  title: isRead
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserNotification/readAt
  title: readAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserNotification/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: UserNotification/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a UserNotification resource.
  method: GET
  returns: UserNotification
  title: getUserNotification
supported operation: Operation
  type: ReplaceAction
  description: Replaces the UserNotification resource.
  expects: UserNotification
  method: PUT
  returns: UserNotification
  title: putUserNotification
supported operation: Operation
  description: Updates the UserNotification resource.
  expects: UserNotification
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: UserNotification
  title: patchUserNotification
supported operation: Operation
  type: DeleteAction
  description: Deletes the UserNotification resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteUserNotification

UserNotification/user
type: Property
domain: UserNotification
the hydra core vocabulary: user
max cardinality: 1
range: User

UserNotification/notification
type: Property
domain: UserNotification
the hydra core vocabulary: notification
max cardinality: 1
range: Notification

UserNotification/isRead
type: Property
domain: UserNotification
the hydra core vocabulary: isRead
range: boolean

UserNotification/readAt
type: Property
domain: UserNotification
the hydra core vocabulary: readAt
range: dateTime

UserNotification/createdAt
type: Property
domain: UserNotification
the hydra core vocabulary: createdAt
range: dateTime

UserNotification/updatedAt
type: Property
domain: UserNotification
the hydra core vocabulary: updatedAt
range: dateTime

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/booklet
  title: getBookletCollection
  description: The collection of Booklet resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/businessArea
  title: getBusinessAreaCollection
  description: The collection of BusinessArea resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/document
  title: getDocumentCollection
  description: The collection of Document resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/favorite
  title: getFavoriteCollection
  description: The collection of Favorite resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/file
  title: getFileCollection
  description: The collection of File resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/notification
  title: getNotificationCollection
  description: The collection of Notification resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/passwordReset
  title: getPasswordResetCollection
  description: The collection of PasswordReset resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/shareLink
  title: getShareLinkCollection
  description: The collection of ShareLink resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/tag
  title: getTagCollection
  description: The collection of Tag resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/user
  title: getUserCollection
  description: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/userInvitation
  title: getUserInvitationCollection
  description: The collection of UserInvitation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/userNotification
  title: getUserNotificationCollection
  description: The collection of UserNotification resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

Entrypoint/booklet
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Booklet
supported operation: Operation
  type: CreateAction
  description: Creates a Booklet resource.
  expects: Booklet
  method: POST
  returns: Booklet
  title: postBooklet
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Booklet resources.
  method: GET
  returns: Collection
  title: getBookletCollection

Entrypoint/businessArea
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BusinessArea
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of BusinessArea resources.
  method: GET
  returns: Collection
  title: getBusinessAreaCollection
supported operation: Operation
  type: CreateAction
  description: Creates a BusinessArea resource.
  expects: BusinessArea
  method: POST
  returns: BusinessArea
  title: postBusinessArea

Entrypoint/document
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Document
supported operation: Operation
  type: CreateAction
  description: Creates a Document resource.
  expects: Document
  method: POST
  returns: Document
  title: postDocument
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Document resources.
  method: GET
  returns: Collection
  title: getDocumentCollection

Entrypoint/favorite
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Favorite
supported operation: Operation
  type: CreateAction
  description: Creates a Favorite resource.
  expects: Favorite
  method: POST
  returns: Favorite
  title: postFavorite
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Favorite resources.
  method: GET
  returns: Collection
  title: getFavoriteCollection

Entrypoint/file
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: File
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of File resources.
  method: GET
  returns: Collection
  title: getFileCollection
supported operation: Operation
  type: CreateAction
  description: Creates a File resource.
  expects: File
  method: POST
  returns: File
  title: postFile

Entrypoint/notification
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Notification
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Notification resources.
  method: GET
  returns: Collection
  title: getNotificationCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Notification resource.
  expects: Notification
  method: POST
  returns: Notification
  title: postNotification

Entrypoint/passwordReset
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PasswordReset
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of PasswordReset resources.
  method: GET
  returns: Collection
  title: getPasswordResetCollection

Entrypoint/shareLink
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ShareLink
supported operation: Operation
  type: CreateAction
  description: Creates a ShareLink resource.
  expects: ShareLink
  method: POST
  returns: ShareLink
  title: postShareLink
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ShareLink resources.
  method: GET
  returns: Collection
  title: getShareLinkCollection

Entrypoint/tag
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Tag
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Tag resources.
  method: GET
  returns: Collection
  title: getTagCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Tag resource.
  expects: Tag
  method: POST
  returns: Tag
  title: postTag

Entrypoint/user
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: User
  title: postUser
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  returns: Collection
  title: getUserCollection

Entrypoint/userInvitation
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UserInvitation
supported operation: Operation
  type: CreateAction
  description: Creates a UserInvitation resource.
  expects: UserInvitation
  method: POST
  returns: UserInvitation
  title: postUserInvitation
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of UserInvitation resources.
  method: GET
  returns: Collection
  title: getUserInvitationCollection

Entrypoint/userNotification
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UserNotification
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of UserNotification resources.
  method: GET
  returns: Collection
  title: getUserNotificationCollection
supported operation: Operation
  type: CreateAction
  description: Creates a UserNotification resource.
  expects: UserNotification
  method: POST
  returns: UserNotification
  title: postUserNotification

ConstraintViolationList
type: Class
title: ConstraintViolationList
description: A constraint violation List.
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolationList
range: string

message
type: Property
domain: ConstraintViolationList
range: string