API - Projetos

Objetivo

Descrever métodos de acesso à API de Projetos(Projects).

Listar

Endpoint

https://api1.tradingworks.net/api/v2/projects/list/{projectstatusID}

Filtro

projectstatusID (opcional) - 0 - Rascunho; 1 - Aberto; 2 - Pausado; 3 - Finalizado; 4 - Cancelado

Método

GET

Headers

AUTH-TOKEN = Sua Chave privada

Novo projeto

Endpoint

https://api1.tradingworks.net/api/v2/projects/post

Método

POST

Headers

AUTH-TOKEN = Sua Chave privada
Content-Type = application/json

Dados


Campo Tipo Requerido Exemplo Observações
ProjectNumber

string (50)

Não "CX45"
ProjectName

string (100)

Sim "Ampliação da Filial Sul" Nome do projeto.
Description

string (1000)

Não "Atividades relativo à expansão da filial sul." Qualquer descritivo sobre a finalidade do projeto.
CustomerNumber

string (255)

Não "C-456" Número do cliente que deverá ser vinculado ao projeto.
Se o cliente for novo, o campo CustomerName deve ser informado.
CustomerName

string (255)

Não "Siderúrgica Nacional S/A" Campo necessário somente quando o cliente não existir cadastrado (CustomerNumber inexistente).
PlannedStartDate

date

Não "2017-04-23" Data planejada de início
PlannedFinishDate

date

Não "2017-10-30" Data planejada de término
OwnerID

integer

Sim 5435 O ID é o código interno da TradingWorks para designar quem é o responsável pelo projeto.
Opcionalmente pode ser usado o campo OwnerFullName ou OwnerEmployeeNumber.
OwnerEmployeeNumber

string (50)

Sim "Z-0984" Número da matrícula do colaborador em substituição do campo OwnerID.
OwnerFullName

string (750)

Sim "José Pereira" Nome completo do colaborador em substituição do campo OwnerID.
ProjectStatusID

integer

Não 0 - Rascunho; 1 - Aberto; 2 - Pausado; 3 - Finalizado; 4 - Cancelado Status do projeto.
Valor padrão: 0
Atividades podem ser executadas somente com o projeto com o status 1 - Aberto.
PlannedStartDate

date

Não "2017-04-23"
PlannedFinishDate

date

Não "2017-04-28"
AllowDuplication

integer

Não 0, 1 ou 2 Valor padrão: 0
0 - Não cria novo projeto se ProjectNumber.
1 - Se existir ProjectNumber seus dados são atualizados.
2 - Cria um novo projeto sob qualquer condição.

Exemplo

{
        "ProjectNumber": "CX45",
        "ProjectName": "Ampliação da Filial Sul",
        "Details": "Atividades relativo à expansão da filial sul.",
        "OwnerFullName": "José Pereira",
        "PlannedStartDate": "2017-04-23",
        "PlannedFinishDate": "2017-04-28",
        "ProjectStatusID": 1,
        "AllowDuplication": 1
}

Editar projeto

Endpoint

https://api1.tradingworks.net/api/v2/projects/put

Método

PUT

Headers

AUTH-TOKEN = Sua Chave privada
Content-Type = application/json

Dados


Campo Tipo Requerido Exemplo Observações
ProjectID

integer

Depende "23421" Número interno da TradingWorks.
User ProjectID quando desejar atualizar também o ProjectNumber.
É obrigatório ter ou ProjectID ou ProjectNumber.
ProjectNumber

string (50)

Depende "CX45" É obrigatório ter ou ProjectID ou ProjectNumber.
Propriedades adicionais do projeto
Sim Todas as propriedades do projeto.

Apagar projeto

As atividades associadas ao projeto não são excluídas, apenas removidos os seus vínculos.

Endpoint

https://api1.tradingworks.net/api/v2/projects/delete

Método

DELETE

Headers

AUTH-TOKEN = Sua Chave privada
Content-Type = application/json

Dados


Campo Tipo Requerido Exemplo Observações
ProjectID
integer
Depende "23421" Número interno da TradingWorks.
É obrigatório ter ou ProjectID ou ProjectNumber.
ProjectNumber
string (50)
Depende "CX45" É obrigatório ter ou ProjectID ou ProjectNumber.

Acessar projeto

Endpoint

https://api1.tradingworks.net/api/v2/projects/get

Método

GET

Headers

AUTH-TOKEN = Sua Chave privada
Content-Type = application/json

Dados


Campo Tipo Requerido Exemplo Observações
ProjectID
integer
Depende "23421" Número interno da TradingWorks.
É obrigatório ter ou ProjectID ou ProjectNumber.
ProjectNumber
string (50)
Depende "CX45" É obrigatório ter ou ProjectID ou ProjectNumber.
Isto respondeu sua dúvida? Obrigado pelo retorno Houve um problema ao enviar seu feedback. Por favor tente novamente.

Ainda precisa de ajuda? Entre em contato Entre em contato