Sign in
Relationship

Update an existing relationship between entities.

put/atlas/v2/relationship

Request body

attributesobject

The attributes of the struct.

typeNamestring

The name of the type.

lastModifiedTSstring

ETag for concurrency control.

createTimeinteger

The created time of the record.

createdBystring

The user who created the record.

guidstring

The GUID of the relationship.

homeIdstring

The home ID of the relationship.

labelstring

The label of the relationship.

provenanceTypenumber

Used to record the provenance of an instance of an entity or relationship

status'ACTIVE' | 'DELETED'

The enum of relationship status.

updateTimeinteger

The update time of the record.

updatedBystring

The user who updated the record.

versionnumber

The version of the relationship.

Response

OK. The relationship is updated.

attributesobject

The attributes of the struct.

typeNamestring

The name of the type.

lastModifiedTSstring

ETag for concurrency control.

createTimeinteger

The created time of the record.

createdBystring

The user who created the record.

guidstring

The GUID of the relationship.

homeIdstring

The home ID of the relationship.

labelstring

The label of the relationship.

provenanceTypenumber

Used to record the provenance of an instance of an entity or relationship

status'ACTIVE' | 'DELETED'

The enum of relationship status.

updateTimeinteger

The update time of the record.

updatedBystring

The user who updated the record.

versionnumber

The version of the relationship.

Changes

No recorded changes to this endpoint across all 3 revisions of this API.