Update a relationship link

put/links/@item

Updates an existing relationship link where the relationship type has an internal bridge table.

Request Samples

1

Response Samples

1{
2  "relationshipTypeName": "string",
3  "relationshipTypeVersion": "string",
4  "relationshipTypeLabel": "string",
5  "id": "string",
6  "qualifiedTypeName": "string",
7  "fromObjectTypeName": "string",
8  "fromObjectTypeVersion": -9223372036854776000,
9  "fromObjectId": "string",
10  "fromObjectDisplayLabel": "string",
11  "toObjectTypeName": "string",
12  "toObjectTypeVersion": -9223372036854776000,
13  "toObjectId": "string",
14  "toObjectDisplayLabel": "string",
15  "validFrom": "2019-08-24T14:15:22Z",
16  "validTo": "2019-08-24T14:15:22Z",
17  "createdAt": "2019-08-24T14:15:22Z",
18  "lastUpdatedAt": "2019-08-24T14:15:22Z",
19  "@type": "string"
20}

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}

_includeEntityLabels
boolean
false

Compute and include display labels for both to and from documents in the response.

Default:
false

Request Body

An object that represents the link.

A link between two documents as defined by a relationship type.

NameTypeRequiredDescription
relationshipTypeName
string
false

The name of the relationship type that defines this link.

relationshipTypeVersion
string
false

The internal Data Hub version of the relationship type.

relationshipTypeLabel
string
false

The display label for the relationship type.

id
string
false

The ID of the link.

qualifiedTypeName
string
false

The qualified name of the relationship type. Qualified names are in the format: fromObjectTypeName + "__" + relationshipTypeName.

fromObjectTypeName
string
false

The entity type name for the "From" side of the relationship type.

fromObjectTypeVersion
integer<int64>
false

The internal Data Hub version for the entity type for the "From" side of the relationship type.

fromObjectId
string
false

The document ID for the "From" side of the relationship type.

fromObjectDisplayLabel
string
false

The display label for the document on the "From" side of the relationship type.

toObjectTypeName
string
false

The entity type name for the "To" side of the relationship type.

toObjectTypeVersion
integer<int64>
false

The internal Data Hub version for the entity type for the "To" side of the relationship type.

toObjectId
string
false

The document ID for the "To" side of the relationship type.

toObjectDisplayLabel
string
false

The display label for the document on the "To" side of the relationship type.

validFrom
string<date-time>
false

The timestamp value that indicates the starting datetime for when the link is valid.

validTo
string<date-time>
false

The timestamp value that indicates the ending datetime for when the link is valid.

createdAt
string<date-time>
false

The timestamp value that indicates when this link was created.

lastUpdatedAt
string<date-time>
false

The timestamp value that indicates when this link was last modified.

@type
string
false

Data type that describes the link object. The value is always "DocumentLink".

Responses

StatusMeaningDescription
200OK

The request succeeded.

Schema
400Bad Request

The request was invalid.

Schema
404Not Found

Unable to find the link.

Schema
412Precondition Failed

The link in the request body was out of date.

Schema
428Precondition Required

The link in the request body did not contain a version.

Schema