APIs de gerenciamento de projetos

Este artigo descreve as APIs REST disponíveis no módulo ITPM (IT Project Management – Gerenciamento de Projetos de TI). Os desenvolvedores de integração podem usar essas APIs para integrar o ServiceAide Cloud Service Management a aplicativos externos.

Você utiliza as APIs para executar as seguintes ações no ServiceAide Cloud Service Management por meio de um aplicativo externo:

Consultar o módulo ITPM para obter uma lista de projetos e tarefas relacionados a um projeto específico.
Marcar projetos como favoritos.
Criar um projeto e tarefas dentro do projeto a partir de um sistema externo.
Atualizar as propriedades do projeto e adicionar integrantes da equipe.
Atualizar tarefas do projeto para atribuir proprietários, fechar a tarefa e modificar o tempo gasto e as estimativas.
Bloquear ou desbloquear tarefas.
Excluir projetos ou tarefas dentro de um projeto.
Criar e modificar colunas no painel de tarefas.

Cada API consiste na seguinte estrutura:

URL: o URL do aplicativo específico para seu slice.
Cabeçalho: os identificadores básicos para seu slice e usuário conectado.
Carga: o script para executar uma ação.
É possível substituir as variáveis nesse script por valores reais ao executar a API. Para algumas APIs, não é necessário uma carga. É possível enviar diretamente os valores no campo URL para essas APIs.

Observação: todos os valores de data são em milissegundos UTC.

O cabeçalho para cada chamada de API requer cabeçalhos (obrigatórios). A tabela a seguir descreve os cabeçalhos obrigatórios e seus valores correspondentes:

Cabeçalho	Valor	Obrigatório para
Cookie	Cloud Service válido da ServiceAide Sessão de gerenciamento	Todas as chamadas de API
Tipo de conteúdo	aplicativo/json	POST, PUT
Aceitar	aplicativo/json	POST.PUT, DELETE, GET

O módulo ITPM inclui as seguintes APIs:

APIs de projeto

É possível usar as seguintes APIs para executar ações em um projeto. Ao trabalhar com um projeto existente, inclua a ID do projeto no URL da seguinte maneira:

http://<URL do aplicativo>/itpm/Project('ID do projeto')

Obter por ID

Recuperar um projeto usando uma ID de projeto.

URL

http://<URL do aplicativo>/itpm/Project('ID do projeto')

Carga

ND

Método

OBTER

Resposta

ND

Criar

Criar um projeto.

URL

http://<URL do aplicativo>/itpm/Project

Carga

Método

PUBLICAR

Resposta

ND

Atualizar

Atualizar um projeto.

URL

http://<URL do aplicativo>/itpm/Project('ID do projeto')

Carga

Método

PUBLICAR

Resposta

ND

Desativar

Desativar um projeto.

URL

http://<URL do aplicativo>/itpm/Project('ID do projeto')

Carga

ND

Método

EXCLUIR

Resposta

ND

Obter tudo

Recuperar a lista de todos os projetos que você possui.

URL

http://<URL do aplicativo>/itpm/Project

Carga

ND

Método

OBTER

Resposta

ND

Marcar ou desmarcar como favorito

Marcar um projeto como favorito.

URL

http://<URL do aplicativo>/itpm/Project('ID do projeto')

Carga

Método

PUBLICAR

Resposta

ND

Alterar proprietário do projeto

Alterar o proprietário de um projeto.

URL

http://<URL do aplicativo>/itpm/Project('ID do projeto')/$links/ownedBy

Carga

Método

PUT

Resposta

ND

Alterar a organização do projeto

ND

APIs de alocação

Usar essas APIs para atribuir integrantes a um projeto.

Alocar usuário

Atribuir um usuário a um projeto.

URL

http://<URL do aplicativo>/itpm/Allocation?$expand=project, usuário

Carga

Método

PUBLICAR

Resposta

ND

Cancelar alocação de usuário

Remover um usuário da associação do projeto.

URL

http://<URL do aplicativo>/itpm/Allocation('ID da alocação')

Carga

ND

Método

EXCLUIR

Resposta

ND

Alterar a alocação

Remover ou fornecer permissões de edição a um usuário.

URL

http://<URL do aplicativo>/itpm/Allocation('ID da alocação')

Carga

Método

PUBLICAR

Resposta

ND

Obter alocações

Recuperar a lista de integrantes de um projeto.

URL

http://<URL do aplicativo>/itpm/Project(ID do projeto)/allocations

Carga

ND

Método

OBTER

Resposta

ND

APIs de coluna

Usar essas APIs para criar e modificar as colunas em um quadro de tarefas do projeto.

Adicionar coluna

Criar uma coluna no quadro de tarefas.

URL

http://<URL do aplicativo>/itpm/Lane

Carga

Método

PUBLICAR

