Data Management

Examples

Github Examples

Detailed examples on how to use this API can be found on Github.

Data Quality

Base URLs:

https://example.com/dataQuality

Terms of service Email: SAS Developers Web: SAS Developers

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Data Quality API retrieves information about locales, functions, definitions, and tokens provided by a Quality Knowledge Base (QKB).

Operations

Root

Contains the operations for the root resource.

Get a list top-level resource links

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/ \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.api+json'


const headers = {
  'Accept':'application/vnd.sas.api+json'
};

fetch('https://example.com/dataQuality/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.api+json'
}

r = requests.get('https://example.com/dataQuality/', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.api+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /

Returns a list of top-level resource links provided by the Data Quality API.

Example responses

The root response consists of a collection of links that can be used to navigate the Data Quality service API.

{
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "environments",
      "href": "/dataQuality/environments",
      "uri": "/dataQuality/environments",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.environment"
    },
    {
      "method": "GET",
      "rel": "qkbs",
      "href": "/dataQuality/qkbs",
      "uri": "/dataQuality/qkbs",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    }
  ]
}

{
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "environments",
      "href": "/dataQuality/environments",
      "uri": "/dataQuality/environments",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.environment"
    },
    {
      "method": "GET",
      "rel": "qkbs",
      "href": "/dataQuality/qkbs",
      "uri": "/dataQuality/qkbs",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. A list of resources was returned.	api

Get headers and verify that API is available

Code samples

# You can also use wget
curl -X HEAD https://example.com/dataQuality/
  -H 'Authorization: Bearer <access-token-goes-here>' \


fetch('https://example.com/dataQuality/',
{
  method: 'HEAD'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.head('https://example.com/dataQuality/')

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "https://example.com/dataQuality/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

HEAD /

Returns header information and verifies that the Data Quality API is running.

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The Data Quality API is available and running.	None

QKB

Contains the operations for the QKB resource.

Get a list of all QKBs on all contexts

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/qkbs \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('https://example.com/dataQuality/qkbs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('https://example.com/dataQuality/qkbs', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/qkbs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /qkbs

Returns a list of all available QKBs on all execution contexts that are available to the user.

Parameters

Name	In	Type	Required	Description
start	query	integer	false	0-based index of first QKB to return. Defaults to 0.
limit	query	integer	false	Specifies the maximum number of QKBs to return in a single page of results. The actual number of returned QKBs can be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Specifies filter criteria for the returned QKBs. Filtering is supported on the name, product, version, default, created, context, and environment fields. The supported functions are and, or, not, in, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries Filter by name starting with 'qkb': /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?filter=startsWith(name, 'qkb') Filter by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?filter=eq(name, 'qkb1') Filter for multiple QKBs /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?filter=in(name, 'qkb1', 'qkb2', 'qkb')
sortBy	query	string(sort-criteria)	false	Specifies sort criteria for the returned QKBs. Sorting is supported on the name, product, version, default, created, context, and environment fields. The default sort order is ascending on the name field. Some sample sorts Sort ascending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?sortBy=name:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?sortBy=name:descending

Example responses

The QKBs response consists of a collection of qkbs available on all execution environments.

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/qkbs",
      "uri": "/dataQuality/qkbs",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/qkbs?start=0&limit=10&sortBy=name",
      "uri": "/dataQuality/qkbs?start=0&limit=10&sortBy=name",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/",
      "uri": "/dataQuality/",
      "type": "application/vnd.sas.api"
    }
  ],
  "name": "qkbs",
  "accept": "application/vnd.sas.data.quality.qkb",
  "items": [
    {
      "version": "1",
      "name": "QKB_USPOCH",
      "product": "CI",
      "productVersion": "v27",
      "isDefault": false,
      "creationTimeStamp": "2017-01-06T14:59:27.000Z",
      "context": "casqkb",
      "environment": "CAS",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
          "type": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "locales",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.locale"
        }
      ]
    },
    {
      "version": "1",
      "name": "31",
      "productVersion": "v31",
      "isDefault": true,
      "context": "a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f",
      "environment": "compute",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31",
          "uri": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31",
          "type": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs",
          "uri": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "locales",
          "href": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31/locales",
          "uri": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31/locales",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.locale"
        }
      ]
    }
  ],
  "version": 2
}

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/qkbs",
      "uri": "/dataQuality/qkbs",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/qkbs?start=0&limit=10&sortBy=name",
      "uri": "/dataQuality/qkbs?start=0&limit=10&sortBy=name",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/",
      "uri": "/dataQuality/",
      "type": "application/vnd.sas.api"
    }
  ],
  "name": "qkbs",
  "accept": "application/vnd.sas.data.quality.qkb",
  "items": [
    {
      "version": "1",
      "name": "QKB_USPOCH",
      "product": "CI",
      "productVersion": "v27",
      "isDefault": false,
      "creationTimeStamp": "2017-01-06T14:59:27.000Z",
      "context": "casqkb",
      "environment": "CAS",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
          "type": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "locales",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.locale"
        }
      ]
    },
    {
      "version": "1",
      "name": "31",
      "productVersion": "v31",
      "isDefault": true,
      "context": "a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f",
      "environment": "compute",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31",
          "uri": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31",
          "type": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs",
          "uri": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "locales",
          "href": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31/locales",
          "uri": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31/locales",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.locale"
        }
      ]
    }
  ],
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. A list of available QKBs was returned.	allQkbsCollection

Get a list of all available QKBs

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts/{contextName}/qkbs

Returns a list of all QKBs in a specified execution environment that are available to the user.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
start	query	integer	false	Specifies a 0-based index of the first QKB to return. Defaults to 0.
limit	query	integer	false	Specifies the maximum number of QKB names to return in a single page of results. The actual number of returned QKBs can be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Specifies filter criteria for the returned QKB names. Filtering is supported on the name, product, version, default, created, context, and environment fields. The supported functions are and, or, not, in, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries Filter by name starting with 'qkb': /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?filter=startsWith(name, 'qkb') Filter by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?filter=eq(name, 'qkb1') Filter for multiple QKBs /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?filter=in(name, 'qkb1', 'qkb2', 'qkb')
sortBy	query	string(sort-criteria)	false	Specifies sort criteria for the returned QKB names. Sorting is supported for the name, product, version, default, created, context, and environment fields. The default sort order is ascending on the name field. Some sample sorts Sort ascending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?sortBy=name:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?sortBy=name:descending
sessionId	query	string	false	Specifies the session identifier.

Example responses

The Qkbs response consists of a collection of Qkbs on a particular execution environment.

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs?sortBy=name&start=0&limit=10",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs?sortBy=name&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/",
      "type": "application/vnd.sas.data.quality.context"
    }
  ],
  "name": "qkbs",
  "accept": "application/vnd.sas.data.quality.qkb",
  "items": [
    {
      "version": "1",
      "name": "QKB_USPOCH",
      "product": "CI",
      "productVersion": "v27",
      "isDefault": false,
      "creationTimeStamp": "2017-01-06T14:59:27.000Z",
      "context": "casqkb",
      "environment": "CAS",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
          "type": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "locales",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.locale"
        }
      ]
    }
  ],
  "version": 2
}

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs?sortBy=name&start=0&limit=10",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs?sortBy=name&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/",
      "type": "application/vnd.sas.data.quality.context"
    }
  ],
  "name": "qkbs",
  "accept": "application/vnd.sas.data.quality.qkb",
  "items": [
    {
      "version": "1",
      "name": "QKB_USPOCH",
      "product": "CI",
      "productVersion": "v27",
      "isDefault": false,
      "creationTimeStamp": "2017-01-06T14:59:27.000Z",
      "context": "casqkb",
      "environment": "CAS",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
          "type": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.qkb"
        },
        {
          "method": "GET",
          "rel": "locales",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.locale"
        }
      ]
    }
  ],
  "version": 2
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. A list of available QKBs was successfully returned.	qkbCollection
404	Not Found	The requested environment or context does not exist.	error2

Get QKB information

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.quality.qkb+json'


const headers = {
  'Accept':'application/vnd.sas.data.quality.qkb+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.quality.qkb+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.quality.qkb+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}

Returns information for a QKB in a specified execution environment.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB in the specified execution environment.
sessionId	query	string	false	Specifies the session identifier.

Example responses

The Qkb response consists of details for a particular qkb.

{
  "version": "1",
  "name": "QKB_USPOCH",
  "product": "CI",
  "productVersion": "v27",
  "isDefault": false,
  "creationTimeStamp": "2017-01-06T14:59:27.000Z",
  "context": "casqkb",
  "environment": "CAS",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
      "type": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "locales",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    }
  ]
}

{
  "version": "1",
  "name": "QKB_USPOCH",
  "product": "CI",
  "productVersion": "v27",
  "isDefault": false,
  "creationTimeStamp": "2017-01-06T14:59:27.000Z",
  "context": "casqkb",
  "environment": "CAS",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
      "type": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    },
    {
      "method": "GET",
      "rel": "locales",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    }
  ]
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. QKB information was successfully returned.	qkb
404	Not Found	The requested qkb does not exist for the given environment and context.	error2

Get headers and verify that QKB exists

Code samples

# You can also use wget
curl -X HEAD https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}
  -H 'Authorization: Bearer <access-token-goes-here>' \


fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}',
{
  method: 'HEAD'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.head('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}')

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

HEAD /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}

Returns header information and verifies that a QKB exists in a specified execution environment.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB.
sessionId	query	string	false	Specifies the session identifier.

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The QKB exists in the specified context.	None
404	Not Found	The requested qkb does not exist for the given environment and context.	None

FieldContentLocale

Contains the operations for field content locale list.

Get list of locales for field content analysis

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/fieldContentLocale \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('https://example.com/dataQuality/fieldContentLocale',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('https://example.com/dataQuality/fieldContentLocale', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/fieldContentLocale", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /fieldContentLocale

Returns a list of all available locale with corresponding language and country that support field content analysis.

Parameters

Name	In	Type	Required	Description
start	query	integer	false	Provides 0-based index of the first locale to return. Defaults to 0.
limit	query	integer	false	Specifies the maximum number of locale to return in one page of results. The actual number of returned locale can be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Specifies filter criteria for the returned locale. Filtering is supported on the language field. The supported functions are and, or, not, in, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries Filter based on language starting with 'Eng': /dataQuality/fieldContentLocale?filter=startsWith(language, 'Eng') Filter by language: /dataQuality/fieldContentLocale?filter=eq(language, 'English') Filter for multiple languages: /dataQuality/fieldContentLocale?filter=in(language, 'English', 'French', 'German')
sortBy	query	string(sort-criteria)	false	Specifies sort criteria for the returned field content locale. Sorting is supported on the language field. The default sort order is ascending on the language field. Some sample sorts Sort ascending by language /dataQuality/fieldContentLocale?sortBy=language:ascending Sort descending by language /dataQuality/fieldContentLocale?sortBy=language:descending

Example responses

The field content locale response consists of a collection of filed content locales available for Data Quality service.

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/fieldContentLocale",
      "uri": "/dataQuality/fieldContentLocale",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/fieldContentLocale?sortBy=language&start=0&limit=10",
      "uri": "/dataQuality/fieldContentLocale?sortBy=language&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/",
      "uri": "/dataQuality/",
      "type": "application/vnd.sas.api"
    },
    {
      "method": "POST",
      "rel": "create",
      "href": "/dataQuality/fieldContentLocale",
      "uri": "/dataQuality/fieldContentLocale",
      "type": "application/vnd.sas.data.quality.field.content.locale",
      "responseType": "application/vnd.sas.data.quality.field.content.locale"
    }
  ],
  "name": "fieldContentLocale",
  "accept": "application/vnd.sas.data.quality.field.content.locale",
  "items": [
    {
      "version": 1,
      "locale": "ENUSA",
      "language": "English",
      "country": "United States",
      "isBootstrappedLocale": "Y",
      "creationTimeStamp": "2022-01-04T18:48:58.737Z",
      "modifiedTimeStamp": "2022-01-04T18:48:58.737Z",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/fieldContentLocale/ENUSA",
          "uri": "/dataQuality/fieldContentLocale/ENUSA",
          "type": "application/vnd.sas.data.quality.field.content.locale"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/fieldContentLocale",
          "uri": "/dataQuality/fieldContentLocale",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.field.content.locale"
        },
        {
          "method": "PUT",
          "rel": "update",
          "href": "/dataQuality/fieldContentLocale/ENUSA",
          "uri": "/dataQuality/fieldContentLocale/ENUSA",
          "type": "application/vnd.sas.data.quality.field.content.locale",
          "responseType": "application/vnd.sas.data.quality.field.content.locale"
        },
        {
          "method": "DELETE",
          "rel": "delete",
          "href": "/dataQuality/fieldContentLocale/ENUSA",
          "uri": "/dataQuality/fieldContentLocale/ENUSA"
        }
      ]
    }
  ],
  "version": 2
}

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/fieldContentLocale",
      "uri": "/dataQuality/fieldContentLocale",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/fieldContentLocale?sortBy=language&start=0&limit=10",
      "uri": "/dataQuality/fieldContentLocale?sortBy=language&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/",
      "uri": "/dataQuality/",
      "type": "application/vnd.sas.api"
    },
    {
      "method": "POST",
      "rel": "create",
      "href": "/dataQuality/fieldContentLocale",
      "uri": "/dataQuality/fieldContentLocale",
      "type": "application/vnd.sas.data.quality.field.content.locale",
      "responseType": "application/vnd.sas.data.quality.field.content.locale"
    }
  ],
  "name": "fieldContentLocale",
  "accept": "application/vnd.sas.data.quality.field.content.locale",
  "items": [
    {
      "version": 1,
      "locale": "ENUSA",
      "language": "English",
      "country": "United States",
      "isBootstrappedLocale": "Y",
      "creationTimeStamp": "2022-01-04T18:48:58.737Z",
      "modifiedTimeStamp": "2022-01-04T18:48:58.737Z",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/fieldContentLocale/ENUSA",
          "uri": "/dataQuality/fieldContentLocale/ENUSA",
          "type": "application/vnd.sas.data.quality.field.content.locale"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/fieldContentLocale",
          "uri": "/dataQuality/fieldContentLocale",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.field.content.locale"
        },
        {
          "method": "PUT",
          "rel": "update",
          "href": "/dataQuality/fieldContentLocale/ENUSA",
          "uri": "/dataQuality/fieldContentLocale/ENUSA",
          "type": "application/vnd.sas.data.quality.field.content.locale",
          "responseType": "application/vnd.sas.data.quality.field.content.locale"
        },
        {
          "method": "DELETE",
          "rel": "delete",
          "href": "/dataQuality/fieldContentLocale/ENUSA",
          "uri": "/dataQuality/fieldContentLocale/ENUSA"
        }
      ]
    }
  ],
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. A list of available field content locale is returned.	fieldContentLocaleCollection

Create new field content locale

Code samples

# You can also use wget
curl -X POST https://example.com/dataQuality/fieldContentLocale \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Content-Type: application/vnd.sas.data.quality.field.content.locale+json' \
  -H 'Accept: application/vnd.sas.data.quality.field.content.locale+json' \
  -H 'Accept: string'

const inputBody = '{
  "locale": "ENUSA",
  "language": "English",
  "country": "United States"
}';
const headers = {
  'Content-Type':'application/vnd.sas.data.quality.field.content.locale+json',
  'Accept':'application/vnd.sas.data.quality.field.content.locale+json',
  'Accept':'string'
};

fetch('https://example.com/dataQuality/fieldContentLocale',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/vnd.sas.data.quality.field.content.locale+json',
  'Accept': 'application/vnd.sas.data.quality.field.content.locale+json',
  'Accept': 'string'
}

r = requests.post('https://example.com/dataQuality/fieldContentLocale', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/vnd.sas.data.quality.field.content.locale+json"},
        "Accept": []string{"application/vnd.sas.data.quality.field.content.locale+json"},
        "Accept": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://example.com/dataQuality/fieldContentLocale", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /fieldContentLocale

Create a new field content locale with provided information.

Body parameter

The field content request body consists of details required to add a new field content locale.

{
  "locale": "ENUSA",
  "language": "English",
  "country": "United States"
}

Parameters

Name	In	Type	Required	Description
Accept	header	string	false	The requested representation of the response. The media type application/vnd.sas.data.quality.field.content.locale+json is the default.
body	body	fieldContentLocale	false	none

Example responses

The field content locale response consists of details for the newly created field content locale..

{
  "version": 1,
  "locale": "ENUSA",
  "language": "English",
  "country": "United States",
  "isBootstrappedLocale": "Y",
  "creationTimeStamp": "2022-01-04T18:48:58.737Z",
  "modifiedTimeStamp": "2022-01-04T18:48:58.737Z",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA",
      "type": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/fieldContentLocale",
      "uri": "/dataQuality/fieldContentLocale",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA",
      "type": "application/vnd.sas.data.quality.field.content.locale",
      "responseType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA"
    }
  ]
}

{
  "version": 1,
  "locale": "ENUSA",
  "language": "English",
  "country": "United States",
  "isBootstrappedLocale": "Y",
  "creationTimeStamp": "2022-01-04T18:48:58.737Z",
  "modifiedTimeStamp": "2022-01-04T18:48:58.737Z",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA",
      "type": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/fieldContentLocale",
      "uri": "/dataQuality/fieldContentLocale",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA",
      "type": "application/vnd.sas.data.quality.field.content.locale",
      "responseType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA"
    }
  ]
}

400 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
201	Created	The field content locale was successfully created.	fieldContentLocale
400	Bad Request	The request was invalid. An invalid combination of request parameters was provided.	error2

Response Headers

Status	Header	Type	Format	Description
201	ETag	string		The caching key for future requests.
201	Location	string		The URL of the created resource.

Get details about a field content locale

Code samples

# You can also use wget
curl -X HEAD https://example.com/dataQuality/fieldContentLocale/{locale}
  -H 'Authorization: Bearer <access-token-goes-here>' \


fetch('https://example.com/dataQuality/fieldContentLocale/{locale}',
{
  method: 'HEAD'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.head('https://example.com/dataQuality/fieldContentLocale/{locale}')

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "https://example.com/dataQuality/fieldContentLocale/{locale}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

HEAD /fieldContentLocale/{locale}

Returns information about a specified field content locale.

Parameters

Name	In	Type	Required	Description
locale	path	string	true	Specifies the field content locale.

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The specified field content locle exists.	None
404	Not Found	The requested field content locale does not exist.	None

Response Headers

Status	Header	Type	Format	Description
200	ETag	string		A tag that identifies this revision of this object.

Update field content locale by locale

Code samples

# You can also use wget
curl -X PUT https://example.com/dataQuality/fieldContentLocale/{locale} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Content-Type: application/vnd.sas.data.quality.field.content.locale+json' \
  -H 'Accept: application/vnd.sas.data.quality.field.content.locale+json' \
  -H 'If-Match: 0' \
  -H 'Accept: string'

const inputBody = '{
  "locale": "ENUSA",
  "language": "English",
  "country": "United States"
}';
const headers = {
  'Content-Type':'application/vnd.sas.data.quality.field.content.locale+json',
  'Accept':'application/vnd.sas.data.quality.field.content.locale+json',
  'If-Match':'0',
  'Accept':'string'
};

fetch('https://example.com/dataQuality/fieldContentLocale/{locale}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/vnd.sas.data.quality.field.content.locale+json',
  'Accept': 'application/vnd.sas.data.quality.field.content.locale+json',
  'If-Match': '0',
  'Accept': 'string'
}

r = requests.put('https://example.com/dataQuality/fieldContentLocale/{locale}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/vnd.sas.data.quality.field.content.locale+json"},
        "Accept": []string{"application/vnd.sas.data.quality.field.content.locale+json"},
        "If-Match": []string{"0"},
        "Accept": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://example.com/dataQuality/fieldContentLocale/{locale}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /fieldContentLocale/{locale}

Update field content locale by locale. Only a user defined field content locale can be updated. The out of the box field content locale cannot be updated by the user.

Body parameter

The field content request body consists of details required to add a new field content locale.

{
  "locale": "ENUSA",
  "language": "English",
  "country": "United States"
}

Parameters

Name	In	Type	Required	Description
locale	path	string	true	Specifies the locale value of the Field Content Locale.
If-Match	header	integer	true	Value corresponding to the current state of the field content locale being modified. A client will get this value from the etag header which is returned from a get Field Content Locale call.
Accept	header	string	false	The requested representation of the response. The media type application/vnd.sas.data.quality.field.content.locale+json is the default.
body	body	fieldContentLocale	true	none

Example responses

The field content locale response consists of a details for a particular field content locale.

{
  "version": 1,
  "locale": "ENUSA",
  "language": "English",
  "country": "United States",
  "isBootstrappedLocale": "Y",
  "creationTimeStamp": "2022-01-04T18:48:58.737Z",
  "modifiedTimeStamp": "2022-01-04T18:48:58.737Z",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA",
      "type": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/fieldContentLocale",
      "uri": "/dataQuality/fieldContentLocale",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA",
      "type": "application/vnd.sas.data.quality.field.content.locale",
      "responseType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA"
    }
  ]
}

{
  "version": 1,
  "locale": "ENUSA",
  "language": "English",
  "country": "United States",
  "isBootstrappedLocale": "Y",
  "creationTimeStamp": "2022-01-04T18:48:58.737Z",
  "modifiedTimeStamp": "2022-01-04T18:48:58.737Z",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA",
      "type": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/fieldContentLocale",
      "uri": "/dataQuality/fieldContentLocale",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA",
      "type": "application/vnd.sas.data.quality.field.content.locale",
      "responseType": "application/vnd.sas.data.quality.field.content.locale"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataQuality/fieldContentLocale/ENUSA",
      "uri": "/dataQuality/fieldContentLocale/ENUSA"
    }
  ]
}

400 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. Information was returned for the specified field content locale.	fieldContentLocale
400	Bad Request	Invalid input	error2
404	Not Found	The requested field content locale does not exist.	error2
412	Precondition Failed	Precondition Failed.	error2
428	Precondition Required	Precondition Required.	error2

Response Headers

Status	Header	Type	Format	Description
200	ETag	string		A tag that identifies this revision of this object.

Delete a field content locale

Code samples

# You can also use wget
curl -X DELETE https://example.com/dataQuality/fieldContentLocale/{locale} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.error+json'


const headers = {
  'Accept':'application/vnd.sas.error+json'
};

fetch('https://example.com/dataQuality/fieldContentLocale/{locale}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.error+json'
}

r = requests.delete('https://example.com/dataQuality/fieldContentLocale/{locale}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.error+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://example.com/dataQuality/fieldContentLocale/{locale}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /fieldContentLocale/{locale}

Deletes a field content locale. Only user defined field content locale can be deleted. The out of the box field content locale cannot be deleted by the user.

Parameters

Name	In	Type	Required	Description
locale	path	string	true	Specifies the locale value of the Field Content Locale.

Example responses

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
204	No Content	Field content locale deleted	None
404	Not Found	Field content locale does not exist	error2

Environments

Contains the operations for execution environments.

Get list of available execution environments

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('https://example.com/dataQuality/environments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('https://example.com/dataQuality/environments', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments

Returns a list of all of the execution environments that are available to the user.

Parameters

Name	In	Type	Required	Description
start	query	integer	false	Provides 0-based index of the first execution environment to return. Defaults to 0.
limit	query	integer	false	Specifies the maximum number of environments to return in one page of results. The actual number of returned contexts can be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Specifies filter criteria for the returned execution environments. Filtering is supported on the name field. The supported functions are and, or, not, in, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries Filter based on names starting with 'env': /dataQuality/environments/{environmentName}/contexts?filter=startsWith(name, 'env') Filter by name: /dataQuality/environments/{environmentName}/contexts?filter=eq(id, 'context1') Filter for multiple names: /dataQuality/environments/{environmentName}/contexts?filter=in(name, 'context1', 'context2', 'context3')
sortBy	query	string(sort-criteria)	false	Specifies sort criteria for the returned execution environments. Sorting is supported on the name field. The default sort order is ascending on the name field. Some sample sorts Sort ascending by name /dataQuality/environments/{environmentName}/contexts?sortBy=name:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts?sortBy=name:descending

Example responses

The environments response consists of a collection of execution environments available for Data Quality service.

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments",
      "uri": "/dataQuality/environments",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.environment"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments?sortBy=name&start=0&limit=10",
      "uri": "/dataQuality/environments?sortBy=name&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.environment"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/",
      "uri": "/dataQuality/",
      "type": "application/vnd.sas.api"
    }
  ],
  "name": "environments",
  "accept": "application/vnd.sas.data.quality.environment",
  "items": [
    {
      "version": 1,
      "name": "CAS",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS",
          "uri": "/dataQuality/environments/CAS",
          "type": "application/vnd.sas.data.quality.environment"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments",
          "uri": "/dataQuality/environments",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.environment"
        },
        {
          "method": "GET",
          "rel": "contexts",
          "href": "/dataQuality/environments/CAS/contexts",
          "uri": "/dataQuality/environments/CAS/contexts",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.context"
        }
      ]
    }
  ],
  "version": 2
}

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments",
      "uri": "/dataQuality/environments",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.environment"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments?sortBy=name&start=0&limit=10",
      "uri": "/dataQuality/environments?sortBy=name&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.environment"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/",
      "uri": "/dataQuality/",
      "type": "application/vnd.sas.api"
    }
  ],
  "name": "environments",
  "accept": "application/vnd.sas.data.quality.environment",
  "items": [
    {
      "version": 1,
      "name": "CAS",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS",
          "uri": "/dataQuality/environments/CAS",
          "type": "application/vnd.sas.data.quality.environment"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments",
          "uri": "/dataQuality/environments",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.environment"
        },
        {
          "method": "GET",
          "rel": "contexts",
          "href": "/dataQuality/environments/CAS/contexts",
          "uri": "/dataQuality/environments/CAS/contexts",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.context"
        }
      ]
    }
  ],
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. A list of available execution environments was returned.	environmentCollection

Get details about an execution environment

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.quality.environment+json'


const headers = {
  'Accept':'application/vnd.sas.data.quality.environment+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.quality.environment+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.quality.environment+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}

Returns information about a specified execution environment.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.

Example responses

The environment response consists of a details for a particular execution environment.

{
  "version": 1,
  "name": "CAS",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS",
      "uri": "/dataQuality/environments/CAS",
      "type": "application/vnd.sas.data.quality.environment"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments",
      "uri": "/dataQuality/environments",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.environment"
    },
    {
      "method": "GET",
      "rel": "contexts",
      "href": "/dataQuality/environments/CAS/contexts",
      "uri": "/dataQuality/environments/CAS/contexts",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.context"
    }
  ]
}

{
  "version": 1,
  "name": "CAS",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS",
      "uri": "/dataQuality/environments/CAS",
      "type": "application/vnd.sas.data.quality.environment"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments",
      "uri": "/dataQuality/environments",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.environment"
    },
    {
      "method": "GET",
      "rel": "contexts",
      "href": "/dataQuality/environments/CAS/contexts",
      "uri": "/dataQuality/environments/CAS/contexts",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.context"
    }
  ]
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. Information was returned for the specified execution environment.	environment
404	Not Found	The requested environment does not exist.	error2

Get headers and verify that execution environment exists

Code samples

# You can also use wget
curl -X HEAD https://example.com/dataQuality/environments/{environmentName}
  -H 'Authorization: Bearer <access-token-goes-here>' \


fetch('https://example.com/dataQuality/environments/{environmentName}',
{
  method: 'HEAD'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.head('https://example.com/dataQuality/environments/{environmentName}')

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "https://example.com/dataQuality/environments/{environmentName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

HEAD /environments/{environmentName}

Returns header information and verifies the existence of a specified execution environment.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The specified execution environment exists.	None
404	Not Found	The requested environment does not exist.	None

Contexts

Contains the operations for execution contexts.

Get list of available execution contexts

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts

Returns a list of all of the execution environments that are available to the user.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
start	query	integer	false	Specifies a 0-based index of the first execution environment to return. Defaults to 0.
limit	query	integer	false	Specifies the maximum number of execution environments to return in one page of results. The actual number of returned execution environments can be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Specifies filter criteria for the returned execution environments. Filtering is supported on the name, type, description, host, port, and restPort fields. The supported functions are and, or, not, in, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries Filter based on names starting with 'env': /dataQuality/environments/{environmentName}/contexts?filter=startsWith(name, 'env') Filter by name: /dataQuality/environments/{environmentName}/contexts?filter=eq(id, 'context1') Filter for multiple names: /dataQuality/environments/{environmentName}/contexts?filter=in(name, 'context1', 'context2', 'context3')
sortBy	query	string(sort-criteria)	false	Specifies sort criteria for the list of returned execution environments. Sorting is supported on the name, type, description, host, port, and restPort fields. The default sort order is ascending on the name field. Some sample sorts Sort ascending by name /dataQuality/environments/{environmentName}/contexts?sortBy=name:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts?sortBy=name:descending

Example responses

The contexts collection response consists of a list of contexts available on a particular execution environment.

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts",
      "uri": "/dataQuality/environments/CAS/contexts",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.context"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts?sortBy=name&start=0&limit=10",
      "uri": "/dataQuality/environments/CAS/contexts?sortBy=name&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.context"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/",
      "uri": "/dataQuality/environments/CAS/",
      "type": "application/vnd.sas.collection"
    }
  ],
  "name": "contexts",
  "accept": "application/vnd.sas.data.quality.context",
  "items": [
    {
      "version": 1,
      "name": "casqkb",
      "type": "CAS",
      "description": "controller",
      "host": "server.example.com",
      "state": "running",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb",
          "type": "application/vnd.sas.data.quality.context"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts",
          "uri": "/dataQuality/environments/CAS/contexts",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.context"
        },
        {
          "method": "GET",
          "rel": "qkbs",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.qkb"
        }
      ]
    }
  ],
  "version": 2
}

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts",
      "uri": "/dataQuality/environments/CAS/contexts",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.context"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts?sortBy=name&start=0&limit=10",
      "uri": "/dataQuality/environments/CAS/contexts?sortBy=name&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.context"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/",
      "uri": "/dataQuality/environments/CAS/",
      "type": "application/vnd.sas.collection"
    }
  ],
  "name": "contexts",
  "accept": "application/vnd.sas.data.quality.context",
  "items": [
    {
      "version": 1,
      "name": "casqkb",
      "type": "CAS",
      "description": "controller",
      "host": "server.example.com",
      "state": "running",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb",
          "type": "application/vnd.sas.data.quality.context"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts",
          "uri": "/dataQuality/environments/CAS/contexts",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.context"
        },
        {
          "method": "GET",
          "rel": "qkbs",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.qkb"
        }
      ]
    }
  ],
  "version": 2
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. A sorted list of available execution environments was returned.	contextCollection
404	Not Found	The requested environment does not exist.	error2

Get context details

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.quality.context+json'


const headers = {
  'Accept':'application/vnd.sas.data.quality.context+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.quality.context+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.quality.context+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts/{contextName}

Returns information about a specified execution environment.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
sessionId	query	string	false	Specifies the session identifier.

Example responses

The context response consists of details for a particular context.

{
  "version": 1,
  "name": "casqkb",
  "type": "CAS",
  "description": "controller",
  "host": "example.com",
  "state": "running",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb",
      "type": "application/vnd.sas.data.quality.context"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts",
      "uri": "/dataQuality/environments/CAS/contexts",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.context"
    },
    {
      "method": "GET",
      "rel": "qkbs",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    }
  ]
}

{
  "version": 1,
  "name": "casqkb",
  "type": "CAS",
  "description": "controller",
  "host": "example.com",
  "state": "running",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb",
      "type": "application/vnd.sas.data.quality.context"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts",
      "uri": "/dataQuality/environments/CAS/contexts",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.context"
    },
    {
      "method": "GET",
      "rel": "qkbs",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.qkb"
    }
  ]
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. Context information was returned.	context
404	Not Found	The requested environment or context does not exist.	error2

Get headers and verify existence of a context

Code samples

# You can also use wget
curl -X HEAD https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}
  -H 'Authorization: Bearer <access-token-goes-here>' \


fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}',
{
  method: 'HEAD'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.head('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}')

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

HEAD /environments/{environmentName}/contexts/{contextName}

Returns header information and verifies that an execution environment exists.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of an execution environment.
contextName	path	string	true	Specifies the name of an execution environment.
sessionId	query	string	false	Specifies the session identifier.

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The specified context exists.	None
404	Not Found	The requested environment or context does not exist.	None

Locale

Contains the operations for the QKB locale resource.

Get a locale list

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales

Returns a list of the locales in a specified QKB and execution environment.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB.
start	query	integer	false	Specifies a 0-based index of the first locale to return. Defaults to 0.
limit	query	integer	false	Specifies the maximum number of locales to return in a single page of results. The actual number of returned locales can be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Specifies filter criteria for the returned locales. Filtering is supported on the name and description fields. The supported functions are and, or, not, in, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries Filter by name starting with 'EN': /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales?filter=startsWith(name, 'EN') Filter by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales?filter=eq(name, 'AFZAF') Filter for multiple locales /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales?filter=in(name, 'ENUSA', 'ENGBR')
sortBy	query	string(sort-criteria)	false	Specifies sort criteria for the returned locales. Sorting is supported on the name and description fields. The default sort order is ascending on the name field. Some sample sorts Sort ascending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales?sortBy=name:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales?sortBy=name:descending
sessionId	query	string	false	Specifies the session identifier.

Example responses

The QKBs response consists of a collection of qkbs available on all execution environments.

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "next",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=2&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=2&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "last",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=2&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=2&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=0&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=0&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/",
      "type": "application/vnd.sas.data.quality.qkb"
    }
  ],
  "name": "locales",
  "accept": "application/vnd.sas.data.quality.locale",
  "items": [
    {
      "version": 1,
      "name": "ENUSA",
      "description": "English (United States)",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA",
          "type": "application/vnd.sas.data.quality.locale"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.locale"
        },
        {
          "method": "GET",
          "rel": "functions",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.function"
        }
      ]
    },
    {
      "version": 1,
      "name": "PLPOL",
      "description": "Polish (Poland)",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/PLPOL",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/PLPOL",
          "type": "application/vnd.sas.data.quality.locale"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.locale"
        },
        {
          "method": "GET",
          "rel": "functions",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/PLPOL/functions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/PLPOL/functions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.function"
        }
      ]
    }
  ],
  "version": 2
}

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "next",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=2&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=2&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "last",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=2&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=2&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=0&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales?sortBy=name&start=0&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/",
      "type": "application/vnd.sas.data.quality.qkb"
    }
  ],
  "name": "locales",
  "accept": "application/vnd.sas.data.quality.locale",
  "items": [
    {
      "version": 1,
      "name": "ENUSA",
      "description": "English (United States)",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA",
          "type": "application/vnd.sas.data.quality.locale"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.locale"
        },
        {
          "method": "GET",
          "rel": "functions",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.function"
        }
      ]
    },
    {
      "version": 1,
      "name": "PLPOL",
      "description": "Polish (Poland)",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/PLPOL",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/PLPOL",
          "type": "application/vnd.sas.data.quality.locale"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.locale"
        },
        {
          "method": "GET",
          "rel": "functions",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/PLPOL/functions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/PLPOL/functions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.function"
        }
      ]
    }
  ],
  "version": 2
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. A list of available locales was successfully returned.	localeCollection
404	Not Found	The requested qkb does not exist for the given environment and context.	error2

Get QKB locale information

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.quality.locale+json'


const headers = {
  'Accept':'application/vnd.sas.data.quality.locale+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.quality.locale+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.quality.locale+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}

Returns locale information for a specified QKB and execution environment.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB in the specified execution environment.
localeName	path	string	true	Specifies the name of the locale in the specified QKB.
sessionId	query	string	false	Specifies the session ID.

Example responses

The locale response consists of details for a particular locale.

{
  "version": 1,
  "name": "ENUSA",
  "description": "English (United States)",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA",
      "type": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "functions",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    }
  ]
}

{
  "version": 1,
  "name": "ENUSA",
  "description": "English (United States)",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA",
      "type": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.locale"
    },
    {
      "method": "GET",
      "rel": "functions",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    }
  ]
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. Locale information was successfully returned.	locale
404	Not Found	The requested locale does not exist for the specified qkb.	error2

Get headers and verify that locale exists

Code samples

# You can also use wget
curl -X HEAD https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}
  -H 'Authorization: Bearer <access-token-goes-here>' \


fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}',
{
  method: 'HEAD'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.head('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}')

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

HEAD /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}

Returns header information and verifies that a locale exists in a specified QKB and execution environment.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB in the specified execution environment.
localeName	path	string	true	Specifies the name of locale in the specified QKB.
sessionId	query	string	false	Specifies the session identifier.

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The specified locale exists in the specified QKB.	None
404	Not Found	The requested locale does not exist for the specified qkb.	None

Function

Contains the operations for QKB functions.

Get supported functions for a locale

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions

Returns a list of functions that are supported by a specified locale, QKB, and execution environment.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of an execution environment.
contextName	path	string	true	Specifies the name of an execution environment.
qkbName	path	string	true	Specifies the name of a QKB in the specified execution environment.
localeName	path	string	true	Specifies the name of a locale in the specified QKB.
start	query	integer	false	Specifies a 0-based index of the first function to return. Defaults to 0.
limit	query	integer	false	Specifies the maximum number of functions to return in a single page of results. The actual number of returned functions can be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Specifies filter criteria for the returned functions. Filtering is supported on the name field. The supported functions are and, or, not, in, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries Search by name starting with 'M': /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions?filter=startsWith(name, 'M') Search by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions?filter=eq(name, 'Standardization') Filter for multiple functions /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions?filter=in(name, 'Match','Standardization')
sortBy	query	string(sort-criteria)	false	Specifies sort criteria for the returned functions. Sorting is supported on the name field. The default sort order is ascending on the name field. Some sample sorts Sort ascending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions?sortBy=name:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions?sortBy=name:descending
sessionId	query	string	false	Specifies the session identifier.

Example responses

The Functions response consists of a collection of functions available for a particular locale.

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "next",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=2&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=2&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "last",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=8&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=8&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=0&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=0&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/",
      "type": "application/vnd.sas.data.quality.locale"
    }
  ],
  "name": "functions",
  "accept": "application/vnd.sas.data.quality.function",
  "items": [
    {
      "version": 1,
      "name": "Case",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Case",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Case",
          "type": "application/vnd.sas.data.quality.function"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.function"
        },
        {
          "method": "GET",
          "rel": "definitions",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Case/definitions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Case/definitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.definition"
        }
      ]
    },
    {
      "version": 1,
      "name": "Extraction",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Extraction",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Extraction",
          "type": "application/vnd.sas.data.quality.function"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.function"
        },
        {
          "method": "GET",
          "rel": "definitions",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Extraction/definitions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Extraction/definitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.definition"
        }
      ]
    }
  ],
  "version": 2
}

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "next",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=2&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=2&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "last",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=8&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=8&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=0&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions?sortBy=name&start=0&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/",
      "type": "application/vnd.sas.data.quality.locale"
    }
  ],
  "name": "functions",
  "accept": "application/vnd.sas.data.quality.function",
  "items": [
    {
      "version": 1,
      "name": "Case",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Case",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Case",
          "type": "application/vnd.sas.data.quality.function"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.function"
        },
        {
          "method": "GET",
          "rel": "definitions",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Case/definitions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Case/definitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.definition"
        }
      ]
    },
    {
      "version": 1,
      "name": "Extraction",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Extraction",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Extraction",
          "type": "application/vnd.sas.data.quality.function"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.function"
        },
        {
          "method": "GET",
          "rel": "definitions",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Extraction/definitions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Extraction/definitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.definition"
        }
      ]
    }
  ],
  "version": 2
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. A list of available functions was returned for the specified locale and QKB.	functionCollection
404	Not Found	The requested locale does not exist for the specified qkb.	error2

