REST APIs

Entity definition

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

Name	Type	Description
`id`	Number	The id of the entity definition
`name`	String	The name of the entity definition
`display_template`	String	A template to use when entities of this definition need to be converted to strings.
`labels`	Labels	The labels of the entity definition
`member_groups`	Array	An array of Member Group Objects. Each member group contains related member definitions.
`self`	Link	A hyperlink to the resource that represents this entity definition.
`entities`	Link	A 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"
  }
}

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