Atualizar um problema do Jira

Atualiza um problema existente do Jira.

Para a configuração de autenticação, consulte as ações de issue do Jira.

Entrada	Tipo	Descrição	Exemplo
authToken	Corda	Obrigatório. String codificada em Base64 de `email:API_Token` para Autenticação Básica. Deve ser fornecido como um segredo. Consulte Criar e gerenciar tokens de API .	`"${{ :secrets:jiraAuthToken }}"`
domínio	Corda	Obrigatório. O domínio da sua instância do Jira Cloud (nome da empresa). Usado para construir a URL base `your-domain.atlassian.net` .	`"mycompany"`
issueKey	Corda	Obrigatório. A chave da issue do Jira a ser atualizada.	`"PROJ-123"`
parâmetro	Mapa	Opcional. Parâmetros de consulta de URL opcionais para a requisição da API do Jira. Consulte a tabela de referência de parâmetros abaixo.	`{"notifyUsers": "false", "returnIssue": "true", "expand": "changelog,renderedFields"}`
campos	Mapa	Opcional. Um mapa de campos da tela de problemas para atualizar, especificando o subcampo e seu valor. Use isto para atualizações simples de um único subcampo. Os campos incluídos aqui não podem ser incluídos também em `update` . Para obter todos os campos com valores permitidos, use `GET /rest/api/3/issue/{issueKey}/editmeta` .	`{"priority": {"name": "High"}, "labels": ["bug", "production"]}`
atualizar	Mapa	Opcional. Um mapa de nomes de campos e uma lista de operações a serem executadas no campo da tela de ocorrências. Use isto quando múltiplos subcampos ou outras operações forem necessários. Os campos incluídos aqui não podem ser incluídos também em `fields` .	`{"labels": [{"add": "critical"}, {"remove": "minor"}], "components": [{"set": [{"name": "Backend"}]}]}`
selectors	Lista	Opcional. Uma lista de expressões nomeadas para extrair valores específicos da resposta.	`[{"name": "summary", "expression": ".responseBody.result.summary"}]`

Referência de parâmetros

Parâmetro	Tipo	Descrição	Padrão
notifyUsers	Boleano	Se um e-mail de notificação sobre a atualização do problema é enviado a todos os observadores. Para desativar as notificações, são necessárias as permissões Administer Jira ou Administer project . Se o usuário não tiver a permissão necessária, isso será ignorado.	`true`
overrideScreenSecurity	Boleano	Se a segurança da tela é ignorada para permitir que campos ocultos sejam editados. Disponível para usuários dos aplicativos Connect e Forge com a permissão global Administer Jira .	`false`
overrideEditableFlag	Boleano	Se a segurança da tela é substituída para permitir que campos não editáveis sejam editados. Disponível para usuários dos aplicativos Connect e Forge com a permissão global Administer Jira .	`false`
returnIssue	Boleano	Se a resposta deve conter o problema com os campos editados nesta solicitação, formatados como na API Get issue.	`false`
expandir	Corda	O parâmetro expand da API Get issue a ser usado na resposta se `returnIssue` for `true` .

Saída	Tipo	Exemplo
response	Objeto	Uma atualização bem-sucedida retorna um corpo vazio com o status 204.
success	Boleano	`success: true \| false`
errorMessage	Corda	`{ "errorMessages": ["Can not update issue with invalid data"], "errors": { "summary": "Summary is required" } }`

Exemplo de fluxo de trabalho
name: update-jira-issues description: 'Updates a ticket summary and adds a new label' steps: - name: set_summary type: action action: jira.issue.update version: 1 inputs: authToken: ${{ :secrets:jiraAuthToken }} domain: mycompany issueKey: "PROJ-123" fields: summary: "Updated: Critical production error resolved" description: type: "doc" version: 1 content: - type: "paragraph" content: - type: "text" text: "Root cause identified and fix deployed to production" update: labels: - add: "resolved" - add: "production" parameters: returnIssue: "true" next: end

Exemplo de fluxo de trabalho

name: update-jira-issues
description: 'Updates a ticket summary and adds a new label'
steps:
  - name: set_summary
    type: action
    action: jira.issue.update
    version: 1
    inputs:
      authToken: ${{ :secrets:jiraAuthToken }}
      domain: mycompany
      issueKey: "PROJ-123"
      fields:
        summary: "Updated: Critical production error resolved"
        description:
          type: "doc"
          version: 1
          content:
            - type: "paragraph"
              content:
                - type: "text"
                  text: "Root cause identified and fix deployed to production"
      update:
        labels:
          - add: "resolved"
          - add: "production"
      parameters:
        returnIssue: "true"
    next: end

Esta tradução de máquina é fornecida para sua comodidade.

Referência de parâmetros