Siteware - Web API

Introdução

Para acessar os endpoints abaixo você precisa fazer uma requisição POST para a url /token.

POST /token HTTP/1.1
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded
grant_type=password&username=username&password=xxxx

IndicatorValues

Endpoints de Criação/Edição de Valores de Indicadores

API	Description
POST api/v2/IndicatorValues/{frequencia}	Salva valores (Real, Meta) de um determinado Indicador, em uma Frequência (Mensal, Semanal ou Diária) com uma data vinculada (Ocorrência). Os valores enviados podem ser do tipo Apurado ou Acumulado.
POST api/v2/IndicatorValues/Indicators/{frequencia}	Salva os Valores da Lista de Indicadores.

Account

Endpoints para gerenciamento de contas de Usuário

API	Description
POST api/Account/Logout	Realiza o logout do usuário.
POST api/Account/EsqueciASenha?email={email}	Envia um e-mail para o usuário reconfigurar a senha.

Documentos

Endpoints de Documentos

API	Description
GET api/Documentos/Download?id={id}&userId={userId}	Realiza o Download de um determinado arquivo.

Reunioes

Endpoints das Reuniões

API	Description
POST api/Reunioes/AceitarConvite?id={id}&idDaNotificacao={idDaNotificacao}	Aceita um convite para uma determinada reunião.
POST api/Reunioes/RecusarConvite?id={id}&idDaNotificacao={idDaNotificacao}	Recusa um convite para uma determinada reunião.
GET api/Reunioes/{id}	Retorna os dados de uma reunião através do seu identificador.

Tarefas

Endpoints de Tarefas

API	Description
POST api/Tarefas/Desativar?id={id}	Desativa uma determinada tarefa.
POST api/Tarefas/Reativar?id={id}	Reativa uma determinada tarefa.
POST api/Tarefas/Designar	Designa uma determinada Tarefa para outro Responsável.
POST api/Tarefas/Editar	Editar os Campos 5W2H da Tarefa.
POST api/Tarefas/AnexarLink	Anexa um link da Tarefa.
POST api/Tarefas/AnexarLinkNaExecucao	Anexa links na execução da Tarefa.
POST api/Tarefas/Criar	Cria uma Tarefa em um Plano de Ação.
GET api/Tarefas/DetalhesDaTarefa?id={id}	Retorna os Detalhes de uma Tarefa.
POST api/Tarefas/AnexarDocumento?id={id}	Anexa um Documento em uma determinada Tarefa.
POST api/Tarefas/AnexarDocumentoNaExecucao?id={id}	Anexa um documento em uma execução de uma Tarefa.
POST api/Tarefas/Executar	Executa uma determinada Tarefa.
POST api/Tarefas/Comentar	Cria um comentário em determinada tarefa.
POST api/Tarefas/AlterarInicioPrevisto	Altera o início previsto de determinada tarefa.
POST api/Tarefas/AlterarFimPrevisto	Altera o fim previsto de determinada tarefa.
GET api/Tarefas/Documentos?id={id}	Lista os documentos de determinada tarefa.
GET api/Tarefas/Comentarios?id={id}	Lista os comentários de determinada tarefa.
POST api/Tarefas/EditarComentario	Edita um determinado comentário de determinada tarefa.
POST api/Tarefas/ExcluirComentario?idDoComentario={idDoComentario}	Exclui um determinado comentário de determinada tarefa.
GET api/Tarefas/Subtarefas?id={id}	Lista as sub-tarefas de uma determinada tarefa.
POST api/Tarefas/Reprogramar	Solicita reprogramação de determinada tarefa.
GET api/Tarefas/{id}	Retorna uma determinada Tarefa.

Notificacoes

API	Description
GET api/Notificacoes/Quantidade	Retorna a quantidade de notificações do usuário.
GET api/Notificacoes?skip={skip}	Retornar 10 notificações saltando a quantidade informada no parâmetro skip.
DELETE api/Notificacoes/{id}	Exclui uma notificação específica.
DELETE api/Notificacoes	Exclui todas as notificações do usuário.

Usuarios

Endpoints de Usuários

API	Description
GET Detalhes?id={id}	Retorna detalhes de um determinado usuário pelo Id.
GET DetalhesDoUsuarioLogado	Retorna detalhes do usuário atual.
POST Foto/Upload	Faz o Upload da Foto de um usuário.
GET api/Usuarios?filter={filter}	Retorna a lista de usuários ativos filtrados.
GET api/Usuarios	Retorna a lista de todos os usuários.
POST api/Usuarios	Cria um usuário no sistema.
PUT api/Usuarios	Edita um usuário do sistema.

Empresas

Endpoints da empresa

API	Description
GET API/Empresas/ObterNomeDaEmpresa	Retorna o nome da empresa

Farol

Endpoints para o Farol de Indicadores

API	Description
POST api/Farol/Farol	Retorna o Farol de um Indicador
POST api/Farol/Desdobramentos	Retorna as opções disponíveis para Desdobrar um Indicador.
POST api/Farol/DesdobrarIndicador	Retorna os itens de Desdobramento de um Indicador de acordo com um filtro.
GET api/Farol/Semanas?idDoPlanoDeGestao={idDoPlanoDeGestao}	Retorna as semanas disponíveis em um Plano de Gestão.

