docs.jsonld
type: ApiDocumentation
title: OTYS Web API
description: The OTYS Web API allows you to interact with the OTYS platform programmatically. It provides endpoints for web-related resources, such as listing vacancies and handling job applications.
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: Ai
supported class: AnalyticsEvent
supported class: Auth
supported class: Configuration
supported class: File
supported class: Form
supported class: MatchCriteria
supported class: User
supported class: Vacancy
supported class: VacancyCategory
supported class: VacancyFilter
supported class: Website
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/description
  title: description
  required: false
  readable: true
  writeable: false
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/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.
sub class 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/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

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

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: false
  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
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
sub class 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
range: integer

Ai
type: Class
title: Ai
supported property: SupportedProperty
  property: Ai/tokens
  title: tokens
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Ai/tokenLimit
  title: tokenLimit
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Ai/tokensUsed
  title: tokensUsed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Ai/prompt
  title: prompt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Ai/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Ai/result
  title: result
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Ai resource.
  method: GET
  returns: Ai
  title: getAi

Ai/tokens
type: Property
domain: Ai
the hydra core vocabulary: tokens
range: integer

Ai/tokenLimit
type: Property
domain: Ai
the hydra core vocabulary: tokenLimit
range: integer

Ai/tokensUsed
type: Property
domain: Ai
the hydra core vocabulary: tokensUsed
range: integer

Ai/prompt
type: Property
domain: Ai
the hydra core vocabulary: prompt
range: string

Ai/source
type: Property
domain: Ai
the hydra core vocabulary: source
range: string

Ai/result
type: Property
domain: Ai
the hydra core vocabulary: result
range: string

AnalyticsEvent
type: Class
title: AnalyticsEvent
supported property: SupportedProperty
  property: AnalyticsEvent/action
  title: action
  required: true
  readable: true
  writeable: true
  description: The analytics action to perform. Allowed values: "view".
supported property: SupportedProperty
  property: AnalyticsEvent/resourceType
  title: resourceType
  required: true
  readable: true
  writeable: true
  description: The type of resource being tracked. Allowed values: "vacancy".
supported property: SupportedProperty
  property: AnalyticsEvent/resourceId
  title: resourceId
  required: false
  readable: true
  writeable: true
  description: The unique identifier of the resource being tracked.
supported property: SupportedProperty
  property: AnalyticsEvent/resourceSlug
  title: resourceSlug
  required: false
  readable: true
  writeable: true
  description: The slug of the resource being tracked (alternative to resourceId).
supported operation: Operation
  type: FindAction
  description: Retrieves a AnalyticsEvent resource.
  method: GET
  returns: owl:Nothing
  title: getAnalyticsEvent

AnalyticsEvent/action
type: Property
domain: AnalyticsEvent
the hydra core vocabulary: action

AnalyticsEvent/resourceType
type: Property
domain: AnalyticsEvent
the hydra core vocabulary: resourceType

AnalyticsEvent/resourceId
type: Property
domain: AnalyticsEvent
the hydra core vocabulary: resourceId
range: string

AnalyticsEvent/resourceSlug
type: Property
domain: AnalyticsEvent
the hydra core vocabulary: resourceSlug
range: string

Auth
type: Class
title: Auth
supported property: SupportedProperty
  property: Auth/accessToken
  title: accessToken
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Auth/tokenType
  title: tokenType
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Auth/expiresIn
  title: expiresIn
  required: false
  readable: false
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Auth resource.
  method: GET
  returns: owl:Nothing
  title: getAuth
description: Authentication operations

Auth/accessToken
type: Property
domain: Auth
the hydra core vocabulary: accessToken
range: string

Auth/tokenType
type: Property
domain: Auth
the hydra core vocabulary: tokenType
range: string

Auth/expiresIn
type: Property
domain: Auth
the hydra core vocabulary: expiresIn
range: integer

Configuration
type: Class
title: Configuration
supported property: SupportedProperty
  property: Configuration/clientId
  title: clientId
  required: false
  readable: true
  writeable: true
  description: The OTYS client ID.
supported property: SupportedProperty
  property: Configuration/clientCode
  title: clientCode
  required: false
  readable: true
  writeable: true
  description: The OTYS client code.
supported property: SupportedProperty
  property: Configuration/clientName
  title: clientName
  required: false
  readable: true
  writeable: true
  description: The OTYS client name.
supported property: SupportedProperty
  property: Configuration/prefix
  title: prefix
  required: false
  readable: true
  writeable: true
  description: The OTYS client prefix.
