Solicitação de controle e tipo de conteúdo de resposta

Controla quais tipos de conteúdo são permitidos em solicitações e respostas da REST API com script.

Por padrão, REST APIs com script são compatíveis aplicação/json , aplicação/xml e texto/xml . Tipos de conteúdo personalizados definidos pelo usuário (com json ou xml (subtipos) também são compatíveis. Por exemplo, vnd.collection e json e. vnd.adobe.xdp.xml São tratados como JSON e XML, respectivamente.

Importante:

Se o formato do corpo da solicitação não for de um json ou xml subtipo, use somente o corpo da solicitação Fluxo de dados campo para acessar o corpo da solicitação. Usando corpo da solicitação dados , DataString , NextEntry() ou HasNext() com um formato não json ou não xml resulta em um 500 resposta de erro.

Padrões de configuração

Você pode definir valores padrão para a API usando Formatos de solicitação compatíveis padrão e. Formatos de resposta compatíveis padrão campos. Esses campos definem valores aceitáveis que os usuários podem passar nos cabeçalhos de solicitação Content-Type e Accept, respectivamente. Se um usuário solicitante especificar um cabeçalho Accept ou Content-Type não compatível com a API ou recurso, a instância responderá com um código de erro HTTP de 406 ou 415 .

Você pode substituir esses valores para cada recurso usando Formatos de solicitação compatíveis e. Formatos de resposta compatíveis No formulário Serviço REST com script.

Nota:

. Formatos de solicitação compatíveis O campo aparece somente para recursos PUT, POST e PATCH.

Usando valores curinga

Você pode usar valores curinga ao especificar tipos de conteúdo válidos.

• Para executar uma pesquisa curinga de caractere único, use o caractere de sinal de porcentagem (%). Este curinga encontra palavras que contêm qualquer caractere no lugar do caractere de sinal de porcentagem. Por exemplo, para encontrar palavras como texto ou teste, pesquise por: te%t .
• Para executar uma pesquisa curinga de vários caracteres, use o caractere asterisco (*). Este curinga encontra palavras que contêm zero ou mais caracteres no lugar do caractere asterisco. Por exemplo, para encontrar palavras como planejado ou inserido, pesquise: pl*d .

Usando o tipo de conteúdo x-www-form-urlencoded

Se uma REST API ou recurso aceitar aplicação/x-www-form-urlencoded Content-type, você pode recuperar os valores urlencoded fornecidos na solicitação como um mapa JSON. Em seguida, você pode fornecer esses pares de chave-valor urlencoded como parâmetros de consulta, no corpo da solicitação ou ambos. Eles são combinados e armazenados nos parâmetros de solicitação. Acesse esses parâmetros por meio do Request.queryParams objeto.

Por exemplo, se sua API estiver definida para aceitar aplicação/x-www-form-urlencoded E sua API é implementada da seguinte forma,

(function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {

 response.setBody(request.queryParams);

})(request, response);

... em seguida, a seguinte solicitação produz a respectiva resposta:

POST to localhost:8080/api/now/some_api/some_resource?name3=value3&name4=value4

Corpo do texto:

name1=value1&name2=value2

Resposta:

{ "result":
    { "name4": [ "value4" ], "name3": [ "value3" ], "name2": [ "value2" ],
      "name1": [ "value1" ]
    }
}

Enviando tipo binário em uma resposta

Ao enviar um tipo binário em uma resposta, você deve definir o tipo de conteúdo da resposta e gravar o fluxo binário diretamente usando um RESTAPIResponseStream objeto. Você pode acessar este objeto chamando GetStreamWriter() no objeto de resposta. Para obter mais informações, consulte.