Параметры строки запроса SPA¶

Поскольку приложение "Первая Форма" имеет веб-интерфейс и для работы с ним используется обычный браузер, в адресной строке можно задавать ссылки, которые указывают не только на главную страницу приложения, но и на различные представления и наборы данных, отфильтрованных определенным образом.

Ссылки имеют вид:

https://адрес_1Формы/{модуль}?{parameters}

или

https://адрес_1Формы/{XXX}?{parameters}

{модуль} — это название вызываемого модуля (например, MainTaskForm.aspx).

{XXX} — это описание конечной точки вместе с параметрами пути (например, /spa/tasks/{TaskID}).

{parameters} — это параметры строки запроса. Большая часть таких параметров — необязательные. Параметры задают условия отбора данных и отображения результатов. Если параметров несколько, они соединяются символом &.

Все основные параметры обязательны, т.е. если для какой-то настройки указаны два и более основных параметра, то значения должны быть заданы для всех (исключение — взаимоисключающие параметры TasksForExtParamID и TasksForLookupColumnId для lookup\'а).\ Дополнительные параметры необязательны, т.е. значения для них могут быть не заданы совсем или заданы выборочно.

Примеры:

\~/MainTaskForm.aspx?TaskID=123456&TemplateID=555

\~/spa/portal/123

ℹ️ Во всех примерах, приведенных в данном разделе, в адресной строке вместо символа \~ необходимо подставить https://адрес_1Формы или использовать относительные адреса.

Коды вместо символов¶

В интерфейсе SPA вместо служебных символов нужно использовать коды:

Символ Код ? %3F & %26 \$ %24 / %2F = %3D пробел %20 \ %5B \ %5D

Пример:

\~/MainTaskForm.aspx%3FTaskID%3D123456%26TemplateID%3D555

Переадресация на API-метод

В "Первой форме" реализована поддержка относительных адресов вне интерфейса SPA в /spa/entry/signin?fromUrl= , что позволяет совершать переадресацию на API-метод.

Пример использования:

При экспорте списка задач категории в Excel ДП "Файл" экспортируется и отображается в колонке в виде кликабельной гиперссылки вида:

https://адрес_1Формы/api/files/download/?redirect=1

При этом в API добавляется параметр URL ?auth=true, наличие которого совершает переадресацию на страницу авторизации в системе для ввода логина и пароля в случае возникновения ошибки доступа (error 401). В 257 версии страница логина указывается в ключе "AuthTokenLoginUrl" appsettings.json

Список задач¶

Список задач в категории или разделе¶

Название

Описание

\~/spa/tasks/subcat//grid

\~/spa/tasks/category/{categoryId}/grid

Основные параметры

subcatId

ID категории

categoryId

ID раздела

Пример

Просмотр списка задач в категории с ID=123:

\~/spa/tasks/subcat/123/grid

Смарт-отбор в списке задач¶

Название

Описание

\~spa/tasks/subcat/{subcatId}/grid?SmartQueryId={SmartQueryId}

Основные параметры

subcatId

ID категории

SmartQueryId

ID смарт-отбора

Пример

Просмотр списка задач в категории с ID = 5574 со смарт-отбором с ID = 18981

\~/spa/tasks/subcat/5574/grid?SmartQueryId=18981

Работает совместно с другими параметрами, например, с отбором по статусам ActiveMode. Просмотр списка задач категории с ID 333 со смарт-отбором 1234, показывая только заявки со статусом "Отклоненные":

\~/spa/tasks/subcat/333/grid?SmartQueryId=1234&ActiveMode=isRejected

Отбор по статусам в списке задач¶

Название

Описание

\~spa/tasks/subcat/{subcatId}/grid?ActiveMode={ActiveMode}

Основные параметры

subcatId

ID категории

ActiveMode

Параметр переопределяет выбор типа статусов "Все", "Активные", "Закрытые" или "Отклоненные".

Значение отбора по статусам:

ActiveMode=isOpened отображает только активные задачи.
ActiveMode=isClosed отображает только закрытые задачи.
ActiveMode=isRejected отображает только отклоненные задачи.

Если параметр "ActiveMode" не указан или задан пустым значением ("ActiveMode="), в категории отображаются задачи со всеми статусами.

Пример¶

Просмотр списка задач в категории с ID = 5574 со смарт-отбором с ID = 18981

Просмотр только активных задач в категории с ID = 333:

\~/spa/tasks/subcat/333/grid?ActiveMode=isOpened

Просмотр всех задач в категории с ID = 333:

\~/spa/tasks/subcat/333/grid?ActiveMode=

Просмотр закрытых задач в категории с ID = 333:

\~/spa/tasks/subcat/333/grid?ActiveMode=isClosed - Закрытые

Просмотр только отклоненных задач в категории с ID = 333:

\~/spa/tasks/subcat/333/grid?ActiveMode=isRejected - Отклоненные

Работает совместно с другими параметрами, например, со смарт-отбором SmartQueryId. Просмотр списка задач категории с ID 333 со смарт-отбором 1234, показывая только заявки со статусом "Отклоненные":

\~/spa/tasks/subcat/333/grid?SmartQueryId=1234&ActiveMode=isRejected

Фильтрация в списке задач:

Название

Описание

Позволяет передать в адресной строке браузера ссылку на любую системную таблицу (произвольный источники, списки задач категории, "мои задачи" и т.п. по любой колонке, у которой есть фильтр "содержит") с предустановленным фильтром

\~spa/tasks/subcat/{subcatId}/grid?f_{columnName}=%25{текст}%25

Основные параметры

subcatId

ID категории

columnName

Название колонки в DataSet: для текста задачи — task, для сообщения в логе ошибок — exception и т.д.

Если значение параметра имеет вид %{текст}%, фильтр отбирает записи, которые содержат указанный текст.

При формате %{текст} — отбираются записи, которые начинаются с этого текста. Формат {текст}% позволяет отобразить только те записи, которые заканчиваются на заданный текст. Знак процента в адресной строке передается в закодированном виде как "%25" (который преобразовывается в "%")

Пример

Просмотр списка задач в категории с фильтром по тексту задачи:

\~/spa/tasks/subcat/5574/grid?f_task=%25Задача

⚠️ Параметр f_* применяется поверх ранее сохранённых фильтров грида и не сбрасывает их автоматически. Если при переходе по ссылке результат неожиданный или пустой, очистите настройки грида кнопкой Очистить всё на панели фильтров, затем перейдите по ссылке снова.

ℹ️ Для пользователей, мигрирующих со старого интерфейса: параметр f_task в SPA является аналогом TaskTextFilter в устаревшем newcustomgrid.aspx. Пример замены: newcustomgrid.aspx?Subcatid=8&TaskTextFilter=0274062111 → spa/tasks/subcat/8/grid?f_task=0274062111%25

Мои задачи в избранном:

Название

Описание

Обязательные параметры

YouPerformerTasks

Я исполнитель

FromYou

Я заказчик

Subscribed

Я подписчик

Resolutions

Задачи на подписи

Signed

Задачи с согласованными вами подписями

Declined

Задачи с отклоненными вами подписями

Requested

Задачи с запрошенными вами подписями

YourGroups

Все задачи ваших подчиненных. В параметре OrgUnitId можно передать ID элемента орг.структуры.

YourGroupsOverdue

Просроченные задачи ваших подчиненных

YourGroupsActiveSigns

Задачи подчиненных на подписи

YourGroupsSignSigns

Подписанные задачи подчиненных

YourGroupsOverdueSigns

Задачи с просроченными подписями подчиненных

YourGroupsRefusedSigns

Задачи с отклоненными подписями от подчиненных

Примеры

Задачи, где я исполнитель:

\~/spa/tasks/YouPerformerTasks/grid?all=false&feedType=Performer

Задачи, где я заказчик:

\~/spa/tasks/FromYou/grid?all=false&feedType=Owner

Задачи, где я подписчик:

\~/spa/tasks/Subscribed/grid?all=false&feedType=All

Задачи на согласовании:

\~/spa/resolutions

Задачи с согласованными вами подписями:

\~/spa/tasks/Signed/grid

Задачи с отклоненными вами подписями:

\~/spa/tasks/Declined/grid

Задачи с запрошенными вами подписями:

\~/spa/tasks/Requested/grid

Все задачи ваших подчиненных:

\~/spa/tasks/YourGroups/grid?OrgUnitId=all

Просроченные задачи ваших подчиненных:

\~/spa/tasks/YourGroupsOverdue/grid

Задачи подчиненных на подписи:

\~/spa/tasks/YourGroupsActiveSigns/grid

Подписанные задачи подчиненных:

\~/spa/tasks/YourGroupsSignSigns/grid

Задачи с просроченными подписями подчиненных:

\~/spa/tasks/YourGroupsOverdueSigns/grid

Задачи с отклоненными подписями от подчиненных:

\~/spa/tasks/YourGroupsRefusedSigns/grid

Сводные разделы¶

Просмотр сводного раздела:

Название

Описание

\~/spa/tasks/summary/{summary_id}/grid

Основной параметр

summary_id

ID сводного раздела

Пример

Просмотр списка задач в категории с ID=123:

\~/spa/tasks/summary/123/grid

Задача¶

Создание новой задачи, интерфейс SPA¶

Название

Описание

\~/spa/newtask/{SubcatId}

Основной параметр

SubcatId

ID категории, в которой создается задача

Дополнительные параметры

OrderedTime

Срок. Если указывается, то значение для него передается в формате

dd.MM.yyyy%20HH:mm

(служебный символ %20 заменяет пробел)

TemplateID

ID нестандартного (пользовательского) шаблона карточки новой задачи

ExtParamString

Значения ДП. Передаются в строке следующего формата:

\~/spa/noframe/newtask/{SubcatID}?ExtParamString=\$Ext{ID_ДП_1}\${значение_ДП_1}\$Ext{ID_ДП_2}\${значение_ДП_2}

Для ДП Multilookup передается массив значений в формате:

\~/spa/noframe/newtask/{SubcatID}?ExtParamString=\$Ext{ID_ДП}\$[ID_задачи_1,ID_задачи_2,...]

Для ДП типа Таблица значение передаётся в формате JSON.

Формат значения в URL: ?ExtParamString=$Ext{IDДП}${"rows":[{"c{IDколонки}":"значение",...}]} Где: - ID_ДП — идентификатор ДП типа Таблица - c{ID_колонки} — ключ с префиксом c и идентификатором колонки - rows — массив строк таблицы

Правила применения: - Значения применяются только к колонкам с режимом редактирования, отличным от ReadOnly и Invisible - Smart-колонки вычисляются автоматически, их значения в URL игнорируются - Виртуальные колонки заполняются из URL - URL-параметр имеет приоритет над настройкой DefaultValue категории - Поддерживается комбинация скалярных ДП и таблицы в одном ExtParamString

SourceTaskID

Родительская задача

CommentID

Первый комментарий в задаче

UserID

От пользователя

LinkedID

Связанная задача

TaskText

Текст задачи

Примеры

Создание новой задачи в категории с ID=22, ДП с ID=38 будет присвоено значение 15, а ДП с ID=23 будет присвоено значение "Иванов Иван Иванович":

\~/spa/noframe/newtask/22?ExtParamString=\$Ext38\$15\$Ext23\$Иванов%20Иван%20Иванович

Cоздание новой задачи в категории с ID=22 со сроком 18.08.2018 15:00:

\~/spa/noframe/newtask/22?OrderedTime=18.08.2018%2015:00

Cоздание новой задачи в категории с ID=42 с использованием пользовательского шаблона 10:

\~/spa/noframe/newtask/42?TemplateID=10

Создание новой задачи в категории с ID=33, в ДП Multilookup с ID=44 будут переданы задачи с номерами 77 и 88:

\~/spa/noframe/newtask/33?ExtParamString=\$Ext44\$[77,88]{.f_CodeExample style="background-color: #ffff00;"}

Создание новой задачи в категории с ID=22, ДП с ID=38 будет присвоено значение 15:

\~/spa/noframe/newtask/22?ExtParamString=\$Ext38\$15

Создание новой задачи¶

Название

Описание

\~/NewTask.aspx

\~/spa/link?url=%2FNewTask.aspx (в таком формате при передаче значений параметров вместо служебных символов нужно использовать коды)

Основной параметр

SubcatID

ID категории, в которой создается задача

Дополнительные параметры

OrderedTime

Срок. Если указывается, то значение для него передается в формате

dd.MM.yyyy%20HH:mm

(служебный символ %20 заменяет пробел)

TemplateID

ID нестандартного (пользовательского) шаблона карточки новой задачи

ExtParamString

Значения ДП. Передаются в строке следующего формата:

ExtParamString=\$Ext{ID_ДП_1}\${значение_ДП_1}\$Ext{ID_ДП_2}\${значение_ДП_2}...

Для ДП Multilookup передается массив значений в формате:

ExtParamString=\$Ext{ID_ДП}\$[ID_задачи_1,ID_задачи_2,...]

SourceTaskID

Родительская задача

CommentID

Первый комментарий в задаче

UserID

От пользователя

LinkedID

Связанная задача

TaskText

Текст задачи

Примеры

Создание новой задачи в категории с ID=22, ДП с ID=38 будет присвоено значение 15, а ДП с ID=23 будет присвоено значение "Иванов Иван Иванович":

\~/NewTask.aspx?SubcatID=22?ExtParamString=\$Ext38\$15\$Ext23\$Иванов%20Иван%20Иванович

Cоздание новой задачи в категории с ID=22 со сроком 18.08.2018 15:00:

\~/NewTask.aspx?SubcatID=22?OrderedTime=18.08.2018%2015:00

Cоздание новой задачи в категории с ID=42 с использованием пользовательского шаблона 10:

\~/NewTask.aspx?SubcatID=42?TemplateID=10

Создание новой задачи в категории с ID=33, в ДП Multilookup с ID=44 будут переданы задачи с номерами 77 и 88:

\~/NewTask.aspx?SubCatID=33?ExtParamString=\$Ext44\$[77,88]{.f_CodeExample style="background-color: #ffff00;"}

Создание новой задачи в категории с ID=22, ДП с ID=38 будет присвоено значение 15:

\~/NewTask.aspx?SubCatID=22?ExtParamString=\$Ext38\$15

Создание новой задачи в категории с ID=22, ДП с ID=38 будет присвоено значение 15:

\~/spa/link?url=%2FNewTask.aspx%3FSubCatID%3D22%26ExtParamString%3D\$Ext38\$15

В таком формате нужно заменять служебные символы на коды (выделены голубым цветом).

Открытие карточки задачи, интерфейс SPA¶

Название

Описание

\~/spa/tasks/{TaskID}

Основной параметр

TaskID

ID задачи

Дополнительные параметры

layoutMode

Режим карточки задачи:

mtf — Карточка задачи

Пример: \~/spa/noframe/tasks/{taskid}?layoutMode=mtf

mtf-thread — Карточка задачи и комментарии

Пример: \~/spa/noframe/tasks/{taskid}?layoutMode=mtf-thread

mtf-only-thread — Комментарии

Пример: \~/spa/noframe/tasks/{taskid}?layoutMode=mtf-only-thread

Примеры

Открыть задачу с ID=123456

\~/spa/tasks/123456

Открытие карточки задачи¶

Название

Описание

MainTaskForm.aspx

Основной параметр

TaskID

ID задачи

Дополнительные параметры

TemplateID

ID нестандартного (пользовательского) шаблона карточки новой задачи

Примеры

Открыть задачу с ID=123456

\~/MainTaskForm.aspx?TaskID=123456

Открыть задачу с ID=123456 с использованием пользовательского шаблона 55

\~/MainTaskForm.aspx?TaskID=123456&TemplateID=55

Открытие карточки задачи в режиме "noframe", без панели инструментов и меню¶

Название

Описание

\~/spa/noframe/tasks/{TaskID}

Основной параметр

TaskID

ID задачи

Дополнительные параметры

layoutMode

Режим карточки задачи:

mtf — Карточка задачи

Пример: \~/spa/noframe/tasks/{taskid}?layoutMode=mtf

mtf-thread — Карточка задачи и комментарии

Пример: \~/spa/noframe/tasks/{taskid}?layoutMode=mtf-thread

mtf-only-thread — Комментарии

Пример: \~/spa/noframe/tasks/{taskid}?layoutMode=mtf-only-thread

uiTheme

Цветовая тема приложения. Параметр работает только в "noframe" и только в режиме layoutMode=mtf-only-thread. Доступные значения:

light — Светлая
dark — Темная

Пример:

\~/spa/noframe/tasks/{taskid}?layoutMode=mtf-only-thread&fromConf=1&uiTheme=dark

Примеры

Открыть задачу с ID=123456

\~/spa/noframe/tasks/123456

Вид задачи без фрейма:

Встреча¶

Создание новой встречи с предзаполненными полями, интерфейс SPA¶

Название

Описание

\~/spa/meeting/new/1507

Основной параметр

1507

ID системной категории "Календарь"

Дополнительные параметры

Title

Название.

Формат: текст (string)

RequiredAttendees

Участники.

В качестве значения передается id участника, несколько пользователей указываются через запятую.

Start

Дата и время (начало).

Формат: YYYY-MM-DDTHH:mm:ss.sss

End

Дата и время (конец).

Формат: YYYY-MM-DDTHH:mm:ss.sss

IsAllDayEvent

Весь день.

Формат: галочка (checkbox). Допустимые значения:

0 — нет
1 — да

Location

Место встречи

Формат: текст (string)

FreeBusyState

Показывать как.

Допустимые значения:

Free — Свободен
Tentative — Под вопросом
Busy — Занят
OOF — Нет на месте
WorkingElsewhere — Работаю в другом месте (Устаревшее)

LinkedTaskId

Связано с

Формат: номер задачи (number)

Description

Описание

Формат: текст (string)

Attachment

Вложения.

В качестве значения передается id файла, несколько файлов указываются через запятую.

Примеры¶

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

Название: Обсуждение
Участники: пользователи с id 28989 и 28988
Дата начала: 01.06.23 15:00
Дата завершения: 01.06.23 16:00
Показывать как: Свободен
Описание: Обсуждение текущих вопросов

\~/spa/meeting/new/1507?Title=Обсуждение&RequiredAttendees=28989,28988&Start=2023-06-01T15:00:00.000&End=2023-06-01T16:00:00.000&IsAllDayEvent=0&FreeBusyState=Free&Description=%Обсуждение%текущих%вопросов

Создание новой встречи с предзаполненными полями в режиме "noframe", интерфейс SPA¶

Название

Описание

\~/spa/noframe/meeting/new/1507

Основной параметр

1507

ID системной категории "Календарь"

Дополнительные параметры

Title

Название.

Формат: текст (string)

RequiredAttendees

Участники.

В качестве значения передается id участника, несколько пользователей указываются через запятую.

Start

Дата и время (начало).

Формат: YYYY-MM-DDTHH:mm:ss.sss

End

Дата и время (конец).

Формат: YYYY-MM-DDTHH:mm:ss.sss

IsAllDayEvent

Весь день.

Формат: галочка (checkbox). Допустимые значения:

0 — нет
1 — да

Location

Место встречи

Формат: текст (string)

FreeBusyState

Показывать как.

Допустимые значения:

Free — Свободен
Tentative — Под вопросом
Busy — Занят
OOF — Нет на месте
WorkingElsewhere — Работаю в другом месте

LinkedTaskId

Связано с

Формат: номер задачи (number)

Description

Описание

Формат: текст (string)

Attachment

Вложения.

В качестве значения передается id файла, несколько файлов указываются через запятую.

Примеры¶

Создание нового календарного события в режиме noframe (без панели инструментов и меню) со следующими параметрами:

Название: Обсуждение
Участники: пользователи с id 28989 и 28988
Дата начала: 01.06.23 15:00
Дата завершения: 01.06.23 16:00
Показывать как: Свободен
Описание: Обсуждение текущих вопросов

\~/spa/noframe/meeting/new/1507?Title=Обсуждение&RequiredAttendees=28989,28988&Start=2023-06-01T15:00:00.000&End=2023-06-01T16:00:00.000&IsAllDayEvent=0&FreeBusyState=Free&Description=%Обсуждение%текущих%вопросов

Лента

Просмотр главной ленты задач и комментариев¶

Название

Описание

\~/1FMain.aspx

\~/spa/feeds/{extp}

Дополнительные параметры

extp

Для ленты комментариев можно использовать параметр CommentsMode:

unread — вкладка Новые
lenta — вкладка Лента
myquestions — вкладка Исходящие
questionstome — вкладка Входящие

Для ленты задач можно использовать параметр TasksMode:

new — вкладка Новые
lenta — вкладка Задачи
owner — вкладка Заказчик
performer — вкладка Иполнитель

Режим. Если задано значение CommentsMode или TasksMode, то режим указывается после него через символ |

Возможные значения:

HideComments — выводится только лента задач
HideTasks — выводится только лента комментариев

extp (для SPA)

default - лента задач и комментариев
tasks — лента задач
comments — лента комментариев
unread — лента комментариев, вкладка Новые
lenta — лента комментариев, вкладка Лента
questions — лента комментариев, вкладка Входящие

Примеры

Вывод ленты задач и комментариев:

\~/1FMain.aspx\ \~/spa/feeds/default

Вывод ленты комментариев, вкладка "Новые":

\~/1FMain.aspx?extp=CommentsMode:unread|HideTasks

\~/spa/feeds/unread

Просмотр ленты категории или раздела¶

Название

Описание

\~/spa/tasks/subcat//feeds

\~/spa/tasks/category/{CategoryId}/feeds

Для обратной совместимости сохраняется поддержка устаревшего написания:

\~/spa/feeds/subcat/{SubcatId}

\~/spa/feeds/category/{CategoryId}

Основные параметры

SubcatId

ID категории

CategoryId

ID раздела

Примеры

Вывод ленты задач в категории с ID=123:

\~spa/tasks/subcat/123/feeds

Диск

Переход на главную страницу Диска (полный вид):

Название

Описание

\~/spa/disk

\~/spa/noframe/disk

В полном виде системные папки диска Мои файлы, Общие файлы, Файлы автоматизации, Файлы замещаемых и Файлы подчиненных выведены в качестве разделов и располагаются в отдельном блоке с левой стороны

Переход на главную страницу Диска (краткий вид):

Название

Описание

\~/spa/disk/short

\~/spa/noframe/disk/short

В кратком виде диска системные папки Мои файлы, Общие файлы, Файлы автоматизации, Файлы замещаемых и Файлы подчиненных отображаются в виде папок

Панель инструментов задачи — Документы — Диск:

Название

Описание

\~/spa/disk/Task/{TaskID}

Основной параметр

TaskID

ID задачи

Пример

Просмотр всех файлов задачи с ID=1234 на диске:

\~/spa/disk/Task/1234

Опросы

Редактор опросов:

Название

Описание

\~/spa/survey/creator/?surveyTaskId={surveyTaskId}

\~/spa/noframe/survey/creator?surveyTaskId={surveyTaskId}

Основной параметр

surveyTaskId

ID задачи

Пример

Просмотр редактора опроса в задаче с ID=123:

\~/spa/survey/creator/?surveyTaskId=123

Опрос:

Название

Описание

\~/spa/survey?assignmentTaskId={surveyTaskId}

\~/spa/noframe/survey?assignmentTaskId={surveyTaskId}

Основной параметр

surveyTaskId

ID задачи

Пример

Просмотр опроса в задаче с ID=123:

\~/spa/survey?assignmentTaskId=123

Чаты¶

Создать новый чат¶

Название

Описание

\~/spa/chat/new?with={UserID,UserID,...}&name={chat_name}&msg={chat_message}

\~/spa/chat/new?with={UserID}&with={UserID}&with={UserID}&name={chat_name}&msg={chat_message}

Основной параметр

with

Список ID пользователей — участников чата, перечисленных через запятую.

Можно использовать несколько параметров with

Дополнительные параметры

name

Название чата

msg

Первое сообщение, которое будет опубликовано в чате сразу после создания

Пример

Создать чат с пользователями с ID=11 и 22, с названием "our chat" и с сообщением "hello":

\~/spa/chat/new?with=11,22&name=our%20chat&msg=hello\ \~/spa/chat/new?with=11&with=22&name=our%20chat&msg=hello

Категория в представлении чата¶

Название

Описание

\~/spa/subcat/{subcatId}/chat

Основной параметр

subcatId

ID категории

Пример

Задачи в категории с ID=123 в представлении чата:

\~/spa/subcat/123/chat

Начать чат с пользователем:

Название

Описание

\~/spa/chat/new?with={userId}&private=true

Основной параметр

userId

ID пользователя

Дополнительный параметр

private

Признак приватного чата

Пример

Начать приватный чат с пользователем, у которого ID = 29000 :

\~/spa/chat/new?with=29000&private=true

Файлы¶

Просмотр файла¶

Название

Описание

Для файлов формата .doc, .docx, .ppt, .pptx, .xls, .xlsx:

\~/spa/file/{fileID}?mode=view

\~/spa/noframe/file/{fileID}?mode=view

Для файлов формата .jpg, .png, .pdf, .mp4:

\~/spa/file/{fileID}/1

\~/spa/noframe/file/{fileID}/1

Основной параметр

fileID

ID файла

Дополнительные параметры

mode

Доступ к файлу. Возможные значения:

view - Доступ только на чтение
edit - Доступ на редактирование

taskId

Номер задачи, в которую вложен файл

extParamId

ID ДП, в который вложен файл. Передается вместе с номером задачи (taskId)

folderId

ID папки диска, в которой вложен файл

Примеры

Просмотр файла формата .doc с ID=1234 в интерфейсе "Первой Формы":

\~/spa/file/1234?mode=view

Просмотр файла формата .doc с ID=1234 в режиме noframe:

\~/spa/noframe/file/1234?mode=view

Просмотр файла формата .pdf с ID=5678 в интерфейсе "Первой Формы":

\~/spa/file/5678/1

Просмотр файла формата .pdf с ID=5678 в режиме noframe:

\~/spa/noframe/file/5678/1

Просмотр документа в Р7 с доступом на редактирование (mode=edit), который вложен в ДП с ID=5678 в задаче с номером 12345:

\~/r7/?fileId=2071876&mode=edit&taskId=12345&extParamId=5678

Просмотр версии 1 документа с ID 1234 в задаче 56789 в режиме noframe:

\~/spa/noframe/file/1234/2?mode=view&taskId=56789&versionId=1

Подписи¶

Запрошенные подписи¶

Название

Описание

\~/spa/tasks/ToSign/grid

Примеры

Просмотр списка запрошенных подписей

\~/spa/tasks/ToSign/grid

Рабочее место акцептанта¶

Название

Описание

\~/spa/resolutions

Пример

Просмотр списка запрошенных подписей

\~/spa/resolutions

Почта¶

Просмотр почтовой папки¶

Название

Описание

\~/Emails/EmailList.aspx

Основной параметр

FolderID

ID почтовой папки

Примеры

Просмотр почтовой папки с ID=123

\~/Emails/EmailList.aspx?FolderID=123

Просмотр письма¶

Название

Описание

\~/Emails/EmailView.aspx

Основной параметр

EmailID

ID письма

Примеры

Просмотр письма с ID=1234567

\~/Emails/EmailView.aspx?EmailID=1234567

Порталы и виджеты¶

Просмотр портальной страницы¶

Название

Описание

для портала Flex: \~/spaex.aspx/portal/{portalID}?{filter_parameters}

для портала Dashboard: \~/spa/portal/{portalID}?{filter_parameters} или \~/spa/norfame/portal/{portalID}?{filter_parameters}

ℹ️ Когда портал Dashboard открывается ссылкой вида \~/spa/portal/{portalID}, то вместе с порталом отображается панель индикаторов. Если такая ссылка открывается изнутри интерфейса приложения (например, как ссылка из Избранного или как ссылка в настройках стартовой страницы), то панель индикаторов задублируется. Поэтому для открытия портала изнутри интерфейса приложения выбирайте формат \~/spa/noframe/portal/{portalID} (без фреймов)

Основной параметр

portalID

ID портала

Параметры

Если для какого-то блока на портале настроен фильтр, можно передать значения параметров этого фильтра. Каждый параметр передается в виде:

f{paramID}_v={paramValue}

Если параметров несколько, они перечисляются через &.

Форматы передачи значений для разных типов параметров фильтра:

Тип параметра фильтра Примеры передаваемых значений для параметра с ID=11 строка f11_v=test число f11_v=2 дата f11_v=25.06.2018 период f11_v=from:25.06.2018;to:20.06.2018 пользователь f11_v=\1,2,3\ орг.структура f11_v=\1,2,3\ выпадающий список f11_v=\1,2,3\ группа f11_v=\1,2,3\ категория f11_v=cat:\1,2,3\;subcat:\11,22,33\

ℹ️ Значения параметров фильтра, передаваемые в строке вызова, имеют приоритет над значениями по умолчанию (если они заданы).

Посмотреть ID параметра можно в настройках фильтра:

Параметры фильтра можно сделать доступными только для чтения, для этого используется модификатор _r :

f{paramID}_r=1

Примеры

Просмотр портальной страницы Flex с ID=123:

\~/spaex.aspx/portal/123

Просмотр портальной страницы Flex с ID=123, где значение параметра с ID=99 равно zzz и его нельзя изменить (read only):

\~/spaex.aspx/portal/123?f99_v=zzz&f99_r=1

Просмотр портальной страницы Dashboard с ID=123, где значение параметра с ID=88 равно 100, а значение параметра с ID=99 равно zzz:

\~/spa/portal/123?f88_v=100&f99_v=zzz

Просмотр виджета¶

Название

Описание

\~/spa/portal/block/{BlockID}

Обязательный параметр

BlockID

ID виджета

Дополнительные параметры

TaskID

ID задачи, если виджет вызывается в контексте карточки задачи

Если для какого-то виджета настроен фильтр, можно передать значения параметров этого фильтра. Каждый параметр передается в виде:

f{paramID}_v={paramValue}

Если параметров несколько, они перечисляются через &.

Форматы передачи значений для разных типов параметров фильтра:

Тип параметра фильтра Примеры передаваемых значений для параметра с ID=11 строка f11_v=test число f11_v=2 дата f11_v=25.06.2018 период f11_v=from:25.06.2018;to:20.06.2018 пользователь f11_v=\1,2,3\ орг.структура f11_v=\1,2,3\ выпадающий список f11_v=\1,2,3\ группа f11_v=\1,2,3\ категория f11_v=cat:\1,2,3\;subcat:\11,22,33\

ℹ️ Значения параметров фильтра, передаваемые в строке вызова, имеют приоритет над значениями по умолчанию (если они заданы).

Посмотреть ID параметра можно в настройках фильтра:

Параметры фильтра можно сделать доступными только для чтения, для этого используется модификатор _r :

f{paramID}_r=1

Примечание

ℹ️ Не поддерживается для виджета Smart Html и для виджета Таблица с настроенными кнопками

Примеры

Просмотр виджета с ID=123

\~/SinglePortalBlock.aspx?BlockID=123

или

\~/spa/portal/block/123

Просмотр виджета с ID=123 в контексте задачи с ID=123456

\~/SinglePortalBlock.aspx?BlockID=123&TaskID=123456

Просмотр виджета с ID=123, параметр фильтра с ID=99 имеет значение 2

\~/SinglePortalBlock.aspx?BlockID=123&f99_v=2

Просмотр новости¶

Название

Описание

\~/spa/portal/{portalId}?widgetId={widgetId}&taskId={taskId}

Основные параметры

portalId

ID портала

widgetId

ID портального блока

taskId

ID новости (задачи) из виджета

Примеры

Просмотр новости с ID=123456 из виджета с ID=2222, который находится в портале с ID=1111.

\~/spa/portal/1111?widgetId=2222&taskId=123456

Настройки виджета:

Название

Описание

\~/administration/widget-settings/{id}

Основной параметр

id

ID виджета

Примеры

Просмотр настроек виджета с ID=123

\~/administration/widget-settings/123

Пространства

Открыть краткий вид статьи пространства в режиме "noframe", без рамки¶

Название

Описание

\~spa/noframe/spaces/subcat/{SubcatID}/short?pageId={PageId}

Основные параметры

SubcatID

ID категории

PageId

ID статьи

Примеры

Открыть пространство в категории 45230 с ID=1493534

\~spa/noframe/spaces/subcat/45230/short?pageId=1493534

В кратком виде отображается только заголовок и содержимое без вложений, ленты комментариев, действий, навигации, ссылок, контактов и указания автора:

Таймлайн (лента времени)¶

Таймлайн для задачи¶

Название

Описание

\~/spa/tasks/{taskId}/timeline

Отображение без панели индикаторов и меню:

\~/spa/noframe/tasks/{taskId}/timeline

Основной параметр

taskId

ID задачи, для которой строится лента времени по связанным событиям

Пример

Просмотр ленты времени для задачи 123456:

\~/spa/tasks/123456/timeline

Диаграмма Ганта¶

Диаграмма Ганта категории или раздела¶

Название

Описание

\~/spa/tasks/subcat//gantt

\~/spa/tasks/category/{categoryId}/gantt

Основные параметры

subcatId

ID категории

categoryId

ID раздела

Пример

Просмотр диаграммы Ганта для категории с ID=123:

\~/spa/tasks/subcat/123/gantt

Календарь¶

Календарное представление категории или раздела¶

Название

Описание

\~/spa/tasks/subcat/{subcatId}/calendar

\~/spa/tasks/category/{categoryId}/calendar

Открыть в iframe (без шапки):

\~/Syndicate.aspx?forceURL=Scheduler.aspx?SubcatId={subcatId}&HideHeader=true

\~/Syndicate.aspx?forceURL=Scheduler.aspx?CategoryId={categoryId}&HideHeader=true

Основные параметры

subcatId

ID категории

categoryId

ID раздела

Пример

Просмотр календарного представления категории с ID=123:

\~/spa/tasks/subcat/123/calendar

Просмотр календарного представления категории с ID=123 во фрейме:

\~/Syndicate.aspx?forceURL=Scheduler.aspx?SubcatId=123&HideHeader=true

Календарь пользователя¶

Название

Описание

\~/spa/user/profile/{userId}?tab=calendar

Основные параметры

userId

ID пользователя

Пример

Просмотр календаря пользователя с ID=123:

\~/spa/user/profile/123?tab=calendar

Канбан-доска¶

Просмотр Канбан-доски¶

Название

Описание

\~/spa/kanban/{publicationAlias}

Основной параметр

publicationAlias

alias публикации, описывающей структуру данных Канбан-доски, см. здесь

Пример

Просмотр Канбан-доски, описываемой публикацией kanban-structure:

\~/spa/kanban/kanban-structure

Канбан-доска для категории¶

Название

Описание

\~/spa/tasks/subcat//kanban

Для обратной совместимости сохраняется поддержка устаревшего написания:

\~/spa/kanban/subcat/{subcatId}

Основной параметр

subcatId

ID категории

Пример

Просмотр Канбан-доски для категории с ID=123:

\~/spa/tasks/subcat/123/kanban

Канбан-доска исполнителя¶

Название

Описание

\~/spa/user/kanban/performer/{UserId}

Основной параметр

UserId

ID пользователя

Примечание

На канбан-доске отображаются:

не более 100 задач на сегодня,
не более 100 задач на завтра,
не более 100 задач, ближайших по сроку.

При определении срока учитывается срок самой задачи, срок запрошенной в задаче подписи и запланированные трудозатраты

Пример

Просмотр Канбан-доски задач, где исполнителем является пользователь с ID=123

\~/spa/user/kanban/performer/123

Отчёты¶

Просмотр отчёта¶

Название

Описание

\~/spa/report/new/{ReportId}

\~/MVC/ReportView/{ReportID}?{filter_params}

Основной параметр

ReportID

ID отчета

Дополнительные параметры

Если для какого-то отчета настроен фильтр, можно передать значения параметров этого фильтра. Каждый параметр передается в виде:

f{paramID}v={paramValue}

Если параметров несколько, они перечисляются через &.

Форматы передачи значений для разных типов параметров фильтра:

Тип параметра фильтра	Примеры передаваемых значений для параметра с ID=11 с именем Mod
строка	f11_Mod_v=test
число	f11_Mod_v=2
дата	f11_Mod_v=25.06.2018
период	f11_Mod_v=from:25.06.2018;to:20.06.2018
пользователь	f11_Mod_v=\1,2,3\
орг.структура	f11_Mod_v=\1,2,3\
выпадающий список	f11_Mod_v=\1,2,3\
группа	f11_Mod_v=\1,2,3\
категория	f11_Mod_v=\1,2,3\

(ID раздела указывать нельзя. Если нужно выбрать раздел, передается список категорий раздела)

ℹ️ Значения параметров фильтра, передаваемые в строке вызова, имеют приоритет над значениями по умолчанию (если они заданы).

ℹ️ Имя параметра регистрозависимо. ID параметра можно посмотреть в настройках фильтра

Параметры фильтра можно сделать доступными только для чтения, для этого используется модификатор (значение 1 делает параметр доступным только для чтения, значение 0 — нет):

f{paramID}_r=1

Примеры

Просмотр отчета с ID=123:

\~/spa/report/new/123

\~/MVC/ReportView/123

Просмотр отчета с ID=456 с параметрами Group (ID параметра = 11, в него передаются группы с ID 888 и 999) и Period (ID параметра = 22, в него передается период c 1 по 10 октября 2018):

\~MVC/ReportView/456?f11_Group_v=[888,999]{.f_CodeExample style="background-color: #ffff00;"}&f22_Period_v=from:01.10.2018;to:10.10.2018

Экспорт отчёта¶

Название

Описание

\~/MVC/ReportExport/{ReportID}?format={export_format}&{filter_params}

Основные параметры

ReportID

ID отчета

format

Возможные форматы экспорта: pdf, html, csv, image (файл jpg), dbf, xml, json, mht, odf, ods, odt, xls, docx, rtf, pptx, xaml, txt, svg, ps, ppml

Дополнительные параметры

Если для какого-то отчета настроен фильтр, можно передать значения параметров этого фильтра. Каждый параметр передается в виде:

f{paramID}v={paramValue}

Если параметров несколько, они перечисляются через &.

Форматы передачи значений для разных типов параметров фильтра:

Тип параметра фильтра	Примеры передаваемых значений для параметра с ID=11 с именем Mod
строка	f11_Mod_v=test
число	f11_Mod_v=2
дата	f11_Mod_v=25.06.2018
период	f11_Mod_v=from:25.06.2018;to:20.06.2018
пользователь	f11_Mod_v=\1,2,3\
орг.структура	f11_Mod_v=\1,2,3\
выпадающий список	f11_Mod_v=\1,2,3\
группа	f11_Mod_v=\1,2,3\
категория	f11_Mod_v=\1,2,3\

(ID раздела указывать нельзя. Если нужно выбрать раздел, передается список категорий раздела)

ℹ️ Значения параметров фильтра, передаваемые в строке вызова, имеют приоритет над значениями по умолчанию (если они заданы).

ℹ️ Имя параметра регистрозависимо. ID параметра можно посмотреть в настройках фильтра

Параметры фильтра можно сделать доступными только для чтения, для этого используется модификатор (значение 1 делает параметр доступным только для чтения, значение 0 — нет):

f{paramID}_r=1

Примеры

Экспорт отчета с ID=123 в формате pdf:

\~MVC/ReportExport/123?format=pdf

Экспорт отчета с ID=456 в формате jpg, с параметром Status (ID=99) со значением 2:

\~MVC/ReportExport/456?format=image&f99_Status_v=2

Пользователи¶

Просмотр справочника сотрудников¶

Название

Описание

\~/spa/org/list/{publicationAlias}

Основной параметр

publicationAlias

название публикации, возвращающей список сотрудников. В настоящее время используется публикация workers

Пример

Просмотр списка сотрудников:

\~/spa/org/list/workers

Просмотр профиля пользователя¶

Название

Описание

\~/spa/user/profile/{userId}

Основной параметр

userId

ID пользователя

Пример

Просмотр профиля пользователя с ID=99:

\~/spa/user/profile/99

Оргструктура

Орг. структура¶

Название

Описание

\~/spa/org/chart2/

\~/spa/org/chart/{publicationAlias}

Основной параметр

publicationAlias

Название публикации, которая возвращает данные по орг.структуре

Пример

Просмотр орг.структуры со стандартным набором данных:

\~/spa/org/chart2/

Просмотр орг.структуры с данными, формируемыми публикацией foreign_offices:

\~/spa/org/chart/foreign_offices

Иерархия

Просмотр иерархии¶

Название

Описание

\~/spa/task-hierarchy/{id}

Основной параметр

ID

ID иерархии

Пример

Просмотр иерархии с ID=123:

\~/spa/task-hierarchy/123

Планировщик¶

Планировщик:

Название

Описание

\~/spa/scheduling-assistant?users={UserID}

\~/spa/noframe/scheduling-assistant?users={UserID}

Основной параметр

UserID

ID пользователя

Пример

Переход к планировщику где 111 и 222 — ID пользователей:

/spa/scheduling-assistant?users=111,222

Переход к планировщику в режиме "noframe", без панели инструментов и меню, где 111 и 222 — ID пользователей:

Просмотр планировщика с ID=123:

/spa/noframe/scheduling-assistant?users=111,222

Файловое хранилище (Устаревшее)

Просмотр файлового хранилища (Диска)¶

Название

Описание

Просмотр начиная с корневой папки:

\~/spaex.aspx/file-storage

Просмотр начиная с выбранной папки, без дерева папок слева и без возможности подняться выше начального уровня:

\~/spaex.aspx/file-storage/{FolderType}/{FolderId}

Просмотр файлов в разделе, категории, задаче:

\~/spaex.aspx/file-storage/Category/{CategoryID}

\~/spaex.aspx/file-storage/Subcategory/{SubcatID}

\~/spaex.aspx/file-storage/album/{TaskID}

Основные параметры

FolderType

Возможные значения типа папки:

Root

корневая папка

Folder

папка в разделе "Общие файлы"

UserRoot

раздел "Мои файлы"

UserFolder

папки внутри раздела "Мои файлы"

Shared

раздел "Файлы пользователей" (доступен в том случае, если какой-либо пользователь предоставил вам доступ к своим личным файлам и папкам)

TaskRoot

раздел "Файлы в задачах"

Просмотр папки файлового хранилища (Диска)¶

Название

Описание

\~/spaex.aspx/file-storage/{FolderId}

Основной параметр

FolderID

ID папки

Пример

Просмотр папки с ID=555:

\~/spaex.aspx/file-storage/555

Просмотр файла в файловом хранилище (Диске)¶

Название

Описание

\~/spaex.aspx/file-storage/{FolderId}?fileid={FileId}

Основные параметры

FolderId

ID папки

FileId

ID файла

Пример

Просмотр файла с ID=123 из папки с ID=555:

\~/spaex.aspx/file-storage/555?fileid=123