Справочный центр Wialon

update_admin_field

Для создания, изменения или удаления административного поля элемента используйте метод item/update_admin_field. Для отправки запроса необходимы права доступа на элемент Просмотр административных полей и Управление административными полями.

Конечная точка

Copied!
svc=item/update_admin_field&params={
  "itemId":<long>,
  "id":<long>,
  "callMode":"<text>",
  "n":"<text>",
  "v":"<text>"
}

Параметры

Запрос должен содержать следующие параметры:

Параметр Описание
itemId ID элемента.
id ID административного поля. При создании административного поля укажите любое значение, например 0. Система не учитывает его и назначает наименьший свободный ID в пределах элемента (1, 2 и т. д.). ID удаленных полей используются повторно.
callMode Действие: create, update или delete.

Для создания или изменения административного поля также укажите следующие параметры:

Параметр Описание
n Имя административного поля.
v Значение административного поля.

Ответ

Если административное поле успешно создано или изменено, возвращается ответ следующего формата:

Copied!
[
	<long>,			/* ID административного поля */
	{
		"id":<long>,	/* ID административного поля */
		"n":"<text>",	/* имя */
		"v":"<text>",	/* значение */
		"ct":<uint>,	/* время создания (Unix-время) */
		"mt":<uint>	/* время последнего изменения (Unix-время) */
	}
]

Если административное поле успешно удалено, возвращается ответ следующего формата:

Copied!
[
	<long>,	/* ID административного поля */
	null
]

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

Коды ошибок

Код ошибки Описание
4 Неверные входные параметры. Например, у callMode неподдерживаемое значение или изменяемое административное поле не найдено.
6 Не удалось создать административное поле, или удаляемое административное поле не найдено.
7 Не удалось получить элемент. Возможно, у пользователя нет прав Просмотр административных полей и Управление административными полями на этот элемент.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.