2.0info: 0.6.2 careersfiles x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: careersfiles 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: /careersfiles/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 /careersfiles/queries/getFile: post: description: Obtém as informações de um arquivo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getFileDTO responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/fileDataDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém as informações de um arquivo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id do arquivo no blob service in: query required: true type: string – name: fileName description: Nome do arquivo in: query required: true type: string – name: serviceDomain description: Domínio do serviço que chamou a primitiva in: query type: string – name: serviceName description: Nome do serviço que chamou a primitiva in: query type: string responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/fileDataDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersfiles/queries/getS3File: post: description: Primitiva para retornar URL do arquivo salvo no Amazon S3 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filePath properties: filePath: type: string description: O caminho, incluindo o nome do arquivo, onde o arquivo está armazenado responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL de acesso ao arquivo default: description: Error response schema: #/definitions/genericError get: description: Primitiva para retornar URL do arquivo salvo no Amazon S3 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filePath description: O caminho, incluindo o nome do arquivo, onde o arquivo está armazenado in: query required: true type: string responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL de acesso ao arquivo default: description: Error response schema: #/definitions/genericError /careersfiles/queries/getS3FileByTenantAndIdentificationNumber: post: description: Primitiva para retornar URL de arquivo salvo no Amazon S3 pelo Tenant e número de identificação da empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getCompanyS3FileDTO responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL de acesso ao arquivo default: description: Error response schema: #/definitions/genericError get: description: Primitiva para retornar URL de arquivo salvo no Amazon S3 pelo Tenant e número de identificação da empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Tenant da empresa in: query required: true type: string – name: identificationNumber description: Número de identificação da empresa in: query required: true type: string – name: fileName description: Nome do arquivo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL de acesso ao arquivo default: description: Error response schema: #/definitions/genericError /careersfiles/queries/getS3FilesByTenantAndIdentificationNumber: post: description: Primitiva para retornar múltiplas URLs de arquivos salvos no Amazon S3 pelo Tenant e número de identificação da empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/getCompanyS3FileDTO minimum: 1 description: responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/s3FileDataDTO minimum: 1 description: default: description: Error response schema: #/definitions/genericError /careersfiles/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 /careersfiles/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 /careersfiles/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersfiles/actions/uploadFile: post: description: Upload de um arquivo fazendo ponte com o BlobService tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/uploadFileDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/fileDataDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersfiles/actions/deleteFile: post: description: Realiza a exclusão de um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getFileDTO responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersfiles/actions/uploadFileInS3: post: description: Upload de imagem para o Bucket S3 tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/uploadFileDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/fileDataDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN contentType: description: Status do healthcheck type: string enum: – IMAGE – DOCUMENT – VIDEO userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT uploadFileDTO: description: Informações do upload type: object required: – attachment – fileName – contentType properties: attachment: type: string description: Arquivo em base 64 fileName: type: string description: Nome do arquivo contentType: type: string allOf: – #/definitions/contentType description: Tipo do conteúdo a se fazer o upload style: type: string description: Reduzir imagem para o tamanho indicado (substitui o arquivo original): 32×32#, 50×50 onde o indica que a proporção de tela será mantida serviceDomain: type: string description: Domínio do serviço que chamou a primitiva default: hcm serviceName: type: string description: Nome do serviço que chamou a primitiva default: careersfiles fileDataDTO: description: Retorno do upload type: object required: – id – fileName – contentType – extension – size – url properties: id: type: string description: Id do arquivo salvo no blob service fileName: type: string description: Nome do arquivo contentType: type: string description: Tipo do arquivo extension: type: string description: Extensão do arquivo size: type: integer format: int64 description: Tamanho do arquivo url: type: string description: URL do arquivo 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/healthcheckDTO description: Status getFileDTO: description: DTO de requisição de consulta de arquivo type: object required: – id – fileName properties: id: type: string description: Id do arquivo no blob service fileName: type: string description: Nome do arquivo serviceDomain: type: string description: Domínio do serviço que chamou a primitiva default: hcm serviceName: type: string description: Nome do serviço que chamou a primitiva default: careersfiles getCompanyS3FileDTO: description: DTO que armazena informações para busca de arquivo da empresa no Amazon S3 discriminator: _discriminator type: object required: – tenant – identificationNumber – fileName – _discriminator properties: tenant: type: string description: Tenant da empresa identificationNumber: type: string description: Número de identificação da empresa fileName: type: string description: Nome do arquivo _discriminator: type: string description: s3FileDataDTO: description: DTO que armazena dados de acesso público ao arquivo no Amazon S3 allOf: – #/definitions/getCompanyS3FileDTO – type: object required: – url properties: url: type: string description: URL de acesso público ao arquivo 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 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