rules

2.0info: 0.1.2 rules description: Cadastro Regras do WMS x-senior-domain: wms x-senior-domain-path: wms 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/wmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /rules/queries/getActiveRules: post: description: Retona as regras que estão ativas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: rules: type: array items: type: string description: Lista das Customizações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retona as regras que estão ativas tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object properties: rules: type: array items: type: string description: Lista das Customizações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/healthcheck: post: description: Verificação disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verificação disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/searchCustomService: post: description: Buscar as customizações dos pontos de extensão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: Filtrar por Ponto de Extensão showExtension: type: boolean description: Buscar Extensões default: true showEvent: type: boolean description: Buscar Eventos default: false responses: 200: description: Ok schema: type: object properties: extensions: type: array items: type: object allOf: – #/definitions/extension description: Lista as implementações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Buscar as customizações dos pontos de extensão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtrar por Ponto de Extensão in: query type: string – name: showExtension description: Buscar Extensões in: query type: boolean – name: showEvent description: Buscar Eventos in: query type: boolean responses: 200: description: Ok schema: type: object properties: extensions: type: array items: type: object allOf: – #/definitions/extension description: Lista as implementações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/listServices: post: description: Buscar os serviços para customização tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: Filtrar por Ponto de Extensão responses: 200: description: Ok schema: type: object properties: services: type: array items: type: object allOf: – #/definitions/customService description: Lista dos servicços 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Buscar os serviços para customização tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtrar por Ponto de Extensão in: query type: string responses: 200: description: Ok schema: type: object properties: services: type: array items: type: object allOf: – #/definitions/customService description: Lista dos servicços 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/statusExecute: post: description: Retorna o status de uma solicitação de execução de customização tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – requestId properties: requestId: type: string description: Identificador da solicitação responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/executeStatus description: Status da solicitação success: type: boolean description: Se executou com sucesso errorLog: type: string description: Log se ocorreu erros data: type: string format: byte description: Dados de retorno do serviço customizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o status de uma solicitação de execução de customização tags: – Queries x-senior-visibility: PRIVATE parameters: – name: requestId description: Identificador da solicitação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/executeStatus description: Status da solicitação success: type: boolean description: Se executou com sucesso errorLog: type: string description: Log se ocorreu erros data: type: string format: byte description: Dados de retorno do serviço customizado 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/exportRule: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/exportCustomPoint: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/exportExecutionRule: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/queries/exportExecutionRuleFail: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: 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: PUBLIC 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: PUBLIC 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/execute: post: description: Executa um ponto de Customização tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – customPoint properties: customPoint: type: string description: Ponto de Customização data: type: string format: byte description: data de entrada ttl: type: integer format: int64 description: Timeout em milisegundos para o Ponto de Customização default: 150000 responses: 200: description: Ok schema: type: object properties: data: type: string format: byte description: Dados de Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/requestExecute: post: description: Solicita execuão um ponto de Customização tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – customPoint properties: customPoint: type: string description: Ponto de Customização data: type: string format: byte description: data de entrada responses: 200: description: Ok schema: type: object required: – requestId properties: requestId: type: string description: Identificador da solicitação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/requestCustom: post: description: Solicita execuão um ponto de Customização tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – customPoint properties: customPoint: type: string description: Ponto de Customização data: type: string format: byte description: data de entrada responses: 200: description: Ok schema: type: object required: – success – data properties: success: type: boolean description: Indica execução com sucesso data: type: string format: byte description: Dados de Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/importRule: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/importCustomPoint: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/importExecutionRule: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/actions/importExecutionRuleFail: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/signals/reprocessFailedEvents: post: description: Reprocessa Events que falharam tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /rules/signals/loadExtensions: post: description: Carrega lista de extensões disponíves tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: Filtrar por Ponto de Extensão responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /rules/events/importRuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /rules/events/exportRuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /rules/events/importCustomPointEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /rules/events/exportCustomPointEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /rules/events/importExecutionRuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /rules/events/exportExecutionRuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /rules/events/importExecutionRuleFailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /rules/events/exportExecutionRuleFailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /rules/entities/rule: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/rule responses: 200: description: The created resource schema: #/definitions/rule 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/rule responses: 200: description: The created resource schema: #/definitions/rule 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 responses: 200: description: Ok schema: type: array items: #/definitions/rule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/rule/{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/rule responses: 200: description: Ok schema: #/definitions/rule 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/rule responses: 200: description: Ok schema: #/definitions/rule 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/rule 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/rule/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/rule responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/customPoint: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customPoint responses: 200: description: The created resource schema: #/definitions/customPoint 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/customPoint responses: 200: description: The created resource schema: #/definitions/customPoint 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 responses: 200: description: Ok schema: type: array items: #/definitions/customPoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/customPoint/{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/customPoint responses: 200: description: Ok schema: #/definitions/customPoint 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/customPoint responses: 200: description: Ok schema: #/definitions/customPoint 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/customPoint 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/customPoint/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/customPoint responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/executionRule: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/executionRule responses: 200: description: The created resource schema: #/definitions/executionRule 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/executionRule responses: 200: description: The created resource schema: #/definitions/executionRule 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 responses: 200: description: Ok schema: type: array items: #/definitions/executionRule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/executionRule/{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/executionRule responses: 200: description: Ok schema: #/definitions/executionRule 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/executionRule responses: 200: description: Ok schema: #/definitions/executionRule 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/executionRule 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/executionRule/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/executionRule responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/executionRuleFail: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/executionRuleFail responses: 200: description: The created resource schema: #/definitions/executionRuleFail 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/executionRuleFail responses: 200: description: The created resource schema: #/definitions/executionRuleFail 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 responses: 200: description: Ok schema: type: array items: #/definitions/executionRuleFail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /rules/entities/executionRuleFail/{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/executionRuleFail responses: 200: description: Ok schema: #/definitions/executionRuleFail 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/executionRuleFail responses: 200: description: Ok schema: #/definitions/executionRuleFail 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/executionRuleFail 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/executionRuleFail/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/executionRuleFail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: serviceHealthStatus: description: Define o Status do serviço type: string enum: – UP – DOWN enumStatusTenant: description: Situação do tenant type: string enum: – AGUARDANDO_ATIVACAO – ATIVADO – EXPIRADO extensionKind: description: Tipo de Extensão type: string enum: – EVENT – EXTENSION – EXTENSION_WEBHOOK executeStatus: description: Define o Status do serviço type: string enum: – NOT_STARTED – IN_PROGESS – COMPLETED 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR extension: description: Registro que representa a extensão type: object required: – name – domain – service – primitive properties: name: type: string description: Nome da Primitiva domain: type: string description: Dominio service: type: string description: Serviço primitive: type: string description: primitiva customService: description: Registro que representa um serviço customizado type: object required: – domainName – serviceName properties: domainName: type: string description: Nome Dominio serviceName: type: string description: Nome do Serviço checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do healthcheck rule: description: Cadastro de Regras – Eventos e Ponto de Extensão type: object required: – customPoint – enabled properties: id: type: string format: uuid description: Identificador único do registro customPoint: type: object allOf: – #/definitions/customPoint description: Ponto de extensão enabled: type: boolean description: Indica se a regra esta habilitada domain: type: string description: Nome do dominio que implementa a extensão service: type: string description: Nome do serviço que implementa a extensão primitive: type: string description: Nome da primitiva que implementa a extensão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: customPoint: description: Pontos de Customização Disponíveis type: object required: – kind – extension – description properties: id: type: string format: uuid description: Identificador único do registro kind: type: string allOf: – #/definitions/extensionKind description: Indica o tipo de regra extension: type: string description: Extensão/Evento registrado no formato dominio/serviço/primitiva description: type: string description: Descrição da Customização createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: executionRule: description: Log Execução Regra type: object required: – extension – status – input properties: id: type: string format: uuid description: Identificador único do registro extension: type: string description: Extensão/Evento registrado no formato dominio/serviço/primitiva status: type: string allOf: – #/definitions/executeStatus description: Status da Execução input: type: string description: Dados de entrada output: type: string description: Dados de saída success: type: boolean description: Se executou com sucesso errorLog: type: string description: Log se ocorreu erros createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: executionRuleFail: description: Registro de falhas de execução de regras type: object required: – executionRule – errorLog properties: id: type: string format: uuid description: Identificador Único do registro executionRule: type: object allOf: – #/definitions/executionRule description: Identificador da execução da regra errorLog: type: string description: Log se ocorreu erros output: type: string description: Dados de saída createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time 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. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: 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