NAV Navbar
Home icon
SAS Viya REST APIs
shell javascript python go
  • Data Management
  • Data Management

    Data Quality

    Base URLs:

    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.

    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"
        }
      ]
    }
    
    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

    [
      {
        "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.

    {
      "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:

    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:


    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:

    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:

    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:


    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:

    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:


    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:


    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:

    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:


    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:

    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:


    The default sort is by name in ascending order.

    Example responses

    An example of source definition collection.

    {
      "name": "sourceDefinitions",
      <