2.0info: 5.22.0 Gerenciamento de conteúdo description: Responsável pelo gerenciamento de conteúdo na plataforma G7. x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: cms 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: /cms/queries/listWidgets: post: description: Lista todos os widgets do tenant que o usuário possui permissão para utilizar tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado nos campos internacionalizados e nas tags ignorando caracteres maiúsculos e minúsculos pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – widgets – listInformation properties: widgets: type: array items: type: object allOf: – #/definitions/widget minimum: 1 description: Os widgets que o usuário possui permissão de visualizar listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/queries/getWidget: post: description: Exibe as informações do widget buscando através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – widgetId properties: widgetId: type: string description: O identificador do widget responses: 200: description: Ok schema: type: object allOf: – #/definitions/widget 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Componente não encontrado default: description: Error response schema: #/definitions/genericError get: description: Exibe as informações do widget buscando através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: widgetId description: O identificador do widget in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/widget 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Componente não encontrado default: description: Error response schema: #/definitions/genericError /cms/queries/countAnalyticsDataset: post: description: Retorna a quantidade de analytics que estão utilizando o dataset tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – datasetId properties: datasetId: type: string description: Identificador do dataset seguindo o padrão: dataset://tenantDomain/identificadorUnico responses: 200: description: Ok schema: type: object required: – size properties: size: type: integer format: int64 description: Retorna a quantidade de analytics que utilizam o dataset 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de analytics que estão utilizando o dataset tags: – Queries x-senior-visibility: PUBLIC parameters: – name: datasetId description: Identificador do dataset seguindo o padrão: dataset://tenantDomain/identificadorUnico in: query required: true type: string responses: 200: description: Ok schema: type: object required: – size properties: size: type: integer format: int64 description: Retorna a quantidade de analytics que utilizam o dataset 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /cms/queries/getAnalytic: post: description: Busca informações de um analytic\n ### Resources:\n – res:// tenant ou dominio do tenant /custom/analytic/ identificador único \n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – analyticId properties: analyticId: type: string description: identificador do analytic responses: 200: description: Ok schema: type: object required: – analytic properties: analytic: type: object allOf: – #/definitions/analytic description: Os dados do componente 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatório não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Analytic não encontrado default: description: Error response schema: #/definitions/genericError get: description: Busca informações de um analytic\n ### Resources:\n – res:// tenant ou dominio do tenant /custom/analytic/ identificador único \n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: analyticId description: identificador do analytic in: query required: true type: string responses: 200: description: Ok schema: type: object required: – analytic properties: analytic: type: object allOf: – #/definitions/analytic description: Os dados do componente 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatório não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Analytic não encontrado default: description: Error response schema: #/definitions/genericError /cms/queries/getAnalytics: post: description: Lista os analytics filtrando por ids tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ids properties: ids: type: array items: type: string minimum: 1 description: identificadores para filtrar responses: 200: description: Ok schema: type: object required: – analytics properties: analytics: type: array items: type: object allOf: – #/definitions/basicAnalytic minimum: 1 description: Analytics ordenados pelo nome 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Lista os analytics filtrando por ids tags: – Queries x-senior-visibility: PUBLIC parameters: – name: ids description: identificadores para filtrar in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – analytics properties: analytics: type: array items: type: object allOf: – #/definitions/basicAnalytic minimum: 1 description: Analytics ordenados pelo nome 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /cms/queries/listAnalytics: post: description: Lista os componentes do tipo analytics tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: Valor a ser buscado no nome do analytic, uri ou tags pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – analytics – listInformation properties: analytics: type: array items: type: object allOf: – #/definitions/basicAnalytic minimum: 1 description: Os registros retornados da listagem listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/queries/getPageResources: post: description: Retorna todos os recursos utilizados para a exibição de uma página\n ### Resources:\n – res:// tenant ou domínio do tenant /custom/page/ identificador único \n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pageId properties: pageId: type: string description: Identificador da página responses: 200: description: Ok schema: type: object properties: resources: type: array items: type: object allOf: – #/definitions/pageResource description: Recursos da página por tipo 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campos informados incorretamente 403: description: Permissão negada 404: description: Página não encontrada default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os recursos utilizados para a exibição de uma página\n ### Resources:\n – res:// tenant ou domínio do tenant /custom/page/ identificador único \n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: pageId description: Identificador da página in: query required: true type: string responses: 200: description: Ok schema: type: object properties: resources: type: array items: type: object allOf: – #/definitions/pageResource description: Recursos da página por tipo 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campos informados incorretamente 403: description: Permissão negada 404: description: Página não encontrada default: description: Error response schema: #/definitions/genericError /cms/queries/listFactoryDefaultAnalytics: post: description: Lista os componentes do tipo analytics padrões de fábrica tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: Valor a ser buscado no nome do analytic, uri ou tags pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – analytics – listInformation properties: analytics: type: array items: type: object allOf: – #/definitions/basicAnalytic minimum: 1 description: Os registros retornados da listagem listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /cms/queries/listFactoryDefaultPages: post: description: Lista as pages padrões de fábrica tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no campo nome da página. pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – pages – listInformation properties: pages: type: array items: type: object allOf: – #/definitions/basicPage minimum: 1 description: Os registros retornados da listagem listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /cms/queries/listFactoryDefaultLandingPages: post: description: Lista as landing pages padrões de fábrica tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no campo título. pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – landingPages – listInformation properties: landingPages: type: array items: type: object allOf: – #/definitions/basicLandingPage minimum: 1 description: Os registros retornados da listagem listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /cms/queries/listFactoryDefaultWidgets: post: description: Lista os componentes do tipo widgets padrões de fábrica tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado nos campos internacionalizados e nas tags ignorando caracteres maiúsculos e minúsculos pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – widgets – listInformation properties: widgets: type: array items: type: object allOf: – #/definitions/widget minimum: 1 description: Os registros retornados da listagem listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /cms/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 /cms/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/registerWidget: post: description: Registra um widget.\n Caso um widget com esse identificador já exista, as informações são atualizadas.\n O padrão do identificador deverá seguir: widget://{tenant ou domínio do tenant}/custom/{serviço}/{nome}\n ### Resources:\n – res://senior.com.br/platform/cms/widget\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – widget properties: widget: type: object allOf: – #/definitions/widget description: Dados do Widget para ser registrado responses: 200: description: Ok schema: type: object required: – widgetId properties: widgetId: type: string description: Identificador do widget registrado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /cms/actions/registerFactoryWidget: post: description: Registra um widget de fábrica, disponível para todos os tenants.\n Caso um widget com esse identificador já exista, as informações são atualizadas.\n O padrão do identificador do widget deverá seguir: widget://senior.com.br/{dominio}/{serviço}/{nome} tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – widget properties: widget: type: object allOf: – #/definitions/widgetRegistry description: Dados do widget para ser registrado tenant: type: string description: Tenant que receberá o widget de fábrica (obrigatório caso o widget não seja padrão de fábrica/shared) responses: 200: description: Ok schema: type: object required: – widgetId properties: widgetId: type: string description: Identificador do widget registrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/unregisterFactoryWidget: post: description: Desregistra um widget de fábrica tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – widgetId properties: widgetId: type: string description: Identificador do widget a ser desregistrado responses: 200: description: Ok schema: type: object required: – widgetId properties: widgetId: type: string description: Identificador do widget a ser desregistrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/unregisterWidget: post: description: Desregistra um widget\n ### Resources:\n – res://senior.com.br/platform/cms/widget\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – widgetId properties: widgetId: type: string description: identificador do widget a ser desregistrado responses: 200: description: Ok schema: type: object required: – widgetId properties: widgetId: type: string description: Identificador do widget a ser desregistrado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Widget não encontrado default: description: Error response schema: #/definitions/genericError /cms/actions/registerAnalytic: post: description: Registra um analytic.\n Caso um analytic com esse identificador já exista, as informações são atualizadas.\n ### Resources:\n – res://senior.com.br/platform/cms/analytics\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – name – chart properties: id: type: string maxLength: 255 description: Identificador do analytics seguindo o padrão: analytic://tenantDomain/identificadorUnico name: type: string maxLength: 255 description: Nome do analytic type: string maxLength: 255 description: Título a ser exibido podendo ser uma chave de tradução no padrão platform.cms.nome chart: type: object allOf: – #/definitions/chart description: Informações do gráfico do analytic, se não informado será mantido o estado anterior. preferredSize: type: object allOf: – #/definitions/preferredSize description: O tamanho preferido para melhor visualização tags: type: array items: type: string description: As tags associadas a esse analytic properties: type: array items: type: object allOf: – #/definitions/property description: Propriedades adicionais do painel.\n Quando uma propriedade é omitida, a mesma é removida. hideProjectionFilters: type: boolean description: Flag para definir se no widget deve aparecer os filtro de projeção, o padrão é false que no caso irá aparecer os filtros default: false additionalFilter: type: object allOf: – #/definitions/additionalFilter description: Filtros adicionais para o dataset do analytic responses: 200: description: Ok schema: type: object required: – id properties: id: type: string maxLength: 255 description: Identificador do analytic criado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /cms/actions/unregisterAnalytic: post: description: Desregistra um analytic\n ### Resources:\n – res:// tenant ou dominio do tenant /custom/analytic/ identificador único \n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – analyticId properties: analyticId: type: string description: identificador do analytic a ser desregistrado responses: 200: description: Ok schema: type: object required: – analyticId properties: analyticId: type: string description: Identificador do analytic desregistrado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Analytic não encontrado default: description: Error response schema: #/definitions/genericError /cms/actions/registerFactoryAnalytic: post: description: Registra um analytic de fábrica.\n Caso um analytic com esse identificador já exista, as informações são atualizadas. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – analytic – tenant properties: analytic: type: object allOf: – #/definitions/analyticRegistry description: Dados do analytic para ser cadastrado tenant: type: string description: Tenant que sera cadastrado o analytic responses: 200: description: Ok schema: type: object required: – id properties: id: type: string maxLength: 255 description: Identificador do analytic criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/unregisterFactoryAnalytic: post: description: Desregistra um analytic de fábrica tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – analyticId – tenant properties: analyticId: type: string maxLength: 255 description: identificador do analytic a ser desregistrado seguindo o padrão: analytic://factory/tenantDomain/identificadorUnico tenant: type: string description: Tenant que esta cadastrado o analytic responses: 200: description: Ok schema: type: object required: – analyticId properties: analyticId: type: string maxLength: 255 description: Identificador do analytic desregistrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/savePage: post: description: Cria ou atualiza uma página\n ### Resources:\n – res://senior.com.br/platform/cms/page\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – name – components properties: id: type: string description: Identificador da página no padrão page://{domínio do tenant}/{identificador único da página} name: type: string description: Nome da página credentials: type: boolean description: Indica se devem ser enviadas as credenciais para os componentes da página default: false includeToolbar: type: boolean description: Indica se devem ser exibido a barra de ferramentas na página ou não default: false positionType: type: string allOf: – #/definitions/positionType description: Indica se os componentes possuirão tamanhos absolutos (fixos) ou relativos à tela components: type: array items: type: object allOf: – #/definitions/basicComponent minimum: 1 description: Os componentes da página globalFilterCollapsable: type: boolean description: Determinar se o Filtro Global será Colapsável default: false globalFilterCollapsed: type: boolean description: Determinar se o Filtro Global iniciará colapsado default: false disabledIFrameCache: type: boolean description: Desativar o cache do IFrame default: false responses: 200: description: Ok schema: type: object required: – pageId properties: pageId: type: string description: Identificador da página 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Pemissão negada default: description: Error response schema: #/definitions/genericError /cms/actions/saveFactoryPage: post: description: Cria ou atualiza uma página de fábrica tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page – tenant properties: page: type: object allOf: – #/definitions/pageRegistry description: Dados da page de fábrica que será salva tenant: type: string description: Nome do tenant que sera inserido ou atualizado a page (sem efeito se for um shared) responses: 200: description: Ok schema: type: object required: – pageId properties: pageId: type: string description: Identificador da página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/copyPage: post: description: Cria uma copia identica de uma página com seu conteúdo e gera um novo recurso com o usuário que efetuou a copia como owner\n ### Resources:\n – res://senior.com.br/platform/cms/page (Editar/Personalizar)\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pageId – name properties: pageId: type: string description: Identificador da página a ser copiada no padrão page://{domínio do tenant}/{identificador único da página} name: type: string description: Nome da nova página responses: 200: description: Ok schema: type: object required: – pageId properties: pageId: type: string description: Identificador da nova página 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Página não encontratada default: description: Error response schema: #/definitions/genericError /cms/actions/copyAnalytic: post: description: Cria uma copia identica de um analytic com seu conteúdo e gera um novo recurso com o usuário que efetuou a copia como owner\n ### Resources:\n – res://senior.com.br/platform/cms/analytics\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – analyticId – name properties: analyticId: type: string description: Identificador do analytic a ser copiado no padrão analytics://{domínio do tenant}/{identificador único do analytic}\n ou analytics://factory/{domínio do tenant}/{identificador único do analytic} name: type: string description: Nome do novo analytics responses: 200: description: Ok schema: type: object required: – analyticId properties: analyticId: type: string description: Identificador do novo analytic 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Identificador inválido do widget default: description: Error response schema: #/definitions/genericError /cms/actions/removePage: post: description: Permite remover uma página existente.\n É necessário possuir permissão o recurso customizado na ação Excluir.\n Se remover uma página em uso por uma landing page, a mesma também é removida.\n ### Resources:\n – res:// tenant ou dominio do tenant /custom/page/ identificador único \n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pageId properties: pageId: type: string description: Identificador da página a ser excluída responses: 200: description: Ok schema: type: object required: – pageId properties: pageId: type: string description: Identificador da página excluída 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Página não encontrada default: description: Error response schema: #/definitions/genericError /cms/actions/removeFactoryPage: post: description: Permite remover uma página de fábrica existente no tenant ou da base shared.\n É necessário possuir permissão o recurso de fábrica de pages na ação Excluir.\n Se remover uma página em uso por uma landing page, a mesma só será removida no\n tenant corrente mas os demais ficarão com uma referência quebrada. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pageId – tenant properties: pageId: type: string description: Identificador da página de fábrica a ser excluída tenant: type: string description: Tenant que está cadastrada a page responses: 200: description: Ok schema: type: object required: – pageId properties: pageId: type: string description: Identificador da página de fábrica excluída 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/getPage: post: description: Permite buscar as informações de uma página\n ### Resources:\n – res:// tenant ou dominio do tenant /custom/page/ identificador único \n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pageId properties: pageId: type: string description: Identificador da página responses: 200: description: Ok schema: type: object required: – page properties: page: type: object allOf: – #/definitions/page description: Informações da página 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Página não encontrada default: description: Error response schema: #/definitions/genericError /cms/actions/listPages: post: description: Lista as páginas que o usuário tem acesso para visualizar.\n ### Resources:\n – res://senior.com.br/platform/cms/page (Visualizar/Personalizar)\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no campo nome da página. ownerOnly: type: boolean description: Filtrar para somente as páginas criadas pelo usuário corrente default: false pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – pages – listInformation properties: pages: type: array items: type: object allOf: – #/definitions/basicPage minimum: 1 description: Retorna as páginas listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/saveLandingPage: post: description: Permite adicionar uma página à landing page.\n Para vincular a página, será necessário ter permissão de visualização para a mesma.\n Se possuir somente a ação Personalizar, então só poderá criar páginas do tipo PERSONAL.\n ### Resources:\n – res://senior.com.br/platform/cms/page (Editar/Personalizar)\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – pageId – title – landingPageType properties: id: type: string description: Identificador da landing page no formato landing://{domínio do tenant}/{identificador único da página} pageId: type: string description: Identificador da página type: string description: Título da página includeHeader: type: boolean description: Se inclui o header da página com o título default: false landingPageType: type: string allOf: – #/definitions/landingPageType description: Tipo da landing page roles: type: array items: type: string description: Papéis da landing page se for compartilhada, se omitido, não realiza alterações responses: 200: description: Ok schema: type: object required: – landingPageId properties: landingPageId: type: string description: Identificador da landing page 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campos informados incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /cms/actions/saveFactoryLandingPage: post: description: Permite adicionar uma landing page de fábrica que deverá apontar para uma Page de fábrica. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – landingPage – tenant properties: landingPage: type: object allOf: – #/definitions/landingPageRegistry description: Laning Page que será adicionada tenant: type: string description: Nome do tenant que sera inserido ou atualizado a page (sem efeito se for uma shared) responses: 200: description: Ok schema: type: object required: – landingPageId properties: landingPageId: type: string description: Identificador da landing page 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/removeLandingPage: post: description: Permite remover uma landing page existente. Se possuir permissão somente na ação Personalizar, então só poderá excluir as landing pages pessoais.\n ### Resources:\n – res://senior.com.br/platform/cms/page (Excluir/Personalizar)\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – landingPageId properties: landingPageId: type: string description: Identificador da página a ser excluída responses: 200: description: Ok schema: type: object required: – landingPageId properties: landingPageId: type: string description: Identificador da página excluída 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Página não encontrada default: description: Error response schema: #/definitions/genericError /cms/actions/removeFactoryLandingPage: post: description: Permite remover uma landing page de fábrica. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – landingPageId – tenant properties: landingPageId: type: string description: Identificador da página a ser excluída tenant: type: string description: Tenant que está cadastrada a page de fábrica (sem efeito caso a landing page seja padrão/shared) responses: 200: description: Ok schema: type: object required: – landingPageId properties: landingPageId: type: string description: Identificador da página excluída 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/getLandingPage: post: description: Permite buscar as informações de uma landing page com as informações da página vinculada\n ### Resources:\n – res:// tenant ou dominio do tenant /custom/landing_page/ identificador único \n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – landingPageId properties: landingPageId: type: string description: Identificador da landing page responses: 200: description: Ok schema: type: object required: – landingPage properties: landingPage: type: object allOf: – #/definitions/landingPage description: Informações completas da landing page com a página 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Landing page não encontrada default: description: Error response schema: #/definitions/genericError /cms/actions/getUserLandingPages: post: description: Lista as landing pages para visualização pelo usuário. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – landingPages properties: landingPages: type: array items: type: object allOf: – #/definitions/basicLandingPage minimum: 1 description: Retorna as informações das landing pages 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/listLandingPages: post: description: Lista as landing pages para administração. Se não possuir permissão na ação Visualizar, então o usuário só poderá consultar as suas landing pages.\n ### Resources\n – res://senior.com.br/platform/cms/page (Visualizar/Personalizar)\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no campo título. pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – landingPages – listInformation properties: landingPages: type: array items: type: object allOf: – #/definitions/basicLandingPage minimum: 1 description: Retorna as páginas, por questões de performance, os papéis em páginas compartilhadas não será retornado listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /cms/actions/saveLandingPagesOrder: post: description: Altera a ordem das landing pages\n ### Resources:\n – res://senior.com.br/platform/cms/page (Editar/Personalizar)\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – landingPageId properties: landingPageId: type: array items: type: string minimum: 1 description: Os identificadores das landing pages na ordem que elas devem ser apresentadas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválidas, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /cms/actions/removePersonalLandingPages: post: description: Apaga todas as landing pages personalizadas do usuário corrente ou do usuário informado\n ### Resources:\n – res://senior.com.br/platform/cms/page (Excluir/Personalizar)\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: user: type: string description: Nome do usuário com domínio, ex: admin@senior.com.br.\n Se não informado será considerado o usuário corrente.\n Usuários com somente permissão de personalizar só podem remover suas próprias páginas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /cms/actions/removeAllPersonalLandingPages: post: description: Apaga todas as landing pages personalizadas de todos os usuários tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cms/actions/setPageAnalyticFilter: post: description: Salva os filtros alterados do analytic na página para o usuário do contexto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pageId – analyticId properties: pageId: type: string description: Identificador da página analyticId: type: string description: Identificador do analytic filter: type: object allOf: – #/definitions/expression description: Filtros order: type: array items: type: object allOf: – #/definitions/order description: A ordenação dos registros additionalFilter: type: object allOf: – #/definitions/additionalFilter description: Filtros adicionais para o dataset do analytic responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campos informados incorretamente 404: description: Página não encontrada default: description: Error response schema: #/definitions/genericErrordefinitions: seriesFormat: description: type: string enum: – DECIMAL – MONEY – SHORT – TIME – DATE – DATETIME – COMPLETED seriesType: description: type: string enum: – AREA – BAR – COLUMN – BUBBLE – LINE chartType: description: Tipo do gráfico a ser exibido type: string enum: – BAR – STACKED_BAR – COLUMN – STACKED_COLUMN – PIE – AREA – LINE – TABLE – BUBBLE – GAUGE – COUNTER – TEXT – RADAR – MAP – HEATMAP – FILTER – MULTIAXIES – MULTIBARS – MULTICOLS – BARSLINES – HOTMAP – POINTMAP – POLAR_AREA – POLAR_BUBBLE – POLAR_COLUMN – POLAR_LINE – RADIAL – SOLIDGAUGE – STATIC – MIXED functionType: description: Tipo da função a ser aplicada na projeção type: string enum: – AVG – COUNT – MAX – MIN – SUM – COUNT_DISTINCT positionType: description: Tipo do posicionamento dos componentes type: string enum: – ABSOLUTE – RELATIVE landingPageType: description: Tipo da landing page type: string enum: – DEFAULT – SHARED – PERSONAL columnType: description: Tipo de dado da coluna type: string enum: – STRING – INTEGER – DATE – DATETIME – TIME – BOOLEAN – DECIMAL – INVALID relationalOperator: description: Operador relacional type: string enum: – EQUAL – NOT_EQUAL – GREATER_THAN – GREATER_THAN_OR_EQUAL – LESS_THAN – LESS_THAN_OR_EQUAL – EMPTY – NOT_EMPTY – CONTAINS – DOES_NOT_CONTAINS – STARTS_WITH – ENDS_WITH – IN – NOT_IN – BETWEEN logicalOperator: description: Operadores lógicos para agregação de filtros (condições) SQL type: string enum: – AND – OR orderType: description: Tipo da ordenação type: string enum: – ASC – DESC componentType: description: Tipo de componente para os recursos type: string enum: – DATASET – ANALYTIC – WIDGET tooltipFormat: description: type: string enum: – DECIMAL – MONEY – SHORT 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 basicPage: description: Informações básicas de uma página para listagem type: object required: – id – name – permission properties: id: type: string description: Identificador da página no padrão page://{domínio do tenant}/{identificador único da página} name: type: string description: Nome da página credentials: type: boolean description: Indica se devem ser enviadas as credenciais para os componentes da página default: false positionType: type: string allOf: – #/definitions/positionType description: Indica se os componentes possuirão tamanhos absolutos (fixos) ou relativos à tela permission: type: object allOf: – #/definitions/permission description: Permissão necessária para visualizar a página page: description: Informações completas de uma página e todos seus componentes type: object required: – id – name – permission – components properties: id: type: string description: Identificador da página no padrão page://{domínio do tenant}/{identificador único da página} name: type: string description: Nome da página credentials: type: boolean description: Indica se devem ser enviadas as credenciais para os componentes da página default: false positionType: type: string allOf: – #/definitions/positionType description: Indica se os componentes possuirão tamanhos absolutos (fixos) ou relativos à tela permission: type: object allOf: – #/definitions/permission description: Permissão necessária para visualizar a página components: type: array items: type: object allOf: – #/definitions/component minimum: 1 description: Os componentes da página includeToolbar: type: boolean description: Mostrar o barra de ferramentas na página default: false globalFilterCollapsable: type: boolean description: Determinar se o Filtro Global será Colapsável default: false globalFilterCollapsed: type: boolean description: Determinar se o Filtro Global iniciará colapsado default: false disabledIFrameCache: type: boolean description: Desativar o cache do IFrame default: false component: description: Informações de um componente em uma página.\n Pode ser do tipo: tabsComponent, widgetComponent, urlComponent, analyticComponent discriminator: _discriminator type: object required: – height – width – position – _discriminator properties: height: type: integer format: int64 description: Altura minimum: 1 width: type: integer format: int64 description: Largura minimum: 1 maximum: 12 position: type: object allOf: – #/definitions/position description: Posição onde inicia a exibição do componente _discriminator: type: string description: tabsComponent: description: Componente do tipo agrupador de abas allOf: – #/definitions/component – type: object required: – tabs properties: tabs: type: array items: type: object allOf: – #/definitions/tabComponent minimum: 1 description: As abas e seus componentes tabComponent: description: Componente do tipo aba type: object required: – name properties: name: type: string maxLength: 255 description: Nome da aba components: type: array items: type: object allOf: – #/definitions/component description: Os componentes vinculados a aba tabOrder: type: integer format: int64 description: Ordenação das Tabs default: 0 urlComponent: description: Componente onde é somente uma URL allOf: – #/definitions/component – type: object required: – url properties: url: type: string maxLength: 1000 description: URL do componente widgetComponent: description: Componente do tipo widget e suas informações allOf: – #/definitions/component – type: object required: – widgetId – name – description – thumbnailURL – url – preferredSize properties: widgetId: type: string maxLength: 255 description: Identificador do widget vinculado name: type: string description: Nome do widget description: type: string description: Descrição do widget thumbnailURL: type: string description: URL do thumbnail url: type: string maxLength: 1000 description: URL do widget preferredSize: type: object allOf: – #/definitions/preferredSize description: O tamanho preferido para melhor visualização hideProjectionFilters: type: boolean description: Flag para definir se no widget deve aparecer os filtro de projeção, o padrão é false que no caso irá aparecer os filtros default: false analyticComponent: description: Componente do tipo analytic e suas informações allOf: – #/definitions/component – type: object required: – analyticId – name – title – chart – preferredSize properties: analyticId: type: string maxLength: 255 description: Identificador do analytic name: type: string description: Nome do widget type: string maxLength: 255 description: Título chart: type: object allOf: – #/definitions/chart description: Informações do gráfico do analytic properties: type: array items: type: object allOf: – #/definitions/property description: Propriedades adicionais do analytic preferredSize: type: object allOf: – #/definitions/preferredSize description: O tamanho preferido para melhor visualização customFilter: type: object allOf: – #/definitions/expression description: Filtros do usuário em relação à página customOrder: type: array items: type: object allOf: – #/definitions/order description: Ordenações adicionais do usuário em relação à página customAdditionalFilter: type: object allOf: – #/definitions/additionalFilter description: Filtros adicionais do usuário em relação à página hideProjectionFilters: type: boolean description: Flag para definir se no widget deve aparecer os filtro de projeção, o padrão é false que no caso irá aparecer os filtros default: false formComponent: description: Componente do tipo form com suporte ao CRUD allOf: – #/definitions/component – type: object required: – formId – formName properties: formId: type: string description: Identificador do formulário formName: type: string description: Nome do formulário basicComponent: description: Informações de um componente em uma página.\n Pode ser do tipo: basicTabsComponent, basicWidgetComponent, basicUrlComponent, basicAnalyticComponent discriminator: _discriminator type: object required: – height – width – position – _discriminator properties: height: type: integer format: int64 description: Altura minimum: 1 width: type: integer format: int64 description: Largura minimum: 1 maximum: 12 position: type: object allOf: – #/definitions/position description: Posição onde inicia a exibição do componente _discriminator: type: string description: basicTabsComponent: description: Componente do tipo agrupador de abas allOf: – #/definitions/basicComponent – type: object required: – tabs properties: tabs: type: array items: type: object allOf: – #/definitions/basicTabComponent minimum: 1 description: As abas e seus componentes basicTabComponent: description: Componente do tipo aba type: object required: – name properties: name: type: string maxLength: 255 description: Nome da aba components: type: array items: type: object allOf: – #/definitions/basicComponent description: Os componentes vinculados a aba tabOrder: type: integer format: int64 description: Ordenação das Tabs default: 0 basicUrlComponent: description: Componente onde é somente uma URL allOf: – #/definitions/basicComponent – type: object required: – url properties: url: type: string maxLength: 1000 description: URL do componente basicWidgetComponent: description: Componente do tipo widget e suas informações allOf: – #/definitions/basicComponent – type: object required: – widgetId properties: widgetId: type: string maxLength: 255 description: Identificador do widget vinculado basicAnalyticComponent: description: Componente do tipo analytic e suas informações allOf: – #/definitions/basicComponent – type: object required: – analyticId properties: analyticId: type: string maxLength: 255 description: Identificador do analytic basicFormComponent: description: Componente do tipo formulário e suas informações allOf: – #/definitions/basicComponent – type: object required: – formId – formName properties: formId: type: string maxLength: 255 description: Identificador do formulario formName: type: string description: Nome do formulário basicAnalytic: description: Informações básicas de um analytic type: object required: – id – name – chartType – createdBy – createdDate properties: id: type: string maxLength: 255 description: Identificador do analytics seguindo o padrão: analytic://tenantDomain/identificadorUnico name: type: string maxLength: 255 description: Nome do widget type: string maxLength: 255 description: Título a ser exibido podendo ser uma chave de tradução no padrão platform.cms.nome tags: type: array items: type: string description: As tags associadas a esse analytic preferredSize: type: object allOf: – #/definitions/preferredSize description: O tamanho preferido para melhor visualização chartType: type: string allOf: – #/definitions/chartType description: O tipo do gráfico createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Data de criação hideProjectionFilters: type: boolean description: Flag para definir se no widget deve aparecer os filtro de projeção, o padrão é false que no caso irá aparecer os filtros default: false analytic: description: Um componente, plugável a uma página, que provê a exibição de informações através de um gráfico type: object required: – id – name – chart – createdBy – createdDate properties: id: type: string maxLength: 255 description: Identificador do analytics seguindo o padrão: analytic://tenantDomain/identificadorUnico name: type: string maxLength: 255 description: Nome do analytic type: string maxLength: 255 description: Título a ser exibido podendo ser uma chave de tradução no padrão platform.cms.nome chart: type: object allOf: – #/definitions/chart description: Informações do gráfico do analytic, se não informado será mantido o estado anterior. preferredSize: type: object allOf: – #/definitions/preferredSize description: O tamanho preferido para melhor visualização tags: type: array items: type: string description: As tags associadas a esse analytic properties: type: array items: type: object allOf: – #/definitions/property description: Propriedades adicionais do painel.\n Quando uma propriedade é omitida, a mesma é removida. createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Data de criação hideProjectionFilters: type: boolean description: Flag para definir se no widget deve aparecer os filtro de projeção, o padrão é false que no caso irá aparecer os filtros default: false analyticRegistry: description: Informações de cadastro de um analytic type: object required: – id – name – chart properties: id: type: string maxLength: 255 description: Identificador do analytics seguindo o padrão: analytic://tenantDomain/identificadorUnico ou analytic://factory/tenantDomain/identificadorUnico name: type: string maxLength: 255 description: Nome do analytic type: string maxLength: 255 description: Título a ser exibido podendo ser uma chave de tradução no padrão platform.cms.nome chart: type: object allOf: – #/definitions/chart description: Informações do gráfico do analytic, se não informado será mantido o estado anterior. preferredSize: type: object allOf: – #/definitions/preferredSize description: O tamanho preferido para melhor visualização tags: type: array items: type: string description: As tags associadas a esse analytic properties: type: array items: type: object allOf: – #/definitions/property description: Propriedades adicionais do painel.\n Quando uma propriedade é omitida, a mesma é removida. shared: type: boolean description: Se este Analytic deve ser salvo na base shared default: false resource: type: string description: URI do resource que contrata a permissão de acesso a um Analytic shared hideProjectionFilters: type: boolean description: Flag para definir se no widget deve aparecer os filtro de projeção, o padrão é false que no caso irá aparecer os filtros default: false chart: description: Informações do chart e suas associações type: object required: – type – datasetId properties: type: type: string allOf: – #/definitions/chartType description: Tipo do gráfico category: type: object allOf: – #/definitions/column description: Categoria, opcional para o tipo de gráfico GAUGE series: type: array items: type: object allOf: – #/definitions/series description: Conjunto de valores a serem exibidos, se o tipo de gráfico for pizza, somente um conjunto é aceito datasetId: type: string description: Identificador do dataset que será vinculado ao gráfico filter: type: object allOf: – #/definitions/expression description: Filtros order: type: array items: type: object allOf: – #/definitions/order description: A ordenação dos registros categories: type: array items: type: object allOf: – #/definitions/categorySeries description: Multiplas Categorias series: description: Conjunto de valores a serem exibidos no gráfico type: object required: – column – label properties: column: type: object allOf: – #/definitions/column description: Coluna que o conjunto de dados será vinculado label: type: string description: Descrição do conjunto column: description: Representa uma coluna da projeção type: object required: – schema – table – column properties: schema: type: string maxLength: 128 description: Nome do schema table: type: string maxLength: 128 description: Nome da tabela column: type: string maxLength: 128 description: Nome da coluna label: type: string maxLength: 128 description: Label da coluna function: type: string allOf: – #/definitions/functionType description: Informa uma função aplicada na coluna precision: type: integer format: int64 description: Precisão para formatação do valor prefix: type: string maxLength: 128 description: Prefixo do label sufix: type: string maxLength: 128 description: Sufixo do label mask: type: string maxLength: 128 description: Máscara da coluna latitude: type: object allOf: – #/definitions/column description: Campo que identifica a latitude da localização a ser renderizada no gráfico de tipo mapa longitude: type: object allOf: – #/definitions/column description: Campo que identifica a longitude da localização a ser renderizada no gráfico de tipo mapa decimal: type: boolean description: Campo que identifica formatação decimal dos números default: true chartFormat: type: string allOf: – #/definitions/seriesFormat description: Formatação numérica e de data chartType: type: string allOf: – #/definitions/seriesType description: Tipo da Série chartShowSecond: type: boolean description: Exibir os segundos na data default: false tooltipFormat: type: string allOf: – #/definitions/tooltipFormat description: Definição da formatação da tooltip categorySeries: description: type: object required: – category properties: category: type: object allOf: – #/definitions/column description: series: type: array items: type: object allOf: – #/definitions/series description: property: description: Registro de uma propriedade type: object required: – name – value properties: name: type: string maxLength: 255 description: Nome da propriedade value: type: string maxLength: 255 description: Valor da propriedade bigvalues: type: string maxLength: 12000 description: Valores grandes para a propriedade widget: description: Um componente, plugável a uma página, que provê uma funcionalidade discriminator: _discriminator type: object required: – id – name – url – _discriminator properties: id: type: string maxLength: 255 description: Identificador URI desse widget. Deve seguir o formato widget:// tenant-domain / domain / service / name name: type: string maxLength: 255 description: A chave de internacionalização do nome desse widget. Chave associada ao bundle do platform.cms description: type: string maxLength: 255 description: A chave de internacionalização da descrição desse widget. Chave associada ao bundle do platform.cms permission: type: object allOf: – #/definitions/permission description: O recurso necessário para acessar esse widget url: type: string maxLength: 1000 description: A URL onde esse widget se encontra thumbnailURL: type: string maxLength: 1000 description: A URL onde pode ser obtido o thumbnail desse widget tags: type: array items: type: string description: As tags associadas a esse widget preferredSize: type: object allOf: – #/definitions/preferredSize description: O tamanho preferido para melhor visualização hideProjectionFilters: type: boolean description: Flag para definir se no widget deve aparecer os filtro de projeção, o padrão é false que no caso irá aparecer os filtros default: false _discriminator: type: string description: widgetRegistry: description: allOf: – #/definitions/widget – type: object properties: shared: type: boolean description: Se este Widget deve ser salvo na base shared (por questão de retrocompatibilidade o valor padrão é TRUE) default: true permission: description: Um conjunto de resource e ação type: object required: – resource – action properties: resource: type: string maxLength: 255 description: O URI do resource action: type: string maxLength: 50 description: O nome da ação preferredSize: description: Tamanho de preferência type: object required: – height – width properties: height: type: integer format: int64 description: Altura, quando utilizada em uma página com valores absolutos, cada unidade representará 40 pixels minimum: 1 width: type: integer format: int64 description: Largura minimum: 1 maximum: 12 pagination: description: As configurações de paginação de uma listagem type: object properties: pageNumber: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 listInformation: description: As informações sobre os resultados de listagem realizada type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Quantidade total de resultados encontrados totalPages: type: integer format: int64 description: Quantidade total de páginas encontradas position: description: Posição onde inicia a exibição do widget type: object required: – row – column properties: row: type: integer format: int64 description: Linha minimum: 0 column: type: integer format: int64 description: Coluna minimum: 0 basicLandingPage: description: Registro com as informações de uma landingPage. type: object required: – id – pageId – title – landingPageType properties: id: type: string description: Identificador da landing page no formato landing://{domínio do tenant}/{identificador único da página} pageId: type: string description: Identificador da página type: string description: Título da página includeHeader: type: boolean description: Se inclui o header da página com o título default: false landingPageType: type: string allOf: – #/definitions/landingPageType description: Tipo da landing page landingPage: description: Registro com as informações da landing page e as informações da página. type: object required: – id – page – title – landingPageType properties: id: type: string description: Identificador da landing page no formato landing://{domínio do tenant}/{identificador único da página} page: type: object allOf: – #/definitions/page description: Informações da página type: string description: Título da página includeHeader: type: boolean description: Se inclui o header da página com o título default: false landingPageType: type: string allOf: – #/definitions/landingPageType description: Tipo da landing page roles: type: array items: type: string description: Papéis da landing page se for compartilhada expression: description: Expressão para montar um filtro seguindo o modelo de uma árvore binária. discriminator: _discriminator type: object required: – _discriminator properties: _discriminator: type: string description: unaryExpression: description: Expressão para filtrar uma coluna allOf: – #/definitions/expression – type: object required: – schema – table – column – operator properties: schema: type: string maxLength: 128 description: Nome do schema table: type: string maxLength: 128 description: Nome da tabela column: type: string maxLength: 128 description: Coluna em que será aplicado o filtro operator: type: string allOf: – #/definitions/relationalOperator description: Tipo do filtro a ser aplicado value: type: object allOf: – #/definitions/value description: Valor a ser utilizado no filtro function: type: string allOf: – #/definitions/functionType description: Função aplicada binaryExpression: description: Expressão que realiza a combinação de dois filtros allOf: – #/definitions/expression – type: object required: – operator – leftExpression – rightExpression properties: operator: type: string allOf: – #/definitions/logicalOperator description: Tipo de combinação a ser realizada leftExpression: type: object allOf: – #/definitions/expression description: Filtro esquerdo rightExpression: type: object allOf: – #/definitions/expression description: Filtro direito value: description: Registro base de valor, podendo ser staticValue discriminator: _discriminator type: object required: – _discriminator properties: _discriminator: type: string description: staticValue: description: Representa o valor estático de um filtro allOf: – #/definitions/value – type: object required: – values properties: values: type: array items: type: string minimum: 1 description: Enviar mais de um elemento quando o filtro é do tipo IN ou BETWEEN.\n Para o operador lógico BETWEEN é necessário que o campo tenha dois elementos, exemplo:\n Filtro:\n {\n column : age,\n operator : BETWEEN,\n values : [ 10, 30]\n }\n SQL:\n age BETWEEN 10 AND 30 order: description: Ordenação type: object required: – schema – table – column – order properties: schema: type: string maxLength: 128 description: Nome do schema table: type: string maxLength: 128 description: Nome da tabela column: type: string maxLength: 128 description: Coluna em que será aplicado o filtro function: type: string allOf: – #/definitions/functionType description: Função aplicada order: type: string allOf: – #/definitions/orderType description: Ordem pageResource: description: Recurso de uma página por tipo type: object required: – name – type – uri – actionUri properties: name: type: string description: Nome do componente type: type: string allOf: – #/definitions/componentType description: Tipo do componente uri: type: string description: URI do recurso actionUri: type: string description: Ação do recurso pageRegistry: description: type: object required: – id – name – components properties: id: type: string description: Identificador da página no padrão page://{domínio do tenant}/{identificador único da página} name: type: string description: Nome da página credentials: type: boolean description: Indica se devem ser enviadas as credenciais para os componentes da página default: false includeToolbar: type: boolean description: Indica se devem ser exibido a barra de ferramentas na página ou não default: false positionType: type: string allOf: – #/definitions/positionType description: Indica se os componentes possuirão tamanhos absolutos (fixos) ou relativos à tela components: type: array items: type: object allOf: – #/definitions/basicComponent minimum: 1 description: Os componentes da página shared: type: boolean description: Se esta Page deve ser salva na base shared default: false resource: type: string description: URI do resource que contrata a permissão de acesso a uma Page shared globalFilterCollapsable: type: boolean description: Determinar se o Filtro Global será Colapsável default: false globalFilterCollapsed: type: boolean description: Determinar se o Filtro Global iniciará colapsado default: false disabledIFrameCache: type: boolean description: Desativar o cache do IFrame default: false landingPageRegistry: description: type: object required: – id – pageId – title properties: id: type: string description: Identificador da landing page no formato landing://{domínio do tenant}/{identificador único da página} pageId: type: string description: Identificador da página type: string description: Título da página includeHeader: type: boolean description: Se inclui o header da página com o título default: false roles: type: array items: type: string description: Papéis da landing page se for compartilhada, se omitido, não realiza alterações shared: type: boolean description: Se esta Landing Page deve ser salva na base shared default: false resource: type: string description: URI do resource que contrata a permissão de acesso a esta LandingPage shared additionalFilter: description: Filtro adicional para datasets de analytics discriminator: _discriminator type: object required: – _discriminator properties: _discriminator: type: string description: unaryAdditionalFilter: description: Chave e valor do filtro adicional para datasets de analytics allOf: – #/definitions/additionalFilter – type: object required: – key – operator properties: key: type: string description: Nome do schema operator: type: string allOf: – #/definitions/relationalOperator description: Tipo do filtro a ser aplicado value: type: object allOf: – #/definitions/value description: Valor a ser utilizado no filtro binaryAdditionalFilter: description: Combinação de filtros adicionais para datasets de analytics allOf: – #/definitions/additionalFilter – type: object required: – operator – leftExpression – rightExpression properties: operator: type: string allOf: – #/definitions/logicalOperator description: Tipo de combinação a ser realizada leftExpression: type: object allOf: – #/definitions/additionalFilter description: Filtro esquerdo rightExpression: type: object allOf: – #/definitions/additionalFilter description: Filtro direito analyticDynamicInfo: description: Registro utilizado para trafegar informações dinâmicas do analyticComponent type: object required: – analyticId – property – value properties: analyticId: type: string description: Id do analytic property: type: string description: Nome da propriedade do analytic value: type: string description: Valor da propriedade do analytic 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