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

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

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

getBody()

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

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

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

Пример:

getBody()
(function(request, response) {
    // Отправляет запрос в формате JSON на
    // https://your-instance-url.simpleone.ru/v1/c_simple/api_module_path/api_action_path

    const requestBody = request.getBody(); // {"key":"value"}
})(SimpleApiRequest, SimpleApiResponse)

getHeader(header)

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

Параметры:

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

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

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

Пример:

getHeader()
(function(request, response) {
    // Отправляет запрос в формате JSON
    // https://your-instance-url.simpleone.ru/v1/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/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/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/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/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)

  • No labels

© 2019-2024, SimpleOne

https://simpleone.ru