Mettre à jour un ticket Jira

Mettre à jour un ticket Jira existant.

Pour la configuration de l’authentification, consultez les actions de ticket Jira.

Saisir	Type	Description	Exemple
authToken	Chaîne	Obligatoire. Chaîne de `email:API_Token` encodée en Base64 pour l’authentification Basic. Doit être fourni en tant que secret. Voir Créer et gérer les jetons d’API .	`"${{ :secrets:jiraAuthToken }}"`
domain	Chaîne	Obligatoire. Le domaine de votre instance Jira Cloud (nom de l'entreprise). Utilisé pour construire l'URL de base `your-domain.atlassian.net` .	`"mycompany"`
issueKey	Chaîne	Obligatoire. La clé du ticket Jira à mettre à jour.	`"PROJ-123"`
paramètres	Carte	Facultatif. Paramètres de requête d'URL facultatifs pour la requête d'API Jira. Consultez le tableau de référence des paramètres ci-dessous.	`{"notifyUsers": "false", "returnIssue": "true", "expand": "changelog,renderedFields"}`
champs	Carte	Facultatif. Une map des champs de l’écran du ticket à mettre à jour, spécifiant le sous-champ et sa valeur. Utilisez ceci pour les mises à jour simples d’un seul sous-champ. Les champs inclus ici ne peuvent pas être également inclus dans `update` . Pour obtenir tous les champs avec les valeurs autorisées, utilisez `GET /rest/api/3/issue/{issueKey}/editmeta` .	`{"priority": {"name": "High"}, "labels": ["bug", "production"]}`
mise à jour	Carte	Facultatif. Un mappage des noms de champs et une liste d'opérations à effectuer sur le champ de l'écran du ticket. Utilisez ceci lorsque plusieurs sous-champs ou d’autres opérations sont nécessaires. Les champs inclus ici ne peuvent pas être également inclus dans `fields` .	`{"labels": [{"add": "critical"}, {"remove": "minor"}], "components": [{"set": [{"name": "Backend"}]}]}`
selectors	List	Facultatif. Une liste d'expressions nommées pour extraire des valeurs spécifiques de la réponse.	`[{"name": "summary", "expression": ".responseBody.result.summary"}]`

Référence des paramètres

paramètres	Type	Description	Défaut
notifyUsers	Booléen	Indique si un e-mail de notification concernant la mise à jour du ticket est envoyé à tous les observateurs. Pour désactiver les notifications, les autorisations Administer Jira ou Administer project sont requises. Si l’utilisateur ne dispose pas de l’autorisation nécessaire, cela est ignoré.	`true`
overrideScreenSecurity	Booléen	Indique si la sécurité de l'écran est outrepassée pour permettre la modification des champs masqués. Disponible pour les utilisateurs des applications Connect et Forge disposant de l'autorisation globale Administrer Jira .	`false`
overrideEditableFlag	Booléen	Si la sécurité de l'écran est contournée pour permettre la modification des champs non modifiables. Disponible pour les utilisateurs des applications Connect et Forge disposant de l'autorisation globale Administrer Jira .	`false`
returnIssue	Booléen	Si la réponse doit contenir le ticket avec les champs modifiés dans cette requête, formaté comme dans l'API Get issue.	`false`
développer	Chaîne	Le paramètre expand de l’API Get issue à utiliser dans la réponse si `returnIssue` est `true` .

Sortir	Type	Exemple
response	Objet	Une mise à jour réussie renvoie un corps vide avec le statut 204.
success	Booléen	`success: true \| false`
errorMessage	Chaîne	`{ "errorMessages": ["Can not update issue with invalid data"], "errors": { "summary": "Summary is required" } }`

Exemple de workflow
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

Exemple de workflow

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

Cette traduction automatique est fournie pour votre commodité.

Référence des paramètres