Entity

An Entity Object contains the state of an entity. The following properties are present:

Name	Type	Description
`id`	Number	The ID of the entity.
`identifier`	String	The unique identifier of the entity.
`self`	Link	A link to the resource of this entity.
`entitydefinition`	Link	A link to the Entity Definition Resource that defines this entity.
`properties`	Object	A dictionary object containing the properties and values. The contents are highly dependent on the entity definition associated with this entity.
`relations`	Object	A dictionary object containing for each relation a property named after the relation and as value either an Entity Relation object or a Link object depending on whether the specific relation is configured as 'nested or not.
`DiscussionOptions`	Object	An object containing details about the page (URL, page ID, page name) where the comment is made. This is optional for linking the comment to a product, but required for email notifications and redirecting to the comment's page.

The values of the properties in the properties dictionary are formatted according to the type of property that is defined in the entity definition associated with this entity. The following table describes the different property types and supported value formats:

Type	Supported value formats
Integer	Number containing a valid 32-bit integer, String containing a valid 32-bit integer, Boolean (converting true and false to 1 and 0, respectively)
Decimal	Number, String containing a valid decimal, Boolean (converting true and false to 1 and 0, respectively)
String	Number (converting to string), String, Boolean (converting to string)
DateTime	String containing an ISO 8601 formatted date and time
Boolean	Number containing either 1 or 0, String containing either "true" or "false", Boolean

Multilanguage properties (marked with is_multilanguage in the entity definition) store values as an object. Each culture is represented by a property named after its RFC 4647 language code, similar to the Labels object.

In addition, properties that can have multiple values (their property definition in the entity definition indicates this through the is_multivalue property) contain an array of values of the respective type.

Multilanguage, multivalue properties contain their values in arrays inside the aforementioned culture object.

Entity definition example

RequestResponse

{
  "id":1,
  "identifier": "00amyWGct0y_ze4lIsj2Mw",
  "properties":{
    "Property1":"Hello, World!",
    "Property2":[41, 42, 43],
    "Property3":{
      "en-US":true,
      "nl-BE":false
    },
    "Property4":"2013-04-30T14:22:42+02:00",
    "Property5":3.1415
  },
  "relations":{
    "R1":{
      "href":"http://<hostname>/api/entities/1/relations/R1"
    },
    "R2": {
      "children":[
        {
          "href":"http://<hostname>/entities/2"
        },
        {
          "href":"http://<hostname>/entities/3"
        }
      ],
      "self":{
        "href":"http://<hostname>/entities/1/relations/R2"
      }
    }
  },
  "entitydefinition":{
    "href":"http://<hostname>/api/entitydefinitions/EntityDefinition1"
  }
}

Example of a request to create a new M.Discussion entity

RequestResponse

{
    "properties":{
        "DiscussionMessage": "<p>test</p>",
        "DiscussionOptions": {
            "absolute_url": "https://<hostname>/en-us/ch-products/ch-productssearch/ch-productdetails/34182?tab28432=Comments",
            "page_id": 28422,
            "page_name": "CH-ProductDetails",
            "entity_id": 34182
    },
    "Discussion.IsDeleted": null
  },
    "relations": {
        "PCMProductToDiscussion": {
            "parent": {
                "href": "https://<hostname>/api/entities/34182"
            }
        }
    },
    "entitydefinition":{
        "href":"https://<hostname>/api/entitydefinitions/M.Discussion"
    }
}

Do you have some feedback for us?

If you have suggestions for improving this article,