Формат EnterpriseData
09.13.2022

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

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

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

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

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

Ping

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

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

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

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

TestConnection

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

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

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

Тип возвращаемого значения – boolean (http://www.w3.org/2001/XMLSchema).

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

• ExchangePlanName – Имя плана обмена. Входной. Тип – string;
• PeerCode – Код узла плана обмена. Входной. Тип – string;
• ErrorMessage – Сообщение об ошибке. Выходной. Тип – string.

PrepareDataForGetting

Метод выгружает из информационной базы данные в файл, архивирует файл и разрезает его на части.

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

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

• ExchangePlanName  – Имя плана обмена, для которого происходит выгрузка. Входной. Тип – string;
• PeerCode – Код узла плана обмена, для которого происходит выгрузка. Входной. Тип – string;
• PartSize – Размер части (в килобайтах), на которые необходимо разрезать файл, по умолчанию 1024. Входной. Тип – decimal;
• OperationID – Уникальный идентификатор операции. Выходной. Тип – string;
• ErrorMessage – Сообщение об ошибке. Выходной. Тип – string.

PrepareDataActionResult

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

Возвращаемое значение: структура, содержащая поля:

• Status – Статус выполнения операции. Тип – string.
  
  Возможные значения:
  "Active" - соответствует значению перечисления СостояниеФоновыхЗаданий - Активно;
  "Completed" -  соответствует значению перечисления СостояниеФоновыхЗаданий - Завершено;
  "Failed" -  соответствует значению перечисления СостояниеФоновыхЗаданий - ЗавершеноАварийно;
  "Canceled" -  соответствует значению перечисления СостояниеФоновыхЗаданий - Отменено;
• FileID – Идентификатор подготовленного файла с данными. Тип – string;
• PartCount – Количество частей, на которые разделен файл. Тип – string;
• ErrorMessage – Сообщение об ошибке. Тип – string.

Тип возвращаемого значения – XML-документ, созданный по схеме EnterpriseDataExchange.xsd.

Скачать схему

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

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

GetDataPart

Метод возвращает запрошенную часть файла с данными, сформированного методом PrepareDataForGetting.

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

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

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

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

ConfirmGettingFile

Метод сообщает информационной базе о том, что стороннее приложение получило все части файла.

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

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

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

PutFilePart

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

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

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

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

PutData

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

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

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

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

PutDataActionResult

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

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

• «Active» – если операция выполняется,
• «Completed» – если операция выполнена,
• «Failed» – если в процессе выполнения операции возникли ошибки
• «Canceled» – если операция отменена.

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

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

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

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

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

Примеры использования методов для выгрузки/загрузки данных в информационную базу, опубликованную в сети Интернет:

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

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

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

• Проверить соединение с информационной базой с помощью метода TestConnection;
• Выполнить метод PrepareDataForGetting;
• С помощью метода PrepareDataActionResult получить результат выполнения метода PrepareDataForGetting. Если в результате выполнения метода PrepareDataActionResult выяснилось, что метод PrepareDataForGetting еще выполняется (в возвращаемом поле «Status», значение поля равно «Active»), то выполнение метода PrepareDataActionResult необходимо повторять (например, каждые 5 сек.) до тех пор, пока метод PrepareDataForGetting не будет выполнен (в возвращаемом поле «Status», значение поля станет не равно «Active»).
• Если метод PrepareDataForGetting был выполнен успешно, то получить все части сформированного файла с помощью метода GetDataPart;
• Сообщить информационной базе, что все файлы получены с помощью метода ConfirmGettingFile.

Ресурсы

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