docs.jsonld
type: ApiDocumentation
title: STI API Platform
entrypoint: /
supported class: Error
supported class: ConstraintViolationList
supported class: Permission
supported class: ProjectStatus
supported class: Task Feed
supported class: Task Plan
supported class: TaskPriority
supported class: TaskStandardField
supported class: TaskStatus
supported class: Translation
supported class: ProjectUserRole
supported class: Role
supported class: Company
supported class: Country
supported class: Form
supported class: Field
supported class: FieldConstrain
supported class: FieldOptionList
supported class: ProjectForm
supported class: Group
supported class: MediaObject
supported class: Plan
supported class: PlanMediaObject
supported class: Project
supported class: Task
supported class: Attachment
supported class: Comment
supported class: User
supported class: Entrypoint
supported class: ConstraintViolation

Error
type: Class
title: Error
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: detail
  title: detail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: instance
  title: instance
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: trace
  title: trace
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hydra:title
  title: hydra:title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hydra:description
  title: hydra:description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: string
  title: string
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: previous
  title: previous
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: traceAsString
  title: traceAsString
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error

title
type: Property
domain: Error
range: string

detail
type: Property
domain: Error
range: string

status
type: Property
domain: Error
range: integer

instance
type: Property
domain: Error
range: string

type
type: Property
domain: Error
range: string

trace
type: Property
domain: Error

message
type: Property
domain: Error
range: string

code
type: Property
domain: Error
range: integer

file
type: Property
domain: Error
range: string

line
type: Property
domain: Error
range: integer

hydra:title
type: Property
domain: Error
range: string

hydra:description
type: Property
domain: Error
range: string

description
type: Property
domain: Error
range: string

string
type: Property
domain: Error

previous
type: Property
domain: Error

traceAsString
type: Property
domain: Error
range: string

ConstraintViolationList
type: Class
title: ConstraintViolationList
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: errorTitle
  title: errorTitle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: detail
  title: detail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hydra:title
  title: hydra:title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hydra:description
  title: hydra:description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: string
  title: string
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: previous
  title: previous
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: traceAsString
  title: traceAsString
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ConstraintViolationList resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ConstraintViolationList resource.
  returns: ConstraintViolationList
supported operation: Retrieves a ConstraintViolationList resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ConstraintViolationList resource.
  returns: ConstraintViolationList
supported operation: Retrieves a ConstraintViolationList resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ConstraintViolationList resource.
  returns: ConstraintViolationList
description: Thrown when a validation error occurs.
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

status
type: Property
domain: ConstraintViolationList
range: integer

errorTitle
type: Property
domain: ConstraintViolationList
range: string

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

detail
type: Property
domain: ConstraintViolationList
range: string

message
type: Property
domain: ConstraintViolationList
range: string

code
type: Property
domain: ConstraintViolationList
range: string
range: integer

file
type: Property
domain: ConstraintViolationList
range: string

line
type: Property
domain: ConstraintViolationList
range: integer

hydra:title
type: Property
domain: ConstraintViolationList
range: string

hydra:description
type: Property
domain: ConstraintViolationList
range: string

type
type: Property
domain: ConstraintViolationList
range: string

title
type: Property
domain: ConstraintViolationList
range: string

instance
type: Property
domain: ConstraintViolationList
range: string

statusCode
type: Property
domain: ConstraintViolationList
range: integer

headers
type: Property
domain: ConstraintViolationList

string
type: Property
domain: ConstraintViolationList

trace
type: Property
domain: ConstraintViolationList

previous
type: Property
domain: ConstraintViolationList

traceAsString
type: Property
domain: ConstraintViolationList
range: string

Permission
type: Class
title: Permission
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectName
  title: subjectName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectValue
  title: subjectValue
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Permission resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Permission resource.
  returns: Nothing

description
type: Property
domain: Permission
range: string

subjectName
type: Property
domain: Permission
range: string

subjectValue
type: Property
domain: Permission
range: string

ProjectStatus
type: Class
title: ProjectStatus
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ProjectStatus resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectStatus resource.
  returns: Nothing

description
type: Property
domain: ProjectStatus
range: string

Task Feed
type: Class
title: Task Feed
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: body
  title: body
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Task Feed resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Task Feed resource.
  returns: Nothing