supported property: SupportedProperty
  property: Configuration/partnerId
  title: partnerId
  required: false
  readable: true
  writeable: true
  description: The OTYS partner ID.
supported property: SupportedProperty
  property: Configuration/defaultContentLanguage
  title: defaultContentLanguage
  required: false
  readable: true
  writeable: true
  description: The default content language for this client.
supported property: SupportedProperty
  property: Configuration/contentLanguages
  title: contentLanguages
  required: false
  readable: true
  writeable: true
  description: Available content languages for this client.
supported property: SupportedProperty
  property: Configuration/useVacancySlugs
  title: useVacancySlugs
  required: false
  readable: true
  writeable: true
  description: Whether custom vacancy URL slugs are enabled.
supported property: SupportedProperty
  property: Configuration/onRecruitEnabled
  title: onRecruitEnabled
  required: false
  readable: true
  writeable: true
  description: Whether the OnRecruit tracking integration is enabled.
supported property: SupportedProperty
  property: Configuration/gdprEnabled
  title: gdprEnabled
  required: false
  readable: true
  writeable: true
  description: Whether GDPR handling is globally enabled.
supported property: SupportedProperty
  property: Configuration/gdprEnabledApplication
  title: gdprEnabledApplication
  required: false
  readable: true
  writeable: true
  description: Whether GDPR handling is enabled for vacancy applications.
supported property: SupportedProperty
  property: Configuration/gdprEnabledOpenApplication
  title: gdprEnabledOpenApplication
  required: false
  readable: true
  writeable: true
  description: Whether GDPR handling is enabled for open/spontaneous applications.
supported property: SupportedProperty
  property: Configuration/gdprDeclinedDays
  title: gdprDeclinedDays
  required: false
  readable: true
  writeable: true
  description: Number of days until candidate data removal when GDPR is declined.
supported property: SupportedProperty
  property: Configuration/gdprAcceptedMonths
  title: gdprAcceptedMonths
  required: false
  readable: true
  writeable: true
  description: Number of months until candidate data removal when GDPR is accepted.
supported property: SupportedProperty
  property: Configuration/websites
  title: websites
  required: false
  readable: true
  writeable: true
  description: Available websites for this client, each with an id and name.
supported property: SupportedProperty
  property: Configuration/vacancyTextFields
  title: vacancyTextFields
  required: false
  readable: true
  writeable: true
  description: Vacancy text field definitions with their publish status.
supported operation: Operation
  type: FindAction
  description: Retrieves a Configuration resource.
  method: GET
  returns: Configuration
  title: getConfiguration

Configuration/clientId
type: Property
domain: Configuration
the hydra core vocabulary: clientId
range: integer

Configuration/clientCode
type: Property
domain: Configuration
the hydra core vocabulary: clientCode
range: string

Configuration/clientName
type: Property
domain: Configuration
the hydra core vocabulary: clientName
range: string

Configuration/prefix
type: Property
domain: Configuration
the hydra core vocabulary: prefix
range: string

Configuration/partnerId
type: Property
domain: Configuration
the hydra core vocabulary: partnerId
range: string

Configuration/defaultContentLanguage
type: Property
domain: Configuration
the hydra core vocabulary: defaultContentLanguage
range: string

Configuration/contentLanguages
type: Property
domain: Configuration
the hydra core vocabulary: contentLanguages
range: string

Configuration/useVacancySlugs
type: Property
domain: Configuration
the hydra core vocabulary: useVacancySlugs
range: boolean

Configuration/onRecruitEnabled
type: Property
domain: Configuration
the hydra core vocabulary: onRecruitEnabled
range: boolean

Configuration/gdprEnabled
type: Property
domain: Configuration
the hydra core vocabulary: gdprEnabled
range: boolean

Configuration/gdprEnabledApplication
type: Property
domain: Configuration
the hydra core vocabulary: gdprEnabledApplication
range: boolean

Configuration/gdprEnabledOpenApplication
type: Property
domain: Configuration
the hydra core vocabulary: gdprEnabledOpenApplication
range: boolean

Configuration/gdprDeclinedDays
type: Property
domain: Configuration
the hydra core vocabulary: gdprDeclinedDays
range: integer

Configuration/gdprAcceptedMonths
type: Property
domain: Configuration
the hydra core vocabulary: gdprAcceptedMonths
range: integer

Configuration/websites
type: Property
domain: Configuration
the hydra core vocabulary: websites

Configuration/vacancyTextFields
type: Property
domain: Configuration
the hydra core vocabulary: vacancyTextFields

