Содержание

Поиск элементов

Поиск элементов

Для поиска элементов по заданным критериям используется команда core/search_items:

svc=core/search_items&params={"spec":{
				"itemsType":<text>,	
				"propName":<text>,	
				"propValueMask":<text>,	
				"sortType":<text>
			     },
			     "force":<uint>,			
			     "flags":<long>,			
		             "from":<uint>,			
			     "to":<uint>}

Использование данного запроса рассмотрено в примере Поиск элементов.

Параметры

Название	Описание
spec	условия поиска
itemsType	тип искомых элементов (см. список ниже)
propName	имя свойства, по которому будет осуществляться поиск (см. список возможных свойств ниже)
propValueMask	значение свойства: может быть использован знак «*»
sortType	имя свойства, по которому будет осуществляться сортировка ответа
force	0 - если такой поиск уже запрашивался, то вернет полученный результат, 1 - будет искать заново
flags	флаги видимости для возвращаемого результата (Значение данного параметра зависит от типа элемента, который вы хотите найти. Форматы всех элементов, а так же их флаги описаны в разделе Форматы данных.)
from	индекс, начиная с которого возвращать элементы результирующего списка
to	индекс последнего возвращаемого элемента (0xffffffff - последний найденный)

Типы элементов системы Wialon (указываются в поле «itemsType»):

avl_resource – ресурс;
avl_retranslator – ретранслятор;
avl_unit – объект;
avl_unit_group – группа объектов;
user – пользователь.

Свойства элементов (указываются в поле «propName» и «sortType»):

sys_name – имя элемента;
sys_unique_id – ID элемента;
sys_user_creator – GUID создателя;
sys_comm_state – состояние оборудования (1 - подключено, 0 - отключено).

Возвращаемый результат

{
	"searchSpec":{			/* условия поиска */
		"itemsType":<text>,		/* тип элементов*/
		"propName":<text>,		/* имя свойства */
		"propValueMask":<text>,		/* значение свойства */
		"sortType":<text>		/* свойство для сортировки*/
	},
	"dataFlags":<uint>,		/* примененные флаги видимости */
	"totalItemsCount":<uint>,	/* количество найденных элементов*/
	"indexFrom":<uint>,		/* начальный индекс */
	"indexTo":<uint>,		/* конечный индекс */
	"items":[{...}]			/* найденные элементы */
}

Формат элементов массива «items» зависит от типа элементов, заданного при поиске (см. Форматы данных).

Возможные ошибки

Код	Значение
1	недействительная сессия
2	неверное имя сервиса
3	неверный результат
4	неверный формат или значение параметров