Listar projetos no Jira, por uma API

Lista os projetos que o usuário pode ver, com a key e o id que as ferramentas de issue e o JQL recebem. Pagine com startAt e maxResults até que isLast seja true.

Identificador
jira_list_projects

A chamada

POST https://connect.reportei.com/api/tools/jira_list_projects/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "query": "<query>"
  }
}

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âmetroTipoObrigatórioDescrição
querystringNãoText matched against the project key and name, case insensitive.
actionstringNãoOnly projects where the user can do this. create lists where they can create issues. The default is view.Valores: view, browse, edit, create
orderBystringNãoSort field; a leading minus reverses it. The default is key.Valores: key, -key, name, -name, lastIssueUpdatedDate, -lastIssueUpdatedDate
startAtintegerNãoIndex of the first project to return. The default is 0.
maxResultsintegerNãoProjects per page, up to 100. The default is 50.

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_list_projects. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Jira

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.