2.0info: develop-SNAPSHOT insights description: Servico Insights x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: insights contact: name: Senior X Platform url: http://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: /insights/queries/getResult: post: description: Obtêm o Resultado de um insight tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – queryId properties: queryId: type: string description: Identificador da Consulta responses: 200: description: Ok schema: type: object properties: output: type: string description: Resultado default: description: Error response schema: #/definitions/genericError get: description: Obtêm o Resultado de um insight tags: – Queries x-senior-visibility: PRIVATE parameters: – name: queryId in: query required: true type: string responses: 200: description: Ok schema: type: object properties: output: type: string description: Resultado default: description: Error response schema: #/definitions/genericError /insights/queries/getInsightMetadata: post: description: Obtem a definição de dados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome do Insight responses: 200: description: Ok schema: type: object properties: output: type: string description: Resultado default: description: Error response schema: #/definitions/genericError get: description: Obtem a definição de dados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name in: query required: true type: string responses: 200: description: Ok schema: type: object properties: output: type: string description: Resultado default: description: Error response schema: #/definitions/genericError /insights/queries/getInsight: post: description: Executa um insight com os parâmetros informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome do insight a ser consultado params: type: string format: byte description: Parâmtros para a consulta responses: 200: description: Ok schema: type: object required: – output properties: output: type: string format: byte description: Resultado da consulta default: description: Error response schema: #/definitions/genericError get: description: Executa um insight com os parâmetros informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name in: query required: true type: string – name: params in: query type: string format: byte responses: 200: description: Ok schema: type: object required: – output properties: output: type: string format: byte description: Resultado da consulta default: description: Error response schema: #/definitions/genericError /insights/queries/getInsightResult: post: description: Obtem o Resultado de um insight tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – qii properties: qii: type: string description: Identificador da Consulta responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/queryStatus description: Status da execução da consulta output: type: string description: Resultado da Consulta quando comncluída default: description: Error response schema: #/definitions/genericError get: description: Obtem o Resultado de um insight tags: – Queries x-senior-visibility: PRIVATE parameters: – name: qii in: query required: true type: string responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/queryStatus description: Status da execução da consulta output: type: string description: Resultado da Consulta quando comncluída default: description: Error response schema: #/definitions/genericError /insights/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: 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 in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /insights/queries/exportInsightDefinition: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /insights/queries/exportInsightQuery: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /insights/queries/exportInsight: 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /insights/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 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 default: description: Error response schema: #/definitions/genericError /insights/actions/executeInsightDefinition: post: description: Executa comandos associados a uma definição de insight tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – commandNames properties: name: type: string description: Nome da definição commandNames: type: array items: type: string minimum: 1 description: Nomes dos comandos a serem executados responses: 200: description: Ok schema: type: object required: – success – flowId properties: success: type: boolean description: Indica se a inicialização da execução do insight teve sucesso flowId: type: string description: Identificador do fluxo de execução dos comandos default: description: Error response schema: #/definitions/genericError /insights/actions/loadTransformationResult: post: description: Carrega o resultado de uma transformação de dados e disponibilíza-os para consulta tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataSource – params – resultRepository – resultLocation properties: dataSource: type: string description: Nome da fonte de dados a ser disponibilizada params: type: array items: type: string minimum: 1 description: Dados que devem ser considerados no carregamento resultRepository: type: string description: Nome do repositório que armazena os resultados da transformação resultLocation: type: string description: Localização dos resultados da transformação relativo ao repositório responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /insights/actions/createQuery: post: description: Cria uma nova consulta para um insight tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – input properties: name: type: string description: Nome do Insight input: type: string description: Entrada de Dados da Consulta responses: 200: description: Ok schema: type: object required: – queryId properties: queryId: type: string description: Identificador da Consulta default: description: Error response schema: #/definitions/genericError /insights/actions/createNamedQuery: post: description: Obtem o Resultado de uma consulta insight pré definida tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – insightName – queryName properties: insightName: type: string description: Nome do Insight queryName: type: string description: Nome da query responses: 200: description: Ok schema: type: object required: – qii properties: qii: type: string description: Identificador da Consulta default: description: Error response schema: #/definitions/genericError /insights/actions/createQueryInsight: post: description: Cria uma nova consulta para um insight tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – input properties: name: type: string description: Nome do Insight input: type: string description: Entrada de Dados da Consula responses: 200: description: Ok schema: type: object required: – qii properties: qii: type: string description: Identificador da Consulta default: description: Error response schema: #/definitions/genericError /insights/actions/load: post: description: Inicia a carga dos dados de um insight tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – insighName properties: insighName: type: string description: Nome do Insight responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Id para consulta do status do processo de carga default: description: Error response schema: #/definitions/genericError /insights/actions/importInsightDefinition: 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: default: description: Error response schema: #/definitions/genericError /insights/actions/importInsightQuery: 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: default: description: Error response schema: #/definitions/genericError /insights/actions/importInsight: 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: default: description: Error response schema: #/definitions/genericError /insights/entities/insightCommand: 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/insightCommand default: description: Error response schema: #/definitions/genericError /insights/entities/insightCommand/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/insightCommand default: description: Error response schema: #/definitions/genericError /insights/entities/insightDefinition/{parentId}/cmds: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: – #/definitions/insightCommand responses: 200: description: The created resources schema: type: array items: #/definitions/insightCommand default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: – #/definitions/insightCommand responses: 200: description: The created resources schema: type: array items: #/definitions/insightCommand default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/insightCommand default: description: Error response schema: #/definitions/genericError /insights/entities/insightDefinition/{parentId}/cmds/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/insightCommand responses: 200: description: Ok schema: #/definitions/insightCommand default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/insightCommand responses: 200: description: Ok schema: #/definitions/insightCommand default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/insightCommand default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /insights/entities/insightDefinition: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/insightDefinition responses: 200: description: The created resource schema: #/definitions/insightDefinition 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/insightDefinition responses: 200: description: The created resource schema: #/definitions/insightDefinition 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/insightDefinition default: description: Error response schema: #/definitions/genericError /insights/entities/insightDefinition/{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/insightDefinition responses: 200: description: Ok schema: #/definitions/insightDefinition 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/insightDefinition responses: 200: description: Ok schema: #/definitions/insightDefinition 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/insightDefinition 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 default: description: Error response schema: #/definitions/genericError /insights/entities/insightDefinition/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/insightDefinition responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /insights/entities/insightQuery: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/insightQuery responses: 200: description: The created resource schema: #/definitions/insightQuery 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/insightQuery responses: 200: description: The created resource schema: #/definitions/insightQuery 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/insightQuery default: description: Error response schema: #/definitions/genericError /insights/entities/insightQuery/{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/insightQuery responses: 200: description: Ok schema: #/definitions/insightQuery 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/insightQuery responses: 200: description: Ok schema: #/definitions/insightQuery 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/insightQuery 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 default: description: Error response schema: #/definitions/genericError /insights/entities/insightQuery/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/insightQuery responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /insights/entities/insight: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/insight responses: 200: description: The created resource schema: #/definitions/insight 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/insight responses: 200: description: The created resource schema: #/definitions/insight 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/insight default: description: Error response schema: #/definitions/genericError /insights/entities/insight/{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/insight responses: 200: description: Ok schema: #/definitions/insight 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/insight responses: 200: description: Ok schema: #/definitions/insight 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/insight 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 default: description: Error response schema: #/definitions/genericError /insights/entities/insight/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/insight responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: commandType: description: Tipos de comandos disponíveis para um Insight. Definem como um job deve ser executado. type: string enum: – INIT – TRANSFORMATION – LOAD queryStatus: description: Enumeração com o status de uma consulta type: string enum: – NOTSTARTED – PENDING – 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 insightCommand: description: Comando associado a uma definição de insight. Um comando representa uma operação que é executada sob uma massa de dados. type: object required: – name – type – jarLocation – mainClass – args properties: id: type: string format: uuid description: Identificador Único insightDefinition: type: object allOf: – #/definitions/insightDefinition description: Definição do insight name: type: string description: Nome do comando type: type: string allOf: – #/definitions/commandType description: Tipo de comando jarLocation: type: string description: Localização do JAR contendo o script a ser executado mainClass: type: string description: Classe principal do JAR args: type: string description: Argumentos para o programa (e.g. origem e destino dos dados) insightDefinition: description: Definição de um insight. A definição tem um nome um conjunto de comandos que serão jobs executados pelo framework de big data type: object required: – name properties: id: type: string format: uuid description: Identificador Único name: type: string description: Nome do Insight cmds: type: array items: type: object allOf: – #/definitions/insightCommand description: Comandos deste Insigth insightQuery: description: Histórico de consultas de Insights type: object required: – username – creation – input – output properties: id: type: string format: uuid description: Identificador Único username: type: string description: Usuário creation: type: string format: date description: Data de criação do Insight input: type: string description: Entrada de Dados output: type: string description: Saída de Dados insight: description: Representação de uma consulta a dados transformados já carregados para nosso serviço type: object required: – name – queryDefinition properties: id: type: string format: uuid description: Identificador Único name: type: string maxLength: 70 description: Nome de identificação do insight queryDefinition: type: string description: Query a ser executado quando o insight for invocado 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: 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