CMS - ListFactoryDefaultAnalytics

  • Wed, 09/01/2021 - 14:13
  • /giovani.lisboa@...

Lista os componentes do tipo analytics padrões de fábrica.

Payload de entrada:

{ // Parâmetro de busca por nome do analytic, uri ou tags "searchValue": "string", // Configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. "pagination": { // Número/índice da página retornado. A primeira página corresponde ao índice 0 "pageNumber": 0, // Quantidade de registros por página "pageSize": 0 } }

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/cms/listFactoryDefaultAnalytics" --header "Authorization: Bearer {access_token}" --header "client_id: {client_id}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "searchValue": "string", "pagination": { "pageNumber": 0, "pageSize": 0 } }"

Responses:

200 OK

{ "analytics": { // 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", // Tags associadas a esse analytic "tags": [ "string" ], // 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 }, // Tipo do gráfico a ser exibido "chartType": "BAR", // Usuário criador do componente "createdBy": "string", // Data de criação do componente "createdDate": "2021-07-13T17:43:26.112Z" }, // Informações sobre os resultados de listagem realizada "listInformation": { // Quantidade total de resultados encontrados "totalElements": 0, // Quantidade total de páginas encontradas "totalPages": 0 } }

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”

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