RESTAPIRequestBody - escopo, global

. RESTAPIRequestBody A API fornece métodos que permitem acessar o conteúdo do corpo de uma solicitação de REST API com script em scripts.

O formato de um objeto RESTAPIRequestBody pode ser JSON ou XML, dependendo do valor do cabeçalho do tipo de conteúdo da solicitação.

Nota:

Não é possível instanciar objetos deste tipo. Objetos desse tipo são criados automaticamente e podem ser acessados somente em scripts de recursos da REST API com script.

Esta API é executada no sn_ws namespace.

Example-request-body de entrada única no formato JSON.

{
 "name": "user1",
 "id": 1234,
 "roles": [
  {
   "name": "admin"
  },
  {
   "name": "itil"
  }
 ]
}

Example-request-body de várias entradas no formato JSON.

[{
 "name": "user1",
 "id": 1234,
 "roles": [
  {
   "name": "admin"
  },
  {
   "name": "itil"
  }
 ]
},{
 "name": "user2",
 "id":9876,
 "roles": [
  {
   "name":"admin"
  }
 ]
}]

RESTAPIRequestBody - dados

O conteúdo do corpo da solicitação.

Nota:

Os serviços web REST consomem dados, fluxo de dados e cadeia de dados por meio de fluxo. Como os fluxos são consumidos apenas uma vez, somente um pode ser chamado. Por exemplo, se chamar dados e dataString, a segunda chamada retornará vazia.

Tabela 1. Campo

Nome	Tipo	Descrição
dados	Objeto ou matriz	O conteúdo da solicitação. Pode ser um único objeto ou uma matriz de objetos, dependendo da solicitação.

var entry;
var id;
var requestBody = request.body;
var requestData = requestBody.data; //May be an array or a single object
if (requestData instanceof Array) { 
 entry = requestData[0].name; // 'user1'
 id = requestData[0].id; // '1234'
} else {
 entry = requestData.name; // 'user1'
 id = requestData.id; // '1234'
}

RESTAPIRequestBody - Fluxo de dados

O conteúdo do corpo da solicitação, como um fluxo.

Nota:

Os serviços web REST consomem dados, fluxo de dados e cadeia de dados por meio de fluxo. Como os fluxos são consumidos apenas uma vez, somente um pode ser chamado. Por exemplo, se chamar dados e dataString, a segunda chamada retornará vazia.

Tabela 2. Campo

Nome	Tipo	Descrição
Fluxo de dados	Objeto	O conteúdo do corpo da solicitação. Você pode passar o fluxo para uma API separada, como criar um anexo a partir da solicitação ou encaminhar a solicitação para um endpoint diferente.

var requestBody = request.body; 
var requestStream = requestBody.dataStream;

RESTAPIRequestBody - Cadeia de dados

O conteúdo do corpo da solicitação, como uma cadeia de caracteres.

Nota:

Os serviços web REST consomem dados, fluxo de dados e cadeia de dados por meio de fluxo. Como os fluxos são consumidos apenas uma vez, somente um pode ser chamado. Por exemplo, se chamar dados e dataString, a segunda chamada retornará vazia.

Tabela 3. Campo

Nome	Tipo	Descrição
DataString	Cadeia de caracteres	O conteúdo do corpo da solicitação.

var requestBody = request.body; 
var requestString = requestBody.dataString;

RESTAPIRequestBody - hasNext()

Determina se há entradas adicionais no corpo da solicitação.

Use este método com NextEntry() método para iterar várias entradas do corpo da solicitação.

Tabela 4. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 5. Retorna

Tipo	Descrição
booliano	Sinalizador que indica se há entradas adicionais no corpo da solicitação. Valores possíveis: Verdadeiro: Entradas adicionais estão disponíveis. . NextEntry() chamado, HasNext() continua a ser verdadeiro até que o último registro correspondente seja carregado. Falso: Não há entradas adicionais.

var requestBody = request.body;
requestBody.hasNext(); // returns true if the request contains a single entry or multiple entries
requestBody. nextEntry(); // returns next available entry

//calling second time
requestBody.hasNext(); // returns false if the request contains a single entry, or true if the request contains multiple entries

RESTAPIRequestBody - nextEntry()

Recupere uma entrada do corpo da solicitação como um objeto de script.

Use este método com o método hasNext() para iterar várias entradas do corpo da solicitação.

Tabela 6. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 7. Retorna

Tipo	Descrição
Objeto	Uma única entrada do corpo da solicitação.

var requestBody = request.body;
var requestEntry = requestBody.nextEntry(); // returns available entry if there is only one entry, or the first entry if there are multiple.
var name = requestEntry.name; // 'user1'

// Calling second time
requestEntry = requestBody.nextEntry(); // returns undefined if there is only one entry, or the second entry if there are multiple.

Este exemplo demonstra o uso de hasNext() com nextEntry().

var requestBody = request.body;
while(requestBody.hasNext()){
var entry = requestBody.nextEntry();
}