Projetos
Projetos e sua estrutura: waves (ciclos), épicos, tarefas e membros da equipe. Todos exigem o recurso Projetos no plano.
Projetos
Projetos podem ser listados, consultados e criados. Não há rota de atualização.
Recurso do plano: Projetos.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/projects | Lista com paginação |
GET | /external/v1/projects/:id | Busca um registro pelo ID |
POST | /external/v1/projects | Cria um registro |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
curl -G "https://erp-api.ideros.api.br/external/v1/projects" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25"
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/projects/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Criar
Responde 201 com o registro criado.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
businessUnitId | string | Não | ID de unidade de negócio. Se omitido e a feature FK_BSN_UNT estiver ativa, será resolvido automaticamente. |
responsibleId | string | Sim | ID de usuário da empresa. |
title | string | Sim | Título do projeto. |
description | string | Não | Descrição detalhada do projeto. |
fileUrl | string | Não | URL do arquivo vinculado ao projeto. |
metadata | object | Não | Objeto JSON livre. |
taskCodePrefix | string | Não | Sigla das tarefas do projeto. Forma o código de cada tarefa no padrão SIGLA-N (ex.: RDS → RDS-1, RDS-2). Se omitida, é derivada automaticamente do título. Normalizada para maiúsculas e única por empresa. |
hasWaves | boolean | Não | Indica se o projeto utiliza Waves (agrupamento de sprints/fases). |
hasEpics | boolean | Não | Indica se o projeto utiliza Epics (agrupamento de funcionalidades). |
addCreatorAsMember | boolean | Não | Indica se o usuário que está criando o projeto deseja ser incluído como membro OWNER da equipe. Se não informado, o criador não será adicionado automaticamente. |
curl -X POST "https://erp-api.ideros.api.br/external/v1/projects" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Implantação — Tech Solutions",
"responsibleId": "ID_DO_USUARIO"
}'
Waves
Recurso do plano: Projetos.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/project-waves | Lista com paginação |
GET | /external/v1/project-waves/:id | Busca um registro pelo ID |
POST | /external/v1/project-waves | Cria um registro |
PUT | /external/v1/project-waves/:id | Atualiza um registro |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
Exemplo com filtro (o valor de relations vai codificado para URL; aqui ele aparece legível: {"where":{"projectId":"ID_DO_PROJETO"}}):
curl -G "https://erp-api.ideros.api.br/external/v1/project-waves" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25" \
--data-urlencode 'relations={"where":{"projectId":"ID_DO_PROJETO"}}'
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/project-waves/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Criar
Responde 201 com o registro criado.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
projectId | string | Sim | ID de projeto. |
title | string | Sim | Título da wave. |
description | string | Não | Descrição detalhada da wave. |
startDate | string (data ISO 8601) | Não | Data de início da wave. |
endDate | string (data ISO 8601) | Não | Data de término da wave. |
metadata | object | Não | Objeto JSON livre. |
Atualizar
Envie no corpo só os campos que mudam, com os mesmos nomes da tabela de criação. Responde 200 com o registro atualizado. Registro de outra empresa responde 403; registro inexistente, 404.
Épicos
Recurso do plano: Projetos.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/project-epics | Lista com paginação |
GET | /external/v1/project-epics/:id | Busca um registro pelo ID |
POST | /external/v1/project-epics | Cria um registro |
PUT | /external/v1/project-epics/:id | Atualiza um registro |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
Exemplo com filtro (o valor de relations vai codificado para URL; aqui ele aparece legível: {"where":{"projectId":"ID_DO_PROJETO"}}):
curl -G "https://erp-api.ideros.api.br/external/v1/project-epics" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25" \
--data-urlencode 'relations={"where":{"projectId":"ID_DO_PROJETO"}}'
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/project-epics/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Criar
Responde 201 com o registro criado.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
projectId | string | Sim | ID de projeto. |
waveId | string | Não | ID de wave. |
title | string | Sim | Título do épico. |
description | string | Não | Descrição detalhada do épico. |
metadata | object | Não | Objeto JSON livre. |
Atualizar
Envie no corpo só os campos que mudam, com os mesmos nomes da tabela de criação. Responde 200 com o registro atualizado. Registro de outra empresa responde 403; registro inexistente, 404.
Tarefas
Tarefas podem ser listadas, consultadas e criadas. Não há rota de atualização.
Recurso do plano: Projetos.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/project-tasks | Lista com paginação |
GET | /external/v1/project-tasks/:id | Busca um registro pelo ID |
POST | /external/v1/project-tasks | Cria um registro |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
Exemplo com filtro (o valor de relations vai codificado para URL; aqui ele aparece legível: {"where":{"projectId":"ID_DO_PROJETO"}}):
curl -G "https://erp-api.ideros.api.br/external/v1/project-tasks" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25" \
--data-urlencode 'relations={"where":{"projectId":"ID_DO_PROJETO"}}'
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/project-tasks/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Criar
Responde 201 com o registro criado.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
projectId | string | Sim | ID de projeto. |
stepColumnId | string | Não | ID de coluna do quadro do projeto. Se não informado, a tarefa será atribuída à primeira coluna do projeto. |
reporterId | string | Sim | ID de usuário da empresa. |
assigneeId | string | Não | ID de usuário da empresa. |
waveId | string | Não | ID de wave. |
epicId | string | Não | ID de épico. |
parentTaskId | string | Não | ID da tarefa pai (hierarquia) |
estimatedDays | number | Não | Duração estimada em dias |
actualDays | number | Não | Duração real em dias |
effort | number | Não | Esforço em horas/homem |
percentComplete | number | Não | Progresso da tarefa (0-100) |
status | enum | Não | Status da tarefa Valores: NOT_STARTED, IN_PROGRESS, BLOCKED, ON_HOLD, COMPLETED, CANCELLED. |
isMilestone | boolean | Não | Indica se é um marco importante |
baselineStartDate | string (data ISO 8601) | Não | Data de início planejada (baseline) |
baselineDueDate | string (data ISO 8601) | Não | Data de término planejada (baseline) |
wbs | string | Não | Work Breakdown Structure |
title | string | Sim | Título da tarefa. |
description | string | Não | Descrição detalhada da tarefa. |
tags | string[] | Não | Lista de tags associadas à tarefa. |
fileUrl | string | Não | URL de um arquivo anexado à tarefa. |
priority | enum | Sim | Prioridade da tarefa. Valores: INDEFINITE, LOW, MEDIUM, HIGH, URGENT. |
startDate | string (data ISO 8601) | Não | Data de início real da tarefa. |
dueDate | string (data ISO 8601) | Não | Data limite para conclusão da tarefa. |
deadlineDate | string (data ISO 8601) | Não | Data de deadline crítica da tarefa. |
actualEndDate | string (data ISO 8601) | Não | Data de término real da tarefa. |
order | number | Não | Ordenação da tarefa dentro da coluna. Se não informado, será calculado automaticamente. |
metadata | object | Não | Objeto JSON livre. |
isExternallyVisible | boolean | Não | Define se a tarefa é visível externamente. |
isEditableByEveryone | boolean | Não | Permite que qualquer membro do projeto edite a tarefa, mesmo não sendo o relator. Apenas o relator pode alterar este campo. |
Equipe do projeto
O POST inclui um membro ou, se a pessoa já for da equipe, muda o papel dela. Só o dono do projeto (ou Proprietário/Administrador da empresa) define outro dono.
Recurso do plano: Projetos.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/project-team-members | Lista com paginação |
GET | /external/v1/project-team-members/:id | Busca um registro pelo ID |
POST | /external/v1/project-team-members | Cria um registro |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
Exemplo com filtro (o valor de relations vai codificado para URL; aqui ele aparece legível: {"where":{"projectId":"ID_DO_PROJETO"}}):
curl -G "https://erp-api.ideros.api.br/external/v1/project-team-members" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25" \
--data-urlencode 'relations={"where":{"projectId":"ID_DO_PROJETO"}}'
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/project-team-members/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Criar
Responde 201 com o registro criado.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
projectId | string | Sim | ID de projeto. |
companyUserId | string | Sim | ID de usuário da empresa. |
role | enum | Não | Papel do membro no projeto. Se não informado, assume MEMBER. Valores: OWNER, MANAGER, MEMBER, VIEWER. |
A nossa equipe ajuda você a configurar e usar esse recurso.