MeuPainel

Endpoints do Meu Painel

API	Description
GET api/MeuPainel/MapaDeCalor?dataInicial={dataInicial}&dataFinal={dataFinal}	Retorna uma coleção da estrutura MapaDeCalor. Esta estrutura representa um dia e a quantidade de tarefas e reuniões para este dia.
GET api/MeuPainel/Reunioes?data={data}	Retorna todas as reuniões agendadas para uma determinada data. Quando a data não é informada, retorna as reuniões do dia.
GET api/MeuPainel/Tarefas?data={data}	Retorna todas as tarefas programadas para uma determinada data. Quando a data não é informada retorna as tarefas do dia.
GET api/MeuPainel?data={data}	Retorna todas as tarefas e reuniões programadas para uma determinada data. Quando a data não é informada, retorna as tarefas e reuniões do dia. Retorna também a quantidade de Tarefas Atrasadas.

Indicadores

Endpoints de Indicadores

API	Description
POST api/Indicadores/DetalhesDoIndicador	Retorna os detalhes de um determinado indicador.
POST api/Indicadores/Grafico	Retorna dados do gráfico do indicador de acordo com o filtro informado.
POST api/Indicadores/Comentar	Cria um comentário em determinado indicador.
GET api/Indicadores/Comentarios?id={id}	Retorna os comentários de um determinado indicador.
GET api/Indicadores/SolucoesDeProblema?id={id}	Retorna as Soluções de Problemas de um determinado indicador.
GET api/Indicadores/Tarefas?id={id}	Retorna as Tarefas de um determinado indicador.
GET api/Indicadores/Documentos?id={id}	Retorna os documentos de um determinado indicador.
POST api/Indicadores/ExcluirComentario?idDoComentario={idDoComentario}&idDoIndicador={idDoIndicador}	Excluir um determinado Comentário de um Indicador.
POST api/Indicadores/EditarComentario	Editar um determinado Comentário de um Indicador.
POST api/Indicadores/AnexarDocumento?id={id}	Anexar um documento em um Indicador.
POST api/Indicadores/SalvarValores	Salvar valores de um determinado indicador.

UnidadesGerenciais

Endpoints de Unidades Gerenciais

API	Description
GET api/UnidadesGerenciais/UnidadesQueOUsuarioAtualAltera?filter={filter}	Retorna a lista das 30 primeiras UG's, por ordem alfabética, que o usuário atual pode alterar.
GET api/UnidadesGerenciais/UnidadesQueOUsuarioAtualAltera?filter={filter}&idPlanoDeGestao={idPlanoDeGestao}	Retorna a lista das 30 primeiras UG's, por ordem alfabética, que o usuário atual pode alterar.
GET api/UnidadesGerenciais/UnidadesGerenciaisPorUsuarioLogado?filter={filter}&idPlanoDeGestao={idPlanoDeGestao}	Retorna lista com as 30 primeiras UG's que o usuário logado possui acesso.
GET api/UnidadesGerenciais	Retorna a lista de UGs cadastradas no sistema

IndicatorAudit

Endpoints referentes à auditoria de Indicadores

API	Description
POST api/IndicatorAudit/Audits	Retorna registros de auditoria de um indicador de acordo com um filtro.

PlanosDeGestao

Endpoints de Planos de Gestão

API	Description
GET api/PlanosDeGestao	Retorna a lista de Planos de Gestão ativos.

Users

User_Endpoints Usar: /odataapi/Users/

API	Description
GET api/Users	Retorna a lista de usuários filtrados.

Projeto

Endpoints de Projetos

API	Description
POST api/Projeto	Cria um projeto no sistema

UsuarioPorLogin

API	Description
GET api/UsuarioPorLogin?login={login}	Retorna a lista de usuários ativos filtrados.

Visoes

Endpoints de Visões

API	Description
GET api/Visoes?idDaUnidadeGerencial={idDaUnidadeGerencial}&idDoPlanoDeGestao={idDoPlanoDeGestao}	Obtém lista de visões do farol.

SolucoesDeProblemas

Endpoints de Soluções de Problemas

API	Description
GET api/SolucoesDeProblemas/{id}	Retorna os detalhes de uma determinada Solução de Problema.

JobRoles

Jobs_Endpoints (ODATA) Usar: /odataapi/JobRoles/

API	Description
GET api/JobRoles	Retorna a lista de Cargos do sistema.
GET api/JobRoles?key={key}	Obtém um cargo específico do sistema.
POST api/JobRoles	Cria um Cargo do sistema.
PUT api/JobRoles?key={key}	Altera um Cargo específico.
DELETE api/JobRoles?key={key}	Remove um Cargo específico do sistema.

AcompanhamentoFinanceiroDoProjeto

Endpoints dos Acompanhamentos Financeiros dos Projetos

API	Description
POST api/AcompanhamentoFinanceiroDoProjeto	Cadastra os Acompanhamentos Financeiro de Projetos.