Update a relationship

put/relationships/{relationshipId}

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

Request Samples

1

Response Samples

1{
2  "creationTimeStamp": "2022-11-17T09:25:04.033000Z",
3  "modifiedTimeStamp": "2022-11-17T09:25:04.033000Z",
4  "id": "001bc483-2dc4-4707-860d-5107abd3e460",
5  "links": [
6    {
7      "method": "GET",
8      "rel": "self",
9      "href": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460",
10      "uri": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460",
11      "type": "application/vnd.sas.relationship"
12    },
13    {
14      "method": "DELETE",
15      "rel": "delete",
16      "href": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460",
17      "uri": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460"
18    },
19    {
20      "method": "PUT",
21      "rel": "update",
22      "href": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460",
23      "uri": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460",
24      "type": "application/vnd.sas.relationship",
25      "responseType": "application/vnd.sas.relationship"
26    },
27    {
28      "method": "GET",
29      "rel": "up",
30      "href": "/relationships/relationships",
31      "uri": "/relationships/relationships",
32      "type": "application/vnd.sas.collection",
33      "itemType": "application/vnd.sas.relationship"
34    }
35  ],
36  "resourceUri": "/casManagement/servers/cas-shared-default/caslibs/COMMON_PROD/tables/CONTACTS_ONLY",
37  "type": "Equivalent",
38  "relatedResourceUri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~COMMON_PROD/tables/CONTACTS_ONLY",
39  "referenceId": "b5fbc8bf-57c2-4166-ae7c-bbfd2fc226eb",
40  "relatedReferenceId": "c06dfdc9-1990-4df0-a7ec-ec517b7d9847",
41  "version": 1
42}

Path Parameters

NameTypeRequiredDescription
relationshipId
string
true

The relationship ID.

Header Parameters

NameTypeRequiredDescription
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.

Request Body

The relationship.

Update relationship resource.

NameTypeRequiredDescription
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.

Responses

StatusMeaningDescription
200OK

Ok.

HeadersSchema
400Bad Request

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

Schema
404Not Found

No relationship exists at the requested path.

Schema
409Conflict

A conflict exists with an existing relationship.

Schema
412Precondition Failed

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

Schema
428Precondition Required

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

Schema