Get headers for a version from the version history of a link

head/links/@item/versions/{version}

Retrieves headers for the full representation of a version from a link's version history. The link to fetch the full representation is returned with version summaries.

Request Samples

Path Parameters

version
string
true
  • The version of the links history to fetch.

Query Parameters

changedOnly
boolean
false

Specifies whether to return only fields that have changed between the previous and requested link version.

Default:
false
includeDisplayLabel
boolean
false

Specifies whether to include the display label for the link in the version.

Default:
false
_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}

Responses

StatusMeaningDescription
200OK

The request succeeded.

400Bad Request

Version history was not available for the specified link.

404Not Found

The specified link or the requested version was not found.