REST APIs

Partial entity

The Partial Entity Resource works like the Entity Resource, except it only returns part of the properties and part of the relation links.

The following methods are supported: GET, HEAD.

GET /api/entities/id?groups=group,group&members=member,member

Returns a Partial Entity Object that contains the state of the entity, limited to the properties and relation links included by the groups and members query parameter.

Example Request:

GET http://<hostname>/api/entities/1?members=Property1,Parent
Host: hostname
Accept: application/json

Example Response:

HTTP/1.1 200 OK
Content-Length: content length
Content-Type: application/json; charset=utf-8
ETag: "hash string"

{
    "id":100,
    "properties":{
        "Property1":"Some value"
    },
    "relations":{
        "Parent":{
            "href":"http://<hostname>/api/entities/1/relations/Parent"
        }
    },
    "self":{
        "href":"http://<hostname>/api/entities/1"
    },
    "entitydefinition":{
        "href":"http://<hostname>/api/entitydefinitions/EntityDefinition1"
    }
}

If you have suggestions for improving this article, let us know!