2.0info: 1.1.0 Datalake description: Mega Index Datalake x-senior-domain: mega x-senior-domain-path: mega x-senior-service-path: index_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/megasecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /index_datalake/queries/listStates: post: description: Nome dos estados\n \n ## Resource:\n – res://senior.com.br/mega/index_datalake/dm/contracts_states_primitive\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchTerm: type: string description: Filtro sobre a listagem de retorno responses: 200: description: Ok schema: type: object properties: data: type: array items: type: object allOf: – #/definitions/dataStates description: Lista das estados possíveis 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 get: description: Nome dos estados\n \n ## Resource:\n – res://senior.com.br/mega/index_datalake/dm/contracts_states_primitive\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchTerm description: Filtro sobre a listagem de retorno in: query type: string responses: 200: description: Ok schema: type: object properties: data: type: array items: type: object allOf: – #/definitions/dataStates description: Lista das estados possíveis 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 /index_datalake/queries/listEnterpriseKind: post: description: Listagem dos tipos de empreendimentos distintos\n -\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchTerm: type: string description: Filtro sobre a listagem de retorno responses: 200: description: Ok schema: type: object properties: data: type: array items: type: object allOf: – #/definitions/dataEnterpriseKind description: Lista dos tipos de empreendimento 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 get: description: Listagem dos tipos de empreendimentos distintos\n -\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchTerm description: Filtro sobre a listagem de retorno in: query type: string responses: 200: description: Ok schema: type: object properties: data: type: array items: type: object allOf: – #/definitions/dataEnterpriseKind description: Lista dos tipos de empreendimento 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 /index_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 /index_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 /index_datalake/actions/clearStructures: post: description: Remove todas as estruturas de dados, menos os tipos explicitamente marcados como false tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dataset: type: boolean description: Remover datasets default: true analytics: type: boolean description: Remover analytics default: true page: type: boolean description: Remover páginas default: true landingpage: type: boolean description: Remover landing pages default: true responses: 200: description: Ok schema: type: object required: – datasetCount – analyticsCount – pageCount – landingpageCount properties: datasetCount: type: integer format: int64 description: Datasets removidos analyticsCount: type: integer format: int64 description: Analytics removidos pageCount: type: integer format: int64 description: Páginas removidas landingpageCount: type: integer format: int64 description: Landing pages removidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /index_datalake/signals/recreateStructures: post: description: Recria todas as estruturas de dados tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenant properties: removeBefore: type: boolean description: Remover estruturas antes default: true recreateShared: type: boolean description: Remover estruturas antes default: true recreateAnonymous: type: boolean description: Remover estruturas antes default: true tenant: type: string description: Tenant para recriar a esrutura filter: type: array items: type: string description: Filtra quais datasets criar responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericErrordefinitions: 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 dataStates: description: Descrição dos estados type: object required: – states properties: states: type: string description: Estados dataEnterpriseKind: description: Descrição dos tipos de contrato type: object required: – enterpriseKind properties: enterpriseKind: type: string description: 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