Manage all aspects of data quality, data sources, and tables

data_management

2024.07

2024.03

2023.10

2024.08

2024.10

2024.09

This API is deprecated as of 2023.10 and will be removed in a future release.
The Relationships API manages the storage and discovery of relationships, and the retrieval of networks of relationship data.

Relationships

2022.09

Viya_35

2023.03

The Relationships API manages the storage and discovery of relationships, and the retrieval of networks of relationship data.

The PUT will fail if the ID in the body does match not the `relationshipId`. Only the `type` field can be updated.

Update a relationship between two references.

Update relationship resource

The eEag that was returned from a GET, POST, or PUT of this relationship.

If-Match

The value of the `lastModified` date of the relationship.  If the relationship has been updated since this time, the update will fail.

If-Unmodified-Since

relationshipId

The connection between a subject resource and a related resource.

Relationship resource

Location

ETag

The time stamp in `EEE, dd MMM yyyy HH:mm:ss GMT` format when the reference was last modified.

Last-Modified

Bad request (the request is not well-formed).

Error

application/vnd.sas.error

No relationship exists at the requested path.

A conflict exists with an existing relationship.

Precondition failed. The target has changed since it was last fetched.

Precondition required. Include an If-Match header with the request.

The request headers did not include an `If-Match` or `If-Unmodified-Since` precondition.

Update a relationship

Create reference

A collection used to create multiple references.

Create references collection

References collection

Update reference resource

A reference contains basic information about a resource for which there is a relationship. This is the `application/vnd.sas.relationship.reference` media type.

Reference resource

Relationships collection

A collection used to create multiple relationships.

Create relationships collection

Create relationship

Relationship types collection

The nature of the connection between two resources.

Relationship type

Distinct values collection

Multi-delete collection

A JSONPatch document containing the path of the item to remove.

JSONPatch document

Relationship query

Provides the status of a relationship job.

Job that loads metadata

Filter text

The list of links to top-level resources and operations available from the root of the API.

Name	Type	Required	Description
If-Match	string	false	The eEag that was returned from a GET, POST, or PUT of this relationship.
If-Unmodified-Since	string	false	The value of the `lastModified` date of the relationship. If the relationship has been updated since this time, the update will fail.

Name	Type	Required	Description
resourceUri	string	true	The URI of the subject resource of this relationship.
referenceId	string	false	The id of the reference for the subject resource.
type	string	true	The id of this relationship type.
relatedResourceUri	string	true	The URI of the related resource of this relationship.
relatedReferenceId	string	false	The id of the reference for the related resource.
source	string	false	The source of this relationship. Typically the URI of the resource that manages this relationship.
version	integer	false	This media type's schema version number. This representation is version 1.
id	string	false	System-assigned unique ID for this object.

Status	Meaning	Description
200	OK	Ok.	Headers	Schema
400	Bad Request	Bad request (the request is not well-formed).		Schema
404	Not Found	No relationship exists at the requested path.		Schema
409	Conflict	A conflict exists with an existing relationship.		Schema
412	Precondition Failed	Precondition failed. The target has changed since it was last fetched.		Schema
428	Precondition Required	The request headers did not include an `If-Match` or `If-Unmodified-Since` precondition.		Schema

Update a relationship

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses