APIs - Tutoriais

ListPages

30 views 13/08/2021 rodolfo-andrade 0

Lista as páginas que o usuário tem acesso para visualizar.

Payload de entrada:

{
  "searchValue": "string",  // O valor/parâmetro a ser pesquisado no campo nome da página.
  "ownerOnly": true,        // Filtrar para somente as páginas criadas pelo usuário corrente.
  "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/actions​/listPages" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "searchValue": "string", "ownerOnly": true, "pagination": { "pageNumber": 0, "pageSize": 0 } }"

Responses:

200 OK
{
  "pages": {                     // Informações básicas de uma página para listagem
    "id": "string",              // Identificador da página no padrão page://{domínio do tenant}/{identificador único da página}
    "name": "string",            // Nome da página
    "credentials": true,         // Indica se devem ser enviadas as credenciais para os componentes da página
    "positionType": "ABSOLUTE",  // Indica se os componentes possuirão tamanhos absolutos (fixos) ou relativos à tela (Tipos padrões: ABSOLUTE e RELATIVE)
    "permission": {              // Permissão necessária para visualizar a página
      "resource": "string",      // O URI do resource
      "action": "string"         // O nome da ação
    }
  },
  "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ê?