API & SDKsGraphsRelationships

Update Relationship

Updates an existing relationship in the graph.

Path parameters

collection_idstringRequired
The collection ID corresponding to the graph containing the relationship.
relationship_idstringRequired
The ID of the relationship to update.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-API-KeystringRequired

Request

This endpoint expects an object.
subjectstringOptional
The updated subject of the relationship.
subject_idstringOptionalformat: "uuid"
The updated subject ID of the relationship.
predicatestringOptional
The updated predicate of the relationship.
objectstringOptional
The updated object of the relationship.
object_idstringOptionalformat: "uuid"
The updated object ID of the relationship.
descriptionstringOptional
The updated description of the relationship.
weightdoubleOptional
The updated weight of the relationship.
metadatamap from strings to anyOptional
The updated metadata of the relationship.

Response

Successful Response
resultsobject
A relationship between two entities. This is a generic relationship, and can be used to represent any type of relationship between any two entities.

Errors