Query an individual link

get/links/@item

Internal-Use Only

Retrieves an individual link using an ID string.

Request Samples

Response Samples

200
application/json
1{
2  "relationshipTypeName": "witnessed_by",
3  "relationshipTypeVersion": 1,
4  "relationshipTypeLabel": "Witnessed by",
5  "id": "witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
6  "@type": "DocumentLink",
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
_id	string	true	The ID for an individual link. A link ID uses the following format: `${relationshipName}\|_\|${fromEntityTypeName}\|_\|${toEntityTypeName}\|_\|${fromEntityId}\|_\|${toEntityId}` where `\|_\|` is the delimiter between link ID components. Link ID component details: `relationshipName` - The relationship type name that defines the link. `fromEntityTypeName` - The entity type name of the starting point for the link. `fromEntityId` - The unique identifier of the entity that is the starting point for the link. `toEntityTypeName` - The entity type name of the destination point for the link. `toEntityId` - The unique identifier of the entity that is the destination point for the link. When submitting the request, the pipe character (`\|`) must be percent-encoded as `%7C`. See below for an example of the pipe character properly encoded: `${relationshipName}%7C_%7C${fromEntityTypeName}%7C_%7C${toEntityTypeName}%7C_%7C${fromEntityId}%7C_%7C${toEntityId}`
_includeDisplayLabel	boolean	false	Specifies whether to compute and include display labels for both the to document and the from document in the response.

Responses

Status	Meaning	Description
200	OK	The request succeeded. An individual link is returned.	Schema
400	Bad Request	The request was invalid.	Schema
404	Not Found	Unable to find the link.	Schema