type
type: Property
domain: #Task Feed
range: string

body
type: Property
domain: #Task Feed
range: string

createdAt
type: Property
domain: #Task Feed
range: string

createdBy
type: Property
domain: #Task Feed
range: string

Task Plan
type: Class
title: Task Plan
supported property: SupportedProperty
  property: task
  title: task
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: coordX
  title: coordX
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: coordY
  title: coordY
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Task Plan resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Task Plan resource.
  returns: Nothing

task
type: Link
domain: #Task Plan
max cardinality: 1
range: Task

coordX
type: Property
domain: #Task Plan
range: decimal

coordY
type: Property
domain: #Task Plan
range: decimal

TaskPriority
type: Class
title: TaskPriority
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a TaskPriority resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TaskPriority resource.
  returns: Nothing

description
type: Property
domain: TaskPriority
range: string

TaskStandardField
type: Class
title: TaskStandardField
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a TaskStandardField resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TaskStandardField resource.
  returns: Nothing

description
type: Property
domain: TaskStandardField
range: string

TaskStatus
type: Class
title: TaskStatus
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: color
  title: color
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a TaskStatus resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TaskStatus resource.
  returns: Nothing

description
type: Property
domain: TaskStatus
range: string

color
type: Property
domain: TaskStatus
range: string

Translation
type: Class
title: Translation
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: key
  title: key
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Translation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Translation resource.
  returns: Nothing

entity
type: Property
domain: Translation
range: string

key
type: Property
domain: Translation
range: string

value
type: Property
domain: Translation
range: string

ProjectUserRole
type: Class
title: ProjectUserRole
supported property: SupportedProperty
  property: role
  title: role
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ProjectUserRole resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectUserRole resource.
  returns: Nothing
supported operation: Updates the ProjectUserRole resource.
  type: Operation
  expects: ProjectUserRole
  method: PATCH
  title: Updates the ProjectUserRole resource.
  returns: ProjectUserRole
supported operation: Deletes the ProjectUserRole resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProjectUserRole resource.
  returns: Nothing

role
type: Link
domain: ProjectUserRole
max cardinality: 1
range: Role

project
type: Link
domain: ProjectUserRole
max cardinality: 1
range: Project

user
type: Link
domain: ProjectUserRole
max cardinality: 1
range: User

Role
type: Class
title: Role
supported property: SupportedProperty
  property: rolePermissions
  title: rolePermissions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Role resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Role resource.
  returns: Role
supported operation: Updates the Role resource.
  type: Operation
  expects: Role
  method: PATCH
  title: Updates the Role resource.
  returns: Role
supported operation: Deletes the Role resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Role resource.
  returns: Nothing
description: Роль Проекта, работают через пермишены и кастомные voters. Есть ещё системные роли (enum SystemRoles), работают через SecurityBundle.

rolePermissions
type: Property
domain: Role

name
type: Property
domain: Role
range: string

Company
type: Class
title: Company
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Company resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Company resource.
  returns: Company
supported operation: Retrieves a Company resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Company resource.
  returns: Company
supported operation: Updates the Company resource.
  type: Operation
  expects: Company
  method: PATCH
  title: Updates the Company resource.
  returns: Company
supported operation: Deletes the Company resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Company resource.
  returns: Nothing

name
type: Property
domain: Company
range: string

Country
type: Class
title: Country
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Country resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Country resource.
  returns: Country
supported operation: Updates the Country resource.
  type: Operation
  expects: Country
  method: PATCH
  title: Updates the Country resource.
  returns: Country
supported operation: Deletes the Country resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Country resource.
  returns: Nothing

name
type: Property
domain: Country
range: string

Form
type: Class
title: Form
supported property: SupportedProperty
  property: fields
  title: fields
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: standardFields
  title: standardFields
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Form resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Form resource.
  returns: Form
supported operation: Replaces the Form resource.
  type: Operation
  type: ReplaceAction
  expects: Form
  method: PUT
  title: Replaces the Form resource.
  returns: Form
supported operation: Deletes the Form resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Form resource.
  returns: Nothing

fields
type: Property
domain: Form
range: Field

name
type: Property
domain: Form
range: string

standardFields
type: Property
domain: Form

