logo

Entity Definition Object

The Entity Definition Object contains all the information related to an entity definition. An entity definition has the following properties:

NameTypeDescription
idNumberThe id of the entity definition
nameStringThe name of the entity definition
display_templateStringA template to use when entities of this definition need to be converted to strings.
labelsLabelsThe labels of the entity definition
member_groupsArrayAn array of Member Group Objects. Each member group contains related member definitions.
selfLinkA hyperlink to the resource that represents this entity definition.
entitiesLinkA hyperlink to the collection resource containing all entities defined by this entity definition.

Example

{
    "id":id,
    "name":"entity definition name"
    "labels":{
        "en-US":"display name in English",
        "nl-BE":"display name in Flemish"
    },
    "member_groups":[
        {
            "name":"Example Member Group",
            "labels":{},
            "members":[
                {
                    "type":"String",
                    "name":"Example Member",
                    "is_multiline":false,
                    "is_indexed":false,
                    "is_mandatory":true,
                    "labels":{}
                    "validation_expression":null
                }
            ]
    ],
    "self":{
        "href":"URL to this entity definition resource"
    },
    "entities": {
        "href":"URL to the collection resource of entities for this entity definition"
    }
}

Can we improve this article ? Provide feedback