Sign in

v3

OpenAPI 3.1.02026-08-03124249.6 KB
Data access

Fetch Adjacent By Property*

*Beta: This endpoint is released for wider testing and is not yet recommended for production use. We welcome feedback. Its interface may change without announcement.

Retrieve entities adjacent to a given entity for a specific property.

This endpoint offers the same information as adjacent entities nested in /entities/{entity_id}, but offers pagination for cases where the number of results is potentially very large.

get/entities/{entity_id}/adjacent/{property_name}

Path parameters

entity_idstring required

ID of the entity hose graph context was requested

Example:Q7747

ID of the entity hose graph context was requested

property_namestring required

Name of the property to fetch adjacent entities for

Example:address

Name of the property to fetch adjacent entities for

Query parameters

sortstring[]
limitinteger
offsetinteger

Response

Successful Response

limitinteger required
offsetinteger

Example response

{
  "limit": 20,
  "total": {
    "value": 42,
    "relation": "eq"
  },
  "results": [
    {
      "id": "ds-abc-own-123",
      "properties": {
        "asset": [
          {
            "caption": "Company 1 Ltd.",
            "id": "NK-1234",
            "properties": {
              "name": [
                "Company 1 Ltd."
              ]
            },
            "schema": "Comany"
          }
        ]
      },
      "schema": "Ownership"
    }
  ]
}