Mais pesquisados:Customização, Tutorial, Documentação

menu

241 views 1 22/10/2018 Atualizado em 03/10/2024 integrador

2.0info: 9.4.1 menu description: Serviço para gerenciamento do menu da plataforma x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: menu contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /menu/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço 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ços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço 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ços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/listModules: post: description: Lista todos os módulos do tenant atual. Incluindo os módulos padrões e os adicionados pelo tenant. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: mapCustomModules: type: boolean description: Indica se os módulos customizados devem ser retornados. Por padrão os módulos customizados são retornados. default: true mapFrontendsConfiguration: type: boolean description: Indica se as configurações de frontend deste módulo devem ser mapeadas no retorno. Por padrão as informações são mapeadas. default: true responses: 200: description: Ok schema: type: object required: – modules properties: modules: type: array items: type: object allOf: – #/definitions/module minimum: 1 description: Lista com todos os módulos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todos os módulos do tenant atual. Incluindo os módulos padrões e os adicionados pelo tenant. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: mapCustomModules description: Indica se os módulos customizados devem ser retornados. Por padrão os módulos customizados são retornados. in: query type: boolean – name: mapFrontendsConfiguration description: Indica se as configurações de frontend deste módulo devem ser mapeadas no retorno. Por padrão as informações são mapeadas. in: query type: boolean responses: 200: description: Ok schema: type: object required: – modules properties: modules: type: array items: type: object allOf: – #/definitions/module minimum: 1 description: Lista com todos os módulos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/getFrontendProject: post: description: Obtém um frontend com base no nome e versão do projeto. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – projectName properties: projectName: type: string description: Nome do projeto projectVersion: type: string description: Versão do projeto responses: 200: description: Ok schema: type: object required: – frontendProject properties: frontendProject: type: object allOf: – #/definitions/frontendProject description: Projeto de frontend solicitado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém um frontend com base no nome e versão do projeto. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: projectName description: Nome do projeto in: query required: true type: string – name: projectVersion description: Versão do projeto in: query type: string responses: 200: description: Ok schema: type: object required: – frontendProject properties: frontendProject: type: object allOf: – #/definitions/frontendProject description: Projeto de frontend solicitado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/getDefaultFrontendProject: post: description: Recupera o frontend default tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – frontendProject properties: frontendProject: type: object allOf: – #/definitions/frontendProject description: Frontend recuperado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera o frontend default tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – frontendProject properties: frontendProject: type: object allOf: – #/definitions/frontendProject description: Frontend recuperado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/findActiveFrontendProject: post: description: Retorna o frontend ativo do tenant tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object properties: frontendProject: type: object allOf: – #/definitions/frontendProject description: Definição do frontend ativo para o tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o frontend ativo do tenant tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object properties: frontendProject: type: object allOf: – #/definitions/frontendProject description: Definição do frontend ativo para o tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/getFrontendProjects: post: description: Retorna todos os projetos de frontend do tenant. tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – frontendProjects properties: frontendProjects: type: array items: type: object allOf: – #/definitions/frontendProject minimum: 1 description: Lista com todos os projetos de frontend. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os projetos de frontend do tenant. tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – frontendProjects properties: frontendProjects: type: array items: type: object allOf: – #/definitions/frontendProject minimum: 1 description: Lista com todos os projetos de frontend. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/generateApplicationConfigurationMenu: post: description: Gera o menu das configurações dos aplicativos. Customizações de menus não são aplicados. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendProjectName – frontendProjectVersion properties: frontendProjectName: type: string description: Nome do projeto frontendProjectVersion: type: string description: Versão do projeto responses: 200: description: Ok schema: type: object required: – forms – menus properties: forms: type: array items: type: object allOf: – #/definitions/formProject minimum: 1 description: Telas das configurações dos aplicativos menus: type: array items: type: object allOf: – #/definitions/menuItemProject minimum: 1 description: Menus das configurações dos aplicativos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Gera o menu das configurações dos aplicativos. Customizações de menus não são aplicados. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: frontendProjectName description: Nome do projeto in: query required: true type: string – name: frontendProjectVersion description: Versão do projeto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – forms – menus properties: forms: type: array items: type: object allOf: – #/definitions/formProject minimum: 1 description: Telas das configurações dos aplicativos menus: type: array items: type: object allOf: – #/definitions/menuItemProject minimum: 1 description: Menus das configurações dos aplicativos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/listDynamicActionMenuItems: post: description: Lista os itens de menu dinâmicos do tenant. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/actionMenuItem minimum: 1 description: Itens de menu dinâmicos do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os itens de menu dinâmicos do tenant. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/actionMenuItem minimum: 1 description: Itens de menu dinâmicos do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/getTreeOfDynamicMenuItem: post: description: Obtém a árvore de um item de menu dinâmico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dynamicMenuItemId properties: dynamicMenuItemId: type: string description: Id do item de menu dinâmico responses: 200: description: Ok schema: type: object properties: root: type: object allOf: – #/definitions/menuItem description: Item de menu raiz da árvore 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a árvore de um item de menu dinâmico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dynamicMenuItemId description: Id do item de menu dinâmico in: query required: true type: string responses: 200: description: Ok schema: type: object properties: root: type: object allOf: – #/definitions/menuItem description: Item de menu raiz da árvore 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/getTreeOfDynamicActionMenuItem: post: description: Obtém a árvore de um item de menu de ações dinâmico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dynamicMenuItemId properties: dynamicMenuItemId: type: string description: Id do item de menu de ações dinâmico responses: 200: description: Ok schema: type: object properties: root: type: object allOf: – #/definitions/menuItem description: Item de menu raiz da árvore 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a árvore de um item de menu de ações dinâmico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dynamicMenuItemId description: Id do item de menu de ações dinâmico in: query required: true type: string responses: 200: description: Ok schema: type: object properties: root: type: object allOf: – #/definitions/menuItem description: Item de menu raiz da árvore 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/getDynamicActionMenuItem: post: description: Retorna o formulário associado à URL passada como parâmetro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName – formURL properties: domainName: type: string description: Nome do dominio do formulário que possui o menu de ações serviceName: type: string description: Nome do serviço do formulário que possui o menu de ações formURL: type: string description: URL do item de menu responses: 200: description: Ok schema: type: object required: – hostFormId properties: hostFormId: type: string description: Identificador do formulário que possui o menu de ações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o formulário associado à URL passada como parâmetro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainName description: Nome do dominio do formulário que possui o menu de ações in: query required: true type: string – name: serviceName description: Nome do serviço do formulário que possui o menu de ações in: query required: true type: string – name: formURL description: URL do item de menu in: query required: true type: string responses: 200: description: Ok schema: type: object required: – hostFormId properties: hostFormId: type: string description: Identificador do formulário que possui o menu de ações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/getDynamicActionMenuService: post: description: Retorna o domínio e o serviço do recurso adicionado ao menu tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – targetId properties: targetId: type: string description: Identificador do recurso que será adicionado ao menu responses: 200: description: Ok schema: type: object required: – domainName – serviceName properties: domainName: type: string description: Nome do dominio do formulário que possui o menu de ações serviceName: type: string description: Nome do serviço do formulário que possui o menu de ações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o domínio e o serviço do recurso adicionado ao menu tags: – Queries x-senior-visibility: PRIVATE parameters: – name: targetId description: Identificador do recurso que será adicionado ao menu in: query required: true type: string responses: 200: description: Ok schema: type: object required: – domainName – serviceName properties: domainName: type: string description: Nome do dominio do formulário que possui o menu de ações serviceName: type: string description: Nome do serviço do formulário que possui o menu de ações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/listFavoriteFolders: post: description: Lista todos os folders dos favoritos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: folders: type: array items: type: object allOf: – #/definitions/favoriteFolderDef description: A lista contendo todos os folders do menu de favoritos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todos os folders dos favoritos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: folders: type: array items: type: object allOf: – #/definitions/favoriteFolderDef description: A lista contendo todos os folders do menu de favoritos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/getMenuWithEmptyNodes: post: description: Retorna os itens de menu, de acordo com o tenant e com o usuário que o solicitou (obtidos através do cabeçalho da mensagem).\nAs permissões já são aplicadas automaticamente e apenas os itens que o usuário tem acesso são retornados.\nItens de menu que são nodos e não tem nenhum filho serão retornados. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – menu properties: menu: type: object allOf: – #/definitions/menu description: O menu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os itens de menu, de acordo com o tenant e com o usuário que o solicitou (obtidos através do cabeçalho da mensagem).\nAs permissões já são aplicadas automaticamente e apenas os itens que o usuário tem acesso são retornados.\nItens de menu que são nodos e não tem nenhum filho serão retornados. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – menu properties: menu: type: object allOf: – #/definitions/menu description: O menu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/getMenu: post: description: Retorna os itens de menu, de acordo com o tenant e com o usuário que o solicitou (obtidos através do cabeçalho da mensagem). As permissões já são aplicadas automaticamente e apenas os itens que o usuário tem acesso são retornados. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – menu properties: menu: type: object allOf: – #/definitions/menu description: O menu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os itens de menu, de acordo com o tenant e com o usuário que o solicitou (obtidos através do cabeçalho da mensagem). As permissões já são aplicadas automaticamente e apenas os itens que o usuário tem acesso são retornados. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – menu properties: menu: type: object allOf: – #/definitions/menu description: O menu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/getActionMenuItems: post: description: Retorna os itens que devem ser adicionados ao menu de ações do formulário passado como parâmetro. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName – hostFormId properties: domainName: type: string description: Nome do dominio do formulário que possui o menu de ações serviceName: type: string description: Nome do serviço do formulário que possui o menu de ações hostFormId: type: string description: Identificador do formulário que possui o menu de ações responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/actionMenuItem minimum: 1 description: Itens que devem ser adicionados ao menu de ações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os itens que devem ser adicionados ao menu de ações do formulário passado como parâmetro. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainName description: Nome do dominio do formulário que possui o menu de ações in: query required: true type: string – name: serviceName description: Nome do serviço do formulário que possui o menu de ações in: query required: true type: string – name: hostFormId description: Identificador do formulário que possui o menu de ações in: query required: true type: string responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/actionMenuItem minimum: 1 description: Itens que devem ser adicionados ao menu de ações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/queries/getAllAvailableMenus: post: description: Retorna os itens de menu, de acordo com o tenant (obtido através do cabeçalho da mensagem). Todos os itens serão retornados com suas permissões requeridas. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – menu properties: menu: type: object allOf: – #/definitions/menu description: O menu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os itens de menu, de acordo com o tenant (obtido através do cabeçalho da mensagem). Todos os itens serão retornados com suas permissões requeridas. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – menu properties: menu: type: object allOf: – #/definitions/menu description: O menu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/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 /menu/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 /menu/actions/enableFrontendConfiguration: post: description: Habilita/Desabilita uma configuração de frontend padrão. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – frontendConfigurationId – enable properties: frontendConfigurationId: type: string description: ID da configuração de frontend enable: type: boolean description: Booleano indicando se é para habilitar (true) ou desabilitar (false) a configuração. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/generateMenu: post: description: Gera o menu para o tenant atual. Aplicando as customizações do tenant sobre o menu padrão. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: frontendProjectName: type: string description: Nome do projeto frontend para o qual o menu será gerado. Opcional, se não for informado será gerado para todos os projetos. frontendProjectVersion: type: string description: Versão do projeto frontend para o qual o menu será gerado. Opcional, se não for informado será gerado para todos os projetos. responses: 200: description: Ok schema: type: object properties: listErrors: type: array items: type: string description: Lista com os erros encontrados durante a geração do menu. warnings: type: array items: type: string description: Lista com as warnings encontradas durante a geração do menu. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/generateDefaultMenu: post: description: Gera o menu padrão para o tenant atual. tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/generateMenuOfModule: post: description: Regera o menu do módulo informado. Será regerado em todos os projetos de frontend do tenant. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – moduleId properties: moduleId: type: string description: Id do módulo que deve ter o menu regerado. responses: 200: description: Ok schema: type: object properties: listErrors: type: array items: type: string description: Lista com os erros encontrados na geração do menu. warnings: type: array items: type: string description: Lista com as warnings encontradas durante a geração do menu. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/disableMenuItemChange: post: description: Desabilita uma alteração do item do menu do tenant corrente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – menuItemId properties: menuItemId: type: string description: Id do item do menu que deve ter sua alteração desabilitada responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/enableMenuItemChange: post: description: Habilita uma alteração do item do menu do tenant corrente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – menuItemId properties: menuItemId: type: string description: Id do item do menu que deve ter sua alteração habilitada responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/requestUploadLocation: post: description: Requisita uma URI, onde o arquivo de configuração será mantido tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: responses: 200: description: Ok schema: type: object required: – objectId – location – version properties: objectId: type: string description: location: type: string description: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/confirmUpload: post: description: Confirma se o arquivo de configuração foi persistido tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – objectId – version – fileName properties: objectId: type: string description: type: string description: fileName: type: string description: responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/requestConfigurationURI: post: description: Solicita uma URI de um arquivo de configuração já persistido tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – objectId – fileName properties: objectId: type: string description: fileName: type: string description: responses: 200: description: Ok schema: type: object required: – uri properties: uri: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/sortModules: post: description: Requisita a ordenação dos módulos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – modules properties: modules: type: array items: type: object allOf: – #/definitions/sortModule minimum: 1 description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/sortConfigurations: post: description: Requisita a ordenação das configurações de um módulo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – moduleId – configurations properties: moduleId: type: string description: configurations: type: array items: type: object allOf: – #/definitions/sortConfiguration minimum: 1 description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/updateFrontendProject: post: description: Atualiza as definições de um frontend tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/frontendProject responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica se a atualização foi feita com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/activateFrontendProject: post: description: Ativa/Desativa um projeto de frontend tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – projectName – projectVersion – activate properties: projectName: type: string description: Nome do projeto projectVersion: type: string description: Versão do projeto activate: type: boolean description: Indica se é para ativar/desativar o projeto. Ao desativar um projeto, o projeto do frontend padrão será ativado. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/createFrontendProject: post: description: Cria um projeto de frontend tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/frontendProject responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/deleteFrontendProject: post: description: Exclui um projeto de frontend. Não é possível excluir se o projeto estiver ativo. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – projectName – projectVersion properties: projectName: type: string description: Nome do projeto projectVersion: type: string description: Versão do projeto responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/addDynamicMenuItem: post: description: Adiciona um item ao menu unificado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parentDomainName – parentServiceName – parentFormId – label – formURL – openOption properties: parentDomainName: type: string description: Nome do domínio do item pai parentServiceName: type: string description: Nome do serviço do item pai parentFormId: type: string description: Identificador do item pai label: type: string description: Label do item de menu formURL: type: string description: URL do formulário que será adicionado ao menu openOption: type: string allOf: – #/definitions/openOptionEnum description: Modo de abertura do resource permissionResource: type: string description: identificador de permissão do resource (URI) permissionOperation: type: string description: Identificador da operação a ser realizada no formulário itemIcon: type: string description: Icone do item de menu (estilo) itemType: type: string description: Tipo do item helpId: type: string description: Id do help da tela helpContext: type: string description: Contexto do help da tela responses: 200: description: Ok schema: type: object required: – menuItemId properties: menuItemId: type: string description: Identificador único do item de menu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/addDynamicMenuItemByParentId: post: description: Adiciona um item ao menu unificado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parentMenuItemId – label – formURL – openOption properties: parentMenuItemId: type: string description: Id do item de menu pai label: type: string description: Label do item de menu formURL: type: string description: URL do formulário que será adicionado ao menu openOption: type: string allOf: – #/definitions/openOptionEnum description: Modo de abertura do resource permissionResource: type: string description: identificador de permissão do resource (URI) permissionOperation: type: string description: Identificador da operação a ser realizada no formulário itemIcon: type: string description: Icone do item de menu (estilo) itemType: type: string description: Tipo do item helpId: type: string description: Id do help da tela helpContext: type: string description: Contexto do help da tela responses: 200: description: Ok schema: type: object required: – menuItemId properties: menuItemId: type: string description: Identificador único do item de menu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/removeDynamicMenuItem: post: description: Remove um item de menu adicionado dinamicamente. Não remove nenhum item padrão ou customizado, somente os dinâmicos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – menuItemId properties: menuItemId: type: string description: Identificador único do item de menu responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/addActionMenuItem: post: description: Adiciona um item de menu ao menu de ações de um determinado formulário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – menuItem properties: menuItem: type: object allOf: – #/definitions/actionMenuItemDef description: responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/removeActionMenuItem: post: description: Apaga um item do menu de ações de um determinado formulário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName – hostFormId – label properties: domainName: type: string description: Nome do dominio do formulário que possui o menu de ações serviceName: type: string description: Nome do serviço do formulário que possui o menu de ações hostFormId: type: string description: Identificador do formulário que possui o menu de ações label: type: string description: Label do item de menu responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/addDynamicActionMenuItem: post: description: Adiciona um item de menu ao menu de ações de um determinado formulário. Podem ser adicionados formulários externos ou dinâmicos, através da URL passada como parâmetro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName – hostFormId – label – formURL – openOption properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço hostFormId: type: string description: Identificador da tela que possui o menu label: type: string description: Label do item de menu formURL: type: string description: URL do formulário que será adicionado ao menu de ações itemIcon: type: string description: Icone do item de menu (estilo) itemType: type: string description: Tipo do item openOption: type: string allOf: – #/definitions/openOptionEnum description: Modo de abertura do resource permissionResource: type: string description: identificador de permissão do resource (URI) permissionOperation: type: string description: Identificador da operação a ser realizada no formulário targetId: type: string description: Identificador do recurso que será adicionado ao menu responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/addDynamicActionMenuItemByMenuId: post: description: Adiciona um item de menu ao menu de ações de um determinado formulário. Podem ser adicionados formulários externos ou dinâmicos, através da URL passada como parâmetro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – menuItemId – label – formURL – openOption properties: menuItemId: type: string description: Id do item de menu a qual o item deve ser adicionado ao menu de ações label: type: string description: Label do item de menu formURL: type: string description: URL do formulário que será adicionado ao menu de ações itemIcon: type: string description: Icone do item de menu (estilo) itemType: type: string description: Tipo do item openOption: type: string allOf: – #/definitions/openOptionEnum description: Modo de abertura do resource permissionResource: type: string description: identificador de permissão do resource (URI) permissionOperation: type: string description: Identificador da operação a ser realizada no formulário targetId: type: string description: Identificador do recurso que será adicionado ao menu responses: 200: description: Ok schema: type: object required: – menuItemId properties: menuItemId: type: string description: Identificador único do item de menu do menu de ações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/removeDynamicActionMenuItem: post: description: Apaga um item dinâmico do menu de ações de um determinado formulário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName – hostFormId – formURL properties: domainName: type: string description: Nome do dominio do formulário que possui o menu de ações serviceName: type: string description: Nome do serviço do formulário que possui o menu de ações hostFormId: type: string description: Identificador do formulário que possui o menu de ações formURL: type: string description: URL do item de menu responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/removeDynamicActionMenuItemById: post: description: Apaga um item de menu dinâmico tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dynamicActionMenuItemId properties: dynamicActionMenuItemId: type: string description: Id do menu de ação dinâmico que deve ser removido responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/addFavoriteFolder: post: description: Cria uma pasta que pode conter itens favoritos de menu tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – folderName properties: folderName: type: string description: Nome da pasta a ser criada responses: 200: description: Ok schema: type: object required: – folderId properties: folderId: type: string description: Identificador da pasta recém-criada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/removeFavoriteFolder: post: description: Apaga uma pasta que pode conter itens favoritos de menu. Caso ela possua itens filhos, eles serão excluídos juntamente com a pasta. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – folderId properties: folderId: type: string description: Identificador da pasta responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/addFavorite: post: description: Cria um item favorito de menu. Este favorito é específico para cada usuário (obtido através do cabeçalho da mensagem). Se o folderId for nulo, então o item é criado na raíz dos favoritos, do contrário vai ser criado na pasta indicada. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName – formId properties: domainName: type: string description: Nome do dominio serviceName: type: string description: Nome do serviço formId: type: string description: Identificador do formulário folderId: type: string description: Identificador da pasta que contém o favorito. Se não for fornecido, o favorito está na pasta raíz responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/actions/removeFavorite: post: description: Remove um item do menu de favoritos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName – formId properties: domainName: type: string description: Nome do dominio serviceName: type: string description: Nome do serviço formId: type: string description: Identificador do item responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/signals/generateDefaultAndActiveMenu: post: description: Gera o menu padrão e o menu ativo de todos os tenants. Essa primitiva é para ser chamada pelo tenant master quando módulos padrões forem adicionados/alterados.\nEsse processo pode ser demorado, por isso ocorre de forma assíncrona. O usuário que chamou a primitiva receberá uma notificação no final do processo. tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: moduleId: type: string description: Id do módulo que deve ter o menu regerado. Esse campo é opcional, se for informado irá regerar apenas o menu desse módulo em específico. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /menu/entities/module: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/module responses: 200: description: The created resource schema: #/definitions/module 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/module responses: 200: description: The created resource schema: #/definitions/module 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/module 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/entities/module/{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/module responses: 200: description: Ok schema: #/definitions/module 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/module responses: 200: description: Ok schema: #/definitions/module 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/module 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 /menu/entities/module/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/module responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/entities/frontendConfiguration: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/frontendConfiguration responses: 200: description: The created resource schema: #/definitions/frontendConfiguration 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/frontendConfiguration responses: 200: description: The created resource schema: #/definitions/frontendConfiguration 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/frontendConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/entities/frontendConfiguration/{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/frontendConfiguration responses: 200: description: Ok schema: #/definitions/frontendConfiguration 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/frontendConfiguration responses: 200: description: Ok schema: #/definitions/frontendConfiguration 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/frontendConfiguration 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 /menu/entities/frontendConfiguration/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/frontendConfiguration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/entities/menuItemChange: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/menuItemChange responses: 200: description: The created resource schema: #/definitions/menuItemChange 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/menuItemChange responses: 200: description: The created resource schema: #/definitions/menuItemChange 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/menuItemChange 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /menu/entities/menuItemChange/{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/menuItemChange responses: 200: description: Ok schema: #/definitions/menuItemChange 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/menuItemChange responses: 200: description: Ok schema: #/definitions/menuItemChange 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/menuItemChange 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 /menu/entities/menuItemChange/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/menuItemChange responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: description: Status do Healthcheck type: string enum: – UP – DOWN openOptionEnum: description: type: string enum: – Boxlet – Dashboard – CurrentTab – NewTab – NewWindow – DesktopNative 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: Componente avaliado no health check type: object required: – name – status properties: name: type: string description: Nome do componente status: type: string allOf: – #/definitions/healthCheckStatus description: Status do componente favoriteFolderDef: description: type: object required: – folderId – folderName properties: folderId: type: string description: folderName: type: string description: sortModule: description: Representa um módulo que será ordenado type: object required: – moduleId – defaultModule properties: moduleId: type: string description: ID do módulo. defaultModule: type: boolean description: Indica se este módulo é um módulo padrão. sortConfiguration: description: Representa uma configuração que será ordenada type: object required: – configurationId – defaultFrontend properties: configurationId: type: string description: ID da configuração defaultFrontend: type: boolean description: Indica se este frontend é um frontend padrão actionMenuItemDef: description: Representa um item que deve ser adicionado ao menu de ações de uma determinada tela type: object required: – domainName – serviceName – hostFormId – label – menuCommand properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço hostFormId: type: string description: Identificador da tela que possui o menu label: type: string description: Label do item de menu menuCommand: type: object allOf: – #/definitions/menuCommandDef description: comando atrelado ao item de menu itemIcon: type: string description: Icone do item de menu (estilo) itemType: type: string description: Tipo do item module: description: Representa um módulo type: object required: – name properties: id: type: string description: ID do módulo. Não informar na criação, apenas na atualização. name: type: string description: Nome do módulo nameI18n: type: string description: Chave de tradução do nome do módulo. Se não for informado ou a chave não existir, será usado o valor informado em name. icon: type: string description: Icone do módulo defaultModule: type: boolean description: Indica se este módulo é um módulo padrão. sequence: type: integer format: int64 description: Sequencia do módulo frontends: type: array items: type: object allOf: – #/definitions/frontendConfiguration description: Lista com todas as configurações de frontend deste módulo. Somente leitura, não informar na criação do módulo. frontendConfiguration: description: Representa uma definição da configuração de um frontend type: object required: – moduleId properties: id: type: string description: Id da configuração do frontend. Não informar na criação, apenas na atualização. configurationUrl: type: string description: Endereço do arquivo de configuração do frontend moduleId: type: string description: Id do módulo ao qual o frontend pertence. defaultFrontend: type: boolean description: Indica se este frontend é um frontend padrão enabled: type: boolean description: Indica se este frontend está habilitado. objectId: type: string description: Id do objeto gerado quando a configuração é mantida na plataforma, necessário quando configurationPersisted verdadeiro fileName: type: string description: Nome do arquivo de configuração mantido na plataforma, necessário quando configurationPersisted é verdadeiro configurationPersisted: type: boolean description: Indica se o arquivo de configuração do frontend é mantido na plataforma default: false sequence: type: integer format: int64 description: Sequencia da configuração menuItemChange: description: Representa uma alteração em um item do menu type: object required: – menuItemId – openOption – url properties: id: type: string description: Id da alteração do item do menu. Não informar na criação, apenas na atualização menuItemId: type: string description: Id do item do menu que deve ter os seus dados alterados domain: type: string description: Nome do domínio service: type: string description: Nome do serviço label: type: string description: Rótulo do item do menu labelI18n: type: string description: Chave de tradução do label do item de menu icon: type: string description: Ícone do item do menu (Estilo) openOption: type: string allOf: – #/definitions/openOptionEnum description: Modo de abertura da tela resource: type: string description: Recurso necessário para visualizar o menu action: type: string description: Ação necessária para visualizar o menu withCredentials: type: boolean description: Indica se as credenciais devem ser enviadas junto a requisição (Padrão false) default: false url: type: string description: URL da tela que deve ser aberta helpId: type: string description: Id do help da tela helContext: type: string description: Context do help da tela frontendProject: description: Representa uma definição de frontend type: object required: – projectName – forms – menu properties: id: type: string description: Identificador único da definição do frontend projectName: type: string description: Nome ou ID do projeto projectVersion: type: string description: Versão do projeto forms: type: array items: type: object allOf: – #/definitions/formProject minimum: 1 description: Telas que o projeto possui menu: type: object allOf: – #/definitions/menuItemProject description: Menu com todas as telas active: type: boolean description: Indica se o projeto está ativo. Apenas leitura. Para ativar um frontend use a primitiva activateFrontend isDefault: type: boolean description: Indica se é o projeto padrão. Só pode haver um projeto padrão. lastUpdate: type: string format: date-time description: Indica a data que o projeto de frontend foi atualizado formProject: description: 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 featureURL: type: string description: URL da feature vinculada a tela helpId: type: string description: Id do help da tela helpContext: type: string description: Contexto do help da tela menuItemProject: description: Representa um item de menu para ser registrado junto com os formulários, em um projeto de frontend type: object required: – label properties: id: type: string description: Identificador único do item de menu label: type: string description: Label do item de menu labelI18n: type: string description: Chave para a tradução do label do item de menu fallbacksLabel: type: array items: type: object allOf: – #/definitions/fallbackLabel description: Fallbacks de traduções nos idiomas padrão da plataforma menuCommand: type: object allOf: – #/definitions/menuCommandProject description: comando atrelado ao item de menu subMenuItems: type: array items: type: object allOf: – #/definitions/menuItemProject description: itens de menu itemIcon: type: string description: Icone do item de menu (estilo) itemType: type: string description: Tipo do item visible: type: boolean description: Indica se este item de menu deve ser mostrado order: type: integer format: int64 description: Ordem do item de menu fallbackLabel: description: Representa uma configuração de tradução fallback para ser utilizada nos itens de menu type: object required: – language – translation properties: language: type: string description: Definição da linguagem translation: type: string description: Tradução da label do menu menuCommandProject: description: Representa um comando que um item de menu executa. Utilizado apenas no registro do projeto de frontend type: object required: – domainName – serviceName – formId – openOption properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço formId: type: string description: Identificador da tela withCredentials: type: boolean description: Define se as credenciais devem ser enviadas junto com o request openOption: type: string allOf: – #/definitions/openOptionEnum description: Modo de abertura do resource permissionResource: type: string description: identificador de permissão do resource (URI) permissionOperation: type: string description: Identificador da operação a ser realizada no formulário featureName: type: string description: Nome da feature vinculada ao menu featureVisible: type: boolean description: Indica se o menu deverá ser visível para todos, nesse caso quem não tiver a feature habilitada usa a url original default: false featureOpenOption: type: string allOf: – #/definitions/openOptionEnum description: Modo de abertura da feature menu: description: Representa um menu type: object required: – subMenuItems properties: subMenuItems: type: array items: type: object allOf: – #/definitions/menuItem minimum: 1 description: Sub-itens deste menu menuItem: description: Representa um item de menu para ser exibido na tela. Os itens que são aqui listados já tiveram a verificação de permissão de acesso efetuada type: object required: – formDomain – formService – menuItemId – label – openOption – itemIcon – itemType – formURL – subMenuItems – favorite properties: formDomain: type: string description: Domínio do formulário formService: type: string description: Serviço do formulário menuItemId: type: string description: Identificador do item do menu label: type: string description: Rótulo do menu openOption: type: string allOf: – #/definitions/openOptionEnum description: Modo default de abertura do resource withCredentials: type: boolean description: Define se as credenciais são passadas na requisição ou não itemIcon: type: string description: Icone do item de menu (estilo) itemType: type: string description: Tipo do item 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 subMenuItems: type: array items: type: object allOf: – #/definitions/menuItem minimum: 1 description: Sub-itens deste item de menu favorite: type: boolean description: Indica se o item é um favorito order: type: integer format: int64 description: Ordem do item de menu permissionResource: type: string description: identificador de permissão do resource (URI) permissionOperation: type: string description: Identificador da operação a ser realizada no formulário menuCommandDef: description: Representa um comando que um item de menu executa. Utilizado apenas no registro do projeto de frontend type: object required: – domainName – serviceName – formId – openOption properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço formId: type: string description: Identificador da tela withCredentials: type: boolean description: Define se as credenciais devem ser enviadas junto com o request openOption: type: string allOf: – #/definitions/openOptionEnum description: Modo de abertura do resource permissionResource: type: string description: identificador de permissão do resource (URI) permissionOperation: type: string description: Identificador da operação a ser realizada no formulário actionMenuItem: description: type: object required: – menuItemId – label – openOption – itemIcon – itemType – formURL properties: menuItemId: type: string description: Identificador do item do menu label: type: string description: Rótulo do menu openOption: type: string allOf: – #/definitions/openOptionEnum description: Modo default de abertura do resource itemIcon: type: string description: Icone do item de menu (estilo) itemType: type: string description: Tipo do item 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 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

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação