Datalake (datalake)

2.0info: 4.0.3 Datalake description: Datalake da Senior x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: datalake 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/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /datalake/queries/listStateProvince: post: description: API DEPRECIADA: Não deveria estar neste serviço | DATA: 2025-08-01 | Lista todos os estados do brasil tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/autoCompleteRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/listInformation 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake/queries/listCity: post: description: API DEPRECIADA: Não deveria estar neste serviço | DATA: 2025-08-01 | Lista todas as cidades do brasil tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/cityAutoCompleteRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/listInformation 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake/queries/listDistrict: post: description: API DEPRECIADA: Não deveria estar neste serviço | DATA: 2025-08-01 | Lista todos os bairros do brasil tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/districtAutoCompleteRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/listInformation 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake/queries/getDatasetData: post: description: API DEPRECIADA: Não deveria estar neste serviço | DATA: 2025-08-01 | Obtem os dados de um dataset do datalake e devolve como JSON tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getDatasetDataRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/getDatasetDataResponse 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake/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 /datalake/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 /datalake/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 /datalake/actions/requestUpload: post: description: Inicia o processo de envio do arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/uploadRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/requestUploadResponse 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake/actions/completeUpload: post: description: Finaliza o processo de envio do arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/uploadRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/completeUploadResponse 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake/actions/validateUpload: post: description: Finaliza o processo de envio do arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/uploadRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/validateUploadResponse 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake/actions/pipelineStart: post: description: Inicia a execução sob demanda de uma pipeline tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pipelineStartRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/pipelineStartResponse 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake/actions/pipelineStop: post: description: Finaliza a execução sob demanda de uma pipeline tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pipelineStopRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/pipelineStopResponse 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake/actions/pipelineCheck: post: description: Verifica a execução sob demanda de uma pipeline tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pipelineCheckRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/pipelineCheckResponse 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake/actions/pipelineDone: post: description: Método chamado por função Lambda quando termina a chamada de inferência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName – executionId – userName – pipelineStatus properties: tenantName: type: string description: Nome do tenant executionId: type: string description: ID da execução perante AWS userName: type: string description: Nome do usuário pipelineStatus: type: string description: Status errorMessage: type: string description: Mensagem de erro responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: 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 healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim datePeriod: description: Período de datas type: object required: – beginDate – endDate properties: beginDate: type: string format: date description: Data de incial do período endDate: type: string format: date description: Data de final do período pipelineStartRequest: description: Requisição para iniciar execução sob demanda de uma pipeline type: object required: – baseName properties: baseName: type: string description: Nome da base aqual o pipeline deve ser executado codeCli: type: string description: Código do cliente perante a base de clientes da Senior datePeriod: type: object allOf: – #/definitions/datePeriod description: Nome do arquivo completo com diretório conforme documentação do datalake pipelineStartResponse: description: Resposta da requisição para iniciar execução sob demanda de uma pipeline type: object required: – executionId properties: executionId: type: string description: ID da execução perante AWS pipelineStopRequest: description: Requisição para parar a execução sob demanda de uma pipeline allOf: – #/definitions/pipelineCheckRequest – type: object pipelineStopResponse: description: Resposta da requisição para parar a execução sob demanda de uma pipeline allOf: – #/definitions/pipelineCheckResponse – type: object pipelineCheckRequest: description: Requisição para verificar a execução sob demanda de uma pipeline discriminator: _discriminator type: object required: – baseName – executionId – _discriminator properties: baseName: type: string description: Nome da base aqual o pipeline deve ser executado executionId: type: string description: ID da execução perante AWS _discriminator: type: string description: pipelineCheckResponse: description: Resposta da requisição para verificar a execução sob demanda de uma pipeline discriminator: _discriminator type: object required: – status – startDate – stopDate – _discriminator properties: status: type: string description: Status da execução perante AWS startDate: type: string format: date-time description: Data/hora de inicio da execução stopDate: type: string format: date-time description: Data/hora da parada da execução _discriminator: type: string description: listInformation: description: Paginação discriminator: _discriminator type: object required: – totalElements – totalPages – contents – _discriminator properties: totalElements: type: integer format: int64 description: Total de elementos existentes totalPages: type: integer format: int64 description: Total de páginas disponíveis contents: type: string format: byte description: Conteúdo _discriminator: type: string description: autoCompleteRequest: description: Dados para requisitar dados por autocomlete discriminator: _discriminator type: object required: – _discriminator properties: offset: type: integer format: int64 description: Página size: type: integer format: int64 description: Máximo de registros orderBy: type: string description: Forma de ordenação filter: type: string description: Filtro de busca columns: type: array items: type: string description: Colunas _discriminator: type: string description: cityAutoCompleteRequest: description: Dados para requisitar dados por autocomlete (junto com o ID do estado) allOf: – #/definitions/autoCompleteRequest – type: object properties: idStateIbge: type: string description: Id do estado no IBGE para utilizar na filtragem districtAutoCompleteRequest: description: Dados para requisitar dados por autocomlete (junto com o ID da cidade) allOf: – #/definitions/autoCompleteRequest – type: object properties: idCity: type: string description: Id da cidade para utilizar na filtragem uploadRequest: description: Requisição de upload de arquivo para o datalake type: object required: – codeCli – baseName – fileName properties: codeCli: type: string description: Código do cliente perante a base de clientes da Senior baseName: type: string description: Nome da base aqual o arquivo deve ser enviado fileName: type: string description: Nome do arquivo completo com diretório conforme documentação do datalake uploadResponse: description: Resposta da requisição de upload/complete de arquivo para o datalake discriminator: _discriminator type: object required: – statusCode – success – _discriminator properties: statusCode: type: integer format: int64 description: Código da resposta HTTP do serviço AWS success: type: boolean description: Tudo ocorreu com sucesso _discriminator: type: string description: requestUploadResponse: description: Resposta da requisição de upload de arquivo para o datalake allOf: – #/definitions/uploadResponse – type: object required: – url properties: url: type: string description: Mensagem do serviço AWS completeUploadResponse: description: Resposta da requisição de complete de arquivo para o datalake allOf: – #/definitions/uploadResponse – type: object required: – message – data properties: message: type: string description: Mensagem do serviço AWS data: type: string format: byte description: Dados do arquivo validateUploadResponse: description: Resposta da requisição de complete de arquivo para o datalake allOf: – #/definitions/completeUploadResponse – type: object getDatasetDataRequest: description: Requisição de dados de um dataset do datalake allOf: – #/definitions/autoCompleteRequest – type: object required: – domain – service – datasetId properties: domain: type: string description: Dominio do dataset service: type: string description: Serviço do dataset datasetId: type: string description: ID do dataset getDatasetDataResponse: description: Resposta da requisição de dados de um dataset do datalake allOf: – #/definitions/listInformation – type: object required: – datasetId properties: datasetId: type: string description: ID do dataset 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 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: Status 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