home

Developer resources

ReltioProductsDeveloper resourcesRolesApplicationsObjectives
ReltioProductsDeveloper resourcesRolesApplicationsObjectives

Unify and manage your data

Show Contents

thumbnailDeveloper resources

Get Entity

Get Paged Entity

This operation returns an entity object (full or partial) by URI with pagination of attributes with a long list of values.

Request: 

POST {TenantURL}/{entity object URI}/_object
Parameter Required Description
Headers Authorization Yes Information about authentication access token in format "Bearer <accessToken>" (see details in Authentication API).
Body select No Comma-separated list of properties from entity structure that should be returned in the response. Allows you to return partial entity object. Additional system properties:
  • attributes._lookupCodes- return codes for lookup attributes
  • attributes._lookupValues- return values for lookup attributes
Example:select=URI,label,attributes._lookupCodes,attributes._lookupValues
time No Returns an object as it was in the Reltio system by some time (timestamp in ms).
options No Comma-separated list of options which affect entity's JSON content in the response. Available options:
  • sendHidden- disabled by default, entity's JSON will contain hidden attributes if this option is enabled.
  • ovOnly- return only attribute values that have the ov=true flag.
  • nonOvOnly- return only attribute values that have the ov=false flag. If you have a nested or reference attribute value where ov=true and sub-attributes where ov=false, then these sub-attributes will not appear in the response.
mergeDuplicateCrosswalks No Specify "true" to check that all crosswalks for the required entity are unique.
defaultMaxValues No Specifies how long can be the list of values for attributes that are not mentioned inattributesPaging.
attributesPaging No This section describes pagination for values of particular attributes.
filter No Used for search in faceted attribute in UI. Available conditions: containsWordStartingWith(property, tokenized value) Example: "filter": "containsWordStartingWith(attributes,%27dfsdf%27)"
exclude No The opposite to the select section. Can be used for the case when an object contains a lot of different attributes and it is more convenient to specify the attribute that should not be included in the result JSON.

Response:

JSON Object representing object with URI.

