SimpleApiRequest

Данный класс содержит методы, которые дают доступ к деталям запроса настроенного REST API в скрипте.

внимание

Экземпляры объектов этого типа доступны только в теле скрипта действия API в виде переменной запроса.

Подробнее читайте в статье Настройки REST API.

getBody()

---

Используйте метод, чтобы получить тело запроса.

Возвращаемое значение:

Тип	Описание
Any	Метод возвращает тело запроса.

Пример:

getBody()

(function(request, response) {
    // Отправляет запрос в формате JSON на
    // https://your-instance-url.simpleone.ru/v1/api/c_simple/api_module_path/api_action_path
 
    const requestBody = request.getBody(); // {"key":"value"}
})(SimpleApiRequest, SimpleApiResponse)

getHeader(header)

---

Используйте метод, чтобы получить значение указанного заголовка запроса.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
header	String	Да	null

Возвращаемое значение:

Тип	Описание
Any	Метод возвращает значение указанного заголовка.

Пример:

getHeader()

(function(request, response) {
    // Отправляет запрос в формате JSON
    // https://your-instance-url.simpleone.ru/v1/api/c_simple/api_module_path/api_action_path
 
    const contentType = request.getHeader('content-type'); // application/json
})(SimpleApiRequest, SimpleApiResponse)

getHeaders()

---

Используйте метод, чтобы получить все заголовки запроса и их значения.

Возвращаемое значение:

Тип	Описание
Object	Метод возвращает объект, ключи которого – названия заголовков.

Пример:

getHeaders()

(function(request, response) {
    // Отправляется запрос на
    // https://your-instance-url.simpleone.ru/v1/api/c_simple/api_module_path/api_action_path
 
    const allHeaders = request.getHeaders(); // {"accept-encoding":["gzip, deflate, br"],"postman-token":...}
})(SimpleApiRequest, SimpleApiResponse)

getQueryParams()

---

Используйте метод, чтобы получить параметры запроса.

Возвращаемое значение:

Тип	Описание
Object	Метод возвращает объект, ключи которого – параметры запроса.

Пример:

getQueryParams()

(function(request, response) {
    // Отправляется запрос на
    // https://your-instance-url.simpleone.ru/v1/api/c_simple/api_module_path/api_action_path?param_1=value_1
 
    const queryParamsObject = request.getQueryParams(); // {"param_1":"value_1"}
})(SimpleApiRequest, SimpleApiResponse)

getQueryString()

---

Используйте метод, чтобы получить параметры запроса в виде строки.

Возвращаемое значение:

Тип	Описание
String	Метод возвращает параметры запроса.

Пример:

getQueryString()

(function(request, response) {
    // Отправляется запрос на
    // https://your-instance-url.simpleone.ru/v1/api/c_simple/api_module_path/api_action_path?param_1=value_1
 
    const queryParamsString = request.getQueryString(); // param_1=value_1
})(SimpleApiRequest, SimpleApiResponse)

getUri()

---

Используйте метод, чтобы получить URI запроса без информации о домене.

Возвращаемое значение:

Тип	Описание
String	Метод возвращает URI запроса. Если после имени домена не было передано никакого пути, метод возвращает значение null.

Примеры:

getUri()

(function(request, response) {
    //  Отправляется запрос на 
    // https://your-instance-url.simpleone.ru/v1/api/c_simple/api_module_path/api_action_path?param_1=value_1
 
    const URI = request.getUri(); // /v1/api/c_simple/api_module_path/api_action_path
})(SimpleApiRequest, SimpleApiResponse)

getUri()

(function(request, response) {
    //  Отправляется запрос на 
    // https://your-instance-url.simpleone.ru/
 
    const URI = request.getUri(); // null
})(SimpleApiRequest, SimpleApiResponse)

getUrl()

---

Используйте метод, чтобы получить полный URL запроса.

Возвращаемое значение:

Тип	Описание
String	Метод возвращает полный URL запроса.

Пример:

getUrl()

(function(request, response) {
    //  Отправляется запрос на 
    // https://your-instance-url.simpleone.ru/v1/api/c_simple/api_module_path/api_action_path?param_1=value_1
 
    const URL = request.getUrl(); // http://your-instance-url.simpleone.ru/v1/c_simple/api_module_path/api_action_path
})(SimpleApiRequest, SimpleApiResponse)