Формат EnterpriseData
09.12.2022

Методы веб-сервиса EnterpriseDataUpload

• Описание методов веб–сервиса
  • Ping
  • TestConnection
  • PutFilePart
  • PutData
  • PutDataActionResult
• Примеры использования веб-сервиса
• Ресурсы

Внимание! Данный функционал доступен в "Библиотеке стандартных подсистем", начиная с версии 2.3.1.62.

Описание методов веб– сервиса

Примечание. Все типы приведены согласно схеме http://www.w3.org/2001/XMLSchema.

Ping

Метод выполняет проверку соединения с информационной базой.

Возвращаемое значение: «пустая строка».

Тип возвращаемого значения – string.

В случае успешного соединения будет возвращена пустая строка.

TestConnection

Метод выполняет проверку подключения к информационной базе.

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

• «True» – если проверка пройдена успешно,
• «False» – если подключение установить не удалось.

В случае если подключение установить не удалось, в выходном параметре «ErrorMessage» будет передано сообщение о причинах ошибки.

Тип возвращаемого значения – boolean.

Параметры метода:

• ErrorMessage – Сообщение об ошибке. Выходной. Тип – string.

PutFilePart

Метод помещает переданную часть файла во временное хранилище.

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

Параметры метода:

• FileID – Уникальный идентификатор файла, передаваемого в информационную базу. Входной. Тип – string;
• PartNumber – Номер части передаваемого файла. Входной. Тип – int. Если архив с данными передается одним куском, PartNumber должен быть равен нулю. Если архив разбит на несколько частей – параметр PartNumber должен соответствовать номеру части, начиная с единицы;
• PartData – Часть файла, закодированная в двоичные данные. Входной. Тип – base64Binary;
• ErrorMessage – Сообщение об ошибке. Выходной. Тип – string.

PutData

Метод загружает в информационную базу данные из временного хранилища, полученные ранее с помощью метода «PutFilePart», согласно настройкам узла информационной базы.

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

Параметры метода:

• FileID – Уникальный идентификатор файла, переданного в информационную базу. Входной. Тип – string;
• OperationID – Уникальный идентификатор операции. Выходной. Тип – string.
• ErrorMessage – Сообщение об ошибке. Выходной. Тип – string.

PutDataActionResult

Метод определяет текущее состояние выполняемой операции.

Возвращаемое значение: «Active» если операция выполняется, «Completed» если операция выполнена, «Failed» если в процессе выполнения операции возникли ошибки и «Canceled» если операция отменена. В случае если в процессе выполнения операции возникла ошибка, в выходном параметре «ErrorMessage» будет передано сообщение о ее причинах.

Тип возвращаемого значения – string.

Параметры метода:

• OperationID – Уникальный идентификатор операции. Входной. Тип – string;
• ErrorMessage – Сообщение об ошибке. Выходной. Тип – string.

Примеры использования веб-сервиса

 Загрузка данных в информационную базу выполняется в следующем порядке:

• Проверить соединение с информационной базой, с помощью метода TestConnection;
• XML-файл с данными заархивировать в формате ZIP и разбить полученный архив на части;
• Отправить каждую часть архива в информационную базу с помощью метода PutFilePart;
• После отправки всех частей архива, вызвать метод PutData;
• Получить результат выполнения метода PutData можно с помощью метода PutDataActionResult.

Ресурсы

• Описание, XSD-схемы и актуальные версии формата EnterpriseData
• Примеры использования веб-сервисов на C# и Java