Авторизация
Authorization: Candidate <HALLIFY_CANDIDATE_PORTAL_TOKEN>Ключ кабинета кандидата в формате Candidate <token>.
Параметры
offerIdПуть · ОбязательноUUID Hallify. До чтения или изменения ресурса проверяется его принадлежность всем родительским арендаторам и агрегатам маршрута.
string · uuidПолное определение
{ "type": "string", "format": "uuid", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }
Тело запроса
Обязательно
По токену кандидата принимает или отклоняет только своё активное предложение, указанное в маршруте.
application/json
Полное определение
{
"$ref": "#/components/schemas/CandidateOfferResponseDto"
}Ответы
200Представление своей заявки после записи ответа на предложение: итоговый этап и текущая ревизия.
Полное определение
{
"$ref": "#/components/schemas/CandidatePortalApplicationDto"
}{
"id": "0120f0fe-6880-47e8-895d-c092d269cdd1",
"requisitionTitle": "Example title",
"currentStage": {
"id": "f97fe865-5ff8-488a-8fab-9e27e748514c",
"code": "EXAMPLE",
"name": "Example name",
"category": "APPLIED",
"isTerminal": true,
"sortOrder": 1,
"revision": 1
},
"status": "ACTIVE",
"appliedAt": "2026-01-15T12:00:00.000Z",
"updatedAt": "2026-01-15T13:00:00.000Z",
"revision": 1,
"canWithdraw": true
}401Отклоняет отсутствующий, некорректный, истёкший, отозванный или недействительный ключ candidatePortalToken на границе владеющего домена.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}Схемы
CandidateOfferResponseDto
По токену кандидата принимает или отклоняет только своё активное предложение, указанное в маршруте.
expectedRevisionОбязательноТекущая целочисленная ревизия
expectedRevision, прочитанная вызывающей стороной; устаревшее значение приводит к отклонению изменения. Ограничения: минимум 1.integerПолное определение
{ "type": "integer", "minimum": 1, "description": "Текущая целочисленная ревизия `expectedRevision`, прочитанная вызывающей стороной; устаревшее значение приводит к отклонению изменения. Ограничения: минимум 1.", "example": 1 }commandKeyОбязательноUUID Hallify для
commandKey.string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "UUID Hallify для `commandKey`.", "example": "144a3af2-662b-401d-8893-0abf596c5088" }responseОбязательноДопустимые значения
response: ACCEPT, DECLINE.stringПолное определение
{ "type": "string", "enum": [ "ACCEPT", "DECLINE" ], "description": "Допустимые значения `response`: ACCEPT, DECLINE.", "example": "ACCEPT" }reasonНеобязательноПричина
reason, введённая человеком и сохранённая как обоснование решения или свидетельство аудита. Ограничения: максимальная длина 500.stringПолное определение
{ "type": "string", "maxLength": 500, "description": "Причина `reason`, введённая человеком и сохранённая как обоснование решения или свидетельство аудита. Ограничения: максимальная длина 500.", "example": "Synthetic example" }
Полное определение
{
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "Текущая целочисленная ревизия `expectedRevision`, прочитанная вызывающей стороной; устаревшее значение приводит к отклонению изменения. Ограничения: минимум 1.",
"example": 1
},
"commandKey": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `commandKey`.",
"example": "144a3af2-662b-401d-8893-0abf596c5088"
},
"response": {
"type": "string",
"enum": [
"ACCEPT",
"DECLINE"
],
"description": "Допустимые значения `response`: ACCEPT, DECLINE.",
"example": "ACCEPT"
},
"reason": {
"type": "string",
"maxLength": 500,
"description": "Причина `reason`, введённая человеком и сохранённая как обоснование решения или свидетельство аудита. Ограничения: максимальная длина 500.",
"example": "Synthetic example"
}
},
"required": [
"expectedRevision",
"commandKey",
"response"
],
"description": "По токену кандидата принимает или отклоняет только своё активное предложение, указанное в маршруте.",
"example": {
"expectedRevision": 1,
"commandKey": "144a3af2-662b-401d-8893-0abf596c5088",
"response": "ACCEPT"
}
}CandidatePortalApplicationDto
Своя заявка в конечном состоянии отзыва с обновлённой ревизией и сохранёнными материалами подачи.
idОбязательноUUID Hallify для
id.string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "UUID Hallify для `id`.", "example": "0120f0fe-6880-47e8-895d-c092d269cdd1" }requisitionTitleОбязательноНазвание заявки на подбор
requisitionTitle.stringПолное определение
{ "type": "string", "description": "Название заявки на подбор `requisitionTitle`.", "example": "Example title" }currentStageОбязательноЭтап подбора, вложенный в поле currentStage заявки кандидата.
allOfПолное определение
{ "allOf": [ { "$ref": "#/components/schemas/RecruitingStageDto" } ], "description": "Этап подбора, вложенный в поле currentStage заявки кандидата.", "example": { "id": "f97fe865-5ff8-488a-8fab-9e27e748514c", "code": "EXAMPLE", "name": "Example name", "category": "APPLIED", "isTerminal": true, "sortOrder": 1, "revision": 1 } }statusОбязательноТекущий статус жизненного цикла
status; допустимые значения: ACTIVE, OFFERED, HIRED, REJECTED, WITHDRAWN.stringПолное определение
{ "type": "string", "enum": [ "ACTIVE", "OFFERED", "HIRED", "REJECTED", "WITHDRAWN" ], "description": "Текущий статус жизненного цикла `status`; допустимые значения: ACTIVE, OFFERED, HIRED, REJECTED, WITHDRAWN.", "example": "ACTIVE" }appliedAtОбязательноВремя события
appliedAt.string · date-timeПолное определение
{ "type": "string", "description": "Время события `appliedAt`.", "format": "date-time", "example": "2026-01-15T12:00:00.000Z" }updatedAtОбязательноВремя события
updatedAt.string · date-timeПолное определение
{ "type": "string", "description": "Время события `updatedAt`.", "format": "date-time", "example": "2026-01-15T13:00:00.000Z" }revisionОбязательноМонотонно возрастающая ревизия
revisionдля оптимистичного контроля конкурентных изменений.integerПолное определение
{ "type": "integer", "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.", "example": 1 }offerНеобязательноВложенные сведения
offer. Null означает отсутствие записанного значения в этом представлении.object · nullПолное определение
{ "nullable": true, "type": "object", "description": "Вложенные сведения `offer`. Null означает отсутствие записанного значения в этом представлении.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID Hallify для `id`.", "example": "dfa73755-b161-462c-87aa-7f0d20d8a424" }, "status": { "type": "string", "enum": [ "DRAFT", "SENT", "ACCEPTED", "DECLINED", "EXPIRED", "WITHDRAWN", "CONVERTED" ], "description": "Текущий статус жизненного цикла `status`; допустимые значения: DRAFT, SENT, ACCEPTED, DECLINED, EXPIRED, WITHDRAWN, CONVERTED.", "example": "DRAFT" }, "legalEntity": { "allOf": [ { "$ref": "#/components/schemas/RecruitingReferenceItemDto" } ], "description": "Справочный элемент подбора, вложенный в поле legalEntity предложения кандидату.", "example": { "id": "ba0372fd-c434-407b-8ec5-0634b02050cc", "name": "Example name" } }, "venue": { "allOf": [ { "$ref": "#/components/schemas/RecruitingReferenceItemDto" } ], "description": "Справочный элемент подбора, вложенный в поле venue предложения кандидату.", "example": { "id": "ba0372fd-c434-407b-8ec5-0634b02050cc", "name": "Example name" } }, "department": { "nullable": true, "type": "object", "description": "Вложенные сведения `department`. Null означает отсутствие записанного значения в этом представлении.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID Hallify для `id`.", "example": "e6112f96-9ef5-48fb-82cf-4187a8ce329c" }, "name": { "type": "string", "description": "Понятное человеку значение `name`.", "example": "Example name" }, "code": { "type": "string", "nullable": true, "description": "Стабильный код `code` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.", "example": "EXAMPLE" } }, "required": [ "id", "name" ], "example": { "id": "e6112f96-9ef5-48fb-82cf-4187a8ce329c", "name": "Example name" } }, "jobProfile": { "nullable": true, "type": "object", "description": "Вложенные сведения `jobProfile`. Null означает отсутствие записанного значения в этом представлении.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID Hallify для `id`.", "example": "66c21fb4-4f9b-4f13-817d-088bf2bee5ca" }, "name": { "type": "string", "description": "Понятное человеку значение `name`.", "example": "Example name" }, "code": { "type": "string", "nullable": true, "description": "Стабильный код `code` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.", "example": "EXAMPLE" } }, "required": [ "id", "name" ], "example": { "id": "66c21fb4-4f9b-4f13-817d-088bf2bee5ca", "name": "Example name" } }, "classification": { "type": "string", "enum": [ "EMPLOYEE", "CONTRACTOR", "INTERN", "APPRENTICE" ], "description": "Допустимые значения `classification`: EMPLOYEE, CONTRACTOR, INTERN, APPRENTICE.", "example": "EMPLOYEE" }, "contractType": { "type": "string", "enum": [ "FULL_TIME", "PART_TIME", "FIXED_TERM", "CASUAL", "SEASONAL", "ON_CALL" ], "description": "Допустимые значения `contractType`: FULL_TIME, PART_TIME, FIXED_TERM, CASUAL, SEASONAL, ON_CALL.", "example": "FULL_TIME" }, "startDate": { "type": "string", "description": "Календарная дата `startDate` в формате ISO 8601 YYYY-MM-DD без подразумеваемого времени суток.", "format": "date", "example": "2026-01-15" }, "compensationAmount": { "type": "string", "nullable": true, "description": "Десятичная денежная величина `compensationAmount`, сериализованная строкой в валюте поля `compensationCurrency`. Ноль означает записанную сумму, а не отсутствие значения. Null означает отсутствие записанного значения в этом представлении.", "example": "1.00" }, "compensationCurrency": { "type": "string", "nullable": true, "description": "Код валюты ISO 4217 в `compensationCurrency` для денежных значений этого представления. Null означает отсутствие записанного значения в этом представлении.", "example": "GEL" }, "compensationPeriod": { "type": "string", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "ANNUAL", null ], "nullable": true, "description": "Допустимые значения `compensationPeriod`: HOURLY, DAILY, WEEKLY, MONTHLY, ANNUAL. Null означает отсутствие записанного значения в этом представлении.", "example": "HOURLY" }, "terms": { "type": "string", "description": "Условия `terms`.", "example": "example" }, "expiresAt": { "type": "string", "nullable": true, "description": "Время события `expiresAt`. Null означает отсутствие записанного значения в этом представлении.", "format": "date-time", "example": "2026-12-31T18:00:00.000Z" }, "revision": { "type": "integer", "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.", "example": 1 }, "canRespond": { "type": "boolean", "description": "Может ли вызывающая сторона ответить на предложение кандидату.", "example": true } }, "required": [ "id", "status", "legalEntity", "venue", "classification", "contractType", "startDate", "terms", "revision", "canRespond" ], "example": { "id": "dfa73755-b161-462c-87aa-7f0d20d8a424", "status": "DRAFT", "legalEntity": { "id": "ba0372fd-c434-407b-8ec5-0634b02050cc", "name": "Example name" }, "venue": { "id": "ba0372fd-c434-407b-8ec5-0634b02050cc", "name": "Example name" }, "classification": "EMPLOYEE", "contractType": "FULL_TIME", "startDate": "2026-01-15", "terms": "example", "revision": 1, "canRespond": true } }canWithdrawОбязательноМожет ли вызывающая сторона отозвать заявку кандидата.
booleanПолное определение
{ "type": "boolean", "description": "Может ли вызывающая сторона отозвать заявку кандидата.", "example": true }
Полное определение
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `id`.",
"example": "0120f0fe-6880-47e8-895d-c092d269cdd1"
},
"requisitionTitle": {
"type": "string",
"description": "Название заявки на подбор `requisitionTitle`.",
"example": "Example title"
},
"currentStage": {
"allOf": [
{
"$ref": "#/components/schemas/RecruitingStageDto"
}
],
"description": "Этап подбора, вложенный в поле currentStage заявки кандидата.",
"example": {
"id": "f97fe865-5ff8-488a-8fab-9e27e748514c",
"code": "EXAMPLE",
"name": "Example name",
"category": "APPLIED",
"isTerminal": true,
"sortOrder": 1,
"revision": 1
}
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"OFFERED",
"HIRED",
"REJECTED",
"WITHDRAWN"
],
"description": "Текущий статус жизненного цикла `status`; допустимые значения: ACTIVE, OFFERED, HIRED, REJECTED, WITHDRAWN.",
"example": "ACTIVE"
},
"appliedAt": {
"type": "string",
"description": "Время события `appliedAt`.",
"format": "date-time",
"example": "2026-01-15T12:00:00.000Z"
},
"updatedAt": {
"type": "string",
"description": "Время события `updatedAt`.",
"format": "date-time",
"example": "2026-01-15T13:00:00.000Z"
},
"revision": {
"type": "integer",
"description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
"example": 1
},
"offer": {
"nullable": true,
"type": "object",
"description": "Вложенные сведения `offer`. Null означает отсутствие записанного значения в этом представлении.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `id`.",
"example": "dfa73755-b161-462c-87aa-7f0d20d8a424"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"SENT",
"ACCEPTED",
"DECLINED",
"EXPIRED",
"WITHDRAWN",
"CONVERTED"
],
"description": "Текущий статус жизненного цикла `status`; допустимые значения: DRAFT, SENT, ACCEPTED, DECLINED, EXPIRED, WITHDRAWN, CONVERTED.",
"example": "DRAFT"
},
"legalEntity": {
"allOf": [
{
"$ref": "#/components/schemas/RecruitingReferenceItemDto"
}
],
"description": "Справочный элемент подбора, вложенный в поле legalEntity предложения кандидату.",
"example": {
"id": "ba0372fd-c434-407b-8ec5-0634b02050cc",
"name": "Example name"
}
},
"venue": {
"allOf": [
{
"$ref": "#/components/schemas/RecruitingReferenceItemDto"
}
],
"description": "Справочный элемент подбора, вложенный в поле venue предложения кандидату.",
"example": {
"id": "ba0372fd-c434-407b-8ec5-0634b02050cc",
"name": "Example name"
}
},
"department": {
"nullable": true,
"type": "object",
"description": "Вложенные сведения `department`. Null означает отсутствие записанного значения в этом представлении.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `id`.",
"example": "e6112f96-9ef5-48fb-82cf-4187a8ce329c"
},
"name": {
"type": "string",
"description": "Понятное человеку значение `name`.",
"example": "Example name"
},
"code": {
"type": "string",
"nullable": true,
"description": "Стабильный код `code` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.",
"example": "EXAMPLE"
}
},
"required": [
"id",
"name"
],
"example": {
"id": "e6112f96-9ef5-48fb-82cf-4187a8ce329c",
"name": "Example name"
}
},
"jobProfile": {
"nullable": true,
"type": "object",
"description": "Вложенные сведения `jobProfile`. Null означает отсутствие записанного значения в этом представлении.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `id`.",
"example": "66c21fb4-4f9b-4f13-817d-088bf2bee5ca"
},
"name": {
"type": "string",
"description": "Понятное человеку значение `name`.",
"example": "Example name"
},
"code": {
"type": "string",
"nullable": true,
"description": "Стабильный код `code` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.",
"example": "EXAMPLE"
}
},
"required": [
"id",
"name"
],
"example": {
"id": "66c21fb4-4f9b-4f13-817d-088bf2bee5ca",
"name": "Example name"
}
},
"classification": {
"type": "string",
"enum": [
"EMPLOYEE",
"CONTRACTOR",
"INTERN",
"APPRENTICE"
],
"description": "Допустимые значения `classification`: EMPLOYEE, CONTRACTOR, INTERN, APPRENTICE.",
"example": "EMPLOYEE"
},
"contractType": {
"type": "string",
"enum": [
"FULL_TIME",
"PART_TIME",
"FIXED_TERM",
"CASUAL",
"SEASONAL",
"ON_CALL"
],
"description": "Допустимые значения `contractType`: FULL_TIME, PART_TIME, FIXED_TERM, CASUAL, SEASONAL, ON_CALL.",
"example": "FULL_TIME"
},
"startDate": {
"type": "string",
"description": "Календарная дата `startDate` в формате ISO 8601 YYYY-MM-DD без подразумеваемого времени суток.",
"format": "date",
"example": "2026-01-15"
},
"compensationAmount": {
"type": "string",
"nullable": true,
"description": "Десятичная денежная величина `compensationAmount`, сериализованная строкой в валюте поля `compensationCurrency`. Ноль означает записанную сумму, а не отсутствие значения. Null означает отсутствие записанного значения в этом представлении.",
"example": "1.00"
},
"compensationCurrency": {
"type": "string",
"nullable": true,
"description": "Код валюты ISO 4217 в `compensationCurrency` для денежных значений этого представления. Null означает отсутствие записанного значения в этом представлении.",
"example": "GEL"
},
"compensationPeriod": {
"type": "string",
"enum": [
"HOURLY",
"DAILY",
"WEEKLY",
"MONTHLY",
"ANNUAL",
null
],
"nullable": true,
"description": "Допустимые значения `compensationPeriod`: HOURLY, DAILY, WEEKLY, MONTHLY, ANNUAL. Null означает отсутствие записанного значения в этом представлении.",
"example": "HOURLY"
},
"terms": {
"type": "string",
"description": "Условия `terms`.",
"example": "example"
},
"expiresAt": {
"type": "string",
"nullable": true,
"description": "Время события `expiresAt`. Null означает отсутствие записанного значения в этом представлении.",
"format": "date-time",
"example": "2026-12-31T18:00:00.000Z"
},
"revision": {
"type": "integer",
"description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
"example": 1
},
"canRespond": {
"type": "boolean",
"description": "Может ли вызывающая сторона ответить на предложение кандидату.",
"example": true
}
},
"required": [
"id",
"status",
"legalEntity",
"venue",
"classification",
"contractType",
"startDate",
"terms",
"revision",
"canRespond"
],
"example": {
"id": "dfa73755-b161-462c-87aa-7f0d20d8a424",
"status": "DRAFT",
"legalEntity": {
"id": "ba0372fd-c434-407b-8ec5-0634b02050cc",
"name": "Example name"
},
"venue": {
"id": "ba0372fd-c434-407b-8ec5-0634b02050cc",
"name": "Example name"
},
"classification": "EMPLOYEE",
"contractType": "FULL_TIME",
"startDate": "2026-01-15",
"terms": "example",
"revision": 1,
"canRespond": true
}
},
"canWithdraw": {
"type": "boolean",
"description": "Может ли вызывающая сторона отозвать заявку кандидата.",
"example": true
}
},
"required": [
"id",
"requisitionTitle",
"currentStage",
"status",
"appliedAt",
"updatedAt",
"revision",
"canWithdraw"
],
"description": "Своя заявка в конечном состоянии отзыва с обновлённой ревизией и сохранёнными материалами подачи.",
"example": {
"id": "0120f0fe-6880-47e8-895d-c092d269cdd1",
"requisitionTitle": "Example title",
"currentStage": {
"id": "f97fe865-5ff8-488a-8fab-9e27e748514c",
"code": "EXAMPLE",
"name": "Example name",
"category": "APPLIED",
"isTerminal": true,
"sortOrder": 1,
"revision": 1
},
"status": "ACTIVE",
"appliedAt": "2026-01-15T12:00:00.000Z",
"updatedAt": "2026-01-15T13:00:00.000Z",
"revision": 1,
"canWithdraw": true
}
}RecruitingStageDto
Упорядоченный этап процесса подбора с категорией и правилами конечного состояния.
idОбязательноUUID Hallify для
id.string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "UUID Hallify для `id`.", "example": "f97fe865-5ff8-488a-8fab-9e27e748514c" }codeОбязательноСтабильный код
codeдля классификации или идентификации.stringПолное определение
{ "type": "string", "description": "Стабильный код `code` для классификации или идентификации.", "example": "EXAMPLE" }nameОбязательноПонятное человеку значение
name.stringПолное определение
{ "type": "string", "description": "Понятное человеку значение `name`.", "example": "Example name" }categoryОбязательноДопустимые значения
category: APPLIED, SCREENING, INTERVIEW, ASSESSMENT, OFFER, HIRED, REJECTED, WITHDRAWN.stringПолное определение
{ "type": "string", "enum": [ "APPLIED", "SCREENING", "INTERVIEW", "ASSESSMENT", "OFFER", "HIRED", "REJECTED", "WITHDRAWN" ], "description": "Допустимые значения `category`: APPLIED, SCREENING, INTERVIEW, ASSESSMENT, OFFER, HIRED, REJECTED, WITHDRAWN.", "example": "APPLIED" }isTerminalОбязательноTrue, если этап подбора конечный и кандидат не переходит с него дальше автоматически.
booleanПолное определение
{ "type": "boolean", "description": "True, если этап подбора конечный и кандидат не переходит с него дальше автоматически.", "example": true }sortOrderОбязательноЦелочисленная позиция сортировки
sortOrder; меньшие значения идут первыми.integerПолное определение
{ "type": "integer", "description": "Целочисленная позиция сортировки `sortOrder`; меньшие значения идут первыми.", "example": 1 }revisionОбязательноМонотонно возрастающая ревизия
revisionдля оптимистичного контроля конкурентных изменений.integerПолное определение
{ "type": "integer", "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.", "example": 1 }
Полное определение
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `id`.",
"example": "f97fe865-5ff8-488a-8fab-9e27e748514c"
},
"code": {
"type": "string",
"description": "Стабильный код `code` для классификации или идентификации.",
"example": "EXAMPLE"
},
"name": {
"type": "string",
"description": "Понятное человеку значение `name`.",
"example": "Example name"
},
"category": {
"type": "string",
"enum": [
"APPLIED",
"SCREENING",
"INTERVIEW",
"ASSESSMENT",
"OFFER",
"HIRED",
"REJECTED",
"WITHDRAWN"
],
"description": "Допустимые значения `category`: APPLIED, SCREENING, INTERVIEW, ASSESSMENT, OFFER, HIRED, REJECTED, WITHDRAWN.",
"example": "APPLIED"
},
"isTerminal": {
"type": "boolean",
"description": "True, если этап подбора конечный и кандидат не переходит с него дальше автоматически.",
"example": true
},
"sortOrder": {
"type": "integer",
"description": "Целочисленная позиция сортировки `sortOrder`; меньшие значения идут первыми.",
"example": 1
},
"revision": {
"type": "integer",
"description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
"example": 1
}
},
"required": [
"id",
"code",
"name",
"category",
"isTerminal",
"sortOrder",
"revision"
],
"description": "Упорядоченный этап процесса подбора с категорией и правилами конечного состояния.",
"example": {
"id": "f97fe865-5ff8-488a-8fab-9e27e748514c",
"code": "EXAMPLE",
"name": "Example name",
"category": "APPLIED",
"isTerminal": true,
"sortOrder": 1,
"revision": 1
}
}RecruitingReferenceItemDto
Справочная запись подбора, вложенная в коллекцию или агрегат Workforce.
idОбязательноUUID Hallify для
id.string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "UUID Hallify для `id`.", "example": "ba0372fd-c434-407b-8ec5-0634b02050cc" }nameОбязательноПонятное человеку значение
name.stringПолное определение
{ "type": "string", "description": "Понятное человеку значение `name`.", "example": "Example name" }codeНеобязательноСтабильный код
codeдля классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.string · nullПолное определение
{ "type": "string", "nullable": true, "description": "Стабильный код `code` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.", "example": "EXAMPLE" }
Полное определение
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `id`.",
"example": "ba0372fd-c434-407b-8ec5-0634b02050cc"
},
"name": {
"type": "string",
"description": "Понятное человеку значение `name`.",
"example": "Example name"
},
"code": {
"type": "string",
"nullable": true,
"description": "Стабильный код `code` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.",
"example": "EXAMPLE"
}
},
"required": [
"id",
"name"
],
"description": "Справочная запись подбора, вложенная в коллекцию или агрегат Workforce.",
"example": {
"id": "ba0372fd-c434-407b-8ec5-0634b02050cc",
"name": "Example name"
}
}TranslatedErrorDto
Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.
statusCodeОбязательноHTTP-статус, повторённый из ответа.
integerПолное определение
{ "type": "integer", "description": "HTTP-статус, повторённый из ответа.", "example": 400 }errorОбязательноКлюч перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.
stringПолное определение
{ "type": "string", "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.", "example": "errors.request.invalid" }codeОбязательноСтабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями.
stringПолное определение
{ "type": "string", "example": "HTTP_BAD_REQUEST", "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями." }messageОбязательноКлюч перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе.
stringПолное определение
{ "type": "string", "example": "errors:http.badRequest", "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе." }translationKeyОбязательноКанонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте.
stringПолное определение
{ "type": "string", "example": "errors:http.badRequest", "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте." }translationValuesНеобязательноНеобязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.
objectПолное определение
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.", "example": { "exampleKey": "example" } }validationErrorsНеобязательноОшибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.
arrayПолное определение
{ "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.", "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "example": [ { "field": "email", "translationKey": "validation:isEmail", "code": "isEmail", "message": "validation:isEmail" } ] }detailsНеобязательноНеобязательные сведения о доменных препятствиях или ошибках валидации.
oneOfПолное определение
{ "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue" }, "example": [ "example" ] }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "example": { "exampleKey": "example" } } ], "example": [ "example" ] }
Полное определение
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP-статус, повторённый из ответа.",
"example": 400
},
"error": {
"type": "string",
"description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
"example": "errors.request.invalid"
},
"code": {
"type": "string",
"example": "HTTP_BAD_REQUEST",
"description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
},
"message": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
},
"translationKey": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
"example": {
"exampleKey": "example"
}
},
"validationErrors": {
"description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorDto"
},
"example": [
{
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
]
},
"details": {
"description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"example": [
"example"
]
}
},
"required": [
"statusCode",
"error",
"code",
"message",
"translationKey"
],
"description": "Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.",
"example": {
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}
}ValidationErrorDto
Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.
fieldОбязательноПубличный путь поля. Вложенные свойства и индексы массива разделены точками.
stringПолное определение
{ "type": "string", "example": "email", "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками." }translationKeyОбязательноКлюч перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers.
stringПолное определение
{ "type": "string", "example": "validation:isEmail", "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers." }codeОбязательноСтабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы.
stringПолное определение
{ "type": "string", "example": "isEmail", "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы." }messageОбязательноКлюч перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются.
stringПолное определение
{ "type": "string", "example": "validation:isEmail", "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются." }translationValuesНеобязательноНеобязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.
objectПолное определение
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.", "example": { "exampleKey": "example" } }
Полное определение
{
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "email",
"description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
},
"translationKey": {
"type": "string",
"example": "validation:isEmail",
"description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
},
"code": {
"type": "string",
"example": "isEmail",
"description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
},
"message": {
"type": "string",
"example": "validation:isEmail",
"description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
"example": {
"exampleKey": "example"
}
}
},
"required": [
"field",
"translationKey",
"code",
"message"
],
"description": "Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.",
"example": {
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
}JsonValue
Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.
Полное определение
{
"oneOf": [
{
"type": "string",
"nullable": true,
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"description": "Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.",
"example": "example"
}