Get historical field value for a relationship link

get/links/history/@item/fields/{fieldName}
Internal-Use Only

Gets a representation of a field value for a relationship link at a certain point in its history. If the field is currently 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 the field is currently configured for masking and the requesting user is not authorized to reveal the value of the masked field, the result is an error.

Request Samples

1

Response Samples

1{
2  "fieldName": "ssn",
3  "raw": 12345678
4}

Path Parameters

NameTypeRequiredDescription
fieldName
string
true

The name of the field.

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}

version
integer
true

The version of the document in history.

Responses

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