Field
type: Class
title: Field
supported property: SupportedProperty
  property: optionList
  title: optionList
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: constraints
  title: constraints
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: options
  title: options
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: baseConstraints
  title: baseConstraints
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: userConstraints
  title: userConstraints
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: sortOrder
  title: sortOrder
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Field resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Field resource.
  returns: Field

optionList
type: Link
domain: Field
max cardinality: 1
range: FieldOptionList

constraints
type: Property
domain: Field
range: FieldConstrain

options
type: Property
domain: Field

name
type: Property
domain: Field
range: string

type
type: Property
domain: Field

baseConstraints
type: Property
domain: Field

userConstraints
type: Property
domain: Field

sortOrder
type: Property
domain: Field
range: integer

FieldConstrain
type: Class
title: FieldConstrain
supported property: SupportedProperty
  property: constrain
  title: constrain
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: settings
  title: settings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: field
  title: field
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a FieldConstrain resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FieldConstrain resource.
  returns: Nothing

constrain
type: Property
domain: FieldConstrain
range: string

settings
type: Property
domain: FieldConstrain

field
type: Link
domain: FieldConstrain
max cardinality: 1
range: Field

FieldOptionList
type: Class
title: FieldOptionList
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: values
  title: values
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a FieldOptionList resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FieldOptionList resource.
  returns: FieldOptionList
supported operation: Updates the FieldOptionList resource.
  type: Operation
  expects: FieldOptionList
  method: PATCH
  title: Updates the FieldOptionList resource.
  returns: FieldOptionList
supported operation: Deletes the FieldOptionList resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the FieldOptionList resource.
  returns: Nothing

name
type: Property
domain: FieldOptionList
range: string

values
type: Property
domain: FieldOptionList

ProjectForm
type: Class
title: ProjectForm
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: form
  title: form
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isNameable
  title: isNameable
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ProjectForm resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectForm resource.
  returns: ProjectForm
supported operation: Updates the ProjectForm resource.
  type: Operation
  expects: ProjectForm
  method: PATCH
  title: Updates the ProjectForm resource.
  returns: ProjectForm
supported operation: Deletes the ProjectForm resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProjectForm resource.
  returns: Nothing

project
type: Link
domain: ProjectForm
max cardinality: 1
range: Project

form
type: Link
domain: ProjectForm
max cardinality: 1
range: Form

isNameable
type: Property
domain: ProjectForm
range: boolean

Group
type: Class
title: Group
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: users
  title: users
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Group resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Group resource.
  returns: Group
supported operation: Updates the Group resource.
  type: Operation
  expects: Group
  method: PATCH
  title: Updates the Group resource.
  returns: Group
supported operation: Deletes the Group resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Group resource.
  returns: Nothing

name
type: Property
domain: Group
range: string

users
type: Link
domain: Group
range: User

MediaObject
type: Class
title: MediaObject
supported property: SupportedProperty
  property: contentUrl
  title: contentUrl
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a MediaObject resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a MediaObject resource.
  returns: Nothing
description: Для создания отношений желательно использовать OneToMany через ManyToMany с unique колонкой

contentUrl
type: Property
domain: MediaObject
range: string

Plan
type: Class
title: Plan
supported property: SupportedProperty
  property: parent
  title: parent
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: children
  title: children
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: sort_order
  title: sort_order
  required: false
  readable: false
  writeable: true
supported operation: Retrieves a Plan resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Plan resource.
  returns: Nothing
supported operation: Updates the Plan resource.
  type: Operation
  expects: Plan
  method: PATCH
  title: Updates the Plan resource.
  returns: Plan
supported operation: Deletes the Plan resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Plan resource.
  returns: Nothing
description: Hierarchical levels of project plan

parent
type: Property
domain: Plan
max cardinality: 1
range: Plan

project
type: Link
domain: Plan
max cardinality: 1
range: Project

children
type: Property
domain: Plan
range: Plan

name
type: Property
domain: Plan
range: string

sort_order
type: Property
domain: Plan
range: integer

PlanMediaObject
type: Class
title: PlanMediaObject
supported property: SupportedProperty
  property: mediaObject
  title: mediaObject
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: plan
  title: plan
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: false
  writeable: true
supported operation: Retrieves a PlanMediaObject resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a PlanMediaObject resource.
  returns: Nothing
