2.0info: 1.1.0 (PRIVATE) – 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: api.senior.com.br /private/mega/index_datalakesecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /getMetadata: post: description: Default 'getMetadata' query. Every service must handle this command and return metadata in the format requested. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: 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. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: default: description: Error response schema: #/definitions/genericError /listEnterpriseKind: post: description: Listagem dos tipos de empreendimentos distintos
–
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/dataEnterpriseKind 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Listagem dos tipos de empreendimentos distintos
–
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/dataEnterpriseKind 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /clearStructures: post: description: Remove todas as estruturas de dados, menos os tipos explicitamente marcados como 'false' x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: dataset: type: boolean description: Remover datasets analytics: type: boolean description: Remover analytics page: type: boolean description: Remover páginas landingpage: type: boolean description: Remover landing pages responses: 200: description: Ok schema: type: object required: – datasetCount – analyticsCount – pageCount – landingpageCount properties: datasetCount: type: integer description: Datasets removidos analyticsCount: type: integer description: Analytics removidos pageCount: type: integer description: Páginas removidas landingpageCount: type: integer description: Landing pages removidas default: description: Error response schema: #/definitions/genericError /listStates: post: description: Nome dos estados
## Resource:
- res://senior.com.br/mega/index_datalake/dm/contracts_states_primitive
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/dataStates 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Nome dos estados
## Resource:
- res://senior.com.br/mega/index_datalake/dm/contracts_states_primitive
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/dataStates 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /recreateStructures: post: description: Recria todas as estruturas de dados x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenant properties: removeBefore: type: boolean description: Remover estruturas antes recreateShared: type: boolean description: Remover estruturas antes recreateAnonymous: type: boolean description: Remover estruturas antes tenant: type: string description: Tenant para recriar a esrutura filter: type: array items: type: string description: Filtra quais datasets criar responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceStarted: post: description: Default 'serviceStarted' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: service: type: string description: responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /notifyUserEvent: post: description: Default 'notifyUser' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/notifyUserEventPayload responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: userNotificationKind: type: string enum: – Operational – Management – News userNotificationPriority: type: string enum: – Error – Alert – None dataStates: type: object required: – states properties: states: type: string description: Estados dataEnterpriseKind: type: object required: – enterpriseKind properties: enterpriseKind: type: string description: notifyUserEventPayload: type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: #/definitions/userNotificationKind notificationPriority: #/definitions/userNotificationPriority 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 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