3.5.5. Утилиты

3.5.5.1. AS.FORMS.ApiUtils

class AS.FORMS.ApiUtils()

Утилиты для работы с REST API Synergy

Примечание

При использовании данных методов адрес и порт Synergy, а также параметры авторизации определяются при подключении проигрывателя форм. Методы являются оберткой над jQuery.ajax() и обладают всеми его свойствами.

AS.FORMS.ApiUtils.simpleAsyncGet(urlPart[, callback[, dataType[, data[, errorHandler]]]])

Выполнить GET запрос по указанному URL REST API.

Аргументы:
  • urlPart (String) – Часть URL метода REST API, без http://host:port/Synergy/, например rest/api/registry/create_doc?registryCode=someregistry
  • callback (function) – Функция, которая будет вызвана в случае успешного выполнения запроса. В данную функцию передается один параметр - ответ на запрос.
  • dataType (String) – default:'json' Тип данных ответа на запрос. Может принимать значения: "xml", "html", "script", "json", "jsonp", "text". Если не передавать параметр, то будет использоваться дефолтное значение "json".
  • data (object) – Данные запроса. Могут быть строкой, объектом или массивом. Конвертируются в строку запроса и добавляются к URL.
  • errorHandler (function) – Функция, которая будет вызвана в случае неуспешного выполнения запроса.
Returns Object:

Объект, содержащий Promise объект, который используется для отслеживания асинхронных вызовов.

С помощью него можно строить цепочки вызовов.

Например так:

jQuery.when(AS.FORMS.ApiUtils.get("url"))
    .then(function(result){
        //do something
        return AS.FORMS.ApiUtils.get("url2")
    }).then(function(result){
        //do something
    }).fail(function(error){
        // любая ошикаб которая произойдет во
        // время выполнения будет обработана здесь
    });

Или ждать результаты выполнения нескольких запросов.

jQuery.when(AS.FORMS.ApiUtils.get("url"),
           AS.FORMS.ApiUtils.get("url1"),
           AS.FORMS.ApiUtils.get("url2"))
    .then(function(result1, result2, result3){
        //do something
    }).fail(function(error){
        // любая ошикаб которая произойдет во
        // время выполнения будет обработана здесь
    });
AS.FORMS.ApiUtils.simpleAsyncPost(urlPart[, callback[, dataType[, data[, contentType[, errorHandler]]]]])

Выполнить POST запрос по указанному URL REST API.

Аргументы:
  • urlPart (String) – Часть URL метода REST API, без http://host:port/Synergy/, например rest/api/asforms/data/save
  • callback (function) – Функция, которая будет вызвана в случае успешного выполнения запроса. В данную функцию передается один параметр - ответ на запрос.
  • dataType (String) – default:'json' Тип данных ответа на запрос. Может принимать значения: "xml", "html", "script", "json", "jsonp", "text".
  • data (object) – Данные запроса. Должны соответствовать параметру contentType
  • contentType (String) – default:'application/x-www-form-urlencoded; charset=UTF-8' Тип данных запроса.
  • errorHandler (function) – Функция, которая будет вызвана в случае неуспешного выполнения запроса.
Returns Object:

Объект, содержащий Promise объект, который используется для отслеживания асинхронных вызовов.

Примечание

подробнее об этом написано в документации к методу simpleAsyncGet