File
type: Class
title: File
supported property: SupportedProperty
  property: File/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/mimeType
  title: mimeType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: File/size
  title: size
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a File resource.
  method: GET
  returns: owl:Nothing
  title: getFile
description: Represents a file resource that can be uploaded and managed via the API.

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

File/name
type: Property
domain: File
the hydra core vocabulary: name
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

Form
type: Class
title: Form
supported property: SupportedProperty
  property: Form/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Form/title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Form/pages
  title: pages
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Form/metaData
  title: metaData
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Form/answers
  title: answers
  required: false
  readable: true
  writeable: true
  description: Key value pair of questioId and answer
supported property: SupportedProperty
  property: Form/fileQuestions
  title: fileQuestions
  required: false
  readable: true
  writeable: false
  description: Get all file questions in the form
supported operation: Operation
  type: FindAction
  description: Retrieves a Form resource.
  method: GET
  returns: Form
  title: getForm
supported operation: Operation
  type: FindAction
  description: Retrieves a Form resource.
  method: GET
  returns: Form
  title: getForm
supported operation: Operation
  type: FindAction
  description: Retrieves a Form resource.
  method: GET
  returns: Form
  title: getForm
description: Form resources are a structural way to handle different types of form in a uniform manner.

Form/id
type: Property
domain: Form
the hydra core vocabulary: id
range: integer

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

Form/pages
type: Property
domain: Form
the hydra core vocabulary: pages

Form/metaData
type: Property
domain: Form
the hydra core vocabulary: metaData

Form/answers
type: Property
domain: Form
the hydra core vocabulary: answers
range: string

Form/fileQuestions
type: Property
domain: Form
the hydra core vocabulary: fileQuestions

MatchCriteria
type: Class
title: MatchCriteria
supported property: SupportedProperty
  property: MatchCriteria/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: MatchCriteria/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: MatchCriteria/options
  title: options
  required: false
  readable: true
  writeable: true
  description: Summary of options
supported operation: Operation
  type: FindAction
  description: Retrieves a MatchCriteria resource.
  method: GET
  returns: MatchCriteria
  title: getMatchCriteria

MatchCriteria/id
type: Property
domain: MatchCriteria
the hydra core vocabulary: id
range: integer

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

MatchCriteria/options
type: Property
domain: MatchCriteria
the hydra core vocabulary: options

User
type: Class
title: User
supported property: SupportedProperty
  property: User/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/infix
  title: infix
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/jobTitle
  title: jobTitle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/linkedIn
  title: linkedIn
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/gender
  title: gender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/profilePicture
  title: profilePicture
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/phoneNumbers
  title: phoneNumbers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/fullName
  title: fullName
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a User resource.
  method: GET
  returns: User
  title: getUser
description: User resource representing an OTYS system user.

User/id
type: Property
domain: User
the hydra core vocabulary: id
range: integer

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

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

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

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

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

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

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

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

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

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

Vacancy
type: Class
title: Vacancy
supported property: SupportedProperty
  property: Vacancy/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/location
  title: location
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/slug
  title: slug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/customApplyUrl
  title: customApplyUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/schemaJobPosting
  title: schemaJobPosting
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/alternateLinks
  title: alternateLinks
  required: false
  readable: true
  writeable: true
  description: Language code to URL mapping
supported property: SupportedProperty
  property: Vacancy/video
  title: video
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/lastModified
  title: lastModified
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/entryDateTime
  title: entryDateTime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/published
  title: published
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/publishedLanguages
  title: publishedLanguages
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/removeApplyButton
  title: removeApplyButton
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/showEmployer
  title: showEmployer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Vacancy/matchCriteria
  title: matchCriteria
  required: false
  readable: true
  writeable: true
  description: Match criteria
supported property: SupportedProperty
  property: Vacancy/categories
  title: categories
  required: false
  readable: true
  writeable: true
  description: Categories
supported property: SupportedProperty
  property: Vacancy/user
  title: user
  required: false
  readable: true
  writeable: true
  description: User
supported property: SupportedProperty
  property: Vacancy/relation
  title: relation
  required: false
  readable: true
  writeable: true
  description: Relation
supported property: SupportedProperty
  property: Vacancy/textfields
  title: textfields
  required: false
  readable: true
  writeable: true
  description: Textfields
supported property: SupportedProperty
  property: Vacancy/mainImage
  title: mainImage
  required: false
  readable: true
  writeable: true
  description: Main image
supported property: SupportedProperty
  property: Vacancy/gallery
  title: gallery
  required: false
  readable: true
  writeable: true
  description: Gallery
