2.0info: 7.52.1 performance description: Serviços do produto Gestão de Desempenho. x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: performance contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /hcm/performancesecurityDefinitions: 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: /getCyclesByNameOrId: post: description: Serviço para obtenção de informações do ciclo, consumido por visões dinâmicas e relatório jasper x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: searchText: type: string description: Busca pelo nome do ciclo searchValue: type: string description: Busca pelo id do ciclo responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/searchedData default: description: Error response schema: #/definitions/genericError get: description: Serviço para obtenção de informações do ciclo, consumido por visões dinâmicas e relatório jasper x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: searchText: type: string description: Busca pelo nome do ciclo searchValue: type: string description: Busca pelo id do ciclo responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/searchedData default: description: Error response schema: #/definitions/genericError /getContinuousCyclesByNameOrId: post: description: Serviço para obtenção dos ciclos continuos, consumido por visões dinâmicas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: searchText: type: string description: Busca pelo nome do ciclo searchValue: type: string description: Busca pelo id do ciclo responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/searchedData default: description: Error response schema: #/definitions/genericError get: description: Serviço para obtenção dos ciclos continuos, consumido por visões dinâmicas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: searchText: type: string description: Busca pelo nome do ciclo searchValue: type: string description: Busca pelo id do ciclo responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/searchedData default: description: Error response schema: #/definitions/genericError /exportPerformanceGoalsIAssist: post: description: Exportar as metas individuais e coletivas da avaliação de resultados para o IAsssit x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/exportPerformanceGoalsIAssistDTO default: description: Error response schema: #/definitions/genericError get: description: Exportar as metas individuais e coletivas da avaliação de resultados para o IAsssit x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/exportPerformanceGoalsIAssistDTO default: description: Error response schema: #/definitions/genericError /exportPerformanceGoals: post: description: Exportar as metas individuais da avaliação de resultados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: cycleId: type: string description: Id do ciclo cycleStartDate: type: string description: Data de início do ciclo employeeId: type: string description: Id do colaborador employeeEntryNumber: #/definitions/employeeEntryNumber page: #/definitions/pagination orderBy: type: array items: #/definitions/ordination description: Ordenação dos campos responses: 200: description: Ok schema: type: object required: – totalElements – numberPages properties: totalElements: type: integer description: Indica quantos registros foram encontrados numberPages: type: integer description: Indica o número de páginas da consulta (incluindo a atual) performanceGoals: #/definitions/exportPerformanceGoalsDTO default: description: Error response schema: #/definitions/genericError get: description: Exportar as metas individuais da avaliação de resultados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: cycleId: type: string description: Id do ciclo cycleStartDate: type: string description: Data de início do ciclo employeeId: type: string description: Id do colaborador employeeEntryNumber: #/definitions/employeeEntryNumber page: #/definitions/pagination orderBy: type: array items: #/definitions/ordination description: Ordenação dos campos responses: 200: description: Ok schema: type: object required: – totalElements – numberPages properties: totalElements: type: integer description: Indica quantos registros foram encontrados numberPages: type: integer description: Indica o número de páginas da consulta (incluindo a atual) performanceGoals: #/definitions/exportPerformanceGoalsDTO default: description: Error response schema: #/definitions/genericError /exportCollectiveGoals: post: description: Exportar as metas compartilhadas da avaliação de resultados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: cycleId: type: string description: Id do ciclo cycleStartDate: type: string description: Data de início do ciclo employeeId: type: string description: Id do colaborador employeeEntryNumber: #/definitions/employeeEntryNumber page: #/definitions/pagination orderBy: type: array items: #/definitions/ordination description: Ordenação dos campos responses: 200: description: Ok schema: type: object required: – totalElements – numberPages properties: totalElements: type: integer description: Indica quantos registros foram encontrados numberPages: type: integer description: Indica o número de páginas da consulta (incluindo a atual) collectiveGoals: #/definitions/exportCollectiveGoalsDTO default: description: Error response schema: #/definitions/genericError get: description: Exportar as metas compartilhadas da avaliação de resultados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: cycleId: type: string description: Id do ciclo cycleStartDate: type: string description: Data de início do ciclo employeeId: type: string description: Id do colaborador employeeEntryNumber: #/definitions/employeeEntryNumber page: #/definitions/pagination orderBy: type: array items: #/definitions/ordination description: Ordenação dos campos responses: 200: description: Ok schema: type: object required: – totalElements – numberPages properties: totalElements: type: integer description: Indica quantos registros foram encontrados numberPages: type: integer description: Indica o número de páginas da consulta (incluindo a atual) collectiveGoals: #/definitions/exportCollectiveGoalsDTO default: description: Error response schema: #/definitions/genericErrordefinitions: employeePerformanceGoalType: type: string enum: – VALUE – PERCENT – LEVEL employeePerformanceGoalDirection: type: string enum: – UPWARD – DESC employeePerformanceGoalState: type: string enum: – IN_DEFINITION – ACTIVE – DONE – CANCELED – EVALUATED_DEFINITION – AWAITING_APPROVAL_GOAL_BY_MANAGER measureUnitType: type: string enum: – PERCENTAGE – UNIT – HOURS – CURRENCY_VALUE employeeType: type: string enum: – EMPTY – EMPLOYEE – THIRDPARTY – PARTNER iAssistGoalType: type: string enum: – COLLECTIVE – INDIVIDUAL goalDirectionType: type: string enum: – UPWARD – DESC directionType: type: string enum: – ASC – DESC exportPerformanceGoalsDTO: type: object required: – id – description – type – direction – weight – minimumValue – idealValue – maximumValue – result – percentageOfAchievement – percentageOfAchievementAppraisal – state – measureUnit – branchOfficeId – branchOfficeName – headquarterId – headquarterName – employeeId – employeeName – employeeEntryNumber – employeeAppraisalCycle properties: id: type: string description: Código da meta description: type: string description: Descrição da meta type: #/definitions/employeePerformanceGoalType direction: #/definitions/employeePerformanceGoalDirection weight: type: string description: Peso da meta minimumValue: type: string description: Valor mínimo da meta idealValue: type: string description: Valor ideal da meta maximumValue: type: string description: Valor máximo da meta result: type: number description: Resultado da meta format: double percentageOfAchievement: type: number description: Percentual de atingimento da meta format: double percentageOfAchievementAppraisal: type: number description: Percentual de atingimento da avaliação format: double state: #/definitions/employeePerformanceGoalState measureUnit: #/definitions/measureUnitType branchOfficeId: type: string description: Código da filial branchOfficeName: type: string description: Nome da filial headquarterId: type: string description: Código da matriz headquarterName: type: string description: Nome da matriz employeeId: type: string description: Código do colaborador employeeName: type: string description: Nome completo do colaborador employeeEntryNumber: #/definitions/employeeEntryNumber employeeAppraisalCycle: #/definitions/cycleRecord employeeEntryNumber: type: object properties: companyNumber: type: integer description: Número da empresa employeeType: #/definitions/employeeType registerNumber: type: integer description: Número de registro do contrato cycleRecord: type: object properties: id: type: string description: Identificador name: type: string description: Nome do ciclo startdate: type: string description: Data de início enddate: type: string description: Data de fim exportPerformanceGoalsIAssistDTO: type: object required: – appraisalId – goalDescription – goalDirection – goalWeight – goalMinimumValue – goalIdealValue – goalMaximumValue – goalResult – goalPercentageOfAchievement – percentageOfAchievementAppraisal – goalState – measureUnit – employeeId – employeeName properties: appraisalId: type: string description: Id da avaliação de competência goalDescription: type: string description: Descrição da meta goalDirection: type: string description: Direção da meta goalWeight: type: string description: Peso da meta goalMinimumValue: type: string description: Valor mínimo da meta goalIdealValue: type: string description: Valor ideal da meta goalMaximumValue: type: string description: Valor máximo da meta goalResult: type: number description: Resultado da meta format: double goalPercentageOfAchievement: type: number description: Percentual de atingimento da meta format: double percentageOfAchievementAppraisal: type: number description: Percentual de atingimento da avaliação format: double goalState: type: string description: Situação atual da meta measureUnit: #/definitions/measureUnitType employeeId: type: string description: Código do colaborador employeeName: type: string description: Nome completo do colaborador cycleName: type: string description: Nome do ciclo cycleStartDate: type: string description: Data de início format: date cycleEndDate: type: string description: Data de fim format: date goalType: #/definitions/iAssistGoalType exportCollectiveGoalsDTO: type: object required: – id – description – direction – measureUnitType – weight – minimumValue – idealValue – maximumValue – goalResult – percentageOfAchievement – percentageOfAchievementAppraisal – branchOfficeId – branchOfficeName – headquarterId – headquarterName – employeeId – employeeName – employeeEntryNumber – employeeAppraisalCycle properties: id: type: string description: Código da meta description: type: string description: Descrição da meta direction: #/definitions/goalDirectionType measureUnitType: #/definitions/measureUnitType weight: type: number description: Peso da meta format: double minimumValue: type: number description: Valor mínimo da meta format: double idealValue: type: number description: Valor ideal da meta format: double maximumValue: type: number description: Valor máximo da meta format: double goalResult: type: number description: Resultado da meta format: double percentageOfAchievement: type: number description: Percentual de atingimento da meta format: double percentageOfAchievementAppraisal: type: number description: Percentual de atingimento da avaliação format: double branchOfficeId: type: string description: Código da filial branchOfficeName: type: string description: Nome da filial headquarterId: type: string description: Código da matriz headquarterName: type: string description: Nome da matriz employeeId: type: string description: Código do colaborador employeeName: type: string description: Nome completo do colaborador employeeEntryNumber: #/definitions/employeeEntryNumber employeeAppraisalCycle: #/definitions/cycleRecord ordination: type: object required: – field properties: field: type: string description: Campo que será ordenado order: #/definitions/directionType pagination: type: object required: – offset – size properties: offset: type: integer description: Página de inicio size: type: integer description: Quantidade de registros por página searchedData: type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Id do registro 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