api.web Ссылка на карточку или вкладку карточки в веб-интерфейсе

Ссылка на карточку в веб-интерфейсе

  • api.web.open(subject)

    api.web.open(subject, login_or_accesskey)

    api.web.openWithUserUUID(subject, login_or_accesskey)

    Генерация URL-ссылки для перехода на карточку указанного объекта.

    Параметры метода:

    • subject — текущий объект, карточка которого открывается при переходе по ссылке. Параметр может быть задан в виде объекта или строки, содержащей его uuid
    • login_or_accesskey — логин или ключ авторизации пользователя для входа в систему (по имени пользователя или по uuid пользователя), см. api.auth Работа с ключами авторизации

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

    Возвращает строку, содержащую URL-ссылку на карточку указанного объекта.

    Примеры:

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

    ${api.web.asLink(api.web.open(subject, api.auth.getAccessKey('username')), 'Карточка объекта')}

    ${api.web.asLink(api.web.open(subject.UUID, 'username'), 'Карточка объекта')}

    ${api.web.asLink(api.web.openWithUserUuid(subject, 'userUuid'), 'Карточка объекта')}

    2. Ссылка для перехода в карточку с указанием логина и пароля или через прозрачную аутентификацию (Kerberos):

    ${api.web.asLink(api.web.open(subject), 'Карточка объекта')}

    ${api.web.asLink(api.web.open(subject.UUID)}, 'Карточка объекта')}

Ссылка на вкладку карточки в веб-интерфейсе

  • api.web.openTab(subject.UUID, tabId)

    api.web.openTab(subject.UUID, tabId, username)

    api.web.openTab(subject.UUID, tabId, accessKey)

    Генерация URL-ссылки для перехода на конкретную вкладку в карточке объекта.

    Параметры метода:

    • subject.UUID — uuid объекта
    • tabId — идентификатор вкладки
    • username — имя пользователя
    • accessKey — ключ доступа

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

    Возвращает строку, содержащую URL-ссылку на карточку указанного объекта.

    Примеры:

    1. Ссылка для перехода на вкладку карточки объекта:

    ${api.web.asLink(api.web.openTab(subject.UUID, tabId), 'Вкладка на карточке объекта')}

    2. Ссылка для перехода на конкретную вкладку в карточке объекта с параметрами - идентификатор объекта, идентификатор вкладки, имя пользователя

    ${api.web.asLink(api.web.openTab(subject.UUID, tabId, 'username'), 'Вкладка на карточке объекта')}

    3. Ссылка для перехода на конкретную вкладку в карточке объекта с параметрами - идентификатор объекта, идентификатор вкладки, ключ доступа

    ${api.web.asLink(api.web.openTab(subject.UUID, tabId, accessKey), 'Вкладка на карточке объекта')}