Referência de tokens de modelos Word

A lista completa de caminhos de dados (vinculações) que você pode usar em um modelo Word. Ela espelha o painel de referência de tokens do produto e o catálogo de vinculações que o validador aplica: se um caminho não estiver aqui, o editor o sinaliza. Para gramática e formatadores, veja Modo de modelo Word.

Como ler esta página

Uma vinculação escalar é usada em um token de valor: ${issue.summary}.
Uma vinculação de coleção é usada em um laço: ${#each issue.subtasks as sub}…${/each}. Dentro do laço, acesse um campo pela variável do laço: ${sub.key}.
Níveis — A é de disponibilidade geral; B vem junto apenas porque o pacote do item já carrega o dado; C é visível mas não vinculável, listado para que o escopo permaneça honesto.
Quais raízes estão disponíveis depende do contexto de exportação.

Contextos de exportação e suas raízes

Um modelo Word é executado em um de sete contextos, cada um expondo um conjunto diferente de raízes.

Contexto	Raízes disponíveis
`single-issue`	`issue`, `generatedAt`
`automation` (ação do Jira Automation)	`issue`, `generatedAt`
`multi-issue` (JQL / quadro)	`issues`, `issueGroups`, `generatedAt`
`scheduled`	`issues`, `issueGroups`, `generatedAt`
`sprint`	`issues`, `issueGroups`, `sprint`, `generatedAt`
`release`	`issues`, `issueGroups`, `release`, `generatedAt`
`backlog`	`issues`, `issueGroups`, `backlog`, `generatedAt`

generatedAt (data e hora) está disponível em todos os contextos.

Nível A — a superfície do item (`issue.*`)

Disponível em single-issue e automation. Os mesmos campos formam a estrutura por elemento da coleção issues: dentro de ${#each issues as it} use ${it.key}, ${it.summary} e assim por diante.

Escalares

Caminho	Tipo
`issue.key`	cadeia
`issue.summary`	cadeia
`issue.description`	texto formatado (ADF)
`issue.status`	status
`issue.status.category`	cadeia
`issue.priority`	prioridade
`issue.assignee`	usuário
`issue.assignee.displayName`	cadeia
`issue.reporter`	usuário
`issue.reporter.displayName`	cadeia
`issue.created`	data e hora
`issue.updated`	data e hora
`issue.dueDate`	data
`issue.parent.key`	cadeia
`issue.parent.summary`	cadeia
`issue.parent.status`	cadeia

Um valor do tipo usuário exibe o nome de exibição por padrão; use o formatador user para escolher uma parte, p. ex. ${issue.assignee | user("displayName")}. Um valor de texto formatado é renderizado com formatação; | plain() remove a formatação.

Coleções

Coleção	Campos do elemento (relativos à variável do laço)
`issue.labels`	lista primitiva — a variável do laço é o rótulo
`issue.components`	`name`
`issue.fixVersions`	`name`, `released` (booleano)
`issue.affectsVersions`	`name`
`issue.subtasks`	`key`, `summary`, `status`, `priority`, `assignee`, `dueDate`
`issue.comments`	`author` (usuário), `author.displayName`, `body` (ADF), `created`, `updated`
`issue.attachments`	`filename`, `mimeType`, `size`, `isImage`, `created`, `author.displayName` — apenas metadados, sem binários e sem URL
`issue.issueLinks`	`typeName`, `direction`, `linkedIssue.key`, `linkedIssue.summary`, `linkedIssue.status`
`issue.worklogs`	`author.displayName`, `timeSpent`, `timeSpentSeconds`, `created`, `started`

Exemplo:

${#each issue.worklogs as wl}
${wl.author.displayName}: ${wl.timeSpentSeconds | duration("hm")} em ${wl.started | date("yyyy-MM-dd")}
${/each}

Nível A — raízes para vários itens

Disponíveis em multi-issue, scheduled, sprint, release e backlog.

Caminho	Espécie	Campos do elemento
`issues`	coleção	toda a superfície do item, relativa à variável do laço
`issueGroups.fixVersions`	coleção	`key`, `title`, `issues`
`issueGroups.sprints`	coleção	`key`, `title`, `issues`
`issueGroups.assignees`	coleção	`key`, `title`, `issues`
`issueGroups.worklogAssignees`	coleção	`key`, `title`, `issues`

Exemplo — agrupar e, então, percorrer os itens de cada grupo:

${#each issueGroups.assignees as group}
## ${group.title}
${#each group.issues as it}
- ${it.key}: ${it.summary}
${/each}
${/each}

Nível A — raízes de contexto

Disponíveis apenas no próprio contexto.

`sprint`

Caminho	Tipo
`sprint.sprint.name`	cadeia
`sprint.sprint.goal`	cadeia
`sprint.sprint.state`	opção
`sprint.stats.issueCount`	número
`sprint.stats.percentDone`	número

`release`

Caminho	Tipo
`release.release.name`	cadeia
`release.release.releaseDate`	data
`release.release.released`	booleano
`release.stats.issueCount`	número
`release.stats.percentDone`	número

`backlog`

Caminho	Tipo / campos do elemento
`backlog.board.boardName`	cadeia
`backlog.board.boardType`	opção
`backlog.stats.totalIssueCount`	número
`backlog.groups`	coleção — `kind`, `name`, `issueCount`, `issues`

Nível A — metadados

Caminho	Tipo	Contextos
`generatedAt`	data e hora	todos

Nível B — log de alterações

Caminho	Espécie	Campos do elemento
`issue.changeHistory`	coleção	`author.displayName`, `created`, `items`

Nível C — visível mas não vinculável

Existem conceitualmente, mas não são resolvíveis; estão listados para que editor e validação reflitam o escopo com honestidade.

Recurso	Observação
`issue.jsm`	Superfície de solicitação, SLA e aprovações do Jira Service Management — adiada.
JQL no modelo	Detectado e diagnosticado pelo analisador de migração, nunca executado.
Tempo	Um espelho do Tempo pode existir em um registro de trabalho, mas não é vinculado.
Xray / Zephyr	Campos de gestão de testes exigem um aplicativo de terceiros.
Assets / Insight	Campos de objeto estão adiados.

Campos personalizados

Campos personalizados são vinculáveis sob um único namespace:

${ issue.customFields.<idDoCampo>.<…> }

IDs desconhecidos são flexíveis: o editor mostra um aviso e o valor pode ficar vazio, mas nunca bloqueia de forma rígida — assim, um modelo pode referenciar um campo que este site não possui sem falhar.
O caminho isolado issue.customFields (o mapa inteiro) nunca é vinculável.
Apenas caracteres de identificador seguros são permitidos; os segmentos __proto__, prototype e constructor são rejeitados.

Ressalvas ao migrar do Xporter

O analisador de migração sugere caminhos do Exportelier para nomes de campo comuns do Xporter. Duas coisas a saber para que uma sugestão realmente resolva:

A conversão automática corrige a sintaxe, não a existência de um caminho. A reescrita tem a forma certa, mas o destino ainda precisa ser uma vinculação real desta página; caso contrário, surge um aviso unknown-binding:
- Ausentes do catálogo: Creator → issue.creator, Resolution → issue.resolution, Project → issue.project, IssueType/Type → issue.issuetype.
- Diferença de maiúsculas: DueDate é sugerido como issue.duedate, mas a vinculação é issue.dueDate.
- Tipo incorreto: Labels é sugerido como escalar, mas issue.labels é uma coleção — use um laço.
Vínculos entre itens. O apelido Links é sugerido como links, mas a vinculação real é issue.issueLinks.

Veja Sintaxe do Xporter: o que funciona para o mapa completo de migração.

Caminhos nunca permitidos

Por segurança, alguns caminhos são rejeitados com um erro unsafe-template independentemente do contexto — campos internos, de credenciais ou que contenham URLs. Incluem raízes como auth, context, forge, internal, secrets, storage e token, além de qualquer caminho terminado em accountId, apiToken, avatarUrl, baseUrl, contentUrl, thumbnailUrl, cookie, session, headers, private ou storageRef. Atendo-se às vinculações desta página, você não esbarrará neles.

Como ler esta página​

Contextos de exportação e suas raízes​

Nível A — a superfície do item (issue.*)​

Escalares​

Coleções​

Nível A — raízes para vários itens​

Nível A — raízes de contexto​

sprint​

release​

backlog​

Nível A — metadados​

Nível B — log de alterações​

Nível C — visível mas não vinculável​

Campos personalizados​

Ressalvas ao migrar do Xporter​

Caminhos nunca permitidos​