supported operation: Updates the PlanMediaObject resource.
  type: Operation
  expects: PlanMediaObject
  method: PATCH
  title: Updates the PlanMediaObject resource.
  returns: PlanMediaObject
supported operation: Deletes the PlanMediaObject resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the PlanMediaObject resource.
  returns: Nothing
description: Versions of plan media files

mediaObject
type: Link
domain: PlanMediaObject
max cardinality: 1
range: MediaObject

plan
type: Link
domain: PlanMediaObject
max cardinality: 1
range: Plan

name
type: Property
domain: PlanMediaObject
range: string

Project
type: Class
title: Project
supported property: SupportedProperty
  property: logo
  title: logo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdBy
  title: createdBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: plans
  title: plans
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startDate
  title: startDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: endDate
  title: endDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: city
  title: city
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: address
  title: address
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: coordLat
  title: coordLat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: coordLon
  title: coordLon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Project resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Project resource.
  returns: Project
supported operation: Updates the Project resource.
  type: Operation
  expects: Project
  method: PATCH
  title: Updates the Project resource.
  returns: Project
supported operation: Deletes the Project resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Project resource.
  returns: Nothing

logo
type: Property
domain: Project
max cardinality: 1
range: MediaObject

createdBy
type: Link
domain: Project
max cardinality: 1
range: User

country
type: Property
domain: Project
max cardinality: 1
range: Country

plans
type: Property
domain: Project
range: Plan

name
type: Property
domain: Project
range: string

code
type: Property
domain: Project
range: string

startDate
type: Property
domain: Project
range: dateTime

endDate
type: Property
domain: Project
range: dateTime

description
type: Property
domain: Project
range: string

url
type: Property
domain: Project
range: string

city
type: Property
domain: Project
range: string

address
type: Property
domain: Project
range: string

coordLat
type: Property
domain: Project
range: string

coordLon
type: Property
domain: Project
range: string

status
type: Property
domain: Project

createdAt
type: Property
domain: Project
range: dateTime

updatedAt
type: Property
domain: Project
range: dateTime

Task
type: Class
title: Task
supported property: SupportedProperty
  property: taskPlan
  title: taskPlan
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: parent
  title: parent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: form
  title: form
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: responsibleUser
  title: responsibleUser
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdBy
  title: createdBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: children
  title: children
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: attachments
  title: attachments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fieldValues
  title: fieldValues
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: recipientUsers
  title: recipientUsers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: recipientGroups
  title: recipientGroups
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: factualProgress
  title: factualProgress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deadline
  title: deadline
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Task resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Task resource.
  returns: Task
supported operation: Updates the Task resource.
  type: Operation
  expects: Task
  method: PATCH
  title: Updates the Task resource.
  returns: Task
supported operation: Deletes the Task resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Task resource.
  returns: Nothing

taskPlan
type: Property
domain: Task

parent
type: Link
domain: Task
max cardinality: 1
range: Task

project
type: Link
domain: Task
max cardinality: 1
range: Project

form
type: Property
domain: Task
max cardinality: 1
range: Form

responsibleUser
type: Property
domain: Task
max cardinality: 1
range: User

createdBy
type: Property
domain: Task
max cardinality: 1
range: User

children
type: Link
domain: Task
range: Task

attachments
type: Property
domain: Task
range: Attachment

fieldValues
type: Property
domain: Task

recipientUsers
type: Property
domain: Task
range: User

recipientGroups
type: Link
domain: Task
range: Group

name
type: Property
domain: Task
range: string

factualProgress
type: Property
domain: Task
range: decimal

deadline
type: Property
domain: Task
range: dateTime

status
type: Property
domain: Task

priority
type: Property
domain: Task

createdAt
type: Property
domain: Task
range: dateTime

updatedAt
type: Property
domain: Task
range: dateTime

Attachment
type: Class
title: Attachment
supported property: SupportedProperty
  property: createdBy
  title: createdBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: mediaObject
  title: mediaObject
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: task
  title: task
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fileUrl
  title: fileUrl
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Attachment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Attachment resource.
  returns: Nothing
supported operation: Deletes the Attachment resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Attachment resource.
  returns: Nothing

createdBy
type: Link
domain: Attachment
max cardinality: 1
range: User

