objects

Replace object references

Replace all references in cross-reference property of an object.

Note: This endpoint is deprecated and will be removed in a future version. Use the /objects/{className}/{id}/references/{propertyName} endpoint instead.

put/objects/{id}/references/{propertyName}

Request

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

Path parameters

idstring uuid required

Unique UUID of the source object.

propertyNamestring required

Unique name of the reference property of the source object.

Query parameters

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

References replaced successfully.

Changes

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