---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# RESTAPIResponse - com escopo, global

# RESTAPIResponse - com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 min. de leitura

A API RESTAPIResponse fornece métodos que permitem criar uma resposta RESTful para uma solicitação de API REST com script.

Esta API é executada no namespace `sn_ws`.  
Nota:  
Você não pode instanciar objetos deste tipo. Objetos desse tipo são criados automaticamente e podem ser acessados somente em scripts de recurso de REST API com script.

## RESTAPIResponse -- getStreamWriter() {#ariaid-title2}

Retorna o ResponseStreamWriter para esta resposta, permitindo que você grave diretamente no fluxo de resposta.
Defina o tipo de conteúdo e o código de status usando as funções setHeaders e setStatus antes de chamar a função getStreamWriter.
{#r_SSRB-getStreamWriter__table_wnn_glb_sr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 1. Parâmetros]

{#r_SSRB-getStreamWriter__table_wnn_glb_sr} {#r_SSRB-getStreamWriter__table_xnn_glb_sr__entry__2}

| Tipo | Descrição |
|-|-|
| RESTAPIResponseStream - com escopo, global | O ResponseStreamWriter para esta resposta. Você pode usar este objeto para gravar diretamente no fluxo de resposta. |
[Tabela 2. Retorna]

{#r_SSRB-getStreamWriter__table_xnn_glb_sr}  

    response.setContentType('application/json');
    response.setStatus(200);
    var writer = response.getStreamWriter();

## RESTAPIResponse - setBody(corpo do objeto) {#ariaid-title3}

Define o conteúdo do corpo a ser enviado na resposta do serviço web.
{#r_SSRB-setBody_Object__table_yzt_cmr_qr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| corpo | Objeto | O corpo da resposta, como um objeto JavaScript. O conteúdo do corpo é serializado automaticamente para JSON ou XML, dependendo do valor do cabeçalho Accept passado na solicitação. |
[Tabela 3. Parâmetros]

{#r_SSRB-setBody_Object__table_yzt_cmr_qr} {#r_SSRB-setBody_Object__table_zzt_cmr_qr__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 4. Retorna]

{#r_SSRB-setBody_Object__table_zzt_cmr_qr}  

    var body = {};
    body.name = "incident";
    body.number = "1234";
    body.caller = {"id": "user1"};
    response.setBody(body);

    var bodyArray = [];
    var body = {};
    body.name = "incident";
    body.number = "1234";
    body.caller = {"id":"user1"};
    bodyArray.push(body);
    response.setBody(bodyArray);

## RESTAPIResponse - setContentType(cadeia de caracteres "contentType") {#ariaid-title4}

Atribui um valor ao cabeçalho Content-Type na resposta do serviço web.
Você deve definir um tipo de conteúdo de resposta antes de escrever a resposta. O tipo de conteúdo é definido automaticamente para respostas de cadeia de caracteres, com base no valor do cabeçalho Aceitar solicitação.

Definir um tipo de conteúdo inválido faz com que a resposta seja padronizada para JSON. A falha ao definir um tipo de conteúdo resulta em um erro de código de status 500 ao enviar uma resposta binária.

Consulte a [documentação do cabeçalho Content-Type W3](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) para obter mais informações sobre este cabeçalho.
{#r_SSRB-setContentType_String__table_dcn_3lr_qr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| contentType | Cadeia de caracteres | O tipo de conteúdo do corpo da resposta, como application/json. |
[Tabela 5. Parâmetros]

{#r_SSRB-setContentType_String__table_dcn_3lr_qr} {#r_SSRB-setContentType_String__table_ecn_3lr_qr__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 6. Retorna]

{#r_SSRB-setContentType_String__table_ecn_3lr_qr}  

    response.setContentType('application/json');

## RESTAPIResponse - setError(Erro de objeto) {#ariaid-title5}

Configura a resposta REST para retornar um erro.
{#r_SSRB-setError_O__table_apv_hb3_zs__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| erro | Objeto | Objeto de erro. Para obter mais informações sobre os tipos de objetos de erro que podem ser usados, consulte [Exemplo de Scripted REST API - amostras de script](https://servicenow-prod.fluidtopics.net/YLKMpDKavRj4NP8korCInQ "Esses exemplos demonstram como criar vários scripts de recursos para uma REST API com script."). |
[Tabela 7. Parâmetros]

{#r_SSRB-setError_O__table_apv_hb3_zs} {#r_SSRB-setError_O__table_bpv_hb3_zs__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 8. Retorna]

{#r_SSRB-setError_O__table_bpv_hb3_zs}  
O exemplo a seguir mostra como retornar um erro de dentro de um recurso REST com script.

    var queryParams = request.queryParams;
    var userId = String(queryParams.user_id || '');
    var fileId = String(queryParams.file_id || '');
    if (!userId || !fileId){
      response.setError(new sn_ws_err.BadRequestError('Missing required parameters.'));
      return;
    }

## RESTAPIResponse - setHeader(cabeçalho de cadeia de caracteres, valor de cadeia de caracteres) {#ariaid-title6}

Atribua um valor a um cabeçalho de resposta de serviço REST.
{#r_SSRB-setHeader_String_String__table_und_rt4_gs__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| cabeçalho | Cadeia de caracteres | O cabeçalho que você deseja definir. |
| valor | Cadeia de caracteres | O valor para atribuir o cabeçalho especificado. |
[Tabela 9. Parâmetros]

{#r_SSRB-setHeader_String_String__table_und_rt4_gs} {#r_SSRB-setHeader_String_String__table_vnd_rt4_gs__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 10. Retorna]

{#r_SSRB-setHeader_String_String__table_vnd_rt4_gs}  

    response.setHeader("Location","<URI>");

## RESTAPIResponse - setHeaders(cabeçalhos de objeto) {#ariaid-title7}

Define os cabeçalhos para a resposta do serviço web.
{#r_SSRB-setHeaders_Object__table_slb_j3r_qr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| cabeçalhos | Objeto | Um objeto JavaScript que lista cada cabeçalho e o valor para atribuir esse cabeçalho. |
[Tabela 11. Parâmetros]

{#r_SSRB-setHeaders_Object__table_slb_j3r_qr} {#r_SSRB-setHeaders_Object__table_tlb_j3r_qr__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 12. Retorna]

{#r_SSRB-setHeaders_Object__table_tlb_j3r_qr}  

    var headers = {};
    headers.X-Total-Count=100;
    headers.Location='https://instance.service-now.com/<endpoint_to_resource>';
    response.setHeaders(headers);

## RESTAPIResponse - setLocation(cadeia de caracteres local) {#ariaid-title8}

Atribui um valor ao cabeçalho Local na resposta do serviço web.
Consulte a [documentação do cabeçalho do local W3](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30) para obter mais informações sobre este cabeçalho.
{#r_SSRB-setLocation_String__table_mzd_1jr_qr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum(a) | Cadeia de caracteres | Um URI absoluto para o qual o destinatário da resposta será redirecionado. |
[Tabela 13. Parâmetros]

{#r_SSRB-setLocation_String__table_mzd_1jr_qr} {#r_SSRB-setLocation_String__table_nzd_1jr_qr__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 14. Retorna]

{#r_SSRB-setLocation_String__table_nzd_1jr_qr}

## RESTAPIResponse - setStatus(Status do número) {#ariaid-title9}

Define o número do código de status da resposta do serviço web.
{#r_SSRB-setStatus_Number__table_tj5_khr_qr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| status | Número | O código de status a ser enviado na resposta, como 200 para indicar sucesso. Passar um valor não numérico, como uma cadeia de caracteres, faz com que o código de status seja padronizado como 0. |
[Tabela 15. Parâmetros]

{#r_SSRB-setStatus_Number__table_tj5_khr_qr} {#r_SSRB-setStatus_Number__table_uj5_khr_qr__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 16. Retorna]

{#r_SSRB-setStatus_Number__table_uj5_khr_qr}  

    response.setStatus(200);