Especificando cabeçalhos HTTP

Determinadas customizações de solicitação requerem a configuração de cabeçalhos de HTTP. Os cabeçalhos Content-Type e Accept controlam o formato de entrada e de saída. O cabeçalho Range controla a paginação. O cabeçalho Compression controla a compactação.

Cabeçalhos Content-Type e Accept

Para especificar os tipos de conteúdo do corpo da solicitação e da saída, use os cabeçalhos Content-Type e Accept.

Tabela 1. Valores dos cabeçalhos Content-Type e Accept
Nome do Cabeçalho Valor Descrição
Content-Type application/json Indica que o formato do corpo da solicitação é JSON.
application/xml Indica que o formato do corpo da solicitação é XML.
application/x-www-form-urlencoded Indica que o corpo da solicitação é codificado por URL.
Accept application/json Configura o tipo de saída para JSON.
application/json;indent=2 Configura o tipo de saída para JSON formatada.
application/xml Configura o tipo de saída para XML.

Intervalo

O cabeçalho Range controla a paginação nas chamadas da API List.

Tabela 2. Valores do cabeçalho de intervalo
Nome do Cabeçalho Valor Descrição
Range items=x-y Retorna registros com IDs de linha x por meio y Como alternativa, é possível especificar o intervalo na URL de solicitação com o parâmetro _range=x-y

Compactação

Para compactar os dados em uma resposta, configure o cabeçalho Accept-Encoding.

Tabela 3. Valores do cabeçalho de compactação
Nome do Cabeçalho Valor Descrição
Accept-Encoding gzip Retorna resultados compactados com o formato GNU .ZIP.
identity Retorna resultados com a codificação de identidade (nenhuma transformação).

X-HTTP-Method-Override

Se não for possível usar um verbo HTTP em uma solicitação, envie uma solicitação POST com o verbo como o valor do cabeçalho de substituição. A solicitação se comporta como se a chamada fosse feita com o verbo HTTP indicado no cabeçalho de substituição.

Por exemplo, se não for possível transmitir uma solicitação DELETE para o número de pedido 12345, configure o cabeçalho X-HTTP-Method-Override para DELETE e use a solicitação de HTTP:
POST https://host:port/contextRoot/restapi/order/12345
Também é possível usar o cabeçalho X-HTTP-Method-Override para transmitir os parâmetros nas solicitações GET que excederem o limite de tamanho de uma URL. Faça um POST para a URL, configure o cabeçalho Content-Type para application/x-www-form-urlencoded, e configure o cabeçalho X-HTTP-Method-Override para GET.
Tabela 4. Valores do cabeçalho X-HTTP-Method-Override
Nome do Cabeçalho Valor
X-HTTP-Method-Override GET
  PATCH
  DELETE