Update a reference

put/references/{referenceId}

Internal-Use Only

Update a reference. The resourceUri can not be updated during this operation. The PUT will fail if the ID in the body does not match the referenceId.

Request Samples

application/json
1

Response Samples

200
application/json
1{
2  "creationTimeStamp": "2022-11-22T19:05:44.122000Z",
3  "createdBy": "sasuser",
4  "modifiedTimeStamp": "2022-11-22T19:05:44.122000Z",
5  "modifiedBy": "sasuser",
6  "id": "bc35f42f-712e-4a2b-bf77-aff28e8c0aeb",
7  "links": [
8    {
9      "method": "GET",
10      "rel": "self",
11      "href": "/relationships/references/bc35f42f-712e-4a2b-bf77-aff28e8c0aeb",
12      "uri": "/relationships/references/bc35f42f-712e-4a2b-bf77-aff28e8c0aeb",
13      "type": "application/vnd.sas.relationship.reference"
14    },
15    {
16      "method": "GET",
17      "rel": "up",
18      "href": "/relationships/references",
19      "uri": "/relationships/references",
20      "type": "application/vnd.sas.collection",
21      "itemType": "application/vnd.sas.relationship.reference"
22    },
23    {
24      "method": "PUT",
25      "rel": "update",
26      "href": "/relationships/references/bc35f42f-712e-4a2b-bf77-aff28e8c0aeb",
27      "uri": "/relationships/references/bc35f42f-712e-4a2b-bf77-aff28e8c0aeb",
28      "type": "application/vnd.sas.relationship.reference",
29      "responseType": "application/vnd.sas.relationship.reference"
30    },
31    {
32      "method": "DELETE",
33      "rel": "delete",
34      "href": "/relationships/references/bc35f42f-712e-4a2b-bf77-aff28e8c0aeb",
35      "uri": "/relationships/references/bc35f42f-712e-4a2b-bf77-aff28e8c0aeb"
36    },
37    {
38      "method": "GET",
39      "rel": "getRelationships",
40      "href": "/relationships/relationships?referenceId=bc35f42f-712e-4a2b-bf77-aff28e8c0aeb",
41      "uri": "/relationships/relationships?referenceId=bc35f42f-712e-4a2b-bf77-aff28e8c0aeb",
42      "type": "application/vnd.sas.collection",
43      "responseType": "application/vnd.sas.collection",
44      "itemType": "application/vnd.sas.relationship"
45    }
46  ],
47  "name": "Quarter 1 results",
48  "resourceUri": "/reports/reports/7339e5a3-3857-4be0-a7c6-9e0cb214888cd",
49  "contentType": "report",
50  "source": "SAS",
51  "analysisTimeStamp": "2022-11-22T19:05:44.122000Z",
52  "version": 1
53}

Path Parameters

Name	Type	Required	Description
referenceId	string	true	The reference ID.

Header Parameters

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

Request Body

The reference.

The reference to update.

Name	Type	Required	Description
resourceUri	string	true	The URI of the resource that this reference represents.
contentType	string	false	The type of the resource this refers to. This will be "report", or "storedprocess" or whatever type string is appropriate for the resource. The type should be registered with the types service so that services that retrieve this resource can look up the correct media type and endpoints for retrieving resources of this type. Also, it is very important that this value matches the type field of the summary representation (that is, the `application/vnd.sas.summary+json` representation).
source	string	false	Source for this reference. This is an indicator of the context from which the referenced resource was obtained. For a resource external to the deployment the source value is defined either by the process providing the resource inforamtion or is user-defined. For resources populated from within the deployment the default value is `sas`.
analysisTimeStamp	string<date-time>	false	Time stamp of the relationship analysis for this reference.
creationTimeStamp	string<date-time>	false	Time stamp of the creation of the referenced resource not this resource. For a resource external to the deployment, where an original time stamp is unavailable, the time stamp of the source file or the analysis time stamp will be used.
modifiedTimeStamp	string<date-time>	false	Time stamp of last modification of the referenced resource not this resource. For a resource external to the deployment, where an original time stamp is unavailable, the time stamp of the source file or the analysis time stamp will be used.
createdBy	string	false	The id of the user who created the referenced resource not this resource. For a resource external to the deployment, where the original user id is unavailable, the user id from the create / update request will be used.
modifiedBy	string	false	The id of the last user who modified the referenced resource not this resource. For a resource external to the deployment, where the original user id is unavailable, the user id from the create / update request will be used.
name	string	false	The name of the referenced resource.
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

Status	Meaning	Description
200	OK	Ok.	Headers	Schema
400	Bad Request	Bad request (the request is not well-formed).		Schema
404	Not Found	No reference exists at the requested path.		Schema
412	Precondition Failed	The `If-Match` request header did not match the resource's entity tag, or the `If-Unmodified-Since` request header did not match the resource's last modified time stamp.		Schema
428	Precondition Required	The request headers did not include an `If-Match` or `If-Unmodified-Since` precondition.		Schema