Pular para o conteúdo principal

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étodoRotaO que faz
GET/external/v1/projectsLista com paginação
GET/external/v1/projects/:idBusca um registro pelo ID
POST/external/v1/projectsCria 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.

CampoTipoObrigatórioDescrição
businessUnitIdstringNãoID de unidade de negócio. Se omitido e a feature FK_BSN_UNT estiver ativa, será resolvido automaticamente.
responsibleIdstringSimID de usuário da empresa.
titlestringSimTítulo do projeto.
descriptionstringNãoDescrição detalhada do projeto.
fileUrlstringNãoURL do arquivo vinculado ao projeto.
metadataobjectNãoObjeto JSON livre.
taskCodePrefixstringNãoSigla 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.
hasWavesbooleanNãoIndica se o projeto utiliza Waves (agrupamento de sprints/fases).
hasEpicsbooleanNãoIndica se o projeto utiliza Epics (agrupamento de funcionalidades).
addCreatorAsMemberbooleanNãoIndica 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étodoRotaO que faz
GET/external/v1/project-wavesLista com paginação
GET/external/v1/project-waves/:idBusca um registro pelo ID
POST/external/v1/project-wavesCria um registro
PUT/external/v1/project-waves/:idAtualiza 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.

CampoTipoObrigatórioDescrição
projectIdstringSimID de projeto.
titlestringSimTítulo da wave.
descriptionstringNãoDescrição detalhada da wave.
startDatestring (data ISO 8601)NãoData de início da wave.
endDatestring (data ISO 8601)NãoData de término da wave.
metadataobjectNãoObjeto 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étodoRotaO que faz
GET/external/v1/project-epicsLista com paginação
GET/external/v1/project-epics/:idBusca um registro pelo ID
POST/external/v1/project-epicsCria um registro
PUT/external/v1/project-epics/:idAtualiza 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.

CampoTipoObrigatórioDescrição
projectIdstringSimID de projeto.
waveIdstringNãoID de wave.
titlestringSimTítulo do épico.
descriptionstringNãoDescrição detalhada do épico.
metadataobjectNãoObjeto 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étodoRotaO que faz
GET/external/v1/project-tasksLista com paginação
GET/external/v1/project-tasks/:idBusca um registro pelo ID
POST/external/v1/project-tasksCria 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.

CampoTipoObrigatórioDescrição
projectIdstringSimID de projeto.
stepColumnIdstringNãoID de coluna do quadro do projeto. Se não informado, a tarefa será atribuída à primeira coluna do projeto.
reporterIdstringSimID de usuário da empresa.
assigneeIdstringNãoID de usuário da empresa.
waveIdstringNãoID de wave.
epicIdstringNãoID de épico.
parentTaskIdstringNãoID da tarefa pai (hierarquia)
estimatedDaysnumberNãoDuração estimada em dias
actualDaysnumberNãoDuração real em dias
effortnumberNãoEsforço em horas/homem
percentCompletenumberNãoProgresso da tarefa (0-100)
statusenumNãoStatus da tarefa Valores: NOT_STARTED, IN_PROGRESS, BLOCKED, ON_HOLD, COMPLETED, CANCELLED.
isMilestonebooleanNãoIndica se é um marco importante
baselineStartDatestring (data ISO 8601)NãoData de início planejada (baseline)
baselineDueDatestring (data ISO 8601)NãoData de término planejada (baseline)
wbsstringNãoWork Breakdown Structure
titlestringSimTítulo da tarefa.
descriptionstringNãoDescrição detalhada da tarefa.
tagsstring[]NãoLista de tags associadas à tarefa.
fileUrlstringNãoURL de um arquivo anexado à tarefa.
priorityenumSimPrioridade da tarefa. Valores: INDEFINITE, LOW, MEDIUM, HIGH, URGENT.
startDatestring (data ISO 8601)NãoData de início real da tarefa.
dueDatestring (data ISO 8601)NãoData limite para conclusão da tarefa.
deadlineDatestring (data ISO 8601)NãoData de deadline crítica da tarefa.
actualEndDatestring (data ISO 8601)NãoData de término real da tarefa.
ordernumberNãoOrdenação da tarefa dentro da coluna. Se não informado, será calculado automaticamente.
metadataobjectNãoObjeto JSON livre.
isExternallyVisiblebooleanNãoDefine se a tarefa é visível externamente.
isEditableByEveryonebooleanNãoPermite 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étodoRotaO que faz
GET/external/v1/project-team-membersLista com paginação
GET/external/v1/project-team-members/:idBusca um registro pelo ID
POST/external/v1/project-team-membersCria 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.

CampoTipoObrigatórioDescrição
projectIdstringSimID de projeto.
companyUserIdstringSimID de usuário da empresa.
roleenumNãoPapel do membro no projeto. Se não informado, assume MEMBER. Valores: OWNER, MANAGER, MEMBER, VIEWER.
Ainda com dúvida?

A nossa equipe ajuda você a configurar e usar esse recurso.