ExtSyncObj.List — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
 
(не показано 5 промежуточных версий этого же участника)
Строка 1: Строка 1:
 
==Описание==  
 
==Описание==  
 +
Списочный метод получения записей таблицы ExtSyncObject.
 
Метод возвращает список записей таблицы ExtSyncObj в соответствии с переданными параметрами.
 
Метод возвращает список записей таблицы ExtSyncObj в соответствии с переданными параметрами.
 
Возвращаемые поля: Type, Data, SbisId, ClientId, StatusId, StatusMsg, Priority, Uuid
 
Возвращаемые поля: Type, Data, SbisId, ClientId, StatusId, StatusMsg, Priority, Uuid
Строка 5: Строка 6:
  
 
==Параметры==
 
==Параметры==
* ДопПоля - Список полей, который должны быть в результате помимо полей по умолчанию. (Массив)
+
* ExtraFields - Список полей, который должны быть в результате помимо полей по умолчанию. (Массив)
Возможные значения: Id, Rey1, Key2, Key3, Number, Action
+
Возможные значения: Id, Key1, Key2, Key3, Number, Action
* Фильтр - Список полей по которым будет выполнен отбор записей. (Объект)
+
* Filter - Список полей по которым будет выполнен отбор записей. (Объект)
 
Возможные значения: 'SyncDocId', 'Type', 'StatusId', 'Uuid'. Обязательно должен быть указан Uuid или SyncDocId
 
Возможные значения: 'SyncDocId', 'Type', 'StatusId', 'Uuid'. Обязательно должен быть указан Uuid или SyncDocId
* Сортировка - Список полей по которым будет осуществляться сортировка (Массив, RecordSet, SortingList)
+
* Sorting - Список полей по которым будет осуществляться сортировка (Массив, RecordSet, SortingList)
 
Возможные значения: Type, Priority.
 
Возможные значения: Type, Priority.
* Навигация - Параметры постраничной навигацию. По умолчанию РазмерСтраницы - 50 (Объект)
+
* Pagination - Параметры постраничной навигацию. По умолчанию РазмерСтраницы - 50 (Объект)
  
  
Строка 17: Строка 18:
 
<source lang="json">
 
<source lang="json">
 
{
 
{
   "ДопПоля": ["Id", "Action"],
+
   "ExtraFields": ["Id", "Action"],
   "Фильтр": {
+
   "Filter": {
 
     "SyncDocId": "017f1612-5124-e710-b1f3-bf17e1cd9d1c",
 
     "SyncDocId": "017f1612-5124-e710-b1f3-bf17e1cd9d1c",
 
     "StatusId": "Подготовлен"
 
     "StatusId": "Подготовлен"
 
   },
 
   },
   "Сортировка": ["Priority", "Action"],
+
   "Sorting": ["Priority", "Action"],
   "Навигация": {
+
   "Pagination": {
     "Страница": 2,
+
     "Page": 2,
     "РазмерСтраницы": 50
+
     "PageSize": 50
 
   }
 
   }
 
}
 
}
Строка 34: Строка 35:
 
<source lang="json">
 
<source lang="json">
 
{
 
{
   "Результат": [{
+
   "Result": [{
 
     "Type": "Номенклатура",
 
     "Type": "Номенклатура",
 
     "Data": {},
 
     "Data": {},
Строка 46: Строка 47:
 
     "Action": 2
 
     "Action": 2
 
   }],
 
   }],
   "Навигация": {
+
   "Navigation": {
     "Страница": 2,
+
     "HasMore": true
     "РазмерСтраницы": 10,
+
     "PageSize": 50,
     "ЕстьЕще": true
+
     "Page": 2
 
   }
 
   }
 
}
 
}

Текущая версия на 14:53, 1 октября 2021

Описание

Списочный метод получения записей таблицы ExtSyncObject. Метод возвращает список записей таблицы ExtSyncObj в соответствии с переданными параметрами. Возвращаемые поля: Type, Data, SbisId, ClientId, StatusId, StatusMsg, Priority, Uuid Полное имя метода: ExtSyncObj.List

Параметры

  • ExtraFields - Список полей, который должны быть в результате помимо полей по умолчанию. (Массив)

Возможные значения: Id, Key1, Key2, Key3, Number, Action

  • Filter - Список полей по которым будет выполнен отбор записей. (Объект)

Возможные значения: 'SyncDocId', 'Type', 'StatusId', 'Uuid'. Обязательно должен быть указан Uuid или SyncDocId

  • Sorting - Список полей по которым будет осуществляться сортировка (Массив, RecordSet, SortingList)

Возможные значения: Type, Priority.

  • Pagination - Параметры постраничной навигацию. По умолчанию РазмерСтраницы - 50 (Объект)


Пример параметров метода:

{
  "ExtraFields": ["Id", "Action"],
  "Filter": {
    "SyncDocId": "017f1612-5124-e710-b1f3-bf17e1cd9d1c",
    "StatusId": "Подготовлен"
  },
  "Sorting": ["Priority", "Action"],
  "Pagination": {
    "Page": 2,
    "PageSize": 50
  }
}

Результат

Объект со списком записей и признаком наличия записей на следующей странице.

{
  "Result": [{
    "Type": "Номенклатура",
    "Data": {},
    "SbisId": "5236",
    "ClientId": "35788796543",
    "StatusId": "Подготовлен",
    "StatusMsg": "",
    "Priority": 56423,
    "Uuid": "017f1612-5124-e710-b1f2-bf15e1cd9d5c",
    "Id": "",
    "Action": 2
  }],
  "Navigation": {
    "HasMore": true
    "PageSize": 50,
    "Page": 2
  }
}