Gestão de Pessoas (hcm)

2.0info: 7.15.0 vacancymanagement description: Serviço de gerenciamento de vagas do recrutamento x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: vacancymanagement contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /hcm/vacancymanagementsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /candidateCreated: post: description: Event of candidate create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidate responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateDeleted: post: description: Event of candidate delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidate responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateMerged: post: description: Event of candidate merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidate responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateUpdated: post: description: Event of candidate update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidate responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateindicationCreated: post: description: Event of candidateIndication create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateIndication responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateindicationDeleted: post: description: Event of candidateIndication delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateIndication responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateindicationMerged: post: description: Event of candidateIndication merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateIndication responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateindicationUpdated: post: description: Event of candidateIndication update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateIndication responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateprofessionalexperienceCreated: post: description: Event of candidateProfessionalExperience create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateProfessionalExperience responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateprofessionalexperienceDeleted: post: description: Event of candidateProfessionalExperience delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateProfessionalExperience responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateprofessionalexperienceMerged: post: description: Event of candidateProfessionalExperience merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateProfessionalExperience responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateprofessionalexperienceUpdated: post: description: Event of candidateProfessionalExperience update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateProfessionalExperience responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateeducationCreated: post: description: Event of candidateEducation create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateEducation responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateeducationDeleted: post: description: Event of candidateEducation delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateEducation responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateeducationMerged: post: description: Event of candidateEducation merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateEducation responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /candidateeducationUpdated: post: description: Event of candidateEducation update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/candidateEducation responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/candidate: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/candidate responses: 200: description: The created resource schema: #/definitions/candidate default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/candidate responses: 200: description: The created resource schema: #/definitions/candidate default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/candidate default: description: Error response schema: #/definitions/genericError /entities/candidate/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/candidate responses: 200: description: Ok schema: #/definitions/candidate default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/candidate responses: 200: description: Ok schema: #/definitions/candidate default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/candidate default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/candidate/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/candidate responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/statusReport: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/statusReport responses: 200: description: The created resource schema: #/definitions/statusReport default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/statusReport responses: 200: description: The created resource schema: #/definitions/statusReport default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/statusReport default: description: Error response schema: #/definitions/genericError /entities/statusReport/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/statusReport responses: 200: description: Ok schema: #/definitions/statusReport default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/statusReport responses: 200: description: Ok schema: #/definitions/statusReport default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/statusReport default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/statusReport/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/statusReport responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/recruitmentProcess: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/recruitmentProcess responses: 200: description: The created resource schema: #/definitions/recruitmentProcess default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/recruitmentProcess responses: 200: description: The created resource schema: #/definitions/recruitmentProcess default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/recruitmentProcess default: description: Error response schema: #/definitions/genericError /entities/recruitmentProcess/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/recruitmentProcess responses: 200: description: Ok schema: #/definitions/recruitmentProcess default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/recruitmentProcess responses: 200: description: Ok schema: #/definitions/recruitmentProcess default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/recruitmentProcess default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/recruitmentProcess/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/recruitmentProcess responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/vacancy: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/vacancy responses: 200: description: The created resource schema: #/definitions/vacancy default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/vacancy responses: 200: description: The created resource schema: #/definitions/vacancy default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/vacancy default: description: Error response schema: #/definitions/genericError /entities/vacancy/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacancy responses: 200: description: Ok schema: #/definitions/vacancy default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacancy responses: 200: description: Ok schema: #/definitions/vacancy default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vacancy default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/vacancy/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/vacancy responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/settingsStage: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/settingsStage responses: 200: description: The created resource schema: #/definitions/settingsStage default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/settingsStage responses: 200: description: The created resource schema: #/definitions/settingsStage default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/settingsStage default: description: Error response schema: #/definitions/genericError /entities/settingsStage/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/settingsStage responses: 200: description: Ok schema: #/definitions/settingsStage default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/settingsStage responses: 200: description: Ok schema: #/definitions/settingsStage default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/settingsStage default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/settingsStage/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/settingsStage responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/candidateEducation: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/candidateEducation responses: 200: description: The created resource schema: #/definitions/candidateEducation default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/candidateEducation responses: 200: description: The created resource schema: #/definitions/candidateEducation default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/candidateEducation default: description: Error response schema: #/definitions/genericError /entities/candidateEducation/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/candidateEducation responses: 200: description: Ok schema: #/definitions/candidateEducation default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/candidateEducation responses: 200: description: Ok schema: #/definitions/candidateEducation default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/candidateEducation default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/candidateEducation/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/candidateEducation responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/candidateProfessionalExperience: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/candidateProfessionalExperience responses: 200: description: The created resource schema: #/definitions/candidateProfessionalExperience default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/candidateProfessionalExperience responses: 200: description: The created resource schema: #/definitions/candidateProfessionalExperience default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/candidateProfessionalExperience default: description: Error response schema: #/definitions/genericError /entities/candidateProfessionalExperience/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/candidateProfessionalExperience responses: 200: description: Ok schema: #/definitions/candidateProfessionalExperience default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/candidateProfessionalExperience responses: 200: description: Ok schema: #/definitions/candidateProfessionalExperience default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/candidateProfessionalExperience default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/candidateProfessionalExperience/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/candidateProfessionalExperience responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/candidatePhoneContact: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/candidatePhoneContact responses: 200: description: The created resource schema: #/definitions/candidatePhoneContact default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/candidatePhoneContact responses: 200: description: The created resource schema: #/definitions/candidatePhoneContact default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/candidatePhoneContact default: description: Error response schema: #/definitions/genericError /entities/candidatePhoneContact/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/candidatePhoneContact responses: 200: description: Ok schema: #/definitions/candidatePhoneContact default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/candidatePhoneContact responses: 200: description: Ok schema: #/definitions/candidatePhoneContact default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/candidatePhoneContact default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/candidatePhoneContact/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/candidatePhoneContact responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/candidateIndication: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/candidateIndication responses: 200: description: The created resource schema: #/definitions/candidateIndication default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/candidateIndication responses: 200: description: The created resource schema: #/definitions/candidateIndication default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/candidateIndication default: description: Error response schema: #/definitions/genericError /entities/candidateIndication/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/candidateIndication responses: 200: description: Ok schema: #/definitions/candidateIndication default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/candidateIndication responses: 200: description: Ok schema: #/definitions/candidateIndication default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/candidateIndication default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/candidateIndication/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/candidateIndication responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: stageType: type: string enum: – SORTED – CUSTOM – APPROVATION situationType: type: string enum: – IN_PROGRESS – SUSPENDED – CANCELED – FINALIZED reasonType: type: string enum: – STAFF_INCREASE – REPLACEMENT employmentContractType: type: string enum: – EMPLOYEE – DIRECTOR – RURAL_WORKER – RETIRED – TRAINEE – APPRENTICE – SPECIFIED_PERIOD – DIRECTOR_RETIRED – PUBLIC_OFFICER – TEACHER – COOPERATIVE_MEMBER – DOMESTIC_WORKER – TEACHER_SPECIFIED_PERIOD – THIRD_PARTY – COL_TERMINO_INDEFINIDO – COL_TERMINO_FIJO – COL_TERMINO_FIJO_1_ANO – COL_APRENDIZ_ETAPA_LECTIVA – COL_TERMINO_INDEFINIDO_SIN_TRANSP – COL_PRESTACION_DE_SERVICIOS – COL_NO_APLICA – COL_CONTRATO_MANZAROVAR – COL_CONTRATO_OCCIDENTAL – COL_CONTRATO_LEGAL_ECOPETROL – COL_CONTRATO_PACIFIC_RUBIALES – COL_CONTRATO_CONVENCIONAL_ECOPETROL – COL_CONTRATISTAS – COL_CONTRATO_PRODUCTIVIDAD_INDEFINIDO – COL_CONTRATO_PRODUCTIVIDAD_FIJO – COL_APRENDIZ_ETAPA_PRODUCTIVA – COL_APRENDIZ_SENA_PRODUCTIVO – COL_OBRA_O_LABOR – COL_INCAPACIDAD_MAYOR_180_DIAS – COL_TERMINO_INDEFINIDO_POR_PRODUCTIVIDAD – COL_TERMINO_INDEFINIDO_INTEGRAL – COL_CONTRATO_SALARIO_FIJO_Y_PRODUCTIVIDAD_INDEFINIDO – COL_TERMINO_INDEFINIDO_VARIABLE – COL_TERMINO_FIJO_VARIABLE genderType: type: string enum: – MALE – FEMALE – LGPD_EXCLUSION maritalStatus: type: string enum: – MARRIED – DIVORCED – SINGLE – WIDOW – CONCUBINAGE – SEPARATED – STABLE_UNION – OTHER – COL_DESCONOCIDO – COL_RELIGIOSO – COL_UNION_LIBRE locale: type: string enum: – PT_BR – EN_US – ES_ES – ES_CO candidateAnnotationType: type: string enum: – POSITIVE – NEGATIVE – NEUTRAL raceType: type: string enum: – NOT_INFORMED – WHITE – BLACK – BROWN – YELLOW – INDIAN disabilityType: type: string enum: – PHYSICAL – HEARING – VISUAL – MENTAL – INTELLECTUAL – OTHER socialNetworkType: type: string enum: – LINKEDIN – FACEBOOK – GOOGLEPLUS – SKYPE – TWITTER – X – INSTAGRAM – TIKTOK educationLevel: type: string enum: – ELEMENTARY_SCHOOL_REGULAR – ELEMENTARY_SCHOOL_SUPPLEMENTARY – HIGH_SCHOOL_REGULAR – HIGH_SCHOOL_SUPPLEMENTARY – HIGH_SCHOOL_TECHNICAL – HIGHER_EDUCATION – POST_GRADUATE_SPECIALIZATION – MASTERS_DEGREE – PHD_DEGREE – POST_DOCTORATE – FREE_DOCENCY – ASSISTANT – TITULAR – MBA – LGPD_EXCLUSION – COL_PREESCOLAR – COL_BASICA_PRIMARIA – COL_BASICA_SECUNDARIA – COL_MEDIA_ACADEMICA_O_CLASICA – COL_MEDIA_TECNICA – COL_NORMALISTA – COL_TECNICA_PROFESIONAL – COL_TECNOLOGICA – COL_PROFESIONAL – COL_ESPECIALIZACION – COL_MAESTRIA – COL_DOCTORADO – COL_POST_DOCTORADO – COL_NINGUNO – TECHNOLOGIST – TECHNICAL_EDUCATION knowledgeLevel: type: string enum: – BASIC – INTERMEDIATE – ADVANCED proficiencyType: type: string enum: – BASIC – INTERMEDIATE – ADVANCED – FLUENT – NATIVE phoneType: type: string enum: – PERSONAL – PROFESSIONAL – MOBILE – BUSINESS_FAX – PERSONAL_FAX – ADDITIONAL – OTHER candidateType: type: string enum: – INTERNAL – EXTERNAL – BOTH brazilianState: type: string enum: – AC – AL – AM – AP – BA – CE – DF – ES – GO – MA – MG – MT – MS – PA – PB – PE – PI – PR – RJ – RN – RO – RR – RS – SC – SE – SP – TO statusMessageType: type: string enum: – ACTIVE – INACTIVE typeSent: type: string enum: – ASSESSMENTS – MESSAGE preferredWorkModel: type: string enum: – IN_PERSON – REMOTE – HYBRID attachmentType: type: string enum: – CURRICULUM – PHOTO – VIDEO – PORTFOLIO – MEDICAL_REPORT – ACCESSIBILITY_CERTIFICATE degreeKinship: type: string enum: – FATHER – MOTHER rneClassification: type: string enum: – TEMPORARY – PERMANENT workRecordClass: type: string enum: – CAU – CFBIO – CFBM – CFC – CFESS – CFF – CFFA – CFM – CFMV – CFN – CFO – CFP – CFQ – COFEN – COFFITO – CONFEA – CONTER – COREN – CRBIO – CRBM – CRC – CREA – CREFITO – CREFONO – CRESS – CRF – CRM – CRMV – CRN – CRO – CRP – CRQ – CRTR – OAB pronounType: type: string enum: – SHE_HER – HE_HIM – NOT_ANSWER genderIdentity: type: string enum: – CISGENDER – TRANSGENDER – NON_BINARY – NOT_ANSWER sexualOrientation: type: string enum: – ASEXUAL – BISEXUAL – HETEROSEXUAL – HOMOSEXUAL – PANSEXUAL – NOT_ANSWER achievementsType: type: string enum: – CERTIFICATE – COURSE – AWARD nameType: type: string enum: – CIVIL – SOCIAL candidatureSubscription: type: string enum: – SUBSCRIBED – SELECTED medicalExamStatus: type: string enum: – NONE – ABLE – UNABLE – WAITING_RETURN – ABLE_RESTRICTIONS – ERROR recruitmentProcessStatus: type: string enum: – ACTIVE – INACTIVE – MOVED – REMOVED – GIVENUP – SUBSCRIBED – ELIMINATED attendantType: type: string enum: – INTERNAL – EXTERNAL jobBoardType: type: string enum: – LINKEDIN templateType: type: string enum: – DEFAULT – CUSTOM – TEMPLATE hiringRegimeType: type: string enum: – CLT – PJ – COOPERATED – TRAINEE jobModelType: type: string enum: – HYBRID – IN_PERSON – REMOTE experienceType: type: string enum: – ENTRY_LEVEL – MID_LEVEL – SENIOR_LEVEL – LEARNER – TRAINEE – SPECIALIST – COORDINATION – MANAGEMENT – DIRECTORSHIP – INTERNSHIP settingsStage: type: object required: – name – sequence – typeStage properties: id: type: string description: format: uuid name: type: string description: Nome sequence: type: integer description: Sequência. typeStage: #/definitions/stageType settingsStageModel: #/definitions/settingsStageModel blockStep: type: boolean description: Etapa de bloqueio visibleToCandidate: type: boolean description: Etapa visível para o candidato createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time settingsStageModel: type: object required: – name – startDate properties: id: type: string description: format: uuid name: type: string description: Nome. startDate: type: string description: Data de início. format: date isReadOnly: type: boolean description: Somente leitura isActive: type: boolean description: É o modelo ativo isDefault: type: boolean description: Modelo padrão settingsStages: type: array items: #/definitions/settingsStage description: Etapas. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time vacancy: type: object required: – title – typeSituation – typeReason – requesterWorkstation – jobPosition properties: id: type: string description: format: uuid type: string description: Título. location: type: string description: Local. typeSituation: #/definitions/situationType code: type: integer description: Código. typeReason: #/definitions/reasonType justification: type: string description: Justificativa. startSalaryRange: type: number description: Início da faixa salarial. format: double endSalaryRange: type: number description: Fim da faixa salarial. format: double admissionDate: type: string description: Data prevista de admissão. format: date finalizationDate: type: string description: Data de finalização. format: date-time finalizationComment: type: string description: Comentário da finalização. limitDays: type: integer description: Limite em dias para finalizar a vaga. positions: type: integer description: Quantidade de postos a serem preenchidos. filledPositions: type: integer description: Quantidade de vagas preenchidas. typeContract: #/definitions/employmentContractType subscribes: type: array items: #/definitions/recruitmentProcess description: Candidatos inscritos na vaga. finalizer: #/definitions/employee requesterWorkstation: #/definitions/workstation jobPosition: #/definitions/jobPosition workstationGroup: #/definitions/workstationGroup headOffice: #/definitions/company branchOffice: #/definitions/company costCenter: #/definitions/costCenter department: #/definitions/department workshift: #/definitions/workshift employeeToReplace: #/definitions/employee recruiter: #/definitions/employee employmentRelationship: #/definitions/employmentRelationship vacancyKeywordConfiguration: #/definitions/vacancyKeywordConfiguration vacancyPublication: #/definitions/vacancyPublication vacancyKeywords: type: array items: #/definitions/vacancyKeyword description: Lista de palavras-chave. questionnaire: type: string description: Identificador do questionário. staffRequisition: type: string description: Identificado da requisição de pessoal. suspendedDays: type: integer description: Quantidade de dias que a vaga ficou suspensa settingsStageModel: #/definitions/settingsStageModel unreadMessages: type: integer description: Quantidade de mensagens não lidas candidateMessage: type: array items: #/definitions/candidateMessage description: Mensagens para candidatos da vaga sendTests: type: boolean description: Descrição da função. function: #/definitions/function description: type: string description: Descrição da Vaga – Permitido descrições de até 10mb. tests: type: array items: type: string description: Lista de tipos de teste. vacancySettingsTest: #/definitions/vacancySettingsTest suggestedInternalVacancyDate: type: string description: Identifica se a vaga já foi considerada para o envio de sugestão de vagas pelo match format: date-time useDefaultStatusReport: type: boolean description: Identificador que valida se a vaga utiliza o status report padrão do sistema urlNewPortal: type: string description: URL da publicação da vaga no Novo Porta hiringRegime: #/definitions/hiringRegimeType jobModel: #/definitions/jobModelType experience: #/definitions/experienceType pcd: type: boolean description: Vaga afirmativa para PCD vacancyRequirements: #/definitions/vacancyRequirements createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time recruitmentProcess: type: object required: – vacancy – candidate – subscriptionType – medicalExamStatus – initialCandidateType – status properties: id: type: string description: format: uuid vacancy: #/definitions/vacancy candidate: #/definitions/candidate subscriptionType: #/definitions/candidatureSubscription medicalExamStatus: #/definitions/medicalExamStatus medicalExamMessage: type: string description: Mensagem de retorno do exame médico statusIntegration: type: boolean description: Status da integração para g5 initialCandidateType: #/definitions/candidateType answerId: type: string description: Identificador da resposta do questionário stage: #/definitions/settingsStage status: #/definitions/recruitmentProcessStatus salary: type: number description: Salário format: double admissionDate: type: string description: Data de admissão format: date attendant: #/definitions/attendant colabbePreAdmission: type: string description: format: uuid attendanceDateTime: type: string description: Data/Hora do atendimento format: date-time adherenceRequestId: type: string description: Identificador da solicitação da aderência adherenceScore: type: number description: Nota da aderência format: double newPortalId: type: string description: format: uuid processBlocked: type: boolean description: Indica que o processo está bloqueado recruitmentProcessRequirementsMet: #/definitions/recruitmentProcessRequirementsMet createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidate: type: object required: – name – typeGender – candidateType properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. name: type: string description: Nome. surname: type: string description: Sobrenome. aboutYou: type: string description: Apresentação candidato – Sobre você. yourSkills: type: string description: Habilidades. email: type: string description: E-mail. typeGender: #/definitions/genderType typeMaritalStatus: #/definitions/maritalStatus numberOfChildren: type: integer description: Quantidade de filhos. birthday: type: string description: Data de nascimento. format: date cpf: type: string description: CPF. travelPossibility: type: boolean description: Disponibilidade para viagens. realocationPossibility: type: boolean description: Disponibilidade de mudança. professionalSummary: type: string description: Resumo profissional. professionalGoal: type: string description: Objetivo profissional. salaryExpectation: type: number description: Salário desejado. format: double locale: #/definitions/locale attachment: #/definitions/attachment photoAttachment: #/definitions/attachment photoThumbnailLink: type: string description: Url do thumbnail da foto do candidato. candidateAddress: type: array items: #/definitions/candidateAddress description: Endereço. candidateVoteRegistration: type: array items: #/definitions/candidateVoteRegistration description: Título eleitoral. candidateDisability: type: array items: #/definitions/candidateDisability description: Deficiências. candidateSocialNetwork: type: array items: #/definitions/candidateSocialNetwork description: Redes sociais. candidateAbility: type: array items: #/definitions/candidateAbility description: Habilidades do candidato. candidateEducation: type: array items: #/definitions/candidateEducation description: Formação acadêmica do candidato. candidateKnowledge: type: array items: #/definitions/candidateKnowledge description: Conhecimento do candidato. candidateLanguage: type: array items: #/definitions/candidateLanguage description: Idiomas do candidato. candidatePersonalInterest: type: array items: #/definitions/candidatePersonalInterest description: Interesses pessoais do candidato. candidatePositionSought: type: array items: #/definitions/candidatePositionSought description: Cargo desejado pelo candidato. candidateProfessionalExperience: type: array items: #/definitions/candidateProfessionalExperience description: Experiência profissional do candidato. candidatePhoneContact: type: array items: #/definitions/candidatePhoneContact description: Telefones de contato. employee: #/definitions/employee candidateType: #/definitions/candidateType candidateRg: #/definitions/candidateRg placeOfBirth: type: string description: Local de nascimento. nationality: type: string description: Nacionalidade. typeRace: #/definitions/raceType updatedAt: type: string description: Data da última alteração do currículo. format: date-time candidateAnnotations: type: array items: #/definitions/candidateAnnotation description: Comentários. candidateMessage: type: array items: #/definitions/candidateMessage description: Mensagens. externalOrigin: type: boolean description: Indica se a fonte dos dados é externa, ou seja, considerado como sendo um currículo. Esta informação será utilizada para contabilizar a quantidade de currículos no Analytics do módulo, uma vez que, no Gestão de Recrutamento e Seleção 2019, os currículos cadastrados via Portal de Candidatos (candidatos externos) e os colaboradores (candidatos internos) são armazenados na mesma tabela. candidateNis: #/definitions/candidateNis grantedDataAccess: type: boolean description: Indica se o candidato concedeu acesso aos dados. Este campo irá armazenar a última ação efetuada pelo candidato no sentido de indicar se o acesso está liberado ou não. Caso o candidato faça o aceite e revogação várias vezes, o histórico ficará armazenado, porém, aqui, só estará a última ação. candidateIndication: type: array items: #/definitions/candidateIndication description: Indicações do candidato. genericDocumentType: type: string description: Tipo de documento do candidato (para usúarios colombianos). genericDocumentNumber: type: string description: Número do documento do candidato (para usuários colombianos). newPortalId: type: string description: format: uuid position: type: string description: Apresentação do candidato – Seu cargo. candidatePreferredWorkModel: type: array items: #/definitions/candidatePreferredWorkModel description: Modelos de trabalho preferenciais. candidateAttachment: type: array items: #/definitions/candidateAttachment description: Anexos do candidato. candidateAffiliation: type: array items: #/definitions/candidateAffiliation description: Filiação 1 do candidato. candidateRne: #/definitions/candidateRne candidateCtps: #/definitions/candidateCtps candidateProfessionalRegistration: #/definitions/candidateProfessionalRegistration candidateCnh: #/definitions/candidateCnh candidateMilitaryRegistration: #/definitions/candidateMilitaryRegistration candidatePassport: #/definitions/candidatePassport candidateAccessibility: #/definitions/candidateAccessibility candidateDiversity: #/definitions/candidateDiversity candidateInfoSharing: #/definitions/candidateInfoSharing candidateAchievements: type: array items: #/definitions/candidateAchievements description: Conquistas do candidato – Cursos, certificações e premiações. nameType: #/definitions/nameType createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time attachment: type: object required: – name – idBlobService properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. name: type: string description: Nome do anexo. idBlobService: type: string description: Identificador do arquivo no blob service. locationURI: type: string description: Localização do anexo candidateAnnotations: type: array items: #/definitions/candidateAnnotation description: Anotações de candidatos fileSize: type: integer description: Tamanho do arquivo type: string description: Versão do objeto no blobservice createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateAnnotation: type: object required: – candidate – type – reporter – annotation properties: id: type: string description: format: uuid candidate: #/definitions/candidate type: #/definitions/candidateAnnotationType reporter: #/definitions/employee annotation: type: string description: Comentário. attachments: type: array items: #/definitions/attachment description: Anexos createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time employee: type: object required: – externalId – jobPosition – department – employer properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. hiredate: type: string description: Data de contratação. format: date dismissalDate: type: string description: Data de demissão. format: date person: #/definitions/person jobPosition: #/definitions/jobPosition department: #/definitions/department employer: #/definitions/company registerNumber: type: integer description: Número do contrato do colaborador. workstation: type: array items: #/definitions/workstation description: Posto de trabalho. externalCandidateId: type: string description: format: uuid workshift: #/definitions/workshift costcenter: #/definitions/costCenter contracttype: #/definitions/employmentContractType excluded: type: boolean description: Colaborador Excluído createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time person: type: object required: – externalId – username properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. name: type: string description: Nome. username: type: string description: Username (HCM) typeGender: #/definitions/genderType birthday: type: string description: Data de nascimento. format: date cpf: type: string description: CPF. typeMaritalStatus: #/definitions/maritalStatus professionalSummary: type: string description: Resumo profissional. rg: type: string description: RG. placeOfBirth: type: string description: Local de nascimento. nationality: type: string description: Nacionalidade. typeRace: #/definitions/raceType voteRegistration: #/definitions/voteRegistration photoThumbnail: type: string description: Miniatura da foto do colaborador originária do HCM. userAccounts: type: array items: #/definitions/userAccount description: Usuários photoAttachment: type: string description: Armazena o externalId da tabela attachment do registro que contém a foto da pessoa. Essa coluna é usada exclusivamente na integração com o HRIS ethnicity: #/definitions/ethnicity createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time voteRegistration: type: object required: – externalId – number – zone – section properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. person: #/definitions/person number: type: string description: número zone: type: string description: Zona section: type: string description: Seção createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time userAccount: type: object required: – externalId – person – username properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. person: #/definitions/person username: type: string description: Nome de usuário userDomain: type: string description: Dominio do usuário createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time ethnicity: type: object required: – externalId – name properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. name: type: string description: Nome. code: type: integer description: Código. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time jobPosition: type: object required: – externalId – name – jobPositionStructure properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. name: type: string description: Nome. jobPositionStructure: type: string description: Identificador da estrutura de cargos. code: type: string description: Código. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time department: type: object required: – externalId – name properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. name: type: string description: Nome. code: type: string description: Código. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time company: type: object required: – externalId – name properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. name: type: string description: Razão social. tradingName: type: string description: Nome fantasia. headOffice: #/definitions/company code: type: integer description: Código. cnpj: type: string description: Cnpj da empresa createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time workstation: type: object required: – externalId properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. employee: #/definitions/employee workstationGroup: #/definitions/workstationGroup createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time workstationGroup: type: object required: – externalId – name properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. name: type: string description: Nome. code: type: string description: Código. workstationGroupStructure: type: string description: Identificador da estrutura de cargos. vacancyTemplate: #/definitions/vacancyTemplate createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time vacancyTemplate: type: object required: – name properties: id: type: string description: format: uuid name: type: string description: Nome. descriptionFileId: type: string description: FileId referente a descrição no blobService type: string description: Título. useDefaultStatusReport: type: boolean description: Identificador que valida se o template utiliza o status report padrão do sistema justification: type: string description: Justificativa. limitDays: type: integer description: Limite em dias para finalizar a vaga. hiringRegime: type: string description: Vínculo trabalhista. jobModel: type: string description: Modelo de trabalho. experience: type: string description: Nível de experiência. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time workshift: type: object required: – externalId – description properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. description: type: string description: Descrição. shift: type: integer description: Turno. code: type: integer description: Código. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time costCenter: type: object required: – externalId – name properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. name: type: string description: Nome. code: type: string description: Código. company: #/definitions/company createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateAddress: type: object properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. candidates: type: array items: #/definitions/candidate description: Candidato country: type: string description: País. state: type: string description: Estado. stateAbbreviation: type: string description: Estado. city: type: string description: Cidade. neighborhood: type: string description: Bairro. address: type: string description: Endereço number: type: string description: Número. additional: type: string description: Complemento. postalCode: type: string description: Código postal. administrativeRegion: type: string description: Região administrativa. updateDate: type: string description: Data da alteração format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateVoteRegistration: type: object required: – candidate – number properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. candidate: #/definitions/candidate number: type: string description: Número. zone: type: string description: Zona. section: type: string description: Seção. city: type: string description: Cidade. state: type: string description: Estado. issueDate: type: string description: Data de Emissão. format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateDisability: type: object required: – candidate properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. candidate: #/definitions/candidate typeDisability: #/definitions/disabilityType cid: type: string description: CID Correspondente. description: type: string description: Descrição da deficiência createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateSocialNetwork: type: object required: – candidate – typeSocialNetwork – profile properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. candidate: #/definitions/candidate typeSocialNetwork: #/definitions/socialNetworkType profile: type: string description: Perfil. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateAbility: type: object required: – candidate – description properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. candidate: #/definitions/candidate description: type: string description: Descrição. highlight: type: boolean description: Destacar habilidade no Banco de Talentos? createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateEducation: type: object required: – candidate – courseName – typeSituation properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. candidate: #/definitions/candidate courseName: type: string description: Nome do curso. institutionName: type: string description: Instituição. startDate: type: string description: Data de início. format: date endDate: type: string description: Data de conclusão. format: date conclusionYear: type: integer description: Ano de conclusão. typeSituation: #/definitions/situationType typeEducationLevel: #/definitions/educationLevel createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateKnowledge: type: object required: – candidate – description properties: id: type: string description: format: uuid externalId: type: string description: Id externo do objeto candidate: #/definitions/candidate description: type: string description: Descrição. knowledgeLevel: #/definitions/knowledgeLevel createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateLanguage: type: object required: – candidate properties: id: type: string description: format: uuid externalId: type: string description: Id externo do objeto candidate: #/definitions/candidate language: type: string description: Idioma typeLanguage: type: string description: Tipo do idioma (NPC) typeProficiency: #/definitions/proficiencyType createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidatePersonalInterest: type: object required: – candidate – interest properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. candidate: #/definitions/candidate interest: type: string description: Interesse. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidatePositionSought: type: object required: – candidate properties: id: type: string description: format: uuid externalId: type: string description: Id externo do objeto candidate: #/definitions/candidate intendedArea: type: string description: Área de interesse. intendedJob: type: string description: Cargo de interesse. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateProfessionalExperience: type: object required: – candidate properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. candidate: #/definitions/candidate company: #/definitions/company companyName: type: string description: Nome da Empresa. jobPosition: #/definitions/jobPosition jobPositionName: type: string description: Nome do cargo. address: type: string description: Endereço da empresa. description: type: string description: Descrição. startDate: type: string description: Início. format: date endDate: type: string description: Término. format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidatePhoneContact: type: object required: – candidate – number – type properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. candidate: #/definitions/candidate countryCode: type: integer description: Código do país. localCode: type: integer description: Código de área. number: type: string description: Número. extension: type: string description: Ramal. type: #/definitions/phoneType createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateRg: type: object properties: id: type: string description: format: uuid number: type: string description: Número do documento issuer: type: string description: Órgão emissor issuerState: #/definitions/brazilianState issueDate: type: string description: Data de expedição format: date externalId: type: string description: Identificador único na base do HCM createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateMessage: type: object required: – candidate – message properties: id: type: string description: format: uuid candidate: #/definitions/candidate vacancy: #/definitions/vacancy settingsMessages: #/definitions/settingsMessages message: type: string description: Mensagem. attachments: type: array items: #/definitions/attachment description: Anexos createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time settingsMessages: type: object required: – name – message – statusMessage – typeSent properties: id: type: string description: format: uuid name: type: string description: Nome message: type: string description: Mensagem statusMessage: #/definitions/statusMessageType candidateMessage: type: array items: #/definitions/candidateMessage description: Mensagens typeSent: #/definitions/typeSent createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateNis: type: object properties: id: type: string description: format: uuid number: type: string description: Número NIS issueDate: type: string description: Data de registro format: date externalId: type: string description: Identificador no HCM createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateIndication: type: object required: – candidate – indication properties: id: type: string description: format: uuid candidate: #/definitions/candidate indication: type: string description: Nome da pessoa que realizou a indicação. comment: type: string description: Comentários sobre a indicação. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidatePreferredWorkModel: type: object required: – candidate properties: id: type: string description: format: uuid candidate: #/definitions/candidate preferredWorkModel: #/definitions/preferredWorkModel createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateAttachment: type: object required: – candidate – attachment – type properties: id: type: string description: format: uuid candidate: #/definitions/candidate attachment: #/definitions/attachment type: #/definitions/attachmentType createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateAffiliation: type: object required: – candidate properties: id: type: string description: format: uuid candidate: #/definitions/candidate degreeKinship: #/definitions/degreeKinship name: type: string description: Nome. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateRne: type: object properties: id: type: string description: format: uuid candidate: #/definitions/candidate number: type: string description: Número. classification: #/definitions/rneClassification nacionality: type: string description: Nacionalidade issuer: type: string description: Orgão Emissor entryDate: type: string description: Data de entrada format: date expirationDate: type: string description: Data de expiração format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateCtps: type: object properties: id: type: string description: format: uuid candidate: #/definitions/candidate serialNumber: type: string description: Número de série. series: type: string description: Série. pisPasep: type: string description: PIS/PASEP federativeUnity: #/definitions/brazilianState issueDate: type: string description: Data de emissão format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateProfessionalRegistration: type: object properties: id: type: string description: format: uuid candidate: #/definitions/candidate workRecordClass: #/definitions/workRecordClass number: type: string description: Número registro. state: #/definitions/brazilianState issueDate: type: string description: Data de emissão format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateCnh: type: object properties: id: type: string description: format: uuid candidate: #/definitions/candidate number: type: string description: Número registro. category: type: string description: Categoria firstCnhDate: type: string description: Data da 1ª habilitação format: date expirationDate: type: string description: Data de expiração format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateMilitaryRegistration: type: object properties: id: type: string description: format: uuid candidate: #/definitions/candidate reservistCertificateNumber: type: string description: Número certificado de reservista. dischargeDate: type: string description: Data dispensa format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidatePassport: type: object properties: id: type: string description: format: uuid candidate: #/definitions/candidate number: type: string description: Número country: type: string description: País expirationDate: type: string description: Data de validade format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateAccessibility: type: object required: – rehabilitated properties: id: type: string description: format: uuid candidate: #/definitions/candidate cid: type: string description: CID Correspondente. description: type: string description: Descrição da necessidade rehabilitated: type: boolean description: Reabilitado (INSS) createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateDiversity: type: object properties: id: type: string description: format: uuid candidate: #/definitions/candidate preferredPronoun: #/definitions/pronounType genderIdentity: #/definitions/genderIdentity sexualOrientation: #/definitions/sexualOrientation race: #/definitions/raceType birthplace: #/definitions/birthplace createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time birthplace: type: object properties: id: type: string description: format: uuid city: type: string description: Cidade de nascimento province: type: string description: Estado de nascimento createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateInfoSharing: type: object required: – sharingInfoAccessibility – sharingInfoDiversity properties: id: type: string description: format: uuid candidate: #/definitions/candidate sharingInfoAccessibility: type: boolean description: Compartilhar acessibilidade sharingInfoDiversity: type: boolean description: Compartilhar diversidade createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time candidateAchievements: type: object required: – candidate – title – description – achievementsType – startDate – endDate properties: id: type: string description: format: uuid candidate: #/definitions/candidate type: string description: Título description: type: string description: Descrição achievementsType: #/definitions/achievementsType startDate: type: string description: Data de início format: date endDate: type: string description: Data final format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time attendant: type: object required: – externalId – name – code properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. name: type: string description: Nome. code: type: string description: Código. attendantType: #/definitions/attendantType createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time recruitmentProcessRequirementsMet: type: object required: – fulfilledSelectedRequirements properties: id: type: string description: format: uuid fulfilledSelectedRequirements: type: array items: type: string description: Requisitos selecionados cumpridos. recruitmentProcess: #/definitions/recruitmentProcess createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time employmentRelationship: type: object required: – externalId – name properties: id: type: string description: format: uuid externalId: type: string description: Identificador único externo. name: type: string description: Nome. code: type: integer description: Código. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time vacancyKeywordConfiguration: type: object properties: id: type: string description: format: uuid trajectorySession: type: boolean description: Seção de trajetória profissional. professionalExperienceSession: type: boolean description: Seção de histórico profissional. educationSession: type: boolean description: Seção de formação acadêmica. languageSession: type: boolean description: Seção de idiomas. competencySession: type: boolean description: Seção de conhecimentos e habilidades. positionSoughtSession: type: boolean description: Seção de cargos e áreas desejadas. vacancy: #/definitions/vacancy createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time vacancyPublication: type: object required: – publication – gmt properties: id: type: string description: format: uuid publication: type: string description: Texto da publicação. internalPublish: type: boolean description: Publica internamente. highlight: type: boolean description: Indicador de destaque. internalStartDate: type: string description: Data de início da publicação interna. format: date internalEndDate: type: string description: Data final da publicação interna. format: date externalPublish: type: boolean description: Publica externamente. externalStartDate: type: string description: Data de início da publicação externa format: date externalEndDate: type: string description: Data final da publicação externa. format: date vacancy: #/definitions/vacancy fileId: type: string description: Identificador do arquivo com o texto da publicação no BlobService. type: string description: Versão do identificador do arquivo com o texto da publicação no BlobService. locationURI: type: string description: URL com o link do arquivo que contém o texto da publicação no BlobService. policyCriterion: type: string description: Critérios da política additionalInfo: type: string description: Informações adicionais apresentadas na publicação das vagas internas/externas gmt: type: string description: Fuso horário em que a vaga será publicada, aceita os seguintes valores: America/Sao_Paulo, America/Noronha, America/Manaus, America/Rio_Branco vacancyPublicationJobboards: type: array items: #/definitions/vacancyPublicationJobboards description: Plataformas de emprego que estão integradas na publicação originalNpcPublicationDate: type: string description: Data da publicação orignal da Vaga no NPC format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time vacancyPublicationJobboards: type: object required: – jobBoardType – startDate – endDate properties: id: type: string description: format: uuid jobBoardType: #/definitions/jobBoardType startDate: type: string description: Data de inicio format: date endDate: type: string description: Data de término format: date description: type: string description: Descrição vacancyPublication: #/definitions/vacancyPublication createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time vacancyKeyword: type: object required: – name properties: id: type: string description: format: uuid name: type: string description: Descrição do posto. vacancy: #/definitions/vacancy createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time function: type: object required: – name properties: id: type: string description: format: uuid internalId: type: string description: format: uuid externalId: type: string description: Id da função no serviço terceiro (externo). name: type: string description: Descrição da função. tests: type: array items: #/definitions/testDto description: Testes da função. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time testDto: type: object properties: id: type: string description: Identificador único do teste. name: type: string description: Nome do teste. type: type: string description: Tipo do teste. vacancySettingsTest: type: object properties: id: type: string description: format: uuid vacancy: #/definitions/vacancy templateType: #/definitions/templateType settingsMessages: #/definitions/settingsMessages message: type: string description: Mensagem a ser enviada. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time vacancyRequirements: type: object required: – requirements properties: id: type: string description: format: uuid requirements: type: string description: Requisitos format: byte vacancy: #/definitions/vacancy createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time statusReport: type: object properties: id: type: string description: format: uuid settingsStage: #/definitions/settingsStage vacancy: #/definitions/vacancy typeAction: type: string description: Tipo de ação vinculado ao cadastro do status report settingsMessages: #/definitions/settingsMessages createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE