Настройки видимости полей

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

Набор методов для работы с настройками видимости полей

Больше о настройках можно прочитать в документации по rpa

Кроме пользовательских полей, можно управлять видимостью системных полей в карточке канбана.

Системные поля имеют следующие коды:

id - id элемента
createdBy - кто создал
updatedBy - кто изменил
movedBy - кто сменил стадию
createdTime - время создания
updatedTime - время изменения
movedTime - время смены стадии

rpa.fields.*

Метод Описание С версии

Метод	Описание	С версии
`rpa.fields.getSettings({typeId: number, stageId: ?number})`	Метод вернет полный набор настроек видимости полей на стадии с идентификатором `stageId` процесса с идентификатором `typeId`. Параметры: `typeId` - идентификатор процесса `stageId` - идентификатор стадии. Необязательное поле, по умолчанию 0 (общие настройки) Пример ответа { "fields": { "kanban": { "id": true, "UF_RPA_1_NAME": true }, "create": { "UF_RPA_1_NAME": true } } }
`rpa.fields.setSettings({typeId: number, fields: ?[], stageId: ?number})`	Метод устанавливает полный набор настроек видимости полей на стадии с идентификатором `stageId` процесса с идентификатором `typeId`. Параметры: `typeId` - идентификатор процесса `stageId` - идентификатор стадии. Необязательное поле, по умолчанию 0 (общие настройки) `fields` - массив с настройками видимости полей Если передать пустой `fields`, то все настройки будут стерты Пример запроса { "typeId": 1, "fields": { "kanban": [ "createdBy", "UF_RPA_1_NAME" ] } } Метод вернет результат аналогичный запросу `rpa.fields.getSettings`
`rpa.fields.setVisibilitySettings({typeId: number, visibility: string, fields: ?[], stageId: ?number})`	Метод изменяет настройки видимости `visibility` полей `fields` для процесса с идентификатором `typeId` на стадии с идентификатором `stageId`. Остальные настройки при этом не изменяются. Параметры: `typeId` - идентификатор процесса `visibility` - идентификатор видимости, для которого меняются настройки `stageId` - идентификатор стадии. Необязательное поле, по умолчанию 0 (общие настройки) `fields` - массив с полями, для которых необходимо поменять настройку Метод необходимо использовать, когда надо изменить настройки видимости только одного типа Пример запроса { "typeId": 1, "visibility": "kanban", "fields": [ "createdBy", "UF_RPA_1_NAME" ] } Метод вернет результат аналогичный запросу `rpa.fields.getSettings`

rpa.fields.getSettings({typeId: number, stageId: ?number})

Метод вернет полный набор настроек видимости полей на стадии с идентификатором stageId процесса с идентификатором typeId. Параметры:

typeId - идентификатор процесса
stageId - идентификатор стадии. Необязательное поле, по умолчанию 0 (общие настройки)

Пример ответа

{
	"fields": {
		"kanban": {
			"id": true,
			"UF_RPA_1_NAME": true
		},
		"create": {
			"UF_RPA_1_NAME": true
		}
	}
}

rpa.fields.setSettings({typeId: number, fields: ?[], stageId: ?number})

Метод устанавливает полный набор настроек видимости полей на стадии с идентификатором stageId процесса с идентификатором typeId. Параметры:

typeId - идентификатор процесса
stageId - идентификатор стадии. Необязательное поле, по умолчанию 0 (общие настройки)
fields - массив с настройками видимости полей

Если передать пустой fields, то все настройки будут стерты

Пример запроса

{
	"typeId": 1,
	"fields": {
		"kanban": [
			"createdBy", 
			"UF_RPA_1_NAME"
		]
	}
}

Метод вернет результат аналогичный запросу rpa.fields.getSettings

rpa.fields.setVisibilitySettings({typeId: number, visibility: string, fields: ?[], stageId: ?number})

Метод изменяет настройки видимости visibility полей fields для процесса с идентификатором typeId на стадии с идентификатором stageId. Остальные настройки при этом не изменяются. Параметры:

typeId - идентификатор процесса
visibility - идентификатор видимости, для которого меняются настройки
stageId - идентификатор стадии. Необязательное поле, по умолчанию 0 (общие настройки)
fields - массив с полями, для которых необходимо поменять настройку

Метод необходимо использовать, когда надо изменить настройки видимости только одного типа

Пример запроса

{
	"typeId": 1,
	"visibility": "kanban",
	"fields": [
		"createdBy", 
		"UF_RPA_1_NAME"
	]
}

Метод вернет результат аналогичный запросу rpa.fields.getSettings

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.