Português
English
Lista todos os widgets do tenant que o usuário possui permissão para utilizar.
Payload de entrada:
{
// O valor a ser pesquisado nos campos internacionalizados e nas tags ignorando caracteres maiúsculos e minúsculos
"searchValue": "string",
// Configurações de paginação de uma 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/listWidgets" --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
{
// Os widgets que o usuário possui permissão de visualizar
"widgets": {
// Identificador URI desse widget. Deve seguir o formato widget://///
"id": "string",
// A chave de internacionalização do nome desse widget. Chave associada ao bundle do platform.cms
"name": "string",
// A chave de internacionalização da descrição desse widget. Chave associada ao bundle do platform.cms
"description": "string",
// O recurso necessário para acessar esse widget
"permission": {
// O URI do resource
"resource": "string",
// O nome da ação
"action": "string"
},
// A URL onde esse widget se encontra
"url": "string",
// A URL onde pode ser obtido o thumbnail desse widget
"thumbnailURL": "string",
// As tags associadas a esse widget
"tags": [
"string"
],
// O tamanho preferido para melhor visualização
"preferredSize": {
// Altura, quando utilizada em uma página com valores absolutos, cada unidade representará 40 pixels
"height": 0,
// Largura
"width": 0
}
},
// Informações sobre os resultados de listagem realizada
"listInformation": {
// Quantidade total de resultados encontrados
"totalElements": 0,
// Quantidade total de páginas encontradas
"totalPages": 0
}
}
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
