Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Todos os serviços disponíveis são implementados utilizando o padrão de Restful Objects.  Esta camada oferece uma forma de comunicação entre as diferentes partes do plugin.

Modelo de URI utilizado pela API REST:

O modelo de URI é baseado na operação a ser realizada (POST, PUT, DELETE e GET) 

A estrutura base da URI dada da seguinte maneira:

http://{host}:{port}/{context}/rest/latest/domain/{object}/{actions}

Onde:

  • {host} e {port} definem onde a aplicacao esta rodando;
  • {context} é o Servlet Context da aplicacao. Por exemplo, no crowd normalmente é /crowd;
  • {object} é o Objeto objeto da camada de persistência a ser trabalhado (entidade de persistência "Company", caso a mesma exista).. Ou seja, é a classe Java que representa para a aplicação a entidade de banco de dados.

Operações suportadas

O modelo de URI é baseado nas operações HTTP (POST, PUT, DELETE e GET). E tratando-se do padrão Restful Objects a URI do serviço exposto tem uma estrutura diferente, mantendo, entretanto, sua estrutura base acima citada.

A seguir, será explicado como a URI se comporta para as diferentes operações HTTP.

GET

Para operações do tipo