mediaObject
type: Link
domain: Attachment
max cardinality: 1
range: MediaObject

task
type: Link
domain: Attachment
max cardinality: 1
range: Task

createdAt
type: Property
domain: Attachment
range: dateTime

fileUrl
type: Property
domain: Attachment
range: string

Comment
type: Class
title: Comment
supported property: SupportedProperty
  property: task
  title: task
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdBy
  title: createdBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: body
  title: body
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Comment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Comment resource.
  returns: Nothing

task
type: Link
domain: Comment
max cardinality: 1
range: Task

createdBy
type: Link
domain: Comment
max cardinality: 1
range: User

body
type: Property
domain: Comment
range: string

createdAt
type: Property
domain: Comment
range: dateTime

User
type: Class
title: User
supported property: SupportedProperty
  property: tasksAsResponsible
  title: tasksAsResponsible
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: groups
  title: groups
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: profile
  title: profile
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: projectUserRoles
  title: projectUserRoles
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userShort
  title: userShort
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userIdentifier
  title: userIdentifier
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Updates the User resource.
  type: Operation
  expects: User
  method: PATCH
  title: Updates the User resource.
  returns: User
supported operation: Deletes the User resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the User resource.
  returns: Nothing

tasksAsResponsible
type: Link
domain: User
range: Task

groups
type: Link
domain: User
range: Group

profile
type: Property
domain: User

projectUserRoles
type: Link
domain: User
range: ProjectUserRole

email
type: Property
domain: User
range: string

roles
type: Property
domain: User

password
type: Property
domain: User
range: string

plainPassword
type: Property
domain: User
range: string

userShort
type: Property
domain: User
range: string

userIdentifier
type: Property
domain: User
range: string

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of Permission resources
  title: The collection of Permission resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectStatus resources
  title: The collection of ProjectStatus resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Task Feed resources
  title: The collection of Task Feed resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Task Plan resources
  title: The collection of Task Plan resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TaskPriority resources
  title: The collection of TaskPriority resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TaskStandardField resources
  title: The collection of TaskStandardField resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TaskStatus resources
  title: The collection of TaskStatus resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Translation resources
  title: The collection of Translation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectUserRole resources
  title: The collection of ProjectUserRole resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Role resources
  title: The collection of Role resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Company resources
  title: The collection of Company resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Country resources
  title: The collection of Country resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Form resources
  title: The collection of Form resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FieldOptionList resources
  title: The collection of FieldOptionList resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectForm resources
  title: The collection of ProjectForm resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Group resources
  title: The collection of Group resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of MediaObject resources
  title: The collection of MediaObject resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Plan resources
  title: The collection of Plan resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of PlanMediaObject resources
  title: The collection of PlanMediaObject resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Project resources
  title: The collection of Project resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Task resources
  title: The collection of Task resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Attachment resources
  title: The collection of Attachment resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Comment resources
  title: The collection of Comment resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of User resources
  title: The collection of User resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of Permission resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Permission
supported operation: Retrieves the collection of Permission resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Permission resources.
  returns: Collection

The collection of ProjectStatus resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectStatus
supported operation: Retrieves the collection of ProjectStatus resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectStatus resources.
  returns: Collection

The collection of Task Feed resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Task Feed
supported operation: Retrieves the collection of Task Feed resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Task Feed resources.
  returns: Collection

The collection of Task Plan resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Task Plan
supported operation: Retrieves the collection of Task Plan resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Task Plan resources.
  returns: Collection

The collection of TaskPriority resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TaskPriority
supported operation: Retrieves the collection of TaskPriority resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TaskPriority resources.
  returns: Collection

The collection of TaskStandardField resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TaskStandardField
supported operation: Retrieves the collection of TaskStandardField resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TaskStandardField resources.
  returns: Collection

The collection of TaskStatus resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TaskStatus
supported operation: Retrieves the collection of TaskStatus resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TaskStatus resources.
  returns: Collection

The collection of Translation resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Translation
supported operation: Retrieves the collection of Translation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Translation resources.
  returns: Collection

The collection of ProjectUserRole resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectUserRole
supported operation: Retrieves the collection of ProjectUserRole resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectUserRole resources.
  returns: Collection
