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

get/links

Retrieves 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.

To fetch a list of all links that originate from a specific document, use these query parameters:
- _relationshipName
- _fromEntityTypeName
- _entityId
- _entityTypeName
- _includeEntityLabels
To fetch an individual link between two documents, use these query parameters:
- relationshipName
- fromEntityTypeName
- fromEntityId
- toEntityTypeName
- toEntityId
- includeEntityLabels

Request Samples

Response Samples


1{
2  "relationshipTypeName": "witnessed_by",
3  "relationshipTypeVersion": 1,
4  "relationshipTypeLabel": "Witnessed by",
5  "@type": "DocumentLink",
6  "id": "witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
7  "createdAt": "2015-10-01T18:30:03.656Z",
8  "lastUpdatedAt": "2015-10-01T18:30:03.656Z",
9  "displayLabel": "Witnessed by",
10  "fromObjectTypeName": "intel_report",
11  "fromObjectTypeVersion": 3,
12  "fromObjectId": "uuid_502",
13  "fromObjectDisplayLabel": "John Smith",
14  "toObjectTypeName": "person",
15  "toObjectTypeVersion": 6,
16  "toObjectId": "uuid_102",
17  "toObjectDisplayLabel": "John Smith",
18  "fieldValues": {
19    "auto_generated_sk": "e5343e0e-3d68-11e8-b467-0ed5f89f718b",
20    "created_at_dttm": "2015-10-01T18:30:03.656Z",
21    "created_by_user_id": "unit_test",
22    "intelReportId": "uuid_502",
23    "last_updated_at_dttm": "2015-10-01T18:30:03.656Z",
24    "last_updated_by_user_id": "unit_test",
25    "personId": "uuid_102",
26    "version": 1
27  },
28  "qualifiedTypeName": "intel_report__witnessed_by",
29  "restrictedFields": {
30    "ssn": {
31      "masked": {
32        "currentUserIsAuthorizedToReveal": true
33      }
34    }
35  }
36}

Query Parameters

Name	Type	Required	Description
_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 the "to" document and the "from" document. 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.

Header Parameters

Name	Type	Required	Description
Accept-Item	string	false	The media type that the client accepts for items within the response collection. This value is ignored when this operation is fetching a single relationship link. Allowed values: application/jsonapplication/vnd.sas.investigation.data.masked.relationshiplinkapplication/vnd.sas.investigation.data.masked.relationshiplink+jsonapplication/vnd.sas.investigation.data.minimally.masked.relationshiplinkapplication/vnd.sas.investigation.data.minimally.masked.relationshiplink+json

Responses

Status	Meaning	Description
200	OK	The request succeeded. The response is either an individual link or a Resource Collection of links.	Headers	Schema
404	Not Found	Unable to find a link or links based on the values that are provided in the request.		Schema
415	Unsupported Media Type	The endpoint cannot produce collection items of the type specified in the `Accept-Item` header.		Schema