managementtrainingintegration

2.0info: 1.0.3 managementtrainingintegration description: Management Training Processor x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: managementtrainingintegration 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: /managementtrainingintegration/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 /managementtrainingintegration/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 /managementtrainingintegration/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 /managementtrainingintegration/actions/saveEmployeeIntegration: post: description: Persiste o colaborador recebido via integração tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – employeeIntegration properties: employeeIntegration: type: object allOf: – #/definitions/saveEmployeeIntegrationDTO description: Informações do colaborador responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementtrainingintegration/actions/saveTrailLMS: post: description: Persiste a trilha recebida pelo LMS tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/saveTrailLMSDTO responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementtrainingintegration/actions/saveEmployeeLms: post: description: Persiste o colaborador recebido via LMS tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – employees properties: employees: type: array items: type: object allOf: – #/definitions/saveEmployeeLmsDTO minimum: 1 description: Lista de colaboradores responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementtrainingintegration/actions/updateEmployeeTrailStageLMS: post: description: Realiza a atualização das etapas e trilha do colaborador tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/updateEmployeeTrailStageLMSDTO responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /managementtrainingintegration/actions/removeEmployeeTrailLMS: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – lmsUserVecId properties: lmsUserVecId: type: integer format: int64 description: IDUsuarioVec trailId: type: integer format: int64 description: IDTrilha\nSe informado remove da trilha\nSe não informado remove de todas as trilhas associadas cause: type: string maxLength: 255 description: Motivo da remoção responses: 200: description: Ok schema: type: object 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 employeeOrigin: type: string enum: – AP – DIGITAL_ADMISSION – LMS description: Origem do colaborador: * `AP` – Administração de Pessoal * `DIGITAL_ADMISSION` – Admissão Digital * `LMS` – Konviva companyOrigin: type: string enum: – AP – DIGITAL_ADMISSION – PAYROLL – LMS description: Origem dos dados de empresa: * `AP` – Administração de Pessoal * `DIGITAL_ADMISSION` – Admissão Digital * `PAYROLL` – Payroll – Gestão de Departamento Pessoal * `LMS` – Konviva situation: type: string enum: – ENABLED – DISABLED description: Situação: * `ENABLED` – Ativo * `DISABLED` – Inativo trailStatus: type: string enum: – NAO_INICIADO – EM_ANDAMENTO – EM_ATRASO – APROVADO_COM_ATRASO – APROVADO_ANTES_DO_PRAZO – APROVADO – NAO_SE_APLICA description: Status da trilha: * `NAO_INICIADO` – Não iniciado * `EM_ANDAMENTO` – Em andamento * `EM_ATRASO` – Em atraso * `APROVADO_COM_ATRASO` – Aprovado com atraso * `APROVADO_ANTES_DO_PRAZO` – Aprovado antes do prazo * `APROVADO` – Aprovado * `NAO_SE_APLICA` – Não se aplica trailStageStatus: type: string enum: – NAO_INICIADO – EM_ANDAMENTO – EM_ATRASO – CONCLUIDO_COM_ATRASO – CONCLUIDO_ANTES_DO_PRAZO – CONCLUIDO – NAO_REQUERIDO description: Status da etapa da trilha: * `NAO_INICIADO` – Não iniciado * `EM_ANDAMENTO` – Em andamento * `EM_ATRASO` – Em atraso * `CONCLUIDO_COM_ATRASO` – Concluído com atraso * `CONCLUIDO_ANTES_DO_PRAZO` – Concluído antes do prazo * `CONCLUIDO` – Concluído * `NAO_REQUERIDO` – Não requerido 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 saveEmployeeIntegrationDTO: description: DTO do colaborador recebido via integração type: object required: – employeeName – employeeDocument – employeePersonalEmail – admissionDate – employeeOrigin – externalId properties: employeeName: type: string maxLength: 255 description: Nome do colaborador employeeDocument: type: string maxLength: 255 description: Documento do colaborador employeePersonalEmail: type: string maxLength: 255 description: E-mail pessoal do colaborador employeeCorporateEmail: type: string maxLength: 255 description: E-mail corporativo do colaborador employeePhone: type: string maxLength: 255 description: Telefone do colaborador admissionDate: type: string format: date description: Data de admissão do colaborador integrationDate: type: string format: date description: Data de integração do colaborador employeeOrigin: type: string allOf: – #/definitions/employeeOrigin description: Serviço de origem do colaborador companyOrigin: type: string allOf: – #/definitions/companyOrigin description: Origem das informações de Empresa, Filial, etc do colaborador company: type: string maxLength: 255 description: Identificador da empresa companyName: type: string maxLength: 255 description: Nome da empresa branchOffice: type: string maxLength: 255 description: Identificador da filial branchOfficeName: type: string maxLength: 255 description: Nome da filial jobPosition: type: string maxLength: 255 description: Identificador do cargo jobPositionName: type: string maxLength: 255 description: Nome do cargo area: type: string maxLength: 255 description: Identificador do departamento areaName: type: string maxLength: 255 description: Nome do departamento workstationGroup: type: string maxLength: 255 description: Identificador do posto de trabalho workstationGroupName: type: string maxLength: 255 description: Nome do posto de trabalho costCenter: type: string maxLength: 255 description: Identificador do centro de custo costCenterName: type: string maxLength: 255 description: Nome do centro de custo externalId: type: string maxLength: 255 description: Identificador referente ao colaborador no sistema externo preOnboardingInviteModel: type: string description: Identificador do modelo de convite sendPreOnboardingOnCreate: type: boolean description: Enviar convite de pré-onboarding ao criar default: false saveTrailLMSDTO: description: DTO de persistencia da trilha type: object required: – trailId – trailName – situation properties: trailId: type: string maxLength: 255 description: Identificador da trilha no LMS trailName: type: string maxLength: 255 description: Nome da trilha trailCode: type: string maxLength: 255 description: Código da trilha situation: type: string allOf: – #/definitions/situation description: Situação imageUrl: type: string description: Imagem da trilha stages: type: array items: type: object allOf: – #/definitions/saveTrailStageLMSDTO description: Etapas da trilha saveTrailStageLMSDTO: description: DTO de persistencia da etapa da trilha type: object required: – stageId – stageDuration – order properties: stageId: type: string maxLength: 255 description: Identificador da etapa stageName: type: string maxLength: 255 description: Nome da etapa stageDuration: type: integer format: int64 description: Duração da etapa em dias order: type: integer format: int64 description: Ordem da etapa saveEmployeeLmsDTO: description: DTO do colaborador LMS type: object required: – lmsUserId – lmsUserVecId – lmsLogin – employeeName – employeeEmail – employeeDocument – trails properties: lmsUserId: type: integer format: int64 description: Identificador usuário lmsUserVecId: type: integer format: int64 description: Identificador usuário vec lmsLogin: type: string maxLength: 255 description: Login LMS employeeName: type: string maxLength: 255 description: Nome do colaborador employeeEmail: type: string maxLength: 255 description: Email do colaborador employeePhone: type: string maxLength: 255 description: Telefone do colaborador employeeDocument: type: string maxLength: 255 description: Documento do colaborador jobPosition: type: string maxLength: 255 description: Identificador do cargo admissionDate: type: string format: date description: Data de admissão lmsCreatedDate: type: string format: date description: Data de cadastro LMS integrationDate: type: string format: date description: Data de integração profileUnit: type: object allOf: – #/definitions/profileUnitUserDTO description: UnidadePerfil do usuário (apenas a principal) trails: type: array items: type: integer format: int64 minimum: 1 description: Lista de IDTrilha com as trilhas associadas ao colaborador profileUnitUserDTO: description: type: object properties: profileId: type: integer format: int64 description: ID do Perfil profileCode: type: string maxLength: 255 description: Código do Perfil unitId: type: integer format: int64 description: ID da Unidade updateEmployeeTrailStageLMSDTO: description: type: object required: – lmsUserVecId – trailId – stageId – stageStatus – stageProgress – stagePerformance – trailStatus – trailProgress – trailPerformance properties: lmsUserVecId: type: integer format: int64 description: IDUsuarioVec trailId: type: integer format: int64 description: IDTrilha stageId: type: integer format: int64 description: IDEtapa stageStatus: type: string allOf: – #/definitions/trailStageStatus description: Status da etapa, de acordo com a configuração da trilha stageProgress: type: integer format: int64 description: Andamento da etapa, de acordo com a configuração da trilha stagePerformance: type: integer format: int64 description: Aproveitamento da etapa, de acordo com a configuração da trilha trailStatus: type: string allOf: – #/definitions/trailStatus description: Status da trilha, de acordo com a configuração da trilha trailProgress: type: integer format: int64 description: Andamento da trilha, de acordo com a configuração da trilha trailPerformance: type: integer format: int64 description: Aproveitamento da trilha, de acordo com a configuração da trilha 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