logo
logo

Entity Definition Resource

Each entity definition in the system is represented by an Entity Definition Resource, that can be used to retrieve the state of the entity definition, as well as update it and delete it.

Methods supported: GET, HEAD, PUT, DELETE.

GET /api/entitydefinitions/name

Returns an Entity Definition Object that contains the state of the entity definition.

Example Request:

GET http://<hostname>/api/entitydefinitions/EntityDefinition1
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":298,
    "name":"EntityDefinition1",
    "member_groups":[
        {
            "name":"New member group",
            "labels":{
                "en-US":"New member group",
                "nl-BE":"Nieuwe onderdeel groep"
            },
            "members":[
                {
                    "type":"String"
                    "name":"New string property"
                },
                ...
            ]
        },
        ...
    ],
    "self":{
        "href":"http://<hostname>/api/entitydefinitions/EntityDefinition1"
    },
    "entities":{
        "href":"http://<hostname>/api/entitydefinitions/EntityDefinition1/entities"
    }
}

PUT /api/entitydefinitions/name

Updates an entity definition with the state submitted in the request. If successful, the server responds with 204 No Content. The request body must contain an Entity Definition Object, and all properties are required. If a property is not present its value is removed. Any members not included are removed.

Example Request:

PUT http://<hostname>/api/entitydefinitions/EntityDefinition1
Host: hostname
Content-Type: application/json

{
    "member_groups":[
        {
            "labels":{
                "nl-NL":"Nieuwe onderdeel groep"
            }
        }
    ]
}

Example Response

HTTP/1.1 204 No Content

DELETE /api/entitydefinitions/name

Deletes the entity definition. If successful, the server responds with 204 No Content.

Example Request:

DELETE http://<hostname>/api/entitydefinitions/EntityDefinition1
Host: hostname

Example Response:

HTTP/1.1 204 No Content

Can we improve this article ? Provide feedback