documentgenerator.template.list

Scope: documentgenerator Права на выполнение: для всех

Описание и пример

documentgenerator.template.list(select = ['*'], filter = [], order = [], start = 0)

Возвращает список шаблонов по фильтру.

Пример

templates: {
	202: {
		"id": "202",
		"active": "Y",
		"name": "Rest Template",
		"code": "",
		"region": "ru",
		"sort": "100",
		"createTime": "2018-06-05T13:07:12+02:00",
		"updateTime": "2018-09-06T14:26:24+02:00",
		"moduleId": "rest",
		"numeratorId": "20",
		"withStamps": "N",
		"isDeleted": "N",
		"download": "",
		"downloadMachine": "",
		"providers": [
			"bitrix\documentgenerator\dataprovider\rest": "bitrix\documentgenerator\dataprovider\rest"
		],
		"users" [
			"0": "UA"
		]
	}
}

Параметры

Параметр	Описание
select	массив полей для вывода. По умолчанию выводит все поля шаблона, кроме users и providers. Чтобы они появились, надо добавить дополнительно. Например, `['*', 'providers', 'users']`.
order	массив для указания порядка вывода `{"id": "desc"}`.
filter	массив для фильтрации.
start	offset для постраничной навигации.

Примеры фильтра

filter: {
  "numeratorId": "20",
  "region": "ru",
  "active": "Y"
}

По умолчанию фильтр имеет следующие значения:

filter: {
  "moduleId": "rest", // изменить нельзя, метод всегда вернет шаблоны только для реста
  "isDeleted": "N" // если нужен список шаблонов без учета isDeleted, необходимо передать "@isDeleted": ["Y", "N"]
}

Метод вернет список шаблонов с их полями.