APIs - Tutoriais

GetPageResources

23 views 18/08/2021 rodolfo-andrade 0

Retorna todos os recursos utilizados para a exibição de uma página

Payload de entrada:

{
  "pageId": "string"  // Identificador da página
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/cms​/queries​/getPageResources" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "pageId": "string" }"

Responses:

200 OK
{
  "resources": {           // Recurso de uma página por tipo
    "name": "string",      // Nome do componente
    "type": "DATASET",     // Tipo do componente
    "uri": "string",       // URI do recurso
    "actionUri": "string"  // Ação do recurso
  }
}
Tipos de componentes padrões:

    DATASET
    ANALYTIC
    WIDGET

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)

404 Not Found (Página não encontrada)
{
  "message": "Descrição do erro",
  "errorCode": "codigoDoErro",
  "reason": "OBJECT_NOT_FOUND",
  "domain": "platform",
  "service": "cms"
}

Este artigo foi útil para você?