Gerenciamento de conteúdo (cms)

Gerenciamento de conteúdo (cms)

111 views 09/06/2021 28/10/2021 integrador 0

2.0info: 5.1.1 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: api.senior.com.br /platform/cms/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /actions/registerWidget: post: description: API DEPRECIADA: Use platform/cms/registerFactoryWidget instead | DATA: 2021-12-08 | Registra um widget. Caso um widget com esse identificador já exista, as informações são atualizadas. O padrão do identificador deverá seguir: widget://{tenant ou domínio do tenant}/custom/{serviço}/{nome} ### Resources: – res://senior.com.br/platform/cms/widget x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – widget properties: widget: #/definitions/widget responses: 200: description: Ok schema: type: object required: – widgetId properties: widgetId: type: string description: Identificador do widget registrado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /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 ### Resources: – res://senior.com.br/platform/cms/analytics x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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} 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 403: description: Permissão negada 404: description: Identificador inválido do widget 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/removePersonalLandingPages: post: description: Apaga todas as landing pages personalizadas do usuário corrente ou do usuário informado ### Resources: – res://senior.com.br/platform/cms/page (Excluir/Personalizar) x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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. Se não informado será considerado o usuário corrente. Usuários com somente permissão de personalizar só podem remover suas próprias páginas responses: 200: description: Ok 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /actions/getPage: post: description: Permite buscar as informações de uma página ### Resources: – res://<tenant ou dominio do tenant>/custom/page/<identificador único> x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/page 403: description: Permissão negada 404: description: Página não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/removeAllPersonalLandingPages: post: description: Apaga todas as landing pages personalizadas de todos os usuários x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /queries/getAnalytic: post: description: Busca informações de um analytic ### Resources: – res://<tenant ou dominio do tenant>/custom/analytic/<identificador único> x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/analytic 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 /actions/saveLandingPagesOrder: post: description: Altera a ordem das landing pages ### Resources: – res://senior.com.br/platform/cms/page (Editar/Personalizar) x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – landingPageId properties: landingPageId: type: array items: type: string description: Os identificadores das landing pages na ordem que elas devem ser apresentadas responses: 200: description: Ok 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 /actions/removePage: post: description: Permite remover uma página existente. É necessário possuir permissão o recurso customizado na ação Excluir. Se remover uma página em uso por uma landing page, a mesma também é removida. ### Resources: – res://<tenant ou dominio do tenant>/custom/page/<identificador único> x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 403: description: Permissão negada 404: description: Página não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/listWidgets: post: description: Lista todos os widgets do tenant que o usuário possui permissão para utilizar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – widgets – listInformation properties: widgets: #/definitions/widget listInformation: #/definitions/listInformation default: description: Error response schema: #/definitions/genericError /queries/listFactoryDefaultLandingPages: post: description: Lista as landing pages padrões de fábrica x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – landingPages – listInformation properties: landingPages: #/definitions/basicLandingPage listInformation: #/definitions/listInformation 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/countAnalyticsDataset: post: description: Retorna a quantidade de analytics que estão utilizando o dataset x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 description: Retorna a quantidade de analytics que utilizam o dataset 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/listFactoryDefaultAnalytics: post: description: Lista os componentes do tipo analytics padrões de fábrica x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – analytics – listInformation properties: analytics: #/definitions/basicAnalytic listInformation: #/definitions/listInformation 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getAnalytics: post: description: Lista os analytics filtrando por ids x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – ids properties: ids: type: array items: type: string description: identificadores para filtrar responses: 200: description: Ok schema: type: object required: – analytics properties: analytics: #/definitions/basicAnalytic 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/listFactoryDefaultPages: post: description: Lista as pages padrões de fábrica x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – pages – listInformation properties: pages: #/definitions/basicPage listInformation: #/definitions/listInformation 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/unregisterWidget: post: description: API DEPRECIADA: Use platform/cms/unregisterFactoryWidget instead | DATA: 2021-12-08 | Desregistra um widget ### Resources: – res://senior.com.br/platform/cms/widget x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] 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 404: description: Widget não encontrado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/savePage: post: description: Cria ou atualiza uma página ### Resources: – res://senior.com.br/platform/cms/page x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 includeToolbar: type: boolean description: Indica se devem ser exibido a barra de ferramentas na página ou não positionType: #/definitions/positionType components: type: array items: #/definitions/basicComponent description: Os componentes da página responses: 200: description: Ok schema: type: object required: – pageId properties: pageId: type: string description: Identificador da página 403: description: Pemissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getPageResources: post: description: Retorna todos os recursos utilizados para a exibição de uma página ### Resources: – res://<tenant ou domínio do tenant>/custom/page/<identificador único> x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/pageResource 403: description: Permissão negada 404: description: Página não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campos informados incorretamente default: description: Error response schema: #/definitions/genericError /queries/listFactoryDefaultWidgets: post: description: Lista os componentes do tipo widgets padrões de fábrica x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – widgets – listInformation properties: widgets: #/definitions/widget listInformation: #/definitions/listInformation 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getWidget: post: description: Exibe as informações do widget buscando através do seu identificador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 required: – id – name – url properties: id: type: string description: Identificador URI desse widget. Deve seguir o formato widget://<tenant-domain>/<domain>/<service>/<name> name: type: string description: A chave de internacionalização do nome desse widget. Chave associada ao bundle do platform.cms description: type: string description: A chave de internacionalização da descrição desse widget. Chave associada ao bundle do platform.cms permission: #/definitions/permission url: type: string description: A URL onde esse widget se encontra thumbnailURL: type: string description: A URL onde pode ser obtido o thumbnail desse widget tags: type: string description: As tags associadas a esse widget preferredSize: #/definitions/preferredSize 404: description: Componente não encontrado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/getLandingPage: post: description: Permite buscar as informações de uma landing page com as informações da página vinculada ### Resources: – res://<tenant ou dominio do tenant>/custom/landing_page/<identificador único> x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/landingPage 404: description: Landing page não encontrada 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/listAnalytics: post: description: Lista os componentes do tipo analytics x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – analytics – listInformation properties: analytics: #/definitions/basicAnalytic listInformation: #/definitions/listInformation default: description: Error response schema: #/definitions/genericError /actions/listPages: post: description: Lista as páginas que o usuário tem acesso para visualizar. ### Resources: – res://senior.com.br/platform/cms/page (Visualizar/Personalizar) x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 pagination: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – pages – listInformation properties: pages: #/definitions/basicPage listInformation: #/definitions/listInformation default: description: Error response schema: #/definitions/genericError /actions/saveLandingPage: post: description: Permite adicionar uma página à landing page. Para vincular a página, será necessário ter permissão de visualização para a mesma. Se possuir somente a ação Personalizar, então só poderá criar páginas do tipo PERSONAL. ### Resources: – res://senior.com.br/platform/cms/page (Editar/Personalizar) x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 landingPageType: #/definitions/landingPageType 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 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campos informados incorretamente default: description: Error response schema: #/definitions/genericError /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. ### Resources: – res://senior.com.br/platform/cms/page (Excluir/Personalizar) x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 403: description: Permissão negada 404: description: Página não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /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 ### Resources: – res://senior.com.br/platform/cms/page (Editar/Personalizar) x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 404: description: Página não encontratada 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/getUserLandingPages: post: description: Lista as landing pages para visualização pelo usuário. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – landingPages properties: landingPages: #/definitions/basicLandingPage default: description: Error response schema: #/definitions/genericError /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. ### Resources – res://senior.com.br/platform/cms/page (Visualizar/Personalizar) x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – landingPages – listInformation properties: landingPages: #/definitions/basicLandingPage listInformation: #/definitions/listInformation 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /actions/registerAnalytic: post: description: Registra um analytic. Caso um analytic com esse identificador já exista, as informações são atualizadas. ### Resources: – res://senior.com.br/platform/cms/analytics x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id – name – chart properties: id: type: string description: Identificador do analytics seguindo o padrão: analytic://tenantDomain/identificadorUnico name: type: string description: Nome do analytic type: string description: Título a ser exibido podendo ser uma chave de tradução no padrão platform.cms.nome chart: #/definitions/chart preferredSize: #/definitions/preferredSize tags: type: array items: type: string description: As tags associadas a esse analytic properties: type: array items: #/definitions/property description: Propriedades adicionais do painel. Quando uma propriedade é omitida, a mesma é removida. responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do analytic criado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/unregisterAnalytic: post: description: Desregistra um analytic ### Resources: – res://<tenant ou dominio do tenant>/custom/analytic/<identificador único> x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 404: description: Analytic não encontrado default: description: Error response schema: #/definitions/genericError /actions/setPageAnalyticFilter: post: description: Salva os filtros alterados do analytic na página para o usuário do contexto x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/expression order: type: array items: #/definitions/order description: A ordenação dos registros additionalFilter: #/definitions/additionalFilter responses: 200: description: Ok 404: description: Página não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campos informados incorretamente default: description: Error response schema: #/definitions/genericErrordefinitions: positionType: type: string enum: – ABSOLUTE – RELATIVE landingPageType: type: string enum: – DEFAULT – SHARED – PERSONAL chartType: type: string enum: – BAR – STACKED_BAR – COLUMN – STACKED_COLUMN – PIE – AREA – LINE – TABLE – BUBBLE – GAUGE – COUNTER – RADAR – MAP – FILTER functionType: type: string enum: – AVG – COUNT – MAX – MIN – SUM – COUNT_DISTINCT orderType: type: string enum: – ASC – DESC componentType: type: string enum: – DATASET – ANALYTIC – WIDGET basicPage: 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 positionType: #/definitions/positionType permission: #/definitions/permission permission: type: object required: – resource – action properties: resource: type: string description: O URI do resource action: type: string description: O nome da ação page: 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 positionType: #/definitions/positionType permission: #/definitions/permission components: type: array items: #/definitions/component description: Os componentes da página includeToolbar: type: boolean description: Mostrar o barra de ferramentas na página component: type: object required: – height – width – position properties: height: type: integer description: Altura width: type: integer description: Largura position: #/definitions/position position: type: object required: – row – column properties: row: type: integer description: Linha column: type: integer description: Coluna basicComponent: type: object required: – height – width – position properties: height: type: integer description: Altura width: type: integer description: Largura position: #/definitions/position basicAnalytic: type: object required: – id – name – chartType – createdBy – createdDate properties: id: type: string description: Identificador do analytics seguindo o padrão: analytic://tenantDomain/identificadorUnico name: type: string description: Nome do widget type: string 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: #/definitions/preferredSize chartType: #/definitions/chartType createdBy: type: string description: Criado por createdDate: type: string description: Data de criação format: date-time preferredSize: type: object required: – height – width properties: height: type: integer description: Altura, quando utilizada em uma página com valores absolutos, cada unidade representará 40 pixels width: type: integer description: Largura analytic: type: object required: – id – name – chart – createdBy – createdDate properties: id: type: string description: Identificador do analytics seguindo o padrão: analytic://tenantDomain/identificadorUnico name: type: string description: Nome do analytic type: string description: Título a ser exibido podendo ser uma chave de tradução no padrão platform.cms.nome chart: #/definitions/chart preferredSize: #/definitions/preferredSize tags: type: array items: type: string description: As tags associadas a esse analytic properties: type: array items: #/definitions/property description: Propriedades adicionais do painel. Quando uma propriedade é omitida, a mesma é removida. createdBy: type: string description: Criado por createdDate: type: string description: Data de criação format: date-time chart: type: object required: – type – series – datasetId properties: type: #/definitions/chartType category: #/definitions/column series: type: array items: #/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: #/definitions/expression order: type: array items: #/definitions/order description: A ordenação dos registros column: type: object required: – schema – table – column properties: schema: type: string description: Nome do schema table: type: string description: Nome da tabela column: type: string description: Nome da coluna label: type: string description: Label da coluna function: #/definitions/functionType precision: type: integer description: Precisão para formatação do valor prefix: type: string description: Prefixo do label sufix: type: string description: Sufixo do label mask: type: string description: Máscara da coluna latitude: #/definitions/column longitude: #/definitions/column series: type: object required: – column – label properties: column: #/definitions/column label: type: string description: Descrição do conjunto expression: type: object properties: order: type: object required: – schema – table – column – order properties: schema: type: string description: Nome do schema table: type: string description: Nome da tabela column: type: string description: Coluna em que será aplicado o filtro function: #/definitions/functionType order: #/definitions/orderType property: type: object required: – name – value properties: name: type: string description: Nome da propriedade value: type: string description: Valor da propriedade widget: type: object required: – id – name – url properties: id: type: string description: Identificador URI desse widget. Deve seguir o formato widget://<tenant-domain>/<domain>/<service>/<name> name: type: string description: A chave de internacionalização do nome desse widget. Chave associada ao bundle do platform.cms description: type: string description: A chave de internacionalização da descrição desse widget. Chave associada ao bundle do platform.cms permission: #/definitions/permission url: type: string description: A URL onde esse widget se encontra thumbnailURL: type: string 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: #/definitions/preferredSize pagination: type: object properties: pageNumber: type: integer description: O número da página retornado. A primeira página corresponde ao índice 0 pageSize: type: integer description: Quantidade de registros por página listInformation: type: object required: – totalElements – totalPages properties: totalElements: type: integer description: Quantidade total de resultados encontrados totalPages: type: integer description: Quantidade total de páginas encontradas basicLandingPage: 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 landingPageType: #/definitions/landingPageType landingPage: 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: #/definitions/page type: string description: Título da página includeHeader: type: boolean description: Se inclui o header da página com o título landingPageType: #/definitions/landingPageType roles: type: array items: type: string description: Papéis da landing page se for compartilhada pageResource: type: object required: – name – type – uri – actionUri properties: name: type: string description: Nome do componente type: #/definitions/componentType uri: type: string description: URI do recurso actionUri: type: string description: Ação do recurso additionalFilter: type: object properties: 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