2.0info: 1.0.1 Data Filters description: Serviço de filtros dos projetos data-seniorx x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: data_filter 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: /data_filter/queries/listDomainFilters: post: description: Lista os filtros de dominio da abrangencia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: filtros responses: 200: description: Ok schema: type: object required: – results properties: results: type: string format: byte description: resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os filtros de dominio da abrangencia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: filtros in: query type: string responses: 200: description: Ok schema: type: object required: – results properties: results: type: string format: byte description: resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data_filter/queries/listDefinitions: post: description: Lista todas os filtros definidos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: shared: type: boolean description: indica se são de fabrica ou de tenant default: false filter: type: string description: filtros responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/definition minimum: 1 description: resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todas os filtros definidos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: shared description: indica se são de fabrica ou de tenant in: query type: boolean – name: filter description: filtros in: query type: string responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/definition minimum: 1 description: resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data_filter/queries/listDefinitionItems: post: description: Lista todos os items de uma definição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – definition_id properties: shared: type: boolean description: indica se são de fabrica ou de tenant default: false filter: type: string description: filtros definition_id: type: string description: id da definição responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/definitionItem minimum: 1 description: resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todos os items de uma definição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: shared description: indica se são de fabrica ou de tenant in: query type: boolean – name: filter description: filtros in: query type: string – name: definition_id description: id da definição in: query required: true type: string responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/definitionItem minimum: 1 description: resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data_filter/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 /data_filter/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 /data_filter/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 /data_filter/actions/saveDefinition: post: description: Salvar uma definição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: shared: type: boolean description: indica se é de fabrica ou de tenant default: false data: type: object allOf: – #/definitions/definition description: dados da definição responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/definition description: resultado do salvar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data_filter/actions/saveDefinitionItem: post: description: Salvar um item de definição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: shared: type: boolean description: indica se é de fabrica ou de tenant default: false data: type: object allOf: – #/definitions/definitionItem description: dados do item de definição responses: 200: description: Ok schema: type: object required: – results properties: results: type: object allOf: – #/definitions/definitionItem description: resultado do salvar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data_filter/actions/removeDefinition: post: description: Exclui uma definição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: shared: type: boolean description: indica se é de fabrica ou de tenant default: false id: type: string description: id da definição responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: resultado do excluir 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data_filter/actions/removeDefinitionItem: post: description: Exclui um item de definição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: shared: type: boolean description: indica se é de fabrica ou de tenant default: false id: type: string description: id do item de definição responses: 200: description: Ok schema: type: object required: – results properties: results: type: string description: resultado do excluir 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data_filter/actions/parseSQLDomainFilter: post: description: Processa os filtros de domninio em uma consulta SQL tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – sql properties: shared: type: boolean description: indica se é de fabrica ou de tenant default: false sql: type: string description: sql a ser processada responses: 200: description: Ok schema: type: object required: – results properties: results: type: string description: retorna a query processada 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 definition: description: Definição type: object required: – name – identifier properties: id: type: string description: chave primaria name: type: string description: nome da definição identifier: type: string description: identificador da definição definitionItem: description: Item de definição type: object required: – definitionId – subject – filter – viewName – fieldName properties: id: type: string description: chave primaria definitionId: type: string description: id da definição domainFilterId: type: string description: id do filtro de dominio subject: type: string description: assunto filter: type: string description: nome dos filtros viewName: type: string description: nome da view fieldName: type: string description: nome do campo alias: type: string description: apelido do campos 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