APIs - Tutoriais

ListWidgets

24 views 18/08/2021 rodolfo-andrade 0

Lista todos os widgets do tenant que o usuário possui permissão para utilizar.

Payload de entrada:

{
  "searchValue": "string",  // O valor a ser pesquisado nos campos internacionalizados e nas tags ignorando caracteres maiúsculos e minúsculos
  "pagination": {           // Configurações de paginação de uma listagem. Não definido, retornará os 10 primeiros resultados.
    "pageNumber": 0,        // Número/índice da página retornado. A primeira página corresponde ao índice 0
    "pageSize": 0           // Quantidade de registros por página
  }
}

Exemplo de request:

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

Responses:

200 OK
{
  "widgets": {                 // Os widgets que o usuário possui permissão de visualizar
    "id": "string",            // Identificador URI desse widget. Deve seguir o formato widget://<tenant-domain>/<domain>/<service>/<name>
    "name": "string",          // A chave de internacionalização do nome desse widget. Chave associada ao bundle do platform.cms
    "description": "string",   // A chave de internacionalização da descrição desse widget. Chave associada ao bundle do platform.cms
    "permission": {            // O recurso necessário para acessar esse widget
      "resource": "string",    // O URI do resource
      "action": "string"       // O nome da ação
    },
    "url": "string",           // A URL onde esse widget se encontra
    "thumbnailURL": "string",  // A URL onde pode ser obtido o thumbnail desse widget
    "tags": [                  // As tags associadas a esse widget
      "string"
    ],
    "preferredSize": {         // O tamanho preferido para melhor visualização
      "height": 0,             // Altura, quando utilizada em uma página com valores absolutos, cada unidade representará 40 pixels
      "width": 0               // Largura
    }
  },
  "listInformation": {         // Informações sobre os resultados de listagem realizada
    "totalElements": 0,        // Quantidade total de resultados encontrados
    "totalPages": 0            // Quantidade total de páginas encontradas
  }
}

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ê?