supported property: SupportedProperty
  property: Vacancy/longitude
  title: longitude
  required: false
  readable: true
  writeable: true
  description: Longitude
supported property: SupportedProperty
  property: Vacancy/latitude
  title: latitude
  required: false
  readable: true
  writeable: true
  description: Latitude
supported property: SupportedProperty
  property: Vacancy/salary
  title: salary
  required: false
  readable: true
  writeable: true
  description: Salary
supported operation: Operation
  type: FindAction
  description: Retrieves a Vacancy resource.
  method: GET
  returns: Vacancy
  title: getVacancy
supported operation: Operation
  type: FindAction
  description: Retrieves a Vacancy resource.
  method: GET
  returns: Vacancy
  title: getVacancy

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

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

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

Vacancy/slug
type: Property
domain: Vacancy
the hydra core vocabulary: slug
range: string

Vacancy/customApplyUrl
type: Property
domain: Vacancy
the hydra core vocabulary: customApplyUrl
range: string

Vacancy/schemaJobPosting
type: Property
domain: Vacancy
the hydra core vocabulary: schemaJobPosting
range: string

Vacancy/alternateLinks
type: Property
domain: Vacancy
the hydra core vocabulary: alternateLinks
range: string

Vacancy/video
type: Property
domain: Vacancy
the hydra core vocabulary: video
range: string

Vacancy/lastModified
type: Property
domain: Vacancy
the hydra core vocabulary: lastModified
range: dateTime

Vacancy/entryDateTime
type: Property
domain: Vacancy
the hydra core vocabulary: entryDateTime
range: dateTime

Vacancy/published
type: Property
domain: Vacancy
the hydra core vocabulary: published
range: boolean

Vacancy/publishedLanguages
type: Property
domain: Vacancy
the hydra core vocabulary: publishedLanguages

Vacancy/removeApplyButton
type: Property
domain: Vacancy
the hydra core vocabulary: removeApplyButton
range: boolean

Vacancy/showEmployer
type: Property
domain: Vacancy
the hydra core vocabulary: showEmployer
range: boolean

Vacancy/matchCriteria
type: Link
domain: Vacancy
the hydra core vocabulary: matchCriteria
range: MatchCriteria

Vacancy/categories
type: Link
domain: Vacancy
the hydra core vocabulary: categories
range: VacancyCategory

Vacancy/user
type: Link
domain: Vacancy
the hydra core vocabulary: user
max cardinality: 1
range: User

Vacancy/relation
type: Property
domain: Vacancy
the hydra core vocabulary: relation

Vacancy/textfields
type: Property
domain: Vacancy
the hydra core vocabulary: textfields

Vacancy/mainImage
type: Property
domain: Vacancy
the hydra core vocabulary: mainImage

Vacancy/gallery
type: Property
domain: Vacancy
the hydra core vocabulary: gallery

Vacancy/longitude
type: Property
domain: Vacancy
the hydra core vocabulary: longitude
range: decimal

Vacancy/latitude
type: Property
domain: Vacancy
the hydra core vocabulary: latitude
range: decimal

Vacancy/salary
type: Property
domain: Vacancy
the hydra core vocabulary: salary

VacancyCategory
type: Class
title: VacancyCategory
supported property: SupportedProperty
  property: VacancyCategory/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: VacancyCategory/name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a VacancyCategory resource.
  method: GET
  returns: owl:Nothing
  title: getVacancyCategory
description: Vacancy Category resource representing categories for vacancies.

VacancyCategory/id
type: Property
domain: VacancyCategory
the hydra core vocabulary: id
range: integer

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

VacancyFilter
type: Class
title: VacancyFilter
supported property: SupportedProperty
  property: VacancyFilter/param
  title: param
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: VacancyFilter/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: VacancyFilter/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: VacancyFilter/options
  title: options
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a VacancyFilter resource.
  method: GET
  returns: owl:Nothing
  title: getVacancyFilter
description: Vacancy filter metadata endpoint. This resource returns available MatchCriteria / Category options and their frequencies for the same active search context as GET /vacancies when the same query parameters are supplied.

VacancyFilter/param
type: Property
domain: VacancyFilter
the hydra core vocabulary: param
range: string

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

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

VacancyFilter/options
type: Property
domain: VacancyFilter
the hydra core vocabulary: options