Request

 {{
  "defaultMaxValues": 2,
  "select": [
    "attributes.FirstName",
    "attributes.LastName",
    "attributes.Address",
    "tags",
    "crosswalks"
  ],
  "exclude": [
    "attributes.ReleaseDates"
  ],
  "time": 1447335441096,
  "mergeDuplicateCrosswalks": false,
  "options": [
    "sendHidden"
  ],
  "attributesPaging": {
    "configuration/entityTypes/HCP/attributes/FirstName": {
      "offset": 3,
      "max": 4
    },
    "configuration/entityTypes/HCP/attributes/LastName": {
      "offset": 1,
      "max": 3
    }
  }
}

Response: 

{
	"attributes": {
        "FirstName": [
            {
                "type": "configuration/entityTypes/HCP/attributes/FirstName",
                "ov": true,
                "value": "First Name 5",
                "uri": "entities/bInwCLQ/attributes/FirstName/12Rgnl9YX"
            },
            {
                "type": "configuration/entityTypes/HCP/attributes/FirstName",
                "ov": true,
                "value": "First Name 4",
                "uri": "entities/bInwCLQ/attributes/FirstName/12RgnlDon"
            }
        ],
        "LastName": [
            {
                "type": "configuration/entityTypes/HCP/attributes/LastName",
                "ov": true,
                "value": "Last Name 4",
                "uri": "entities/bInwCLQ/attributes/LastName/12RgnlZ85"
            },
            {
                "type": "configuration/entityTypes/HCP/attributes/LastName",
                "ov": true,
                "value": "Last Name 5",
                "uri": "entities/bInwCLQ/attributes/LastName/12RgnlUrp"
            },
            {
                "type": "configuration/entityTypes/HCP/attributes/LastName",
                "ov": true,
                "value": "Last Name 2",
                "uri": "entities/bInwCLQ/attributes/LastName/12Rgnlheb"
            }
        ],
        "Address": [
            {
                "label": "Create address 6",
                "relationshipLabel": "",
                "value": {
                    "AddressRank": [
                        {
                            "type": "configuration/relationTypes/HasAddress/attributes/AddressRank",
                            "ov": true,
                            "value": "1",
                            "uri": "entities/bInwCLQ/attributes/Address/TcuIjYv/AddressRank/12Rgnl5IH"
                        }
                    ],
                    "AddressLine1": [
                        {
                            "type": "configuration/entityTypes/Location/attributes/AddressLine1",
                            "ov": true,
                            "value": "Create address 6",
                            "uri": "entities/bInwCLQ/attributes/Address/TcuIjYv/AddressLine1/11TvgflrK"
                        }
                    ]
                },
                "ov": true,
                "uri": "entities/bInwCLQ/attributes/Address/TcuIjYv",
                "refEntity": {
                    "type": "configuration/entityTypes/Location",
                    "crosswalks": [
                        {
                            "uri": "entities/bInwCLQ/crosswalks/eRIpMfm.11Tvgfq7a",
                            "type": "configuration/sources/Reltio",
                            "value": "eRIpMfm",
                            "createDate": "2017-06-21T13:08:56.500Z",
                            "updateDate": "2017-06-21T13:08:56.500Z",
                            "attributeURIs": [
                                "entities/bInwCLQ/attributes/Address/TcuIjYv/AddressLine1/11TvgflrK",
                                "entities/bInwCLQ/attributes/Address/TcuIjYv"
                            ]
                        }
                    ],
                    "objectURI": "entities/eRIpMfm"
                },
                "refRelation": {
                    "type": "configuration/relationTypes/HasAddress",
                    "crosswalks": [
                        {
                            "uri": "entities/bInwCLQ/crosswalks/TcuIjYv.12Rgnl121",
                            "type": "configuration/sources/Reltio",
                            "value": "TcuIjYv",
                            "createDate": "2017-07-27T07:21:12.672Z",
                            "updateDate": "2017-07-27T07:21:12.672Z",
                            "attributeURIs": [
                                "entities/bInwCLQ/attributes/Address/TcuIjYv/AddressRank/12Rgnl5IH",
                                "entities/bInwCLQ/attributes/Address/TcuIjYv"
                            ]
                        }
                    ],
                    "startRefPinned": false,
                    "endRefPinned": false,
                    "startRefIgnored": false,
                    "endRefIgnored": false,
                    "objectURI": "relations/TcuIjYv"
                },
                "startObjectCrosswalks": [
                    {
                        "type": "configuration/sources/Reltio",
                        "value": "bInwCLQ",
                      ],
                        "singleAttributeUpdateDates": {
                            "entities/bInwCLQ/attributes/FirstName/12Rgnl9YX": "2017-07-27T07:21:12.672Z",
                            "entities/bInwCLQ/attributes/LastName/12RgnlZ85": "2017-07-27T07:21:12.672Z",
                            "entities/bInwCLQ/attributes/LastName/12Rgnlheb": "2017-07-27T07:21:12.672Z",
                            "entities/bInwCLQ/attributes/FirstName/12RgnlDon": "2017-07-27T07:21:12.672Z",
                            "entities/bInwCLQ/attributes/LastName/12RgnlUrp": "2017-07-27T07:21:12.672Z"
                        }
                    }
                ]
            },
            {
                "label": "Create address 3",
                "relationshipLabel": "",
                "value": {
                    "AddressRank": [
                        {
                            "type": "configuration/relationTypes/HasAddress/attributes/AddressRank",
                            "ov": true,
                            "value": "2",
                            "uri": "entities/bInwCLQ/attributes/Address/TcuIfIf/AddressRank/12RgnksVV"
                        }
                    ],
                    "AddressLine1": [
                        {
                            "type": "configuration/entityTypes/Location/attributes/AddressLine1",
                            "ov": true,
                            "value": "Create address 3",
                            "uri": "entities/bInwCLQ/attributes/Address/TcuIfIf/AddressLine1/11TvgfMHm"
                        }
                    ]
                },
                "ov": true,
                "uri": "entities/bInwCLQ/attributes/Address/TcuIfIf",
                "refEntity": {
                    "type": "configuration/entityTypes/Location",
                    "crosswalks": [
                        {
                            "uri": "entities/bInwCLQ/crosswalks/eRIpE9G.11TvgfQY2",
                            "type": "configuration/sources/Reltio",
                            "value": "eRIpE9G",
                            "createDate": "2017-06-21T13:08:55.514Z",
                            "updateDate": "2017-06-21T13:08:55.514Z",
                            "attributeURIs": [
                                "entities/bInwCLQ/attributes/Address/TcuIfIf/AddressLine1/11TvgfMHm",
                                "entities/bInwCLQ/attributes/Address/TcuIfIf"
                            ]
                        }
                    ],
                    "objectURI": "entities/eRIpE9G"
                },
                "refRelation": {
                    "type": "configuration/relationTypes/HasAddress",
                    "crosswalks": [
                        {
                            "uri": "entities/bInwCLQ/crosswalks/TcuIfIf.12RgnkoFF",
                            "type": "configuration/sources/Reltio",
                            "value": "TcuIfIf",
                            "createDate": "2017-07-27T07:21:12.672Z",
                            "updateDate": "2017-07-27T07:21:12.672Z",
                            "attributeURIs": [
                                "entities/bInwCLQ/attributes/Address/TcuIfIf/AddressRank/12RgnksVV",
                                "entities/bInwCLQ/attributes/Address/TcuIfIf"
                            ]
                        }
                    ],
                    "startRefPinned": false,
                    "endRefPinned": false,
                    "startRefIgnored": false,
                    "endRefIgnored": false,
                    "objectURI": "relations/TcuIfIf"
                },
                "startObjectCrosswalks": [
                    {
                        "type": "configuration/sources/Reltio",
                        "value": "bInwCLQ",
                     ],
                        "singleAttributeUpdateDates": {
                            "entities/bInwCLQ/attributes/FirstName/12Rgnl9YX": "2017-07-27T07:21:12.672Z",
                            "entities/bInwCLQ/attributes/LastName/12RgnlZ85": "2017-07-27T07:21:12.672Z",
                            "entities/bInwCLQ/attributes/LastName/12Rgnlheb": "2017-07-27T07:21:12.672Z",
                            "entities/bInwCLQ/attributes/FirstName/12RgnlDon": "2017-07-27T07:21:12.672Z",
                            "entities/bInwCLQ/attributes/LastName/12RgnlUrp": "2017-07-27T07:21:12.672Z"
                        }
                    }
                ]
            }
        ],
        "paging": {
            "configuration/entityTypes/HCP/attributes/Blob": {
                "totalValues": 5,
                "totalOvValues": 5
            },
            "configuration/entityTypes/HCP/attributes/Date": {
                "totalValues": 5,
                "totalOvValues": 5
            },
            "configuration/entityTypes/HCP/attributes/Address": {
                "totalValues": 3,
                "totalOvValues": 3
            },
            "configuration/entityTypes/HCP/attributes/Int": {
                "totalValues": 5,
                "totalOvValues": 5
            },
            "configuration/entityTypes/HCP/attributes/Number": {
                "totalValues": 5,
                "totalOvValues": 5
            },
            "configuration/entityTypes/HCP/attributes/Long": {
                "totalValues": 5,
                "totalOvValues": 5
            },
            "configuration/entityTypes/HCP/attributes/Timestamp": {
                "totalValues": 5,
                "totalOvValues": 5
            },
            "configuration/entityTypes/HCP/attributes/FirstName": {
                "offset": 3,
                "max": 4,
                "totalValues": 5,
                "totalOvValues": 5
            },
            "configuration/entityTypes/HCP/attributes/Float": {
                "totalValues": 5,
                "totalOvValues": 5
            },
            "configuration/entityTypes/HCP/attributes/LastName": {
                "offset": 1,
                "max": 3,
                "totalValues": 5,
                "totalOvValues": 5
            }
        }
    },
    "crosswalks": [
        {
            "uri": "entities/bInwCLQ/crosswalks/1Fsge2q2a",
            "type": "configuration/sources/Reltio",
            "value": "bInwCLQ",
            "reltioLoadDate": "2017-07-27T07:21:12.672Z",
            "createDate": "2017-07-13T08:26:44.476Z",
            "updateDate": "2017-07-13T08:26:44.476Z",
            "attributes": [
                "entities/bInwCLQ/attributes/FirstName/12Rgnl9YX",
                "entities/bInwCLQ/attributes/LastName/12RgnlZ85",
                "entities/bInwCLQ/attributes/LastName/12Rgnlheb",
                "entities/bInwCLQ/attributes/FirstName/12RgnlDon",
                "entities/bInwCLQ/attributes/LastName/12RgnlUrp"
            ],
            "singleAttributeUpdateDates": {
                "entities/bInwCLQ/attributes/FirstName/12Rgnl9YX": "2017-07-27T07:21:12.672Z",
                "entities/bInwCLQ/attributes/LastName/12RgnlZ85": "2017-07-27T07:21:12.672Z",
                "entities/bInwCLQ/attributes/LastName/12Rgnlheb": "2017-07-27T07:21:12.672Z",
                "entities/bInwCLQ/attributes/FirstName/12RgnlDon": "2017-07-27T07:21:12.672Z",
                "entities/bInwCLQ/attributes/LastName/12RgnlUrp": "2017-07-27T07:21:12.672Z"
            }
        }
    ]
}

Updated on December 9, 2024

Footer

You've found your way to a temporary environment. Content is not complete or final. Looking for Reltio documentation? Go to docs.reltio.com.

© 2025 The RELTIO® mark is a registered trademark of Reltio, Inc. in the United States and other countries; DataDriven and Reltio Data Cloud are trademarks of Reltio, Inc. Other names or marks are trademarks of their respective owners.

Terms and Conditions, Privacy Policy, and