Create a new reference

post/references

Internal-Use Only

The resource URI must be set by the client within the request body, and this URI must be unique across the entire system.

Request Samples

application/json
1

Response Samples

201
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}

Request Body

The new reference.

Used to create a single reference.

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.

Responses

Status	Meaning	Description
201	Created	The reference was created.	Headers	Schema
400	Bad Request	Bad request (the request is not well-formed).		Schema
405	Method Not Allowed	Method Not Allowed. The resource was not allowed to be created.
409	Conflict	There was a conflict. A reference exists with the resource URI.		Schema