Lista as páginas que o usuário tem acesso para visualizar.
Payload de entrada:
{
// O valor/parâmetro a ser pesquisado no campo nome da página.
"searchValue": "string",
// Filtrar para somente as páginas criadas pelo usuário corrente.
"ownerOnly": true,
// 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/listPages" --header "Authorization: Bearer {access_token}" --header "client_id: {client_id}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "searchValue": "string", "ownerOnly": true, "pagination": { "pageNumber": 0, "pageSize": 0 } }"
Responses:
200 OK
{
//Informações básicas de uma página para listagem
"pages": {
// Identificador da página no padrão page://{domínio do tenant}/{identificador único da página}
"id": "string",
// Nome da página
"name": "string",
// Indica se devem ser enviadas as credenciais para os componentes da página
"credentials": true,
// Indica se os componentes possuirão tamanhos absolutos (fixos) ou relativos à tela (Tipos padrões: ABSOLUTE e RELATIVE)
"positionType": "ABSOLUTE",
// Permissão necessária para visualizar a página
"permission": {
// O URI do resource
"resource": "string",
// O nome da ação
"action": "string"
}
},
// 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