CMS - RegisterAnalytic


Registra um componente do tipo analytic (caso um analytic com esse identificador já exista, as informações são atualizadas).

Payload de entrada:

{ // Identificador do analytics seguindo o padrão: analytic://tenantDomain/identificadorUnico "id": "string", // Nome do analytic "name": "string", // Título a ser exibido podendo ser uma chave de tradução no padrão platform.cms.nome "title": "string", // Informações de gráficos e suas associações "chart": { // Tipo do gráfico "type": "BAR", // Categoria do gráfico (opcional para o tipo de gráfico GAUGE) "category": { // Nome do schema "schema": "string", // Nome da tabela "table": "string", // Nome da coluna "column": "string", // Label da coluna "label": "string", // Informa uma função aplicada na coluna "function": "AVG", // Precisão para formatação do valor "precision": 0, // Prefixo do label "prefix": "string", // Sufixo do label "sufix": "string", // Máscara da coluna "mask": "string" }, //Conjunto de valores a serem exibidos (se o tipo de gráfico for pizza, somente um conjunto é aceito) "series": [{ // Coluna que o conjunto de dados será vinculado "column": { // Nome do schema "schema": "string", // Nome da tabela "table": "string", // Nome da coluna "column": "string", // Label da coluna "label": "string", // Informa uma função aplicada na coluna "function": "AVG", // Precisão para formatação do valor "precision": 0, // Prefixo do label "prefix": "string", // Sufixo do label "sufix": "string", // Máscara da coluna "mask": "string" }, // Descrição do conjunto "label": "string" }], // Identificador do dataset que será vinculado ao gráfico "datasetId": "string", // Filtros "filter": {}, // A ordenação dos registros "order": [{ // Nome do schema "schema": "string", // Nome da tabela "table": "string", // Coluna em que será aplicado o filtro "column": "string", // Função aplicada "function": "AVG", // Tipo de ordenação (Valores padrões: ASC e DESC) "order": "ASC" }] }, // Tamanho de preferência "preferredSize": { // Altura, quando utilizada em uma página com valores absolutos, cada unidade representará 40 pixels "height": 0, // Largura "width": 0 }, // Tags associadas a esse "tags": [ "string" ], // Registro de uma propriedade "properties": [{ // Nome da propriedade "name": "string", // Valor da propriedade "value": "string" }] }

Tipos de gráficos padrões:

  • BAR – “Barra”
  • STACKED_BAR – “Barra empilhada”
  • COLUMN – “Coluna”/li>
  • STACKED_COLUMN – “Coluna empilhada”/li>
  • PIE – “Pizza”
  • AREA – “Área”
  • LINE – “Linha”
  • TABLE – “Tabela”
  • BUBBLE – “Bolha”
  • GAUGE – “Medidor”
  • COUNTER – “Contador”
  • RADAR – “Radar”
  • MAP – “Mapa”
  • FILTER – “Filtro”

Tipos de funções padrões:

  • AVG – “Média”
  • COUNT – “Contar”
  • MAX – “Máximo”
  • MIN – “Mínimo”
  • SUM – “Soma”
  • COUNT_DISTINCT – “Contar distintos”

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/cms/registerAnalytic" --header "Authorization: Bearer {access_token}" --header "client_id: {client_id}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "id": "string", "name": "string", "title": "string", "chart": { "type": "BAR", "category": { "schema": "string", "table": "string", "column": "string", "label": "string", "function": "AVG", "precision": 0, "prefix": "string", "sufix": "string", "mask": "string"}, "series": [ { "column": { "schema": "string", "table": "string", "column": "string", "label": "string", "function": "AVG", "precision": 0, "prefix": "string", "sufix": "string", "mask": "string" }, "label": "string" } ], "datasetId": "string", "filter": { }, "order": [ { "schema": "string", "table": "string", "column": "string", "function": "AVG", "order": "ASC" } ] }, "preferredSize": { "height": 0, "width": 0 }, "tags": [ "string" ], "properties": [ { "name": "string", "value": "string" } ] }"

Response:

  • 200 OK
    { "id": "string" // Identificador do analytic criado }

  • 400 Bad Request: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente
    { "message": "Descrição do erro", "errorCode": "codigoDoErro", "reason": "BAD_REQUEST", "domain": "platform", "service": "cms" }
  • 401 Unauthorized: Usuário ou senha inválido
    { "error_description": "Descrição do erro", "error": "codigo_do_erro" }

  • 403 Forbidden: Permissão negada