Media Types

Externally Defined Media Types

application/vnd.sas.collection

The application/vnd.sas.collection media type represents a collection of resources. The collection is usually a page of limit items from a larger collection.

Here are the link relations for the application/vnd.sas.collection media type.

Relationship	HTTP Method	Description
self	GET	The current page of the (filtered) collection. URI: {SASApi}/rest/collectionUri?start=startIndex&limit=limitIndex Media type: application/vnd.sas.collection
next	GET	The next page of resources. It should be omitted if the current view is on the last page. URI: {SASApi}/rest/collectionUri?start=startIndex&limit=limitIndex Media type: application/vnd.sas.collection
first	GET	The first page of resources. It should be omitted if the current view is on the first page. URI: {SASApi}/rest/collectionUri?start=startIndex&limit=limitIndex Media type: application/vnd.sas.collection
last	GET	The last page of resources. It should be omitted if the current view is on the last page. URI: {SASApi}/rest/collectionUri?start=startIndex&limit=limitIndex[modifiers] Media type: application/vnd.sas.collection
up	GET	The resource that this collection resides in. URI: {SASApi}/rest/containerUri Media type: application/vnd.sas.collection

Here is an example of application/vnd.sas.collection+json and application/vnd.sas.collection+json;version=2:

{
  "version" : 2,
  "accept": "space-separated media type names allowed in this collection",
  "count" : integer,
  "start" : integer,
  "limit" : integer,
  "name" : "items",
  "items": [ 
    { resource1 fields }, ..., 
    { resourceN fields } 
    ], 
  "links" : [
          { link representation }, ...
          { link representation },
          ]
}

Note: The order of the fields can vary.

application/vnd.sas.error

Here are attributes for application/vnd.sas.error:

errorCode

The system error code for reference (64-bit integer). It is often used for correlation with back-end service error message identifiers.

httpStatusCode

The HTTP status code error number (integer), 1xx, 2xx, 3xx, 4xx, or 5xx values.

message

The back-end system error message string. The message should be localized as per the Accept-Language of the request.

details

Detailed information specific to this error, in a list of strings. If appropriate, these strings should be localized as per the Accept-Language of the request.

remediation

Recommended actions to resolve the error, in a list of strings. The remediation string should be localized as per the Accept-Language of the request.

version

Version information for this error format (integer, value 1).

links

An array of application/vnd.sas.link objects.

application/vnd.sas.link

application/vnd.sas.link is a media type used to denote a link to a resource.

text/vnd.sas.source.ds2

text/vnd.sas.source.ds2 is a media type used to denote SAS source code consisting of DS2 code.