Resposta

ND

Atualizar coluna

Modificar a coluna no quadro de tarefas.

URL

http://<URL do aplicativo>/itpm/Lane('ID do projeto')

Carga

Método

PUBLICAR

Resposta

ND

Excluir coluna

Remover uma coluna do quadro de tarefas de um projeto.

URL

http://<URL do aplicativo>/itpm/Lane('ID da coluna')

Carga

ND

Método

EXCLUIR

Resposta

ND

Obter colunas

Recuperar a lista de todas as colunas em um quadro de tarefas do projeto.

URL

http://<URL do aplicativo>/itpm/Project('ID do projeto')/lanes

Carga

ND

Método

OBTER

Resposta

ND

APIs de tarefa

Usar essas APIs para criar e modificar tarefas dentro de um projeto.

Criar

Criar uma tarefa.

URL

http://<URL do aplicativo>/itpm/Tarefa

Carga

Método

PUBLICAR

Resposta

ND

Obter todas as tarefas por projeto

Recuperar todas as tarefas em um projeto.

URL

http://<URL do aplicativo>/itpm/Project('ID do projeto')/tasks?$filter=

Carga

ND

Método

OBTER

Resposta

ND

Obter todas as tarefas por coluna

Recuperar todas as tarefas em uma coluna específica.

URL

http://<URL do aplicativo>/itpm/Lane('ID da coluna')/tasks

Carga

ND

Método

OBTER

Resposta

ND

Excluir tarefa

Remover uma tarefa de um projeto.

URL

http://<URL do aplicativo>/itpm/Task('ID da tarefa')

Carga

ND

Método

EXCLUIR

Resposta

ND

Atualizar

Modificar uma tarefa.

URL

http://localhost:9000/itpm/Task('ID da tarefa')

Carga

Método

PUBLICAR

Resposta

ND

APIs de lista de verificação de tarefa

Você pode criar itens para a lista de verificação de uma tarefa.

Criar lista de verificação

URL

http://<URL do aplicativo>/itpm/CheckListItem

Método

PUBLICAR

Carga

 {
   "description":"Item 1 to be finished",
   "position":2232,
   "done":false,
   "task":{
      "__metadata":{
         "uri":"/itpm/Task('6e87bc52-0aad-4faa-b633-cec827858c04')",
         "type":"odata.Task"
      }
   }
}

Resposta

ND

Atualizar a lista de verificação

URL

http://<URL do aplicativo>/itpm/CheckListItem('checklistItemId')

Método

PUBLICAR

Carga

 {
   "description":"Item 1 to be finished updated",
   "position":2236,
   "done":true,
   "task":{
      "__metadata":{
         "uri":"/itpm/Task('6e87bc52-0aad-4faa-b633-cec827858c04')",
         "type":"odata.Task"
      }
   }
}

Resposta

ND

Obter todos os itens da lista de verificação

URL

http://<URL do aplicativo>/itpm/Task('taskId')

Método

OBTER

Resposta

ND

Obter todos os itens concluídos da lista de verificação de uma tarefa

URL

http://<URL do aplicativo>/itpm/Task('taskId')/checklistItems?$filter=done eq true

Método

OBTER

Resposta

ND

Excluir lista de verificação

URL

http://<URL do aplicativo>/itpm/CheckListItem('checkListItemId')

Método

EXCLUIR

Resposta

ND

Excluir tudo

URL

http://<URL do aplicativo>/itpm/Task('taskId')/$links/checklistItems

Método

EXCLUIR

Resposta

ND

APIs de ticket

É possível importar vários tickets.

URL

http://<URL do aplicativo>/ImportTickets?$expand=importResults/task/ticket

Método

PUBLICAR

Carga

{
   "lane":{
      "__metadata":{
         "uri":"/itpm/Lane('872586ad-b903-466e-a498-dc5b73a4f91e')",
         "type":"odata.Lane"
      }
   },
   "ticketIds":[7,8,9]
}

Resposta

ND

API de autorização de logon

A seguinte API permite autenticar um usuário no aplicativo com base em um nome de usuário e senha.

URL

http:/<url_de_contexto>/odata/login?$format=JSON

Método

PUBLICAR

Cabeçalhos

application/x-www-form-urlencoded

Parâmetros do formulário

Nome de usuário: <user_login>

Senha: <password>

Resposta

A resposta contém os seguintes parâmetros abaixo no formato JSON.

Status
primary_org_logo_idb
external_slice
external_user_id
maintenance_notice

Observação: a resposta também contém o cookie, " LOTUSSESSION="1389265934:080c19ee-e95c-4dce-bfda-09d2ff4dd87d:abb769cf-b153-4052-aa0c-b807434e3191:1945ad38cf8891e3cec4e9d6e33267b417a6c2cb"; Version=1; Path=/"