2.0info: 6.1.0 Customização de Regras x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: rules 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: /rules/queries/healthcheck: post: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getExtension: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – domain – service – extensionPoint properties: domain: type: string description: service: type: string description: extensionPoint: type: string description: responses: 200: description: Ok schema: type: object required: – extension properties: extension: type: object allOf: – #/definitions/extension description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: domain description: in: query required: true type: string – name: service description: in: query required: true type: string – name: extensionPoint description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – extension properties: extension: type: object allOf: – #/definitions/extension description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getEndpoint: post: description: Returns the endpoint of a domain/service/primitive.\nIf registered is set to true, the endpoint will be returned only if it has a registered extension.\nIf registered is set to false, the endpoint will be returned only if it does not have a registered extension.\nPlease notice that a disabled extension will be considered a registered extension tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – domain – service – primitive – registered properties: domain: type: string description: service: type: string description: primitive: type: string description: registered: type: boolean description: responses: 200: description: Ok schema: type: object required: – endpoint properties: endpoint: type: object allOf: – #/definitions/rulePoint description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns the endpoint of a domain/service/primitive.\nIf registered is set to true, the endpoint will be returned only if it has a registered extension.\nIf registered is set to false, the endpoint will be returned only if it does not have a registered extension.\nPlease notice that a disabled extension will be considered a registered extension tags: – Queries x-senior-visibility: PUBLIC parameters: – name: domain description: in: query required: true type: string – name: service description: in: query required: true type: string – name: primitive description: in: query required: true type: string – name: registered description: in: query required: true type: boolean responses: 200: description: Ok schema: type: object required: – endpoint properties: endpoint: type: object allOf: – #/definitions/rulePoint description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getExtensionPoint: post: description: Returns the extensionPoint of a domain/service/primitive.\nIf registered is set to true, the extensionPoint will be returned only if it has a registered extension.\nIf registered is set to false, the extensionPoint will be returned only if it does not have a registered extension.\nPlease notice that a disabled extension will be considered a registered extension tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – domain – service – primitive – registered properties: domain: type: string description: service: type: string description: primitive: type: string description: registered: type: boolean description: responses: 200: description: Ok schema: type: object required: – extensionPoint properties: extensionPoint: type: object allOf: – #/definitions/rulePoint description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns the extensionPoint of a domain/service/primitive.\nIf registered is set to true, the extensionPoint will be returned only if it has a registered extension.\nIf registered is set to false, the extensionPoint will be returned only if it does not have a registered extension.\nPlease notice that a disabled extension will be considered a registered extension tags: – Queries x-senior-visibility: PUBLIC parameters: – name: domain description: in: query required: true type: string – name: service description: in: query required: true type: string – name: primitive description: in: query required: true type: string – name: registered description: in: query required: true type: boolean responses: 200: description: Ok schema: type: object required: – extensionPoint properties: extensionPoint: type: object allOf: – #/definitions/rulePoint description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getEndpointExtension: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – domain – service – endpoint properties: domain: type: string description: service: type: string description: endpoint: type: string description: responses: 200: description: Ok schema: type: object required: – endpointExtension properties: endpointExtension: type: object allOf: – #/definitions/endpointExtension description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: domain description: in: query required: true type: string – name: service description: in: query required: true type: string – name: endpoint description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – endpointExtension properties: endpointExtension: type: object allOf: – #/definitions/endpointExtension description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getEndpointExtensions: post: description: Returns all endpoint extensions associated with the given domain and service. tags: – Queries x-senior-visibility: PUBLIC parameters: – 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 schema: type: object required: – endpointExtensions properties: endpointExtensions: type: array items: type: object allOf: – #/definitions/endpointExtension minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns all endpoint extensions associated with the given domain and service. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: domain description: in: query required: true type: string – name: service description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – endpointExtensions properties: endpointExtensions: type: array items: type: object allOf: – #/definitions/endpointExtension minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getEndpointExtensionById: post: description: Returns an endpoint extension based on its id. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: responses: 200: description: Ok schema: type: object allOf: – #/definitions/endpointExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns an endpoint extension based on its id. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/endpointExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getHistoryAmountAllowed: post: description: Returns how many history record the service will storage per customization tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – amount properties: amount: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns how many history record the service will storage per customization tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – amount properties: amount: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getExecutionHistory: post: description: Returns the result of past extension calls. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – domain – service – primitive – page – size properties: domain: type: string description: service: type: string description: primitive: type: string description: page: type: integer format: int64 description: size: type: integer format: int64 description: onlyError: type: boolean description: default: false filter: type: object allOf: – #/definitions/historyFilters description: Search filters responses: 200: description: Ok schema: type: object required: – history – count properties: history: type: array items: type: object allOf: – #/definitions/result minimum: 1 description: count: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getExtensionMetrics: post: description: Returns the metrics of the extensions belonging to the extension points that match the filter. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: domain: type: string description: service: type: string description: primitive: type: string description: responses: 200: description: Ok schema: type: object required: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/extensionMetrics minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns the metrics of the extensions belonging to the extension points that match the filter. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: domain description: in: query type: string – name: service description: in: query type: string – name: primitive description: in: query type: string responses: 200: description: Ok schema: type: object required: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/extensionMetrics minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getEndpointExtensionMetrics: post: description: Returns the metrics of the extensions belonging to the endpoints that match the filter. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: domain: type: string description: service: type: string description: primitive: type: string description: responses: 200: description: Ok schema: type: object required: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/endpointExtensionMetrics minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns the metrics of the extensions belonging to the endpoints that match the filter. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: domain description: in: query type: string – name: service description: in: query type: string – name: primitive description: in: query type: string responses: 200: description: Ok schema: type: object required: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/endpointExtensionMetrics minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getExtensionStatistics: post: description: Returns the extensions statistics filtering by period tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – extensionId – since properties: extensionId: type: string description: The extension identifier since: type: string format: date-time description: The start of period until: type: string format: date-time description: The end of period. The default value considers now responses: 200: description: Ok schema: type: object required: – statistics properties: statistics: type: object allOf: – #/definitions/extensionStatistics description: Aggregated statistics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns the extensions statistics filtering by period tags: – Queries x-senior-visibility: PUBLIC parameters: – name: extensionId description: The extension identifier in: query required: true type: string – name: since description: The start of period in: query required: true type: string format: date-time – name: until description: The end of period. The default value considers now in: query type: string format: date-time responses: 200: description: Ok schema: type: object required: – statistics properties: statistics: type: object allOf: – #/definitions/extensionStatistics description: Aggregated statistics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getUsageLimits: post: description: list all limits and uses of the service tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – usage – maxRequests properties: usage: type: array items: type: object allOf: – #/definitions/usageLimit minimum: 1 description: Get service usage limits maxRequests: type: integer format: int64 description: The max quantity of requests allowed per second. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: list all limits and uses of the service tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – usage – maxRequests properties: usage: type: array items: type: object allOf: – #/definitions/usageLimit minimum: 1 description: Get service usage limits maxRequests: type: integer format: int64 description: The max quantity of requests allowed per second. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getEndpointDocumentation: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – domain – service – primitive – url – protocol – method properties: domain: type: string description: service: type: string description: primitive: type: string description: url: type: string description: protocol: type: string allOf: – #/definitions/protocol description: method: type: string allOf: – #/definitions/method description: responses: 200: description: Ok schema: type: object required: – documentation properties: documentation: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getExtensionPointDocumentation: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – domain – service – protocol – extensionPoint – url properties: domain: type: string description: service: type: string description: protocol: type: string allOf: – #/definitions/protocol description: extensionPoint: type: string description: url: type: string description: responses: 200: description: Ok schema: type: object required: – documentation properties: documentation: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/listDomains: post: description: Lists all domains that are registered. The results are ordered alphabetically. tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – domains properties: domains: type: array items: type: string minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lists all domains that are registered. The results are ordered alphabetically. tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – domains properties: domains: type: array items: type: string minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/listServices: post: description: Lists all services of the given domain. The results are ordered alphabetically. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – domain properties: domain: type: string description: responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: string minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lists all services of the given domain. The results are ordered alphabetically. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: domain description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: string minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/searchExtensionPoints: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – query properties: query: type: string description: responses: 200: description: Ok schema: type: object required: – extensionPoints properties: extensionPoints: type: array items: type: object allOf: – #/definitions/rulePoint minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: query description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – extensionPoints properties: extensionPoints: type: array items: type: object allOf: – #/definitions/rulePoint minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/searchEndpoints: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – query properties: query: type: string description: responses: 200: description: Ok schema: type: object required: – endpoints properties: endpoints: type: array items: type: object allOf: – #/definitions/rulePoint minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: query description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – endpoints properties: endpoints: type: array items: type: object allOf: – #/definitions/rulePoint minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getThrottlingConfiguration: post: description: Returns the throttling configuration defined by the master tenant tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – maxRequests properties: maxRequests: type: integer format: int64 description: The max quantity of requests allowed per second. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns the throttling configuration defined by the master tenant tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – maxRequests properties: maxRequests: type: integer format: int64 description: The max quantity of requests allowed per second. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/getHistoryPayload: post: description: Returns the payload of a given history tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: historyId: type: string description: The history id to search the payload responses: 200: description: Ok schema: type: object required: – id – historyId – input – output properties: id: type: string description: payload identifier historyId: type: string description: history identifier input: type: string description: the customization input output: type: string description: the customization output 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns the payload of a given history tags: – Queries x-senior-visibility: PUBLIC parameters: – name: historyId description: The history id to search the payload in: query type: string responses: 200: description: Ok schema: type: object required: – id – historyId – input – output properties: id: type: string description: payload identifier historyId: type: string description: history identifier input: type: string description: the customization input output: type: string description: the customization output 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/listActiveCustomizations: post: description: Lista as customizações ativas de todos os tenants tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: Domínio para pesquisar service: type: string description: Serviço para pesquisar primitives: type: array items: type: string description: Primitivas para pesquisar responses: 200: description: Ok schema: type: object properties: enabledEndpoints: type: array items: type: object allOf: – #/definitions/tenantEndpoints description: Customizações ativas encontradas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as customizações ativas de todos os tenants tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domain description: Domínio para pesquisar in: query required: true type: string – name: service description: Serviço para pesquisar in: query required: true type: string – name: primitives description: Primitivas para pesquisar in: query type: array items: type: string responses: 200: description: Ok schema: type: object properties: enabledEndpoints: type: array items: type: object allOf: – #/definitions/tenantEndpoints description: Customizações ativas encontradas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/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 /rules/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 /rules/actions/setExtensionEnabled: post: description: Set if the extension is going to be enabled or disabled. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – enabled properties: id: type: string description: The id of the extension to enabled/disabled. enabled: type: boolean description: True to enable the extension, false otherwise. responses: 200: description: Ok schema: type: object required: – previousState properties: previousState: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/setEndpointExtensionEnabled: post: description: Set if the extension is going to be enabled or disabled. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – enabled properties: id: type: string description: The id of the extension to enabled/disabled. enabled: type: boolean description: True to enable the extension, false otherwise. responses: 200: description: Ok schema: type: object required: – previousState properties: previousState: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/consolidateStatistics: post: description: Persist the statics tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – statistic properties: statistic: type: array items: type: object allOf: – #/definitions/statisticToPersist minimum: 1 description: Statistic items to persist responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: True if ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/testUrlConnection: post: description: Requests given URL using bridge, following same path that is used by a custom rule tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – url – protocol properties: url: type: string description: The URL that will be requested protocol: type: string allOf: – #/definitions/protocol description: The protocol to make the request responses: 200: description: Ok schema: type: object required: – status – message properties: status: type: integer format: int64 description: The status returned by request message: type: string description: The message returned by request 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/enableAllEndpoints: post: description: Enable all endpoints tags: – Actions x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: The value of the process, true only if all of them were enabled with success. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/disableAllEndpoints: post: description: Disable all endpoints tags: – Actions x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: The value of the process, true only if all of them were disabled with success. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/enableAllExtensionPoints: post: description: Enable all extension points tags: – Actions x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: The value of the process, true only if all of them were enabled with success. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/disableAllExtensionPoints: post: description: Disable all extension points tags: – Actions x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: The value of the process, true only if all of them were disabled with success. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/getTenantTotalRequests: post: description: Cria relatório com informações do mês corrente de todas requisições as regras com sucesso por tenant tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – totalTenantRequests properties: totalTenantRequests: type: array items: type: object allOf: – #/definitions/totalTenantRequests minimum: 1 description: Lista de totais de requisições com sucesso por tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/recreateBindings: post: description: Try recreate bindings for endpoints tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: Tenant for recreate responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/migrateUrls: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – toMigrate properties: toMigrate: type: array items: type: object allOf: – #/definitions/urlMigration minimum: 1 description: responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/signals/updateAllExtensionPoints: post: description: Updates all extension points from a service, reading its metadata in order to do it. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: service: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /rules/events/endpointCustomizationStatusChanged: post: description: Evento publicado quando a customização de um endpoint é ativada ou desativada. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenants properties: enabledEndpoints: type: array items: type: object allOf: – #/definitions/endpointId description: Endpoints com customizações ativas. disabledEndpoints: type: array items: type: object allOf: – #/definitions/endpointId description: Endpoints com customizações inativas. tenants: type: array items: type: string minimum: 1 description: Tenants para os quais os endpoints foram ativados/desativados. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /rules/entities/extension: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/extension responses: 200: description: The created resource schema: #/definitions/extension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/extension responses: 200: description: The created resource schema: #/definitions/extension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/extension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/extension/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/extension responses: 200: description: Ok schema: #/definitions/extension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/extension responses: 200: description: Ok schema: #/definitions/extension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/extension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/extension/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/extension responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/endpointExtension: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/endpointExtension responses: 200: description: The created resource schema: #/definitions/endpointExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/endpointExtension responses: 200: description: The created resource schema: #/definitions/endpointExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/endpointExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/endpointExtension/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/endpointExtension responses: 200: description: Ok schema: #/definitions/endpointExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/endpointExtension responses: 200: description: Ok schema: #/definitions/endpointExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/endpointExtension 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/endpointExtension/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/endpointExtension responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN method: description: type: string enum: – BEFORE – AROUND – AFTER – WEB_HOOK – EXTENSION_POINT protocol: description: type: string enum: – SOAP_11 – REST rulePointType: description: type: string enum: – ACTION – EVENT – QUERY – SIGNAL historyType: description: type: string enum: – SUCCESS – ERROR – NONE – ALL availability: description: type: string enum: – PUBLIC – PRIVATE 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 checkDTO: description: Itens verificados no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthCheckStatus description: Status statisticToPersist: description: type: object required: – tenant – idExtension – status – bytes – duration properties: tenant: type: string description: idExtension: type: string description: status: type: integer format: int64 description: bytes: type: integer format: int64 description: duration: type: integer format: int64 description: log: description: type: object required: – user – when properties: user: type: string description: when: type: string format: date-time description: rulePoint: description: type: object required: – domain – service – name properties: domain: type: string description: service: type: string description: name: type: string description: type: type: string allOf: – #/definitions/rulePointType description: Tipo de endpoint documentation: type: string description: Documentação deste ponto de regra/funcionalidade availability: type: string allOf: – #/definitions/availability description: A disponibilidade deste endpoint deprecatedRemoval: type: string format: date description: Data quando a funcionalidade deprecada será removida extensionMetrics: description: type: object required: – extension – successExecutions – failedExecutions – totalExecutions properties: extension: type: object allOf: – #/definitions/extension description: successExecutions: type: integer format: int64 description: failedExecutions: type: integer format: int64 description: totalExecutions: type: integer format: int64 description: endpointExtensionMetrics: description: type: object required: – endpointExtension – successExecutions – failedExecutions – totalExecutions properties: endpointExtension: type: object allOf: – #/definitions/endpointExtension description: successExecutions: type: integer format: int64 description: failedExecutions: type: integer format: int64 description: totalExecutions: type: integer format: int64 description: extensionStatistics: description: A detailed representation of a extensions execution type: object required: – success – clientError – serverError – total properties: success: type: object allOf: – #/definitions/statisticAggregation description: The aggregation about requests made successfully clientError: type: object allOf: – #/definitions/statisticAggregation description: The aggregation about requests with a client error (4xx) serverError: type: object allOf: – #/definitions/statisticAggregation description: The aggregation about requests with a server error (5xx) total: type: object allOf: – #/definitions/statisticAggregation description: The aggregation about all requests statisticAggregation: description: The aggregation type: object required: – totalRequests – maxDuration – minDuration – averageDuration – maxSize – minSize – averageSize properties: totalRequests: type: integer format: int64 description: Total quantity of requests maxDuration: type: integer format: int64 description: The maximum during time of requests in millisecond minDuration: type: integer format: int64 description: The minimum during time of requests in millisecond averageDuration: type: integer format: int64 description: The average during time of requests in milliseconds maxSize: type: integer format: int64 description: The maximum size of requests payload in bytes minSize: type: integer format: int64 description: The minimum size of requests payload in bytes averageSize: type: integer format: int64 description: The average size of requests payload in bytes usageLimit: description: A detailed representation of service usage limit type: object required: – limit – usage – label properties: limit: type: number format: double description: service limit usage: type: number format: double description: The amount used by the service label: type: string description: The limit label header: description: type: object required: – name – value properties: name: type: string description: value: type: string description: environmentVariable: description: type: object required: – name – value properties: name: type: string description: value: type: string description: headers: description: type: object required: – user – tenant – timeout properties: user: type: boolean description: tenant: type: boolean description: timeout: type: boolean description: token: type: boolean description: custom: type: array items: type: object allOf: – #/definitions/header description: historyFilters: description: type: object properties: since: type: string format: date-time description: The start of period until: type: string format: date-time description: The end of period. The default value considers now term: type: string description: The term for filter in payload result: description: type: object required: – id – success – status – errorMessage – start – end – duration – bytesSent – bytesReceived – headers – url properties: id: type: string description: success: type: boolean description: status: type: integer format: int64 description: errorMessage: type: string description: start: type: string format: date-time description: end: type: string format: date-time description: duration: type: integer format: int64 description: bytesSent: type: integer format: int64 description: The quantity of bytes sent to custom service bytesReceived: type: integer format: int64 description: The quantity of bytes received to custom service headers: type: array items: type: object allOf: – #/definitions/header minimum: 1 description: url: type: string description: Customization url urlMigration: description: type: object required: – service – domain – primitive – url properties: service: type: string description: domain: type: string description: primitive: type: string description: url: type: string description: extension: description: type: object required: – extensionPoint – protocol – url – headers properties: id: type: string description: extensionPoint: type: object allOf: – #/definitions/rulePoint description: enabled: type: boolean description: A read only field. To set this attribute, use setExtensionEnabled primitive protocol: type: string allOf: – #/definitions/protocol description: tags: type: array items: type: string description: url: type: string description: description: type: string maxLength: 2000 description: A customizations description. Usually holds the reason about customization and any relevant information created: type: object allOf: – #/definitions/log description: updated: type: object allOf: – #/definitions/log description: headers: type: object allOf: – #/definitions/headers description: environmentVariables: type: array items: type: object allOf: – #/definitions/environmentVariable description: Definição das variáveis de ambiente user: type: string description: Usuário (sem @dominio) especifico para esse ponto de regra historyType: type: string allOf: – #/definitions/historyType description: History type that the service must keep for this extension with default value NONE accessKey: type: string description: An AccessKey that grants access to the API Gateway endpointExtension: description: type: object required: – endpoint – protocol – method – url – headers properties: id: type: string description: endpoint: type: object allOf: – #/definitions/rulePoint description: enabled: type: boolean description: A read only field. To set this attribute, use setEndpointExtensionEnabled primitive protocol: type: string allOf: – #/definitions/protocol description: method: type: string allOf: – #/definitions/method description: url: type: string description: tags: type: array items: type: string description: description: type: string maxLength: 2000 description: A customizations description. Usually holds the reason about customization and any relevant information created: type: object allOf: – #/definitions/log description: updated: type: object allOf: – #/definitions/log description: headers: type: object allOf: – #/definitions/headers description: environmentVariables: type: array items: type: object allOf: – #/definitions/environmentVariable description: Definição das variáveis de ambiente user: type: string description: Usuário (sem @dominio) especifico para esse ponto de regra historyType: type: string allOf: – #/definitions/historyType description: History type that the service must keep for this extension with default value NONE sendInput: type: boolean description: Send input payload if method is AFTER default: false accessKey: type: string description: An AccessKey that grants access to the API Gateway totalTenantRequests: description: informações do total de requisições com sucesso do tenant type: object required: – tenant – totalSuccess – totalError properties: tenant: type: string description: Nome do tenant totalSuccess: type: integer format: int64 description: Total de requisições do mês totalError: type: integer format: int64 description: Total de requisições com Erro do mês endpointId: description: Identificador do endpoint type: object required: – domain – service – name properties: domain: type: string description: Domínio do endpoint service: type: string description: Serviço do endpoint name: type: string description: Nome do endpoint tenantEndpoints: description: Endpoints do tenant type: object required: – tenant properties: tenant: type: string description: Tenant endpoints: type: array items: type: object allOf: – #/definitions/endpointId description: Endpoints do tenant 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