2.0info: 10.1.0 form_customization description: Customização de frontends x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: form_customization 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: /form_customization/queries/healthcheck: post: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados default: description: Error response schema: #/definitions/genericError get: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados default: description: Error response schema: #/definitions/genericError /form_customization/queries/getFrontendNew: post: description: Retorna um frontend baseado no id e na versão. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendId – frontendVersion properties: frontendId: type: string description: Id do frontend frontendVersion: type: string description: Versão do frontend responses: 200: description: Ok schema: type: object required: – frontend properties: frontend: type: object allOf: – #/definitions/frontendDefNew description: Definição do Frontend que foi solicitado default: description: Error response schema: #/definitions/genericError get: description: Retorna um frontend baseado no id e na versão. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: frontendId description: Id do frontend in: query required: true type: string – name: frontendVersion description: Versão do frontend in: query required: true type: string responses: 200: description: Ok schema: type: object required: – frontend properties: frontend: type: object allOf: – #/definitions/frontendDefNew description: Definição do Frontend que foi solicitado default: description: Error response schema: #/definitions/genericError /form_customization/queries/listFrontends: post: description: Lista os ids de todos os frontends. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pageRequest properties: pageRequest: type: object allOf: – #/definitions/pageRequest description: responses: 200: description: Ok schema: type: object properties: frontends: type: array items: type: object allOf: – #/definitions/frontendIdDef description: default: description: Error response schema: #/definitions/genericError /form_customization/queries/listFrontendsById: post: description: Lista os ids dos frontends baseado no id. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendId – pageRequest properties: frontendId: type: string description: pageRequest: type: object allOf: – #/definitions/pageRequest description: responses: 200: description: Ok schema: type: object properties: frontends: type: array items: type: object allOf: – #/definitions/frontendIdDef description: default: description: Error response schema: #/definitions/genericError /form_customization/queries/listFrontendsByChangeUser: post: description: Lista os ids dos frontends baseado no usuário que criou ou alterou. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – changeUser – pageRequest properties: changeUser: type: string description: pageRequest: type: object allOf: – #/definitions/pageRequest description: responses: 200: description: Ok schema: type: object properties: frontends: type: array items: type: object allOf: – #/definitions/frontendIdDef description: default: description: Error response schema: #/definitions/genericError /form_customization/queries/listActiveFrontends: post: description: Lista os ids dos frontends ativos. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pageRequest properties: pageRequest: type: object allOf: – #/definitions/pageRequest description: responses: 200: description: Ok schema: type: object properties: frontends: type: array items: type: object allOf: – #/definitions/frontendIdDef description: default: description: Error response schema: #/definitions/genericError /form_customization/queries/searchFrontendsByIdAndVersion: post: description: Procura os frontends que possuem a expressão no id. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idEexpression – versionExpression – pageRequest properties: idEexpression: type: string description: versionExpression: type: string description: pageRequest: type: object allOf: – #/definitions/pageRequest description: responses: 200: description: Ok schema: type: object properties: frontends: type: array items: type: object allOf: – #/definitions/frontendIdInfoDef description: default: description: Error response schema: #/definitions/genericError /form_customization/queries/getMenuForCustomization: post: description: Retorna o menu considerando o menu padrão, do tenant e as customizações. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendId – frontendVersion properties: frontendId: type: string description: Id do projeto de frontend frontendVersion: type: string description: Versão do projeto de frontend responses: 200: description: Ok schema: type: object required: – menu properties: menu: type: array items: type: object allOf: – #/definitions/menuItemDef minimum: 1 description: Lista com os módulos e seus submenus. changes: type: array items: type: object allOf: – #/definitions/menuItemChange description: Alterações customizadas do menu. default: description: Error response schema: #/definitions/genericError get: description: Retorna o menu considerando o menu padrão, do tenant e as customizações. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: frontendId description: Id do projeto de frontend in: query required: true type: string – name: frontendVersion description: Versão do projeto de frontend in: query required: true type: string responses: 200: description: Ok schema: type: object required: – menu properties: menu: type: array items: type: object allOf: – #/definitions/menuItemDef minimum: 1 description: Lista com os módulos e seus submenus. changes: type: array items: type: object allOf: – #/definitions/menuItemChange description: Alterações customizadas do menu. default: description: Error response schema: #/definitions/genericError /form_customization/queries/getMenuChanges: post: description: Retorna as alterações customizadas realizadas no menu. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendId – frontendVersion properties: frontendId: type: string description: Id do projeto de frontend frontendVersion: type: string description: Versão do projeto de frontend responses: 200: description: Ok schema: type: object required: – menuItems – forms properties: changes: type: array items: type: object allOf: – #/definitions/menuItemChange description: Alterações customizadas do menu. menuItems: type: array items: type: object allOf: – #/definitions/menuItem minimum: 1 description: Lista com os itens de menu customizados. forms: type: array items: type: object allOf: – #/definitions/customForm minimum: 1 description: Lista com as telas customizadas. default: description: Error response schema: #/definitions/genericError get: description: Retorna as alterações customizadas realizadas no menu. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: frontendId description: Id do projeto de frontend in: query required: true type: string – name: frontendVersion description: Versão do projeto de frontend in: query required: true type: string responses: 200: description: Ok schema: type: object required: – menuItems – forms properties: changes: type: array items: type: object allOf: – #/definitions/menuItemChange description: Alterações customizadas do menu. menuItems: type: array items: type: object allOf: – #/definitions/menuItem minimum: 1 description: Lista com os itens de menu customizados. forms: type: array items: type: object allOf: – #/definitions/customForm minimum: 1 description: Lista com as telas customizadas. default: description: Error response schema: #/definitions/genericError /form_customization/queries/getMenuReferencingChanges: post: description: Retorna as alterações customizadas que referenciam o menu (como parent ou previous). tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – menuId properties: menuId: type: string description: Id do item de menu responses: 200: description: Ok schema: type: object properties: changes: type: array items: type: object allOf: – #/definitions/menuItemChange description: Alterações customizadas que referenciam o menu. default: description: Error response schema: #/definitions/genericError get: description: Retorna as alterações customizadas que referenciam o menu (como parent ou previous). tags: – Queries x-senior-visibility: PRIVATE parameters: – name: menuId description: Id do item de menu in: query required: true type: string responses: 200: description: Ok schema: type: object properties: changes: type: array items: type: object allOf: – #/definitions/menuItemChange description: Alterações customizadas que referenciam o menu. default: description: Error response schema: #/definitions/genericError /form_customization/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 description: 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 /form_customization/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 /form_customization/actions/createFrontendNew: post: description: Cria um projeto de frontend tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendId – frontendVersion properties: frontendId: type: string description: Id da definição de frontend frontendVersion: type: string description: Versão do frontend responses: 200: description: Ok schema: type: object required: – frontend properties: frontend: type: object allOf: – #/definitions/frontendDefNew description: Definição do Frontend que foi criado default: description: Error response schema: #/definitions/genericError /form_customization/actions/deleteFrontend: post: description: Exclui um frontend. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendId properties: frontendId: type: object allOf: – #/definitions/frontendIdDef description: responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: default: description: Error response schema: #/definitions/genericError /form_customization/actions/activateFrontend: post: description: Ativa um frontend. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendId properties: frontendId: type: object allOf: – #/definitions/frontendIdDef description: responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: default: description: Error response schema: #/definitions/genericError /form_customization/actions/deactivateFrontend: post: description: Desativa um frontend. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendId properties: frontendId: type: object allOf: – #/definitions/frontendIdDef description: responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: default: description: Error response schema: #/definitions/genericError /form_customization/actions/changeMenu: post: description: Aplica alterações no menu. É permitido mudar um item de menu de posição e torná-lo visível/invisível. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendId – frontendVersion properties: frontendId: type: string description: Id do projeto de frontend frontendVersion: type: string description: Versão do projeto de frontend changes: type: array items: type: object allOf: – #/definitions/menuItemChange description: Lista com os itens de menu alterados e o que foi alterado em cada um. responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /form_customization/actions/applyCustomizations: post: description: Aplica as customizações no frontend e retorna o frontend customizado. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendId – frontendVersion – menuItems – forms properties: frontendId: type: string description: Id do projeto de frontend frontendVersion: type: string description: Versão do projeto de frontend menuItems: type: array items: type: object allOf: – #/definitions/menu minimum: 1 description: Lista com os itens de menu originais. forms: type: array items: type: object allOf: – #/definitions/form minimum: 1 description: Lista com as telas originais. responses: 200: description: Ok schema: type: object required: – menuItems – forms properties: menuItems: type: array items: type: object allOf: – #/definitions/menu minimum: 1 description: Lista com os itens de menu com as customizações aplicadas. forms: type: array items: type: object allOf: – #/definitions/form minimum: 1 description: Lista com as telas com as customizações aplicadas. default: description: Error response schema: #/definitions/genericError /form_customization/entities/menuItem: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/menuItem responses: 200: description: The created resource schema: #/definitions/menuItem 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/menuItem responses: 200: description: The created resource schema: #/definitions/menuItem 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/menuItem default: description: Error response schema: #/definitions/genericError /form_customization/entities/menuItem/{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/menuItem responses: 200: description: Ok schema: #/definitions/menuItem 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/menuItem responses: 200: description: Ok schema: #/definitions/menuItem 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/menuItem 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 /form_customization/entities/menuItem/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/menuItem responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /form_customization/entities/customForm: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customForm responses: 200: description: The created resource schema: #/definitions/customForm 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/customForm responses: 200: description: The created resource schema: #/definitions/customForm 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/customForm default: description: Error response schema: #/definitions/genericError /form_customization/entities/customForm/{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/customForm responses: 200: description: Ok schema: #/definitions/customForm 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/customForm responses: 200: description: Ok schema: #/definitions/customForm 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/customForm 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 /form_customization/entities/customForm/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/customForm responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: healthCheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN menuOpenOption: description: Modo de abertura de uma tela. type: string enum: – CurrentTab – NewTab – DesktopNative – Boxlet – Dashboard – NewWindow userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT checkDTO: description: Itens verificados no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthCheckStatus description: Status pageRequest: description: Page request info. type: object required: – offset – size properties: offset: type: integer format: int64 description: First returning record index. size: type: integer format: int64 description: Record quantity to return. changeInfoDef: description: type: object required: – user – time_ properties: user: type: string description: Usuário que criou ou efetuou a última alteração no objeto. time_: type: string format: date-time description: Hora que o objeto foi criado ou alterado pela última vez. frontendIdDef: description: Frontend id. discriminator: _discriminator type: object required: – id – version – _discriminator properties: id: type: string description: identificador do frontend. type: string description: versão do frontend. _discriminator: type: string description: frontendIdInfoDef: description: FronendIDDef com mais informações allOf: – #/definitions/frontendIdDef – type: object required: – active properties: active: type: boolean description: frontendDef: description: Frontend definition. type: object required: – id – owner properties: id: type: object allOf: – #/definitions/frontendIdDef description: creation: type: object allOf: – #/definitions/changeInfoDef description: Informações sobre a criação do objeto. change: type: object allOf: – #/definitions/changeInfoDef description: Informações sobre a última alteração do objeto. owner: type: string description: Proprietário do frontend. active: type: boolean description: Indica se o frontend está ativo. Esse campo é somente para consulta. Seu valor será ignorado na criação ou na alteração de frontends. frontendDefNew: description: Frontend definition. type: object required: – frontendId – frontendVersion – forms properties: frontendId: type: string description: Id do frontend. frontendVersion: type: string description: Versão do frontend. creation: type: object allOf: – #/definitions/changeInfoDef description: Informações sobre a criação do objeto. change: type: object allOf: – #/definitions/changeInfoDef description: Informações sobre a última alteração do objeto. forms: type: array items: type: object allOf: – #/definitions/customForm minimum: 1 description: Telas que o projeto possui active: type: boolean description: Indica se o frontend está ativo. menuItem: description: Item de menu customizado type: object required: – frontendId – frontendVersion – label properties: id: type: string description: Identificador do item de menu frontendId: type: string description: Id do frontend. frontendVersion: type: string description: Versão do frontend. formId: type: string description: Identificador da tela associada à este item de menu. Se for null significa que é um item agrupador. openOption: type: string allOf: – #/definitions/menuOpenOption description: Forma de abertura da tela associada à este item de menu. label: type: string description: Label do item de menu labelI18n: type: string description: Chave de tradução do label. icon: type: string description: Ícone do menu permissionResource: type: string description: Recurso associado à este menu (para verificar a permissão de acesso) permissionAction: type: string description: Ação associada ao recurso deste menu (para verificar a permissão de acesso) withCredentials: type: boolean description: Indica se o item de menu customizado deve receber as credenciais de usuário logado parentMenuId: type: string description: Id do menu pai escolhido no cadastro da tela. Esse valor é ignorado caso existam customizações adicionais do usuário customForm: description: Tela customizada type: object required: – label – formURL – frontendId – frontendVersion properties: id: type: string description: Identificador da tela creationUser: type: string description: Usuário que criou a tela. changeUser: type: string description: Usuário que realizou a última alteração na tela. creationTime: type: string format: date-time description: Horário de criação da tela. changeTime: type: string format: date-time description: Horário da última alteração na tela. label: type: string description: Label da tela formURL: type: string description: URL da tela helpId: type: string description: URL do help da tela (deve ser uma URL absoluta) helpContext: type: string description: Contexto do help da tela menuItem: type: object allOf: – #/definitions/menuItem description: Item de menu que abre esta tela. menuItemId: type: string description: Identificador do item de menu que abre esta tela. frontendId: type: string description: Id do frontend. frontendVersion: type: string description: Versão do frontend. menuItemChange: description: Alteração de um item de menu type: object required: – menuItemId – visible properties: menuItemId: type: string description: Id do item de menu alterado parentMenuId: type: string description: Id do pai do item de menu previousSiblingMenuId: type: string description: Id do menu anterior ao item de menu alterado (essa informação é utilizada para posicionar o menu no local correto) visible: type: boolean description: Indica se o item de menu deve ser apresentado ou não. onlyVisibilityChange: type: boolean description: Indica se apenas a visibilidade do menu foi alterada. Neste caso ignora os campos parentMenuId e previousSiblingMenuId. menuItemDef: description: Item de menu type: object required: – id – label – isModule – visible – isCustom properties: id: type: string description: Identificador do item de menu label: type: string description: Label do item de menu icon: type: string description: Ícone do item de menu isModule: type: boolean description: Indica se o item é um módulo visible: type: boolean description: Indica se este item de menu está visível ou não isCustom: type: boolean description: Indica se este item é um item de menu customizado. Apenas itens de menu customizados que não possuem associação com tela podem ser excluídos. hasFormAssociation: type: boolean description: Indica se este item de menu possui associação com uma tela hasFormUrl: type: boolean description: Indica se este item de menu possui associação com uma tela e esta tela possui uma URL subMenuItems: type: array items: type: object allOf: – #/definitions/menuItemDef description: Lista com os submenus deste item de menu menu: description: Item de menu type: object required: – uniqueId – id – label properties: uniqueId: type: string description: Identificador único do item de menu. id: type: string description: Identificador do item de menu label: type: string description: Label do item de menu labelI18n: type: string description: Chave de tradução do label. icon: type: string description: Ícone do item de menu isModule: type: boolean description: Indica se o item é um módulo visible: type: boolean description: Indica se este item de menu está visível ou não isCustom: type: boolean description: Indica se este item é um item de menu customizado. Apenas itens de menu customizados que não possuem associação com tela podem ser excluídos. formId: type: string description: Identificador da tela associada à este item de menu. Se for null significa que é um item agrupador. hasFormAssociation: type: boolean description: Indica se este item de menu possui associação com uma tela hasFormUrl: type: boolean description: Indica se este item de menu possui associação com uma tela e esta tela possui uma URL openOption: type: string allOf: – #/definitions/menuOpenOption description: Forma de abertura da tela associada à este item de menu. permissionResource: type: string description: Recurso associado à este menu (para verificar a permissão de acesso) permissionAction: type: string description: Ação associada ao recurso deste menu (para verificar a permissão de acesso) withCredentials: type: boolean description: Indica se o item de menu customizado deve receber as credenciais de usuário logado subMenuItems: type: array items: type: object allOf: – #/definitions/menu description: Lista com os submenus deste item de menu form: description: Tela type: object required: – formLabel – domainName – serviceName – formId properties: formLabel: type: string description: Label da tela domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço formId: type: string description: Identificador da tela formURL: type: string description: URL da tela helpId: type: string description: Id do help da tela helpContext: type: string description: Contexto do help da tela custom: type: boolean description: Indica se esta tela é customizada. notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE