Jira
Visão geral
Seção intitulada “Visão geral”Jira é a plataforma de rastreamento de bugs, issues e gestão de projetos ágeis da Atlassian, amplamente adotada por times de software para organizar backlogs, sprints e fluxos de trabalho com Scrum ou Kanban. Com a integração Jira no SquadOS, seus agentes podem criar e atualizar issues, transitar status de workflow, registrar worklogs, gerenciar sprints e muito mais — tudo sem sair da conversa.
- Site oficial: https://www.atlassian.com/software/jira
- Documentação na Composio: docs.composio.dev/toolkits/jira
Autenticação
Seção intitulada “Autenticação”Esta ferramenta suporta OAuth 2.0 (OAUTH2), OAuth 2.0 Server-to-Server (S2S_OAUTH2) e chave de API (API_KEY) para conectar.
O modo mais comum é o OAuth 2.0 via credenciais próprias configuradas no portal de desenvolvedor da Atlassian. Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
client_id | Sim | Client ID do aplicativo OAuth 2.0 criado no portal de desenvolvedor da Atlassian. |
client_secret | Sim | Client Secret correspondente ao aplicativo OAuth 2.0. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse o Atlassian Developer Portal e crie uma conta de desenvolvedor caso ainda não tenha.
- Clique em Create e selecione o tipo OAuth 2.0 Integration para criar um novo aplicativo.
- Na aba Authorization, clique em Configure e informe a Callback URL da Composio (exibida na tela de configuração de auth do Composio).
- Na aba Permissions, adicione a API do Jira e configure os escopos necessários nas seções User Identity API e Jira API.
- Na aba Settings, localize a seção Authentication Details e copie o Client ID e o Client Secret.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Jira. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso (OAuth) ou informa as credenciais obtidas acima.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Perguntas frequentes
Seção intitulada “Perguntas frequentes”Como configurar credenciais OAuth personalizadas para o Jira?
Seção intitulada “Como configurar credenciais OAuth personalizadas para o Jira?”Consulte o guia passo a passo em composio.dev/auth/jira para criar e configurar suas próprias credenciais OAuth no Jira com a Composio.
Qual a diferença entre JQL GET, JQL POST e Busca de Issues?
Seção intitulada “Qual a diferença entre JQL GET, JQL POST e Busca de Issues?”JQL GET e POST acessam a mesma funcionalidade de busca, mas usam métodos HTTP diferentes. POST suporta consultas complexas no corpo da requisição. A ação Busca de Issues usa JQL POST internamente com parâmetros e filtros extras. Para resultados consistentes, prefira POST para consultas complexas. Use o parâmetro fields para solicitar campos específicos, ou ["*all"] para todos os campos.
Ações disponíveis
Seção intitulada “Ações disponíveis”Criar issue
Seção intitulada “Criar issue”JIRA_CREATE_ISSUE
Cria uma nova issue no Jira (ex.: bug, tarefa, história) em um projeto especificado. Projetos diferentes podem ter campos obrigatórios personalizados além dos padrão (resumo, chave do projeto, tipo de issue). Se a criação falhar com “campo X é obrigatório”, use JIRA_GET_ISSUE_CREATE_METADATA para descobrir os campos disponíveis para o projeto. Campos customizados podem ser fornecidos via additional_properties como string JSON.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
summary | string | Sim | Título breve e descritivo da issue. |
project_key | string | Sim | Chave do projeto Jira onde a issue será criada (ex.: ‘KAN’, ‘DEV’, ‘PROJ’). |
issue_type | string | Sim | Tipo da issue — deve ser válido para o projeto alvo (ex.: ‘Task’, ‘Story’, ‘Epic’, ‘Bug’). |
description | string | Não | Descrição detalhada da issue. Aceita texto simples, Markdown ou Atlassian Document Format (ADF). |
assignee | string | Não | Account ID do usuário a quem atribuir a issue. Use JIRA_FIND_USERS para obter IDs válidos. |
assignee_name | string | Não | Nome ou e-mail do usuário a atribuir (ignorado se assignee for fornecido). |
priority | string | Não | Nível de prioridade (ex.: ‘High’, ‘Medium’, ‘Low’). Nomes são específicos por instância. |
labels | array | Não | Lista de labels para categorizar a issue; novas labels são criadas se não existirem. |
due_date | string | Não | Data de resolução esperada no formato YYYY-MM-DD. |
sprint_id | integer | Não | ID do sprint ao qual atribuir esta issue. |
components | array | Não | Lista de IDs de componentes (ex.: ‘10000’); os componentes devem existir no projeto. |
parent | string | Não | Chave ou ID da issue pai (ex.: ‘PROJ-123’). Use apenas para sub-tarefas. |
reporter | string | Não | Account ID do usuário que reporta a issue. Padrão: usuário da requisição. |
versions | array | Não | Lista de IDs de versões afetadas pela issue. |
fix_versions | array | Não | Lista de IDs de versões onde a issue será corrigida. |
additional_properties | string | Não | String JSON com campos adicionais, incluindo campos customizados (ex.: '{"customfield_10104": 5}'). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Editar issue
Seção intitulada “Editar issue”JIRA_EDIT_ISSUE
Atualiza uma issue Jira existente com novos valores de campos. Suporta parâmetros diretos (resumo, descrição, responsável, prioridade, etc.) que são mesclados com o parâmetro fields. Parâmetros diretos têm precedência. Nota: o campo status não pode ser atualizado por esta ação — use JIRA_TRANSITION_ISSUE para mudar o status.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issue_id_or_key | string | Sim | ID ou chave da issue Jira a editar. |
summary | string | Não | Novo título breve da issue. |
description | string | Não | Nova descrição. Suporta Markdown, convertido automaticamente para ADF. |
assignee | string | Não | Usuário a atribuir: account ID, e-mail ou nome. Forneça string vazia para remover o responsável. |
priority_id_or_name | string | Não | ID ou nome da prioridade (ex.: ‘High’, ‘Medium’). |
labels | array | Não | Lista de labels a definir para a issue (substitui as existentes). |
due_date | string | Não | Data de resolução no formato YYYY-MM-DD. Use null para remover. |
sprint_id_or_name | string | Não | ID ou nome do sprint ao qual atribuir esta issue. |
fields | string | Não | String JSON de campos para atualizações diretas. |
update | string | Não | String JSON para operações granulares em campos (ex.: adicionar/remover labels). |
notify_users | boolean | Não | Se verdadeiro, envia e-mail de notificação aos observadores. |
return_issue | boolean | Não | Se verdadeiro, a resposta inclui os detalhes completos da issue atualizada. |
additional_properties | object | Não | Propriedades adicionais a incluir no corpo da requisição. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter issue
Seção intitulada “Obter issue”JIRA_GET_ISSUE
Recupera uma issue Jira por ID ou chave com campos e expansões personalizáveis. Solicite apenas os campos e expansões necessários para evitar respostas grandes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issue_key | string | Sim | ID (ex.: ‘10000’) ou chave (ex.: ‘PROJ-123’) da issue a recuperar. |
fields | array | Não | Lista de nomes ou IDs de campos a retornar. Se omitido, retorna um conjunto padrão de campos. |
expand | string | Não | Lista separada por vírgulas de entidades a incluir (ex.: ‘changelog’, ‘renderedFields’, ‘transitions’). |
properties | array | Não | Lista de chaves de propriedades da issue a incluir na resposta. |
fields_by_keys | boolean | Não | Se verdadeiro, os valores em fields são interpretados como chaves de campo. |
update_history | boolean | Não | Controla se a visualização da issue a adiciona à lista “Visualizados recentemente” do usuário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir issue
Seção intitulada “Excluir issue”JIRA_DELETE_ISSUE
Exclui permanente e irreversivelmente uma issue Jira por seu ID ou chave. Obtenha confirmação explícita do usuário antes de chamar esta ação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issue_id_or_key | string | Sim | ID ou chave da issue a excluir. |
delete_subtasks | boolean | Não | Se verdadeiro, as sub-tarefas da issue também são excluídas. Se falso e a issue tiver sub-tarefas, a exclusão falhará. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atribuir issue
Seção intitulada “Atribuir issue”JIRA_ASSIGN_ISSUE
Atribui uma issue Jira a um usuário, ao responsável padrão do projeto, ou remove o responsável. Suporta busca por e-mail ou nome.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issue_id_or_key | string | Sim | ID ou chave da issue a atribuir. |
account_id | string | Não | Account ID Atlassian do usuário. Use '-1' para atribuir ao responsável padrão do projeto, ou omita para desatribuir. |
assignee_name | string | Não | Nome ou e-mail do usuário a atribuir (ignorado se account_id for fornecido). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar comentário
Seção intitulada “Adicionar comentário”JIRA_ADD_COMMENT
Adiciona um comentário usando Atlassian Document Format (ADF) para texto rico a uma issue Jira existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issue_id_or_key | string | Sim | ID ou chave da issue à qual adicionar o comentário. |
comment | string | Sim | Texto do comentário. Suporta Markdown incluindo negrito, itálico, código, links e @menções. |
visibility_type | string | Não | Tipo de restrição de visibilidade: 'group' ou 'role'. |
visibility_value | string | Não | Nome do grupo ou papel que pode ver o comentário (obrigatório se visibility_type for definido). |
additional_properties | object | Não | Propriedades adicionais a incluir no corpo da requisição do comentário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar comentários da issue
Seção intitulada “Listar comentários da issue”JIRA_LIST_ISSUE_COMMENTS
Recupera comentários paginados de uma issue Jira com ordenação opcional. Pagine incrementando start_at por max_results até que a contagem acumulada alcance o campo total na resposta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issue_id_or_key | string | Sim | ID (ex.: ‘10000’) ou chave (ex.: ‘PROJ-123’) da issue Jira. |
start_at | integer | Não | Índice baseado em 0 do primeiro comentário a retornar. |
max_results | integer | Não | Número máximo de comentários a retornar por página (máximo ~100 no Jira Cloud). |
order_by | string | Não | Campo para ordenar comentários; use 'created' para ordem crescente por data de criação. |
expand | string | Não | Use 'renderedBody' para incluir a versão HTML renderizada do corpo do comentário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar comentário
Seção intitulada “Atualizar comentário”JIRA_UPDATE_COMMENT
Atualiza o texto ou a visibilidade de um comentário existente em uma issue Jira.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issue_id_or_key | string | Sim | ID ou chave da issue Jira onde o comentário está localizado. |
comment_id | string | Sim | ID único do comentário a atualizar. |
comment_text | string | Sim | Novo conteúdo de texto para o comentário. Substitui o corpo existente. Suporta texto simples e formatação básica. |
notify_users | boolean | Não | Se verdadeiro, envia notificações aos usuários sobre a atualização do comentário. |
visibility_type | string | Não | Tipo de restrição de visibilidade: 'group' ou 'role'. |
visibility_value | string | Não | Nome do grupo ou papel a restringir a visibilidade. |
additional_properties | string | Não | String JSON de propriedades do comentário como pares chave-valor. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir comentário
Seção intitulada “Excluir comentário”JIRA_DELETE_COMMENT
Exclui um comentário específico de uma issue Jira usando seu ID e o ID/chave da issue. Requer permissão do usuário para excluir comentários na issue.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issueIdOrKey | string | Sim | ID (ex.: ‘10000’) ou chave (ex.: ‘PROJ-123’) da issue Jira da qual o comentário será excluído. |
id | string | Sim | Identificador único do comentário a excluir (ex.: ‘10001’). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Buscar issues
Seção intitulada “Buscar issues”JIRA_SEARCH_ISSUES
Busca avançada de issues Jira com suporte a filtros estruturados e JQL bruto. Pelo menos um parâmetro de filtro é obrigatório; chamadas sem parâmetros serão rejeitadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
jql | string | Não | Consulta JQL bruta para usuários avançados. Tem precedência sobre os filtros. |
project_key | string | Não | Filtrar por chave de projeto (ex.: ‘PROJ’). |
assignee | string | Não | Filtrar por responsável: account ID, e-mail, nome de exibição ou 'unassigned'. |
status_id_or_name | string | Não | Filtrar por status: ID (ex.: ‘10001’) ou nome (ex.: ‘To Do’, ‘In Progress’, ‘Done’). |
issue_type_id_or_name | string | Não | Filtrar por tipo de issue: ID (ex.: ‘10001’) ou nome (ex.: ‘Bug’, ‘Task’, ‘Story’). |
priority_id_or_name | string | Não | Filtrar por prioridade: ID ou nome (ex.: ‘High’, ‘Medium’, ‘Low’). |
sprint_id_or_name | string | Não | Filtrar por sprint: ID (ex.: ‘123’) ou nome (ex.: ‘Sprint 1’). |
labels | array | Não | Filtrar por labels (todas as labels devem corresponder). |
text_search | string | Não | Pesquisar no resumo e na descrição. |
created_after | string | Não | Filtrar issues criadas após esta data. Formato YYYY-MM-DD ou datas relativas como '-7d'. |
updated_after | string | Não | Filtrar issues atualizadas após esta data. |
created_before | string | Não | Filtrar issues criadas antes desta data (formato YYYY-MM-DD). |
updated_before | string | Não | Filtrar issues atualizadas antes desta data. |
fields | array | Não | Lista de campos a retornar para cada issue. |
max_results | integer | Não | Número máximo de issues a retornar por página (máximo 100). |
next_page_token | string | Não | Token de cursor para buscar a próxima página. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar projeto
Seção intitulada “Criar projeto”JIRA_CREATE_PROJECT
Cria um novo projeto Jira com configuração de responsável (lead), template e tipo.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
key | string | Sim | Chave única para o projeto (somente letras maiúsculas, sem espaços). |
name | string | Sim | Nome legível para o projeto. |
lead_account_id | string | Sim | Account ID Atlassian do responsável pelo projeto. |
project_type_key | string | Sim | Tipo do projeto: 'business', 'software' ou 'service_desk'. |
project_template_key | string | Sim | Chave do template do projeto, compatível com project_type_key. |
description | string | Não | Descrição textual opcional do projeto. |
assignee_type | string | Não | Responsável padrão para novas issues: 'PROJECT_LEAD' ou 'UNASSIGNED'. |
url | string | Não | URL opcional para o projeto. |
avatar_id | integer | Não | ID de um avatar existente para o projeto. |
category_id | integer | Não | ID de uma categoria de projeto existente. |
permission_scheme | integer | Não | ID de um esquema de permissões existente. |
notification_scheme | integer | Não | ID de um esquema de notificações existente. |
issue_security_scheme | integer | Não | ID de um esquema de segurança de issues existente. |
additional_properties | object | Não | Propriedades adicionais para a requisição de criação do projeto. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter projeto
Seção intitulada “Obter projeto”JIRA_GET_PROJECT
Recupera os detalhes de um projeto Jira pelo seu ID ou chave.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
project_id_or_key | string | Sim | ID numérico ou chave do projeto (ex.: ‘PROJ’). |
expand | string | Não | Informações adicionais a incluir: description, issueTypes, lead, projectKeys, issueTypeHierarchy. |
properties | string | Não | Lista separada por vírgulas de propriedades do projeto a retornar (máximo 100 chaves). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os projetos
Seção intitulada “Listar todos os projetos”JIRA_LIST_ALL_PROJECTS
Lista todos os projetos acessíveis ao usuário. Use quando precisar de uma lista abrangente de todos os projetos Jira.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
expand | string | Não | Informações adicionais na resposta: description, issueTypes, lead, projectKeys. |
recent | integer | Não | Retorna os projetos acessados mais recentemente pelo usuário (máximo 20). |
properties | array | Não | Lista de propriedades de projeto a retornar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar sprint
Seção intitulada “Criar sprint”JIRA_CREATE_SPRINT
Cria um novo sprint em um board Jira com datas de início/fim e objetivo opcionais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
origin_board_id | integer | Sim | Identificador do board Jira para o novo sprint. Use JIRA_LIST_BOARDS para encontrar IDs de boards. |
name | string | Sim | Nome para o novo sprint (máximo 30 caracteres). |
goal | string | Não | Objetivo principal ou meta para o sprint. |
start_date | string | Não | Data e hora de início pretendida para o sprint (formato ISO 8601). |
end_date | string | Não | Data e hora de término pretendida para o sprint (formato ISO 8601). |
additional_properties | object | Não | Propriedades adicionais para a requisição de criação do sprint. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar sprints
Seção intitulada “Listar sprints”JIRA_LIST_SPRINTS
Recupera sprints paginados de um board Jira com filtragem opcional por estado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
board_id | integer | Sim | Identificador único do board Jira. Deve ser um board Scrum; boards Kanban não suportam sprints. |
state | string | Não | Filtra sprints por estado. Aceita valor único ('active') ou valores separados por vírgula ('active,closed'). Valores válidos: 'future', 'active', 'closed'. |
start_at | integer | Não | Índice inicial baseado em 0 para paginação. |
max_results | integer | Não | Número máximo de sprints por página. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Mover issues para sprint
Seção intitulada “Mover issues para sprint”JIRA_MOVE_ISSUE_TO_SPRINT
Move uma ou mais issues Jira para um sprint ativo especificado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
sprint_id | integer | Sim | Identificador único do sprint alvo. Deve pertencer ao mesmo board/projeto das issues. |
issues | array | Sim | Lista de chaves de issues (ex.: ‘PROJ-123’) a mover para o sprint especificado. |
rank_after_issue | string | Não | Chave ou ID da issue após a qual posicionar as issues movidas no backlog do sprint. |
rank_before_issue | string | Não | Chave ou ID da issue antes da qual posicionar as issues movidas. |
rank_custom_field_id | integer | Não | ID do campo customizado de ranqueamento a usar para ordenação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Transitar issue
Seção intitulada “Transitar issue”JIRA_TRANSITION_ISSUE
Transita uma issue Jira para um estado diferente do workflow, com suporte a busca por nome de transição e atribuição de usuário por e-mail. Use JIRA_GET_TRANSITIONS para verificar as transições disponíveis antes de chamar esta ação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issue_id_or_key | string | Sim | ID ou chave da issue a transitar. |
transition_id_or_name | string | Sim | ID ou nome da transição a aplicar. Nomes são específicos do workflow — use JIRA_GET_TRANSITIONS para obter os valores válidos para a issue atual. |
comment | string | Não | Comentário opcional a adicionar durante a transição. Suporta formatação Markdown. |
assignee | string | Não | Account ID do usuário a atribuir durante a transição. |
assignee_name | string | Não | Nome ou e-mail do usuário a atribuir (ignorado se assignee for fornecido). |
resolution | string | Não | Resolução a definir ao FECHAR uma issue (ex.: ‘Done’, ‘Fixed’, ‘Won’t Do’). Só use ao transitar para status final. |
transition_fields | object | Não | Campos a incluir no payload da transição (ex.: campos obrigatórios pela tela de transição do workflow). |
additional_properties | object | Não | Propriedades adicionais a incluir no nível superior do corpo da requisição de transição. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter transições
Seção intitulada “Obter transições”JIRA_GET_TRANSITIONS
Recupera as transições de workflow disponíveis para uma issue Jira. Use sempre o id numérico da resposta ao chamar JIRA_TRANSITION_ISSUE — IDs de transição são específicos por projeto/workflow.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issue_id_or_key | string | Sim | ID (ex.: ‘10000’) ou chave (ex.: ‘PROJ-123’) da issue Jira. |
expand | string | Não | Use 'transitions.fields' para incluir os campos associados a cada transição. |
transition_id | string | Não | ID de uma transição específica a recuperar. |
include_unavailable_transitions | boolean | Não | Se verdadeiro, inclui transições não disponíveis atualmente para a issue. |
sort_by_ops_bar_and_status | boolean | Não | Se verdadeiro, ordena as transições pela barra de operações e depois por categoria de status. |
skip_remote_only_condition | boolean | Não | Se verdadeiro, ignora condições definidas por apps remotos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar worklog
Seção intitulada “Adicionar worklog”JIRA_ADD_WORKLOG
Adiciona uma entrada de worklog a uma issue Jira. Use para registrar o tempo gasto em uma issue.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issue_id_or_key | string | Sim | ID ou chave da issue Jira à qual adicionar o worklog. |
time_spent | string | Não | Tempo gasto como string de duração Jira (ex.: ‘2h 30m’, ‘1d’, ‘45m’). Forneça este ou time_spent_seconds. |
time_spent_seconds | integer | Não | Tempo em segundos gasto na issue. Forneça este ou time_spent. |
started | string | Não | Data e hora de início do trabalho no formato ISO 8601. Se não fornecido, usa o horário atual. |
comment | object | Não | Estrutura de comentário no Atlassian Document Format. |
adjust_estimate | string | Não | Opções para ajustar a estimativa restante: 'new', 'leave', 'manual' ou 'auto'. |
new_estimate | string | Não | Nova estimativa restante se adjust_estimate for 'new' (ex.: ‘2h’). |
reduce_by | string | Não | Valor a reduzir da estimativa restante se adjust_estimate for 'manual'. |
notify_users | boolean | Não | Se deve notificar usuários que observam a issue sobre este worklog. |
visibility | object | Não | Detalhes sobre a restrição de visibilidade do worklog. |
expand | string | Não | Use 'properties' para incluir campos customizados associados aos worklogs. |
override_editable_flag | boolean | Não | Se deve adicionar o worklog mesmo que a issue não seja editável. Requer permissões de admin. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter worklogs
Seção intitulada “Obter worklogs”JIRA_GET_WORKLOG
Recupera os worklogs de uma issue Jira especificada.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issue_id_or_key | string | Sim | ID (ex.: ‘10001’) ou chave (ex.: ‘PROJECT-123’) da issue Jira. |
start_at | integer | Não | Índice baseado em 0 do primeiro worklog a retornar, para paginação. |
max_results | integer | Não | Número máximo de worklogs a retornar por página. |
started_after | integer | Não | Filtra worklogs iniciados em ou após esta data. Forneça como timestamp Unix em milissegundos. |
started_before | integer | Não | Filtra worklogs iniciados em ou antes desta data. Forneça como timestamp Unix em milissegundos. |
expand | string | Não | Use 'properties' para incluir campos customizados associados aos worklogs. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar versão
Seção intitulada “Criar versão”JIRA_CREATE_VERSION
Cria uma nova versão para releases ou marcos em um projeto Jira.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome para a nova versão. Recomenda-se que os nomes sejam únicos dentro de um projeto. |
projectId | integer | Sim | ID numérico do projeto Jira ao qual esta versão será adicionada. |
description | string | Não | Descrição textual da versão. |
startDate | string | Não | Data de início do trabalho na versão (formato YYYY-MM-DD). |
releaseDate | string | Não | Data de lançamento da versão (formato YYYY-MM-DD). |
released | boolean | Não | Indica se a versão está marcada como lançada. |
archived | boolean | Não | Indica se a versão está marcada como arquivada. |
additional_properties | object | Não | Propriedades adicionais para a requisição de criação da versão. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar issues em lote
Seção intitulada “Criar issues em lote”JIRA_BULK_CREATE_ISSUE
Cria múltiplas issues Jira (até 50 por chamada) com suporte completo a Markdown, resolução de responsável e tratamento de prioridade.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issues | array | Sim | Lista de issues a criar (1 a 50 por requisição). Cada definição de issue segue a mesma estrutura da ação de criação única. Para sub-tarefas, inclua parent_key para especificar a issue pai. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Buscar issues em lote
Seção intitulada “Buscar issues em lote”JIRA_FETCH_BULK_ISSUES
Busca múltiplas issues Jira por seus IDs ou chaves em uma única requisição (máximo 100 por chamada).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
issueIdsOrKeys | array | Sim | Array de IDs ou chaves de issues a buscar. Mínimo 1, máximo 100 por requisição. |
fields | array | Não | Lista de campos a retornar para cada issue. Use '*all' para todos os campos ou prefixe com - para excluir (ex.: '-description'). |
expand | array | Não | Lista de opções de expansão (ex.: 'renderedFields', 'changelog'). |
properties | array | Não | Lista de chaves de propriedades da issue a incluir (máximo 5). |
fieldsByKeys | boolean | Não | Se verdadeiro, referencia campos por chave em vez de ID. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Vincular issues
Seção intitulada “Vincular issues”JIRA_CREATE_ISSUE_LINK
Vincula duas issues Jira usando um tipo de vínculo especificado com comentário opcional.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
link_type | string | Sim | Nome do tipo de vínculo a criar (ex.: ‘Blocks’, ‘Relates’, ‘Duplicate’, ‘Cloners’). Use JIRA_GET_ISSUE_LINK_TYPES para recuperar nomes válidos. |
inward_issue_key | string | Sim | Chave da issue que inicia o relacionamento de vínculo (a issue “origem”). |
outward_issue_key | string | Sim | Chave da issue que é o alvo do relacionamento de vínculo (a issue “destino”). |
comment | string | Não | Comentário textual opcional a adicionar ao vínculo criado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter usuário atual
Seção intitulada “Obter usuário atual”JIRA_GET_CURRENT_USER
Recupera informações detalhadas sobre o usuário Jira atualmente autenticado. O accountId retornado é o identificador correto para campos como lead_account_id em JIRA_CREATE_PROJECT e ações de observador.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
expand | string | Não | Lista separada por vírgulas de propriedades do usuário a expandir, ex.: 'groups', 'applicationRoles'. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter status das issues
Seção intitulada “Obter status das issues”JIRA_GET_ALL_STATUSES
Recupera todos os status de issues associados a workflows no Jira. Retorna status globais que podem não ser válidos para todos os projetos ou esquemas de workflow; verifique se o status retornado é aplicável ao projeto específico antes de usá-lo.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |