Headcount Backend (headcount)

2.0info: 2.0.2 Headcount Backend description: Serviço de Quadro de vagas x-senior-domain: HCM x-senior-domain-path: hcm x-senior-service-path: headcount contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /headcount/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/normalizationInProgress: post: description: Retorna os identificadores externos dos planos de vagas que estão em normalização tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – externalIds properties: externalIds: type: array items: type: string minimum: 1 description: Identificadores externos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os identificadores externos dos planos de vagas que estão em normalização tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – externalIds properties: externalIds: type: array items: type: string minimum: 1 description: Identificadores externos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/migrate: post: description: Realiza a migração da base de dados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – errorMessage properties: status: type: boolean description: Status da migração errorMessage: type: string description: Mensagem de erro da migração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza a migração da base de dados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – errorMessage properties: status: type: boolean description: Status da migração errorMessage: type: string description: Mensagem de erro da migração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/jobVacancyAvaliableOnAdmission: post: description: Retornar a quantidade de vagas disponível no processo de Admissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – workstationGroupId – hireDate properties: companyId: type: string description: Id da empresa da admissão workstationGroupId: type: string description: Id do posto actingTypeId: type: string description: Id do Tipo de atuação actingTypeCode: type: integer format: int64 description: Code do Tipo de atuação hireDate: type: string format: date description: Data da admissão isFlowProcess: type: boolean description: Utilizado em processo de aprovação default: false responses: 200: description: Ok schema: type: object required: – jobVacancyAvaliable properties: jobVacancyAvaliable: type: object allOf: – #/definitions/jobVacancyAvaliable description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retornar a quantidade de vagas disponível no processo de Admissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: companyId description: Id da empresa da admissão in: query required: true type: string – name: workstationGroupId description: Id do posto in: query required: true type: string – name: actingTypeId description: Id do Tipo de atuação in: query type: string – name: actingTypeCode description: Code do Tipo de atuação in: query type: integer format: int64 – name: hireDate description: Data da admissão in: query required: true type: string format: date – name: isFlowProcess description: Utilizado em processo de aprovação in: query type: boolean responses: 200: description: Ok schema: type: object required: – jobVacancyAvaliable properties: jobVacancyAvaliable: type: object allOf: – #/definitions/jobVacancyAvaliable description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/jobVacancyAvaliableOnStaffRequisition: post: description: Retorna a quantidade de vagas disponível no processo de requisição ou criação de vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – workstationGroupId – staffRequisitionTypeCode – vacancyQuantity – referenceDate properties: companyId: type: string description: Id da empresa da admissão workstationGroupId: type: string description: Id do posto actingTypeId: type: string description: Id do Tipo de atuação actingTypeCode: type: integer format: int64 description: Code do Tipo de atuação staffRequisitionTypeCode: type: integer format: int64 description: Código do tipo de requisição vacancyQuantity: type: integer format: int64 description: Quantidade de vagas referenceDate: type: string format: date description: Data de referência isFlowProcess: type: boolean description: Utilizado em processo de aprovação default: false responses: 200: description: Ok schema: type: object required: – jobVacancyAvaliable properties: jobVacancyAvaliable: type: object allOf: – #/definitions/jobVacancyAvaliable description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de vagas disponível no processo de requisição ou criação de vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: companyId description: Id da empresa da admissão in: query required: true type: string – name: workstationGroupId description: Id do posto in: query required: true type: string – name: actingTypeId description: Id do Tipo de atuação in: query type: string – name: actingTypeCode description: Code do Tipo de atuação in: query type: integer format: int64 – name: staffRequisitionTypeCode description: Código do tipo de requisição in: query required: true type: integer format: int64 – name: vacancyQuantity description: Quantidade de vagas in: query required: true type: integer format: int64 – name: referenceDate description: Data de referência in: query required: true type: string format: date – name: isFlowProcess description: Utilizado em processo de aprovação in: query type: boolean responses: 200: description: Ok schema: type: object required: – jobVacancyAvaliable properties: jobVacancyAvaliable: type: object allOf: – #/definitions/jobVacancyAvaliable description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/jobVacancyAvaliableOnMovimentation: post: description: Retorna a quantidade de vagas disponível no processo de Transferência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – workstationGroupIdOrigin – workstationGroupIdDestiny – referenceDate properties: companyId: type: string description: Id da empresa da admissão workstationGroupIdOrigin: type: string description: Id do posto de origem workstationGroupIdDestiny: type: string description: Id do posto de destino actingTypeId: type: string description: Id do Tipo de atuação actingTypeCode: type: integer format: int64 description: Code do Tipo de atuação referenceDate: type: string format: date description: Data de referência isFlowProcess: type: boolean description: Utilizado em processo de aprovação default: false responses: 200: description: Ok schema: type: object required: – jobVacancyAvaliable properties: jobVacancyAvaliable: type: object allOf: – #/definitions/jobVacancyAvaliable description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de vagas disponível no processo de Transferência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: companyId description: Id da empresa da admissão in: query required: true type: string – name: workstationGroupIdOrigin description: Id do posto de origem in: query required: true type: string – name: workstationGroupIdDestiny description: Id do posto de destino in: query required: true type: string – name: actingTypeId description: Id do Tipo de atuação in: query type: string – name: actingTypeCode description: Code do Tipo de atuação in: query type: integer format: int64 – name: referenceDate description: Data de referência in: query required: true type: string format: date – name: isFlowProcess description: Utilizado em processo de aprovação in: query type: boolean responses: 200: description: Ok schema: type: object required: – jobVacancyAvaliable properties: jobVacancyAvaliable: type: object allOf: – #/definitions/jobVacancyAvaliable description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/jobVacancyAvaliableOnReturnHistoricalLeave: post: description: Retorna a quantidade de vagas disponível no processo de retorno de afastamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – workstationGroupId – referenceDate – timeTrackingSituationId properties: companyId: type: string description: Id da empresa da admissão workstationGroupId: type: string description: Id do posto actingTypeId: type: string description: Id do Tipo de atuação referenceDate: type: string format: date description: Data de referência timeTrackingSituationId: type: string description: Id da situação do afastamento responses: 200: description: Ok schema: type: object required: – jobVacancyAvaliable properties: jobVacancyAvaliable: type: object allOf: – #/definitions/jobVacancyAvaliable description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de vagas disponível no processo de retorno de afastamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: companyId description: Id da empresa da admissão in: query required: true type: string – name: workstationGroupId description: Id do posto in: query required: true type: string – name: actingTypeId description: Id do Tipo de atuação in: query type: string – name: referenceDate description: Data de referência in: query required: true type: string format: date – name: timeTrackingSituationId description: Id da situação do afastamento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – jobVacancyAvaliable properties: jobVacancyAvaliable: type: object allOf: – #/definitions/jobVacancyAvaliable description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/hasHeadCountAvailableOnStaffRequisitionType: post: description: Retorna se um determinado tipo de requisição de pessoal tem o controle quadro de colaborares habilitado ou não tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – staffRequisitionCode properties: staffRequisitionCode: type: integer format: int64 description: Código do tipo da requisição de pessoal responses: 200: description: Ok schema: type: object required: – headCountControlAvailable properties: headCountControlAvailable: type: boolean description: Indica se o controle de quadro de colaboradores está habilitado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna se um determinado tipo de requisição de pessoal tem o controle quadro de colaborares habilitado ou não tags: – Queries x-senior-visibility: PRIVATE parameters: – name: staffRequisitionCode description: Código do tipo da requisição de pessoal in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – headCountControlAvailable properties: headCountControlAvailable: type: boolean description: Indica se o controle de quadro de colaboradores está habilitado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportCompany: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportWorkstationgroupstructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportWorkstationgroup: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportActingtype: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportTimetrackingsituation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportWorkstationGroupProfile: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportStaffRequisitionType: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportJobVacancyPlan: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportJobVacancyPlanCompany: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportWorkstationGroupJobVacancyPlan: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportEffectiveHeadCount: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/exportProvidedHeadCount: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importCompany: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importWorkstationgroupstructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importWorkstationgroup: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importActingtype: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importTimetrackingsituation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importWorkstationGroupProfile: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importStaffRequisitionType: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importJobVacancyPlan: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importJobVacancyPlanCompany: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importWorkstationGroupJobVacancyPlan: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importEffectiveHeadCount: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/actions/importProvidedHeadCount: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/events/importCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/importWorkstationgroupstructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportWorkstationgroupstructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/importWorkstationgroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportWorkstationgroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/importActingtypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportActingtypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/importTimetrackingsituationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportTimetrackingsituationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/importWorkstationGroupProfileEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportWorkstationGroupProfileEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/importStaffRequisitionTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportStaffRequisitionTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/importJobVacancyPlanEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportJobVacancyPlanEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/importJobVacancyPlanCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportJobVacancyPlanCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/importWorkstationGroupJobVacancyPlanEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportWorkstationGroupJobVacancyPlanEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/importEffectiveHeadCountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportEffectiveHeadCountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/importProvidedHeadCountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/events/exportProvidedHeadCountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /headcount/entities/staffRequisitionType: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/staffRequisitionType responses: 200: description: The created resource schema: #/definitions/staffRequisitionType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/staffRequisitionType responses: 200: description: The created resource schema: #/definitions/staffRequisitionType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/staffRequisitionType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/staffRequisitionType/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editStaffRequisitionType responses: 200: description: Ok schema: #/definitions/editStaffRequisitionType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/staffRequisitionType responses: 200: description: Ok schema: #/definitions/staffRequisitionType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/staffRequisitionType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/staffRequisitionType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/staffRequisitionType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/jobVacancyPlan: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobVacancyPlan responses: 200: description: The created resource schema: #/definitions/jobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobVacancyPlan responses: 200: description: The created resource schema: #/definitions/jobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/jobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/jobVacancyPlan/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editJobVacancyPlan responses: 200: description: Ok schema: #/definitions/editJobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobVacancyPlan responses: 200: description: Ok schema: #/definitions/jobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/jobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/jobVacancyPlan/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/jobVacancyPlan responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/jobVacancyPlanCompany: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobVacancyPlanCompany responses: 200: description: The created resource schema: #/definitions/jobVacancyPlanCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobVacancyPlanCompany responses: 200: description: The created resource schema: #/definitions/jobVacancyPlanCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/jobVacancyPlanCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/jobVacancyPlanCompany/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editJobVacancyPlanCompany responses: 200: description: Ok schema: #/definitions/editJobVacancyPlanCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobVacancyPlanCompany responses: 200: description: Ok schema: #/definitions/jobVacancyPlanCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/jobVacancyPlanCompany 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/jobVacancyPlanCompany/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/jobVacancyPlanCompany responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/workstationGroupJobVacancyPlan: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workstationGroupJobVacancyPlan responses: 200: description: The created resource schema: #/definitions/workstationGroupJobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workstationGroupJobVacancyPlan responses: 200: description: The created resource schema: #/definitions/workstationGroupJobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/workstationGroupJobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/workstationGroupJobVacancyPlan/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editWorkstationGroupJobVacancyPlan responses: 200: description: Ok schema: #/definitions/editWorkstationGroupJobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workstationGroupJobVacancyPlan responses: 200: description: Ok schema: #/definitions/workstationGroupJobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workstationGroupJobVacancyPlan 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/workstationGroupJobVacancyPlan/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workstationGroupJobVacancyPlan responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/effectiveHeadCount: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/effectiveHeadCount responses: 200: description: The created resource schema: #/definitions/effectiveHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/effectiveHeadCount responses: 200: description: The created resource schema: #/definitions/effectiveHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/effectiveHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/effectiveHeadCount/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEffectiveHeadCount responses: 200: description: Ok schema: #/definitions/editEffectiveHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/effectiveHeadCount responses: 200: description: Ok schema: #/definitions/effectiveHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/effectiveHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/effectiveHeadCount/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/effectiveHeadCount responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/providedHeadCount: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/providedHeadCount responses: 200: description: The created resource schema: #/definitions/providedHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/providedHeadCount responses: 200: description: The created resource schema: #/definitions/providedHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/providedHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/providedHeadCount/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editProvidedHeadCount responses: 200: description: Ok schema: #/definitions/editProvidedHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/providedHeadCount responses: 200: description: Ok schema: #/definitions/providedHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/providedHeadCount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /headcount/entities/providedHeadCount/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/providedHeadCount responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: heathcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim referenceDateType: type: string enum: – referenceDate – firstDayOfTheMonth – lastDayOfTheMonth – referenceDatePlusGrace description: Data de referência: * `referenceDate` – Data de referência * `firstDayOfTheMonth` – Primeiro dia do mês * `lastDayOfTheMonth` – Último dia do mês * `referenceDatePlusGrace` – Data de referência mais carência checkHeadCountType: type: string enum: – notAllowToInclude – allowIncludeByApprover – allowInclude – notConsist description: Tipo de verificação de vaga: * `notAllowToInclude` – Não permite inclusão * `allowIncludeByApprover` – Permite inclusão por aprovação * `allowInclude` – Permite inclusão * `notConsist` – Não consiste workstationGroupHeadCountControlType: type: string enum: – notConsist – byOwnWorkstationGroup – byGrouperWorkstationGroup description: Tipo controle de vagas de posto de trabalho: * `notConsist` – Não consiste * `byOwnWorkstationGroup` – Pelo próprio grupo de posto de trabalho * `byGrouperWorkstationGroup` – Por agrupador de posto de trabalho consistencyType: type: string enum: – notConsist – allow – allowWithWarning – allowWithPermission – notAllow description: Consistência: * `notConsist` – Não consiste * `allow` – Permite * `allowWithWarning` – Permite com alerta * `allowWithPermission` – Permite mediante aprovação * `notAllow` – Não permite userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error jobVacancyAvaliable: description: Retorno da quantidade de vagas disponível type: object required: – headCountBalance – effectiveCount – providedCount – temporaryCount – leaveCount – staffRequisitionCount – vacancyCount – message – consistencyType properties: headCountBalance: type: integer format: int64 description: Saldo de vagas effectiveCount: type: integer format: int64 description: Quantidade de efetivo providedCount: type: integer format: int64 description: Quantidade de previstos temporaryCount: type: integer format: int64 description: Quantidade de temporários leaveCount: type: integer format: int64 description: Quantidade de afastados staffRequisitionCount: type: integer format: int64 description: Quantidade de requisições de vaga vacancyCount: type: integer format: int64 description: Quantidade de vagas message: type: string description: Mensagem consistencyType: type: string allOf: – #/definitions/consistencyType description: Consistência checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status effectiveHeadCountSituation: description: Detalhamento da situação do quadro efetivo type: object required: – headCountBalance – effectiveCount – leaveCount – staffRequisitionCount – vacancyCount properties: headCountBalance: type: integer format: int64 description: Saldo de vagas effectiveCount: type: integer format: int64 description: Quantidade de efetivo leaveCount: type: integer format: int64 description: Quantidade de afastados staffRequisitionCount: type: integer format: int64 description: Quantidade de requisições de vaga vacancyCount: type: integer format: int64 description: Quantidade de vagas providedHeadCountSituation: description: type: object required: – countProvidedJobVacancy – countTemporaryJobVacancy properties: countProvidedJobVacancy: type: integer format: int64 description: Quantidade de vagas do quadro previsto countTemporaryJobVacancy: type: integer format: int64 description: Quantidade de vagas temporárias company: description: Empresa type: object required: – id – code – cnpj – companyname properties: id: type: string description: Id da empresa code: type: integer format: int64 description: Código da empresa cnpj: type: string description: Cnpj da empresa companyname: type: string description: Nome da empresa workstationgroupstructure: description: Estrutura salarial do grupo de postos type: object required: – id properties: id: type: string description: Identificador único da estrutura salarial name: type: string description: Nome da estrutura salarial code: type: integer format: int64 description: Código da estrutura de postos workstationgroup: description: Grupo de postos de trabalho type: object required: – id – workstationgroupstructure properties: id: type: string description: Identificador único do grupo de posto de trabalho name: type: string description: Nome do grupo de postos de trabalho code: type: string description: Código do grupo de Postos workstationgroupstructure: type: object allOf: – #/definitions/workstationgroupstructure description: Estrutura do Grupo de postos actingtype: description: Tipo de atuação da proposta type: object required: – id – description – code – mainhistory – headCountControl properties: id: type: string description: Identificador único do tipo de atuação description: type: string description: Descrição do tipo de atuação da proposta code: type: integer format: int64 description: Código do tipo da proposta na G5 mainhistory: type: boolean description: Identificador de histórico principal headCountControl: type: boolean description: Indica se atuações deste tipo contabilizam uma vaga no quadro de lotação timetrackingsituation: description: Situação de uma apuração realizada pelo colaborador type: object required: – headCountControl properties: id: type: string description: Id da situação do afastamento code: type: integer format: int64 description: Código da situação isforabsent: type: boolean description: Indica se o afastamento considera absenteísmo name: type: string description: Nome da situação headCountControl: type: boolean description: Considera afastados quadro workstationGroupProfile: description: Perfil do posto de trabalho.Contém configurações de características de posto.(R017PER) type: object required: – id – code – description properties: id: type: string maxLength: 32 description: Identificador do Perfil de posto. code: type: integer format: int64 description: Código do perfil. (PERPOS) description: type: string maxLength: 50 description: Descrição do perfil de posto. (DESPER) staffRequisitionType: description: Tipos de requisição de pessoal type: object required: – code – name – headCountControl properties: id: type: string maxLength: 32 description: Identificador do tipo de requisição pessoal code: type: integer format: int64 description: Código do tipo de requisição maximum: 999 name: type: string maxLength: 30 description: Descrição do tipo de requisição headCountControl: type: boolean description: Verifica existência de vaga nas requisições deste tipo externalId: type: string description: Identificador externo editStaffRequisitionType: type: object required: – id allOf: – #/definitions/staffRequisitionType jobVacancyPlan: description: Plano de vagas type: object required: – workstationgroupstructure – code – startDate – endDate – checkLeaves – checkVacancies – checkStaffRequisition – referenceDateType – checkHeadCountAdmissionType – checkHeadCountMovimentationType – temporaryVacancyControl properties: id: type: string maxLength: 32 description: Identificação do registro workstationgroupstructure: type: object allOf: – #/definitions/workstationgroupstructure description: Estrutura de postos de trabalho code: type: integer format: int64 description: Código do plano de vagas maximum: 9999 smallDescription: type: string maxLength: 40 description: Descrição reduzida do plano de vagas completeDescription: type: string maxLength: 500 description: Descrição detalhada do plano de vagas startDate: type: string format: date description: Data de início da vigência endDate: type: string format: date description: Data de término da vigência checkLeaves: type: boolean description: Considerar afastamentos na composição do saldo checkVacancies: type: boolean description: Considerar vagas na composição do saldo checkStaffRequisition: type: boolean description: Considerar requisições de vagas na composição do saldo referenceDateType: type: string allOf: – #/definitions/referenceDateType description: Data de referência para buscar o saldo do quadro de vagas graceDays: type: integer format: int64 description: Dias de carência considerados na contagem do saldo maximum: 99 checkHeadCountAdmissionType: type: string allOf: – #/definitions/checkHeadCountType description: Verificação do quadro na admissão checkHeadCountMovimentationType: type: string allOf: – #/definitions/checkHeadCountType description: Verificação do quadro nas movimentações temporaryVacancyControl: type: boolean description: Controlar vaga temporária normalizationInProgress: type: boolean description: Indica se a normalização do quadro está em andamento default: false externalId: type: string description: Identificador externo editJobVacancyPlan: type: object required: – id allOf: – #/definitions/jobVacancyPlan jobVacancyPlanCompany: description: Plano de vagas por empresas type: object required: – jobVacancyPlan – company – jobVacancyPlanActive properties: id: type: string maxLength: 32 description: Identificador do registro jobVacancyPlan: type: object allOf: – #/definitions/jobVacancyPlan description: Plano de vagas company: type: object allOf: – #/definitions/company description: Empresa jobVacancyPlanActive: type: boolean description: Define se o plano de vagas está ativo para esta empresa externalId: type: string description: Identificador externo editJobVacancyPlanCompany: type: object required: – id allOf: – #/definitions/jobVacancyPlanCompany workstationGroupJobVacancyPlan: description: Plano de vagas por posto type: object required: – workstationGroup – dateWhen – workstationGroupHeadCountControlType properties: id: type: string maxLength: 32 description: Identificador do registro workstationGroup: type: object allOf: – #/definitions/workstationgroup description: Posto de trabalho dateWhen: type: string format: date description: Data de alteração do histórico de controle de vagas do posto workstationGroupHeadCountControlType: type: string allOf: – #/definitions/workstationGroupHeadCountControlType description: Define como será feito o controle de vagas para este posto de trabalho grouperWorkstationGroup: type: object allOf: – #/definitions/workstationgroup description: Posto agrupador externalId: type: string description: Identificação externa editWorkstationGroupJobVacancyPlan: type: object required: – id allOf: – #/definitions/workstationGroupJobVacancyPlan effectiveHeadCount: description: Quadro de vagas efetivo type: object required: – jobVacancyPlan – workstationGroup – dateWhen – countJobVacancy – countHistoricalLeave – countVacancy – countVacancyRequest properties: id: type: string maxLength: 32 description: Identificador do registro jobVacancyPlan: type: object allOf: – #/definitions/jobVacancyPlan description: Plano de vagas workstationGroup: type: object allOf: – #/definitions/workstationgroup description: Posto de trabalho dateWhen: type: string format: date description: Data do efetivo countJobVacancy: type: integer format: int64 description: Quantidade de efetivo maximum: 999999 countHistoricalLeave: type: integer format: int64 description: Quantidade de afastamentos do efetivo maximum: 999999 countVacancy: type: integer format: int64 description: Quantidade de vagas do efetivo maximum: 999999 countVacancyRequest: type: integer format: int64 description: Quantidade de solicitações de vagas do efetivo maximum: 999999 externalId: type: string description: Identificador externo editEffectiveHeadCount: type: object required: – id allOf: – #/definitions/effectiveHeadCount providedHeadCount: description: Quadro de vagas previsto type: object required: – jobVacancyPlan – workstationGroup – dateWhen – countJobVacancy – countTemporaryJobVacancy properties: id: type: string maxLength: 32 description: Identificador do registro jobVacancyPlan: type: object allOf: – #/definitions/jobVacancyPlan description: Plano de vagas workstationGroup: type: object allOf: – #/definitions/workstationgroup description: Posto de trabalho dateWhen: type: string format: date description: Data de alteração do quadro de vagas countJobVacancy: type: integer format: int64 description: Quantidade de vagas no posto de trabalho maximum: 999999 countTemporaryJobVacancy: type: integer format: int64 description: Quantidade de vagas temporárias no posto de trabalho maximum: 999999 externalId: type: string description: Identificador externo editProvidedHeadCount: type: object required: – id allOf: – #/definitions/providedHeadCount notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage