$method
Este parâmetro permite-lhe definir a operação a executar com a entidade ou a seleção de entidades devolvida.
Sintaxe disponível
Sintaxe | Exemplo | Descrição |
---|---|---|
$method=delete | POST /Employee?$filter="ID=11"& $method=delete | Elimina a entidade, coleção de entidades ou seleção de entidades atual |
$method=entityset | GET /People/?$filter="ID>320"& $method=entityset& $timeout=600 | Cria um conjunto de entidades no cache do 4D Server baseado na coleção de entidades definidas no pedido REST |
$method=release | GET /Employee/$entityset/<entitySetID>?$method=release | Libera um conjunto de entidades existente armazenado no cache do 4D Server |
$method=subentityset | GET /Company(1)/staff?$expand=staff& $method=subentityset& $subOrderby=lastName ASC | Cria um conjunto de entidades com base na coleção de entidades relacionadas definidas no pedido REST |
$method=update | POST /Person/?$method=update | Actualiza e/ou cria uma ou mais entidades |
$method=delete
Elimina a entidade, coleção de entidades ou seleção de entidades atual (criada através de REST)
Descrição
Com $method=delete
, é possível eliminar uma entidade ou toda uma coleção de entidades. You can define the collection of entities by using, for example, $filter
or specifying one directly using \{dataClass\}({key})
(e.g., /Employee(22)).
You can also delete the entities in an entity set, by calling $entityset/\{entitySetID\}
.
Exemplo
Pode então escrever o seguinte pedido REST para eliminar a entidade cuja chave é 22:
POST /rest/Employee(22)/?$method=delete
Também é possível efetuar uma consulta utilizando $filter:
POST /rest/Employee?$filter="ID=11"&$method=delete
Também é possível eliminar um conjunto de entidades utilizando $entityset/{entitySetID}:
POST /rest/Employee/$entityset/73F46BE3A0734EAA9A33CA8B14433570?$method=delete
Responsa:
{
"ok": true
}
$method=entityset
Cria um conjunto de entidades no cache do 4D Server baseado na coleção de entidades definidas no pedido REST
Descrição
Quando cria uma coleção de entidades em REST, pode também criar um conjunto de entidades que será guardado na cache do 4D Server. The entity set will have a reference number that you can pass to $entityset/\{entitySetID\}
to access it. Por padrão, é válido durante duas horas; no entanto, pode modificar esse tempo passando um valor (em segundos) para $timeout.
Se usou $savedfilter
e/ou $savedorderby
(em conjunto com $filter
e/ou $orderby
) quando criou seu conjunto de entidades, pode recriá-lo com o mesmo ID de referência mesmo que tenha sido removido do cache de 4D Server.
Exemplo
Para criar um conjunto de entidades, que será guardado no cache do 4D Server por duas horas, adicione $method=entityset
no final do seu pedido REST:
GET /rest/People/?$filter="ID>320"&$method=entityset
Pode criar um conjunto de entidades que será armazenado na cache do 4D Server por apenas dez minutos, passando um novo timeout para $timeout
:
GET /rest/People/?$filter="ID>320"&$method=entityset&$timeout=600
Também é possível guardar o filtro e ordenar por, passando true para $savedfilter
e $savedorderby
.
$skip
e$top/$limit
não são tidos em consideração quando se guarda um conjunto de entidades.
Após criar um conjunto de entidades, o primeiro elemento, __ENTITYSET
, é adicionado ao objeto devolvido e indica o URI a utilizar para aceder ao conjunto de entidades:
__ENTITYSET: "http://127.0.0.1:8081/rest/Employee/$entityset/9718A30BF61343C796345F3BE5B01CE7"`
$method=release
Libera um conjunto de entidades existente armazenado no cache do 4D Server.