Buscar issues no Jira, por uma API
Busca issues com JQL. A consulta precisa ser delimitada, por exemplo project = KEY. Só o id da issue volta, a menos que fields liste o que incluir. Passe o nextPageToken da resposta para ler a próxima página.
- Identificador
- jira_search_issues
A chamada
POST https://connect.reportei.com/api/tools/jira_search_issues/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"jql": "<jql>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| jql | string | Sim | JQL query, for example project = KEY AND status = Done ORDER BY created DESC. |
| fields | string | Não | Comma-separated field names to return, for example summary,status,assignee. |
| maxResults | integer | Não | Issues per page. |
| nextPageToken | string | Não | The nextPageToken of the previous response. Omit it on the first page. |
Conexões possíveis
O seu cliente conecta a conta do Jira uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Usuário e senha
O cliente informa as credenciais do app numa tela do Connect, ou o seu sistema as envia por POST /api/customer-toolkits, sem tela.
Na conexão, o cliente informa também {site}: o endereço da conta dele na API do app.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/jira_search_issues. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Jira
- Obter issueGETRetorna uma issue pelo id ou pela chave, com todos os campos navegáveis, a menos que fields liste o que incluir.
- Criar issuePOSTCria uma issue. fields precisa ter ao menos project, issuetype e summary, e qualquer outro campo precisa existir na tela de criação do projeto, como mostra Listar campos de criação. Nesta versão da API, o campo description recebe um objeto Atlassian Document Format, não texto simples.
- Atualizar issuePUTEdita os campos de uma issue: fields define valores, e update aplica operações como adicionar ou remover um label. Um campo vai em fields ou em update, nunca nos dois. O status não muda aqui: use Fazer transição da issue. A resposta é vazia, status 204, a menos que returnIssue seja true.
- Excluir issueDELETEExclui uma issue. Uma issue com subtarefas só é excluída com deleteSubtasks definido como true, o que também exclui as subtarefas. Exige a permissão Delete issues no projeto. A resposta é vazia, status 204.
- Listar transiçõesGETLista as transições que o usuário pode fazer agora em uma issue, cada uma com o id que Fazer transição da issue recebe, seu name e o status para o qual leva em to.
- Fazer transição da issuePOSTMove uma issue para outro status executando uma de suas transições. Quando a transição tem uma tela, seus campos obrigatórios, como resolution, vão em fields ou update. A resposta é vazia, status 204.
- Listar comentáriosGETLista os comentários de uma issue, com o corpo em Atlassian Document Format. Pagine com startAt e maxResults até que startAt mais a quantidade retornada alcance total.
- Criar comentárioPOSTAdiciona um comentário a uma issue, visível para todos que podem ver a issue. O Jira notifica os observadores pelo esquema de notificação do projeto. Retorna o novo comentário.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
