2.0info: 1.7.0 Logs Process description: Logs Process x-senior-domain: Logs x-senior-domain-path: logs x-senior-service-path: process 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/logssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /process/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process/queries/isProcessCancelled: post: description: Verifica se um processo está cancelado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 36 description: Identificador do processo. responses: 200: description: Ok schema: type: object required: – cancelled properties: cancelled: type: boolean description: Retorno da situação do processo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se um processo está cancelado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: summaryId description: Identificador do processo. in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – cancelled properties: cancelled: type: boolean description: Retorno da situação do processo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process/queries/isProcessFinished: post: description: Verifica se um processo está finalizado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 36 description: Identificador do processo. responses: 200: description: Ok schema: type: object required: – finished properties: finished: type: boolean description: Retorno da situação do processo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se um processo está finalizado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: summaryId description: Identificador do processo. in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – finished properties: finished: type: boolean description: Retorno da situação do processo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process/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 /process/queries/exportProcessSummary: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /process/queries/exportLog: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /process/queries/exportProcessType: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /process/queries/exportProperties: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /process/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 /process/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process/actions/importProcessSummary: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /process/actions/importLog: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /process/actions/importProcessType: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /process/actions/importProperties: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /process/signals/startProcess: post: description: Cria um novo processo de log tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – summaryId – processType – startDate – startedBy – type properties: summaryId: type: string maxLength: 36 description: Código de Identificação do Processo. processType: type: string description: Tipo do Processo. startDate: type: string format: date-time description: Data de Início do Processo. startedBy: type: string maxLength: 255 description: Usuário que iniciou o Processo. total: type: integer format: int64 description: Total de Registros. unit: type: string description: Unidade, label utilizado para exibir o percentual ou quantidade, valor padrão é registros type: type: string allOf: – #/definitions/processSummaryType description: Tipo finalizationNotification: type: object allOf: – #/definitions/notificationDTO description: Definição de notificação de finalização do processo cancelNotification: type: object allOf: – #/definitions/notificationDTO description: Definição de notificação ao cancelar o processo logPayload: type: object allOf: – #/definitions/logPayload description: Payload do log responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process/signals/logMessage: post: description: Insere uma mensagem de log. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – summaryId – logPayload properties: summaryId: type: string maxLength: 36 description: Código de identificação do processo. logPayload: type: object allOf: – #/definitions/logPayloadTime description: Payload do log responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process/signals/logMessages: post: description: Insere uma lista de mensagem de log. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – summaryId – logPayload properties: summaryId: type: string maxLength: 36 description: Código de identificação do processo. logPayload: type: array items: type: object allOf: – #/definitions/logPayloadTime minimum: 1 description: Payload do log responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process/signals/cancelProcess: post: description: Cancela o processo em execução tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – summaryId – endDate – canceledBy properties: summaryId: type: string description: Código de Identificação do Processo endDate: type: string format: date-time description: Data e Hora da finalização canceledBy: type: string description: Usuário que Cancelou o Processo logPayload: type: object allOf: – #/definitions/logPayload description: Payload do log responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process/signals/finishProcess: post: description: Finaliza um processo e insere um registro de log. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – summaryId – endDate properties: summaryId: type: string maxLength: 36 description: Código de identificação do processo. endDate: type: string format: date-time description: Data e hora da finalização. logPayload: type: object allOf: – #/definitions/logPayload description: Payload do log responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process/signals/dataCleaning: post: description: Faz a limpeza dos logs que podem ser excluídos tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process/signals/sumProcess: post: description: Soma processos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – summaryId – time – successfullyProcessed – processedWithError properties: summaryId: type: string maxLength: 36 description: Código de Identificação do Processo time: type: string format: date-time description: Data e Hora da atualização successfullyProcessed: type: integer format: int64 description: Quantidade de registros processados com sucesso processedWithError: type: integer format: int64 description: Quantidade de registros processados com erro logPayload: type: object allOf: – #/definitions/logPayload description: Payload do log responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process/signals/updateTotalRecords: post: description: Atualizar a quantidade total de registros a serem processados, somente é permitido se a quantidade total for 0. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – summaryId – total properties: summaryId: type: string maxLength: 36 description: Código de identificação do processo. total: type: integer format: int64 description: Total de registros. minimum: 0 responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process/signals/updateTotalAndSumRecords: post: description: Atualiza a quantidade total de registros a serem processados e soma a quantidade de registros processados com sucesso e erro tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – summaryId – time – successfullyProcessed – processedWithError properties: summaryId: type: string maxLength: 36 description: Código de Identificação do Processo time: type: string format: date-time description: Data e Hora da atualização successfullyProcessed: type: integer format: int64 description: Quantidade de registros processados com sucesso processedWithError: type: integer format: int64 description: Quantidade de registros processados com erro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process/events/dataCleaningFinished: post: description: Atualiza o snapshot dos históricos do colaborador em lote. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – summaryIds properties: summaryIds: type: array items: type: string minimum: 1 description: Identificadores únicos dos processos cujas informações foram removidas. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process/events/importProcessSummaryEvent: 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 /process/events/exportProcessSummaryEvent: 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 /process/events/importLogEvent: 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 /process/events/exportLogEvent: 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 /process/events/importProcessTypeEvent: 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 /process/events/exportProcessTypeEvent: 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 /process/events/importPropertiesEvent: 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 /process/events/exportPropertiesEvent: 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 /process/entities/processSummary: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processSummary responses: 200: description: The created resource schema: #/definitions/processSummary 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/processSummary responses: 200: description: The created resource schema: #/definitions/processSummary 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/processSummary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process/entities/processSummary/{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/processSummary responses: 200: description: Ok schema: #/definitions/processSummary 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/processSummary responses: 200: description: Ok schema: #/definitions/processSummary 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/processSummary 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 /process/entities/processSummary/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/processSummary responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process/entities/log: 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/log 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process/entities/processType: 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/processType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN logType: description: Tipo do log type: string enum: – INFO – WARNING – ERROR processSummaryType: description: Tipo de processo de log type: string enum: – USER – DEBUG – USER_DEBUG 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 – LOCALDATETIME – 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 checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status logPayload: description: Payload do log discriminator: _discriminator type: object required: – message – logType – _discriminator properties: message: type: string description: Mensagem logType: type: string allOf: – #/definitions/logType description: Tipo do log _discriminator: type: string description: processNotificationDTO: description: Dados necessários executar uma operação e notificar um serviço. type: object required: – processId – processType – processTypeDescription – startDate – endDate – total – processed – processedWithError – successfullyProcessed – unprocessed – startedBy – unit – cancelledBy – cancellationDate properties: processId: type: string description: Identificador único do processo processType: type: string description: Tipo de processo processTypeDescription: type: string description: Descrição do tipo do processo. startDate: type: string format: date-time description: Data de Início do Processo endDate: type: string format: date-time description: Data de Término do Processo total: type: integer format: int64 description: Quantidade total de registros a serem processados processed: type: integer format: int64 description: Quantidade total de registros processados processedWithError: type: integer format: int64 description: Quantidade de registros processados com erro successfullyProcessed: type: integer format: int64 description: Quantidade de registros processados com sucesso unprocessed: type: integer format: int64 description: Quantidade de registros não processados startedBy: type: string description: Usuário que iniciou o processo unit: type: string description: Unidade dos itens que estão sendo processados (colaboradores, apurações, etc.) cancelledBy: type: string description: Usuário que cancelou o processo cancellationDate: type: string format: date-time description: Data de cancelamento do processo notificationDTO: description: Definição de notificação de um processo. type: object required: – domain – service – api properties: domain: type: string description: Domínio que será avisado service: type: string description: Serviço que será avisado api: type: string description: API que será notificada logPayloadTime: description: Payload do log com data/hora allOf: – #/definitions/logPayload – type: object required: – time properties: time: type: string format: date-time description: Data e hora da atualização. processSummary: description: Resumo do Processo type: object required: – summaryId – processType – startDate – startedBy – type properties: id: type: string format: uuid description: Identificador único do registro (Usado apenas internamente para evitar erro de chave duplicada) summaryId: type: string format: uuid description: Identificador Único do Processo para agrupar os itens do Log processType: type: object allOf: – #/definitions/processType description: Tipo do Processo startDate: type: string format: date-time description: Data de Início do Processo endDate: type: string format: date-time description: Data de Término do Processo total: type: integer format: int64 description: Quantidade total de registros a serem processados minimum: 0 default: 0 processed: type: integer format: int64 description: Quantidade total de registros processados default: 0 processedWithError: type: integer format: int64 description: Quantidade de registros processados com erro default: 0 successfullyProcessed: type: integer format: int64 description: Quantidade de registros processados com sucesso default: 0 unprocessed: type: integer format: int64 description: Quantidade de registros não processados default: 0 startedBy: type: string maxLength: 255 description: Usuário que iniciou o processo unit: type: string maxLength: 255 description: Unidade dos itens que estão sendo processados (colaboradores, apurações, etc.) default: Registros cancelledBy: type: string description: Usuário que cancelou o processo cancellationDate: type: string format: date-time description: Data de cancelamento do processo expirationDate: type: string format: date-time description: Data da expiração type: type: string allOf: – #/definitions/processSummaryType description: Tipo finalizationDomain: type: string description: Domínio que será avisado na finalização do processo finalizationService: type: string description: Serviço que será avisado na finalização do processo finalizationApi: type: string description: API que será notificada na finalização do processo cancelDomain: type: string description: Domínio que será avisado ao cancelar o processo cancelService: type: string description: Serviço que será avisado ao cancelar o processo cancelApi: type: string description: API que será notificada ao cancelar o processo log: description: Log type: object required: – time – summaryId – message – type properties: id: type: string format: uuid description: Identificador único do registro time: type: string format: date-time description: Data e Hora do Log summaryId: type: string format: uuid description: Identificador Único do Processo usado para agrupar os registros individuais de Log message: type: string maxLength: 4000 description: Mensagem type: type: string allOf: – #/definitions/logType description: Tipo do log processType: description: Tipo de processo type: object required: – type – name – description – erasable properties: type: type: string maxLength: 255 description: Tipo do Processo name: type: string maxLength: 50 description: Nome x-i18n: true description: type: string maxLength: 255 description: Descrição x-i18n: true erasable: type: boolean description: Define se os logs desse processo são apagáveis expiresIn: type: integer format: int64 description: Prazo (em dias) da expiração dos registros para remoção minimum: 1 maximum: 365 translations: type: object properties: locale: type: object properties: name: type: string maxLength: 50 description: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR.description: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale.description: Text example using en-US locale. properties: description: Propriedades type: object required: – key – value – updateDateTime properties: id: type: string format: uuid description: Identificador único key: type: string maxLength: 60 description: Chave da propriedade value: type: string maxLength: 255 description: Valor da chave updateDateTime: type: string format: date-time description: Data da última atualização 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