Get field values for a relationship link

get/links/@item/fields
Internal-Use Only

Gets a representation of multiple field values for a relationship link. If any of the fields is configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the raw unmasked value of the field is returned. If any of the fields are configured for masking and the requesting user is not authorized to reveal the value of the masked field, the value will be omitted from the response.

Request Samples

1

Response Samples

1{
2  "count": 2,
3  "items": [
4    {
5      "fieldName": "ssn",
6      "raw": 12345678
7    },
8    {
9      "fieldName": "last_name",
10      "raw": "Smith"
11    }
12  ]
13}

Query Parameters

NameTypeRequiredDescription
_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}

fieldName
array [string]
true

The names of the fields.

Responses

StatusMeaningDescription
200OKThe request succeeded.Schema
404Not FoundThe relationship link or field was not found.Schema