Get function information

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.quality.function+json'


const headers = {
  'Accept':'application/vnd.sas.data.quality.function+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.quality.function+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.quality.function+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}

Returns function information for a specified locale, QKB, and execution environment.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB in the specified execution environment.
localeName	path	string	true	Specifies the name of the locale that is supported by the specified QKB.
functionName	path	string	true	Specifies the name of the function that is supported by the locale and QKB.
sessionId	query	string	false	Specifies the session identifier.

Example responses

The function response consists of details for the particular function.

{
  "version": 1,
  "name": "Match",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match",
      "type": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "definitions",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    }
  ]
}

{
  "version": 1,
  "name": "Match",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match",
      "type": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.function"
    },
    {
      "method": "GET",
      "rel": "definitions",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    }
  ]
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. Function information was returned for the specified locale and QKB.	function
404	Not Found	The requested function does not exist for the specified qkb and locale.	error2

Get headers and verify that a function is available for locale

Code samples

# You can also use wget
curl -X HEAD https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}
  -H 'Authorization: Bearer <access-token-goes-here>' \


fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}',
{
  method: 'HEAD'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.head('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}')

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

HEAD /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}

Returns header information and verifies that a function is available for a given locale, QKB, and context.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB in the specified execution environment.
localeName	path	string	true	Specifies the name of the locale that is supported by the specified QKB.
functionName	path	string	true	Specifies the name of the function that is supported by the specified QKB and locale.
sessionId	query	string	false	Specifies the session identifier.

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The function exists and is supported by the specified QKB and locale.	None
404	Not Found	The requested function does not exist for the specified qkb and locale.	None

Definitions

Contains the operations for QKB definitions.

Get a list of data quality definitions

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions

Returns a list of data quality definitions that are supported by a specified locale and QKB.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB that is available in the specified execution environment.
localeName	path	string	true	Specifies the name of the locale that is supported by the specified QKB.
functionName	path	string	true	Specifies the name of the data quality definition that is supported by the specified QKB and locale.
start	query	integer	false	Specifies a 0-based index of the first definition to return. Defaults to 0.
limit	query	integer	false	Specifies a maximum number of definitions to return in a single page of results. The actual number of returned definitions can be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Specifies filter criteria for the returned definitions. Filtering is supported on the name field. The supported functions are and, or, not, in, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries Filter by name starting with 'A': /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions?filter=startsWith(name, 'A') Filter by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions?filter=eq(name, 'Account Number') Search for multiple definitions /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions?filter=in(name, 'Account Number', 'Address', 'Business Title')
sortBy	query	string(sort-criteria)	false	Specifies sort criteria for the returned definitions. Sorting is supported on the name field. The default sort order is ascending on the name field. Some sample sorts Sort ascending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions?sortBy=id:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions?sortBy=name:descending
sessionId	query	string	false	Specifies the session identifier.

Example responses

The Definitions response consists of a collection of definitions available for the particular function.

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "next",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=2&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=2&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "last",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=24&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=24&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=0&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=0&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/",
      "type": "application/vnd.sas.data.quality.function"
    }
  ],
  "name": "definitions",
  "accept": "application/vnd.sas.data.quality.definition",
  "items": [
    {
      "version": 1,
      "name": "Account Number",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number",
          "type": "application/vnd.sas.data.quality.definition"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.definition"
        },
        {
          "method": "GET",
          "rel": "tokens",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number/tokens",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number/tokens",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.token"
        }
      ]
    },
    {
      "version": 1,
      "name": "Address",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address",
          "type": "application/vnd.sas.data.quality.definition"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.definition"
        },
        {
          "method": "GET",
          "rel": "tokens",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.token"
        }
      ]
    }
  ],
  "version": 2
}

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "next",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=2&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=2&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "last",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=24&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=24&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=0&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=0&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/",
      "type": "application/vnd.sas.data.quality.function"
    }
  ],
  "name": "definitions",
  "accept": "application/vnd.sas.data.quality.definition",
  "items": [
    {
      "version": 1,
      "name": "Account Number",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number",
          "type": "application/vnd.sas.data.quality.definition"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.definition"
        },
        {
          "method": "GET",
          "rel": "tokens",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number/tokens",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number/tokens",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.token"
        }
      ]
    },
    {
      "version": 1,
      "name": "Address",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address",
          "type": "application/vnd.sas.data.quality.definition"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.definition"
        },
        {
          "method": "GET",
          "rel": "tokens",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.token"
        }
      ]
    }
  ],
  "version": 2
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. Data quality definitions were returned for the specified QKB and locale.	definitionCollection
404	Not Found	The requested function does not exist for the specified qkb and locale.	error2

Get definition information

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.quality.definition+json'


const headers = {
  'Accept':'application/vnd.sas.data.quality.definition+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.quality.definition+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.quality.definition+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}

Returns definition information for a given QKB, locale, and function.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB in the specified execution environment.
localeName	path	string	true	Specifies the name of the locale that is supported by the specified QKB.
definitionName	path	string	true	Specifies the name of the definition that is supported by the specified QKB and locale.
functionName	path	string	true	Specifies the name of the function that is supported by the specified QKB and locale.
sessionId	query	string	false	Specifies the session identifier.

Example responses

The definition response consists of a details for a particular definition.

{
  "version": 1,
  "name": "Address",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address",
      "type": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "tokens",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    }
  ]
}

{
  "version": 1,
  "name": "Address",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address",
      "type": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.definition"
    },
    {
      "method": "GET",
      "rel": "tokens",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    }
  ]
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. Information was returned for the specified data quality definition.	definition
404	Not Found	The requested definition does not exist for the specified qkb, locale and function.	error2

Get headers and verify that a definition exists

Code samples

# You can also use wget
curl -X HEAD https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}
  -H 'Authorization: Bearer <access-token-goes-here>' \


fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}',
{
  method: 'HEAD'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.head('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}')

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

HEAD /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}

Returns header information and verifies that a definition exists in a given QKB and locale.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB on the specified execution environment.
localeName	path	string	true	Specifies the name of the locale that is supported by the specified QKB.
functionName	path	string	true	Specifies the name of the function that is supported by the specified QKB and locale.
definitionName	path	string	true	Specifies the name of the definition that is supported by the specified function, QKB, and locale.
sessionId	query	string	false	Specifies the session identifier.

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The data quality definition exists in the specified context.	None
404	Not Found	The requested definition does not exist for the specified qkb, locale and function.	None

Tokens

Contains the operations for QKB tokens.

Get a token list from a QKB

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens

Returns a list of tokens for a specified data quality function, definition. QKB, and locale.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB in the specified execution environment.
localeName	path	string	true	Specifies the name of the locale that is supported by the specified QKB.
functionName	path	string	true	Specifies the name of the function that is supported by the specified QKB and locale.
definitionName	path	string	true	Specifies the name of the definition that is supported by the specified QKB and locale.
start	query	integer	false	Specifies a 0-based index of the first locale to return. Defaults to 0.
limit	query	integer	false	Specifies the maximum number of tokens to return in a single page of results. The actual number of returned tokens can be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Specifies filter criteria for the returned tokens. Filtering is supported on the name field. The supported functions are and, or, not, in, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries Filter by name starting with 'A': /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions/Address/tokens?filter=startsWith(name, 'A') Filter by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions/Address/tokens?filter=eq(name, 'Extension') Filter for multiple tokens /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales?filter=in(id, 'locale1', 'locale2', 'locale3')
sortBy	query	string(sort-criteria)	false	Specifies sort criteria for the returned tokens. The only valid sorting option is the name field. The default sort order is ascending on the name field. Some sample sorts Sort ascending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/tokens?sortBy=name:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/tokens?sortBy=name:descending
sessionId	query	string	false	Specifies the session identifier.

Example responses

The QKBs response consists of a collection of qkbs available on all execution environments.

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    },
    {
      "method": "GET",
      "rel": "next",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=2&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=2&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    },
    {
      "method": "GET",
      "rel": "last",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=8&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=8&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=0&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=0&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/",
      "type": "application/vnd.sas.data.quality.definition"
    }
  ],
  "name": "tokens",
  "accept": "application/vnd.sas.data.quality.token",
  "items": [
    {
      "version": 1,
      "name": "Building/Site",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/Building/Site",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/Building/Site",
          "type": "application/vnd.sas.data.quality.token"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.token"
        }
      ]
    },
    {
      "version": 1,
      "name": "DD_Only",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/DD_Only",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/DD_Only",
          "type": "application/vnd.sas.data.quality.token"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.token"
        }
      ]
    }
  ],
  "version": 2
}

{
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    },
    {
      "method": "GET",
      "rel": "next",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=2&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=2&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    },
    {
      "method": "GET",
      "rel": "last",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=8&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=8&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=0&limit=2",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens?sortBy=name&start=0&limit=2",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/",
      "type": "application/vnd.sas.data.quality.definition"
    }
  ],
  "name": "tokens",
  "accept": "application/vnd.sas.data.quality.token",
  "items": [
    {
      "version": 1,
      "name": "Building/Site",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/Building/Site",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/Building/Site",
          "type": "application/vnd.sas.data.quality.token"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.token"
        }
      ]
    },
    {
      "version": 1,
      "name": "DD_Only",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/DD_Only",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/DD_Only",
          "type": "application/vnd.sas.data.quality.token"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.quality.token"
        }
      ]
    }
  ],
  "version": 2
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. A list of available tokens was returned for the specified context.	tokenCollection
404	Not Found	The requested definition does not exist for the specified qkb, locale and function.	error2

Get information about a token

Code samples

# You can also use wget
curl -X GET https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.quality.token+json'


const headers = {
  'Accept':'application/vnd.sas.data.quality.token+json'
};

fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.quality.token+json'
}

r = requests.get('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.quality.token+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}

Returns information about a token from a specified QKB, locale, function, and definition.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB on the specified execution environment.
localeName	path	string	true	Specifies the name of the locale that is supported by the specified QKB.
functionName	path	string	true	Specifies the name of the function that is supported by the specified locale and QKB.
definitionName	path	string	true	Specifies the name of the data quality definition that is supported by the specified locale and QKB.
tokenName	path	string	true	Specifies the name of the token that is supported by the specified definition, function, locale, and QKB.
sessionId	query	string	false	Specifies the session identifier.

Example responses

The Token response consists of details for a particular token.

{
  "version": 1,
  "name": "PO Box",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/PO%20Box",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/PO%20Box",
      "type": "application/vnd.sas.data.quality.token"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    }
  ]
}

{
  "version": 1,
  "name": "PO Box",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/PO%20Box",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/PO%20Box",
      "type": "application/vnd.sas.data.quality.token"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.quality.token"
    }
  ]
}

404 Response

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. Token information was returned for the specified context.	token
404	Not Found	The requested token does not exist for the specified qkb, locale, function and definition.	error2

Get headers and verify that a token exists in a given definition

Code samples

# You can also use wget
curl -X HEAD https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}
  -H 'Authorization: Bearer <access-token-goes-here>' \


fetch('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}',
{
  method: 'HEAD'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.head('https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}')

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "https://example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

HEAD /environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}

Returns header information and verifies that a token exists in a specified data quality definition.

Parameters

Name	In	Type	Required	Description
environmentName	path	string	true	Specifies the name of the execution environment.
contextName	path	string	true	Specifies the name of the execution environment.
qkbName	path	string	true	Specifies the name of the QKB in the specified execution environment.
localeName	path	string	true	Specifies the name of the locale that is supported by the specified QKB.
functionName	path	string	true	Specifies the name of the function that is supported by the specified QKB and locale.
definitionName	path	string	true	Specifies the name of the data quality definition that is supported by the specified QKB and locale.
tokenName	path	string	true	Specifies the name of the token for the specified function, definition, locale, and QKB.
sessionId	query	string	false	Specifies the session identifier.

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The token exists in the specified context.	None
404	Not Found	The requested token does not exist for the specified qkb, locale, function and definition.	None

Schemas

api

{
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "version": 0
}

API

Properties

Name	Type	Required	Restrictions	Description
links	links	true	none	Provides zero or more links to related resources and actions.
version	integer(int32)	true	none	The version of the media-type that represents this API.

fieldContentLocale

{
  "version": 0,
  "locale": "string",
  "language": "string",
  "country": "string",
  "isBootstrappedLocale": "string",
  "creationTimeStamp": "2019-08-24T14:15:22Z",
  "modifiedTimeStamp": "2019-08-24T14:15:22Z",
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ]
}

FieldContentLocale

Properties

Name	Type	Required	Restrictions	Description
version	integer	false	none	Media-type version.
locale	string	false	none	The locale code for field content analysis.
language	string	false	none	The language for field content analysis.
country	string	false	none	The country for field content analysis.
isBootstrappedLocale	string	false	none	Flag to indicate of a locale is bootstrapped or user-defined.
creationTimeStamp	string(date-time)	false	none	Provides the creation timestamp for the locale.
modifiedTimeStamp	string(date-time)	false	none	Provides the modified timestamp for the locale.
links	[link]	false	none	Links that apply to this field content locale,

fieldContentLocaleCollection

{
  "name": "string",
  "accept": "string",
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "items": [
    {
      "version": 0,
      "locale": "string",
      "language": "string",
      "country": "string",
      "isBootstrappedLocale": "string",
      "creationTimeStamp": "2019-08-24T14:15:22Z",
      "modifiedTimeStamp": "2019-08-24T14:15:22Z",
      "links": [
        {
          "href": "string",
          "itemType": "string",
          "method": "string",
          "rel": "string",
          "responseItemType": "string",
          "responseType": "string",
          "title": "string",
          "type": "string",
          "uri": "string"
        }
      ]
    }
  ],
  "version": 0
}

FieldContentLocale Collection

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Provides the name of the collection of available field content locale.
accept	string	false	none	Provides a space-separated list of link types for the items in the collection of field content locale.
links	[link]	false	none	Provides paging links that apply to the collection of field content locale.
items	[fieldContentLocale]	false	none	Provides the actual result of the query.
version	integer	false	none	Provides the version of the collection schema.

environment

{
  "version": 0,
  "name": "string",
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ]
}

Environment

Properties

Name	Type	Required	Restrictions	Description
version	integer	false	none	This media type's schema version number. This representation is version 1.
name	string	false	none	The unique name of the execution environment.
links	[link]	false	none	Links that apply to this execution environment,

environmentCollection

{
  "accept": "string",
  "count": 0,
  "limit": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "name": "string",
  "start": 0,
  "version": 0,
  "items": [
    {
      "version": 0,
      "name": "string",
      "links": [
        {
          "href": "string",
          "itemType": "string",
          "method": "string",
          "rel": "string",
          "responseItemType": "string",
          "responseType": "string",
          "title": "string",
          "type": "string",
          "uri": "string"
        }
      ]
    }
  ]
}

Environment Collection

Properties

Name	Type	Required	Restrictions	Description
Environment Collection	any	false	none	A collection of environments.

allOf

Name	Type	Required	Restrictions	Description
anonymous	baseCollection2	false	none	Representation of base collection.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[environment]	false	none	Array of environments

context

{
  "version": 0,
  "name": "string",
  "type": "string",
  "description": "string",
  "host": "string",
  "state": "string",
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ]
}

Context

Properties

Name	Type	Required	Restrictions	Description
version	integer	false	none	This media type's schema version number. This representation is version 1.
name	string	false	none	Provides the unique name of the context.
type	string	false	none	Provides the type of context.
description	string	false	none	Provides the description of the context.
host	string	false	none	Provides the host name of the context.
state	string	false	none	Provides the state of the context. The state is the value from the CAS Management service, along with 'unknown host' for hosts that cannot be resolved.
links	[link]	false	none	Provides links that apply to this context.

contextCollection

{
  "accept": "string",
  "count": 0,
  "limit": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "name": "string",
  "start": 0,
  "version": 0,
  "items": [
    {
      "version": 0,
      "name": "string",
      "type": "string",
      "description": "string",
      "host": "string",
      "state": "string",
      "links": [
        {
          "href": "string",
          "itemType": "string",
          "method": "string",
          "rel": "string",
          "responseItemType": "string",
          "responseType": "string",
          "title": "string",
          "type": "string",
          "uri": "string"
        }
      ]
    }
  ]
}

Context Collection

Properties

Name	Type	Required	Restrictions	Description
Context Collection	any	false	none	Provides a collection of contexts.

allOf

Name	Type	Required	Restrictions	Description
anonymous	baseCollection2	false	none	Representation of base collection.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[context]	false	none	Array of contexts

qkb

{
  "version": "string",
  "name": "string",
  "product": "string",
  "default": true,
  "creationTimeStamp": "2019-08-24T14:15:22Z",
  "context": "string",
  "environment": "string",
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ]
}

QKB

Properties

Name	Type	Required	Restrictions	Description
version	string	false	none	This media type's schema version number. This representation is version 1.
name	string	false	none	Provides the unique name of the QKB. The name must be unique within a given execution environment.
product	string	false	none	Provides the product that is associated with the QKB.
default	boolean	false	none	Provides a flag that indicates the default QKB in each execution environment.
creationTimeStamp	string(date-time)	false	none	Provides the creation timestamp for the QKB.
context	string	false	none	Provides the name of the execution environment of the QKB.
environment	string	false	none	Provides the name of the execution environment of the QKB.
links	[link]	false	none	Provides a list of links that apply to the QKB.

qkbCollection

{
  "accept": "string",
  "count": 0,
  "limit": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "name": "string",
  "start": 0,
  "version": 0,
  "items": [
    {
      "version": "string",
      "name": "string",
      "product": "string",
      "default": true,
      "creationTimeStamp": "2019-08-24T14:15:22Z",
      "context": "string",
      "environment": "string",
      "links": [
        {
          "href": "string",
          "itemType": "string",
          "method": "string",
          "rel": "string",
          "responseItemType": "string",
          "responseType": "string",
          "title": "string",
          "type": "string",
          "uri": "string"
        }
      ]
    }
  ]
}

QKB Collection

Properties

Name	Type	Required	Restrictions	Description
QKB Collection	any	false	none	A collection of QKBs.

allOf

Name	Type	Required	Restrictions	Description
anonymous	baseCollection2	false	none	Representation of base collection.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[qkb]	false	none	Array of QKBs

allQkbsCollection

{
  "accept": "string",
  "count": 0,
  "limit": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "name": "string",
  "start": 0,
  "version": 0,
  "items": [
    {
      "version": "string",
      "name": "string",
      "product": "string",
      "default": true,
      "creationTimeStamp": "2019-08-24T14:15:22Z",
      "context": "string",
      "environment": "string",
      "links": [
        {
          "href": "string",
          "itemType": "string",
          "method": "string",
          "rel": "string",
          "responseItemType": "string",
          "responseType": "string",
          "title": "string",
          "type": "string",
          "uri": "string"
        }
      ]
    }
  ]
}

All QKBs Collection

Properties

Name	Type	Required	Restrictions	Description
All QKBs Collection	any	false	none	A collection of QKBs across from all environments and contexts.

allOf

Name	Type	Required	Restrictions	Description
anonymous	baseCollection2	false	none	Representation of base collection.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[qkb]	false	none	Array of QKBs

locale

{
  "version": 0,
  "name": "string",
  "description": "string",
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ]
}

Locale

Properties

Name	Type	Required	Restrictions	Description
version	integer	false	none	This media type's schema version number. This representation is version 1.
name	string	false	none	Provides the name of the locale. The name is unique within each QKB.
description	string	false	none	Provides a short description of the locale.
links	[link]	false	none	Provides links that apply to the locale.

localeCollection

{
  "accept": "string",
  "count": 0,
  "limit": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "name": "string",
  "start": 0,
  "version": 0,
  "items": [
    {
      "version": 0,
      "name": "string",
      "description": "string",
      "links": [
        {
          "href": "string",
          "itemType": "string",
          "method": "string",
          "rel": "string",
          "responseItemType": "string",
          "responseType": "string",
          "title": "string",
          "type": "string",
          "uri": "string"
        }
      ]
    }
  ]
}

Locale Collection

Properties

Name	Type	Required	Restrictions	Description
Locale Collection	any	false	none	Provides a collection of QKB locales.

allOf

Name	Type	Required	Restrictions	Description
anonymous	baseCollection2	false	none	Representation of base collection.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[locale]	false	none	Array of QKB locales

function

{
  "version": 0,
  "name": "string",
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ]
}

Function

Properties

Name	Type	Required	Restrictions	Description
version	integer	false	none	This media type's schema version number. This representation is version 1.
name	string	false	none	Provides the name of the function. The name is unique within a given locale.
links	[link]	false	none	Provides a list of links that apply to this function.

functionCollection

{
  "accept": "string",
  "count": 0,
  "limit": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "name": "string",
  "start": 0,
  "version": 0,
  "items": [
    {
      "version": 0,
      "name": "string",
      "links": [
        {
          "href": "string",
          "itemType": "string",
          "method": "string",
          "rel": "string",
          "responseItemType": "string",
          "responseType": "string",
          "title": "string",
          "type": "string",
          "uri": "string"
        }
      ]
    }
  ]
}

Function Collection

Properties

Name	Type	Required	Restrictions	Description
Function Collection	any	false	none	Provides a collection of QKB functions

allOf

Name	Type	Required	Restrictions	Description
anonymous	baseCollection2	false	none	Representation of base collection.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[function]	false	none	Array of QKB functions

definition

{
  "version": 0,
  "name": "string",
  "type": "string",
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ]
}

Definition

Properties

Name	Type	Required	Restrictions	Description
version	integer	false	none	This media type's schema version number. This representation is version 1.
name	string	false	none	Provides the unique name of the definition within the locale.
type	string	false	none	Provides the type of the definition.
links	[link]	false	none	Provides a list of links that apply to the locale.

definitionCollection

{
  "accept": "string",
  "count": 0,
  "limit": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "name": "string",
  "start": 0,
  "version": 0,
  "items": [
    {
      "version": 0,
      "name": "string",
      "type": "string",
      "links": [
        {
          "href": "string",
          "itemType": "string",
          "method": "string",
          "rel": "string",
          "responseItemType": "string",
          "responseType": "string",
          "title": "string",
          "type": "string",
          "uri": "string"
        }
      ]
    }
  ]
}

Definition Collection

Properties

Name	Type	Required	Restrictions	Description
Definition Collection	any	false	none	Provides a collection of data quality definitions.

allOf

Name	Type	Required	Restrictions	Description
anonymous	baseCollection2	false	none	Representation of base collection.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[definition]	false	none	Array of data quality functions

token

{
  "version": 0,
  "name": "string",
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ]
}

Token

Properties

Name	Type	Required	Restrictions	Description
version	integer	false	none	This media type's schema version number. This representation is version 1.
name	string	false	none	Provides the name of the token, which is unique within each definition.
links	[link]	false	none	Provides a list of links that apply to the token.

tokenCollection

{
  "accept": "string",
  "count": 0,
  "limit": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "name": "string",
  "start": 0,
  "version": 0,
  "items": [
    {
      "version": 0,
      "name": "string",
      "links": [
        {
          "href": "string",
          "itemType": "string",
          "method": "string",
          "rel": "string",
          "responseItemType": "string",
          "responseType": "string",
          "title": "string",
          "type": "string",
          "uri": "string"
        }
      ]
    }
  ]
}

Token Collection

Properties

Name	Type	Required	Restrictions	Description
Token Collection	any	false	none	Provides a collection of tokens.

allOf

Name	Type	Required	Restrictions	Description
anonymous	baseCollection2	false	none	Representation of base collection.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[token]	false	none	Array of tokens

links

[
  {
    "href": "string",
    "itemType": "string",
    "method": "string",
    "rel": "string",
    "responseItemType": "string",
    "responseType": "string",
    "title": "string",
    "type": "string",
    "uri": "string"
  }
]

Links

Properties

Name	Type	Required	Restrictions	Description
Links	[link]	false	none	Provides zero or more links to related resources and actions.

error2

{
  "errorCode": 0,
  "httpStatusCode": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "message": "string",
  "version": 0
}

The representation of an error.

Properties

Name	Type	Required	Restrictions	Description
errorCode	integer	false	none	The numeric ID for the error.
httpStatusCode	integer	false	none	The HTTP status code for the error.
links	[link]	false	none	The links that apply to the error.
message	string	false	none	The message for the error.
version	integer	false	none	The version number of the error representation. This representation is version 2.

link

{
  "href": "string",
  "itemType": "string",
  "method": "string",
  "rel": "string",
  "responseItemType": "string",
  "responseType": "string",
  "title": "string",
  "type": "string",
  "uri": "string"
}

The links that apply to the collection.

Properties

Name	Type	Required	Restrictions	Description
href	string	false	none	The URL for the link.
itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
method	string	false	none	The HTTP method for the link.
rel	string	false	none	The relationship of the link to the resource.
responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
title	string	false	none	The title for the link.
type	string	false	none	The media type or link type for the link.
uri	string	false	none	The relative URI for the link.

baseCollection2

{
  "accept": "string",
  "count": 0,
  "limit": 0,
  "links": [
    {
      "href": "string",
      "itemType": "string",
      "method": "string",
      "rel": "string",
      "responseItemType": "string",
      "responseType": "string",
      "title": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "name": "string",
  "start": 0,
  "version": 0
}

Representation of base collection.

Properties

Name	Type	Required	Restrictions	Description
accept	string	false	none	A space-delimited list of media types from which an `Accept` header may be constructed.
count	integer(int64)	false	none	If populated indicates the number of items in the collection.
limit	integer	false	none	The number of items that were requested for the collection.
links	[link]	false	none	The links that apply to the collection.
name	string	false	none	The name of the collection.
start	integer(int64)	false	none	The zero-based index of the first item in the collection.
version	integer	false	none	The version number of the collection representation. This representation is version 2.

Data Sources

Base URLs:

http://mock-dataSources.apifirst.unx.sas.com/dataSources

Terms of service Email: SAS Developers Web: SAS Developers

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Data Sources API works in concert with the Data Tables and Row Sets APIs to navigate, reference, and retrieve data in the SAS Viya ecosystem. The Data Sources API enables retrieval of metadata for data sources and linking to their respective tables.
All GET operations have a corresponding HEAD with identical signature and semantics except the resource body is not returned.

Terminology:

data source: represents a node in the data source hierarchy that can represent a server, library, or collection of tables.

provider: represents a vnd.sas.data.provider that the Data Sources service is responsible for managing and retrieving rather than the Data Sources providers (such as CAS). These are retrieved from the service registry.

data source definition: represents the metadata needed to construct a data source node in the hierarchy. This is only available on a per provider basis. Compute is the only supported provider.

engine: represents the means to connect to the next level down in the data source hierarchy. An engine's definition contains all of the available attributes that must be specified to create a data source definition.

Usage Notes

Overview

The Data Sources API works in concert with the Data Tables and Row Sets APIs to navigate, reference, and retrieve data in the SAS Viya ecosystem. The Data Sources API enables retrieval of data source metadata. A data source represents a collection of data tables. Examples of data sources are SAS libraries, CASLIBs, or a JDBC data schema.

Each data source is a RESTful resource with a URL that serves as the address of and unique ID of that data source.

Terminology

data source

represents a node in the data source hierarchy that can represent a server, library, or collection of tables.

provider

represents a vnd.sas.data.provider that the Data Sources service provider is responsible for managing and retrieving rather than the Data Sources service (such as CAS). These are retrieved from the service registry.

data source definition

represents the metadata needed to construct a data source node in the hierarchy. This is only available on a per provider basis. Compute is the only supported provider.

engine

represents the means to connect to the next level down in the data source hierarchy. An engine's definition contains all of the available attributes that must be specified to create a data source definition.

Error Codes

Error codes

The following list contains the set of error codes that are used in certain error conditions.

Error Code	HTTP Status Code	Description
11900	404	No provider found.
11901	400	The `sortBy` query parameter is not supported by this provider on this endpoint.
11902	400	The `filter` query parameter is not supported by this provider on this endpoint.
11904	400	The provider does not support source definitions.
11905	500	Too many providers found.
11906	400	The specified Accept-Item is invalid.
11907	500	An error occurred while serializing the source definition for the transfer object.
11908	500	An error occurred while extracting the source definition from the transfer object.
11909	400	The transfer object is missing content.
11910	400	The source definition id in the request path does not match the one in the body.
11911	400	The provider id in the request path does not match the one in the body.
11912	400	The id must not be specified when creating a new source definition.
11913	400	The session delete failed.
11914	400	A Source definition with the ID already exists.
11915	400	The source definition not found.
11916	503	The provider for the source is not available, or it is currently starting up.
11917	503	The provider is not available, or it is currently starting up.
11938	400	The path parameter with value is not valid.
11939	400	The request body is not valid.
11940	400	The query parameter with value is not valid.
11941	400	The path parameter is required.
11945	400	The value for the field is invalid because it doesn't confirm to SAS libref name rules.

Note: Other error codes may be returned from respective provider services.

Operations

Providers

Contains data source operations for the providers resource.

Get a list of providers

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json' \
  -H 'Accept-Item: application/vnd.sas.data.provider.summary+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json',
  'Accept-Item':'application/vnd.sas.data.provider.summary+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json',
  'Accept-Item': 'application/vnd.sas.data.provider.summary+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
        "Accept-Item": []string{"application/vnd.sas.data.provider.summary+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers

Returns a collection of application/vnd.sas.data.provider.summary resources. Standard paging, filtering, and sorting options are specified in the Parameters section below.

Parameters

Name	In	Type	Required	Description
Accept-Item	header	string	false	The desired provider representation. The Accept-Item options are: application/vnd.sas.data.provider.summary+json application/vnd.sas.data.provider+json If the application/vnd.sas.data.provider.summary type is specified or no Accept-Item header is present, the providers are returned as the summary representation provider objects. In this case, the provider contains the following properties: id, version, and links.
start	query	integer	false	0-based index of first provider to return. Defaults to 0.
limit	query	integer	false	Maximum number of providers to return in this page of results. The actual number of returned providers can be fewer if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Filter criteria for returned providers. The only valid filter field is id. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries: Search by id starting with: /dataSources/providers?filter=startsWith(id, 'prov') Search by id: /dataSources/providers?filter=eq(id, 'provider1') Search for multiple providers: /dataSources/providers?filter=in(id, 'provider1', 'provider2', 'provider3')
sortBy	query	string(sort-criteria)	false	Sort returned providers. The only valid sorting option is the id field. The default sort order is ascending on the id field. Some sample sorts include the following: Sort ascending by id: /dataSources/providers?sortBy=id:ascending Sort descending by id: /dataSources/providers?sortBy=id:descending

Detailed descriptions

Accept-Item: The desired provider representation.
The Accept-Item options are:

application/vnd.sas.data.provider.summary+json
application/vnd.sas.data.provider+json

If the application/vnd.sas.data.provider.summary type is specified or no Accept-Item header is present, the providers are returned as the summary representation provider objects. In this case, the provider contains the following properties: id, version, and links.

filter: Filter criteria for returned providers. The only valid filter field is id. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries:

Search by id starting with: /dataSources/providers?filter=startsWith(id, 'prov')
Search by id: /dataSources/providers?filter=eq(id, 'provider1')
Search for multiple providers: /dataSources/providers?filter=in(id, 'provider1', 'provider2', 'provider3')

sortBy: Sort returned providers.
The only valid sorting option is the id field. The default sort order is ascending on the id field. Some sample sorts include the following:

Sort ascending by id: /dataSources/providers?sortBy=id:ascending
Sort descending by id: /dataSources/providers?sortBy=id:descending

Enumerated Values

Parameter	Value
Accept-Item	application/vnd.sas.data.provider.summary+json
Accept-Item	application/vnd.sas.data.provider+json

Example responses

GET /providers

{
  "name": "providers",
  "accept": "application/vnd.sas.data.provider.summary application/vnd.sas.data.provider",
  "start": 0,
  "count": 1,
  "limit": 10,
  "version": 2,
  "items": [
    {
      "id": "cas",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas",
          "uri": "/dataSources/providers/cas",
          "type": "application/vnd.sas.data.provider"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas",
          "uri": "/dataSources/providers/cas",
          "type": "application/vnd.sas.data.provider.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers",
          "uri": "/dataSources/providers",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.provider"
        },
        {
          "method": "GET",
          "rel": "dataSources",
          "href": "/dataSources/providers/cas/sources",
          "uri": "/dataSources/providers/cas/sources",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        }
      ],
      "version": 1
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataSources/providers",
      "uri": "/dataSources/providers",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers?start=0&limit=10",
      "uri": "/dataSources/providers?start=0&limit=10",
      "type": "application/vnd.sas.collection"
    }
  ]
}

{
  "name": "providers",
  "accept": "application/vnd.sas.data.provider.summary application/vnd.sas.data.provider",
  "start": 0,
  "count": 1,
  "limit": 10,
  "version": 2,
  "items": [
    {
      "id": "cas",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas",
          "uri": "/dataSources/providers/cas",
          "type": "application/vnd.sas.data.provider"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas",
          "uri": "/dataSources/providers/cas",
          "type": "application/vnd.sas.data.provider.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers",
          "uri": "/dataSources/providers",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.provider"
        },
        {
          "method": "GET",
          "rel": "dataSources",
          "href": "/dataSources/providers/cas/sources",
          "uri": "/dataSources/providers/cas/sources",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        }
      ],
      "version": 1
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataSources/providers",
      "uri": "/dataSources/providers",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers?start=0&limit=10",
      "uri": "/dataSources/providers?start=0&limit=10",
      "type": "application/vnd.sas.collection"
    }
  ]
}

This is an example of an error that could be returned for bad requests

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. Any providers are returned in a resource collection.	providerSummaryCollection
400	Bad Request	The request was invalid. Invalid requests occur in the following scenarios: A negative start value is provided. A negative limit value is provided. An unsupported field is specified in the sortBy parameter.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Gets the provider

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.provider+json'


const headers = {
  'Accept':'application/vnd.sas.data.provider+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.provider+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.provider+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers/{providerId}

Returns information about a single provider based on its unique ID.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.

Example responses

GET /providers/{providerId}

{
  "id": "cas",
  "apiVersion": 2,
  "usesSessions": true,
  "sourceDefinitionsSupport": "none",
  "version": 2,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers",
      "uri": "/dataSources/providers",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.provider.summary"
    },
    {
      "method": "GET",
      "rel": "dataSources",
      "href": "/dataSources/providers/cas/sources",
      "uri": "/dataSources/providers/cas/sources",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    }
  ]
}

Certain Data Sources service providers support session-based data retrieval. To determine whether this is supported by any particular provider, query /dataTables/providers/{providerId} to retrieve the application/vnd.sas.data.provider media type. Then check the usesSessions member.

{}

GET /providers/{providerId}

{
  "id": "cas",
  "apiVersion": 2,
  "usesSessions": true,
  "sourceDefinitionsSupport": "none",
  "version": 2,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers",
      "uri": "/dataSources/providers",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.provider.summary"
    },
    {
      "method": "GET",
      "rel": "dataSources",
      "href": "/dataSources/providers/cas/sources",
      "uri": "/dataSources/providers/cas/sources",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    }
  ]
}

Certain Data Sources service providers support session-based data retrieval. To determine whether this is supported by any particular provider, query /dataTables/providers/{providerId} to retrieve the application/vnd.sas.data.provider media type. Then check the usesSessions member.

{}

GET /providers/{providerId}

{
  "id": "cas",
  "apiVersion": 2,
  "usesSessions": true,
  "sourceDefinitionsSupport": "none",
  "version": 2,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers",
      "uri": "/dataSources/providers",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.provider.summary"
    },
    {
      "method": "GET",
      "rel": "dataSources",
      "href": "/dataSources/providers/cas/sources",
      "uri": "/dataSources/providers/cas/sources",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    }
  ]
}

Certain Data Sources service providers support session-based data retrieval. To determine whether this is supported by any particular provider, query /dataTables/providers/{providerId} to retrieve the application/vnd.sas.data.provider media type. Then check the usesSessions member.

{}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	provider
404	Not Found	No provider exists at the requested path.	Inline

Response Schema

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Sources

Contains operations for data sources resource.

