Russian (Русский) - Change language

GetFilteredBatches

Назначение

Позволяет получить отфильтрованный  список пакетов с сервера порциями. Например, строить запросы типа «выдать 100 пакетов на стадии распознавания, начиная с 500 записи».

Определение

int GetFilteredBatches(int sessionId, int projectId, int batchTypeId, int[] stageTypes, int[] stageExtIds, string name, int batchPurpose, long startDate, long stopDate, long slaDateBeginRange, long slaDateEndRange, int slaStateFlags, int firstRecord, int recordsCount, RegistrationProperty[] filterRegParams, out Batch[] batches)
    

Параметры

Имя Тип Описание
sessionId int Идентификатор сессии подключения к Серверу Приложений
projectId int Идентификатор проекта, о пакетах которого необходимо получить информацию
batchTypeId int

Идентификатор типа пакета

  • 0 – пакет по умолчанию
  • 1 – все типы пакетов
stageTypes int []

Массив типов стадий (возможные значения: см. ProcessingStage), пакеты на которых интересуют

  • Пустой массив – все стадии
  • 0 - «пакеты вне стадий»
stageExtIds int []

Массив идентификаторов стадий (поле Id в структуре ProcessingStage), пакеты на которых интересуют

  • Пустой массив – все стадии
  • 0 - «пакеты вне стадий»
name string Префикс имени пакета. Пустая строка – допустимы любые имена
batchPurpose int

Назначение пакета

Возможные значения:

  • 0 - пакет с данными
  • 1 - пакеты обучения наложения определения документов
  • 2 - пакеты обучения классификатора
startDate long

Пакеты с датой создания позднее, чем указанная, 0 - все пакеты

Для конвертации используйте следующие методы (пример на языке C#):

DateTime dtTime;
long lTime;
...
// конвертация из DataTime в long
dTime = DataTime.FromFileTime(lTime);
...
// конвертация из long в DataTime
lTime = dTime.ToFileTime();
        
stopDate long

Пакеты с датой создания не раньше, чем указанная, 0 - все пакеты

Для конвертации используйте следующие методы (пример на языке C#):

DateTime dtTime;
long lTime;
...
// конвертация из DataTime в long
dTime = DataTime.FromFileTime(lTime);
...
// конвертация из long в DataTime
lTime = dTime.ToFileTime();
        
slaDateBeginRange long

Пакеты с датой окончания обработки по SLA не раньше, чем указанная, 0 - все пакеты

Для конвертации используйте следующие методы (пример на языке C#):

DateTime dtTime;
long lTime;
...
// конвертация из DataTime в long
dTime = DataTime.FromFileTime(lTime);
...
// конвертация из long в DataTime
lTime = dTime.ToFileTime();
        
slaDateEndRange long

Пакеты с датой окончания обработки по SLA не позже, чем указанная, 0 - все пакеты

Для конвертации используйте следующие методы (пример на языке C#):

DateTime dtTime;
long lTime;
...
// конвертация из DataTime в long
dTime = DataTime.FromFileTime(lTime);
...
// конвертация из long в DataTime
lTime = dTime.ToFileTime();
        
slaStateFlags int

Содержит предупреждение об истечении времени обработки пакета

Допустимы следующие значения или их логическая сумма (OR):

  • 0 - не фильтруем по этому признаку
  • 1 - пакеты с не заданным сроком обработки
  • 2 - пакеты, со сроком обработки, не являющимся истекающим или истекшим
  • 4 - пакеты с истекающим сроком обработки
  • 8 - пакеты с истекшим сроком обработки
firstRecord int Номер записи, с которой начинаем выборку
(Нумерация начинается с нулевого элемента)
recordsCount int Количество пакетов, которые хотим получить в выборке
filterRegParams RegistrationProperty[] Массив пар «имя-значение» для фильтрации по регистрационным параметрам.
(Допускается передать не больше 5 пар значений, остальные будут проигнорированы)

Замечание. Пакеты отсортированы по убыванию идентификатора, т.е. «самые новые пакеты – в начало».

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

Тип Описание
int Количество пакетов на сервере, удовлетворяющих заданному фильтру
Batch[] Массив заполненных структур Batch

10.11.2020 12:08:08


Please leave your feedback about this article