objects

Add an object reference

Adds a new reference to a reference property (propertyName) on a source data object. The source object is identified by its collection name (className) and UUID (id). The reference to add is specified in the request body.

post/objects/{className}/{id}/references/{propertyName}

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/objects/{className}/{id}/references/{propertyName}
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Path parameters

classNamestring required

Name of the collection (class) the source object belongs to.

idstring uuid required

Unique UUID of the source object.

propertyNamestring required

Unique name of the reference property of the source object.

Query parameters

consistency_levelstring

Determines how many replicas must acknowledge a request before it is considered successful.

tenantstring

Specifies the tenant in a request targeting a multi-tenant collection (class).

Request body

classstring uri

If using a concept reference (rather than a direct reference), specify the desired collection (class) name here.

schemaPropertySchema

Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection.

beaconstring uri

If using a direct reference, specify the URI to point to the cross-reference here. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-reference to an object

hrefstring uri

If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise.

Response

Reference added successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.