Get Entities

Used for both individual entities and entity search. The response can include a maximum of 200 entities.

Name Description
Input Payload N/A
Output Payload Combined entity (List<Map<String, Object>>)
Data Sense

Dynamically build Output structures at design time

Map response JSON to object list

Command GET {TenantURL}/entities
Note: If the Request has a select parameter, there should not be any space between the query params.

Sample Request

[{
                
                "type": "configuration/entityTypes/Individual",
                
                "attributes": {
                
                "FirstName": [{
                
                "value": "Dima"
                
                }],
                
                "LastName": [{
                
                "value": "Kuznetsov"
                
                }]
                
                }
                
                }
]

Sample Response

[{
                
                "index": 0,
                
                "object": {
                
                "URI": "entities/FG7htmx",
                
                "type": "configuration/entityTypes/Individual",
                
                "createdBy": "dkuznetsov@infoviewsystems.com",
                
                "createdTime": 1480535621632,
                
                "updatedBy": "dkuznetsov@infoviewsystems.com",
                
                "updatedTime": 1480535621632,
                
                "attributes": {
                
                "LastName": [{
                
                "type": "configuration/entityTypes/Individual/attributes/LastName",
                
                "ov": true,
                
                "value": "Kuznetsov",
                
                "URI": "entities/FG7htmx/attributes/LastName/Tw1DLk7T"
                
                }],
                
                "FirstName": [{
                
                "type": "configuration/entityTypes/Individual/attributes/FirstName",
                
                "ov": true,
                
                "value": "Dima",
                
                "URI": "entities/FG7htmx/attributes/FirstName/Tw1DLfrD"
                
                }]
                
                },
                
                "isFavorite": false,
                
                "crosswalks": [{
                
                "URI": "entities/FG7htmx/crosswalks/Tw1DLoNj",
                
                "type": "configuration/sources/Reltio",
                
                "value": "FG7htmx",
                
                "reltioLoadDate": "2016-11-30T19:53:41.632Z",
                
                "createDate": "2016-11-30T19:53:41.632Z",
                
                "updateDate": "2016-11-30T19:53:41.632Z",
                
                "attributes": [
                
                "entities/FG7htmx/attributes/LastName/Tw1DLk7T",
                
                "entities/FG7htmx/attributes/FirstName/Tw1DLfrD"
                
                ],
                
                "singleAttributeUpdateDates": {}
                
                }],
                
                "analyticsAttributes": {},
                
                "label": "",
                
                "secondaryLabel": ""
                
                },
                
                "successful": true
                
                }]
Table 1. Get Entity Parameters
Name Type Required (default) Notes
filter String No Enables entities filtering by a condition. Format for filter query parameter: filter=({Condition Type}[AND/OR {Condition Type}]*)
select String No Comma-separated list of properties from entity structure that should be returned in a response. Allows you to return partial entity object. List of entity object properties you can find in Entities API. Additional system properties are:
  • attributes._lookupCodes-return codes for lookup attributes
  • attributes._lookupValues-return values for lookup attributes
Note: If the Request has a select parameter, there should not be any space between the query params.
Example: select=URI,label,attributes._lookupCodes,attributes._lookupValues
max Integer No (50) Positive Integer value to identify the maximum number of entities to return in a response. Can be used to organize pagination in combination with the "offset" parameter.
offset Integer No (0) Positive Integer value to identify starting what element in a result set should be returned in a response. Can be used to organize pagination in combination with the "limit" parameter.
sort String No () Entity objects property that should be used for sorting. Can be used in combination with "order" parameter to have reverse order. Default sorting is by Entity URI. Example: sort=attributes.FirstName
order String No Order of sorting. Can be used in combination with "sort" parameter to have reverse order. Possible values:
  • asc - the results will be shown in ascending order
  • desc - the results will be shown in descending order
Default sorting is by entity desc.
options String No () Comma-separated list of different options. Available options:
  • sendHidden-disabled by default, entity's JSON will contain hidden attributes if this option is enabled.
  • searchByOv-disabled by default, to search by all attributes with Operational Value (OV) only
You can use the searchByOv and sortByOv options in case of DYNAMIC or STATIC index OV strategy. If you use searchByOv option, sorting by OV works automatically. In case of NONE strategy, the sortByOv option is ignored. If you want to sort by OV, you should switch indexOvStrategy to STATIC or DYNAMIC.
  • ovOnly-return only attribute values that have ov=true flag.
  • nonOvOnly-return only attribute values that have ov=false flag. If you have a nested or reference attribute value where ov=true, but sub-attributes where ov=false, then these sub attributes will not appear in the response.
Example: options=searchByOv

Searching Entities using MuleSoft V3

Searching Entities usingMuleSoft V4