RESTAPIRequest - com escopo, global

A API RESTAPIRequest fornece métodos que permitem acessar detalhes da solicitação de API REST em scripts.

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.

RESTAPIRequest - corpo

O corpo da solicitação.

Tabela 1. Campo

Nome	Tipo	Descrição
corpo	RESTAPIRequestBody	O corpo da solicitação. Você pode acessar dados do objeto do corpo usando a API RESTAPIRequestBody.

var requestBody = request.body // Returns instance of RESTAPIRequestBody

RESTAPIRequest - getHeader(Cabeçalho de cadeia de caracteres)

Retorna o valor de um cabeçalho específico da solicitação de serviço web.

Tabela 2. Parâmetros

Nome	Tipo	Descrição
cabeçalho	Cadeia de caracteres	O nome do cabeçalho, como accept ou content-type.

Tabela 3. Retorna

Tipo	Descrição
Cadeia de caracteres	O valor do cabeçalho especificado.

var acceptHeader = request.getHeader('accept');

RESTAPIRequest – getSupportedResponseContentTypes()

Obtenha os tipos de conteúdo especificados no cabeçalho Aceitar da solicitação.

Tabela 4. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 5. Retorna

Tipo	Descrição
Matriz	Uma matriz de valores de cadeia de caracteres em que cada cadeia de caracteres é um tipo de conteúdo, como aplicação/json.

RESTAPIRequest - cabeçalhos

Todos os cabeçalhos da solicitação.

Tabela 6. Campo

Nome	Tipo	Descrição
cabeçalhos	objeto	Todos os cabeçalhos da solicitação e seus valores.

var headers = request.headers; 
var acceptHeader = headers.Accept;
var myCustomHeader = headers.myCustom; 
var specialHeader = headers['special - header'];

RESTAPIRequest - pathParams

Os parâmetros de caminho passados no URI da solicitação.

Tabela 7. Campo

Nome	Tipo	Descrição
pathParams	Objeto	Os parâmetros de caminho como um objeto de script. Os parâmetros de caminho disponíveis dependem da configuração do serviço web.

Neste exemplo, o endpoint de API REST de script segue este formato: https://instance.service-now.com/api/now/myservice/{tableName}/{id}. A solicitação que está sendo processada usa este URL: https://instance.service-now.com/api/now/myservice/myApp_table/1234.

var pathParams = request.pathParams; 
var tableName = pathParams.tableName; //'myApp_table' 
var id = pathParams.id; //'1234'

RESTAPIRequest - queryParams

Os parâmetros de consulta da solicitação de serviço web.

Tabela 8. Campo

Nome	Tipo	Descrição
queryParams	Matriz	Os parâmetros de consulta da solicitação de serviço web.

Neste exemplo, a solicitação que está sendo processada usa este URL: https://<instance_rest_endpoint> ?active=false&name=now . Observe os parâmetros active e name.

var queryParams = request.queryParams; 
var isActiveQuery = queryParams.active; // [false] 
var nameQueryVal = queryParams.name; // ['now']

RESTAPIRequest - queryString

A consulta inteira adicionada ao URI do endpoint.

Tabela 9. Campo

Nome	Tipo	Descrição
queryString	Cadeia de caracteres	A consulta inteira para a solicitação.

Neste exemplo, a solicitação que está sendo processada usa este URL: https://<instance_rest_endpoint> ?active=false&name=now . Observe a consulta active=false&name=now.

var query = request.queryString; //"active=false&name=now"

RESTAPIRequest - URI

O URI da solicitação, excluindo informações de domínio.

Tabela 10. Campo

Nome	Tipo	Descrição
URI	Cadeia de caracteres	O URI da solicitação, excluindo informações de domínio.

Neste exemplo, a solicitação que está sendo processada usa este URL: https://instance.service-now.com/api/now/table/myTable?active=false&name=now.

var query = request.uri; //"api/now/table/myTable"

RESTAPIRequest - URL

A URL de solicitação inteira.

Tabela 11. Campo

Nome	Tipo	Descrição
URL	Cadeia de caracteres	A URL de solicitação inteira.

Neste exemplo, a solicitação que está sendo processada usa este URL: https://instance.service-now.com/api/now/table/myTable?active=false&name=now.

var query = request.url; //"https://instance.service-now.com/api/now/table/myTable?active=false&name=now"