Create Relationship

POST

Creates a new relationship in the graph.

Path parameters

collection_idstringRequired

The collection ID corresponding to the graph to add the relationship to.

Headers

X-API-KeystringRequired

Request

This endpoint expects an object.
subjectstringRequired

The subject of the relationship to create.

subject_idstringRequiredformat: "uuid"

The ID of the subject of the relationship to create.

predicatestringRequired

The predicate of the relationship to create.

objectstringRequired

The object of the relationship to create.

object_idstringRequiredformat: "uuid"

The ID of the object of the relationship to create.

descriptionstringRequired

The description of the relationship to create.

weightdoubleOptionalDefaults to 1

The weight of the relationship to create.

metadatamap from strings to anyOptional

The metadata of the relationship to create.

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

Built with