Использование полей в ссылках удаленных задач

На этой странице приведено руководство по полям, используемым ссылками удаленных задач REST и Java API.

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

См. Руководство по API REST для примеров с полными образцами данных и скриншотами JSON.

Поле.

Необходимые.

JSON Key

Описание.

Воздействие, если пробел

Поле: GlobalID

 

Обязательно: мы настоятельно рекомендуем вам передать это значение.

 

JSON Key: globalId

Описание: глобально уникальный идентификатор, который уникально идентифицирует удаленное приложение и удаленный объект в удаленной системе. Максимальная длина - 255 символов.

 

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

Поле: Отношения

 

JSON Key: отношения

Описание: Связь между удаленным объектом и задачей Jira. Это может быть глагол или существительное. Он используется для группировки ссылок в пользовательском интерфейсе.

 

Воздействие, если пробел: «ссылки на», используемые в пользовательском интерфейсе.

Поле: объект

 

Поле: URL

 

Обязательно: в противном случае вы не можете создать ссылку.

 

JSON Key: object.url

 

 

Описание: гиперссылка на объект в удаленной системе.

Поле: Название

 

Обязательно: в противном случае вы не можете создать ссылку.

 

JSON Key: object.title

Описание: название удаленного объекта.

Поле: Резюме

 

JSON Key: object.summary

Описание: Текстовое резюме удаленного объекта.

 

Воздействие пробела: в пользовательском интерфейсе нет текста.

Поле: URL-адрес значка

 

Обязательно: мы настоятельно рекомендуем вам передать это значение.

 

JSON Key: object.icon.url16x16

Описание: Значок 16x16, представляющий тип объекта в удаленной системе.

 

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

Поле: Название значка

 

Обязательно: мы настоятельно рекомендуем вам передать это значение.

 

JSON Key: object.icon.title

Описание: Текст для всплывающей подсказки главного значка, описывающего тип объекта в удаленной системе. Название и имя приложения объединяются для создания всплывающей подсказки

Воздействие пробела: в подсказке используется только имя приложения.

Поле: разрешено

 

JSON Key: object.status.resolved

Описание: «разрешен ли удаленный объект» (значение «истинно») или «неразрешен» (значение «false»). Это значение будет иметь смысл только тогда, когда удаленный объект является чем-то разрешимым (например, задача, билет поддержки и т. д.). Это не имеет смысла для таких вещей, как страницы Wiki.

Если «Решено» является «истина», ссылка на вопрос будет иметь зачеркивающий шрифт.

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

Поле: значок значка состояния

 

JSON Key: object.status.icon.url16x16

Описание: Значок 16x16, представляющий статус удаленного объекта.

 

Воздействие пробела: в пользовательском интерфейсе отсутствует значок состояния.

Поле: текст значка статуса

 

JSON Key: object.status.icon.title

Описание: Текстовое описание статуса для всплывающей подсказки значка статуса. Не используется, если URL-адрес значка состояния пуст.

 

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

Поле: значок состояния

 

JSON Key: object.status.icon.link

Описание: гиперссылка на всплывающую подсказку значка состояния. Не используется, если URL-адрес значка состояния пуст.

 

Воздействие пробела: значок статуса не доступен.

Поле: приложение

 

Поле: название приложения

 

Обязательно: мы настоятельно рекомендуем вам передать это значение.

 

JSON Key: application.name

Описание: Человеко-читаемое имя экземпляра удаленного приложения, в котором хранится удаленный объект. Ссылки сгруппированы по типу приложения и имени приложения _ в пользовательском интерфейсе. Название иконки и имя приложения объединяются для создания всплывающей подсказки главного значка.

Воздействие пробела: только знаковое название используется в подсказке значков.

Если  заголовок значка также пуст, на панели инструментов значков отображается «Веб-ссылка». Группировка и сортировка ссылок могут помещать эти ссылки в последнюю очередь.

Поле: Тип приложения

 

Обязательно: мы настоятельно рекомендуем вам передать это значение.

 

JSON Key: application.type

Описание: Тип приложения с расширением имен. Он не отображается пользователю. Рендеринг приложений может регистрироваться для рендеринга определенного типа приложений. Ссылки группируются на основе типа приложения и _Application Name _ в пользовательском интерфейсе.

См. Сортировку ниже.

 

Воздействие пробела: вы не сможете предоставить пользовательский виализатор(рендер) для своих ссылок.

 

Соблюдается уникальность в глобальном идентификаторе для конкретного ключа задачи.

поле

 

Удаленный пример Jira

GlobalID

appId=123&issueId=123

Relationship (отношения)

дубликаты

URL

http://mycompany.com/jira/CWD-111

Заголовок

CWD-111

Summary (Резюме)

Поддержка вложенных групп

Иконка URL

http://mycompany.com/jira/bug.png

Загловок иконки

Ошибка - проблема, которая нарушает или предотвращает функции продукта

Разрешено

false

Status Icon URL (URL-адрес значка статуса)

https://www.mycompany.com/jira/images/icons/newfeature.gif

Текст иконки статуса

Разрешено. Решение принято, и оно ожидает проверки репортером. Отсюда задачи либо возобновляются, либо закрываются.

Имя приложения

Моя компания Jira

Тип приложения

com.atlassian.jira

 

Примеры удаленного Confluence

Поле

Примеры удаленного Confluence

 

GlobalID

appId=456&pageId=123

Relationship (отношения)

упомянуто в

URL

http://www.website.com/hello.html

Заголовок Title

Моя первая страница

Иконка URL

http://mycompany.com/wiki/page.png

Загловок иконки

Страница

Ссылка иконки статуса

Моя компания Wiki

Тип приложения

com.atlassian.confluence

 

Примеры веб-ссылок

Поле

Примеры веб-ссылок

URL

http://www.website.com/hello.html

Загловок

Hello World

По материалам Atlassian JIRA  Server Developer Using fields in Remote Issue Links