2.0info: 0.0.3 hcm_java_compatibility_bridge description: HCM Java Compatibility Bridge x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: hcm_java_compatibility_bridge 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: /hcm_java_compatibility_bridge/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/healthcheckDTO 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/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hcm_java_compatibility_bridge/queries/getWorkstationGroupSubordinatesToActiveEmployee: post: description: Retorna os postos de trabalhos subordinados a um usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getWorkstationGroupSubordinatesToActiveEmployeeDTO responses: 200: description: Ok schema: type: object required: – workstationGroupIds properties: workstationGroupIds: type: array items: type: string minimum: 1 description: Postos de trabalhos subordinados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os postos de trabalhos subordinados a um usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: considerEmployer description: Indica se a empresa empregadora do colaborador associado ao usuário deve ser considera na busca in: query type: boolean – name: onlyDirects description: Considera apenas liderados diretos in: query type: boolean – name: onlyLeaders description: Considera apenas gestores in: query type: boolean – name: returnThemselves description: Considera se deve retornar o próprio posto do colaborador na busca in: query type: boolean responses: 200: description: Ok schema: type: object required: – workstationGroupIds properties: workstationGroupIds: type: array items: type: string minimum: 1 description: Postos de trabalhos subordinados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hcm_java_compatibility_bridge/queries/listEmployeeContractEvaluations: post: description: Retorna as avaliações de contrato de um colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: string description: Filtro a ser aplicado na consulta responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/employeeContractEvaluationDTO minimum: 1 description: Lista de avaliações de contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as avaliações de contrato de um colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtro a ser aplicado na consulta in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/employeeContractEvaluationDTO minimum: 1 description: Lista de avaliações de contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hcm_java_compatibility_bridge/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 /hcm_java_compatibility_bridge/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/genericErrordefinitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Nome do status getWorkstationGroupSubordinatesToActiveEmployeeDTO: description: DTO da primitiva getWorkstationGroupSubordinatesToActiveEmployee type: object properties: considerEmployer: type: boolean description: Indica se a empresa empregadora do colaborador associado ao usuário deve ser considera na busca default: true onlyDirects: type: boolean description: Considera apenas liderados diretos default: true onlyLeaders: type: boolean description: Considera apenas gestores default: false returnThemselves: type: boolean description: Considera se deve retornar o próprio posto do colaborador na busca default: false employeeContractEvaluationDTO: description: DTO de retorno da primitiva listEmployeeContractEvaluations type: object required: – evaluatorName – evaluationStatus – evaluationDate – evaluationLimitDate properties: evaluatorName: type: string description: Nome do avaliador evaluationStatus: type: string description: Status da avaliação evaluationDate: type: string format: date description: Data da avaliação evaluationLimitDate: type: string format: date description: Data limite da avaliação 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. 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