update

put

https://api-examples.tamr.cloud/api/v1alpha1/relationships/{relationshipId}

Updates the data of a relationship to the given data.

Preview the results of this operation by setting the dryRunbody parameter to true.

Path Params

relationshipId

string

required

The identifier of the relationship to update.

Body Params

fromTableId

string

required

The table of the originating record.

fromRecordId

string

required

The identifier of the originating record.

toTableId

string

required

The table of the terminating record.

toRecordId

string

required

The identifier of the terminating record.

relationshipTypeId

string

required

The identifier of the type of the relationship.

details

object

Additional details about the relationship.

expectedVersion

object

The expected version of the relationship. If specified, operation is performed only if the current version of the relationship matches this.

fromRecordVersion

object

The expected version of the from record of the relationship If specified, operation is performed only if the current version of the record matches this.

toRecordVersion

object

The expected version of the to record of the relationship If specified, operation is performed only if the current version of the record matches this.

dryRun

boolean

Optional. Run the same checks as the update, including the relationship type's hierarchy constraints and expected versions, and return the relationship as it would be updated, without updating it. A refusal returns the same status and ErrorInfo reason as the update. Fields only a write assigns are unset: version_id, create_time and update_time. Advisory: a concurrent write can land first, and the real write's check is final. Default is false.

Response

200A successful response.