Query a list of links or an individual link based on specific query parameters

get/links

Gets either a list of links that are associated with a document or an individual link. The type of request is determined by the included query parameters. Do not mix the query parameters for both types of requests.

  • Query a list of links that are associated with a document. Fetch a list of all links that originate from a specific document. Use these query parameters:
    • _relationshipName
    • _fromEntityTypeName
    • _entityId
    • _entityTypeName
    • _includeEntityLabels

  • Query an individual link. Fetch an individual link between two documents. Use these parameters:
    • relationshipName
    • fromEntityTypeName
    • fromEntityId
    • toEntityTypeName
    • toEntityId
    • includeEntityLabels

Request Samples

1

Response Samples

1{
2  "relationshipTypeName": "string",
3  "relationshipTypeVersion": "string",
4  "relationshipTypeLabel": "string",
5  "id": "string",
6  "qualifiedTypeName": "string",
7  "fromObjectTypeName": "string",
8  "fromObjectTypeVersion": -9223372036854776000,
9  "fromObjectId": "string",
10  "fromObjectDisplayLabel": "string",
11  "toObjectTypeName": "string",
12  "toObjectTypeVersion": -9223372036854776000,
13  "toObjectId": "string",
14  "toObjectDisplayLabel": "string",
15  "validFrom": "2019-08-24T14:15:22Z",
16  "validTo": "2019-08-24T14:15:22Z",
17  "createdAt": "2019-08-24T14:15:22Z",
18  "lastUpdatedAt": "2019-08-24T14:15:22Z",
19  "@type": "string"
20}

Query Parameters

NameTypeRequiredDescription
_entityId
string
false

The unique identifier for the entity that is the starting point of the link.

_entityTypeName
string
false

The same value as _fromEntityTypeName. (This is required for legacy reasons.)

_fromEntityTypeName
string
false

The entity type of the starting point of the link.

_includeEntityLabels
boolean
false

Compute and include display labels for both to and from documents.

Default:
false
_relationshipName
string
false

The name of the relationship type upon which the link is based.

fromEntityId
string
false

The unique identifier for the entity that is the starting point of the link.

fromEntityTypeName
string
false

The entity type of the starting point of the link.

includeEntityLabels
boolean
false

Compute and include display labels for both to and from documents.

Default:
false
relationshipName
string
false

The name of the relationship type upon which the link is based.

toEntityId
string
false

The unique identifier for the entity that is the destination point of the link.

toEntityTypeName
string
false

The entity type of the destination point of the link.

Responses

StatusMeaningDescription
200OK

The request succeeded. The response is either an individual link or an array of links.

Schema
404Not Found

Unable able to find a link or links based on the values provided in the request.

Schema