Update relationship

patch

https://data.api.exabel.com/v1/relationshipTypes/{relationshipTypeId}/relationships/entityTypes/{fromEntityTypeId}/entities/{fromEntityId}/entityTypes/{toEntityTypeId}/entities/{toEntityId}

This can also be used to create a relationship by setting allowMissing to true.

Note that this method will update all fields unless updateMask is set.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

relationshipTypeId

string

required

The ID of a relationship type, e.g. relationshipTypeIdentifier or namespace.relationshipTypeIdentifier. The namespace must be empty (being global) or a namespace accessible to the customer. The relationship type identifier must match the regex [A-Z][A-Z0-9_]{0,63}.

fromEntityTypeId

string

required

The ID of an entity type, e.g. entityTypeIdentifier or namespace.entityTypeIdentifier. The namespace must be empty (being global) or a namespace accessible to the customer. The entity type identifier must match the regex \w[\w-]{0,63}.

fromEntityId

string

required

The ID of an entity, e.g. entityIdentifier or namespace.entityIdentifier. The namespace must be empty (being global) or a namespace accessible to the customer. The entity identifier must match the regex \w[\w-]{0,63}.

toEntityTypeId

string

required

toEntityId

string

required

Query Params

updateMask

string

Use this to update only selected fields. For example, specify description to update only the description. If allowMissing is set, this field is ignored.

For REST requests, this is a comma-separated string.

allowMissing

boolean

If set to true, a new relationship will be created if it did not exist, and updateMask is ignored.

Body Params

The relationship to update.

description

string

This is currently not used in the Exabel app, but may be in future.

properties

object

Additional properties of this relationship. This is currently not used in the Exabel app, but may be in future.

Responses

200A successful response.

defaultAn unexpected error response.