Get a list of data sources

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json' \
  -H 'Accept-Item: application/vnd.sas.data.source+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json',
  'Accept-Item':'application/vnd.sas.data.source+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json',
  'Accept-Item': 'application/vnd.sas.data.source+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
        "Accept-Item": []string{"application/vnd.sas.data.source+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers/{providerId}/sources

Returns a collection of sources. Standard paging, filtering, and sorting options are provided. The members of this collection use application/vnd.sas.data.source media type representation.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
Accept-Item	header	string	false	The desired data source representation. The Accept-Item options are: application/vnd.sas.data.source+json application/vnd.sas.data.source.summary+json If the application/vnd.sas.data.source+json type is specified or no Accept-Item header is present, the data sources are returned as full representation source objects.
start	query	integer	false	The starting index of the first source in a page. Defaults to 0.
limit	query	integer	false	Maximum number of sources to return in this page of results. The actual number of returned sources can be fewer if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Filter criteria for returned sources. The valid filter fields are name and type if supported by the provider. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith and isNull. Sample queries include the following: Search by name starting with: /dataSources/providers/{providerId}/sources?filter=startsWith(name, 'sour') Search by name: /dataSources/providers/{providerId}/sources?filter=eq(name, 'source1') Search for multiple sources: /dataSources/providers/{providerId}/sources?filter=in(name, 'source1', 'source2', 'source3')
sortBy	query	string(sort-criteria)	false	Sort returned sources. The sort criteria supports the following fields in either ascending or descending order (name, type, createdBy, modifiedBy, creationTimeStamp, and modifiedTimeStamp). Sample sorts include the following: Sort ascending by source name: /dataSources/providers/{providerId}/sources?sortBy=name:ascending Sort descending by source name: /dataSources/providers/{providerId}/sources?sortBy=name:descending The default sort is by name in ascending order.

Detailed descriptions

Accept-Item: The desired data source representation. The Accept-Item options are:

application/vnd.sas.data.source+json
application/vnd.sas.data.source.summary+json

If the application/vnd.sas.data.source+json type is specified or no Accept-Item header is present, the data sources are returned as full representation source objects.

filter: Filter criteria for returned sources. The valid filter fields are name and type if supported by the provider. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith and isNull. Sample queries include the following:

Search by name starting with: /dataSources/providers/{providerId}/sources?filter=startsWith(name, 'sour')
Search by name: /dataSources/providers/{providerId}/sources?filter=eq(name, 'source1')
Search for multiple sources: /dataSources/providers/{providerId}/sources?filter=in(name, 'source1', 'source2', 'source3')

sortBy: Sort returned sources. The sort criteria supports the following fields in either ascending or descending order (name, type, createdBy, modifiedBy, creationTimeStamp, and modifiedTimeStamp). Sample sorts include the following:

Sort ascending by source name: /dataSources/providers/{providerId}/sources?sortBy=name:ascending
Sort descending by source name: /dataSources/providers/{providerId}/sources?sortBy=name:descending

The default sort is by name in ascending order.

Enumerated Values

Parameter	Value
Accept-Item	application/vnd.sas.data.source+json
Accept-Item	application/vnd.sas.data.source.summary+json

Example responses

GET /providers/{providerId}/sources

{
  "name": "sources",
  "accept": "application/vnd.sas.data.source",
  "count": 1,
  "version": 2,
  "items": [
    {
      "id": "cas",
      "name": "cas",
      "type": "casServer",
      "providerId": "cas",
      "description": "controller",
      "hasTables": true,
      "hasEngines": false,
      "attributes": {
        "port": 8850,
        "host": "server.example.com"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source.summary"
        },
        {
          "method": "GET",
          "rel": "status",
          "href": "/casManagement/servers/cas/status",
          "uri": "/casManagement/servers/cas/status",
          "responseType": "application/json"
        },
        {
          "method": "GET",
          "rel": "tables",
          "href": "/dataTables/dataSources/cas~fs~cas/tables",
          "uri": "/dataTables/dataSources/cas~fs~cas/tables",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/cas/sources",
          "uri": "/dataSources/providers/cas/sources",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "children",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataSources/providers/cas/sources",
      "uri": "/dataSources/providers/cas/sources",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas/sources?start=0&limit=10",
      "uri": "/dataSources/providers/cas/sources?start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

{
  "name": "sources",
  "accept": "application/vnd.sas.data.source",
  "count": 1,
  "version": 2,
  "items": [
    {
      "id": "cas",
      "name": "cas",
      "type": "casServer",
      "providerId": "cas",
      "description": "controller",
      "hasTables": true,
      "hasEngines": false,
      "attributes": {
        "port": 8850,
        "host": "server.example.com"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source.summary"
        },
        {
          "method": "GET",
          "rel": "status",
          "href": "/casManagement/servers/cas/status",
          "uri": "/casManagement/servers/cas/status",
          "responseType": "application/json"
        },
        {
          "method": "GET",
          "rel": "tables",
          "href": "/dataTables/dataSources/cas~fs~cas/tables",
          "uri": "/dataTables/dataSources/cas~fs~cas/tables",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/cas/sources",
          "uri": "/dataSources/providers/cas/sources",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "children",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataSources/providers/cas/sources",
      "uri": "/dataSources/providers/cas/sources",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas/sources?start=0&limit=10",
      "uri": "/dataSources/providers/cas/sources?start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

This is an example of an error that could be returned for bad requests

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	sourceCollection
400	Bad Request	The request was invalid. Invalid requests occur in the following scenarios: A negative start value is provided. A negative limit value is provided. An unsupported field is specified in the sortBy parameter. An unsupported field is specified in the filter parameter. An invalid filter parameter is provided.	Inline
404	Not Found	No provider exists at the requested path.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Get a data source

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.source+json'


const headers = {
  'Accept':'application/vnd.sas.data.source+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.source+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.source+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers/{providerId}/sources/{sourceId}

Returns information about a single source based on its unique ID.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
sourceId	path	string	true	The ID for the source.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this identifier is not specified, the data service provider creates a temporary session and then destroys it after the request is complete. If this is specified all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This only has effect when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided and the session created by the data service provider is not be destroyed. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is destroyed after the request is complete. Defaults to false.

Example responses

GET /providers/{providerId}/sources/{sourceId}

{
  "id": "cas",
  "name": "cas",
  "type": "casServer",
  "providerId": "cas",
  "description": "controller",
  "hasTables": true,
  "hasEngines": false,
  "attributes": {
    "port": "8850",
    "host": "server.example.com"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas/sources/cas",
      "uri": "/dataSources/providers/cas/sources/cas",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataSources/providers/cas/sources/cas",
      "uri": "/dataSources/providers/cas/sources/cas",
      "type": "application/vnd.sas.data.source.summary"
    },
    {
      "method": "GET",
      "rel": "status",
      "href": "/casManagement/servers/cas/status",
      "uri": "/casManagement/servers/cas/status",
      "responseType": "application/json"
    },
    {
      "method": "GET",
      "rel": "tables",
      "href": "/dataTables/dataSources/cas~fs~cas/tables",
      "uri": "/dataTables/dataSources/cas~fs~cas/tables",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/cas/sources",
      "uri": "/dataSources/providers/cas/sources",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "children",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    }
  ]
}

{
  "id": "cas",
  "name": "cas",
  "type": "casServer",
  "providerId": "cas",
  "description": "controller",
  "hasTables": true,
  "hasEngines": false,
  "attributes": {
    "port": "8850",
    "host": "server.example.com"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas/sources/cas",
      "uri": "/dataSources/providers/cas/sources/cas",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataSources/providers/cas/sources/cas",
      "uri": "/dataSources/providers/cas/sources/cas",
      "type": "application/vnd.sas.data.source.summary"
    },
    {
      "method": "GET",
      "rel": "status",
      "href": "/casManagement/servers/cas/status",
      "uri": "/casManagement/servers/cas/status",
      "responseType": "application/json"
    },
    {
      "method": "GET",
      "rel": "tables",
      "href": "/dataTables/dataSources/cas~fs~cas/tables",
      "uri": "/dataTables/dataSources/cas~fs~cas/tables",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/cas/sources",
      "uri": "/dataSources/providers/cas/sources",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "children",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    }
  ]
}

{
  "id": "cas",
  "name": "cas",
  "type": "casServer",
  "providerId": "cas",
  "description": "controller",
  "hasTables": true,
  "hasEngines": false,
  "attributes": {
    "port": "8850",
    "host": "server.example.com"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas/sources/cas",
      "uri": "/dataSources/providers/cas/sources/cas",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataSources/providers/cas/sources/cas",
      "uri": "/dataSources/providers/cas/sources/cas",
      "type": "application/vnd.sas.data.source.summary"
    },
    {
      "method": "GET",
      "rel": "status",
      "href": "/casManagement/servers/cas/status",
      "uri": "/casManagement/servers/cas/status",
      "responseType": "application/json"
    },
    {
      "method": "GET",
      "rel": "tables",
      "href": "/dataTables/dataSources/cas~fs~cas/tables",
      "uri": "/dataTables/dataSources/cas~fs~cas/tables",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/cas/sources",
      "uri": "/dataSources/providers/cas/sources",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "children",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    }
  ]
}

{
  "id": "cas",
  "name": "cas",
  "type": "casServer",
  "providerId": "cas",
  "description": "controller",
  "hasTables": true,
  "hasEngines": false,
  "attributes": {
    "port": "8850",
    "host": "server.example.com"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas/sources/cas",
      "uri": "/dataSources/providers/cas/sources/cas",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataSources/providers/cas/sources/cas",
      "uri": "/dataSources/providers/cas/sources/cas",
      "type": "application/vnd.sas.data.source.summary"
    },
    {
      "method": "GET",
      "rel": "status",
      "href": "/casManagement/servers/cas/status",
      "uri": "/casManagement/servers/cas/status",
      "responseType": "application/json"
    },
    {
      "method": "GET",
      "rel": "tables",
      "href": "/dataTables/dataSources/cas~fs~cas/tables",
      "uri": "/dataTables/dataSources/cas~fs~cas/tables",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/cas/sources",
      "uri": "/dataSources/providers/cas/sources",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "children",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    }
  ]
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	source
404	Not Found	No provider or data source definition exists at the requested path.	Inline

Response Schema

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Get a list of child data sources

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/children \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json' \
  -H 'Accept-Item: application/vnd.sas.data.source+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json',
  'Accept-Item':'application/vnd.sas.data.source+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/children',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json',
  'Accept-Item': 'application/vnd.sas.data.source+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/children', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
        "Accept-Item": []string{"application/vnd.sas.data.source+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/children", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers/{providerId}/sources/{sourceId}/children

Returns a collection of sources that are children of the specified source. Standard paging, filtering, and sorting options are provided. The members of this collection use application/vnd.sas.data.source media type representation.

Parameters

Name	In	Type	Required	Description
Accept-Item	header	string	false	The desired data source representation. The Accept-Item options are: application/vnd.sas.data.source+json application/vnd.sas.data.source.summary+json If the application/vnd.sas.data.column+json type is specified or no Accept-Item header is present, the data sources are returned as full representation column objects.
providerId	path	string	true	The ID for the provider.
sourceId	path	string	true	The ID for the data source.
start	query	integer	false	The starting index of the first source in a page. Defaults to 0.
limit	query	integer	false	Maximum number of sources to return in this page of results. The actual number of returned sources might be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Filter criteria for returned sources. The valid filter fields are name and type if supported by the provider. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Sample queries include the following: Search by name starting with: /dataSources/providers/{providerId}/sources/{sourceId}/children?filter=startsWith(name, 'sour') Search by name: /dataSources/providers/{providerId}/sources/{sourceId}/children?filter=eq(name, 'source1') Search for multiple sources: /dataSources/providers/{providerId}/sources/{sourceId}/children?filter=in(name, 'source1', 'source2', 'source3')
sortBy	query	string(sort-criteria)	false	Sort returned sources. The sort criteria supports the following fields in either ascending or descending order (name, type, createdBy, modifiedBy, creationTimeStamp, and modifiedTimeStamp). Sample sorts include the following: Sort ascending by source name: /dataSources/providers/{providerId}/sources/{sourceId}/children?sortBy=name:ascending Sort descending by source name: /dataSources/providers/{providerId}/sources/{sourceId}/children?sortBy=name:descending The default sort is by name in ascending order.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session and then destroys it after the request is complete. If this is specified all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This only has effect when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided and the session created by the data service provider is not be destroyed. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is destroyed after the request is complete. Defaults to false.

Detailed descriptions

Accept-Item: The desired data source representation. The Accept-Item options are:

application/vnd.sas.data.source+json
application/vnd.sas.data.source.summary+json

If the application/vnd.sas.data.column+json type is specified or no Accept-Item header is present, the data sources are returned as full representation column objects.

filter: Filter criteria for returned sources.
The valid filter fields are name and type if supported by the provider. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Sample queries include the following:

Search by name starting with: /dataSources/providers/{providerId}/sources/{sourceId}/children?filter=startsWith(name, 'sour')
Search by name: /dataSources/providers/{providerId}/sources/{sourceId}/children?filter=eq(name, 'source1')
Search for multiple sources: /dataSources/providers/{providerId}/sources/{sourceId}/children?filter=in(name, 'source1', 'source2', 'source3')

Sort ascending by source name: /dataSources/providers/{providerId}/sources/{sourceId}/children?sortBy=name:ascending
Sort descending by source name: /dataSources/providers/{providerId}/sources/{sourceId}/children?sortBy=name:descending

The default sort is by name in ascending order.

Enumerated Values

Parameter	Value
Accept-Item	application/vnd.sas.data.source+json
Accept-Item	application/vnd.sas.data.source.summary+json

Example responses

GET /providers/{providerId}/sources/{sourceId}/children

{
  "name": "sources",
  "accept": "application/vnd.sas.data.source application/vnd.sas.data.source.summary",
  "version": 2,
  "items": [
    {
      "id": "MYCASLIB",
      "name": "MYCASLIB",
      "type": "caslib",
      "providerId": "cas",
      "description": "castest test files.",
      "hasTables": true,
      "hasEngines": false,
      "attributes": {
        "active\"": "false",
        "personal\"": "false",
        "subDirs\"": "true"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
          "type": "application/vnd.sas.data.source.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "parent",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "tables",
          "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables",
          "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        }
      ]
    },
    {
      "id": "EngTest",
      "name": "EngTest",
      "type": "caslib",
      "providerId": "cas",
      "description": "engtest HDAT files.",
      "hasTables": true,
      "attributes": {
        "active": "false",
        "personal": "false",
        "subDirs": "true"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas~fs~EngTest",
          "uri": "/dataSources/providers/cas/sources/cas~fs~EngTest",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas/sources/cas~fs~EngTest",
          "uri": "/dataSources/providers/cas/sources/cas~fs~EngTest",
          "type": "application/vnd.sas.data.source.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "parent",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "tables",
          "href": "/dataTables/dataSources/cas~fs~cas~fs~EngTest/tables",
          "uri": "/dataTables/dataSources/cas~fs~cas~fs~EngTest/tables",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        }
      ]
    },
    {
      "id": "Formats",
      "name": "Formats",
      "type": "caslib",
      "providerId": "cas",
      "description": "Format Caslib",
      "hasTables": true,
      "hasEngines": false,
      "attributes": {
        "active": "false",
        "personal": "false",
        "subDirs": "true"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas~fs~Formats",
          "uri": "/dataSources/providers/cas/sources/cas~fs~Formats",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas/sources/cas~fs~Formats",
          "uri": "/dataSources/providers/cas/sources/cas~fs~Formats",
          "type": "application/vnd.sas.data.source.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "parent",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "tables",
          "href": "/dataTables/dataSources/cas~fs~cas~fs~Formats/tables",
          "uri": "/dataTables/dataSources/cas~fs~cas~fs~Formats/tables",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        }
      ]
    },
    {
      "id": "HPS",
      "name": "HPS",
      "type": "caslib",
      "providerId": "cas",
      "description": "HDAT files on /hps",
      "hasTables": true,
      "hasEngines": false,
      "attributes": {
        "active": "false",
        "personal": "false",
        "subDirs": "true"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas~fs~HPS",
          "uri": "/dataSources/providers/cas/sources/cas~fs~HPS",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas/sources/cas~fs~HPS",
          "uri": "/dataSources/providers/cas/sources/cas~fs~HPS",
          "type": "application/vnd.sas.data.source.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "parent",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "tables",
          "href": "/dataTables/dataSources/cas~fs~cas~fs~HPS/tables",
          "uri": "/dataTables/dataSources/cas~fs~cas~fs~HPS/tables",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/children?start=0&limit=10",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/children?start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/cas/sources/cas",
      "uri": "/dataSources/providers/cas/sources/cas",
      "type": "application/vnd.sas.data.source"
    }
  ]
}

{
  "name": "sources",
  "accept": "application/vnd.sas.data.source application/vnd.sas.data.source.summary",
  "version": 2,
  "items": [
    {
      "id": "MYCASLIB",
      "name": "MYCASLIB",
      "type": "caslib",
      "providerId": "cas",
      "description": "castest test files.",
      "hasTables": true,
      "hasEngines": false,
      "attributes": {
        "active\"": "false",
        "personal\"": "false",
        "subDirs\"": "true"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default~fs~MYCASLIB",
          "type": "application/vnd.sas.data.source.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "parent",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "tables",
          "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables",
          "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        }
      ]
    },
    {
      "id": "EngTest",
      "name": "EngTest",
      "type": "caslib",
      "providerId": "cas",
      "description": "engtest HDAT files.",
      "hasTables": true,
      "attributes": {
        "active": "false",
        "personal": "false",
        "subDirs": "true"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas~fs~EngTest",
          "uri": "/dataSources/providers/cas/sources/cas~fs~EngTest",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas/sources/cas~fs~EngTest",
          "uri": "/dataSources/providers/cas/sources/cas~fs~EngTest",
          "type": "application/vnd.sas.data.source.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "parent",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "tables",
          "href": "/dataTables/dataSources/cas~fs~cas~fs~EngTest/tables",
          "uri": "/dataTables/dataSources/cas~fs~cas~fs~EngTest/tables",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        }
      ]
    },
    {
      "id": "Formats",
      "name": "Formats",
      "type": "caslib",
      "providerId": "cas",
      "description": "Format Caslib",
      "hasTables": true,
      "hasEngines": false,
      "attributes": {
        "active": "false",
        "personal": "false",
        "subDirs": "true"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas~fs~Formats",
          "uri": "/dataSources/providers/cas/sources/cas~fs~Formats",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas/sources/cas~fs~Formats",
          "uri": "/dataSources/providers/cas/sources/cas~fs~Formats",
          "type": "application/vnd.sas.data.source.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "parent",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "tables",
          "href": "/dataTables/dataSources/cas~fs~cas~fs~Formats/tables",
          "uri": "/dataTables/dataSources/cas~fs~cas~fs~Formats/tables",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        }
      ]
    },
    {
      "id": "HPS",
      "name": "HPS",
      "type": "caslib",
      "providerId": "cas",
      "description": "HDAT files on /hps",
      "hasTables": true,
      "hasEngines": false,
      "attributes": {
        "active": "false",
        "personal": "false",
        "subDirs": "true"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas~fs~HPS",
          "uri": "/dataSources/providers/cas/sources/cas~fs~HPS",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataSources/providers/cas/sources/cas~fs~HPS",
          "uri": "/dataSources/providers/cas/sources/cas~fs~HPS",
          "type": "application/vnd.sas.data.source.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "parent",
          "href": "/dataSources/providers/cas/sources/cas",
          "uri": "/dataSources/providers/cas/sources/cas",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "tables",
          "href": "/dataTables/dataSources/cas~fs~cas~fs~HPS/tables",
          "uri": "/dataTables/dataSources/cas~fs~cas~fs~HPS/tables",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/children",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/children?start=0&limit=10",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/children?start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/cas/sources/cas",
      "uri": "/dataSources/providers/cas/sources/cas",
      "type": "application/vnd.sas.data.source"
    }
  ]
}

This is an example of an error that could be returned for bad requests

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	sourceChildrenCollection
400	Bad Request	The request was invalid. An invalid filter or combination of request parameters was provided.	Inline
404	Not Found	No provider or data source exists at the requested path.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

SourceDefinitions

Contains operations for the data source definitions resource.

Get a list of data source definitions

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers/{providerId}/sourceDefinitions

Returns a collection of application/vnd.sas.source.definition resources. Standard paging, filtering, and sorting options are specified in the Parameters section below.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
start	query	integer	false	The starting index of the first source definition in a page. Defaults to 0.
limit	query	integer	false	Maximum number of source definitions to return in this page of results. The actual number of returned sources can be fewer if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Filter criteria for returned data source definitions. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries include the following: Search by name starting with: /dataSources/providers/{providerId}/sourceDefinitions?filter=startsWith(name, 'sour') Search by name: /dataSources/providers/{providerId}/sourceDefinitions?filter=eq(name, 'source1') Search for multiple source definitions: /dataSources/providers/{providerId}/sourceDefinitions?filter=in(name, 'source1', 'source2', 'source3')
sortBy	query	string(sort-criteria)	false	Sort returned data source definitions. The sort criteria supports the following fields in either ascending or descending order (name, type, createdBy, modifiedBy, creationTimeStamp, and modifiedTimeStamp). Some sample sorts include the following: Sort ascending by name: /dataSources/providers/{providerId}/sourceDefinitions?sortBy=name:ascending Sort descending by name: /dataSources/providers/{providerId}/sourceDefinitions?sortBy=name:descending The default sort is by name in ascending order.

Detailed descriptions

filter: Filter criteria for returned data source definitions. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries include the following:

Search by name starting with: /dataSources/providers/{providerId}/sourceDefinitions?filter=startsWith(name, 'sour')
Search by name: /dataSources/providers/{providerId}/sourceDefinitions?filter=eq(name, 'source1')
Search for multiple source definitions: /dataSources/providers/{providerId}/sourceDefinitions?filter=in(name, 'source1', 'source2', 'source3')

sortBy: Sort returned data source definitions. The sort criteria supports the following fields in either ascending or descending order (name, type, createdBy, modifiedBy, creationTimeStamp, and modifiedTimeStamp). Some sample sorts include the following:

Sort ascending by name: /dataSources/providers/{providerId}/sourceDefinitions?sortBy=name:ascending
Sort descending by name: /dataSources/providers/{providerId}/sourceDefinitions?sortBy=name:descending

The default sort is by name in ascending order.

Example responses

An example of source definition collection.

{
  "name": "sourceDefinitions",
  "accept": "application/vnd.sas.data.source.definition",
  "start": 0,
  "count": 1,
  "limit": 10,
  "version": 2,
  "items": [
    {
      "creationTimeStamp": "2017-04-12T13:39:09.424Z",
      "modifiedTimeStamp": "2017-04-12T13:39:09.424Z",
      "createdBy": "bob",
      "modifiedBy": "bob",
      "id": "84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
      "name": "ORAFW",
      "providerId": "Compute",
      "description": "description for source definition",
      "dataSourceId": "SAS Studio compute context",
      "defaultLibref": "ORAFW",
      "attributes": {
        "engineName": "sase7",
        "options": {
          "ENABLEDIRECTIO": "NO",
          "NOSETPERM": "NO",
          "USEDIRECTIO": "NO"
        },
        "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "PUT",
          "rel": "update",
          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "DELETE",
          "rel": "delete",
          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3"
        },
        {
          "method": "PUT",
          "rel": "export",
          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "type": "application/vnd.sas.transfer.object"
        },
        {
          "method": "PUT",
          "rel": "import",
          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "type": "application/vnd.sas.transfer.object",
          "responseType": "application/vnd.sas.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/Compute/sourceDefinitions",
          "uri": "/dataSources/providers/Compute/sourceDefinitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataSources/providers/Compute",
          "uri": "/dataSources/providers/Compute",
          "type": "application/vnd.sas.data.provider"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataSources/providers/myProvider/sourceDefinitions",
      "uri": "/dataSources/providers/myProvider/sourceDefinitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/myProvider/sourceDefinitions?sortBy=name:ascending&start=0&limit=10",
      "uri": "/dataSources/providers/myProvider/sourceDefinitions?sortBy=name:ascending&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/myProvider",
      "uri": "/dataSources/providers/myProvider",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "POST",
      "rel": "createSourceDefinition",
      "href": "/dataSources/providers/myProvider/sourceDefinitions",
      "uri": "/dataSources/providers/myProvider/sourceDefinitions",
      "type": "application/vnd.sas.data.source.definition",
      "responseType": "application/vnd.sas.data.source.definition"
    }
  ]
}

{
  "name": "sourceDefinitions",
  "accept": "application/vnd.sas.data.source.definition",
  "start": 0,
  "count": 1,
  "limit": 10,
  "version": 2,
  "items": [
    {
      "creationTimeStamp": "2017-04-12T13:39:09.424Z",
      "modifiedTimeStamp": "2017-04-12T13:39:09.424Z",
      "createdBy": "bob",
      "modifiedBy": "bob",
      "id": "84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
      "name": "ORAFW",
      "providerId": "Compute",
      "description": "description for source definition",
      "dataSourceId": "SAS Studio compute context",
      "defaultLibref": "ORAFW",
      "attributes": {
        "engineName": "sase7",
        "options": {
          "ENABLEDIRECTIO": "NO",
          "NOSETPERM": "NO",
          "USEDIRECTIO": "NO"
        },
        "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "PUT",
          "rel": "update",
          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "DELETE",
          "rel": "delete",
          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3"
        },
        {
          "method": "PUT",
          "rel": "export",
          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "type": "application/vnd.sas.transfer.object"
        },
        {
          "method": "PUT",
          "rel": "import",
          "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "type": "application/vnd.sas.transfer.object",
          "responseType": "application/vnd.sas.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/Compute/sourceDefinitions",
          "uri": "/dataSources/providers/Compute/sourceDefinitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataSources/providers/Compute",
          "uri": "/dataSources/providers/Compute",
          "type": "application/vnd.sas.data.provider"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataSources/providers/myProvider/sourceDefinitions",
      "uri": "/dataSources/providers/myProvider/sourceDefinitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/myProvider/sourceDefinitions?sortBy=name:ascending&start=0&limit=10",
      "uri": "/dataSources/providers/myProvider/sourceDefinitions?sortBy=name:ascending&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/myProvider",
      "uri": "/dataSources/providers/myProvider",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "POST",
      "rel": "createSourceDefinition",
      "href": "/dataSources/providers/myProvider/sourceDefinitions",
      "uri": "/dataSources/providers/myProvider/sourceDefinitions",
      "type": "application/vnd.sas.data.source.definition",
      "responseType": "application/vnd.sas.data.source.definition"
    }
  ]
}

This is an example of an error that could be returned for bad requests

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. Any data source definitions are returned in a resource collection.	sourceDefinitionCollection
400	Bad Request	The request was invalid. Invalid requests occur in the following scenarios: A negative start value is provided. A negative limit value is provided. An unsupported field is specified in the sortBy parameter.	Inline
404	Not Found	No provider exists at the requested path.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Create a data source definition

Code samples

# You can also use wget
curl -X POST http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Content-Type: application/vnd.sas.data.source.definition+json' \
  -H 'Accept: application/vnd.sas.data.source.definition+json'

const inputBody = '{
  "name": "ORAFW",
  "providerId": "Compute",
  "description": "A description for source definition",
  "dataSourceId": "SAS Studio compute context",
  "defaultLibref": "ORAFW",
  "attributes": {
    "engineName": "sase7",
    "options": {
      "ENABLEDIRECTIO": "NO",
      "NOSETPERM": "NO",
      "USEDIRECTIO": "NO"
    },
    "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
  }
}';
const headers = {
  'Content-Type':'application/vnd.sas.data.source.definition+json',
  'Accept':'application/vnd.sas.data.source.definition+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/vnd.sas.data.source.definition+json',
  'Accept': 'application/vnd.sas.data.source.definition+json'
}

r = requests.post('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/vnd.sas.data.source.definition+json"},
        "Accept": []string{"application/vnd.sas.data.source.definition+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /providers/{providerId}/sourceDefinitions

Creates a date source definition from the provided request.

Body parameter

A sample request body to create a source definition.

{
  "name": "ORAFW",
  "providerId": "Compute",
  "description": "A description for source definition",
  "dataSourceId": "SAS Studio compute context",
  "defaultLibref": "ORAFW",
  "attributes": {
    "engineName": "sase7",
    "options": {
      "ENABLEDIRECTIO": "NO",
      "NOSETPERM": "NO",
      "USEDIRECTIO": "NO"
    },
    "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
  }
}

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
body	body	createSourceDefinition	true	Source definition to create. The only fields validated are name, label, domain, and description. Other fields are not validated. The attributes are not required for the source definition but they are needed to actually use the source definition to access tables

Example responses

A sample response to create source definition request.

{
  "creationTimeStamp": "2017-04-12T13:29:14.212Z",
  "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
  "createdBy": "bob",
  "modifiedBy": "bob",
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "name": "ORAFW",
  "providerId": "Compute",
  "description": "A description for source definition",
  "dataSourceId": "SAS Studio compute context",
  "defaultLibref": "ORAFW",
  "attributes": {
    "engineName": "sase7",
    "options": {
      "ENABLEDIRECTIO": "NO",
      "NOSETPERM": "NO",
      "USEDIRECTIO": "NO"
    },
    "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
    },
    {
      "method": "PUT",
      "rel": "export",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object"
    },
    {
      "method": "PUT",
      "rel": "import",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object",
      "responseType": "application/vnd.sas.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sourceDefinitions",
      "uri": "/dataSources/providers/Compute/sourceDefinitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

{
  "creationTimeStamp": "2017-04-12T13:29:14.212Z",
  "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
  "createdBy": "bob",
  "modifiedBy": "bob",
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "name": "ORAFW",
  "providerId": "Compute",
  "description": "A description for source definition",
  "dataSourceId": "SAS Studio compute context",
  "defaultLibref": "ORAFW",
  "attributes": {
    "engineName": "sase7",
    "options": {
      "ENABLEDIRECTIO": "NO",
      "NOSETPERM": "NO",
      "USEDIRECTIO": "NO"
    },
    "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
    },
    {
      "method": "PUT",
      "rel": "export",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object"
    },
    {
      "method": "PUT",
      "rel": "import",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object",
      "responseType": "application/vnd.sas.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sourceDefinitions",
      "uri": "/dataSources/providers/Compute/sourceDefinitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

This is an example of an error that could be returned for bad requests

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
201	Created	A source definition was created.	sourceDefinition
400	Bad Request	The request was invalid.	errorResponse
404	Not Found	No provider exists at the requested path.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Response Headers

Status	Header	Type	Description
201	Location	string	The URI of the newly created source definition.
201	Last-Modified	string	The ISO8601 date string representing the timestamp of the last update to this object.
201	ETag	string	A tag that identifies this revision of this object.

Get a data source definition

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.source.definition+json'


const headers = {
  'Accept':'application/vnd.sas.data.source.definition+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.source.definition+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.source.definition+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers/{providerId}/sourceDefinitions/{sourceDefinitionId}

Returns information about a single source based on its unique ID.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
sourceDefinitionId	path	string	true	The ID for the source definition.

Example responses

A sample source definition.

{
  "creationTimeStamp": "2017-04-12T13:29:14.212Z",
  "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
  "createdBy": "bob",
  "modifiedBy": "bob",
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "name": "ORAFW",
  "providerId": "Compute",
  "description": "description for source definition",
  "dataSourceId": "SAS Studio compute context",
  "defaultLibref": "ORAFW",
  "attributes": {
    "engineName": "sase7",
    "options": {
      "ENABLEDIRECTIO": "NO",
      "NOSETPERM": "NO",
      "USEDIRECTIO": "NO"
    },
    "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
    },
    {
      "method": "PUT",
      "rel": "export",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object"
    },
    {
      "method": "PUT",
      "rel": "import",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object",
      "responseType": "application/vnd.sas.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sourceDefinitions",
      "uri": "/dataSources/providers/Compute/sourceDefinitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

{
  "creationTimeStamp": "2017-04-12T13:29:14.212Z",
  "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
  "createdBy": "bob",
  "modifiedBy": "bob",
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "name": "ORAFW",
  "providerId": "Compute",
  "description": "description for source definition",
  "dataSourceId": "SAS Studio compute context",
  "defaultLibref": "ORAFW",
  "attributes": {
    "engineName": "sase7",
    "options": {
      "ENABLEDIRECTIO": "NO",
      "NOSETPERM": "NO",
      "USEDIRECTIO": "NO"
    },
    "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
    },
    {
      "method": "PUT",
      "rel": "export",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object"
    },
    {
      "method": "PUT",
      "rel": "import",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object",
      "responseType": "application/vnd.sas.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sourceDefinitions",
      "uri": "/dataSources/providers/Compute/sourceDefinitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	sourceDefinition
404	Not Found	No provider or data source definition exists at the requested path.	Inline

Response Schema

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Response Headers

Status	Header	Type	Description
200	Location	string	The URI of the newly created source definition.
200	ETag	string	The entity tag for the source definition.
200	Last-Modified	string	The time stamp in `EEE, dd MMM yyyy HH:mm:ss GMT` format when the source definition was last modified.

Update a data source definition

Code samples

# You can also use wget
curl -X PUT http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Content-Type: application/vnd.sas.data.source.definition+json' \
  -H 'Accept: application/vnd.sas.data.source.definition+json' \
  -H 'If-Match: string'

const inputBody = '{
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "name": "ORAFW",
  "providerId": "Compute",
  "description": "A description for source definition",
  "dataSourceId": "SAS Studio compute context",
  "defaultLibref": "ORAFW",
  "attributes": {
    "engineName": "sase7",
    "options": {
      "ENABLEDIRECTIO": "NO",
      "NOSETPERM": "NO",
      "USEDIRECTIO": "NO"
    },
    "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
  },
  "version": 1
}';
const headers = {
  'Content-Type':'application/vnd.sas.data.source.definition+json',
  'Accept':'application/vnd.sas.data.source.definition+json',
  'If-Match':'string'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/vnd.sas.data.source.definition+json',
  'Accept': 'application/vnd.sas.data.source.definition+json',
  'If-Match': 'string'
}

r = requests.put('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/vnd.sas.data.source.definition+json"},
        "Accept": []string{"application/vnd.sas.data.source.definition+json"},
        "If-Match": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /providers/{providerId}/sourceDefinitions/{sourceDefinitionId}

Updates an existing data source definition through a full replacement of the resource. The ID field might not be modified by this operation.

Body parameter

A sample request for updating a source definition request PUT /providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e.

{
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "name": "ORAFW",
  "providerId": "Compute",
  "description": "A description for source definition",
  "dataSourceId": "SAS Studio compute context",
  "defaultLibref": "ORAFW",
  "attributes": {
    "engineName": "sase7",
    "options": {
      "ENABLEDIRECTIO": "NO",
      "NOSETPERM": "NO",
      "USEDIRECTIO": "NO"
    },
    "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
  },
  "version": 1
}

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
sourceDefinitionId	path	string	true	The ID for the source definition.
If-Match	header	string	false	The etag that was returned from a GET, POST, or PUT of this data source definition.
body	body	updateSourceDefinition	true	The source definition to update.

Example responses

A sample response for update a source definition request PUT /providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e.

{
  "creationTimeStamp": "2017-04-12T13:29:14.212Z",
  "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
  "createdBy": "bob",
  "modifiedBy": "bob",
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "name": "ORAFW",
  "providerId": "Compute",
  "description": "A description for source definition",
  "dataSourceId": "SAS Studio compute context",
  "defaultLibref": "ORAFW",
  "attributes": {
    "engineName": "sase7",
    "options": {
      "ENABLEDIRECTIO": "NO",
      "NOSETPERM": "NO",
      "USEDIRECTIO": "NO"
    },
    "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
    },
    {
      "method": "PUT",
      "rel": "export",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object"
    },
    {
      "method": "PUT",
      "rel": "import",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object",
      "responseType": "application/vnd.sas.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sourceDefinitions",
      "uri": "/dataSources/providers/Compute/sourceDefinitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

{
  "creationTimeStamp": "2017-04-12T13:29:14.212Z",
  "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
  "createdBy": "bob",
  "modifiedBy": "bob",
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "name": "ORAFW",
  "providerId": "Compute",
  "description": "A description for source definition",
  "dataSourceId": "SAS Studio compute context",
  "defaultLibref": "ORAFW",
  "attributes": {
    "engineName": "sase7",
    "options": {
      "ENABLEDIRECTIO": "NO",
      "NOSETPERM": "NO",
      "USEDIRECTIO": "NO"
    },
    "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
    },
    {
      "method": "PUT",
      "rel": "export",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object"
    },
    {
      "method": "PUT",
      "rel": "import",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.transfer.object",
      "responseType": "application/vnd.sas.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sourceDefinitions",
      "uri": "/dataSources/providers/Compute/sourceDefinitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

This is an example of an error that could be returned for bad requests

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

This is an example of an error that could be returned for unsupported requested media type

{
  "httpStatusCode": 406,
  "message": "Not Acceptable",
  "details": [
    "application/vnd.sas.data.source.definition+json",
    "application/json",
    "application/vnd.sas.summary+json",
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 19f0716a-973f-4001-a234-8719df94741c"
  ],
  "version": 2
}

{
  "httpStatusCode": 406,
  "message": "Not Acceptable",
  "details": [
    "application/vnd.sas.data.source.definition+json",
    "application/json",
    "application/vnd.sas.summary+json",
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 19f0716a-973f-4001-a234-8719df94741c"
  ],
  "version": 2
}

This is an example of an error that could be returned for invalid Etag

{
  "httpStatusCode": 412,
  "details": [
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 44d09ec8-3236-499a-9d33-dd794a9e9ca2"
  ],
  "message": "The If-Match header value does not match current ETag.",
  "version": 2
}

{
  "httpStatusCode": 412,
  "details": [
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 44d09ec8-3236-499a-9d33-dd794a9e9ca2"
  ],
  "message": "The If-Match header value does not match current ETag.",
  "version": 2
}

This is an example of an error that could be returned for missing If-Match header

{
  "httpStatusCode": 412,
  "details": [
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 44d09ec8-3236-499a-9d33-dd794a9e9ca2"
  ],
  "message": "The If-Match header not provided for the update.",
  "version": 2
}

{
  "httpStatusCode": 412,
  "details": [
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 44d09ec8-3236-499a-9d33-dd794a9e9ca2"
  ],
  "message": "The If-Match header not provided for the update.",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. Data source definition updated successfully.	sourceDefinition
400	Bad Request	The request was invalid. This occurs when the user provides an ID in the request that does not match the ID in the path of the URL.	Inline
404	Not Found	No data source definition exists at the requested path.	Inline
406	Not Acceptable	This is an example of an error that could be returned for unsupported requested media type.	Inline
412	Precondition Failed	The ETag provided does not match the current version of the object.	Inline
428	Precondition Required	The If-Match header was not provided when updating an existing type.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 406

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 412

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 428

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Response Headers

Status	Header	Type	Description
200	Location	string	The URI of the newly created source definition.
200	Last-Modified	string	The ISO8601 date string representing the timestamp of the last update to this data source definition.
200	Etag	string	A tag that identifies this revision of this object.

Delete a data source definition

Code samples

# You can also use wget
curl -X DELETE http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.error'


const headers = {
  'Accept':'application/vnd.sas.error'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.error'
}

r = requests.delete('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.error"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /providers/{providerId}/sourceDefinitions/{sourceDefinitionId}

Deletes the specified data source definition.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
sourceDefinitionId	path	string	true	The ID for the source definition.

Example responses

This is an example of an error that could be returned for bad requests

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
204	No Content	The data source definition was deleted.	None
400	Bad Request	Bad Request	Inline
404	Not Found	No provider or data source definition exists at the requested path.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Sessions

Contains operations to access data sources using the sessions resource.

Get a session

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.session+json'


const headers = {
  'Accept':'application/vnd.sas.data.session+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.session+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.session+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers/{providerId}/sources/{sourceId}/sessions/{sessionId}

Returns information about a single session based on its unique ID.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
sourceId	path	string	true	The ID for the source.
sessionId	path	string	true	The unique identifier of the session used to access the data service provider's backing service.

Example responses

GET /dataSources/providers/cas/sources/casServer/sessions/{sessionId}

{
  "version": 1,
  "id": "d75b412f-6004-4a03-9e6a-f447fdfc1eff",
  "providerId": "cas",
  "owner": "bob",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
      "uri": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
      "type": "application/vnd.sas.data.session"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
      "uri": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

{
  "version": 1,
  "id": "d75b412f-6004-4a03-9e6a-f447fdfc1eff",
  "providerId": "cas",
  "owner": "bob",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
      "uri": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
      "type": "application/vnd.sas.data.session"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
      "uri": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	session
404	Not Found	No provider, data source, or session exists at the requested path.	Inline

Response Schema

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Terminate a session

Code samples

# You can also use wget
curl -X DELETE http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.error'


const headers = {
  'Accept':'application/vnd.sas.error'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.error'
}

r = requests.delete('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.error"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /providers/{providerId}/sources/{sourceId}/sessions/{sessionId}

Terminates a session if the user has permissions to terminate the sessions, as determined by the provider service.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The provider.
sourceId	path	string	true	The ID for the data source.
sessionId	path	string	true	The unique identifier of the session used to access the data service provider's backing service.

Example responses

This is an example of an error that could be returned for bad requests

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
204	No Content	The session was terminated.	None
400	Bad Request	Bad Request	Inline
404	Not Found	No provider, data source, or session exists at the requested path.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Root

Contains operations for the root resource of the Data Sources API.

Get a collection of top-level links

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/ \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.api+json'


const headers = {
  'Accept':'application/vnd.sas.api+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.api+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.api+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /

Returns a list of links to the top-level collections surfaced through this API.

Example responses

Root Hateoas links.

{
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "providers",
      "href": "/dataSources/providers",
      "uri": "/dataSources/providers",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.provider.summary"
    }
  ]
}

{
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "providers",
      "href": "/dataSources/providers",
      "uri": "/dataSources/providers",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.provider.summary"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	api

Engines

Contains operations for engines of the Data Sources API.

Get a list of engines for a data source

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers/{providerId}/sources/{sourceId}/engines

Returns a collection of engines for the respective data source. Standard paging, filtering, and sorting options are provided. The members of this collection use application/vnd.sas.data.engine media type representation.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
sourceId	path	string	true	The ID for the source.
start	query	integer	false	The starting index of the first engine in a page. Defaults to 0.
limit	query	integer	false	Maximum number of engines to return in this page of results. The actual number of returned engines might be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Filter criteria for returned engines. The valid filter fields are name, label, description, and licensed. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith and isNull. Sample queries include the following: Search by name starting with: /dataSources/providers/{providerId}/sources/{sourceId}/engines?filter=startsWith(name, 'SASI') Search by name: /dataSources/providers/{providerId}/sources/{sourceId}/engines?filter=eq(name, 'SASIONZA') Search for multiple engines: /dataSources/providers/{providerId}/sources/{sourceId}/engines?filter=in(name, 'SASIONZA', 'SASORA')
sortBy	query	string(sort-criteria)	false	Sort returned sources. The sort criteria supports the following fields in either ascending or descending order: name, label, description, and licensed. Sample sorts include the following: Sort ascending by engine name: /dataSources/providers/{providerId}/sources/{sourceId}/engines?sortBy=name:ascending Sort descending by engine name: /dataSources/providers/{providerId}/sources/{sourceId}/engines?sortBy=name:descending The default sort is by name in ascending order.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this identifier is not specified, the data service provider creates a temporary session and then destroys it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. They also contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This only has effect when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided and the session created by the data service provider is not destroyed. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. They also contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is destroyed after the request is complete. Defaults to false.

Detailed descriptions

filter: Filter criteria for returned engines.
The valid filter fields are name, label, description, and licensed. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith and isNull. Sample queries include the following:

Search by name starting with: /dataSources/providers/{providerId}/sources/{sourceId}/engines?filter=startsWith(name, 'SASI')
Search by name: /dataSources/providers/{providerId}/sources/{sourceId}/engines?filter=eq(name, 'SASIONZA')
Search for multiple engines: /dataSources/providers/{providerId}/sources/{sourceId}/engines?filter=in(name, 'SASIONZA', 'SASORA')

sortBy: Sort returned sources. The sort criteria supports the following fields in either ascending or descending order: name, label, description, and licensed. Sample sorts include the following:

Sort ascending by engine name: /dataSources/providers/{providerId}/sources/{sourceId}/engines?sortBy=name:ascending
Sort descending by engine name: /dataSources/providers/{providerId}/sources/{sourceId}/engines?sortBy=name:descending

The default sort is by name in ascending order.

Example responses

GET /providers/{providerId}/sources/{sourceId}/engines

{
  "name": "engines",
  "accept": "application/vnd.sas.data.engine",
  "start": 0,
  "limit": 10,
  "count": 1,
  "version": 2,
  "items": [
    {
      "name": "sasionza",
      "label": "NETEZZA",
      "description": "SAS/ACCESS to Netezza",
      "providerId": "compute",
      "licensed": true,
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
          "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
          "type": "application/vnd.sas.data.engine"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
          "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.engine"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataSources/providers/Compute",
          "uri": "/dataSources/providers/Compute",
          "type": "application/vnd.sas.data.provider"
        },
        {
          "method": "GET",
          "rel": "dataSource",
          "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
          "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "definition",
          "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
          "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
          "type": "application/schema"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines?start=0&limit=10",
      "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines?start=0&limit=10",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "collection",
      "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
      "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
      "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
      "type": "application/vnd.sas.data.source"
    }
  ]
}

{
  "name": "engines",
  "accept": "application/vnd.sas.data.engine",
  "start": 0,
  "limit": 10,
  "count": 1,
  "version": 2,
  "items": [
    {
      "name": "sasionza",
      "label": "NETEZZA",
      "description": "SAS/ACCESS to Netezza",
      "providerId": "compute",
      "licensed": true,
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
          "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
          "type": "application/vnd.sas.data.engine"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
          "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.engine"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataSources/providers/Compute",
          "uri": "/dataSources/providers/Compute",
          "type": "application/vnd.sas.data.provider"
        },
        {
          "method": "GET",
          "rel": "dataSource",
          "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
          "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "definition",
          "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
          "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
          "type": "application/schema"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines?start=0&limit=10",
      "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines?start=0&limit=10",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "collection",
      "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
      "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
      "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
      "type": "application/vnd.sas.data.source"
    }
  ]
}

This is an example of an error that could be returned for bad requests

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	engineCollection
400	Bad Request	The request was invalid. An invalid filter or combination of request parameters was provided.	Inline
404	Not Found	No provider or data source exists at the requested path.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Get an engine name

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.engine+json'


const headers = {
  'Accept':'application/vnd.sas.data.engine+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.engine+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.engine+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers/{providerId}/sources/{sourceId}/engines/{engineName}

Returns information about a single engine based on its unique name.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
sourceId	path	string	true	The ID for the source.
engineName	path	string	true	The unique name of this engine within its data source.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session and then destroys it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This only has effect when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided and the session created by the data service provider is not destroyed. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is destroyed after the request is complete. Defaults to false.

Example responses

GET /dataSources/providers/Compute/sources/{sourceId}/engines/{engineName}

{
  "name": "sasionza",
  "nickname": "NETEZZA",
  "legalName": "SAS/ACCESS to Netezza",
  "providerId": "compute",
  "licensed": true,
  "hasDefinition": true,
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
      "type": "application/vnd.sas.data.engine"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.engine"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "dataSource",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "definition",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
      "type": "application/schema"
    }
  ]
}

{
  "name": "sasionza",
  "nickname": "NETEZZA",
  "legalName": "SAS/ACCESS to Netezza",
  "providerId": "compute",
  "licensed": true,
  "hasDefinition": true,
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
      "type": "application/vnd.sas.data.engine"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.engine"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "dataSource",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "definition",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
      "type": "application/schema"
    }
  ]
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	engine
404	Not Found	No provider, data source, or engine exists at the requested path.	Inline

Response Schema

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Get an engine definition

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}/definition \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/schema'


const headers = {
  'Accept':'application/schema'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}/definition',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/schema'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}/definition', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/schema"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}/definition", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers/{providerId}/sources/{sourceId}/engines/{engineName}/definition

Returns the definition of the engine as application or schema+json. This definition includes all available engine options.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
sourceId	path	string	true	The ID for the source.
engineName	path	string	true	The unique name of this engine within its data source.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session and then destroys it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This only has effect when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided and the session created by the data service provider is not destroyed. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is destroyed after the request is complete. Defaults to false.

Example responses

The engine definition as a json schema.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "SASE7",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "engineName"
  ],
  "properties": {
    "engineName": {
      "label": "V9",
      "type": "string",
      "default": "SASE7",
      "enum": [
        "SASE7"
      ]
    }
  }
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	engineDefinition
404	Not Found	No provider, data source, or engine exists at the requested path.	Inline

Response Schema

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Transfer

Contains operations to transfer object resources.

Create source definition from transfer object

Code samples

# You can also use wget
curl -X POST http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions#transfer \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Content-Type: application/vnd.sas.transfer.object+json' \
  -H 'Accept: application/vnd.sas.summary+json'

const inputBody = '{
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "content": "eyjjcmvhdglvblrpbwvtdgftcci6ijiwmjmtmdetmjzumtm6mja6mt",
  "summary": {
    "creationTimeStamp": "2017-04-12T13:29:14.212Z",
    "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
    "createdBy": "bob",
    "modifiedBy": "bob",
    "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
    "name": "ORAFW",
    "providerId": "Compute",
    "description": "description for source definition",
    "dataSourceId": "SAS Studio compute context",
    "defaultLibref": "ORAFW",
    "attributes": {
      "engineName": "sase7",
      "options": {
        "ENABLEDIRECTIO": "NO",
        "NOSETPERM": "NO",
        "USEDIRECTIO": "NO"
      },
      "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
    },
    "version": 1,
    "links": [
      {
        "method": "GET",
        "rel": "self",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "PUT",
        "rel": "update",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "DELETE",
        "rel": "delete",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
      },
      {
        "method": "PUT",
        "rel": "export",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.transfer.object"
      },
      {
        "method": "PUT",
        "rel": "import",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.transfer.object",
        "responseType": "application/vnd.sas.summary"
      },
      {
        "method": "GET",
        "rel": "up",
        "href": "/dataSources/providers/Compute/sourceDefinitions",
        "uri": "/dataSources/providers/Compute/sourceDefinitions",
        "type": "application/vnd.sas.collection",
        "itemType": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "GET",
        "rel": "provider",
        "href": "/dataSources/providers/Compute",
        "uri": "/dataSources/providers/Compute",
        "type": "application/vnd.sas.data.provider"
      }
    ]
  },
  "version": 2
}';
const headers = {
  'Content-Type':'application/vnd.sas.transfer.object+json',
  'Accept':'application/vnd.sas.summary+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions#transfer',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/vnd.sas.transfer.object+json',
  'Accept': 'application/vnd.sas.summary+json'
}

r = requests.post('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions#transfer', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/vnd.sas.transfer.object+json"},
        "Accept": []string{"application/vnd.sas.summary+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions#transfer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /providers/{providerId}/sourceDefinitions#transfer

Create a new source definition from transfer object. Other than the old source definition ID, all other source definition properties are preserved.

Body parameter

The transfer object example.

{
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "content": "eyjjcmvhdglvblrpbwvtdgftcci6ijiwmjmtmdetmjzumtm6mja6mt",
  "summary": {
    "creationTimeStamp": "2017-04-12T13:29:14.212Z",
    "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
    "createdBy": "bob",
    "modifiedBy": "bob",
    "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
    "name": "ORAFW",
    "providerId": "Compute",
    "description": "description for source definition",
    "dataSourceId": "SAS Studio compute context",
    "defaultLibref": "ORAFW",
    "attributes": {
      "engineName": "sase7",
      "options": {
        "ENABLEDIRECTIO": "NO",
        "NOSETPERM": "NO",
        "USEDIRECTIO": "NO"
      },
      "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
    },
    "version": 1,
    "links": [
      {
        "method": "GET",
        "rel": "self",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "PUT",
        "rel": "update",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "DELETE",
        "rel": "delete",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
      },
      {
        "method": "PUT",
        "rel": "export",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.transfer.object"
      },
      {
        "method": "PUT",
        "rel": "import",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.transfer.object",
        "responseType": "application/vnd.sas.summary"
      },
      {
        "method": "GET",
        "rel": "up",
        "href": "/dataSources/providers/Compute/sourceDefinitions",
        "uri": "/dataSources/providers/Compute/sourceDefinitions",
        "type": "application/vnd.sas.collection",
        "itemType": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "GET",
        "rel": "provider",
        "href": "/dataSources/providers/Compute",
        "uri": "/dataSources/providers/Compute",
        "type": "application/vnd.sas.data.provider"
      }
    ]
  },
  "version": 2
}

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
body	body	transferObject	true	The source definition to be imported.

Example responses

The transfer object example.

{
  "creationTimeStamp": "2017-04-12T13:29:14.212Z",
  "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
  "createdBy": "bob",
  "modifiedBy": "bob",
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "name": "sourceDefName1",
  "version": 2,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sourceDefinitions",
      "uri": "/dataSources/providers/Compute/sourceDefinitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

{
  "creationTimeStamp": "2017-04-12T13:29:14.212Z",
  "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
  "createdBy": "bob",
  "modifiedBy": "bob",
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "name": "sourceDefName1",
  "version": 2,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sourceDefinitions",
      "uri": "/dataSources/providers/Compute/sourceDefinitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

This is an example of an error that could be returned for bad requests

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
201	Created	A source definition was imported successfully.	transferObjectSummary
400	Bad Request	The request was invalid. There was a provider mismatch between the transfer object content and requested provider.	Inline
404	Not Found	No provider exists at the requested path.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Response Headers

Status	Header	Type	Description
201	Location	string	The URI of the newly created source definition.
201	ETag	string	The entity tag for the newly created source definition.
201	Last-Modified	string	The time stamp in `EEE, dd MMM yyyy HH:mm:ss GMT` format when the source definition was last modified.

Check transfer object availability

Code samples

# You can also use wget
curl -X GET http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}#transfer \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.transfer.object+json'


const headers = {
  'Accept':'application/vnd.sas.transfer.object+json'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}#transfer',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.transfer.object+json'
}

r = requests.get('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}#transfer', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.transfer.object+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}#transfer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /providers/{providerId}/sourceDefinitions/{sourceDefinitionId}#transfer

Return the transfer object of the specified source definition.

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
sourceDefinitionId	path	string	true	The ID for the source definition.

Example responses

The transfer object example.

{
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "content": "eyjjcmvhdglvblrpbwvtdgftcci6ijiwmjmtmdetmjzumtm6mja6mt",
  "summary": {
    "creationTimeStamp": "2017-04-12T13:29:14.212Z",
    "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
    "createdBy": "bob",
    "modifiedBy": "bob",
    "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
    "name": "ORAFW",
    "providerId": "Compute",
    "description": "description for source definition",
    "dataSourceId": "SAS Studio compute context",
    "defaultLibref": "ORAFW",
    "attributes": {
      "engineName": "sase7",
      "options": {
        "ENABLEDIRECTIO": "NO",
        "NOSETPERM": "NO",
        "USEDIRECTIO": "NO"
      },
      "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
    },
    "version": 1,
    "links": [
      {
        "method": "GET",
        "rel": "self",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "PUT",
        "rel": "update",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "DELETE",
        "rel": "delete",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
      },
      {
        "method": "PUT",
        "rel": "export",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.transfer.object"
      },
      {
        "method": "PUT",
        "rel": "import",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.transfer.object",
        "responseType": "application/vnd.sas.summary"
      },
      {
        "method": "GET",
        "rel": "up",
        "href": "/dataSources/providers/Compute/sourceDefinitions",
        "uri": "/dataSources/providers/Compute/sourceDefinitions",
        "type": "application/vnd.sas.collection",
        "itemType": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "GET",
        "rel": "provider",
        "href": "/dataSources/providers/Compute",
        "uri": "/dataSources/providers/Compute",
        "type": "application/vnd.sas.data.provider"
      }
    ]
  },
  "version": 2
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The source definition returned as a transfer object.	transferObject
404	Not Found	No provider or data source definition exists at the requested path.	Inline

Response Schema

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Response Headers

Status	Header	Type	Description
200	Location	string	The URI of the newly created source definition.
200	ETag	string	The entity tag for the source definition.
200	Last-Modified	string	The time stamp in `EEE, dd MMM yyyy HH:mm:ss GMT` format when the source definition was last modified.

Update source definition with transfer object

Code samples

# You can also use wget
curl -X PUT http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}#transfer \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Content-Type: application/vnd.sas.transfer.object+json' \
  -H 'Accept: application/vnd.sas.summary' \
  -H 'If-Match: string'

const inputBody = '{
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "content": "eyjjcmvhdglvblrpbwvtdgftcci6ijiwmjmtmdetmjzumtm6mja6mt",
  "summary": {
    "creationTimeStamp": "2017-04-12T13:29:14.212Z",
    "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
    "createdBy": "bob",
    "modifiedBy": "bob",
    "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
    "name": "ORAFW",
    "providerId": "Compute",
    "description": "description for source definition",
    "dataSourceId": "SAS Studio compute context",
    "defaultLibref": "ORAFW",
    "attributes": {
      "engineName": "sase7",
      "options": {
        "ENABLEDIRECTIO": "NO",
        "NOSETPERM": "NO",
        "USEDIRECTIO": "NO"
      },
      "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
    },
    "version": 1,
    "links": [
      {
        "method": "GET",
        "rel": "self",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "PUT",
        "rel": "update",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "DELETE",
        "rel": "delete",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
      },
      {
        "method": "PUT",
        "rel": "export",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.transfer.object"
      },
      {
        "method": "PUT",
        "rel": "import",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.transfer.object",
        "responseType": "application/vnd.sas.summary"
      },
      {
        "method": "GET",
        "rel": "up",
        "href": "/dataSources/providers/Compute/sourceDefinitions",
        "uri": "/dataSources/providers/Compute/sourceDefinitions",
        "type": "application/vnd.sas.collection",
        "itemType": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "GET",
        "rel": "provider",
        "href": "/dataSources/providers/Compute",
        "uri": "/dataSources/providers/Compute",
        "type": "application/vnd.sas.data.provider"
      }
    ]
  },
  "version": 2
}';
const headers = {
  'Content-Type':'application/vnd.sas.transfer.object+json',
  'Accept':'application/vnd.sas.summary',
  'If-Match':'string'
};

fetch('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}#transfer',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/vnd.sas.transfer.object+json',
  'Accept': 'application/vnd.sas.summary',
  'If-Match': 'string'
}

r = requests.put('http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}#transfer', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/vnd.sas.transfer.object+json"},
        "Accept": []string{"application/vnd.sas.summary"},
        "If-Match": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://mock-dataSources.apifirst.unx.sas.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}#transfer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /providers/{providerId}/sourceDefinitions/{sourceDefinitionId}#transfer

Updates a source definition using the transfer object. If no existing source definition is found, a new source definition is created. Either way, all other source definition properties are preserved.

Body parameter

The transfer object example.

{
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "content": "eyjjcmvhdglvblrpbwvtdgftcci6ijiwmjmtmdetmjzumtm6mja6mt",
  "summary": {
    "creationTimeStamp": "2017-04-12T13:29:14.212Z",
    "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
    "createdBy": "bob",
    "modifiedBy": "bob",
    "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
    "name": "ORAFW",
    "providerId": "Compute",
    "description": "description for source definition",
    "dataSourceId": "SAS Studio compute context",
    "defaultLibref": "ORAFW",
    "attributes": {
      "engineName": "sase7",
      "options": {
        "ENABLEDIRECTIO": "NO",
        "NOSETPERM": "NO",
        "USEDIRECTIO": "NO"
      },
      "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
    },
    "version": 1,
    "links": [
      {
        "method": "GET",
        "rel": "self",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "PUT",
        "rel": "update",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "DELETE",
        "rel": "delete",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
      },
      {
        "method": "PUT",
        "rel": "export",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.transfer.object"
      },
      {
        "method": "PUT",
        "rel": "import",
        "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
        "type": "application/vnd.sas.transfer.object",
        "responseType": "application/vnd.sas.summary"
      },
      {
        "method": "GET",
        "rel": "up",
        "href": "/dataSources/providers/Compute/sourceDefinitions",
        "uri": "/dataSources/providers/Compute/sourceDefinitions",
        "type": "application/vnd.sas.collection",
        "itemType": "application/vnd.sas.data.source.definition"
      },
      {
        "method": "GET",
        "rel": "provider",
        "href": "/dataSources/providers/Compute",
        "uri": "/dataSources/providers/Compute",
        "type": "application/vnd.sas.data.provider"
      }
    ]
  },
  "version": 2
}

Parameters

Name	In	Type	Required	Description
providerId	path	string	true	The ID for the provider.
sourceDefinitionId	path	string	true	The ID for the source definition.
If-Match	header	string	false	The etag that was returned from a GET, POST, or PUT of this data source definition.
body	body	transferObject	true	Source definition to be imported.

Example responses

The transfer object example.

This is an example of an error that could be returned for bad requests

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 400,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "error message explaining what when wrong",
  "version": 2
}

This is an example of an error that could be returned for resource not found

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

{
  "errorCode": 0,
  "httpStatusCode": 404,
  "details": [
    "path: resource URI",
    "correlator: 18afd83a-58d7-4b9b-9df8-de99dc821dc5"
  ],
  "message": "The resource not found",
  "version": 2
}

This is an example of an error that could be returned for unsupported requested media type

{
  "httpStatusCode": 406,
  "message": "Not Acceptable",
  "details": [
    "application/vnd.sas.data.source.definition+json",
    "application/json",
    "application/vnd.sas.summary+json",
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 19f0716a-973f-4001-a234-8719df94741c"
  ],
  "version": 2
}

{
  "httpStatusCode": 406,
  "message": "Not Acceptable",
  "details": [
    "application/vnd.sas.data.source.definition+json",
    "application/json",
    "application/vnd.sas.summary+json",
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 19f0716a-973f-4001-a234-8719df94741c"
  ],
  "version": 2
}

This is an example of an error that could be returned for invalid Etag

{
  "httpStatusCode": 412,
  "details": [
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 44d09ec8-3236-499a-9d33-dd794a9e9ca2"
  ],
  "message": "The If-Match header value does not match current ETag.",
  "version": 2
}

{
  "httpStatusCode": 412,
  "details": [
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 44d09ec8-3236-499a-9d33-dd794a9e9ca2"
  ],
  "message": "The If-Match header value does not match current ETag.",
  "version": 2
}

This is an example of an error that could be returned for missing If-Match header

{
  "httpStatusCode": 412,
  "details": [
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 44d09ec8-3236-499a-9d33-dd794a9e9ca2"
  ],
  "message": "The If-Match header not provided for the update.",
  "version": 2
}

{
  "httpStatusCode": 412,
  "details": [
    "path: /dataSources/providers/Compute/sourceDefinitions/7841c9a3-2c80-4a99-962f-9c5273573e3f",
    "correlator: 44d09ec8-3236-499a-9d33-dd794a9e9ca2"
  ],
  "message": "The If-Match header not provided for the update.",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The imported or updated source definition returned in resource summary format.	transferObjectSummary
400	Bad Request	The request was invalid. There is a mismatch in the transfer object content and one of the following requested resources: The provider. The data source definition.	Inline
404	Not Found	No provider exists at the requested path.	Inline
406	Not Acceptable	This is an example of an error that could be returned for unsupported requested media type.	Inline
412	Precondition Failed	The ETag provided does not match the current version of the object.	Inline
428	Precondition Required	Required If-Match header is missing.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 406

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 412

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 428

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1providers/get/responses/400/content/application~1vnd.sas.error%2Bjson/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Schemas

provider

{
  "id": "string",
  "version": 0,
  "apiVersion": 0,
  "usesSessions": true,
  "sourceDefinitionsSupport": "string",
  "attributes": {
    "property1": null,
    "property2": null
  },
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ]
}

Provider

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	The unique provider identifier.
version	integer	false	none	The provider schema version.
apiVersion	integer	false	none	The provider API version.
usesSessions	boolean	false	none	If this value is true, this provider supports sessions. If false, sessions are not supported.
sourceDefinitionsSupport	string	false	none	Indicates to the dataSources service how it should handle source definition persistence for this provider. The possible values are none (no support) and providedByDataSources (data sources service stores source definitions for the provider).
attributes	object	false	none	Additional provider-specific attributes.
» additionalProperties	any	false	none	none
links	[object]	false	none	Links that apply to this resource.
» Link	object	false	none	A link to a related operation or resource.
»» method	string	false	none	The HTTP method for the link.
»» rel	string	true	none	The relationship of the link to the resource.
»» uri	string	false	none	The relative URI for the link.
»» href	string	false	none	The URL for the link.
»» title	string	false	none	The title for the link.
»» type	string	false	none	The media type or link type for the link.
»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.

providerSummary

{
  "id": "string",
  "version": 0,
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ]
}

Provider Summary

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	The unique provider identifier.
version	integer	false	none	The provider schema version.
links	[link]	false	none	Links that apply to this resource.

providerSummaryCollection

{
  "name": "string",
  "start": 0,
  "limit": 0,
  "count": 0,
  "accept": "string",
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "version": 0,
  "items": [
    {
      "id": "string",
      "version": 0,
      "links": [
        {
          "method": "string",
          "rel": "string",
          "uri": "string",
          "href": "string",
          "title": "string",
          "type": "string",
          "itemType": "string",
          "responseType": "string",
          "responseItemType": "string"
        }
      ]
    }
  ]
}

Provider Summary Collection

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)
» name	string	false	none	The name of the collection.
» start	integer(int64)	false	none	The zero-based index of the first item in the collection.
» limit	integer	false	none	The number of items that were requested for the collection.
» count	integer(int64)	false	none	If populated indicates the number of items in the collection.
» accept	string	false	none	A space-delimited list of media types from which an `Accept` header may be constructed.
» links	[link]	false	none	The links that apply to the collection.
» version	integer	false	none	The version number of the collection representation. This representation is version 2.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[providerSummary]	true	none	The array that contains provider summary resources.

source

{
  "id": "string",
  "providerId": "string",
  "name": "string",
  "description": "string",
  "hasTables": true,
  "hasEngines": true,
  "createdBy": "string",
  "modifiedBy": "string",
  "creationTimeStamp": "2019-08-24T14:15:22Z",
  "modifiedTimeStamp": "2019-08-24T14:15:22Z",
  "attributes": {
    "property1": null,
    "property2": null
  },
  "version": 0,
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ]
}

Data Source

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	The unique data source identifier.
providerId	string	false	none	The source provider identifier.
name	string	false	none	The non-unique name of the data source.
description	string	false	none	A brief description of the source.
hasTables	boolean	false	none	If this value is true, this source is a table container. If this value is false, this source is not a table container.
hasEngines	boolean	false	none	If this value is true, this source, this source has engines available for it. If this value is false, this source does not have engines available for it.
createdBy	string	false	none	The user who created this source.
modifiedBy	string	false	none	The last user to modify this source.
creationTimeStamp	string(date-time)	false	none	The timestamp for the source creation.
modifiedTimeStamp	string(date-time)	false	none	The timestamp for the last source modification.
attributes	object	false	none	The attributes for this source.
» additionalProperties	any	false	none	none
version	integer	false	none	The source schema version.
links	[link]	false	none	The paging links that apply to this object.

sourceCollection

{
  "name": "string",
  "start": 0,
  "limit": 0,
  "count": 0,
  "accept": "string",
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "version": 0,
  "items": [
    {
      "id": "string",
      "providerId": "string",
      "name": "string",
      "description": "string",
      "hasTables": true,
      "hasEngines": true,
      "createdBy": "string",
      "modifiedBy": "string",
      "creationTimeStamp": "2019-08-24T14:15:22Z",
      "modifiedTimeStamp": "2019-08-24T14:15:22Z",
      "attributes": {
        "property1": null,
        "property2": null
      },
      "version": 0,
      "links": [
        {
          "method": "string",
          "rel": "string",
          "uri": "string",
          "href": "string",
          "title": "string",
          "type": "string",
          "itemType": "string",
          "responseType": "string",
          "responseItemType": "string"
        }
      ]
    }
  ]
}

Data Source Collection

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	providerSummaryCollection	false	none	This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[source]	true	none	The array that contains data source resources.

sourceChildrenCollection

{
  "name": "string",
  "start": 0,
  "limit": 0,
  "count": 0,
  "accept": "string",
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "version": 0,
  "items": [
    {
      "id": "string",
      "providerId": "string",
      "name": "string",
      "description": "string",
      "hasTables": true,
      "hasEngines": true,
      "createdBy": "string",
      "modifiedBy": "string",
      "creationTimeStamp": "2019-08-24T14:15:22Z",
      "modifiedTimeStamp": "2019-08-24T14:15:22Z",
      "attributes": {
        "property1": null,
        "property2": null
      },
      "version": 0,
      "links": [
        {
          "method": "string",
          "rel": "string",
          "uri": "string",
          "href": "string",
          "title": "string",
          "type": "string",
          "itemType": "string",
          "responseType": "string",
          "responseItemType": "string"
        }
      ]
    }
  ]
}

Data Source Children Collection

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	providerSummaryCollection	false	none	This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[source]	true	none	The array that contains data source resources.

engineCollection

{
  "name": "string",
  "start": 0,
  "limit": 0,
  "count": 0,
  "accept": "string",
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "version": 0,
  "items": [
    {
      "version": 0,
      "name": "string",
      "nickname": "string",
      "legalName": "string",
      "providerId": "string",
      "dataSourceId": "string",
      "licensed": true,
      "hasDefinition": true,
      "links": [
        {
          "method": "string",
          "rel": "string",
          "uri": "string",
          "href": "string",
          "title": "string",
          "type": "string",
          "itemType": "string",
          "responseType": "string",
          "responseItemType": "string"
        }
      ]
    }
  ]
}

Engine Collection

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	providerSummaryCollection	false	none	This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[engine]	true	none	The array that contains engine resources.

sourceDefinition

{
  "id": "string",
  "providerId": "string",
  "name": "string",
  "dataSourceId": "string",
  "description": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "creationTimeStamp": "2019-08-24T14:15:22Z",
  "modifiedTimeStamp": "2019-08-24T14:15:22Z",
  "defaultLibref": "string",
  "attributes": {
    "property1": null,
    "property2": null
  },
  "version": 0,
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ]
}

Source Definition

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique data source definition identifier.
providerId	string	true	none	The provider identifier.
name	string	true	none	The non-unique name of the data source.
dataSourceId	string	false	none	A unique identifier of the associated data source.
description	string	false	none	A brief description of the data source definition.
createdBy	string	false	none	The user who created this source definition.
modifiedBy	string	false	none	The last user to modify this data source definition.
creationTimeStamp	string(date-time)	false	none	The timestamp for the source definition creation.
modifiedTimeStamp	string(date-time)	false	none	The timestamp for the last source definition modification.
defaultLibref	string	false	none	A libref for use when LIBNAME statement is auto generated.
attributes	object	false	none	The map of attribute names to values for this source definition. The value of each attribute may be of types: number, string, boolean, or object like a map. If an attribute does not have a value, the value should be set to null.
» additionalProperties	any	false	none	none
version	integer	false	none	The source definition schema version.
links	[link]	false	none	Paging links that apply to this object.

createSourceDefinition

{
  "providerId": "string",
  "name": "string",
  "description": "string",
  "dataSourceId": "string",
  "defaultLibref": "string",
  "attributes": {
    "property1": null,
    "property2": null
  },
  "version": 0
}

Create Source Definition Request

Properties

Name	Type	Required	Restrictions	Description
providerId	string	true	none	The provider identifier.
name	string	true	none	The non-unique name for the data source definition.
description	string	false	none	A brief description of the data source definition.
dataSourceId	string	false	none	The unique identifier for the associated data source.
defaultLibref	string	false	none	A libref for use when LIBNAME statement is auto generated.
attributes	object	false	none	The map of attribute names to values for this source definition. The value of each attribute may be of types: number, string, boolean, or object like a map. If an attribute does not have a value, the value should be set to null.
» additionalProperties	any	false	none	none
version	integer	false	none	The source definition schema version.

updateSourceDefinition

{
  "id": "string",
  "providerId": "string",
  "name": "string",
  "description": "string",
  "dataSourceId": "string",
  "defaultLibref": "string",
  "attributes": {
    "property1": null,
    "property2": null
  },
  "version": 0
}

Update Source Definition Request

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique data source definition identifier.
providerId	string	true	none	The provider identifier.
name	string	true	none	The non-unique name for the data source definition.
description	string	false	none	A brief description for the data source definition.
dataSourceId	string	false	none	The unique identifier for the associated data source.
defaultLibref	string	false	none	A libref for use when LIBNAME statement is auto generated.
attributes	object	false	none	The map of attribute names to values for this source definition. The value of each attribute may be of types: number, string, boolean, or object like a map. If an attribute does not have a value, the value should be set to null.
» additionalProperties	any	false	none	none
version	integer	false	none	The source definition schema version.

sourceDefinitionCollection

{
  "name": "string",
  "start": 0,
  "limit": 0,
  "count": 0,
  "accept": "string",
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "version": 0,
  "items": [
    {
      "id": "string",
      "providerId": "string",
      "name": "string",
      "dataSourceId": "string",
      "description": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "creationTimeStamp": "2019-08-24T14:15:22Z",
      "modifiedTimeStamp": "2019-08-24T14:15:22Z",
      "defaultLibref": "string",
      "attributes": {
        "property1": null,
        "property2": null
      },
      "version": 0,
      "links": [
        {
          "method": "string",
          "rel": "string",
          "uri": "string",
          "href": "string",
          "title": "string",
          "type": "string",
          "itemType": "string",
          "responseType": "string",
          "responseItemType": "string"
        }
      ]
    }
  ]
}

Data Source Definition Collection

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	providerSummaryCollection	false	none	This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[sourceDefinition]	true	none	The array that contains source definition resources.

session

{
  "version": 0,
  "id": "string",
  "providerId": "string",
  "owner": "string",
  "attributes": {
    "property1": {},
    "property2": {}
  },
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ]
}

Session

Properties

Name	Type	Required	Restrictions	Description
version	integer	false	none	The media type's schema version number.
id	string	false	none	The unique session identifier.
providerId	string	false	none	The provider identifier for this session.
owner	string	false	none	The user ID for the owner of this session.
attributes	object	false	none	The attributes for this session.
» additionalProperties	object	false	none	none
links	[link]	false	none	The links that apply to the resource or object.

engine

{
  "version": 0,
  "name": "string",
  "nickname": "string",
  "legalName": "string",
  "providerId": "string",
  "dataSourceId": "string",
  "licensed": true,
  "hasDefinition": true,
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ]
}

Engine

Properties

Name	Type	Required	Restrictions	Description
version	integer	false	none	The media type's schema version number.
name	string	false	none	The unique name of this engine within its data source.
nickname	string	false	none	The user visible nickname of the engine.
legalName	string	false	none	The engine's short legal name.
providerId	string	false	none	The unique identifier of this engine's provider.
dataSourceId	string	false	none	The unique identifier of this engine's parent data source.
licensed	boolean	false	none	If true, the engine is licensed. If false, the engine is not licensed.
hasDefinition	boolean	false	none	If true, the engine has an associated definition. If false, the definition link is omitted.
links	[link]	false	none	The links that apply to this object.

engineDefinition

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "SASE7",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "engineName"
  ],
  "properties": {
    "engineName": {
      "label": "V9",
      "type": "string",
      "default": "SASE7",
      "enum": [
        "SASE7"
      ]
    }
  }
}

Engine Definition

Properties

None

transferObject

{
  "version": 0,
  "id": "string",
  "summary": {},
  "content": "string",
  "connectors": [
    {}
  ]
}

Transfer Object

Properties

Name	Type	Required	Restrictions	Description
version	integer	false	none	The version number of the transfer object.
id	string	false	none	The unique transfer object identifier.
summary	object	false	none	The details of the source definition.
content	string	false	none	The encoded data of the transfer object.
connectors	[object]	false	none	Items that are associated with the transfer object.

transferObjectSummary

{
  "id": "string",
  "name": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "creationTimeStamp": "2019-08-24T14:15:22Z",
  "modifiedTimeStamp": "2019-08-24T14:15:22Z",
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "version": 0
}

Transfer Resource Summary Object

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	The unique data source definition identifier.
name	string	false	none	The non-unique name of the data source.
createdBy	string	false	none	The user who created this source definition.
modifiedBy	string	false	none	The last user to modify this data source definition.
creationTimeStamp	string(date-time)	false	none	The timestamp for the source definition creation.
modifiedTimeStamp	string(date-time)	false	none	The timestamp for the last source definition modification.
links	[link]	false	none	Paging links that apply to this object.
version	integer	false	none	The source definition schema version.

api

{
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "version": 1
}

A list of links to top level resources available from the root of the API.

Properties

Name	Type	Required	Restrictions	Description
links	[link]	false	none	The API's top-level links.
version	integer	false	none	The version number of the API representation. This is version 1.

Examples

Github Examples

Detailed examples on how to use this API can be found on Github.

Media Type Samples

Externally-Defined Media Types

Generic Attributes Model

The model for a generic attributes object that is used across multiple resource representations follows. The purpose of this model is to store attributes in a generic fashion, allowing the resource to be expanded without requiring version updates. It also enables various providers to provide different data that is appropriate for different resources.

For example, a CAS Server data source would have a different set of attributes than a Compute Server context.

Name	Type	Description
`attributes`	`object`	An object containing name/value pairs where the values can be any type, such as a number, string, object, or an array.

JSON Representation of Attributes


 {
  "attributes": {
    "myAttrNum": 1.2,
    "myAttrInt": 100,
    "myAttrString": "myString",
    "myAttrArray": \[ 123, "value1", true\],
    "myAttrBoolean": true,
    "myAttrNull": null,
    "myAttrObj": {
       "myAttrBoolean": true,
       "myAttrNull": null,
     }
  }

application/vnd.sas.data.provider

The application/vnd.sas.data.provider media type describes the complete details of the provider.

Link Relations

Relation	Method	Description
`self`	`GET`	Returns a link to the full or complete representation of the provider. URI: `/dataSources/providers/{providerId}` Type: `application/vnd.sas.data.provider`
`alternate`	`GET`	Returns a link to the summary representation of the provider. URI: `/dataSources/providers/{providerId}` Type: `application/vnd.sas.data.provider.summary`
`up`	`GET`	Returns a link to the collection of all data source providers. URI: `/dataSources/providers` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.provider.summary`
`dataSources`	`GET`	Returns a link to the collection of sources that belong to this provider. HREF: `/dataSources/providers/{providerId}/sources` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source`
`sourceDefinitions`	`GET`	Returns a link to the collection of source definitions that belong to this provider. This will be omitted if the provider does not support data source definitions. HREF: `/dataSources/providers/{providerId}/sourceDefinitions` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source.definition`

Members

Name	Type	Description
`version`	`integer`	Returns the media type's schema version number. This representation is version 2.
`id`	`string`	Returns the unique identifier for a provider.
`apiVersion`	`integer`	Returns the provider API version.
`usesSessions`	`boolean`	Returns as `true` if the provider supports sessions, `false` otherwise.
`sourceDefinitionsSupport`	`string`	Returns the type of sourceDefinitionsSupport this provider desires. Valid values include: : none : providedByDataSources.
`attributes`	`object`	Returns a generic attributes object. See the Generic attributes model for more information.
`links`	`array of link objects`	Returns the links that apply to related resources or operations. See the above link relations table for a description of the link types.

application/vnd.sas.data.provider+json


 {
    "id": "cas",
    "type": "dataSources",
    "usesSessions": true,
    "sourceDefinitionsSupport": "none",
    "apiVersion": 2,
    "links": [
        {
            "method": "GET",
            "rel": "self",
            "type": "application/vnd.sas.data.provider",
            "href": "/dataTables/providers/cas",
            "uri": "/dataTables/providers/cas"
        },
        {
            "method": "GET",
            "rel": "alternate",
            "type": "application/vnd.sas.data.provider.summary",
            "href": "/dataTables/providers/cas",
            "uri": "/dataTables/providers/cas"
        },
        {
            "method": "GET",
            "rel": "up",
            "type": "application/vnd.sas.collection",
            "itemType": "application/vnd.sas.data.provider",
            "href": "/dataTables/providers",
            "uri": "/dataTables/providers"
        },
        {
            "method": "GET",
            "rel": "dataSources",
            "type": "application/vnd.sas.collection",
            "itemType": "application/vnd.sas.data.source",
            "href": "/dataSources/providers/cas/sources",
            "uri": "/dataSources/providers/cas/sources"
        }
    ],
    version: 2
}

application/vnd.sas.data.provider.summary

The application/vnd.sas.data.provider.summary media type describes the summary details of this provider.

Link Relations

application/vnd.sas.data.provider.summary has the same link relations as application/vnd.sas.data.provider.

Members

application/vnd.sas.data.provider.summary has the following members of the application/vnd.sas.data.provider media type: * id * type * links * version

The following field members are removed from this media type.

usesSessions, attributes, apiVersion.

This is representation version 1.

application/vnd.sas.data.provider.summary+json


 {
    "id": "cas",
    "type": "dataSources",
    "links": [
        {
            "method": "GET",
            "rel": "self",
            "type": "application/vnd.sas.data.provider",
            "href": "/dataTables/providers/cas",
            "uri": "/dataTables/providers/cas"
        },
        {
            "method": "GET",
            "rel": "alternate",
            "type": "application/vnd.sas.data.provider.summary",
            "href": "/dataTables/providers/cas",
            "uri": "/dataTables/providers/cas"
        },
        {
            "method": "GET",
            "rel": "up",
            "type": "application/vnd.sas.collection",
            "itemType": "application/vnd.sas.data.provider",
            "href": "/dataTables/providers",
            "uri": "/dataTables/providers"
        },
        {
            "method": "GET",
            "rel": "dataSources",
            "type": "application/vnd.sas.collection",
            "itemType": "application/vnd.sas.data.source",
            "href": "/dataSources/providers/cas/sources",
            "uri": "/dataSources/providers/cas/sources"
        }
    ],
    version: 1
}

application/vnd.sas.data.source

The application/vnd.sas.data.source media type describes the complete details of a data source.

Link Relations

Relation	Method	Description
`self`	`GET`	Returns the link to the full/complete representation of the source. URI: `/dataSources/providers/{providerId}/sources/{sourceId}` Type: `application/vnd.sas.data.source`
`alternate`	`GET`	Returns the link to the summary representation of the source. Added source summary representation. Since: 2 URI: /dataSources/providers/{providerId}/sources/{sourceId} Type: `application/vnd.sas.data.source.summary`
`sessionScoped`	`GET`	Returns the link to the current page of the (filtered) collection with the `sessionId` query parameter included. This link exists only if the `sessionId` query parameter is passed in or the`preserveSession` is set to true. URI: `/dataSources/providers/{providerId}/sources/{sourceId}?sessionId={sessionId}` Type: `application/vnd.sas.data.source`
`session`	`GET`	Returns a link to get the session for accessing this collection. This link is included if the client request includes the `sessionId` query parameter or if the `preserveSession` query parameter is set to true. HREF: `/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}` Type: `application/vnd.sas.data.session`
`up`	`GET`	Returns a link to the collection of root data sources in this hierarchy. Note this up link never has the `sessionId` query parameter on it. If this link is followed, the sessionId's value must be maintained by the consuming application. URI: `/dataSources/providers/{providerId}/sources/` Type: `application/vnd.sas.collection` Item Type: `application/vnd.sas.data.source`
`children`	`GET`	Returns a link to the collection of child data sources that belong to this data source URI: /dataSources/providers/{providerId}/sources/{sourceId}/children Type: `application/vnd.sas.collection` Item Type: `application/vnd.sas.data.source`
`parent`	`GET`	Returns a link to the parent source of this source. This is only available if the source has a parent source URI: /dataSources/providers/{providerId}/sources/{parentSourceId} Type: `application/vnd.sas.data.source`
`tables`	`GET`	Returns a link to the collection of tables for this data source. This should be omitted if the source `hasTables` member is set to false. HREF: `/dataTables/dataSources/{dataSourceId}/tables` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.table`
`engines`	`GET`	Returns a link to the collection of engines for this data source. This should be omitted if the source `hasEngines` member is set to false. Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.engine`

Members

Name	Type	Description
`version`	`integer`	Returns the media type's schema version number. This representation is version 1.
`id`	`string`	Returns the data source's unique identifier.
`providerId`	`string`	Returns the identifier of the provider the data source is contained within.
`parentId`	`string`	Returns the identifier of the data source's parent data source. Should be omitted or null if the data source has no parent data source.
`name`	`string`	Returns the non-unique name (such as the display name) of the data source.
`type`	`string`	Returns the data source's type (such as casServer, caslib, schema, etc.)
`description`	`string`	Returns a brief description of the data source.
`hasTables`	`boolean`	Returns true if this data source contains tables, false otherwise.
`hasEngines`	`boolean`	Returns true if this data source contains engines, false otherwise.
`createdBy`	`string`	Returns the user ID who created this data source.
`modifiedBy`	`string`	Returns the last user ID to modify this data source.
`creationTimeStamp`	`string`	Returns the formatted time stamp when the data source was created, in yyyy-mm-ddThh:mm:ssZ format.
`modifiedTimeStamp`	`string`	Returns the formatted time stamp when the data source was created, in yyyy-mm-ddThh:mm:ssZ format.
`attributes`	`object`	Returns an object containing arbitrary types (objects, arrays, numbers, Booleans). See the generic attributes model for more information.
`links`	`array of link objects`	Returns links that apply to related resources or operations. See the above link relations table for a description of the link types.

application/vnd.sas.data.source+json


 {
  "version": 1,
  "id": "2bdc7d5b-3c52-44f9-84e6-2f25f6a42e8d",
  "name": "Mike's DB Server",
  "description": "The database server on Mike's computer",
  "providerId": "jdbc",
  "type": "dbServer",
  "hasTables": false,
  "hasEngines": false,
  "creationTimeStamp": "2000-06-10T09:18:08.000Z",
  "modifiedTimeStamp": "2015-07-07T16:19:44.000Z",
  "createdBy": "bob",
  "modifiedBy": "bob",
  "attributes": {
    "extraAttr1": true,
    "extraAttr2": 100,
    "extraAttr3": "extra attribute for example"
  },
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/jdbc/sources/2bdc7d5b-3c52-44f9-84e6-2f25f6a42e8d",
      "uri": "/dataSources/providers/jdbc/sources/2bdc7d5b-3c52-44f9-84e6-2f25f6a42e8d",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/jdbc/sources",
      "uri": "/dataSources/providers/jdbc/sources",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "children"
      "href": "/dataSources/providers/jdbc/sources/2bdc7d5b-3c52-44f9-84e6-2f25f6a42e8d/children",
      "uri": "/dataSources/providers/jdbc/sources/2bdc7d5b-3c52-44f9-84e6-2f25f6a42e8d/children",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source"
    }
  ]
}

application/vnd.sas.data.source.summary

The application/vnd.sas.data.source.summary media type describes the summary details of a data source. Note that this summary media type is not the default media type for its respective collection. Instead, the default is the application/vnd.sas.data.source media type. If you want to retrieve this media type.

instead, specify the Accept-Item header as application/vnd.sas.data.source.summary+json on the GET /providers/{providerId}/sources request.

Link Relations

application/vnd.sas.data.source.summary has the same link relations as application/vnd.sas.data.source.

Members

application/vnd.sas.data.source.summary has all of the members of the application/vnd.sas.data.source media type. The attributes member's content varies depending on the provider.

This is representation version 1.

application/vnd.sas.data.session

The application/vnd.sas.data.session media type describes the complete details of a session.

Link Relations

Relation	Method	Description
`self`	`GET`	Returns a link to the representation of the session. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}` Type: `application/vnd.sas.data.session`
`delete`	`DELETE`	Returns a link to destroy this session instance. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}`
`provider`	`GET`	Returns a link to the session's respective provider URI: `/dataSources/providers/{providerId}` Type: `application/vnd.sas.data.provider`

Members

Name	Type	Description
`version`	`integer`	Returns the media type's schema version number. This representation is version 1.
`id`	`string`	Returns the unique session identifier.
`providerId`	`string`	Returns the provider identifier for this session.
`owner`	`string`	Returns the user ID of the owner of the session.
`attributes`	`object`	Returns an object containing arbitrary types (objects, arrays, numbers, Booleans). See the generic attributes model for more information.
`links`	`array of link objects`	Returns links that apply to related resources or operations. See the above link relations table for a description of the link types.

application/vnd.sas.data.session+json


 {
  "version": 1,
  "id": "d75b412f-6004-4a03-9e6a-f447fdfc1eff",
  "providerId": "cas",
  "owner": "bob",
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
      "uri": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
      "type": "application/vnd.sas.data.session"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
      "uri": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

application/vnd.sas.data.engine

The application/vnd.sas.data.engine media type describes the complete details of an engine.

Link Relations

Relation	Method	Description
`self`	`GET`	Returns a link to the full or complete representation of the engine. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}` Type: `application/vnd.sas.data.engine`
`sessionScoped`	`GET`	Returns a link to the engine with the `sessionId` query parameter included. This link exists only if the `sessionId` query parameter is passed in or the`preserveSession` is set to true. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/sources/engines/{engineName}?sessionId={sessionId}` Type: application/application/vnd.sas.data.engine
`up`	`GET`	Returns a link to the collection of all engines for the data source URI: /dataSources/providers/{providerId}/sources/{sourceId}/engines Type: `application/vnd.sas.collection` Item type: application/vnd.sas.data.engine
`provider`	`GET`	Returns a link to the provider for this engine URI: /dataSources/providers/{providerId} Type: `application/vnd.sas.data.provider`
`dataSource`	`GET`	Returns a link to this engine's parent data source URI: /dataSources/providers/{providerId}/sources/{sourceId} Type: `application/vnd.sas.data.source`
`definition`	`GET`	Returns a link to this engine's associated definition represented as a schema. This is omitted if the engine does not have an associated definition. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}/definition` Type: `application/schema`
`session`	`GET`	Returns a link to get the session for accessing this engine. This link is included if the client request includes the `?sessionId` query parameter or if the `preserveSession` query parameter is set to true. HREF: `/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}` Type: `application/vnd.sas.data.session`

Members

Name	Type	Description
`version`	`integer`	Returns this media type.

application/vnd.sas.data.engine+json


 {
  "version": 1,
  "name": "SASIONZA",
  "nickname": "Netezza",
  "legalName": "The SAS Netezza engine",
  "providerId": "compute",
  "dataSourceId": "myComputeContext",
  "licensed": true,
  "hasDefinition": true,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
      "type": "application/vnd.sas.data.engine"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.engine"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "dataSource",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "definition",
      "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
      "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
      "type": "application/schema"
    }
  ]
}

application/schema+json

The application/schema+json describes the options for the engine using JSON Schema.


 {
    "$schema": "http://www.sas.com/schemas/engines/SASIONZA",
    "title": "SASIONZA",
    "description": "SASIONZA description",
    "type": "object",
    "additionalProperties": false,
    "required": [
        "engineName"
    ],
    "properties": {
        "engineName": {
            "label": "SASIONZA",
            "description": "SASIONZA description",
            "type": "string",
            "default": "SASIONZA",
            "enum": [
                "SASIONZA"
            ]
        },
        "physicalName": {
            "label": "Physical name",
            "description": "physicalName description",
            "type": "string"
        },
        "custom": {
            "label": "custom libname options",
            "description": "custom libname option description",
            "type": "string"
        },
        "options": {
            "type": "object",
            "additionalProperties": false,
            "description": "the libname options",
            "properties": {
                "PRESERVE_COL_NAMES": {
                    "label": "Preserve column names as in the DBMS",
                    "description": "PRESERVE_COL_NAMES is used to create DBMS columns with non-standard SAS characters",
                    "default": "YES",
                    "aliases": [
                        "QUOTE_NAMES",
                        "PRES_COL",
                        "DBMIXED"
                    ],
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "DBINDEX": {
                    "label": "Whether to use indexes",
                    "description": "DBINDEX specifies whether to use database indexes during a join to a SAS data set",
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "CONNECTION": {
                    "label": "Type of connection",
                    "description": "CONNECTION determines whether operations against a libref share a connection to the DBMS",
                    "default": "SHAREDREAD",
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "DEFER": {
                    "label": "Whether to defer a connection until needed",
                    "description": "DEFER determines when the connection to the DBMS occurs",
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "SPOOL": {
                    "label": "Whether to create a spool file for two-pass processing",
                    "description": "SPOOL specifies whether to create a utility spool file during read transactions that read data more than once",
                    "default": "YES",
                    "type": "string"
                },
                "CONNECTION_GROUP": {
                    "label": "Connection group name",
                    "description": "CONNECTION_GROUP causes operations against multiple librefs and operations against multiple Pass-Through Facility CONNECT statements to share a connection to the DBMS",
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "READ_LOCK_TYPE": {
                    "label": "Lock type for reading",
                    "description": "READ_LOCK_TYPE specifies how to lock the table during read operations",
                    "default": "EMPTY",
                    "aliases": [
                        "READLOCK_TYPE"
                    ],
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "UPDATE_LOCK_TYPE": {
                    "label": "Lock type for updating",
                    "description": "UPDATE_LOCK_TYPE specifies how to lock the table during update operations",
                    "default": "EMPTY",
                    "aliases": [
                        "UPDATELOCK_TYPE"
                    ],
                    "type": "string"
                },
                "DBCONINIT": {
                    "label": "User-defined connection initialization command",
                    "description": "DBCONINIT is a user-defined initialization command to be executed immediately after every connection to the DBMS that is within the scope of the LIBNAME",
                    "aliases": [
                        "DBINITCMD",
                        "INITCMD"
                    ],
                    "type": "string",
                    "pattern": "^\".*?\"$",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "DBCONTERM": {
                    "label": "User-defined connection termination command",
                    "description": "DBCONTERM is a user-defined termination command to be executed before every disconnect from the DBMS that is within the scope of the LIBNAME",
                    "aliases": [
                        "DBTERMCMD",
                        "TERMCMD"
                    ],
                    "type": "string",
                    "pattern": "^\".*?\"$",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "DBPROMPT": {
                    "label": "Prompt user for connection information",
                    "description": "DBPROMPT Specifies whether SAS displays a window that prompts for connection information.",
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "PRESERVE_TAB_NAMES": {
                    "label": "Preserve DBMS table names",
                    "description": "PRESERVE_TAB_NAMES is used to show table names as defined in the database",
                    "default": "YES",
                    "aliases": [
                        "PRES_TAB",
                        "QUOTE_TABLE_NAMES"
                    ],
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "REREAD_EXPOSURE": {
                    "label": "Allow random access to a table when rereading a row",
                    "description": "REREAD_EXPOSURE specifies whether the SAS/ACCESS engine behaves like a random access engine for the scope of the LIBNAME statement",
                    "default": "NO",
                    "aliases": [
                        "REREAD_EXPOSURE_OK"
                    ],
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "DBLIBINIT": {
                    "label": "User-defined library initialization command",
                    "description": "DBLIBINIT is a user-defined initialization command to be executed once within the scope of the LIBNAME statement or libref that established the first connection to the DBMS",
                    "type": "string",
                    "pattern": "^\".*?\"$"
                },
                "DBLIBTERM": {
                    "label": "User-defined library termination command",
                    "description": "DBLIBTERM is a user-defined termination command to be executed once, before the DBMS disconnect that is associated with the first connection made by the LIBNAME statement or libref",
                    "type": "string",
                    "pattern": "^\".*?\"$"
                },
                "VALIDVARNAME": {
                    "label": null,
                    "description": null,
                    "default": "V7",
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "DIRECT_SQL": {
                    "label": "Pass generated SELECT SQL to the DBMS",
                    "description": "DIRECT_SQL specifies whether generated SQL is passed to the DBMS for processing-",
                    "default": "YES",
                    "type": "array",
                    "items": {
                        "type": "string",
                        "enum": [
                            "NO",
                            "NOMULTOUTJOINS",
                            "NOFUNCTIONS",
                            "NONE",
                            "ONCE",
                            "NOGENSQL",
                            "NOWHERE",
                            "YES"
                        ]
                    }
                },
                "DBGEN_NAME": {
                    "label": "How to rename DBMS columns containing invalid SAS characters",
                    "description": "DBGEN_NAME causes automatic renaming of DBMS columns containing characters that SAS does not allow",
                    "default": "DBMS",
                    "type": "string",
                    "enum": [
                        "SAS",
                        "DBMS"
                    ],
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "DBMAX_TEXT": {
                    "label": "Maximum text length",
                    "description": "DBMAX_TEXT determines the length of a very long DBMS character data type that is read into or written from SAS when using a SAS/ACCESS engine",
                    "default": 1024,
                    "aliases": [
                        "TEXTSIZE"
                    ],
                    "type": "integer",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "PRESERVE_NAMES": {
                    "label": null,
                    "description": null,
                    "default": "YES",
                    "aliases": [
                        "PRES"
                    ],
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "DBCREATE_TABLE_OPTS": {
                    "label": "Options used in DBMS CREATE TABLE",
                    "description": "DBCREATE_TABLE_OPTS specifies DBMS-specific syntax to add to the end of the DBMS CREATE TABLE statement",
                    "aliases": [
                        "POST_STMT_OPTS"
                    ],
                    "type": "string"
                },
                "DBCOMMIT": {
                    "label": "How often to COMMIT insert, update, or delete transactions",
                    "description": "DBCOMMIT causes an automatic COMMIT after a specified number of rows have been processed",
                    "type": "integer"
                },
                "DBNULLKEYS": {
                    "label": "Whether to check for null keys when generating where clauses",
                    "description": "DBNULLKEYS controls the format of the WHERE clause when you use the DBKEY= data set option",
                    "default": "YES",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "MULTI_DATASRC_OPT": {
                    "label": "Multi data source optimization",
                    "description": "MULTI_DATASRC_OPT (new for V9) can be used instead of DBKEY data set option when joining a large DBMS table and a relatively small SAS data set",
                    "default": "NONE",
                    "type": "string",
                    "enum": [
                        "NONE",
                        "IN_CLAUSE"
                    ]
                },
                "DBSLICEPARM": {
                    "label": "Threaded DBMS access",
                    "description": "DBSLICEPARM (new for V9) allows automatic generation of partitioning WHERE clauses if the DBSLICE data set option is not set.  Value consists of text and the maximum number of threads",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "DIRECT_EXE": {
                    "label": "Pass DELETE  to the DBMS",
                    "description": "DIRECT_EXE (new for 9.1) enables you to pass an SQL statement directly to the database via implicit passthru",
                    "type": "string",
                    "enum": [
                        "DELETE"
                    ]
                },
                "DBSASLABEL": {
                    "label": "Column label type",
                    "description": "DBSASLABEL specifies the type of column labels an engine uses",
                    "default": "COMPAT",
                    "type": "string",
                    "enum": [
                        "COMPAT",
                        "DBMS",
                        "NONE"
                    ]
                },
                "DBCHAR_CONSTANT_IS_SPOOFED": {
                    "label": null,
                    "description": null,
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "UTILCONN_TRANSIENT": {
                    "label": "Whether to automatically drop utility connections",
                    "description": "UTILCONN_TRANSIENT (new for 9.1) determines whether a utility connection gets automatically dropped as soon as it is no longer in use.",
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "THREADED_SQL": {
                    "label": null,
                    "description": null,
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "DBMSTEMP": {
                    "label": "Whether tables created by SAS are temporary",
                    "description": "DBMSTEMP specifies whether SAS creates temporary or permanent tables",
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "SQL_FUNCTIONS_COPY": {
                    "label": "Where to write the current in-memory functions list",
                    "description": "SQL_FUNCTIONS_COPY writes the functions associated with this particular LIBNAME statement to a SAS data set or the SAS log",
                    "type": "string"
                },
                "SELECTS_WITH_UNION": {
                    "label": null,
                    "description": null,
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "ALLOWED_SQLCODES": {
                    "label": "What warnings and errors to ignore",
                    "description": "ALLOWED_SQLCODES_DESC specifies the SQL warnings and errors to ignore during preparation and execution",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "OPTIMIZE_DATETIME": {
                    "label": null,
                    "description": null,
                    "default": "YES",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "USER": {
                    "label": "User",
                    "description": "USER specifies the Netezza user name (also called the user ID) that you use to connect to your database",
                    "aliases": [
                        "UID"
                    ],
                    "type": "string",
                    "pattern": "^\".*?\"$",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "PWD": {
                    "label": "Password",
                    "description": "PASSWORD specifies the password that is associated with your Netezza user name",
                    "aliases": [
                        "PASSWORD",
                        "PW",
                        "PASS"
                    ],
                    "type": "string",
                    "pattern": "^\".*?\"$",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "DATASRC": {
                    "label": "ODBC datasourc",
                    "description": "DATASRC specify the configured Netezza ODBC datasource to which you want to connect",
                    "aliases": [
                        "DS",
                        "DSN"
                    ],
                    "type": "string",
                    "pattern": "^\".*?\"$",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "DATABASE": {
                    "label": "Database",
                    "description": "DATABASE specifies the name of the database on the Netezza Performance Server",
                    "aliases": [
                        "DB"
                    ],
                    "type": "string",
                    "pattern": "^\".*?\"$",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "SERVER": {
                    "label": "Server",
                    "description": "SERVER specifies the server or IP address of the Netezza performance server to which you want to connect",
                    "type": "string",
                    "pattern": "^\".*?\"$",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "SQL_FUNCTIONS": {
                    "label": "Pass functions to the DBMS that match those supported by SAS",
                    "description": "SQL_FUNCTIONS  (new for 9.0) specifies that functions that match those that are supported by SAS should be passed to the DBMS",
                    "type": "string"
                },
                "IGNORE_READ_ONLY_COLUMNS": {
                    "label": "Specify the value for IGNORE_READ_ONLY_COLUMNS",
                    "description": "IGNORE_READ_ONLY_COLUMNS Specifies whether to ignore or include columns whose data types are read-only when generating an SQL statement for inserts or updates",
                    "default": "NO",
                    "aliases": [
                        "IGNORE_READONLY"
                    ],
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "LOGIN_TIMEOUT": {
                    "label": "Login timeout, in seconds",
                    "description": "LOGIN_TIMEOUT specifies how long the ODBC driver waits to make a connection before returning to the application",
                    "type": "integer",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "AUTOCOMMIT": {
                    "label": "Whether to COMMIT immediately after a transaction",
                    "description": "AUTOCOMMIT indicates whether updates are committed immediately after they are submitted",
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "READBUFF": {
                    "label": "Block read buffer size",
                    "description": "READBUFF specifies the number of rows in a single fetch",
                    "aliases": [
                        "ROWSET",
                        "ROWSET_SIZE"
                    ],
                    "type": "integer",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "SCHEMA": {
                    "label": "Xchema name",
                    "description": "Specifies the schema name",
                    "aliases": [
                        "OWNER"
                    ],
                    "type": "string"
                },
                "QUALIFIER": {
                    "label": "User-defined qualifier to identify an object",
                    "description": "QUALIFIER allows identification of such database objects as tables and views with the specified qualifier",
                    "type": "string"
                },
                "DUMMY_CONNECT": {
                    "label": null,
                    "description": null,
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "CONNECT_OPTIONS": {
                    "label": null,
                    "description": null,
                    "aliases": [
                        "CONOPTS"
                    ],
                    "type": "string",
                    "pattern": "^\".*?\"$",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "BULKUNLOAD": {
                    "label": "Whether to call the Remote External Table interface to retrieve data from the server.",
                    "description": "BULDUNLOAD specifies whether to rapidly retrieves (fetches) a large number of rows from a data set",
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "QUERY_TIMEOUT": {
                    "label": "Number of seconds to wait before canceling query",
                    "description": "QUERY_TIMEOUT specifies the number of seconds of inactivity to wait before canceling a query",
                    "aliases": [
                        "TIMEOUT"
                    ],
                    "type": "integer",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "TRACE": {
                    "label": "Whether to trace debugging options",
                    "description": "TRACE specifies whether to turn on tracing information that is used in debugging",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "TRACEFILE": {
                    "label": "Trace output filename",
                    "description": "TRACEFILE  specifies the filename to which the DBMS driver manager writes trace information",
                    "type": "string",
                    "pattern": "^\".*?\"$",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "QUOTE_CHAR": {
                    "label": "Quotation mark character for delimiting identifiers",
                    "description": "QUOTE_CHAR specifies which quotation mark character to use when delimiting identifiers",
                    "type": "string"
                },
                "PORT": {
                    "label": "Port",
                    "description": "PORT specifies the name of the database on the Netezza Performance Server",
                    "default": "5480",
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "READ_ONLY": {
                    "label": "Read Only",
                    "description": "READ_ONLY specifies whether to connect to the Netezza database in read-only mode(YES) or read-write(NO) mode",
                    "default": "NO",
                    "aliases": [
                        "READONLY"
                    ],
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "SHOW_SYSTEM": {
                    "label": null,
                    "description": null,
                    "default": "NO",
                    "aliases": [
                        "SHOWSYSTEM",
                        "SHOW_SYSTEM_TABLES",
                        "SHOWSYSTEMTABLES"
                    ],
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "INSERTBUFF": {
                    "label": "Block insert buffer size",
                    "description": "INSERTBUFF specifies the number of rows in a single insert",
                    "default": 1,
                    "type": "integer"
                },
                "DISTRIBUTE": {
                    "label": null,
                    "description": null,
                    "aliases": [
                        "DISTRIBUTE_ON"
                    ],
                    "type": "string"
                },
                "STRINGDATES": {
                    "label": "Whether to read dates or times as character strings",
                    "description": "STRINGDATES specifies whether to read date and time values from the database as character strings or as numeric date values",
                    "default": "NO",
                    "aliases": [
                        "STRDATES"
                    ],
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string",
                    "tags": [
                        "DBI_PASSTHRU_OPTION"
                    ]
                },
                "CHAR_AS_NCHAR": {
                    "label": "Whether to use NCHAR oR NVARCHAR as the default column type",
                    "description": "CHAR_AS_NCHAR specifies the default character type to use for table columns",
                    "default": "NO",
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                },
                "SYNONYMS": {
                    "label": "Whether to show only table and view synonyms",
                    "description": "SHOW_SYNONYMS specifies whether to show only synonyms for tables and views for the current user or schema",
                    "aliases": [
                        "SHOW_SYNONYMS"
                    ],
                    "enum": [
                        "YES",
                        "NO"
                    ],
                    "type": "string"
                }
            }
        }
    }
}

application/vnd.sas.data.source.definition

Add Engines Collection.

The application/vnd.sas.data.source.definition media type describes the complete details of a data source definition.

Link Relations

Relation	Method	Description
`self`	`GET`	Returns a link to the full or complete representation of the data source definition. URI: `/dataSources/providers/{providerId}/sourcesDefinitions/{sourceDefinitionId}` Type: `application/vnd.sas.data.source.definition`
`up`	`GET`	Returns a link to the collection of all engines for the data source definition. URI: `/dataSources/providers/{providerId}/sourcesDefinitions/{sourceDefinitionId}` Type: `application/vnd.sas.collection` Item type: application/vnd.sas.data.source.definition
`export`	`GET`	Returns the transfer data of the data source definition. URI: `/dataSources/providers/{providerId}/sourcesDefinitions/{sourceDefinitionId}` Type: `application/vnd.sas.transfer.object`
`provider`	`GET`	Returns a link to the provider for the data source definition. URI: `/dataSources/providers/{providerId}` Type: `application/vnd.sas.data.provider`
`update`	`PUT`	Returns a link to update the data source definition. URI: `/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}` Type: `application/vnd.sas.data.source.definition`
`import`	`PUT`	Imports the provided transfer data to update an existing data source definition or create a new one with the given ID. URI: `/dataSources/providers/{providerId}/sourcesDefinitions/{sourceDefinitionId}` Type: `application/vnd.sas.transfer.object` Item type: application/vnd.sas.summary
`delete`	`DELETE`	Returns a link to delete the data source definition. URI: `/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}`

Members

Name	Type	Description
`version`	`integer`	Returns the media type's schema version number. This representation is version 1.
`id`	`string`	Returns the unique identifier of this data source definition
`name`	`string`	Returns the non-unique name of this data source definition
`description`	`string`	Returns the data source definition's description
`providerId`	`string`	Returns the unique identifier of this data source definition's provider.
`dataSourceId`	`string`	Returns the unique identifier of this data source definition's associated data source.
`defaultLibref`	`string`	Returns the default libref.
`attributes`	`object`	Returns an object containing name/value pairs where the values might be any type, such as a number, string, object, or array.
`links`	`array of link objects`	Returns links that apply to related resources or operations. See the above link relations table for a description of the link types.

application/vnd.sas.data.source.definition+json


 {
  "creationTimeStamp": "2017-04-12T13:29:14.212Z",
  "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
  "createdBy": "bob",
  "modifiedBy": "bob",
  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
  "name": "sourceDefName1",
  "providerId": "Compute",
  "description": "my description",
  "dataSourceId": "myComputeContext",
  "defaultLibref": "ORAFW"
  "attributes": {
    "key1": "value1",
    "key2": 5,
    "key3": false,
    "key4": null,
    "key5": {
      "key5-1": "value5-1",
      "Key5-2": null
    },
    "key6": "value6",
    "key7": "value7",
    "key8": "value8",
    "key9": "value9",
    "key10": "value10"
  },
  "version": 2,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "PUT",
      "rel": "update",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "type": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "DELETE",
      "rel": "delete",
      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/Compute/sourceDefinitions",
      "uri": "/dataSources/providers/Compute/sourceDefinitions",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.source.definition"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/Compute",
      "uri": "/dataSources/providers/Compute",
      "type": "application/vnd.sas.data.provider"
    }
  ]
}

Resource Relationships

The diagram below shows the relationships between the resources in this API.

Data Sources entity relationship diagram

Pagination, Sorting, and Filtering

pagination - The default page limit is set to 50 for all collections. This limit can be modified by setting the ?limit query parameter when applicable.
sorting - Refer to 'Sorting and Filtering' section of specific endpoint for details.
filtering:
- Standard functions are supported.
- Example query strings are listed below:
- Filter by the name field of a connection - ?filter=contains(name,"myDBServer")
- Filter by the name field startingWith - ?filter=startsWith(name,"myDB")
- Filter by name or description field - ?filter=or(contains(name,"myDBSer"),contains(description,"my database"))
- Refer to 'Sorting and Filtering' section of specific endpoint for details.

Root

Path: /

Links

The GET / response includes the following links:

Relation	Method	Description
`providers`	`GET`	Returns a collection of data source providers. URI: `/dataSources/providers` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.provider.summary`

Providers

Path: /providers

Links

The response includes the following links:

Relation	Method	Description
`collection`	`GET`	Returns the first page of the collection, without the sorting or filtering criteria. URI: `/dataSources/providers` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.provider`
`self`	`GET`	Returns the current page of the collection. URI: `/dataSources/providers` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.provider`
`first`	`GET`	Returns the first page of collection results. (start=0) URI: `/dataSources/providers` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.provider`
`prev`	`GET`	Returns the previous page of collection results. URI: `/dataSources/providers` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.provider`
`next`	`GET`	Returns the next page of collection results. URI: `/dataSources/providers` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.provider`
`last`	`GET`	Returns the last page of collection results. URI: `/dataSources/providers` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.provider`
`up`	`GET`	Returns the root of this API. URI: `/dataSources` Type: `application/vnd.sas.collection`

Sorting and Filtering

sorting- A default sort order of ascending by ID is automatically applied to the contents of the collection. An alternate sort order might be specified via the ?sortBy query parameter. A sort order can only be applied to the simple fields of a resource on which filtering is supported. Methods within this API do not support the various strength options as outlined by the sorting guidelines.
filtering - An optional ?filter parameter might be specified to query the exact set of identities that are included within the collection. Standard functional notation is supported.
- The list of fields that can be searched on for providers include the following: ID.
- The response when invalid fields are used in a filter parameter varies provider to provider. Some providers return 400 when invalid fields are used in filter where as others return empty collection.

Sources

Path: /providers/{providerId}/sources

Links

The response includes the following links:

Relation	Method	Description
`collection`	`GET`	Returns the first page of the collection, without the sorting or filtering criteria. URI: `/dataSources/providers/{providerId}/sources` Type: `application/vnd.sas.collection` Item type: `applcation/vnd.sas.data.source`
`self`	`GET`	Returns the current page of the collection. URI: `/dataSources/providers/{providerId}/sources` Type: `application/vnd.sas.collection` Item type: `applcation/vnd.sas.data.source`
`first`	`GET`	Returns the first page of collection results. (start=0) URI: `/dataSources/providers/{providerId}/sources` Type: `application/vnd.sas.collection` Item type: `applcation/vnd.sas.data.source`
`prev`	`GET`	Returns the previous page of collection results. URI: `/dataSources/providers/{providerId}/sources` Type: `application/vnd.sas.collection` Item type: `applcation/vnd.sas.data.source`
`next`	`GET`	Returns the next page of collection results. URI: `/dataSources/providers/{providerId}/sources` Type: `application/vnd.sas.collection` Item type: application/vnd.sas.source
`last`	`GET`	Returns the last page of collection results. URI: `/dataSources/providers/{providerId}/sources` Type: `application/vnd.sas.collection` Item type: application/vnd.sas.source
`up`	`GET`	Returns the parent provider of this collection. URI: `/dataSources/providers/{providerId}` Type: `application/vnd.sas.data.provider`

Sorting and Filtering

sorting- A default sort order of ascending by name is automatically applied to the contents of the collection. An alternate sort order might be specified via the ?sortBy query parameter. A sort order can only be applied to the simple fields of a resource on which filtering is supported. Methods within this API do not support the various strength options as outlined by the sorting guidelines.
filtering - An optional ?filter parameter might be specified to query the exact set of identities that are included within the collection. Standard functional notation is supported.
- The list of fields that can be searched on for data sources by default across all providers include the following: name, description.
- Some providers may support filtering on additional fields.
- For example
- Compute provider supports filtering on modifiedBy, creationTimeStamp, modifiedTimeStamp.
- The response when invalid fields are used in a filter parameter varies provider to provider. Some providers return 400 when invalid fields are used in filter where as others return empty collection.

Children

Path: /providers/{providerId}/sources/{sourceId}/children

Links

The response includes the following links:

Relation	Method	Description
`collection`	`GET`	Returns the first page of the collection, without the sorting or filtering criteria. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/children` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source`
`self`	`GET`	Returns the current page of the collection. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/children` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source`
`sessionScoped`	`GET`	Returns the current page of the (filtered) collection with the `sessionId` query parameter included. This link exists only if the `sessionId` query parameter is passed in or the`preserveSession` is set to true. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/children?sessionId={sessionId}` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source`
`first`	`GET`	Returns the first page of collection results. (start=0) URI: `/dataSources/providers/{providerId}/sources/{sourceId}/children` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source`
`prev`	`GET`	Returns the previous page of collection results. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/children` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source`
`next`	`GET`	Returns the next page of collection results. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/children` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source`
`last`	`GET`	Returns the last page of collection results. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/children` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source`
`up`	`GET`	Returns the parent source of this collection. URI: `/dataSources/providers/{providerId}/sources/{sourceId}` Type: `application/vnd.sas.data.source`
`session`	`GET`	Provides a link to get the session for accessing this collection. This link is included if the client request includes the `?sessionId` query parameter or if the `preserveSession` query parameter is set to true. HREF: `/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}` Type: `application/vnd.sas.data.session`

Sorting and Filtering

sorting- A default sort order of ascending by name is automatically applied to the contents of the collection. An alternate sort order might be specified via the ?sortBy query parameter. A sort order can only be applied to the simple fields of a resource on which filtering is supported. Methods within this API do not support the various strength options as outlined by the sorting guidelines.
filtering - An optional ?filter parameter might be specified to query the exact set of identities that are included within the collection. Standard functional notation is supported.
- The list of fields that can be searched on for data sources and connections by default across all providers include the following: name, description.
- Some providers may support filtering on additional fields.
- For example
- Compute provider supports filtering on modifiedBy, creationTimeStamp, modifiedTimeStamp.
- Response to invalid fields in filter varies provider to provider. Some providers return 400 where as others just empty collection.

Engines

Path: /providers/{providerId}/sources/{sourceId}/engines

Links

The response includes the following links:

Relation	Method	Description
`collection`	`GET`	Returns the first page of the collection, without the sorting or filtering criteria. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/engines` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.engine`
`self`	`GET`	Returns the current page of the collection. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/engines` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.engine`
`sessionScoped`	`GET`	Returns the current page of the (filtered) collection with the `sessionId` query parameter included. This link exists only if the `sessionId` query parameter is passed in or the`preserveSession` is set to true. URI: /dataSources/providers/{providerId}/sources/{sourceId}/engines?sessionId={sessionId} Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.engine`
`first`	`GET`	Returns the first page of collection results. (start=0) URI: `/dataSources/providers/{providerId}/sources/{sourceId}/engines` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.engine`
`prev`	`GET`	Returns the previous page of collection results. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/engines` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.engine`
`next`	`GET`	Returns the next page of collection results. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/engines` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.engine`
`last`	`GET`	Returns he last page of collection results. URI: `/dataSources/providers/{providerId}/sources/{sourceId}/engines` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.engine`
`up`	`GET`	Returns the parent source of this collection. URI: `/dataSources/providers/{providerId}/sources/{sourceId}` Type: `application/vnd.sas.data.source`
`session`	`GET`	Provides a link to get the session for accessing this collection. This link is included if the client request includes the `?sessionId` query parameter or if the `preserveSession` query parameter is set to true. HREF: `/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}` Type: `application/vnd.sas.data.session`

Sorting and Filtering

sorting- A default sort order of ascending by name is automatically applied to the contents of the collection. An alternate sort order might be specified via the ?sortBy query parameter. A sort order can only be applied to the simple fields of a resource on which filtering is supported. Methods within this API do not support the various strength options as outlined by the sorting guidelines.
filtering - An optional ?filter parameter might be specified to query the exact set of identities that are included within the collection. Standard functional notation is supported.
- The list of fields that can be searched on engines by default include the following: name, nickname, providerId, licensed, hasDefinition, version.
- The response when invalid fields are used in a filter parameter varies provider to provider. Some providers return 400 where as others return empty collection.

sourceDefinitions

Path: /providers/{providerId}/sourceDefinitions

Links

The response includes the following links:

Relation	Method	Description
`collection`	`GET`	Returns the first page of the collection, without the sorting or filtering criteria. URI: `/dataSources/providers/{providerId}/sourceDefinitions` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source.definition`
`self`	`GET`	Returns the current page of the collection. URI: `/dataSources/providers/{providerId}/sourceDefinitions` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source.definition`
`first`	`GET`	Returns the first page of collection results. (start=0) URI: `/dataSources/providers/{providerId}/sourceDefinitions` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source.definition`
`prev`	`GET`	Returns the previous page of collection results. URI: `/dataSources/providers/{providerId}/sourceDefinitions` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source.definition`
`next`	`GET`	Returns the next page of collection results. URI: `/dataSources/providers/{providerId}/sourceDefinitions` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source.definition`
`last`	`GET`	Returns the last page of collection results. URI: `/dataSources/providers/{providerId}/sourceDefinitions` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.source.definition`
`up`	`GET`	Returns the parent provider of this collection. URI: `/dataSources/providers/{providerId}` Type: `application/vnd.sas.data.provider`
`createSourceDefinition`	`POST`	Provides a link to create a data source definition HREF: `/dataSources/providers/{providerId}/sourceDefinitions` Item type: `application/vnd.sas.data.source.definition`
`import`	`POST`	Imports a data source definition from the transfer data HREF: `/dataSources/providers/{providerId}/sourceDefinitions` Type: application/vnd.sas.transfer.object Response type: application/vnd.sas.summary

Sorting and Filtering

sorting- A default sort order of ascending by name is automatically applied to the contents of the collection. An alternate sort order might be specified via the ?sortBy query parameter. A sort order can only be applied to the simple fields of a resource on which filtering is supported. Methods within this API do not support the various strength options as outlined by the sorting guidelines.
filtering - An optional ?filter parameter might be specified to query the exact set of identities that are included within the collection. Standard functional notation is supported.
- The list of fields that can be searched on for source definitions by default include the following: id, name, providerId, dataSourceId, createdBy, creationTimeStamp, modifiedBy and modifiedTimeStamp.
- The response when invalid fields are used in a filter parameter varies provider to provider. Some providers return 400 where as others return empty collection.

Data Tables

Base URLs:

http://mock-dataTables.apifirst.unx.sas.com/dataTables

Terms of service Email: SAS Developers Web: SAS Developers

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Data Tables API works in concert with the Data Sources and Row Sets APIs to navigate, reference, and retrieve data in the SAS Viya ecosystem. The Data Tables API enables retrieval of metadata for data tables and their respective columns.
All GET operations have a corresponding HEAD with identical signature and semantics except the resource body is not returned.

Terminology:

table: represents a rectangular data structure that consists of rows and columns of uniform data.

data table: represents a rectangular data structure that consists of rows and columns of uniform data.

data source: represents a node in the data source hierarchy that can represent a server, library, or collection of tables.

column: represents a column of rectangular data.

row: represents a row of rectangular data.

cell: represents the value where a row and column intersect.

provider: represents a service that has registered itself as a provider of data table information. These services provide table and column metadata for specific environments such as SAS Compute Server or CAS.

session: represents a semi-permanent interactive information interchange between the client that uses this API and the provider service returning the metadata.

long poll: implements requests to either create (POST) a table, or get an existing job that can optionally wait at the server for the completion of the job. The maximum time out is 30 seconds. The job might return incomplete, in which case the user can reissue another long poll request.

Usage Notes

Overview

The Data Tables API is used to retrieve table and column metadata that is contained in the SAS Viya ecosystem.

Context

The Data Tables API works with the Data Sources and Row Sets APIs to navigate, reference, and retrieve data in the SAS Viya ecosystem. The Data Tables API enables retrieval of data table and column metadata.

Terminology

table

represents a rectangular data structure that consists of rows and columns of uniform data.

data table

represents a rectangular data structure that consists of rows and columns of uniform data.

data source

represents a node in the data source hierarchy that can represent a server, library, or collection of tables.

column

represents a column of rectangular data.

row

represents a row of rectangular data.

cell

represents the value where a row and column intersect.

provider

represents a service that has registered itself as a provider of data table information. These services provide table and column metadata for specific environments such as SAS Compute Server or CAS.

session

represents a semi-permanent interactive information interchange between the client that uses this API and the provider service returning the metadata.

long poll

implements requests to either create (POST) a table, or get an existing job that can optionally wait at the server for the completion of the job. The maximum time out is 30 seconds. The job might return incomplete, in which case the user can reissue another long poll request.

Error Codes

Error codes

The following list contains the set of error codes that are used in certain error conditions.

Error Code	HTTP Status Code	Description
11900	404	No provider found.
11901	400	The `sortBy` query parameter is not supported by this provider on this endpoint.
11902	400	The `filter` query parameter is not supported by this provider on this endpoint.
11906	400	The specified Accept-Item is invalid.
11916	503	The provider for the source is not available, or it is currently starting up.
11917	503	The provider is not available, or it is currently starting up.
11938	400	The path parameter with value is not valid.
11939	400	The request body is not valid.
11940	400	The query parameter with value is not valid.
11941	400	The path parameter is required.
11942	400	The multi-part form data is not valid.
11943	400	The multi-part form data is required.
11944	400	The URI fragment is not valid.

Note: Other error codes may be returned from respective provider services.

Operations

Root

Contains the operations for the root resource.

Get a list of top-level links

Code samples

# You can also use wget
curl -X GET http://mock-dataTables.apifirst.unx.sas.com/dataTables/ \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.api+json'


const headers = {
  'Accept':'application/vnd.sas.api+json'
};

fetch('http://mock-dataTables.apifirst.unx.sas.com/dataTables/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.api+json'
}

r = requests.get('http://mock-dataTables.apifirst.unx.sas.com/dataTables/', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.api+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataTables.apifirst.unx.sas.com/dataTables/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /

Returns a collection of links to the top-level collections surfaced through this API. HEAD is also supported.

Example responses

Root Hateoas links.

{
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "tables",
      "href": "/dataTables/dataSources/{dataSourceId}/tables",
      "uri": "/dataTables/dataSources/{dataSourceId}/tables",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "tables",
      "href": "/dataTables/dataSources/{dataSourceId}/tables",
      "uri": "/dataTables/dataSources/{dataSourceId}/tables",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "tables",
      "href": "/dataTables/dataSources/{dataSourceId}/tables",
      "uri": "/dataTables/dataSources/{dataSourceId}/tables",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "job",
      "href": "/dataTables/jobs/{jobId}",
      "uri": "/dataTables/jobs/{jobId}",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    }
  ]
}

{
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "tables",
      "href": "/dataTables/dataSources/{dataSourceId}/tables",
      "uri": "/dataTables/dataSources/{dataSourceId}/tables",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "tables",
      "href": "/dataTables/dataSources/{dataSourceId}/tables",
      "uri": "/dataTables/dataSources/{dataSourceId}/tables",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "tables",
      "href": "/dataTables/dataSources/{dataSourceId}/tables",
      "uri": "/dataTables/dataSources/{dataSourceId}/tables",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "job",
      "href": "/dataTables/jobs/{jobId}",
      "uri": "/dataTables/jobs/{jobId}",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	api

Tables

Contains the operations for the Data Tables resource.

Get a collection of tables

Code samples

# You can also use wget
curl -X GET http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json' \
  -H 'Accept-Item: application/vnd.sas.data.table+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json',
  'Accept-Item':'application/vnd.sas.data.table+json'
};

fetch('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json',
  'Accept-Item': 'application/vnd.sas.data.table+json'
}

r = requests.get('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
        "Accept-Item": []string{"application/vnd.sas.data.table+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /dataSources/{dataSourceId}/tables

Returns a collection of tables available from the named data source as application/vnd.sas.data.table or application/vnd.sas.data.table.summary resources. Standard paging, filtering, and sorting options are specified in the Parameters section below.

Parameters

Name	In	Type	Required	Description
Accept-Item	header	string	false	The desired column representation. The Accept-Item options are: application/vnd.sas.data.table+json application/vnd.sas.data.table.summary+json If the application/vnd.sas.data.table+json type is specified or there is no Accept-Item header, the tables are returned as the complete representation table objects.
dataSourceId	path	string	true	The name of the data source.
start	query	integer	false	The starting index of the first table in a page. Defaults to 0.
limit	query	integer	false	The maximum number of tables to return in this page of results. The actual number of returned tables might be less if the collection has been exhausted. Defaults to 10.
filter	query	string(filter-criteria)	false	Filter criteria for returned tables. The valid filter fields are name and type if supported by the provider. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries: Search by name starting with: .../{dataSourceId}/tables?filter=startsWith(name, 'tab') Search by name: .../{dataSourceId}/tables?filter=eq(name, 'table1') Search for multiple tables: .../{dataSourceId}/tables?filter=in(name, 'table1', 'table2', 'table3')
sortBy	query	string(sort-criteria)	false	Sort returned tables. The sort criteria supports the following fields in either ascending or descending order (name, type, createdBy, modifiedBy, creationTimeStamp and modifiedTimeStamp). Some sample sorts: Sort ascending by table name:.../{dataSourceId}/tables?sortBy=name:ascending Sort descending by table name:.../{dataSourceId}/tables?sortBy=name:descending The default sort is by name in ascending order.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session, and then terminates it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This has effect only when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided, the session created by the data service provider is not be terminated. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false, or not specified, the session is be terminated after the request is complete. The default is false.

Detailed descriptions

Accept-Item: The desired column representation.
The Accept-Item options are:

application/vnd.sas.data.table+json
application/vnd.sas.data.table.summary+json

If the application/vnd.sas.data.table+json type is specified or there is no Accept-Item header, the tables are returned as the complete representation table objects.

filter: Filter criteria for returned tables.
The valid filter fields are name and type if supported by the provider. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries:

Search by name starting with: .../{dataSourceId}/tables?filter=startsWith(name, 'tab')
Search by name: .../{dataSourceId}/tables?filter=eq(name, 'table1')
Search for multiple tables: .../{dataSourceId}/tables?filter=in(name, 'table1', 'table2', 'table3')

sortBy: Sort returned tables. The sort criteria supports the following fields in either ascending or descending order (name, type, createdBy, modifiedBy, creationTimeStamp and modifiedTimeStamp). Some sample sorts:

Sort ascending by table name:.../{dataSourceId}/tables?sortBy=name:ascending
Sort descending by table name:.../{dataSourceId}/tables?sortBy=name:descending

The default sort is by name in ascending order.

Enumerated Values

Parameter	Value
Accept-Item	application/vnd.sas.data.table+json
Accept-Item	application/vnd.sas.data.table.summary+json

Example responses

A pageable collection of table objects.

{
  "name": "tables",
  "accept": "application/vnd.sas.data.table application/vnd.sas.data.table.summary",
  "version": 2,
  "count": 730,
  "start": 0,
  "limit": 1,
  "items": [
    {
      "name": "AIRLINES",
      "providerId": "cas",
      "dataSourceId": "MYCASLIB",
      "type": "table",
      "creationTimeStamp": "2016-04-15T10:22:31.000Z",
      "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
      "attributes": {
        "loaded": true,
        "characterSet": "UTF8",
        "global": true,
        "caslibId": "MYCASLIB",
        "rowCount": 6048,
        "columnCount": 8,
        "sessionId": "6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
        "encoding": "utf-8",
        "serverId": "cas"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "type": "application/vnd.sas.data.table"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "type": "application/vnd.sas.data.table.summary"
        },
        {
          "method": "GET",
          "rel": "connectionAttributes",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "type": "application/vnd.sas.attributes"
        },
        {
          "method": "GET",
          "rel": "sessionScoped",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.table"
        },
        {
          "method": "GET",
          "rel": "session",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.session"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        },
        {
          "method": "GET",
          "rel": "source",
          "href": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "rows",
          "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.row"
        },
        {
          "method": "GET",
          "rel": "rowSet",
          "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.row.set"
        },
        {
          "method": "GET",
          "rel": "columns",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.column.summary"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataTables/providers/cas",
          "uri": "/dataTables/providers/cas",
          "type": "application/vnd.sas.data.provider"
        },
        {
          "method": "GET",
          "rel": "dataSource",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.source"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "next",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=10&limit=10",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=10&limit=10",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "last",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=730&limit=1",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=730&limit=1",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?start=0&limit=10",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "sessionScoped",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=0&limit=1",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=0&limit=1",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/cas/sources/cas~cas-shared-default~fs~MYCASLIB?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas~cas-shared-default~fs~MYCASLIB?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "session",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.session"
    }
  ]
}

{
  "name": "tables",
  "accept": "application/vnd.sas.data.table application/vnd.sas.data.table.summary",
  "version": 2,
  "count": 730,
  "start": 0,
  "limit": 1,
  "items": [
    {
      "name": "AIRLINES",
      "providerId": "cas",
      "dataSourceId": "MYCASLIB",
      "type": "table",
      "creationTimeStamp": "2016-04-15T10:22:31.000Z",
      "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
      "attributes": {
        "loaded": true,
        "characterSet": "UTF8",
        "global": true,
        "caslibId": "MYCASLIB",
        "rowCount": 6048,
        "columnCount": 8,
        "sessionId": "6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
        "encoding": "utf-8",
        "serverId": "cas"
      },
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "type": "application/vnd.sas.data.table"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "type": "application/vnd.sas.data.table.summary"
        },
        {
          "method": "GET",
          "rel": "connectionAttributes",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
          "type": "application/vnd.sas.attributes"
        },
        {
          "method": "GET",
          "rel": "sessionScoped",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.table"
        },
        {
          "method": "GET",
          "rel": "session",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.session"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.table"
        },
        {
          "method": "GET",
          "rel": "source",
          "href": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "rows",
          "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.row"
        },
        {
          "method": "GET",
          "rel": "rowSet",
          "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.row.set"
        },
        {
          "method": "GET",
          "rel": "columns",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.column.summary"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataTables/providers/cas",
          "uri": "/dataTables/providers/cas",
          "type": "application/vnd.sas.data.provider"
        },
        {
          "method": "GET",
          "rel": "dataSource",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.source"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "next",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=10&limit=10",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=10&limit=10",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "last",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=730&limit=1",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=730&limit=1",
      "type": "application/vnd.sas.collection"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?start=0&limit=10",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "sessionScoped",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=0&limit=1",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=0&limit=1",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataSources/providers/cas/sources/cas~cas-shared-default~fs~MYCASLIB?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas~cas-shared-default~fs~MYCASLIB?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "session",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.session"
    }
  ]
}

this is an example of an error that could be returned for bad requests

{
  "httpStatusCode": 400,
  "message": "example error message",
  "version": 2
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	tableCollection
400	Bad Request	An invalid request was made in one of the following scenarios: A negative start value is provided. A negative limit value is provided. A non-existent or unsupported field is specified in the sortBy parameter.	error
404	Not Found	The data source does not exist.	error

Create a new table

Code samples

# You can also use wget
curl -X POST http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Content-Type: application/vnd.sas.data.table.request+json' \
  -H 'Accept: application/vnd.sas.data.table.job+json'

const inputBody = '{
  "sourceArguments": {
    "tableUri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES"
  },
  "targetArguments": {
    "tableName": "AIRLINES",
    "replace": "true"
  }
}';
const headers = {
  'Content-Type':'application/vnd.sas.data.table.request+json',
  'Accept':'application/vnd.sas.data.table.job+json'
};

fetch('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/vnd.sas.data.table.request+json',
  'Accept': 'application/vnd.sas.data.table.job+json'
}

r = requests.post('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/vnd.sas.data.table.request+json"},
        "Accept": []string{"application/vnd.sas.data.table.job+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /dataSources/{dataSourceId}/tables

Creates a new table. If the Content-Type header is set to application/json, it maps to the application/vnd.ssa.data.table.request+json media type.

Body parameter

Example table request.

{
  "sourceArguments": {
    "tableUri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES"
  },
  "targetArguments": {
    "tableName": "AIRLINES",
    "replace": "true"
  }
}

Parameters

Name	In	Type	Required	Description
dataSourceId	path	string	true	The name of the data source.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session, and then terminates it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
wait	query	number(float)	false	This service implements "long poll", how long to wait for an update before returning anyway, in floating point seconds. The maximum is 30 seconds.
body	body	tableRequest	true	The table create request details to use for creating the table.

Example responses

Example table job.

{
  "id": "cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "type": "table",
  "state": "running",
  "duration": 0.255,
  "createdBy": "bob",
  "modifiedBy": "bob",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.data.table.job"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.job.execution.job"
    },
    {
      "method": "GET",
      "rel": "state",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "type": "text/plain"
    },
    {
      "method": "GET",
      "rel": "sourceTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "targetTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "log",
      "href": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1",
      "uri": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1"
    }
  ]
}

{
  "id": "cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "type": "table",
  "state": "running",
  "duration": 0.255,
  "createdBy": "bob",
  "modifiedBy": "bob",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.data.table.job"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.job.execution.job"
    },
    {
      "method": "GET",
      "rel": "state",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "type": "text/plain"
    },
    {
      "method": "GET",
      "rel": "sourceTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "targetTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "log",
      "href": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1",
      "uri": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1"
    }
  ]
}

{
  "id": "cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "type": "table",
  "state": "running",
  "duration": 0.255,
  "createdBy": "bob",
  "modifiedBy": "bob",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.data.table.job"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.job.execution.job"
    },
    {
      "method": "GET",
      "rel": "state",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "type": "text/plain"
    },
    {
      "method": "GET",
      "rel": "sourceTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "targetTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "log",
      "href": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1",
      "uri": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1"
    }
  ]
}

{
  "id": "cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "type": "table",
  "state": "running",
  "duration": 0.255,
  "createdBy": "bob",
  "modifiedBy": "bob",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.data.table.job"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.job.execution.job"
    },
    {
      "method": "GET",
      "rel": "state",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "type": "text/plain"
    },
    {
      "method": "GET",
      "rel": "sourceTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "targetTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "log",
      "href": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1",
      "uri": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1"
    }
  ]
}

this is an example of an error that could be returned for bad requests

{
  "httpStatusCode": 400,
  "message": "example error message",
  "version": 2
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
201	Created	Created. The requested table has both been created, and its respective job is in a terminal state (one of "completed", "canceled", "timedOut", "failed").	tableJob
202	Accepted	Accepted. The table creation has not completed.	tableJob
400	Bad Request	Bad request (the request is not well formed).	error
404	Not Found	Not found - typically the data source could not be found.	error

Response Headers

Status	Header	Type	Format	Description
201	Location	string		location of the completed job.
202	Location	string		location of the running job.

Upload a file

Code samples

# You can also use wget
curl -X POST http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables#upload \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/vnd.sas.data.table.job+json' \
  -H 'Content-Type: multipart/form-data' \
  -H 'Content-Item-Type: application/vnd.sas.data.table.cas.sashdat.request+json'

const inputBody = '{
  "tableRequest": "{ sourceArguments: { delimiter: \",\", }, targetArguments: { tableName: \"AIRLINES\", replace: \"true\" } }",
  "file": "AIRLINES.csv"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/vnd.sas.data.table.job+json',
  'Content-Type':'multipart/form-data',
  'Content-Item-Type':'application/vnd.sas.data.table.cas.sashdat.request+json'
};

fetch('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables#upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/vnd.sas.data.table.job+json',
  'Content-Type': 'multipart/form-data',
  'Content-Item-Type': 'application/vnd.sas.data.table.cas.sashdat.request+json'
}

r = requests.post('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables#upload', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"multipart/form-data"},
        "Accept": []string{"application/vnd.sas.data.table.job+json"},
        "Content-Type": []string{"multipart/form-data"},
        "Content-Item-Type": []string{"application/vnd.sas.data.table.cas.sashdat.request+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables#upload", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /dataSources/{dataSourceId}/tables#upload

Creates a new table from an uploaded file. Note that this operation is synchronous, and blocks until the file upload is complete. It returns an application/vnd.sas.data.table.job+json resource when the upload succeeds or fails.

Body parameter

Example table request with file upload.

tableRequest: '{ sourceArguments: { delimiter: ",", }, targetArguments: {
  tableName: "AIRLINES", replace: "true" } }'
file: AIRLINES.csv

Parameters

Name	In	Type	Required	Description
dataSourceId	path	string	true	The name of the data source.
Content-Type	header	string	true	The media type of the form data tableRequest member.
Content-Item-Type	header	string	true	The media type of the form data tableRequest member.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session, and then terminates it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
body	body	multipartTableRequest	true	The table create request details to use for creating the table using a file.

Enumerated Values

Parameter	Value
Content-Type	multipart/form-data
Content-Item-Type	application/vnd.sas.data.table.cas.sashdat.request+json
Content-Item-Type	application/vnd.sas.data.table.cas.data.set.request+json
Content-Item-Type	application/vnd.sas.data.table.cas.delimited.request+json
Content-Item-Type	application/vnd.sas.data.table.cas.excel.request+json

Example responses

Example table job for file upload.

{
  "id": "cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "type": "table",
  "state": "running",
  "duration": 0.255,
  "createdBy": "bob",
  "modifiedBy": "bob",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.data.table.job"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.job.execution.job"
    },
    {
      "method": "GET",
      "rel": "state",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "type": "text/plain"
    },
    {
      "method": "GET",
      "rel": "sourceTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "targetTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "log",
      "href": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1",
      "uri": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1"
    }
  ]
}

{
  "id": "cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "type": "table",
  "state": "running",
  "duration": 0.255,
  "createdBy": "bob",
  "modifiedBy": "bob",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.data.table.job"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.job.execution.job"
    },
    {
      "method": "GET",
      "rel": "state",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "type": "text/plain"
    },
    {
      "method": "GET",
      "rel": "sourceTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "targetTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "log",
      "href": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1",
      "uri": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1"
    }
  ]
}

this is an example of an error that could be returned for bad requests

{
  "httpStatusCode": 400,
  "message": "example error message",
  "version": 2
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
201	Created	Created. The requested table has both been created, and its respective job is in a terminal state (one of "completed", "canceled", "timedOut", "failed").	tableJob
400	Bad Request	Bad request (the request is not well formed).	error
404	Not Found	Not found - typically the data source could not be found.	error

Response Headers

Status	Header	Type	Format	Description
201	Location	string		location of the completed job.

Get a table

Code samples

# You can also use wget
curl -X GET http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.table+json'


const headers = {
  'Accept':'application/vnd.sas.data.table+json'
};

fetch('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.table+json'
}

r = requests.get('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.table+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /dataSources/{dataSourceId}/tables/{tableId}

Returns information about a single table based on its unique name.

Parameters

Name	In	Type	Required	Description
dataSourceId	path	string	true	The name of the data source.
tableId	path	string	true	The URL encoded (i.e. Percent encoded) form of the table's name.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session, and then terminates it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This has effect only when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided, the session created by the data service provider is not be terminated. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false, or not specified, the session is be terminated after the request is complete. The default is false.

Example responses

Information about a table.

{
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "dataSourceId": "MYCASLIB",
  "type": "table",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "attributes": {
    "loaded": true,
    "characterSet": "UTF8",
    "global": true,
    "caslibId": "MYCASLIB",
    "rowCount": 6048,
    "columnCount": 8,
    "sessionId": "6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
    "encoding": "utf-8",
    "serverId": "cas"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table.summary"
    },
    {
      "method": "GET",
      "rel": "connectionAttributes",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.attributes"
    },
    {
      "method": "GET",
      "rel": "sessionScoped",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "session",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.session"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "source",
      "href": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "rows",
      "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    },
    {
      "method": "GET",
      "rel": "rowSet",
      "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "columns",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataTables/providers/cas",
      "uri": "/dataTables/providers/cas",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "dataSource",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    }
  ]
}

{
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "dataSourceId": "MYCASLIB",
  "type": "table",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "attributes": {
    "loaded": true,
    "characterSet": "UTF8",
    "global": true,
    "caslibId": "MYCASLIB",
    "rowCount": 6048,
    "columnCount": 8,
    "sessionId": "6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
    "encoding": "utf-8",
    "serverId": "cas"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table.summary"
    },
    {
      "method": "GET",
      "rel": "connectionAttributes",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.attributes"
    },
    {
      "method": "GET",
      "rel": "sessionScoped",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "session",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.session"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "source",
      "href": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "rows",
      "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    },
    {
      "method": "GET",
      "rel": "rowSet",
      "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "columns",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataTables/providers/cas",
      "uri": "/dataTables/providers/cas",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "dataSource",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    }
  ]
}

{
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "dataSourceId": "MYCASLIB",
  "type": "table",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "attributes": {
    "loaded": true,
    "characterSet": "UTF8",
    "global": true,
    "caslibId": "MYCASLIB",
    "rowCount": 6048,
    "columnCount": 8,
    "sessionId": "6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
    "encoding": "utf-8",
    "serverId": "cas"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table.summary"
    },
    {
      "method": "GET",
      "rel": "connectionAttributes",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.attributes"
    },
    {
      "method": "GET",
      "rel": "sessionScoped",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "session",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.session"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "source",
      "href": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "rows",
      "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    },
    {
      "method": "GET",
      "rel": "rowSet",
      "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "columns",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataTables/providers/cas",
      "uri": "/dataTables/providers/cas",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "dataSource",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    }
  ]
}

{
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "dataSourceId": "MYCASLIB",
  "type": "table",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "attributes": {
    "loaded": true,
    "characterSet": "UTF8",
    "global": true,
    "caslibId": "MYCASLIB",
    "rowCount": 6048,
    "columnCount": 8,
    "sessionId": "6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
    "encoding": "utf-8",
    "serverId": "cas"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table.summary"
    },
    {
      "method": "GET",
      "rel": "connectionAttributes",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.attributes"
    },
    {
      "method": "GET",
      "rel": "sessionScoped",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "session",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.session"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "source",
      "href": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "rows",
      "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    },
    {
      "method": "GET",
      "rel": "rowSet",
      "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "columns",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataTables/providers/cas",
      "uri": "/dataTables/providers/cas",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "dataSource",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    }
  ]
}

{
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "dataSourceId": "MYCASLIB",
  "type": "table",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "attributes": {
    "loaded": true,
    "characterSet": "UTF8",
    "global": true,
    "caslibId": "MYCASLIB",
    "rowCount": 6048,
    "columnCount": 8,
    "sessionId": "6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
    "encoding": "utf-8",
    "serverId": "cas"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table.summary"
    },
    {
      "method": "GET",
      "rel": "connectionAttributes",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.attributes"
    },
    {
      "method": "GET",
      "rel": "sessionScoped",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "session",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.session"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "source",
      "href": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    },
    {
      "method": "GET",
      "rel": "rows",
      "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rows?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    },
    {
      "method": "GET",
      "rel": "rowSet",
      "href": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/rowSets/tables/cas~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "columns",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "provider",
      "href": "/dataTables/providers/cas",
      "uri": "/dataTables/providers/cas",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "dataSource",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.source"
    }
  ]
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	table
404	Not Found	One of the following resources does not exist: The data source The table	error

Delete a table

Code samples

# You can also use wget
curl -X DELETE http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.table.job+json'


const headers = {
  'Accept':'application/vnd.sas.data.table.job+json'
};

fetch('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.table.job+json'
}

r = requests.delete('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.table.job+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /dataSources/{dataSourceId}/tables/{tableId}

Deletes a table resource.

Parameters

Name	In	Type	Required	Description
dataSourceId	path	string	true	The name of the data source.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session, and then terminates it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
wait	query	number(float)	false	This service implements "long poll", how long to wait for an update before returning anyway, in floating point seconds. The maximum is 30 seconds.
soft	query	boolean	false	True to perform a soft delete (such as a CAS table unload), false for a hard delete.
tableId	path	string	true	The URL encoded (i.e. Percent encoded) form of the table's name.

Example responses

Example table job for delete table request.

{
  "id": "cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "type": "table",
  "state": "running",
  "duration": 0.255,
  "createdBy": "bob",
  "modifiedBy": "bob",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.data.table.job"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.job.execution.job"
    },
    {
      "method": "GET",
      "rel": "state",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "type": "text/plain"
    },
    {
      "method": "GET",
      "rel": "targetTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    }
  ]
}

{
  "id": "cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "type": "table",
  "state": "running",
  "duration": 0.255,
  "createdBy": "bob",
  "modifiedBy": "bob",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.data.table.job"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.job.execution.job"
    },
    {
      "method": "GET",
      "rel": "state",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "type": "text/plain"
    },
    {
      "method": "GET",
      "rel": "targetTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    }
  ]
}

this is an example of an error that could be returned for bad requests

{
  "httpStatusCode": 400,
  "message": "example error message",
  "version": 2
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted. The table deletion has not completed.	tableJob
204	No Content	Created. The requested table has both been deleted, and its respective job is in the "completed" state.	None
400	Bad Request	Bad request (the request is not well formed).	error
404	Not Found	Not found - typically the data source could not be found.	error

Response Headers

Status	Header	Type	Format	Description
202	Location	string		location of the running job.
204	Location	string		location of the completed job.

Jobs

Contains the operations for the job resource.

Get the table job

Code samples

# You can also use wget
curl -X GET http://mock-dataTables.apifirst.unx.sas.com/dataTables/jobs/{jobId} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.table.job+json'


const headers = {
  'Accept':'application/vnd.sas.data.table.job+json'
};

fetch('http://mock-dataTables.apifirst.unx.sas.com/dataTables/jobs/{jobId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.table.job+json'
}

r = requests.get('http://mock-dataTables.apifirst.unx.sas.com/dataTables/jobs/{jobId}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.table.job+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataTables.apifirst.unx.sas.com/dataTables/jobs/{jobId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /jobs/{jobId}

Get the specified job, which tracks asynchronous table creation or deletion processes.

Parameters

Name	In	Type	Required	Description
jobId	path	string	true	The ID of the job
wait	query	number(float)	false	This service implements "long poll", how long to wait for the job to complete before returning anyway, in floating point seconds. The maximum is 30 seconds.

Example responses

Example table job.

{
  "id": "cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "type": "table",
  "state": "running",
  "duration": 0.255,
  "createdBy": "bob",
  "modifiedBy": "bob",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.data.table.job"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.job.execution.job"
    },
    {
      "method": "GET",
      "rel": "state",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "type": "text/plain"
    },
    {
      "method": "GET",
      "rel": "sourceTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "targetTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "log",
      "href": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1",
      "uri": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1"
    }
  ]
}

{
  "id": "cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "type": "table",
  "state": "running",
  "duration": 0.255,
  "createdBy": "bob",
  "modifiedBy": "bob",
  "creationTimeStamp": "2016-04-15T10:22:31.000Z",
  "modifiedTimeStamp": "2016-04-15T10:22:31.000Z",
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.data.table.job"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "uri": "/jobExecution/jobs/9bb8f3b2-4787-4955-bc24-6635cd7c2e96",
      "type": "application/vnd.sas.job.execution.job"
    },
    {
      "method": "GET",
      "rel": "state",
      "href": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "uri": "/dataTables/jobs/cas~fs~jes~fs~9bb8f3b2-4787-4955-bc24-6635cd7c2e96/state",
      "type": "text/plain"
    },
    {
      "method": "GET",
      "rel": "sourceTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "targetTable",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "log",
      "href": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1",
      "uri": "/files/files/103a512d-0caf-4df0-a35f-68908be0aea1"
    }
  ]
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	tableJob
404	Not Found	Not found.	error

Get the state of the specified job

Code samples

# You can also use wget
curl -X GET http://mock-dataTables.apifirst.unx.sas.com/dataTables/jobs/{jobId}/state \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: text/plain'


const headers = {
  'Accept':'text/plain'
};

fetch('http://mock-dataTables.apifirst.unx.sas.com/dataTables/jobs/{jobId}/state',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'text/plain'
}

r = requests.get('http://mock-dataTables.apifirst.unx.sas.com/dataTables/jobs/{jobId}/state', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataTables.apifirst.unx.sas.com/dataTables/jobs/{jobId}/state", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /jobs/{jobId}/state

Get the state of the specified job.

Parameters

Name	In	Type	Required	Description
jobId	path	string	true	the jobId

Example responses

example job state

"running"

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	the state.	string
404	Not Found	Not found.	error

Columns

Contains the operations for the Columns of Data Tables resource.

Get a collection of columns

Code samples

# You can also use wget
curl -X GET http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}/columns \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json' \
  -H 'Accept-Item: application/vnd.sas.data.column.summary+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json',
  'Accept-Item':'application/vnd.sas.data.column.summary+json'
};

fetch('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}/columns',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json',
  'Accept-Item': 'application/vnd.sas.data.column.summary+json'
}

r = requests.get('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}/columns', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
        "Accept-Item": []string{"application/vnd.sas.data.column.summary+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}/columns", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /dataSources/{dataSourceId}/tables/{tableId}/columns

Returns a collection of column resources. Standard paging, filtering and sorting options are specified in the Parameters section below.

Parameters

Name	In	Type	Required	Description
Accept-Item	header	string	false	The desired column representation. The Accept-Item options are: application/vnd.sas.data.column.summary+json application/vnd.sas.data.column+json application/vnd.sas.summary+json If the application/vnd.sas.data.column.summary+json type is specified, or there is no Accept-Item header, the columns are returned as summary representation column objects. In this case, the column contains the following properties: name, type, rawLength, formattedLength, and links.
dataSourceId	path	string	true	The name of the data source.
tableId	path	string	true	The URL encoded (i.e. Percent encoded) form of the table's name.
start	query	integer	false	The starting index of the first column in a page. Defaults to 0.
limit	query	integer	false	The maximum number of columns to return in this page of results. The actual number of returned columns might be less if the collection has been exhausted. Defaults to 25.
filter	query	string(filter-criteria)	false	Filter criteria for returned columns. The valid filter fields are name and type if supported by the provider. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries: Search by name starting with: .../tables/{tableId}/columns?filter=startsWith(name, 'col') Search by name: .../tables/{tableId}/columns?filter=eq(name, 'column1') Search for multiple tables: .../tables/{tableId}/columns?filter=in(name, 'column1', 'column2', 'column3')
sortBy	query	string(sort-criteria)	false	Sort returned tables. The sort criteria supports the following fields in either ascending or descending order (index, name, type). Some sample sorts: Sort ascending by table name: .../tables/{tableId}/columns?sortBy=name:ascending Sort descending by table name: .../tables/{tableId}/columns?sortBy=name:descending The default sort is by name in ascending index.
excludeItemLinks	query	boolean	false	Set to true to remove the links from the returned column items. Defaults to false.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session, and then terminates it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This has effect only when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided, the session created by the data service provider is not be terminated. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false, or not specified, the session is be terminated after the request is complete. The default is false.

Detailed descriptions

Accept-Item: The desired column representation.
The Accept-Item options are:

application/vnd.sas.data.column.summary+json
application/vnd.sas.data.column+json
application/vnd.sas.summary+json

If the application/vnd.sas.data.column.summary+json type is specified, or there is no Accept-Item header, the columns are returned as summary representation column objects. In this case, the column contains the following properties: name, type, rawLength, formattedLength, and links.

filter: Filter criteria for returned columns.
The valid filter fields are name and type if supported by the provider. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries:

Search by name starting with: .../tables/{tableId}/columns?filter=startsWith(name, 'col')
Search by name: .../tables/{tableId}/columns?filter=eq(name, 'column1')
Search for multiple tables: .../tables/{tableId}/columns?filter=in(name, 'column1', 'column2', 'column3')

sortBy: Sort returned tables. The sort criteria supports the following fields in either ascending or descending order (index, name, type). Some sample sorts:

Sort ascending by table name: .../tables/{tableId}/columns?sortBy=name:ascending
Sort descending by table name: .../tables/{tableId}/columns?sortBy=name:descending

The default sort is by name in ascending index.

Enumerated Values

Parameter	Value
Accept-Item	application/vnd.sas.data.column.summary+json
Accept-Item	application/vnd.sas.data.column+json

Example responses

A pageable collection of column objects.

{
  "name": "columns",
  "accept": "application/vnd.sas.data.column.summary application/vnd.sas.data.column",
  "count": 8,
  "start": 0,
  "limit": 25,
  "items": [
    {
      "name": "AIRLINE ID",
      "index": 0,
      "type": "double",
      "rawLength": 8,
      "formattedLength": 12,
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID",
          "type": "application/vnd.sas.data.column"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID",
          "type": "application/vnd.sas.data.column.summary"
        },
        {
          "method": "GET",
          "rel": "sessionScoped",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.column"
        },
        {
          "method": "GET",
          "rel": "session",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.session"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.column.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.column.summary"
        },
        {
          "method": "GET",
          "rel": "table",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.table"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?start=0&limit=10",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "sessionScoped",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=0&limit=10",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "session",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.session"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.table"
    }
  ]
}

{
  "name": "columns",
  "accept": "application/vnd.sas.data.column.summary application/vnd.sas.data.column",
  "count": 8,
  "start": 0,
  "limit": 25,
  "items": [
    {
      "name": "AIRLINE ID",
      "index": 0,
      "type": "double",
      "rawLength": 8,
      "formattedLength": 12,
      "version": 1,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID",
          "type": "application/vnd.sas.data.column"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID",
          "type": "application/vnd.sas.data.column.summary"
        },
        {
          "method": "GET",
          "rel": "sessionScoped",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.column"
        },
        {
          "method": "GET",
          "rel": "session",
          "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.session"
        },
        {
          "method": "GET",
          "rel": "alternate",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/AIRLINE%20ID?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.column.summary"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.column.summary"
        },
        {
          "method": "GET",
          "rel": "table",
          "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
          "type": "application/vnd.sas.data.table"
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?start=0&limit=10",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "sessionScoped",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=0&limit=10",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f&start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "session",
      "href": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataSources/providers/cas/sources/cas-shared-default/sessions/6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.session"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES?sessionId=6a5ebbb5-0f3a-0a4d-a433-17e44f65e34f",
      "type": "application/vnd.sas.data.table"
    }
  ]
}

this is an example of an error that could be returned for bad requests

{
  "httpStatusCode": 400,
  "message": "example error message",
  "version": 2
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	columnSummaryCollection
400	Bad Request	An invalid request was made in one of the following scenarios: A negative start value is provided. A negative limit value is provided. A non-existent or unsupported field is specified in the sortBy parameter.	error
404	Not Found	One of the following resources does not exist: The data source The table	error

Get a column

Code samples

# You can also use wget
curl -X GET http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}/columns/{columnId} \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.column+json'


const headers = {
  'Accept':'application/vnd.sas.data.column+json'
};

fetch('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}/columns/{columnId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.column+json'
}

r = requests.get('http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}/columns/{columnId}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.column+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-dataTables.apifirst.unx.sas.com/dataTables/dataSources/{dataSourceId}/tables/{tableId}/columns/{columnId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /dataSources/{dataSourceId}/tables/{tableId}/columns/{columnId}

Returns information about a single column based on its unique name.

Parameters

Name	In	Type	Required	Description
dataSourceId	path	string	true	The name of the data source.
tableId	path	string	true	The URL encoded (i.e. Percent encoded) form of the table's name.
columnId	path	string	true	The URL encoded (i.e. Percent encoded) form of the column's name.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session, and then terminates it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This has effect only when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided, the session created by the data service provider is not be terminated. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false, or not specified, the session is be terminated after the request is complete. The default is false.

Example responses

Information about a column.

{
  "name": "Airline ID",
  "type": "double",
  "index": 1,
  "rawLength": 8,
  "formattedLength": 12,
  "version": 1,
  "format": {
    "name": "string",
    "rawLength": 0,
    "decimals": 0
  },
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "type": "application/vnd.sas.data.column"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "type": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns",
      "uri": "/dataTables/dataTableProviders/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column"
    }
  ]
}

Summary information about a column.

{
  "name": "Airline ID",
  "type": "double",
  "index": 1,
  "rawLength": 8,
  "formattedLength": 12,
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "type": "application/vnd.sas.data.column"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "type": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    }
  ]
}

Information about a column.

{
  "name": "Airline ID",
  "type": "double",
  "index": 1,
  "rawLength": 8,
  "formattedLength": 12,
  "version": 1,
  "format": {
    "name": "string",
    "rawLength": 0,
    "decimals": 0
  },
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "type": "application/vnd.sas.data.column"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/Airline%20ID",
      "type": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns",
      "uri": "/dataTables/dataTableProviders/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column"
    }
  ]
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	column
404	Not Found	One of the following resources does not exist: The data source The table The column	error

Schemas

table

{
  "providerId": "string",
  "dataSourceId": "string",
  "name": "string",
  "label": "string",
  "type": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "attributes": {},
  "creationTimeStamp": "2019-08-24T14:15:22Z",
  "modifiedTimeStamp": "2019-08-24T14:15:22Z",
  "version": 0,
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ]
}

Table

Properties

Name	Type	Required	Restrictions	Description
providerId	string	false	none	The table provider name.
dataSourceId	string	false	none	The parent source name.
name	string	false	none	The unique name of the table.
label	string	false	none	The user visible name of this table. This value might vary depending on the Accept-Language header.
type	string	false	none	The type of this table.
createdBy	string	false	none	The user who created this table.
modifiedBy	string	false	none	The last user to modify this table.
attributes	object	false	none	Additional provider-specific attributes.
creationTimeStamp	string(date-time)	false	none	Timestamp of table creation, in yyyy-mm-ddThh:mm:ssZ format.
modifiedTimeStamp	string(date-time)	false	none	Timestamp of last table modification, in yyyy-mm-ddThh:mm:ssZ format.
version	integer	false	none	The table schema version.
links	[object]	false	none	The links that apply to this table.
» Link	object	false	none	A link to a related operation or resource.
»» method	string	false	none	The HTTP method for the link.
»» rel	string	true	none	The relationship of the link to the resource.
»» uri	string	false	none	The relative URI for the link.
»» href	string	false	none	The URL for the link.
»» title	string	false	none	The title for the link.
»» type	string	false	none	The media type or link type for the link.
»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.

tableCollection

{
  "name": "string",
  "start": 0,
  "limit": 0,
  "count": 0,
  "accept": "string",
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "version": 0,
  "items": [
    {
      "providerId": "string",
      "dataSourceId": "string",
      "name": "string",
      "label": "string",
      "type": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "attributes": {},
      "creationTimeStamp": "2019-08-24T14:15:22Z",
      "modifiedTimeStamp": "2019-08-24T14:15:22Z",
      "version": 0,
      "links": [
        {
          "method": "string",
          "rel": "string",
          "uri": "string",
          "href": "string",
          "title": "string",
          "type": "string",
          "itemType": "string",
          "responseType": "string",
          "responseItemType": "string"
        }
      ]
    }
  ]
}

Table Collection

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)
» name	string	false	none	The name of the collection.
» start	integer(int64)	false	none	The zero-based index of the first item in the collection.
» limit	integer	false	none	The number of items that were requested for the collection.
» count	integer(int64)	false	none	If populated indicates the number of items in the collection.
» accept	string	false	none	A space-delimited list of media types from which an `Accept` header may be constructed.
» links	[link]	false	none	The links that apply to the collection.
» version	integer	false	none	The version number of the collection representation. This representation is version 2.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[table]	true	none	An array that contains Table resources.

column

{
  "format": {
    "name": "string",
    "rawLength": 0,
    "decimals": 0
  },
  "informat": {
    "property1": {
      "name": "string",
      "rawLength": 0,
      "decimals": 0
    },
    "property2": {
      "name": "string",
      "rawLength": 0,
      "decimals": 0
    }
  },
  "attributes": {
    "property1": {},
    "property2": {}
  },
  "version": 0,
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "name": "string",
  "label": "string",
  "index": 0,
  "type": "string",
  "rawLength": 0,
  "formattedLength": 0
}

Column

Properties

Name	Type	Required	Restrictions	Description
Column	columnSummary	false	none	Information about a column.
format	format	false	none	The resource that represents the format of a column.
informat	object	false	none	The informat of the column represented as the following object
» additionalProperties	informat	false	none	The resources that represent the informat of the column.
attributes	object	false	none	The attributes for this column.
» additionalProperties	object	false	none	none
version	integer	false	none	The column schema version.
links	[link]	false	none	The links that apply to the column.

columnSummary

{
  "name": "string",
  "label": "string",
  "index": 0,
  "type": "string",
  "rawLength": 0,
  "formattedLength": 0,
  "version": 0,
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ]
}

Column Summary

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The unique name of the column.
label	string	false	none	The localized name of this column. This value might vary depending on the Accept-Language header.
index	integer	false	none	The column's 0-based index if this is supported by the provider data service. If it is unsupported, it is omitted.
type	string	false	none	The type of the column.
rawLength	integer	false	none	The raw rawLength of the column.
formattedLength	integer	false	none	The formatted rawLength of the column.
version	integer	false	none	The column schema version.
links	[link]	false	none	The links that apply to the column.

columnSummaryCollection

{
  "name": "string",
  "start": 0,
  "limit": 0,
  "count": 0,
  "accept": "string",
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "version": 0,
  "items": [
    {
      "name": "string",
      "label": "string",
      "index": 0,
      "type": "string",
      "rawLength": 0,
      "formattedLength": 0,
      "version": 0,
      "links": [
        {
          "method": "string",
          "rel": "string",
          "uri": "string",
          "href": "string",
          "title": "string",
          "type": "string",
          "itemType": "string",
          "responseType": "string",
          "responseItemType": "string"
        }
      ]
    }
  ]
}

Column Summary Collection

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	tableCollection	false	none	This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[columnSummary]	true	none	An array that contains Column resources.

format

{
  "name": "string",
  "rawLength": 0,
  "decimals": 0
}

Format

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The format name of the column.
rawLength	integer	false	none	The rawLength of the column format.
decimals	integer	false	none	The number of decimals in the column format.

informat

{
  "name": "string",
  "rawLength": 0,
  "decimals": 0
}

Informat

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The informat name of the column.
rawLength	integer	false	none	The rawLength of the column informat.
decimals	integer	false	none	The number of decimals in the column informat.

columnArgument

{
  "name": "string"
}

Column Argument

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the column

tableRequestTargetArguments

{
  "tableName": "string",
  "label": "string",
  "replace": [
    {
      "name": "string"
    }
  ]
}

Table Request Target arguments

Properties

Name	Type	Required	Restrictions	Description
tableName	string	true	none	The name of the target data table.
label	string	false	none	A label for the table.
replace	[columnArgument]	false	none	The columns to include from the source table when creating the new table.

tableRequest

{
  "sourceArguments": {
    "property1": {
      "casServer": "string",
      "caslib": "string",
      "tablePath": "string",
      "includedColumns": [
        {
          "name": "string"
        }
      ],
      "filter": "string",
      "encryptionPassword": "string"
    },
    "property2": {
      "casServer": "string",
      "caslib": "string",
      "tablePath": "string",
      "includedColumns": [
        {
          "name": "string"
        }
      ],
      "filter": "string",
      "encryptionPassword": "string"
    }
  },
  "targetArguments": {
    "property1": {
      "tableName": "string",
      "label": "string",
      "replace": [
        {
          "name": "string"
        }
      ]
    },
    "property2": {
      "tableName": "string",
      "label": "string",
      "replace": [
        {
          "name": "string"
        }
      ]
    }
  },
  "version": 0
}

Table create

Properties

Name	Type	Required	Restrictions	Description
sourceArguments	object	false	none	The arguments for the source data to create the table from
» additionalProperties	tableRequestCasSasHdatSourceArguments	false	none	The source arguments for the create request
targetArguments	object	false	none	The arguments for the target data table to create
» additionalProperties	tableRequestTargetArguments	false	none	The target arguments for the create request
version	integer	false	none	This media type's schema version number.

tableRequestCasSasHdat

{
  "sourceArguments": {
    "property1": {
      "casServer": "string",
      "caslib": "string",
      "tablePath": "string",
      "includedColumns": [
        {
          "name": "string"
        }
      ],
      "filter": "string",
      "encryptionPassword": "string"
    },
    "property2": {
      "casServer": "string",
      "caslib": "string",
      "tablePath": "string",
      "includedColumns": [
        {
          "name": "string"
        }
      ],
      "filter": "string",
      "encryptionPassword": "string"
    }
  },
  "targetArguments": {
    "property1": {
      "tableName": "string",
      "label": "string",
      "replace": [
        {
          "name": "string"
        }
      ]
    },
    "property2": {
      "tableName": "string",
      "label": "string",
      "replace": [
        {
          "name": "string"
        }
      ]
    }
  },
  "version": 0
}

Table create request details for CAS with SASHdat sources

Properties

Name	Type	Required	Restrictions	Description
sourceArguments	object	false	none	The arguments for the source data to create the table from
» additionalProperties	tableRequestCasSasHdatSourceArguments	false	none	The source arguments for the create request
targetArguments	object	false	none	The arguments for the target data table to create
» additionalProperties	tableRequestTargetArguments	false	none	The target arguments for the create request
version	integer	false	none	This media type's schema version number.

tableRequestCasSasHdatSourceArguments

{
  "casServer": "string",
  "caslib": "string",
  "tablePath": "string",
  "includedColumns": [
    {
      "name": "string"
    }
  ],
  "filter": "string",
  "encryptionPassword": "string"
}

Table Request Source Arguments

Properties

Name	Type	Required	Restrictions	Description
casServer	string	true	none	The name of the source cas server
caslib	string	true	none	The name of the source caslib
tablePath	string	false	none	The relative path to the table within the caslib
includedColumns	[columnArgument]	false	none	The columns to include from the source table when creating the new table.
filter	string	false	none	A filter (i.e. WHERE clause to be applied to the rows of the source table as a filter for the new table.
encryptionPassword	string	false	none	The passphrase used for a AES encrypted data set. Required if the data set uses AES/AES2 encryption.

tableJob

{
  "id": "string",
  "providerId": "string",
  "type": "create",
  "state": "pending",
  "error": {
    "message": "string",
    "id": "string",
    "errorCode": 0,
    "httpStatusCode": 0,
    "details": [
      "string"
    ],
    "remediation": "string",
    "errors": [
      null
    ],
    "links": [
      {
        "method": "string",
        "rel": "string",
        "uri": "string",
        "href": "string",
        "title": "string",
        "type": "string",
        "itemType": "string",
        "responseType": "string",
        "responseItemType": "string"
      }
    ],
    "version": 0
  },
  "duration": 0,
  "creationTimeStamp": "string",
  "modifiedTimeStamp": "string",
  "endTimeStamp": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "attributes": {},
  "version": 0,
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ]
}

Table Create Job

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	The unique ID that is generated by the API.
providerId	string	false	none	The ID of the provider.
type	string	false	none	The type of the table job.
state	string	false	none	The current state of the job.
error	object	false	none	The representation of an error.
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[error]	false	none	Any additional errors that occurred.
» links	[link]	false	none	The links that apply to the error.
» version	integer	true	none	The version number of the error representation. This representation is version 2.
duration	number(double)	false	none	The number of seconds that elapsed from the time the job was started until it finished, or the amount of time that has passed if it is still running.
creationTimeStamp	string	false	none	The creation date, which is the date that the job was submitted. This uses the yyyy-MM-ddTHH:mm:ss.SSSZ format.
modifiedTimeStamp	string	false	none	The date of the last modification. This uses the yyyy-MM-ddTHH:mm:ss.SSSZ format.
endTimeStamp	string	false	none	The date that the job finished. This uses the yyyy-MM-ddTHH:mm:ss.SSSZ format.
createdBy	string	false	none	The user ID of the user who created or submitted the job.
modifiedBy	string	false	none	The user ID of the user who last modified the job.
attributes	object	false	none	Additional provider and table specific attributes.
version	integer	false	none	This media type's schema version number.
links	[link]	false	none	The links that apply to the column.

Enumerated Values

Property	Value
type	create
type	delete
state	pending
state	running
state	canceled
state	completed
state	failed
state	timedOut

multipartTableRequest

{
  "tableRequest": "string",
  "file": "string"
}

Table Create request

Properties

Name	Type	Required	Restrictions	Description
tableRequest	string	true	none	The list of job parameters passed in application/vnd.sas.data.table.request+json format.
file	string(binary)	true	none	The multi-part request file to use when creating the new table.

api

{
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "version": 1
}

A list of links to top level resources available from the root of the API.

Properties

Name	Type	Required	Restrictions	Description
links	[link]	false	none	The API's top-level links.
version	integer	false	none	The version number of the API representation. This is version 1.

Examples

Github Examples

Detailed examples on how to use this API can be found on Github.

Media Type Samples

Externally Defined Media Types

Generic Attributes Model

The following model is for a generic attributes object that is used across multiple resource representations. The purpose of this model is to store attributes in a generic fashion, allowing the resource to be expanded without requiring version updates. Also, various providers can provide different data for different resources.

Name	Type	Description
`attributes`	`object`	An object that contains name/value pairs where the values can be any type, such as a number, string, object, or an array.

JSON Representation of Attributes


 {
  "attributes": {
    "myAttrNum": 1.2,
    "myAttrInt": 100,
    "myAttrString": "myString",
    "myAttrArray": [ 123, "value1", true],
    "myAttrBoolean": true,
    "myAttrNull": null,
    "myAttrObj": {
       "myAttrBoolean": true,
       "myAttrNull": null,
     }
  }

application/vnd.sas.data.table

The application/vnd.sas.data.table media type describes the complete details of a table.

Link Relations

Relation	HTTP Method	Description
`self`	`GET`	Returns a link to the full complete representation of the table. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}` Type: `application/vnd.sas.data.table`
`alternate`	`GET`	Returns a link to the summary representation of the table. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}` Type: `application/vnd.sas.data.table.summary`
`connectionAttributes`	`GET`	Returns a link to the attributes needed to establish a connection to this table from other clients. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}` Type: `application/vnd.sas.attributes`
`sessionScoped`	`GET`	Returns a link to the full complete representation of the table. with the `sessionId` query parameter included. This link exists only if the `sessionId` query parameter is passed in or if the `preserveSession` query parameter is set to true. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}?sessionId={sessionId}` Type: `application/vnd.sas.data.table`
`session`	`GET`	Returns a link to the session for accessing this table. This link is included if the client request includes the `sessionId` query parameter or if the `preserveSession` query parameter is set to true. HREF: /dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId} Type: application/vnd.sas.data.session
`up`	`GET`	Returns a link to the collection of all tables for this source reference. URI: `/dataTables/dataSources/{dataSourceId}/tables` Type: `application/vnd.sas.collection`
`rows`	`GET`	Returns a link to a collection of this table's rows HREF: `/rowSets/tables/{tableId}/rows` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.row`
`columns`	`GET`	Returns a link to a collection of this table's columns. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns` Type: `application/vnd.sas.collection` Item type: application/vnd.sas.data.column.summary
`provider`	`GET`	Returns a link to the provider for this table HREF: `/dataSources/providers/{providerId}` Type: `application/vnd.sas.data.provider`
`dataSource`	`GET`	Returns a link to this table's parent data source HREF: `/dataSources/providers/{providerId}/sources/{sourceId}` Type: `application/vnd.sas.data.source`
`type`	`GET`	Returns a link to this table's type resource in the Types API. Omit if the provider service does not register its types. HREF: `/types/types/{typeName}` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.content.type`

Members

Name	Type	Description
`version`	`integer`	The media type schema version number. This representation is version 1.
`name`	`string`	The unique name of this table within a data source.
`label`	`string`	The user visible name of this table. This value can vary depending on the `Accept-Language` header.
`providerId`	`string`	The unique identifier of this table's provider.
`dataSourceId`	`string`	The unique identifier of this table's parent data source. See the data source id format for more details.
`type`	`string`	The type of this table. This type corresponds to a type in the Types API.
`createdBy`	`string`	The user ID who created this table
`modifiedBy`	`string`	The last user ID to modify this table
`creationTimeStamp`	`string`	The formatted time stamp when the table was created, in yyyy-mm-ddThh:mm:ssZ format
`modifiedTimeStamp`	`string`	The formatted time stamp when the table was created, in yyyy-mm-ddThh:mm:ssZ format
`attributes`	`object`	A generic attributes object. See the generic attributes model for more information.
`links`	`array of link objects`	Zero or more links to related resources or operations.

application/vnd.sas.data.table+json


 {
  "name": "AIRLINES",
  "label": "Airlines",
  "providerId": "cas",
  "dataSourceId": "cas~fs~cas~fs~CASTestTmp",
  "creationTimeStamp": "2016-03-03T14:59:52.000Z",
  "modifiedTimeStamp": "2016-03-03T14:59:52.000Z",
  "createdBy": "bob",
  "modifiedBy": "bob",
  "type": "table",
  "attributes": {
    "loaded": true,
    "sourceTableName": null,
    "characterSet": "UTF8",
    "global": true,
    "caslibId": "CASTestTmp",
    "rowCount": 6048,
    "columnCount": 8,
    "sessionId": "feb250ff-15fc-ed44-913c-28c3f311c17b",
    "encoding": "utf-8",
    "serverId": "cas"
  },
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataTableProviders/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES",
      "uri": "/dataTables/dataTableProviders/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataTables/dataTableProviders/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES",
      "uri": "/dataTables/dataTableProviders/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES",
      "type": "application/vnd.sas.data.table.summary"
    },
    {
      "method": "GET",
      "rel": "connectionAttributes",
      "href": "/dataTables/dataTableProviders/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES",
      "uri": "/dataTables/dataTableProviders/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES",
      "type": "application/vnd.sas.attributes"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataTableProviders/cas~fs~cas~fs~CASTestTmp/tables",
      "uri": "/dataTables/dataTableProviders/cas~fs~cas~fs~CASTestTmp/tables",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.table"
    },
    {
      "method": "GET",
      "rel": "dataSource",
      "href": "/dataSources/providers/cas/sources/cas~fs~CASTestTmp",
      "uri": "/dataSources/providers/cas/sources/cas~fs~CASTestTmp",
      "type": "application/vnd.sas.data.source"
    },
   {
      "method": "GET",
      "rel": "provider",
      "href": "/dataSources/providers/cas",
      "uri": "/dataSources/providers/cas",
      "type": "application/vnd.sas.data.provider"
    },
    {
      "method": "GET",
      "rel": "rows",
      "href": "/rowSets/tables/cas~fs~cas~fs~CASTestTmp~fs~AIRLINES/rows",
      "uri": "/rowSets/tables/cas~fs~cas~fs~CASTestTmp~fs~AIRLINES/rows",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row.summary"
    },
    {
      "method": "GET",
      "rel": "columns",
      "href": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns",
      "uri": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column.summary"
    }
  ]
}

application/vnd.sas.data.table.summary

The application/vnd.sas.data.table.summary media type describes the summary details of a data table. Note that this summary media type is not the default media type for its respective collection instead, the default is the application/vnd.sas.data.table media type. To retrieve this media type.

instead, specify the Accept-Item header as application/vnd.sas.data.table.summary+json on the GET /dataSources/{dataSourceId}/tables request.

Link Relations

application/vnd.sas.data.table.summary has the same link relations as application/vnd.sas.data.table.

Members

application/vnd.sas.data.table.summary has all of the members of the application/vnd.sas.data.table media type that might change in future versions of this media type.

The attributes member's content varies, depending on the provider.

This is representation version 1.

application/vnd.sas.data.column

The application/vnd.sas.data.column media type describes the complete details of a column. If a less comprehensive media type is needed with a smaller payload, see the application/vnd.sas.data.column.summary media type.

Link Relations

Relation	HTTP Method	Description
`self`	`GET`	Returns a link to the full complete representation of the column. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns/{columnName}` Type: `application/vnd.sas.data.column`
`sessionScoped`	`GET`	Returns a link to the full complete representation of the column. with the `sessionId` query parameter included. This link exists only if the `sessionId`query parameter is passed in or if the `preserveSession` query parameter is set to true. URI: /dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns/{columnName} Type: `application/vnd.sas.data.column`
`session`	`GET`	Returns a link to the session for accessing this column. This link is included if the client request includes the `sessionId` query parameter or if the `preserveSession` query parameter is set to true. HREF: /dataSources/providers/{providerId}/{sourceId}/sessions/{sessionId} Type: `application/vnd.sas.data.session`
`alternate`	`GET`	Returns a link to the full complete representation of the column. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns/{columnName}` Type: `application/vnd.sas.data.column.summary`
`up`	`GET`	Returns a link to the collection of all columns for this specified table URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.column.summary`
`table`	`GET`	Returns a link to the data table that contains this column URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}` Type: `application/vnd.sas.data.table`
`type`	`GET`	Returns a link to the type resource of this column in the Types API. Omit this resource if the provider service does not register its types. HREF: /types/types/{typeName} Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.content.type`

Members

Name	Type	Description
`version`	`integer`	The media type schema version number. This representation is version 1.
`name`	`string`	The name of the column.
`label`	`string`	The localized name of this column. This value can vary depending on the `Accept-Language` header.
`type`	`string`	The column type. This type corresponds to a type in the Types API.
`index`	`long integer`	The column 0-based index (as a 64-bit integer) if this is supported by the provider data service. If it is unsupported, it is omitted.
`rawLength`	`integer`	The raw length of the column.
`formattedLength`	`integer`	The formatted length of the column.
`format`	`object`	The format of the column represented as the following object:


 { name: "string", length: "integer", decimals: "integer", } ```                                                                                                                                                                                                                                                           |
| `informat`        | `object`                | The input format of the column as the following object: 
<div class="center-column"></div>


<div class="center-column"></div>

```json

 { name: "string", length: "integer", decimals: "integer", } ```                                                                                                                                                                                                                                                                 |
| `attributes`      | `object`                | A generic attributes object. See the [generic attributes model]( #generic-attributes-model) for more information.                                                                                                                                                                                                          |
| `links`           | `array of link objects` | Zero or more links to related resources or operations. Se                                                                                                                                                                                                                                                                                                                                   |


###### <a name='application-vnd.sas.data.column~json'>application/vnd.sas.data.column+json</a>


<div class="center-column"></div>


<div class="center-column"></div>

```json

 {
  "name": "Airline ID",
  "type": "double",
  "rawLength": 8,
  "formattedLength": 12,
  "version": 1,
  "format": {
    "name": "string",
    "length": 0,
    "decimals": 0,
  },
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns/Airline%20ID",
      "uri": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns/Airline%20ID",
      "type": "application/vnd.sas.data.column"
    },
    {
      "method": "GET",
      "rel": "alternate",
      "href": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns/Airline%20ID",
      "uri": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns/Airline%20ID",
      "type": "application/vnd.sas.data.column.summary"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns",
      "uri": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.column"
    },
    {
      "method": "GET",
      "rel": "table",
      "href": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES",
      "uri": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    }
  ]
}

application/vnd.sas.data.column.summary

The application/vnd.sas.data.column.summary media type provides a summary-based description of a column in a data table. This media type is a subset of the application/vnd.sas.data.column media type. It contains all of the member fields except the following: attributes, format and informat.

Link Relations

Relation	HTTP Method	Description
`self`	`GET`	Returns a link to the full complete representation of the column. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns/{columnName}` Type: `application/vnd.sas.data.column`
`sessionScoped`	`GET`	Returns a link to the full complete representation of the column. with the `sessionId` query parameter included. This link exists only if the `sessionId`query parameter is passed in or if the `preserveSession` query parameter is set to true. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns/{columnName}` Type: `application/vnd.sas.data.column`
`session`	`GET`	Returns a link to get the session for accessing this column. This link is included if the client request includes the `sessionId` query parameter or if the `preserveSession` query parameter is set to true. HREF: `/dataSources/providers/{providerId}/{sourceId}/sessions/{sessionId}` Type: `application/vnd.sas.data.session`
`alternate`	`GET`	Returns a link to the full complete representation of the column. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns/{columnName}` Type: `application/vnd.sas.data.column.summary`
`up`	`GET`	Returns a link to the collection of all columns for this specified table URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns` Type: `application/vnd.sas.collection` Item type: application/vnd.sas.data.column.summary
`table`	`GET`	Returns a link to the parent table of this column URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}` Type: `application/vnd.sas.data.table`
`type`	`GET`	Returns a link to the type resource of the column in the Types API. Omit this resource if the provider service does not register its types. HREF: `/types/types/{typeName}` Type: `application/vnd.sas.collection` Item type: application/vnd.sas.content.type

Members

Name	Type	Description
`version`	`integer`	The media type schema version number. This representation is version 1.
`name`	`string`	The name of the column.
`label`	`string`	The localized name of this column. This value can vary depending on the `Accept-Language` header.
`type`	`string`	The type of the column type. This type corresponds to a type in the Types API.
`index`	`long integer`	The 0-based index of the column (as a 64-bit integer) if this is supported by the provider data service. If it is unsupported, it is omitted.
`rawLength`	`integer`	The raw length of the column.
`formattedLength`	`integer`	The formatted length of the column.
`links`	`array of link objects`	Zero or more links to related resources or operations. See the above link relations table for a description of the link types.

application/vnd.sas.data.column.summary+json


 {
 "name": "Airline ID",
 "type": "double",
 "rawLength": 8,
 "formattedLength": 12,
 "version": 1,
 "links": [
   {
     "method": "GET",
     "rel": "self",
     "href": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns/Airline%20ID",
     "uri": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns/Airline%20ID",
     "type": "application/vnd.sas.data.column"
   },
   {
     "method": "GET",
     "rel": "alternate",
     "href": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns/Airline%20ID",
     "uri": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns/Airline%20ID",
     "type": "application/vnd.sas.data.column.summary"
   },
   {
     "method": "GET",
     "rel": "up",
     "href": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns/",
     "uri": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES/columns/",
     "type": "application/vnd.sas.collection",
     "itemType": "application/vnd.sas.data.column.summary"
   },
   {
     "method": "GET",
     "rel": "table",
     "href": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES",
     "uri": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/tables/AIRLINES",
     "type": "application/vnd.sas.data.table"
   }
 ]
 }

application/vnd.sas.data.table.job+json

The application/vnd.sas.data.table.job media type. represents a resource for tracking asynchronous operations (jobs) on data table resources.

This is described by tableJob.

application/vnd.sas.data.table.request+json

The application/vnd.sas.data.table.request media type. the media type for loading tables into memory for the CAS provider.

This is described by tableRequest.

application/vnd.sas.data.table.cas.sashdat.request+json

The application/vnd.sas.data.table.cas.sashdat.request media type. the media type for creating tables from sashdat sources for the CAS provider.

This is described by tableRequestCasSasHdat.

application/vnd.sas.data.table.cas.data.set.request+json

The application/vnd.sas.data.table.cas.data.set.request media type. the media type for creating tables from SAS Data Set sources for the CAS provider.

This is described by tableRequestCasDataset.

application/vnd.sas.data.table.cas.oracle.request+json

The application/vnd.sas.data.table.cas.oracle.request media type. the media type for creating tables from Oracle database sources for the CAS provider.

This is described by tableRequestCasOracle.

application/vnd.sas.data.table.cas.postgresql.request+json

The application/vnd.sas.data.table.cas.postgresql.request media type. the media type for creating tables from PostgreSQL database sources for the CAS provider.

This is described by tableRequestCasPostgreSQL.

application/vnd.sas.data.table.cas.excel.request+json

The application/vnd.sas.data.table.cas.excel.request media type. the media type for creating tables from Excel sources for the CAS provider.

This is described by tableRequestCasExcel.

application/vnd.sas.data.table.cas.delimited.request+json

The application/vnd.sas.data.table.cas.delimited.request media type. the media type for creating tables from delimited sources for the CAS provider.

This is described by tableRequestCasDelimited.

data source id format

dataSourceId is formed by concatenating provider identifier, server name and library name with forward slash (/). For example, given provider identifier cas, cas server cas-shared-default and library name formats, the dataSourceId would be cas/cas-shared-default/formats. dataSourceId must be encoded when it is used as part of URI. Encode dataSourceId by replacing

/ with ~fs~

\ with ~rs~

; with ~sc~

~ with ~~

Applying the above encoding rules to the dataSourceId cas/cas-shared-default/formats would become cas~fs~cas-shared-default~fs~formats.

Resource Relationships

The diagram below shows the relationships between the resources in this API.

Data Tables entity relationship diagram

Pagination, Sorting, and Filtering

In this API, methods that operate on a collection support the following features.

pagination - The default page limit is 10 for the tables collection and 25 for the columns collection. To modify this limit, set the ?limit query parameter.
sorting- Refer to 'Sorting and Filtering' section of specific endpoint for details.
filtering:
- These functions are supported: and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, isNull
- Example query strings are listed below:
- Filter by name starting with - ?filter=startsWith(name, 'tabl')
- Filter by name - ?filter=eq(id, 'table1')
- Filter by for multiple tables with name - ?filter=in(name, 'table1', 'table2', 'table3')
- Refer to 'Sorting and Filtering' section of specific endpoint for details.

Root

Path: /

Links

Relation	Method	Description
`tables`	`GET`	Returns a collection of tables. URI: `/dataTables/dataSources/{dataSourceId}/tables` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.table`

Tables

Path: /dataSources/{dataSourceId}/tables

Links

Relation	Method	Description
`collection`	`GET`	Returns the first page of the unfiltered, unsorted tables collection. URI: `/dataTables/dataSources/{dataSourceId}/tables` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.table`
`self`	`GET`	Returns the current page of the (filtered) tables collection. URI: `/dataTables/dataSources/{dataSourceId}/tables` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.table`
`up`	`GET`	Returns the parent data source of this collection of tables. HREF: `/dataSources/providers/{providerId}/sources/{dataSourceId}` Type: `application/vnd.sas.data.source`
`sessionScoped`	`GET`	Returns the current page of the (filtered) collection with the `sessionId` query parameter included. This link exists only if the `sessionId` query parameter is passed in or the`preserveSession` is set to true. URI: `/dataTables/dataSources/{dataSourceId}/tables?sessionId={sessionId}` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.table`
`session`	`GET`	Returns the session for accessing this collection. This link is included if the client request includes the `?sessionId` query parameter or if the `preserveSession` query parameter is set to true. HREF: `/dataSources/providers/{providerId}/{sourceId}/sessions/{sessionId}` Type: `application/vnd.sas.data.session`
`first`	`GET`	Returns the first page of collection results. (start=0) URI: `/dataTables/dataSources/{dataSourceId}/tables` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.table`
`prev`	`GET`	Returns the previous page of collection results. URI: `/dataTables/dataSources/{dataSourceId}/tables` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.table`
`next`	`GET`	Returns the next page of collection results. URI: `/dataTables/dataSources/{dataSourceId}/tables` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.table`
`last`	`GET`	Returns the last page of collection results. URI: `/dataTables/dataSources/{dataSourceId}/tables` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.table`

Sorting and Filtering

sorting- A default sort order of ascending by name is automatically applied to the contents of the collection. An alternate sort order might be specified via the ?sortBy query parameter. A sort order can only be applied to the simple fields of a resource on which filtering is supported. Methods within this API do not support the various strength options as outlined by the sorting guidelines.
filtering - An optional ?filter parameter might be specified to query the exact set of identities that are included within the collection. Standard functional notation is supported.
- Standard functions are supported.
- The list of fields that can be searched on tables by default across all providers include the following: name.
- Some providers may support filtering on additional fields.
- For example:
- CAS provider supports filtering on createdBy.
- Compute provider supports filtering on providerId, dataSourceId, type, label.
- Response to invalid fields in filter varies provider to provider. Some providers return 400 where as others just empty collection.

Columns

Path: /dataSources/{dataSourceId}/tables/{tableName}/columns

Links

Relation	Method	Description
`collection`	`GET`	Returns the collection. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.column.summary`
`self`	`GET`	Returns the current page of the (filtered) collection. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.column.summary`
`up`	`GET`	Returns the parent table of this collection of columns. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}` Type `application/vnd.sas.data.table`
`sessionScoped`	`GET`	Returns the current page of the (filtered) collection with the `sessionId` query parameter included. This link exists only if the `sessionId` query parameter is passed in or the`preserveSession` is set to true. URI: `/dataTables/dataSources/{dataSourceId}/tables?sessionId={sessionId}` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.column.summary`
`session`	`GET`	Returns the session for accessing this collection. This link is included if the client request includes the `sessionId` query parameter or if the `preserveSession` query parameter is set to true. HREF: `/dataSources/providers/{providerId}/{sourceId}/sessions/{sessionId}` Type: `application/vnd.sas.data.session`
`first`	`GET`	Returns the first page of collection results. (start=0) URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.column.summary`
`prev`	`GET`	Returns the previous page of collection results. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.column.summary`
`next`	`GET`	Returns the next page of collection results. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.column.summary`
`last`	`GET`	Returns the last page of collection results. URI: `/dataTables/dataSources/{dataSourceId}/tables/{tableName}/columns` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.column.summary`

sorting- A default sort order of ascending by name is automatically applied to the contents of the collection. An alternate sort order might be specified via the ?sortBy query parameter. A sort order can only be applied to the simple fields of a resource on which filtering is supported. Methods within this API do not support the various strength options as outlined by the sorting guidelines.
filtering - An optional ?filter parameter might be specified to query the exact set of identities that are included within the collection. Standard functional notation is supported.
- Standard functions are supported.
- The list of fields that can be searched on tables by default across all providers include the following: name, type.
- Some providers may support filtering on additional fields.
- For example:
- CAS provider supports filtering on indexed, formattedLength, licensed, hasDefinition.
- Compute provider supports filtering on label, index.
- Response to invalid fields in filter varies provider to provider. Some providers return 400 where as others just empty collection.

Job

Path: /jobs/{id}

This API provides to creation of tables and application/vnd.sas.data.table.job to monitor their creation since it occurs asynchronously. This job includes metadata about the links to the log, source and target tables.

The client must poll until the job is completed (using either the self or the state link). Terminal states are: completed, timedOut , canceled and failed. Both the POST and GET calls accept a request parameter wait, how long (in floating point seconds) to wait if the job is not complete before timing out and returning. This so-called long poll returns immediately when the job completes. The default value for asynchronous POST and DELETE operations is 0.5 (1/2 second), and 0.0 for synchronous GET operations. The maximum is 30 seconds.

Relation	Method	Description
self	GET	Returns the job. URI: `/jobs/{jobId}` Response type: `application/vnd.sas.data.table.job`
state	GET	Returns the state of this job. URI: `/jobs/{jobId}/state` Response type: `text/plain`
alternate	GET	Returns the backing execution provider's representation of this job. URI: `/jobExecution/jobs/{id}` Response type: `application/vnd.sas.job.execution.job`
sourceTable	GET	Returns the source data table. URI: `/dataTables/{dataSourceId}/tables/{tableId}` Response type: `application/vnd.sas.data.table`
targetTable	GET	Returns the target data table. URI: `/dataTables/{dataSourceId}/tables/{tableId}` Response type: `application/vnd.sas.data.table`
log	GET	Returns the log file. URI: Varies depending on execution environment, but typically is `/files/files/{fileId}`

Row Sets

Base URLs:

http://mock-rowSets.apifirst.unx.sas.com/rowSets

Terms of service Email: SAS Developers Web: SAS Developers

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Row Sets API provides a common way to reference rows of rectangular data that are available in the SAS ecosystem. The URLs for this API are the only canonical form of storing data references for SAS Viya.
All GET operations have a corresponding HEAD with identical signature and semantics except the resource body is not returned.

Terminology:

table: represents a rectangular data structure that consists of rows and columns of uniform data.

data table: represents a rectangular data structure that consists of rows and columns of uniform data.

column: represents a column of rectangular data. row: represents a row of rectangular data.

cell: represents the value where a row and column intersect.

provider: represents a service that has registered itself as a provider of Row Set information. These services implement specified endpoints that the Row Sets service redirect to.

Usage Notes

Overview

The Row Sets API is used for retrieving row data that is contained in the SAS Viya ecosystem.

Context

The Row Sets API works in concert with the Data Sources and Data Tables APIs to navigate, reference, and retrieve data in the SAS Viya environment. The Row Set API enables retrieval of rectangular row data for data tables.

Terminology

table

represents a rectangular data structure that consists of rows and columns of uniform data.

data table

represents a rectangular data structure that consists of rows and columns of uniform data.

column

represents a column of rectangular data.

row

represents a row of rectangular data.

cell

represents the value where a row and column intersect.

provider

represents a service that has registered itself as a provider of Row Set information. These services implement specified endpoints that the Row Sets service redirect to.

Error Codes

The following list contains the set of error codes that are used in certain error conditions.

Error Code	HTTP Status Code	Description
11900	404	No provider found.
11901	400	The `sortBy` query parameter is not supported by this provider on this endpoint.
11902	400	The `filter` query parameter is not supported by this provider on this endpoint.
11906	400	The specified Accept-Item is invalid.
11916	503	The provider for the source is not available, or it is currently starting up.
11917	503	The provider is not available, or it is currently starting up.
11938	400	The path parameter with value was not valid.
11939	400	The request body was not valid.
11940	400	The query parameter with value is not valid.
11941	400	The path parameter is required.

Note: Other error codes may be returned from respective provider services.

Operations

Root

Contains the operations for the Root resource.

Get a collection of top-level links

Code samples

# You can also use wget
curl -X GET http://mock-rowSets.apifirst.unx.sas.com/rowSets/ \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.api+json'


const headers = {
  'Accept':'application/vnd.sas.api+json'
};

fetch('http://mock-rowSets.apifirst.unx.sas.com/rowSets/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.api+json'
}

r = requests.get('http://mock-rowSets.apifirst.unx.sas.com/rowSets/', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.api+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-rowSets.apifirst.unx.sas.com/rowSets/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /

Returns a collection of links to the top-level collections that are surfaced through this API.

Example responses

Root Hateoas links.

{
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "rows",
      "href": "/rowSets/tables/{tableId}/rows",
      "uri": "/rowSets/tables/{tableId}/rows",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    },
    {
      "method": "POST",
      "rel": "rowsBasedOnWhereCondition",
      "href": "/rowSets/tables/{tableId}/rows",
      "uri": "/rowSets/tables/{tableId}/rows",
      "type": "text/plain",
      "responseType": "application/vnd.sas.collection",
      "responseItemType": "application/vnd.sas.data.row"
    },
    {
      "method": "GET",
      "rel": "rowSet",
      "href": "/rowSets/tables/{tableId}/rowSet",
      "uri": "/rowSets/tables/{tableId}/rowSet",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row.set"
    },
    {
      "method": "POST",
      "rel": "rowSetBasedOnWhereCondition",
      "href": "/rowSets/tables/{tableId}/rowSet",
      "uri": "/rowSets/tables/{tableId}/rowSet",
      "type": "text/plain",
      "responseType": "application/vnd.sas.data.row.set"
    }
  ]
}

{
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "rows",
      "href": "/rowSets/tables/{tableId}/rows",
      "uri": "/rowSets/tables/{tableId}/rows",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    },
    {
      "method": "POST",
      "rel": "rowsBasedOnWhereCondition",
      "href": "/rowSets/tables/{tableId}/rows",
      "uri": "/rowSets/tables/{tableId}/rows",
      "type": "text/plain",
      "responseType": "application/vnd.sas.collection",
      "responseItemType": "application/vnd.sas.data.row"
    },
    {
      "method": "GET",
      "rel": "rowSet",
      "href": "/rowSets/tables/{tableId}/rowSet",
      "uri": "/rowSets/tables/{tableId}/rowSet",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row.set"
    },
    {
      "method": "POST",
      "rel": "rowSetBasedOnWhereCondition",
      "href": "/rowSets/tables/{tableId}/rowSet",
      "uri": "/rowSets/tables/{tableId}/rowSet",
      "type": "text/plain",
      "responseType": "application/vnd.sas.data.row.set"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	api

Check the availability of the service

Code samples

# You can also use wget
curl -X HEAD http://mock-rowSets.apifirst.unx.sas.com/rowSets/
  -H 'Authorization: Bearer <access-token-goes-here>' \


fetch('http://mock-rowSets.apifirst.unx.sas.com/rowSets/',
{
  method: 'HEAD'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.head('http://mock-rowSets.apifirst.unx.sas.com/rowSets/')

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "http://mock-rowSets.apifirst.unx.sas.com/rowSets/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

HEAD /

Returns header information and the status.

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded. The service is available.	None

RowSet

Contains the operations for the row set resource.

Get a row set

Code samples

# You can also use wget
curl -X GET http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rowSet \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.data.row.set+json'


const headers = {
  'Accept':'application/vnd.sas.data.row.set+json'
};

fetch('http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rowSet',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.data.row.set+json'
}

r = requests.get('http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rowSet', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.data.row.set+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rowSet", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /tables/{tableId}/rowSet

Returns a paginated collection of rows and their cell's corresponding columns. Standard paging options are provided. Sorting and filtering options are provider dependent, but the default sort order is ascending by row order (i.e. index). If the provider has naturally unordered row data, it must allow for pagination in a consistent manner.

Parameters

Name	In	Type	Required	Description
tableId	path	string	true	The ID of the table.
start	query	integer(int32)	false	Pagination parameter, what is the starting index.
limit	query	integer(int32)	false	Pagination parameter, how many items to return.
format	query	boolean	false	Formats the cells of data. Defaults to true.
sortBy	query	string(sort-criteria)	false	Sort returned rows of data. Rows sorted by any valid column name. The default sort order is ascending by row order (i.e. index). For example: Sort ascending by column with name COLUMN_A: /rowSets/tables/{tableId}/rowSet?sortBy=COLUMN_A:ascending Sort descending by column with name COLUMN_A: /rowSets/tables/{tableId}/rowSet?sortBy=COLUMN_A:descending
includeColumns	query	string	false	Includes the row index as the first item in the row data. The default value is "false".
where	query	string	false	The WHERE clause to pass through to the underlying data service. This acts as a filter on the provided data. Example: ?where=COUNTRY='Canada'.
columnDetail	query	string	false	The desired column representation. The columnDetail options yield the following in the columns member: summary - application/vnd.sas.data.column.summary detail - application/vnd.sas.data.column names - the column name as a string If no value is specified, the default value is "summary".
columnStart	query	integer	false	The starting index of the first column in a page. The default value is "0".
columnLimit	query	integer	false	Maximum number of cells per row and columns to return in this page of results. The number of returned columns might be less if the collection has been exhausted. Defaults to 25.
columnSortBy	query	string(sort-criteria)	false	Sort returned columns and cells of data. Columns sorted by any valid column name. The default sort order is ascending by column index. Some sample sorts: Sort descending by column index descending: /rowSets/tables/{tableId}/rowSet?columnSortBy=index:descending Sort ascending by column name ascending: /rowSets/tables/{tableId}/rowSet?columnSortBy=name:ascending
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this parameter is not specified, the data service provider creates a temporary session, and then deletes it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they will contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This parameter has effect only if the sessionId query parameter is not specified. If this is set to true, and no sessionId is provided, the session created by the data service provider is not destroyed. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they will contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is deleted after the request is complete. The default setting is "false".

Enumerated Values

Parameter	Value
columnDetail	summary
columnDetail	detail
columnDetail	names

Example responses

A paginated collection of rows, and their cell's corresponding columns.

{
  "count": 6048,
  "start": 0,
  "limit": 10,
  "columnDetail": "names",
  "columnStart": 0,
  "columnLimit": 25,
  "rows": [
    [
      "Private flight",
      "N",
      "United States"
    ],
    [
      "135 Airways",
      "N",
      "United States"
    ],
    [
      "1Time Airline",
      "N",
      "South Africa"
    ],
    [
      "2 Sqn No 1 Elementary Flying Training School",
      "N",
      "United Kingdom"
    ],
    [
      "213 Flight Unit",
      "N",
      "Russia"
    ],
    [
      "223 Flight Unit State Airline",
      "N",
      "Russia"
    ],
    [
      "224th Flight Unit",
      "N",
      "Russia"
    ],
    [
      "247 Jet Ltd",
      "N",
      "United Kingdom"
    ],
    [
      "3D Aviation",
      "N",
      "United States"
    ],
    [
      "40-Mile Air",
      "N",
      "United States"
    ]
  ],
  "columns": [
    "NAME",
    "ALIAS",
    "COUNTRY"
  ],
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "rowSet",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "self",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "first",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "next",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=10&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=10&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "last",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=6040&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=6040&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "up",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    }
  ]
}

{
  "count": 6048,
  "start": 0,
  "limit": 10,
  "columnDetail": "names",
  "columnStart": 0,
  "columnLimit": 25,
  "rows": [
    [
      "Private flight",
      "N",
      "United States"
    ],
    [
      "135 Airways",
      "N",
      "United States"
    ],
    [
      "1Time Airline",
      "N",
      "South Africa"
    ],
    [
      "2 Sqn No 1 Elementary Flying Training School",
      "N",
      "United Kingdom"
    ],
    [
      "213 Flight Unit",
      "N",
      "Russia"
    ],
    [
      "223 Flight Unit State Airline",
      "N",
      "Russia"
    ],
    [
      "224th Flight Unit",
      "N",
      "Russia"
    ],
    [
      "247 Jet Ltd",
      "N",
      "United Kingdom"
    ],
    [
      "3D Aviation",
      "N",
      "United States"
    ],
    [
      "40-Mile Air",
      "N",
      "United States"
    ]
  ],
  "columns": [
    "NAME",
    "ALIAS",
    "COUNTRY"
  ],
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "rowSet",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "self",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "first",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "next",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=10&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=10&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "last",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=6040&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=6040&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "up",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    }
  ]
}

this is an example of an error that could be returned for bad requests

{
  "httpStatusCode": 400,
  "message": "example error message",
  "version": 2
}

{
  "httpStatusCode": 400,
  "message": "example error message",
  "version": 2
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	rowSet
400	Bad Request	The request was invalid. The error might occur in one of the following scenarios: A negative start value is provided. A negative limit value is provided. A non-existent column is specified in the sortBy or includeColumns parameter. An invalid value is specified in a parameter (such as columnDetail=doesNotExist).	Inline
404	Not Found	No resource exists at the requested path. The table that is associated with these rows does not exist.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Get a row set by the filter criteria

Code samples

# You can also use wget
curl -X POST http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rowSet \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Content-Type: text/plain' \
  -H 'Accept: application/vnd.sas.data.row.set+json'

const inputBody = 'COUNTRY='Canada'';
const headers = {
  'Content-Type':'text/plain',
  'Accept':'application/vnd.sas.data.row.set+json'
};

fetch('http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rowSet',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'text/plain',
  'Accept': 'application/vnd.sas.data.row.set+json'
}

r = requests.post('http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rowSet', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"text/plain"},
        "Accept": []string{"application/vnd.sas.data.row.set+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rowSet", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /tables/{tableId}/rowSet

Returns a paginated collection of rows, and their cell's corresponding columns. Standard paging options are provided. Sorting and filtering options are provider dependent, but the default sort order is ascending by row order (i.e. index). If the provider has naturally unordered row data, it must allow pagination in a consistent manner.

Body parameter

Example where condition.

COUNTRY='Canada'

Parameters

Name	In	Type	Required	Description
tableId	path	string	true	The ID of the table.
start	query	integer(int32)	false	Pagination parameter, what is the starting index.
limit	query	integer(int32)	false	Pagination parameter, how many items to return.
format	query	boolean	false	Whether or not to format the cells of data. Defaults to true.
sortBy	query	string(sort-criteria)	false	Sort returned rows of data. Rows sorted by any valid column name. The default sort order is ascending by row order (i.e. index). Some sample sorts: Sort ascending by column with name COLUMN_A: /rowSets/tables/{tableId}/rowSet?sortBy=COLUMN_A:ascending Sort descending by column with name COLUMN_A: /rowSets/tables/{tableId}/rowSet?sortBy=COLUMN_A:descending
columnDetail	query	string	false	The desired column representation. The columnDetail options listed below yield the following in the columns member. summary - application/vnd.sas.data.column.summary detail - application/vnd.sas.data.column names - the column name as a string If no value is specified, the default value is "summary".
includeColumns	query	string	false	Includes the row index as the first item in the row data. The default value is "false".
columnStart	query	integer	false	The starting index of the first column in a page. The default value is "0".
columnLimit	query	integer	false	Maximum number of cells per row and columns to return in this page of results. The number of returned columns might be less if the collection has been exhausted. Defaults to 25.
columnSortBy	query	string(sort-criteria)	false	Sort returned columns and cells of data. Columns sorted by any valid column name. The default sort order is ascending by column index. Some sample sorts: Sort descending by column index descending: /rowSets/tables/{tableId}/rowSet?columnSortBy=index:descending Sort ascending by column name ascending: /rowSets/tables/{tableId}/rowSet?columnSortBy=name:ascending
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this is not specified the data service provider will create a temporary session, and then destroy it after the request is complete. If this is specified all returned links, except the "self" link, will have the sessionId query parameter added to their respective URIs. Also, they will contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This parameter has effect only if the sessionId query parameter is not specified. If this is set to true, and no sessionId is provided, the session created by the data service provider will not be destroyed. All returned links, except the "self" link, will have the sessionId query parameter added to their respective URIs. Also, they will contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified the session will be destroyed after the request is complete. Defaults to false.
body	body	where	true	The WHERE clause to pass through to the underlying data service. This parameter acts as a filter on the provided data.

Enumerated Values

Parameter	Value
columnDetail	summary
columnDetail	detail
columnDetail	names

Example responses

A paginated collection of rows, and their cell's corresponding columns.

{
  "count": 6048,
  "start": 0,
  "limit": 10,
  "columnDetail": "names",
  "columnStart": 0,
  "columnLimit": 25,
  "rows": [
    [
      "Private flight",
      "N",
      "United States"
    ],
    [
      "135 Airways",
      "N",
      "United States"
    ],
    [
      "1Time Airline",
      "N",
      "South Africa"
    ],
    [
      "2 Sqn No 1 Elementary Flying Training School",
      "N",
      "United Kingdom"
    ],
    [
      "213 Flight Unit",
      "N",
      "Russia"
    ],
    [
      "223 Flight Unit State Airline",
      "N",
      "Russia"
    ],
    [
      "224th Flight Unit",
      "N",
      "Russia"
    ],
    [
      "247 Jet Ltd",
      "N",
      "United Kingdom"
    ],
    [
      "3D Aviation",
      "N",
      "United States"
    ],
    [
      "40-Mile Air",
      "N",
      "United States"
    ]
  ],
  "columns": [
    "NAME",
    "ALIAS",
    "COUNTRY"
  ],
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "rowSet",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "self",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "first",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "next",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=10&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=10&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "last",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=6040&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=6040&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "up",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    }
  ]
}

{
  "count": 6048,
  "start": 0,
  "limit": 10,
  "columnDetail": "names",
  "columnStart": 0,
  "columnLimit": 25,
  "rows": [
    [
      "Private flight",
      "N",
      "United States"
    ],
    [
      "135 Airways",
      "N",
      "United States"
    ],
    [
      "1Time Airline",
      "N",
      "South Africa"
    ],
    [
      "2 Sqn No 1 Elementary Flying Training School",
      "N",
      "United Kingdom"
    ],
    [
      "213 Flight Unit",
      "N",
      "Russia"
    ],
    [
      "223 Flight Unit State Airline",
      "N",
      "Russia"
    ],
    [
      "224th Flight Unit",
      "N",
      "Russia"
    ],
    [
      "247 Jet Ltd",
      "N",
      "United Kingdom"
    ],
    [
      "3D Aviation",
      "N",
      "United States"
    ],
    [
      "40-Mile Air",
      "N",
      "United States"
    ]
  ],
  "columns": [
    "NAME",
    "ALIAS",
    "COUNTRY"
  ],
  "version": 1,
  "links": [
    {
      "method": "GET",
      "rel": "rowSet",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "self",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "first",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=0&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "next",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=10&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=10&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "last",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=6040&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~AIRLINES/rowSet?start=6040&limit=10&includeColumns=NAME,ALIAS,COUNTRY",
      "type": "application/vnd.sas.data.row.set"
    },
    {
      "method": "GET",
      "rel": "up",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/AIRLINES",
      "type": "application/vnd.sas.data.table"
    }
  ]
}

this is an example of an error that could be returned for bad requests

{
  "httpStatusCode": 400,
  "message": "example error message",
  "version": 2
}

{
  "httpStatusCode": 400,
  "message": "example error message",
  "version": 2
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	rowSet
400	Bad Request	The request was invalid. An invalid request was made in one of the following scenarios: A negative start value is provided. A negative limit value is provided. A non-existent column is specified in the sortBy or includeColumns parameter. An invalid value is specified in a parameter (such as columnDetail=doesNotExist).	Inline
404	Not Found	No resource exists at the requested path. The table that is associated with these rows does not exist.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Rows

Contains the operations for the rows resource.

Get a collection of rows

Code samples

# You can also use wget
curl -X GET http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rows \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.collection+json'


const headers = {
  'Accept':'application/vnd.sas.collection+json'
};

fetch('http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rows',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.collection+json'
}

r = requests.get('http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rows', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.collection+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rows", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /tables/{tableId}/rows

Returns a collection of rows. Standard paging options are provided. Sorting and filtering options are provider dependent, but the default sort order is ascending by row order (for example, index). If the provider has naturally unordered row data, it must allow for pagination in a consistent manner.

Parameters

Name	In	Type	Required	Description
tableId	path	string	true	The ID of the table.
start	query	integer(int32)	false	Pagination parameter, what is the starting index.
limit	query	integer(int32)	false	Pagination parameter, how many items to return.
format	query	boolean	false	Use this parameter to format the cells of data. Defaults to true.
sortBy	query	string(sort-criteria)	false	Sort returned rows of data. Rows are sorted by any valid column ID. The default sort order is ascending by row order (i.e. index). Some sample sorts: Sort ascending by column with id COLUMN_A: /rowSets/tables/{tableId}/rows?sortBy=COLUMN_A:ascending Sort descending by column with id COLUMN_A: /rowSets/tables/{tableId}/rows?sortBy=COLUMN_A:descending
includeIndex	query	boolean	false	Use this parameter to include the row index as the first item in the row data. Defaults to false.
excludeItemLinks	query	boolean	false	Use this parameter to exclude the links from this collection's items. Defaults to true.
where	query	string	false	The WHERE clause to pass through to the underlying data service. This parameter acts as a filter on the provided data. Example: ?where=COUNTRY='Canada'.
sessionId	query	string	false	The unique identifier of the session used to access the data service provider's backing service. When this parameter is not specified, the data service provider will create a temporary session, and then delete it after the request is complete. If this parameter is specified, all returned links, except the "self" link, will have the sessionId query parameter added to their respective URIs. Also, they will contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This string has effect only if the sessionId query parameter is not specified. If this is set to true, and no sessionId is provided, the session created by the data service provider will not be destroyed. All returned links, except the "self" link, will have the sessionId query parameter added to their respective URIs. Also, they will contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false, or not specified, the session will be destroyed after the request is complete. Defaults to false.

Example responses

A pageable collection of row resources.

{
  "name": "rows",
  "accept": "application/vnd.sas.data.row",
  "start": 0,
  "limit": 10,
  "items": [
    {
      "version": 1,
      "cells": [
        "Antarctica",
        1
      ]
    },
    {
      "version": 1,
      "cells": [
        "Puerto Rico",
        2
      ]
    },
    {
      "version": 1,
      "cells": [
        "Virgin Islands (U.S.)",
        3
      ]
    },
    {
      "version": 1,
      "cells": [
        "Aruba",
        4
      ]
    },
    {
      "version": 1,
      "cells": [
        "Bahamas",
        5
      ]
    },
    {
      "version": 1,
      "cellCount": 2,
      "cells": [
        "Bermuda",
        6
      ]
    },
    {
      "version": 1,
      "cells": [
        "Belize",
        7
      ]
    },
    {
      "version": 1,
      "cells": [
        "British Virgin Islands",
        8
      ]
    },
    {
      "version": 1,
      "cells": [
        "Canada",
        9
      ]
    },
    {
      "version": 1,
      "cells": [
        "Cayman Islands",
        10
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows?start=0&limit=10",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows?start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/COUNTRY",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/COUNTRY",
      "type": "application/vnd.sas.data.table"
    }
  ]
}

{
  "name": "rows",
  "accept": "application/vnd.sas.data.row",
  "start": 0,
  "limit": 10,
  "items": [
    {
      "version": 1,
      "cells": [
        "Antarctica",
        1
      ]
    },
    {
      "version": 1,
      "cells": [
        "Puerto Rico",
        2
      ]
    },
    {
      "version": 1,
      "cells": [
        "Virgin Islands (U.S.)",
        3
      ]
    },
    {
      "version": 1,
      "cells": [
        "Aruba",
        4
      ]
    },
    {
      "version": 1,
      "cells": [
        "Bahamas",
        5
      ]
    },
    {
      "version": 1,
      "cellCount": 2,
      "cells": [
        "Bermuda",
        6
      ]
    },
    {
      "version": 1,
      "cells": [
        "Belize",
        7
      ]
    },
    {
      "version": 1,
      "cells": [
        "British Virgin Islands",
        8
      ]
    },
    {
      "version": 1,
      "cells": [
        "Canada",
        9
      ]
    },
    {
      "version": 1,
      "cells": [
        "Cayman Islands",
        10
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "collection",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    },
    {
      "method": "GET",
      "rel": "self",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows?start=0&limit=10",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows?start=0&limit=10",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    },
    {
      "method": "GET",
      "rel": "up",
      "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/COUNTRY",
      "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~MYCASLIB/tables/COUNTRY",
      "type": "application/vnd.sas.data.table"
    }
  ]
}

this is an example of an error that could be returned for bad requests

{
  "httpStatusCode": 400,
  "message": "example error message",
  "version": 2
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	rowCollection
400	Bad Request	The request was invalid. The error might occur in one of the following scenarios: A negative start value is provided. A negative limit value is provided. A non-existent column is specified in the sortBy parameter. A non-existent resource member is specified in the excludeItemFields parameter.	Inline
404	Not Found	No resource exists at the requested path. The table that is associated with these rows does not exist.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Get a collection of rows by the filter criteria

Code samples

# You can also use wget
curl -X POST http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rows \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Content-Type: text/plain' \
  -H 'Accept: application/vnd.sas.data.row+json'

const inputBody = 'COUNTRY='Canada'';
const headers = {
  'Content-Type':'text/plain',
  'Accept':'application/vnd.sas.data.row+json'
};

fetch('http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rows',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'text/plain',
  'Accept': 'application/vnd.sas.data.row+json'
}

r = requests.post('http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rows', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"text/plain"},
        "Accept": []string{"application/vnd.sas.data.row+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://mock-rowSets.apifirst.unx.sas.com/rowSets/tables/{tableId}/rows", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /tables/{tableId}/rows

Returns a collection of rows when a application/vnd.sas.data.row.set.criteria resource is provided in the body of the request. Standard paging options are provided. Sorting is provider dependent, but the default sort order is ascending by row order (i.e. index). If the provider has naturally unordered row data, it must allow for pagination in a consistent manner.

Body parameter

Example where condition.

COUNTRY='Canada'

Parameters

Name	In	Type	Required	Description
tableId	path	string	true	The ID of the table.
start	query	integer(int32)	false	Pagination parameter, what is the starting index.
limit	query	integer(int32)	false	Pagination parameter, how many items to return.
sortBy	query	string(sort-criteria)	false	Sort returned rows of data. Rows sorted by any valid column ID. The default sort order is ascending by row order (i.e. index). Examples: Sort ascending by column with id COLUMN_A: /rowSets/tables/{tableId}/rows?sortBy=COLUMN_A:ascending Sort descending by column with id COLUMN_A: /rowSets/tables/{tableId}/rows?sortBy=COLUMN_A:descending
includeIndex	query	boolean	false	Includes the row index as the first item in the row data. Defaults to false.
excludeItemLinks	query	boolean	false	Excludes the links from this collection's items. Defaults to true.
sessionId	query	string	false	The unique identifier of the session that is used to access the data service provider's backing service. When this parameter is not specified, the data service provider creates a temporary session and then destroys it after the request is complete. If this parameter is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they will contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
preserveSession	query	boolean	false	This parameter has effect only if the sessionId query parameter is not specified. If set to true, and no sessionId is provided, the session created by the data service provider is not destroyed. All returned links, except the "self" link, will have the sessionId query parameter added to their respective URIs. Also, they will contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is deleted after the request is complete. Defaults to false.
body	body	where	true	The WHERE clause to pass through to the underlying data service. This parameter acts as a filter on the provided data.

Example responses

Representation of a row summary object.

{
  "version": 1,
  "cells": [
    "Antarctica",
    1
  ],
  "links": [
    {
      "method": "GET",
      "rel": "up",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    }
  ]
}

{
  "version": 1,
  "cells": [
    "Antarctica",
    1
  ],
  "links": [
    {
      "method": "GET",
      "rel": "up",
      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows",
      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~COUNTRY/rows",
      "type": "application/vnd.sas.collection",
      "itemType": "application/vnd.sas.data.row"
    }
  ]
}

this is an example of an error that could be returned for bad requests

{
  "httpStatusCode": 400,
  "message": "example error message",
  "version": 2
}

this is an example of an error that could be returned for resource not found

{
  "httpStatusCode": 404,
  "message": "example error message",
  "version": 2
}

Responses

Status	Meaning	Description	Schema
201	Created	Created. The requested row has both been created.	row
400	Bad Request	The request was invalid. The error might occur in one of the following scenarios: A negative start value is provided. A negative limit value is provided. A non-existent column is specified in the sortBy parameter. A non-existent resource member is specified in the excludeItemFields parameter.	Inline
404	Not Found	No resource exists at the requested path. The table could not be found at the requested path.	Inline

Response Schema

Status Code 400

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Status Code 404

Error

Name	Type	Required	Restrictions	Description
» message	string	false	none	The message for the error.
» id	string	false	none	The string ID for the error.
» errorCode	integer	false	none	The numeric ID for the error.
» httpStatusCode	integer	true	none	The HTTP status code for the error.
» details	[string]	false	none	Messages that provide additional details about the cause of the error.
» remediation	string	false	none	A message that describes how to resolve the error.
» errors	[#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema]	false	none	Any additional errors that occurred.
»» Error	#/paths/~1tables~1%7BtableId%7D~1rows/get/responses/400/content/application~1vnd.sas.error/schema	false	none	The representation of an error.
» links	[link]	false	none	The links that apply to the error.
»» Link	link	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
» version	integer	true	none	The version number of the error representation. This representation is version 2.

Response Headers

Status	Header	Type	Format	Description
201	Location	string		location of the completed job.

Schemas

row

{
  "cells": [
    null
  ],
  "version": 0,
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ]
}

Row

Properties

Name	Type	Required	Restrictions	Description
cells	[any]	false	none	The cells for this row. Can be number, integer, null, boolean, or string.
version	integer	false	none	The row schema version.
links	[object]	false	none	The links that apply to this resource.
» Link	object	false	none	A link to a related operation or resource.
»» method	string	false	none	The HTTP method for the link.
»» rel	string	true	none	The relationship of the link to the resource.
»» uri	string	false	none	The relative URI for the link.
»» href	string	false	none	The URL for the link.
»» title	string	false	none	The title for the link.
»» type	string	false	none	The media type or link type for the link.
»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.

rowCollection

{
  "name": "string",
  "start": 0,
  "limit": 0,
  "count": 0,
  "accept": "string",
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "items": [
    {
      "cells": [
        null
      ],
      "version": 0,
      "links": [
        {
          "method": "string",
          "rel": "string",
          "uri": "string",
          "href": "string",
          "title": "string",
          "type": "string",
          "itemType": "string",
          "responseType": "string",
          "responseItemType": "string"
        }
      ]
    }
  ],
  "version": 0
}

Row Collection

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the collection "rows" in the context of the request.
start	integer	false	none	The 0-based index of the result candidates to start returning.
limit	integer	false	none	The maximum number of results requested.
count	integer	false	none	The number of results returned in the collection.
accept	string	false	none	A space-separated list of link types of the items in this collection.
links	[link]	false	none	Paging links that apply to this object.
items	[row]	false	none	The results of a query.
version	integer	false	none	The collection schema version.

rowSet

{
  "columnDetail": "summary",
  "start": 0,
  "limit": 0,
  "count": 0,
  "columnCount": 0,
  "columnStart": 0,
  "columnLimit": 0,
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "rows": [
    [
      "string"
    ]
  ],
  "columns": [
    "string"
  ],
  "version": 0
}

Row Set

Properties

Name	Type	Required	Restrictions	Description
columnDetail	string	false	none	The level of detail of the columns array member. This value is set by the columnDetail query parameter, and defaults to summary when none is provided.
start	integer	false	none	The 0-based index of the rows candidates to start returning.
limit	integer	false	none	The maximum number of rows requested.
count	integer	false	none	The actual number of rows returned in the collection.
columnCount	integer	false	none	The number of columns in the collection. Can be omitted if the count is not known.
columnStart	integer	false	none	The index of the first column in the columns member, 0-based. Defaults to 0. Omitted if the includeColumns query parameter is set.
columnLimit	integer	false	none	The number of columns to return in each page. Defaults to 25. Will be omitted if the includeColumns query parameter is set.
links	[link]	false	none	Paging links that apply to this object.
rows	[array]	false	none	The results of this query as an array containing arrays of heterogeneous data.
columns	[string]	false	none	The rows' corresponding columns. The type of items in this array is determined by the columnDetail query parameter's value, which can be one of the following: summary - The default if no value is specified. Contains application/vnd.sas.data.column.summary objects. detail - Contains application/vnd.sas.data.column objects. names - Contains the column names as JSON strings.
version	integer	false	none	Collection schema version.

Enumerated Values

Property	Value
columnDetail	summary
columnDetail	detail
columnDetail	names

where

"string"

WHERE Clause

Properties

Name	Type	Required	Restrictions	Description
WHERE Clause	string	false	none	The WHERE clause to pass through to the underlying data service. This acts as a filter on the provided data. example: COUNTRY='Canada'.

api

{
  "links": [
    {
      "method": "string",
      "rel": "string",
      "uri": "string",
      "href": "string",
      "title": "string",
      "type": "string",
      "itemType": "string",
      "responseType": "string",
      "responseItemType": "string"
    }
  ],
  "version": 1
}

A list of links to top level resources available from the root of the API.

Properties

Name	Type	Required	Restrictions	Description
links	[link]	false	none	The API's top-level links.
version	integer	false	none	The version number of the API representation. This is version 1.

Examples

Github Examples

Detailed examples on how to use this API can be found on Github.

Media Type Samples

Externally Defined Media Types

application/vnd.sas.collection
application/vnd.sas.error
application/vnd.sas.data.provider
application/vnd.sas.data.provider.summary
application/vnd.sas.data.table

application/vnd.sas.data.row

The application/vnd.sas.data.row media type serves as the complete JSON representation of a row of data.

Link Relations

Relation	HTTP Method	Description
`up`	`GET`	Creates a link to the collection of all rows for this source reference URI: `/rowSets/tables/{tableId}/rows` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.row`

Members

Name	Type	Description
`version`	`integer`	Returns this media type.

s schema version number. This representation is version 1. | | cells | array | Creates an array of heterogeneous data that represents the content of the cells. | | links | array of link objects | Creates zero or more links to related resources or operations. See the above link relations table for a description of the link types. |

application/vnd.sas.data.row+json


 {
            "method": "GET",
            "rel": "up",
            "type": "application/vnd.sas.collection",
            "itemType": "application/vnd.sas.data.row",
            "href": "/rowSets/tables/cas~fs~myCasServer~fs~myCasLib~fs~myCasTable/rows",
            "uri": "/rowSets/tables/cas~fs~myCasServer~fs~myCasLib~fs~myCasTable/rows"
        }
    ],
    "cells": [
        2468.0,
        "Frontier Airlines",
        "\\N",
        "F9",
        "FFT",
        "FRONTIER FLIGHT",
        "United States",
        "Y"
    ],
    version: 1
}

Resource Relationships

The diagram below shows the relationships between the resources in this API.

Row Sets entity relationship diagram

Pagination, sorting, and filtering

pagination - The default page limit is 10 for all collections. To modify this limit, set the ?limit query parameter when applicable.
sorting- A sort order of ascending by column index is applied by default to the contents of the /rows endpoint collections. To specify an alternate sort order, use the ?sortBy query parameter. A sort order can be applied only to the simple fields of a resource. Methods within this API do not support the various strength options as outlined by the sorting guidelines.
row filtering - you can filter the returned rows using one of the following actions:
- POST /rowSets/tables/{tableId}/rows
  
  Provide a WHERE clause by setting the Content-Type header to text/plain and placing the WHERE clause in the body, such as COUNTRY='Canada'
- GET /rowSets/tables/{tableId}/rows?where={whereClause}
Example: /rowSets/tables/{tableId}/rows?where=COUNTRY='Canada'

Root

Path: /

Links

Relation	HTTP Method	Description
`rows`	`GET`	Returns a link template to return a collection of rows. URI: `/rowSets/tables/{tableId}/rows` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.row`

Rows

Path: /tables/{tableId}/rows

Links

Relation	HTTP Method	Description
`collection`	`GET`	Returns the base of the unfiltered or unsorted collection. URI: `/rowSets/tables/{tableId}/rows` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.row`
`self`	`GET`	Returns the current page of the (filtered) collection. The `sessionId` query parameter is always excluded from this link. URI: `/rowSets/tables/{tableId}/rows` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.row`
`sessionScoped`	`GET`	Returns the current page of the (filtered) collection with the `sessionId` query parameter included. This link exists only if the `sessionId`query parameter is passed in. URI: `/rowSets/tables/{tableId}/rows?sessionId={sessionId}` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.row`
`first`	`GET`	Returns the first page of collection results. (start=0) URI: `/rowSets/tables/{tableId}/rows` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.row`
`prev`	`GET`	Returns the previous page of collection results. URI: `/rowSets/tables/{tableId}/rows` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.row`
`next`	`GET`	Returns the next page of collection results. URI: `/rowSets/tables/{tableId}/rows` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.row`
`last`	`GET`	Returns the last page of collection results. URI: `/rowSets/tables/{tableId}/rows` Type: `application/vnd.sas.collection` Item type: `application/vnd.sas.data.row`
`session`	`GET`	Returns the session for accessing this source. This link is included if the client request includes the `sessionId` query parameter, or if the `preserveSession` query parameter is set to true. HREF: `/dataSources/providers/{providerId}/{sourceId}/sessions/{sessionId}` Type: `application/vnd.sas.data.session`
`up`	`GET`	Returns the collection of rows parent table HREF: /dataTables/dataSources/{dataSourceId}/tables/{tableId} Type: `application/vnd.sas.data.table`

SAS Studio Development

Base URLs:

https://example.com/studioDevelopment

Terms of service Email: SAS Developers Web: SAS Developers

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

SAS Studio API

Usage Notes

Overview

The SAS Studio Development API provides programmatic access to functionality that is available in SAS Studio. This API is useful for supporting CI/CD workflows as well as for automation of submission of Studio artifact for execution on SAS Compute or SAS Job Execution Service.

Error Codes

This API uses the standard error response type, 'application/vnd.sas.error' to handle propagating all error messages and codes to the consumer. The range of error codes assigned to the Studio Development API is 124,300-124,699. The list below contains the set of error codes that are used for the following error conditions:

HTTP Status Code	Error Code	Description
400	124300	The user specified an invalid media type in the code generation request.
400	124301	The user specified an invalid reference type in the code generation request.
400	124302	The user referenced an object in the code generation request that does not exist.
500	124303	An error ocurred during code generation.
400	124305	Input validation failed for one or more fields in the code generation request.
400	124306	Only one of either a reference or an object must be specified.

Operations

Root

Contains the operations for the root resource.

Gets the API object

Code samples

# You can also use wget
curl -X GET https://example.com/studioDevelopment/ \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Accept: application/vnd.sas.api+json'


const headers = {
  'Accept':'application/vnd.sas.api+json'
};

fetch('https://example.com/studioDevelopment/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/vnd.sas.api+json'
}

r = requests.get('https://example.com/studioDevelopment/', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.sas.api+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://example.com/studioDevelopment/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /

The API object contains a set of links for the supported endpoints.

Example responses

Example response for a GET on /.

{
  "version": 1,
  "links": [
    {
      "method": "POST",
      "rel": "generateCode",
      "href": "/studioDevelopment/code",
      "uri": "/studioDevelopment/code",
      "type": "application/vnd.sas.code.generation.request",
      "responseType": "application/vnd.sas.code.generation.request"
    }
  ]
}

{
  "version": 1,
  "links": [
    {
      "method": "POST",
      "rel": "generateCode",
      "href": "/studioDevelopment/code",
      "uri": "/studioDevelopment/code",
      "type": "application/vnd.sas.code.generation.request",
      "responseType": "application/vnd.sas.code.generation.request"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	Inline

Response Schema

Status Code 200

API

Name	Type	Required	Restrictions	Description
» version	integer	true	none	The version number of the API representation. This is version 1.
» links	[object]	true	none	The API's top-level links.
»» Link	object	false	none	A link to a related operation or resource.
»»» method	string	false	none	The HTTP method for the link.
»»» rel	string	true	none	The relationship of the link to the resource.
»»» uri	string	false	none	The relative URI for the link.
»»» href	string	false	none	The URL for the link.
»»» title	string	false	none	The title for the link.
»»» type	string	false	none	The media type or link type for the link.
»»» itemType	string	false	none	If this is a link to a container, `itemType` is the media type or link type for the items in the container.
»»» responseType	string	false	none	The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
»»» responseItemType	string	false	none	The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.

Response Headers

Status	Header	Type	Format	Description
200	Content-Type	string		No description

Checks API availability

Code samples

# You can also use wget
curl -X HEAD https://example.com/studioDevelopment/
  -H 'Authorization: Bearer <access-token-goes-here>' \


fetch('https://example.com/studioDevelopment/',
{
  method: 'HEAD'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.head('https://example.com/studioDevelopment/')

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "https://example.com/studioDevelopment/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

HEAD /

Returns the headers for the API - this operation determines whether the service provided by the API is available.

Responses

Status	Meaning	Description	Schema
200	OK	The request succeeded.	None

Response Headers

Status	Header	Type	Format	Description
200	Content-Type	string		No description

CodeGeneration

Generates code for SAS Studio artifact (Studio Flow and SAS Program) stored either in SAS Content or on file system. If generating code for an artifact stored in file system then a compute session should be created. If not provided as part of API request (sessionId attribute), a session will be created in the default SAS Studio compute context.

Generates code for an item at the given location

Code samples

# You can also use wget
curl -X POST https://example.com/studioDevelopment/code \
  -H 'Authorization: Bearer <access-token-goes-here>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/vnd.sas.publish.code.generation.result'

const inputBody = '{
  "reference": {
    "type": "content",
    "path": "/Public/test.flw",
    "mediaType": "application/vnd.sas.dataflow"
  },
  "initCode": true,
  "wrapperCode": false
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/vnd.sas.publish.code.generation.result'
};

fetch('https://example.com/studioDevelopment/code',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/vnd.sas.publish.code.generation.result'
}

r = requests.post('https://example.com/studioDevelopment/code', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/vnd.sas.publish.code.generation.result"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://example.com/studioDevelopment/code", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /code

Given the location of a SAS program or the Studio flow file, return the code that SAS Studio would run.

Body parameter

Example generation request for a flow stored in content.

{
  "reference": {
    "type": "content",
    "path": "/Public/test.flw",
    "mediaType": "application/vnd.sas.dataflow"
  },
  "initCode": true,
  "wrapperCode": false
}

Parameters

Name	In	Type	Required	Description
sessionId	query	string	false	If referencing a file on the compute file system, use this session id to access the file. If not provided, a session will be created in the default SAS Studio compute context to access the file.
body	body	codeGenerationRequest	true	The code generation request.

Example responses

Example generation response for a program.

Responses

Status	Meaning	Description	Schema
200	OK	The generated code.	codeGenerationResult
400	Bad Request	Bad request. The request body had invalid input.	None

Schemas

externalReference

{
  "type": "content",
  "path": "string",
  "mediaType": "application/vnd.sas.dataflow"
}

externalReference

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	Indicates the type of content (SAS Content or SAS Compute Server)
path	string	false	none	Indicates the path in SAS Content or the path on the SAS Compute Server. Must start with '/'.
mediaType	string	false	none	Indicates the media type of the object being referenced.

Enumerated Values

Property	Value
type	content
type	compute
mediaType	application/vnd.sas.dataflow
mediaType	application/vnd.sas.program

sourceObject

{
  "value": "string",
  "mediaType": "application/vnd.sas.dataflow"
}

sourceObject

Properties

Name	Type	Required	Restrictions	Description
value	string	false	none	If a flow, the raw contents of a flow represented as a string. If code, the actual code
mediaType	string	false	none	Indicates the media type of the object being referenced.

Enumerated Values

Property	Value
mediaType	application/vnd.sas.dataflow
mediaType	application/vnd.sas.program

codeGenerationRequest

{
  "reference": {
    "type": "content",
    "path": "string",
    "mediaType": "application/vnd.sas.dataflow"
  },
  "object": {
    "value": "string",
    "mediaType": "application/vnd.sas.dataflow"
  },
  "initCode": true,
  "wrapperCode": true
}

codeGenerationRequest

Properties

Name	Type	Required	Restrictions	Description
reference	externalReference	false	none	A pointer to an object in SAS Content, on the SAS Compute Server, or in a service.
object	sourceObject	false	none	Flow or code that will be used to generate the result. If this is a flow, it will be the raw contents of a flow created in SAS Studio, and will look like JSON data. If this is code, it will be the actual SAS code.
initCode	boolean	false	none	Indicates whether to include the initialization code for the SAS Studio session.
wrapperCode	boolean	false	none	Indicates whether to include the wrapper code for the SAS Studio request.

codeGenerationResult

{
  "code": "string"
}

codeGenerationResult

Properties

Name	Type	Required	Restrictions	Description
code	string	false	none	Generated code.