supported operation: Creates a ProjectUserRole resource.
  type: Operation
  type: CreateAction
  expects: ProjectUserRole
  method: POST
  title: Creates a ProjectUserRole resource.
  returns: ProjectUserRole

The collection of Role resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Role
supported operation: Retrieves the collection of Role resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Role resources.
  returns: Collection
supported operation: Creates a Role resource.
  type: Operation
  type: CreateAction
  expects: Role
  method: POST
  title: Creates a Role resource.
  returns: Role

The collection of Company resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Company
supported operation: Retrieves the collection of Company resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Company resources.
  returns: Collection
supported operation: Retrieves the collection of Company resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Company resources.
  returns: Collection
supported operation: Creates a Company resource.
  type: Operation
  type: CreateAction
  expects: Company
  method: POST
  title: Creates a Company resource.
  returns: Company

The collection of Country resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Country
supported operation: Retrieves the collection of Country resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Country resources.
  returns: Collection
supported operation: Creates a Country resource.
  type: Operation
  type: CreateAction
  expects: Country
  method: POST
  title: Creates a Country resource.
  returns: Country
supported operation: Creates a Country resource.
  type: Operation
  type: CreateAction
  expects: Country
  method: POST
  title: Creates a Country resource.
  returns: Country

The collection of Form resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Form
supported operation: Retrieves the collection of Form resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Form resources.
  returns: Collection
supported operation: Creates a Form resource.
  type: Operation
  type: CreateAction
  expects: Form
  method: POST
  title: Creates a Form resource.
  returns: Form

The collection of FieldOptionList resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FieldOptionList
supported operation: Retrieves the collection of FieldOptionList resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FieldOptionList resources.
  returns: Collection
supported operation: Creates a FieldOptionList resource.
  type: Operation
  type: CreateAction
  expects: FieldOptionList
  method: POST
  title: Creates a FieldOptionList resource.
  returns: FieldOptionList

The collection of ProjectForm resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectForm
supported operation: Retrieves the collection of ProjectForm resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectForm resources.
  returns: Collection
supported operation: Creates a ProjectForm resource.
  type: Operation
  type: CreateAction
  expects: ProjectForm
  method: POST
  title: Creates a ProjectForm resource.
  returns: ProjectForm

The collection of Group resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Group
supported operation: Retrieves the collection of Group resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Group resources.
  returns: Collection
supported operation: Creates a Group resource.
  type: Operation
  type: CreateAction
  expects: Group
  method: POST
  title: Creates a Group resource.
  returns: Group

The collection of MediaObject resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: MediaObject
supported operation: Creates a MediaObject resource.
  type: Operation
  type: CreateAction
  expects: MediaObject
  method: POST
  title: Creates a MediaObject resource.
  returns: MediaObject

The collection of Plan resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Plan
supported operation: Retrieves the collection of Plan resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Plan resources.
  returns: Collection
supported operation: Creates a Plan resource.
  type: Operation
  type: CreateAction
  expects: Plan
  method: POST
  title: Creates a Plan resource.
  returns: Plan

The collection of PlanMediaObject resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PlanMediaObject
supported operation: Creates a PlanMediaObject resource.
  type: Operation
  type: CreateAction
  expects: PlanMediaObject
  method: POST
  title: Creates a PlanMediaObject resource.
  returns: PlanMediaObject

The collection of Project resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Project
supported operation: Retrieves the collection of Project resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Project resources.
  returns: Collection
supported operation: Creates a Project resource.
  type: Operation
  type: CreateAction
  expects: Project
  method: POST
  title: Creates a Project resource.
  returns: Project

The collection of Task resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Task
supported operation: Retrieves the collection of Task resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Task resources.
  returns: Collection
supported operation: Creates a Task resource.
  type: Operation
  type: CreateAction
  expects: Task
  method: POST
  title: Creates a Task resource.
  returns: Task

The collection of Attachment resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Attachment
supported operation: Creates a Attachment resource.
  type: Operation
  type: CreateAction
  expects: Attachment
  method: POST
  title: Creates a Attachment resource.
  returns: Attachment

The collection of Comment resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Comment
supported operation: Creates a Comment resource.
  type: Operation
  type: CreateAction
  expects: Comment
  method: POST
  title: Creates a Comment resource.
  returns: Comment

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

ConstraintViolation
type: Class
title: A constraint violation
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: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string