Website
type: Class
title: Website
supported property: SupportedProperty
  property: Website/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Website/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Website/hostedPageUrl
  title: hostedPageUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Website/externalApplyUrlFormat
  title: externalApplyUrlFormat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Website/externalVacancyDetailUrlFormat
  title: externalVacancyDetailUrlFormat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Website/externalVacancyPreviewUrlFormat
  title: externalVacancyPreviewUrlFormat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Website/externalUrl
  title: externalUrl
  required: false
  readable: true
  writeable: true
  description: The external url format in OTYS - CSM GE333
supported property: SupportedProperty
  property: Website/webhookUrl
  title: webhookUrl
  required: false
  readable: true
  writeable: true
  description: Please provide a valid URL for the webhook. Whenever a change occurs in OTYS, a POST request will be sent to this URL with contextual data.
supported property: SupportedProperty
  property: Website/enrollAdminEmail
  title: enrollAdminEmail
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Website resource.
  method: GET
  returns: Website
  title: getWebsite
supported operation: Operation
  description: Updates the Website resource.
  expects: Website
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Website
  title: patchWebsite
supported operation: Operation
  type: DeleteAction
  description: Deletes the Website resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteWebsite
description: Operations related to the Website resource in the OTYS system.

Website/id
type: Property
domain: Website
the hydra core vocabulary: id
range: integer

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

Website/hostedPageUrl
type: Property
domain: Website
the hydra core vocabulary: hostedPageUrl
range: string

Website/externalApplyUrlFormat
type: Property
domain: Website
the hydra core vocabulary: externalApplyUrlFormat
range: string

Website/externalVacancyDetailUrlFormat
type: Property
domain: Website
the hydra core vocabulary: externalVacancyDetailUrlFormat
range: string

Website/externalVacancyPreviewUrlFormat
type: Property
domain: Website
the hydra core vocabulary: externalVacancyPreviewUrlFormat
range: string

Website/externalUrl
type: Property
domain: Website
the hydra core vocabulary: externalUrl
range: string

Website/webhookUrl
type: Property
domain: Website
the hydra core vocabulary: webhookUrl
range: string

Website/enrollAdminEmail
type: Property
domain: Website
the hydra core vocabulary: enrollAdminEmail
range: string

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/ai
  title: getAiCollection
  description: The collection of Ai resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/analyticsEvent
  title: getAnalyticsEventCollection
  description: The collection of AnalyticsEvent resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/auth
  title: getAuthCollection
  description: The collection of Auth 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/form
  title: getFormCollection
  description: The collection of Form resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/matchCriteria
  title: getMatchCriteriaCollection
  description: The collection of MatchCriteria 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/vacancy
  title: getVacancyCollection
  description: The collection of Vacancy resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/vacancyCategory
  title: getVacancyCategoryCollection
  description: The collection of VacancyCategory resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/vacancyFilter
  title: getVacancyFilterCollection
  description: The collection of VacancyFilter resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/website
  title: getWebsiteCollection
  description: The collection of Website resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

Entrypoint/ai
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Ai
supported operation: Operation
  type: CreateAction
  description: Creates a Ai resource.
  expects: Ai
  method: POST
  returns: Ai
  title: postAi
supported operation: Operation
  type: CreateAction
  description: Creates a Ai resource.
  expects: Ai
  method: POST
  returns: Ai
  title: postAi

Entrypoint/analyticsEvent
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: AnalyticsEvent
supported operation: Operation
  type: CreateAction
  description: Creates a AnalyticsEvent resource.
  expects: AnalyticsEvent
  method: POST
  returns: owl:Nothing
  title: postAnalyticsEvent

Entrypoint/auth
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Auth
supported operation: Operation
  type: CreateAction
  description: Creates a Auth resource.
  expects: Auth
  method: POST
  returns: Auth
  title: postAuth

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: CreateAction
  description: Creates a File resource.
  expects: File
  method: POST
  returns: File
  title: postFile

Entrypoint/form
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Form
supported operation: Operation
  type: CreateAction
  description: Creates a Form resource.
  expects: Form
  method: POST
  returns: Form
  title: postForm
supported operation: Operation
  type: CreateAction
  description: Creates a Form resource.
  expects: Form
  method: POST
  returns: Form
  title: postForm
supported operation: Operation
  type: CreateAction
  description: Creates a Form resource.
  expects: Form
  method: POST
  returns: Form
  title: postForm

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

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: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  returns: Collection
  title: getUserCollection

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

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

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

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

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

ConstraintViolationList/propertyPath
type: Property
label: propertyPath
domain: ConstraintViolationList
range: string

ConstraintViolationList/message
type: Property
label: message
domain: ConstraintViolationList
range: string