APIs - Tutoriais

RegisterAnalytic

82 views 21/07/2021 17/08/2021 rodolfo-andrade 0

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

Payload de entrada:

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

    BAR – “Barra”
    STACKED_BAR – “Barra empilhada”
    COLUMN – “Coluna”
    STACKED_COLUMN – “Coluna empilhada”
    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/actions/registerAnalytic" --header "Authorization: Bearer {access_token}" --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" } ] }"

Responses:

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)

Este artigo foi útil para você?