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

    Data Quality

    Base URLs:

    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).

    Usage Notes

    Overview

    The Data Quality API enables clients to reference information contained in a Quality Knowledge Base (QKB), such as the following:

    Clients use the API to determine which operations are available for a given QKB. Other facilities, such as the DATA Step 1 CAS action, perform transformations. Examples of SAS applications that use the Data Quality API include SAS Visual Data Builder and SAS Data Preparation.

    Session Management

    For operations within an execution context, endpoints accept an optional query parameter named 'sessionId'. Providing a session ID to these endpoints can improve performance dramatically. If a session ID is not provided, the Data Quality API attempts to create a session. When processing is complete, the API attempts to destroy the session. If a session ID is provided, the client is responsible for destroying the session after the completion of processing. Links provided by the Data Quality API propagate the session ID, with the exception of the self link.

    Collection Behavior

    Methods in the Data Quality API that operate on a collection support the following features:

    Collection URIs

    The following URIs return collections:

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

    Terminology

    context

    an available execution environment, such as a CAS server, Server context, various InDB technologies.

    data quality operation

    a result that is returned by a data quality function. Categories of functions support operations such as parsing, matching, casing, and standardization.

    definition

    an algorithm in a Quality Knowledge Base that implements a data quality operation. Each definition applies to one type of text content and one locale. To execute a data quality operation, a function specifies a definition and a column of source data. Definitions are identified by name. Available definitions can be enumerated by the API. The names of definitions can contain characters such as spaces that must be encoded. Definition names are not unique within a QKB but are unique within a function.

    environment

    a type of execution environment. Supported execution environments are CAS and compute.

    function

    a data quality language element. To complete a data quality operation, the language element references a definition in a locale in a QKB.

    locale

    in a QKB, a locale provides reference information for a specified language and geographic region. Not all data quality functions are supported in all locales. The result of a data quality operation on the same data can differ based on the specified locale.

    QKB

    a Quality Knowledge Base, which provides reference information for data quality operations. A QKB must be installed before it can be referenced by the DataQuality API.

    token

    an element returned by a definition within a QKB. For example, a parsing function can return tokens such as street, city, and state. Token names can include spaces.

    Error Codes

    This API uses the standard error response type, application/vnd.sas.error, to handle propagating all error messages and codes to the consumer.

    The range of error codes assigned to the Data Quality microservice REST API is:

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

    HTTP Status Code Error Code Description
    404 100201 Environment not found.
    404 100202 Context not found.
    404 100203 CasLib not found.
    404 100204 QKB not found.
    404 100205 Locale not found.
    404 100206 Function not found.
    404 100207 Definition not found.
    404 100208 Token not found.
    500 100209 Cannot get CAS session.
    500 100209 Error invoking CAS action.

    Security

    The Data Quality service grants READ access for a principalType of "everyone". There are no endpoints that support DELETE, PUT, POST, or PATCH.

    Operations

    Root

    Contains the operations for the root resource.

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataQuality/ \
      -H 'Accept: application/vnd.sas.api+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.api+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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
    404 Not Found No service exists at the requested path. None

    Get headers and verify that API is available

    Code samples

    # You can also use wget
    curl -X HEAD https://www.example.com/dataQuality/
    
    
    
    fetch('https://www.example.com/dataQuality/',
    {
      method: 'HEAD'
    
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    
    r = requests.head('https://www.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://www.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
    404 Not Found No service exists at the requested path. 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://www.example.com/dataQuality/qkbs \
      -H 'Accept: application/vnd.sas.collection+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.collection+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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.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": 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://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs \
      -H 'Accept: application/vnd.sas.collection+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.collection+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. A list of available QKBs was successfully returned. qkbCollection
    404 Not Found No service exists at the requested path. None

    Get QKB information

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName} \
      -H 'Accept: application/vnd.sas.data.quality.qkb+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.quality.qkb+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. QKB information was successfully returned. qkb
    404 Not Found No service exists at the requested path. None

    Get headers and verify that QKB exists

    Code samples

    # You can also use wget
    curl -X HEAD https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}
    
    
    
    fetch('https://www.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://www.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://www.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 No service exists at the requested path. None

    Environments

    Contains the operations for execution environments.

    Get list of available execution environments

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataQuality/environments \
      -H 'Accept: application/vnd.sas.collection+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.collection+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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.collection"
        }
      ],
      "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": 1,
          "name": "compute",
          "links": [
            {
              "method": "GET",
              "rel": "self",
              "href": "/dataQuality/environments/compute",
              "uri": "/dataQuality/environments/compute",
              "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/compute/contexts",
              "uri": "/dataQuality/environments/compute/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://www.example.com/dataQuality/environments/{environmentName} \
      -H 'Accept: application/vnd.sas.data.quality.environment+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.quality.environment+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. Information was returned for the specified execution environment. environment
    404 Not Found No service exists at the requested path. None

    Get headers and verify that execution environment exists

    Code samples

    # You can also use wget
    curl -X HEAD https://www.example.com/dataQuality/environments/{environmentName}
    
    
    
    fetch('https://www.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://www.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://www.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 No service exists at the requested path. 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://www.example.com/dataQuality/environments/{environmentName}/contexts \
      -H 'Accept: application/vnd.sas.collection+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.collection+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. A sorted list of available execution environments was returned. contextCollection
    404 Not Found No service exists at the requested path. None

    Get context details

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName} \
      -H 'Accept: application/vnd.sas.data.quality.context+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.quality.context+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "version": 1,
      "name": "casqkb",
      "type": "CAS",
      "description": "controller",
      "host": "www.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"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. Context information was returned. context
    404 Not Found No service exists at the requested path. None

    Get headers and verify existence of a context

    Code samples

    # You can also use wget
    curl -X HEAD https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}
    
    
    
    fetch('https://www.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://www.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://www.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 No service exists at the requested path. 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://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales \
      -H 'Accept: application/vnd.sas.collection+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.collection+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. A list of available locales was successfully returned. localeCollection
    404 Not Found No service exists at the requested path. No QKB exists in the specified context. None

    Get QKB locale information

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName} \
      -H 'Accept: application/vnd.sas.data.quality.locale+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.quality.locale+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. Locale information was successfully returned. locale
    404 Not Found No service exists at the requested path. No locale or QKB exists in the specified context. None

    Get headers and verify that locale exists

    Code samples

    # You can also use wget
    curl -X HEAD https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}
    
    
    
    fetch('https://www.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://www.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://www.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 No service exists at the requested path. The specified locale does not exist in 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://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions \
      -H 'Accept: application/vnd.sas.collection+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.collection+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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
    }
    
    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 No service exists at the requested path. The specified locale is not found in the specified QKB. None

    Get function information

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName} \
      -H 'Accept: application/vnd.sas.data.quality.function+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.quality.function+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. Function information was returned for the specified locale and QKB. function
    404 Not Found No service exists at the requested path. The specified QKB, locale, or function does not exist in the specified execution environment. None

    Get headers and verify that a function is available for locale

    Code samples

    # You can also use wget
    curl -X HEAD https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}
    
    
    
    fetch('https://www.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://www.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://www.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 No service exists at the requested path. The function does not exist in the specified context. 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://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions \
      -H 'Accept: application/vnd.sas.collection+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.collection+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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
    }
    
    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 No service exists at the requested path. The definition, locale, or QKB does not exist in the specified context. None

    Get definition information

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName} \
      -H 'Accept: application/vnd.sas.data.quality.definition+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.quality.definition+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. Information was returned for the specified data quality definition. definition
    404 Not Found No service exists at the requested path. The specified data quality definition does not exist in the specified context. None

    Get headers and verify that a definition exists

    Code samples

    # You can also use wget
    curl -X HEAD https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}
    
    
    
    fetch('https://www.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://www.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://www.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 No service exists at the requested path. The data quality definition does not exist in the specified context. 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://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens \
      -H 'Accept: application/vnd.sas.collection+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.collection+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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
    }
    
    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 No service exists at the requested path. No tokens exist in the specified context. None

    Get information about a token

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName} \
      -H 'Accept: application/vnd.sas.data.quality.token+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.quality.token+json'
    };
    
    fetch('https://www.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://www.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://www.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

    200 Response

    {
      "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"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. Token information was returned for the specified context. token
    404 Not Found No service exists at the requested path. Token information does not exist in the specified context. None

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

    Code samples

    # You can also use wget
    curl -X HEAD https://www.example.com/dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}
    
    
    
    fetch('https://www.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://www.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://www.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 No service exists at the requested path. The token does not exist in the specified context. None

    Schemas

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

    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.

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

    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 [any] false none Links that apply to this execution environment,
    » Link object false none A link to a related operation or resource.
    »» method string false none The HTTP method for the link.
    »» rel string true none The relationship of the link to the resource.
    »» uri string false none The relative URI for the link.
    »» href string false none The URL for the link.
    »» title string false none The title for the link.
    »» type string false none The media type or link type for the link.
    »» itemType string false none If this is a link to a container, itemType is the media type or link type for the items in the container.
    »» responseType string false none The media type or link type of the response body for a PUT, POST, or PATCH operation.
    »» responseItemType string false none The media type or link type of the items in the response body for a PUT, POST, or PATCH operation.

    environmentCollection

    {
      "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.collection"
        }
      ],
      "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": 1,
          "name": "compute",
          "links": [
            {
              "method": "GET",
              "rel": "self",
              "href": "/dataQuality/environments/compute",
              "uri": "/dataQuality/environments/compute",
              "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/compute/contexts",
              "uri": "/dataQuality/environments/compute/contexts",
              "type": "application/vnd.sas.collection",
              "itemType": "application/vnd.sas.data.quality.context"
            }
          ]
        }
      ],
      "version": 2
    }
    
    

    Environment Collection

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

    allOf

    Name Type Required Restrictions Description
    anonymous object false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)
    » name string false none The name of the collection.
    » start integer(int64) false none The zero-based index of the first item in the collection.
    » limit integer false none The number of items that were requested for the collection.
    » count integer(int64) false none If populated indicates the number of items in the collection.
    » accept string false none A space-delimited list of media types from which an Accept header may be constructed.
    » links [environment] false none The links that apply to the collection.
    » version integer false none The version number of the collection representation. This representation is version 2.

    and

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

    context

    {
      "version": 1,
      "name": "casqkb",
      "type": "CAS",
      "description": "controller",
      "host": "www.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"
        }
      ]
    }
    
    

    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 [environment] false none Provides links that apply to this context.

    contextCollection

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

    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 environmentCollection false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

    and

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

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

    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 [environment] false none Provides a list of links that apply to the QKB.

    qkbCollection

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

    QKB Collection

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

    allOf

    Name Type Required Restrictions Description
    anonymous environmentCollection false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

    and

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

    allQkbsCollection

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

    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 environmentCollection false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

    and

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

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

    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 [environment] false none Provides links that apply to the locale.

    localeCollection

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

    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 environmentCollection false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

    and

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

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

    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 [environment] false none Provides a list of links that apply to this function.

    functionCollection

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

    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 environmentCollection false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

    and

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

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

    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 [environment] false none Provides a list of links that apply to the locale.

    definitionCollection

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

    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 environmentCollection false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

    and

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

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

    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 [environment] false none Provides a list of links that apply to the token.

    tokenCollection

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

    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 environmentCollection false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

    and

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

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

    Links

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

    Examples

    Media Type Samples

    application/vnd.sas.data.quality.environment

    Provides detailed information about an environment.

    This is described by environment.

    Below is an example of the JSON representation of this media type.

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

    application/vnd.sas.data.quality.context

    Provides detailed information about a context.

    This is described by context.

    Below is an example of the JSON representation of this media type.

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

    application/vnd.sas.data.quality.qkb

    Provides information about a QKB.

    This is described by qkb.

    Below is an example of the JSON representation of this media type.

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

    application/vnd.sas.data.quality.locale

    Provides detailed information about a locale.

    This is described by locale.

    Below is an example of the JSON representation of this media type.

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

    application/vnd.sas.data.quality.function

    Provides information about a function.

    This is described by function.

    Below is an example of the JSON representation of this media type.

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

    application/vnd.sas.data.quality.definition

    Provides information about a definition.

    This is described by definition.

    Below is an example of the JSON representation of this media type.

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

    application/vnd.sas.data.quality.token

    Provides information about a token.

    This is described by token.

    Below is an example of the JSON representation of this media type.

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

    Resource Reference

    Common Collection Behaviors

    GET operations on collection resources return an application/vnd.sas.collection. The following endpoints return collections in this API:

    Collection Item Type Up-link Type
    /dataQuality/environments application/vnd.sas.data.quality.environment application/vnd.sas.api
    /dataQuality/environments/{environmentName}/contexts application/vnd.sas.data.quality.context application/vnd.sas.data.quality.environment
    /dataQuality/qkbs application/vnd.sas.data.quality.qkb application/vnd.sas.api
    /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs application/vnd.sas.data.quality.qkb application/vnd.sas.data.quality.context
    /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales application/vnd.sas.data.quality.locale application/vnd.sas.data.quality.qkb
    /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions application/vnd.sas.data.quality.function application/vnd.sas.data.quality.locale
    /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions application/vnd.sas.data.quality.definition application/vnd.sas.data.quality.function
    /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens application/vnd.sas.data.quality.token application/vnd.sas.data.quality.definition

    All collections support pagination links and an uplink:

    Relation Description
    self Returns the current page from the collection.
    collection Returns the first page of the collection, without sorting or filtering criteria.
    prev Returns the previous page of resources from the collection. Present if not at the start of the collection.
    next Returns the next page of resources from the collection. Present if not at the end of the collection.
    first Returns the first page of resources from the collection. Present if not at the start of the collection.
    last Returns the last page of resources from the collection. Present if not at the end of the collection.
    up The parent resource.

    Additional links are documented in the collection endpoints where they appear.

    Root

    Path: /

    The root of the API. This resource contains links to the top-level resources in the API. The response uses the application/vnd.sas.api media type.

    The GET / response includes the following links.

    Relation Method Description
    environments GET Returns the collection of environments.
    URI: /dataQuality/environments
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.environment
    qkbs GET Returns the collection of QKBs across all environments.
    URI: /dataQuality/qkbs
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.qkb
    Environments

    Collection endpoint path: /dataQuality/environments

    Retrieves a list of all available execution environments.

    The Environments collection response includes the usual set of pagination and up-links.

    Individual endpoint path: /dataQuality/environments/{environmentName}

    Retrieves environment details. In addition to GET, this path also supports HEAD method.

    The GET /dataQuality/environments/{environmentName} response includes the following links.

    Relation Method Description
    self GET Returns information about particular execution environment.
    URI: /dataQuality/environments/{environmentName}
    Type: application/vnd.sas.data.quality.environment
    up GET Returns the collection of environments.
    URI: /dataQuality/environments
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.environment
    contexts GET Returns a collection of all available contexts for a particular environment type.
    URI: /dataQuality/environments/{environmentName}/contexts
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.context
    Contexts

    Collection endpoint path: /dataQuality/environments/{environmentName}/contexts

    Retrieves a list of all available execution contexts for a particular environment type.

    The contexts collection response includes the usual set of pagination and up-links.

    Individual endpoint path: /dataQuality/environments/{environmentName}/contexts/{contextName}

    Retrieves context details. In addition to GET, this path also supports HEAD method.

    The GET / includes the following links.

    Relation Method Description
    self GET Returns information about particular execution context.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}
    Type: application/vnd.sas.data.quality.context
    up GET Returns a collection of all available contexts for a particular environment type.
    URI: /dataQuality/environments/{environmentName}/contexts
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.context
    qkbs GET Returns a collection of all available QKBs on a particular context.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.qkb
    QKBs

    All QKBs Collection Endpoint Path: /dataQuality/qkbs

    Retrieves a list of all available QKBs across all available execution contexts.

    The all QKBs collection response includes the usual set of pagination and up-links.

    QKBs Collection Endpoint Path: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs

    Retrieves a list of all available QKBs on a particular context.

    The QKBs collection response includes the usual set of pagination and up-links.

    QKBs Individual Endpoint Path: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}

    Retrieves QKB information about a context. In addition to GET, this path also supports HEAD and DELETE methods.

    . The GET /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName} includes the following links.

    Relation Method Description
    self GET Returns information about a particular QKB on a particular execution context.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}
    Type: application/vnd.sas.data.quality.qkb or application/vnd.sas.data.quality.qkb
    up GET Returns a collection of all available QKBs on a particular context.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.qkb
    locales GET Returns a collection of locales.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.locale
    Locale

    Collection endpoint path: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales

    Returns a list of locale in a particular QKB.

    The locale collection response includes the usual set of pagination and up-links.

    Individual endpoint path: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}

    Returns locale information for a given context and QKB. In addition to GET, this path also supports HEAD method.

    The GET / includes the following links.

    Relation Method Description
    self GET Returns locale information for a given context and QKB.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}
    Type: application/vnd.sas.data.quality.locale
    up GET Returns a list of locale in a particular QKB.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.locale
    functions GET Returns a list of functions in a particular QKB and locale.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.function
    Functions

    Collection endpoint path: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions

    Returns a list of functions in a particular QKB and locale.

    The functions collection response includes the usual set of pagination and up-links.

    Individual endpoint path: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}

    Returns a function information for a given QKB, context, and locale. In addition to GET, this path also supports HEAD method.

    The GET / includes the following links.

    Relation Method Description
    self GET Returns function information for a given QKB, context, and locale.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}
    Type: application/vnd.sas.data.quality.function
    up GET Returns a list of functions in a particular QKB and locale.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.function
    definitions GET Returns a list of definitions in a function.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.definition
    Definitions

    Collection endpoint path: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions

    Returns a list of definitions in a particular function.

    The Definitions collection response includes the usual set of pagination and up-links.

    Individual endpoint path: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}

    Returns definition information for a given context, QKB, locale, and function. In addition to GET, this path also supports HEAD method.

    The GET / includes the following links.

    Relation Method Description
    self GET Returns definition information for a given context, QKB, locale, and function.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}
    Type: application/vnd.sas.data.quality.definition
    up GET Returns a list of definitions in a particular function.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.definition
    tokens GET Returns a list of tokens in a definition.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.token
    Tokens

    Collection endpoint path: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens

    Returns a list of tokens in a particular definition.

    The tokens collection response includes the usual set of pagination and up-links.

    Individual endpoint path: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}

    Retrieves a token from a given QKB, locale, and definition. In addition to GET, this path also supports the HEAD method.

    The GET / includes the following links.

    Relation Method Description
    self GET Retrieves a token from a given QKB, locale, and definition.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}
    Type: application/vnd.sas.data.quality.token
    up GET Returns a list of tokens in a particular definition.
    URI: /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens
    Type: application/vnd.sas.collection
    Item Type: application/vnd.sas.data.quality.token

    Data Sources

    Base URLs:

    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.

    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

    This API uses the standard error response type, application/vnd.sas.error, to handle propagating all error messages and codes to the consumer.

    The range of error codes assigned to the Data Sources microservice REST API is:

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

    HTTP Status Code Error Code Description
    400 11901 The sortBy query parameter is not supported by this provider on this endpoint.
    400 11902 The filter query parameter is not supported by this provider on this endpoint.
    404 11900 The provider was not found.
    501 11903 The provider service does not support this action.
    501 11904 The provider does not support source definitions.

    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 https://www.example.com/dataSources/providers \
      -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('https://www.example.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('https://www.example.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", "https://www.example.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

    200 Response

    {
      "name": "providers",
      "accept": "application/vnd.sas.data.provider.summary application/vnd.sas.data.provider",
      "start": 0,
      "count": 1,
      "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
        }
      ],
      "limit": 10,
      "version": 2,
      "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"
        }
      ]
    }
    
    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.
    error2

    Gets the provider

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataSources/providers/{providerId} \
      -H 'Accept: application/vnd.sas.data.provider+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.provider+json'
    };
    
    fetch('https://www.example.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('https://www.example.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", "https://www.example.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

    200 Response

    {
      "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"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. provider
    404 Not Found No provider exists at the requested path. error2

    Sources

    Contains operations for data sources resource.

    Get a list of data sources

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataSources/providers/{providerId}/sources \
      -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('https://www.example.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('https://www.example.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", "https://www.example.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

    200 Response

    {
      "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,
      "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/children",
              "uri": "/dataSources/providers/cas/sources/cas/children",
              "type": "application/vnd.sas.collection",
              "itemType": "application/vnd.sas.data.source"
            }
          ]
        }
      ],
      "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.
    error2
    404 Not Found No provider exists at the requested path. error2
    501 Not Implemented One of the following query parameters is not supported by the provider service (parameter - errorCode):
    • sortBy - 11901
    • filter - 11902
    error2

    Get a data source

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId} \
      -H 'Accept: application/vnd.sas.data.source+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.source+json'
    };
    
    fetch('https://www.example.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('https://www.example.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", "https://www.example.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.
    Detailed descriptions

    sessionId: 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: 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

    200 Response

    {
      "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/children",
          "uri": "/dataSources/providers/cas/sources/cas/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        }
      ]
    }
    
    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. error2

    Get a list of child data sources

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/children \
      -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('https://www.example.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('https://www.example.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", "https://www.example.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.

    sessionId: 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: 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.

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

    Example responses

    200 Response

    {
      "links": [
        {
          "method": "GET",
          "rel": "collection",
          "href": "/dataSources/providers/cas/sources/cas/children",
          "uri": "/dataSources/providers/cas/sources/cas/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas/children?start=0&limit=10",
          "uri": "/dataSources/providers/cas/sources/cas/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",
      "items": [
        {
          "id": "CASTestTmp",
          "name": "CASTestTmp",
          "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~fs~CASTestTmp",
              "uri": "/dataSources/providers/cas/sources/cas~fs~CASTestTmp",
              "type": "application/vnd.sas.data.source"
            },
            {
              "method": "GET",
              "rel": "alternate",
              "href": "/dataSources/providers/cas/sources/cas~fs~CASTestTmp",
              "uri": "/dataSources/providers/cas/sources/cas~fs~CASTestTmp",
              "type": "application/vnd.sas.data.source.summary"
            },
            {
              "method": "GET",
              "rel": "up",
              "href": "/dataSources/providers/cas/sources/cas/children",
              "uri": "/dataSources/providers/cas/sources/cas/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~CASTestTmp/tables",
              "uri": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/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/children",
              "uri": "/dataSources/providers/cas/sources/cas/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/children",
              "uri": "/dataSources/providers/cas/sources/cas/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/children",
              "uri": "/dataSources/providers/cas/sources/cas/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"
            }
          ]
        }
      ],
      "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. error2
    404 Not Found No provider or data source exists at the requested path. error2
    501 Not Implemented One of the following query parameters is not supported (parameter - errorCode):
    • sortBy - 11901
    • filter - 11902
    error2

    Source Definitions

    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 https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions \
      -H 'Accept: application/vnd.sas.collection+json' \
      -H 'Accept-Item: application/vnd.sas.data.source.definition+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.collection+json',
      'Accept-Item':'application/vnd.sas.data.source.definition+json'
    };
    
    fetch('https://www.example.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',
      'Accept-Item': 'application/vnd.sas.data.source.definition+json'
    }
    
    r = requests.get('https://www.example.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"},
            "Accept-Item": []string{"application/vnd.sas.data.source.definition+json"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("GET", "https://www.example.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.
    Accept-Item header string false The desired data source definition representation. The Accept-Item options are:
    • application/vnd.sas.data.source.definition+json
    • application/vnd.sas.summary+json

    If the application/vnd.sas.data.source.definition+json type is specified or no Accept-Item header is present, the data source definitions are returned as full representation data source definition objects.
    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

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


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

    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.

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

    Example responses

    200 Response

    {
      "links": [
        {
          "method": "GET",
          "rel": "collection",
          "href": "/dataSources/providers/myProvider/sourceDefinitions",
          "uri": "/dataSources/providers/myProvider/sourceDefinitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/myProvider/sourceDefinitions?sortBy=name:ascending&start=0&limit=10",
          "uri": "/dataSources/providers/myProvider/sourceDefinitions?sortBy=name:ascending&start=0&limit=10",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/myProvider",
          "uri": "/dataSources/providers/myProvider",
          "type": "application/vnd.sas.data.provider"
        },
        {
          "method": "POST",
          "rel": "createSourceDefinition",
          "href": "/dataSources/providers/myProvider/sourceDefinitions",
          "uri": "/dataSources/providers/myProvider/sourceDefinitions",
          "type": "application/vnd.sas.data.source.definition"
        }
      ],
      "name": "sourceDefinitions",
      "accept": "application/vnd.sas.data.source.definition",
      "start": 0,
      "count": 1,
      "items": [
        {
          "creationTimeStamp": "2017-04-12T13:39:09.424Z",
          "modifiedTimeStamp": "2017-04-12T13:39:09.424Z",
          "createdBy": "bob",
          "modifiedBy": "bob",
          "id": "84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "name": "sourceDefName1",
          "providerId": "Compute",
          "description": "my",
          "dataSourceId": "myComputeContext",
          "defaultLibref": "ORAFW",
          "attributes": {
            "key1": "value1",
            "key2": "value2",
            "key3": "value3",
            "key4": "value4",
            "key5": "value5",
            "key6": "value6",
            "key7": "value7",
            "key8": "value8",
            "key9": "value9",
            "key10": "value10"
          },
          "version": 2,
          "links": [
            {
              "method": "GET",
              "rel": "self",
              "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
              "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
              "type": "application/vnd.sas.data.source.definition"
            },
            {
              "method": "PUT",
              "rel": "update",
              "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
              "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
              "type": "application/vnd.sas.data.source.definition"
            },
            {
              "method": "DELETE",
              "rel": "delete",
              "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
              "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3"
            },
            {
              "method": "GET",
              "rel": "up",
              "href": "/dataSources/providers/Compute/sourceDefinitions",
              "uri": "/dataSources/providers/Compute/sourceDefinitions",
              "type": "application/vnd.sas.collection",
              "itemType": "application/vnd.sas.data.source.definition"
            },
            {
              "method": "GET",
              "rel": "provider",
              "href": "/dataSources/providers/Compute",
              "uri": "/dataSources/providers/Compute",
              "type": "application/vnd.sas.data.provider"
            }
          ]
        }
      ],
      "limit": 10,
      "version": 2
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. Any data source definitions are returned in a resource collection. sourceDefinitionCollection
    400 Bad Request The request was invalid. Invalid requests occur in the following scenarios:
    • A negative start value is provided.
    • A negative limit value is provided.
    • An unsupported field is specified in the sortBy parameter.
    error2
    404 Not Found No provider exists at the requested path. error2

    Create a data source definition

    Code samples

    # You can also use wget
    curl -X POST https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions \
      -H 'Content-Type: application/vnd.sas.data.source.definition+json' \
      -H 'Accept: application/vnd.sas.data.source.definition+json'
    
    
    const inputBody = '{
      "providerId": "string",
      "name": "string",
      "description": "string",
      "dataSourceId": "string",
      "defaultLibref": "string",
      "attributes": {
        "property1": {},
        "property2": {}
      },
      "version": 0
    }';
    const headers = {
      'Content-Type':'application/vnd.sas.data.source.definition+json',
      'Accept':'application/vnd.sas.data.source.definition+json'
    };
    
    fetch('https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Content-Type': 'application/vnd.sas.data.source.definition+json',
      'Accept': 'application/vnd.sas.data.source.definition+json'
    }
    
    r = requests.post('https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions', headers = headers)
    
    print(r.json())
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Content-Type": []string{"application/vnd.sas.data.source.definition+json"},
            "Accept": []string{"application/vnd.sas.data.source.definition+json"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("POST", "https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions", data)
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        // ...
    }
    

    POST /providers/{providerId}/sourceDefinitions

    Creates a date source definition from the provided request.

    Body parameter

    {
      "providerId": "string",
      "name": "string",
      "description": "string",
      "dataSourceId": "string",
      "defaultLibref": "string",
      "attributes": {
        "property1": {},
        "property2": {}
      },
      "version": 0
    }
    
    Parameters
    Name In Type Required Description
    providerId path string true The ID for the provider.
    body body createSourceDefinition true Source definition to create. The only fields validated are name, label, domain, and description. Other fields are not validated. The attributes are not required for the source definition but they are needed to actually use the source definition to access tables
    Detailed descriptions

    body: Source definition to create. The only fields validated are name, label, domain, and description. Other fields are not validated. The attributes are not required for the source definition but they are needed to actually use the source definition to access tables

    Example responses

    201 Response

    {
      "creationTimeStamp": "2017-04-12T13:29:14.212Z",
      "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
      "createdBy": "bob",
      "modifiedBy": "bob",
      "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
      "name": "sourceDefName1",
      "providerId": "Compute",
      "description": "my description",
      "dataSourceId": "myComputeContext",
      "defaultLibref": "ORAFW",
      "attributes": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3",
        "key4": "value4",
        "key5": "value5",
        "key6": "value6",
        "key7": "value7",
        "key8": "value8",
        "key9": "value9",
        "key10": "value10"
      },
      "version": 2,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "PUT",
          "rel": "update",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "DELETE",
          "rel": "delete",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/Compute/sourceDefinitions",
          "uri": "/dataSources/providers/Compute/sourceDefinitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataSources/providers/Compute",
          "uri": "/dataSources/providers/Compute",
          "type": "application/vnd.sas.data.provider"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    201 Created A source definition was created. sourceDefinition
    400 Bad Request The request was invalid. error2
    404 Not Found No provider exists at the requested path. error2
    Response Headers
    Status Header Type Format Description
    201 Location string The URI of the newly created source definition.
    201 Last-Modified string The ISO8601 date string representing the timestamp of the last update to this object.
    201 ETag string A tag that identifies this revision of this object.

    Get a data source definition

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId} \
      -H 'Accept: application/vnd.sas.data.source.definition+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.source.definition+json'
    };
    
    fetch('https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/vnd.sas.data.source.definition+json'
    }
    
    r = requests.get('https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}', headers = headers)
    
    print(r.json())
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/vnd.sas.data.source.definition+json"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("GET", "https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}", data)
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        // ...
    }
    

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

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

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

    Example responses

    200 Response

    {
      "creationTimeStamp": "2017-04-12T13:29:14.212Z",
      "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
      "createdBy": "bob",
      "modifiedBy": "bob",
      "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
      "name": "sourceDefName1",
      "providerId": "Compute",
      "description": "my description",
      "dataSourceId": "myComputeContext",
      "defaultLibref": "ORAFW",
      "attributes": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3",
        "key4": "value4",
        "key5": "value5",
        "key6": "value6",
        "key7": "value7",
        "key8": "value8",
        "key9": "value9",
        "key10": "value10"
      },
      "version": 2,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "PUT",
          "rel": "update",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "DELETE",
          "rel": "delete",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/Compute/sourceDefinitions",
          "uri": "/dataSources/providers/Compute/sourceDefinitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataSources/providers/Compute",
          "uri": "/dataSources/providers/Compute",
          "type": "application/vnd.sas.data.provider"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. sourceDefinition
    404 Not Found No provider or data source definition exists at the requested path. error2
    Response Headers
    Status Header Type Format Description
    200 ETag string The entity tag for the source definition.
    200 Last-Modified string The time stamp in EEE, dd MMM yyyy HH:mm:ss GMT format when the source definition was last modified.

    Update a data source definition

    Code samples

    # You can also use wget
    curl -X PUT https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId} \
      -H 'Content-Type: application/vnd.sas.data.source.definition+json' \
      -H 'Accept: application/vnd.sas.data.source.definition+json' \
      -H 'If-Match: string'
    
    
    const inputBody = '{
      "id": "string",
      "providerId": "string",
      "name": "string",
      "description": "string",
      "dataSourceId": "string",
      "defaultLibref": "string",
      "attributes": {
        "property1": {},
        "property2": {}
      },
      "version": 0
    }';
    const headers = {
      'Content-Type':'application/vnd.sas.data.source.definition+json',
      'Accept':'application/vnd.sas.data.source.definition+json',
      'If-Match':'string'
    };
    
    fetch('https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}',
    {
      method: 'PUT',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Content-Type': 'application/vnd.sas.data.source.definition+json',
      'Accept': 'application/vnd.sas.data.source.definition+json',
      'If-Match': 'string'
    }
    
    r = requests.put('https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}', headers = headers)
    
    print(r.json())
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Content-Type": []string{"application/vnd.sas.data.source.definition+json"},
            "Accept": []string{"application/vnd.sas.data.source.definition+json"},
            "If-Match": []string{"string"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("PUT", "https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}", data)
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        // ...
    }
    

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

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

    Body parameter

    {
      "id": "string",
      "providerId": "string",
      "name": "string",
      "description": "string",
      "dataSourceId": "string",
      "defaultLibref": "string",
      "attributes": {
        "property1": {},
        "property2": {}
      },
      "version": 0
    }
    
    Parameters
    Name In Type Required Description
    providerId path string true The ID for the provider.
    sourceDefinitionId path string true The ID for the source definition.
    If-Match header string false The etag that was returned from a GET, POST, or PUT of this data source definition.
    body body updateSourceDefinition true The source definition to update.

    Example responses

    200 Response

    {
      "creationTimeStamp": "2017-04-12T13:29:14.212Z",
      "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
      "createdBy": "bob",
      "modifiedBy": "bob",
      "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
      "name": "sourceDefName1",
      "providerId": "Compute",
      "description": "my description",
      "dataSourceId": "myComputeContext",
      "defaultLibref": "ORAFW",
      "attributes": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3",
        "key4": "value4",
        "key5": "value5",
        "key6": "value6",
        "key7": "value7",
        "key8": "value8",
        "key9": "value9",
        "key10": "value10"
      },
      "version": 2,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "PUT",
          "rel": "update",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "DELETE",
          "rel": "delete",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/Compute/sourceDefinitions",
          "uri": "/dataSources/providers/Compute/sourceDefinitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataSources/providers/Compute",
          "uri": "/dataSources/providers/Compute",
          "type": "application/vnd.sas.data.provider"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. Data source definition updated successfully. sourceDefinition
    400 Bad Request The request was invalid. This occurs when the user provides an ID in the request that does not match the ID in the path of the URL. error2
    404 Not Found No data source definition exists at the requested path. error2
    412 Precondition Failed The ETag provided does not match the current version of the object or the last modified date does not match. error2
    415 Unsupported Media Type The requested media type is not supported. error2
    428 Precondition Required The ETag was not provided when updating an existing type. error2
    Response Headers
    Status Header Type Format Description
    200 Last-Modified string The ISO8601 date string representing the timestamp of the last update to this data source definition.
    200 Etag string A tag that identifies this revision of this object.

    Delete a data source definition

    Code samples

    # You can also use wget
    curl -X DELETE https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId} \
      -H 'Accept: */*'
    
    
    
    const headers = {
      'Accept':'*/*'
    };
    
    fetch('https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}',
    {
      method: 'DELETE',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': '*/*'
    }
    
    r = requests.delete('https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}', headers = headers)
    
    print(r.json())
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"*/*"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("DELETE", "https://www.example.com/dataSources/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}", data)
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        // ...
    }
    

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

    Deletes the specified data source definition.

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

    Example responses

    204 Response

    Responses
    Status Meaning Description Schema
    204 No Content The data source definition was deleted. error2
    404 Not Found No provider or data source definition exists at the requested path. error2

    Sessions

    Contains operations to access data sources using the sessions resource.

    Get a session

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId} \
      -H 'Accept: application/vnd.sas.data.session+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.session+json'
    };
    
    fetch('https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/vnd.sas.data.session+json'
    }
    
    r = requests.get('https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}', headers = headers)
    
    print(r.json())
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/vnd.sas.data.session+json"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("GET", "https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}", data)
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        // ...
    }
    

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

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

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

    Example responses

    200 Response

    {
      "version": 1,
      "id": "d75b412f-6004-4a03-9e6a-f447fdfc1eff",
      "providerId": "cas",
      "owner": "bob",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
          "uri": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
          "type": "application/vnd.sas.data.session"
        },
        {
          "method": "DELETE",
          "rel": "delete",
          "href": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
          "uri": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataSources/providers/cas",
          "uri": "/dataSources/providers/cas",
          "type": "application/vnd.sas.data.provider"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. session
    404 Not Found No provider, data source, or session exists at the requested path. error2

    Terminate a session

    Code samples

    # You can also use wget
    curl -X DELETE https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId} \
      -H 'Accept: */*'
    
    
    
    const headers = {
      'Accept':'*/*'
    };
    
    fetch('https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}',
    {
      method: 'DELETE',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': '*/*'
    }
    
    r = requests.delete('https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}', headers = headers)
    
    print(r.json())
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"*/*"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("DELETE", "https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/sessions/{sessionId}", data)
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        // ...
    }
    

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

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

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

    Example responses

    404 Response

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

    Root

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

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataSources/ \
      -H 'Accept: application/vnd.sas.api+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.api+json'
    };
    
    fetch('https://www.example.com/dataSources/',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/vnd.sas.api+json'
    }
    
    r = requests.get('https://www.example.com/dataSources/', headers = headers)
    
    print(r.json())
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/vnd.sas.api+json"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("GET", "https://www.example.com/dataSources/", data)
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        // ...
    }
    

    GET /

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

    Example responses

    200 Response

    {
      "version": 1,
      "links": [
        {
          "method": "string",
          "rel": "string",
          "uri": "string",
          "href": "string",
          "title": "string",
          "type": "string",
          "itemType": "string",
          "responseType": "string",
          "responseItemType": "string"
        }
      ]
    }
    
    Status Meaning Description Schema
    200 OK The request succeeded. Inline

    Status Code 200

    API

    Name Type Required Restrictions Description
    » version integer true none The version number of the API representation. This is version 1.
    » links [link] true none The API's top-level links.
    »» Link object false none A link to a related operation or resource.
    »»» method string false none The HTTP method for the link.
    »»» rel string true none The relationship of the link to the resource.
    »»» uri string false none The relative URI for the link.
    »»» href string false none The URL for the link.
    »»» title string false none The title for the link.
    »»» type string false none The media type or link type for the link.
    »»» itemType string false none If this is a link to a container, itemType is the media type or link type for the items in the container.
    »»» responseType string false none The media type or link type of the response body for a PUT, POST, or PATCH operation.
    »»» responseItemType string false none The media type or link type of the items in the response body for a PUT, POST, or PATCH operation.

    Check service availability

    Code samples

    # You can also use wget
    curl -X HEAD https://www.example.com/dataSources/ \
      -H 'Accept: application/vnd.sas.api+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.api+json'
    };
    
    fetch('https://www.example.com/dataSources/',
    {
      method: 'HEAD',
    
      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.head('https://www.example.com/dataSources/', headers = headers)
    
    print(r.json())
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/vnd.sas.api+json"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("HEAD", "https://www.example.com/dataSources/", data)
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        // ...
    }
    

    HEAD /

    Returns the headers so that clients can determine whether the service is running.

    Example responses

    200 Response

    ""
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. The service is running and available. emptyResponse

    Engines

    Contains operations for engines of the Data Sources API.

    Get a list of engines for a data source

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines \
      -H 'Accept: application/vnd.sas.collection+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.collection+json'
    };
    
    fetch('https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/vnd.sas.collection+json'
    }
    
    r = requests.get('https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines', headers = headers)
    
    print(r.json())
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/vnd.sas.collection+json"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("GET", "https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines", data)
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        // ...
    }
    

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

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

    Parameters
    Name In Type Required Description
    providerId path string true The ID for the provider.
    sourceId path string true The ID for the source.
    start query integer false The starting index of the first engine in a page. Defaults to 0.
    limit query integer false Maximum number of engines to return in this page of results. The actual number of returned engines might be less if the collection has been exhausted. Defaults to 10.
    filter query string(filter-criteria) false Filter criteria for returned engines.
    The valid filter fields are name, label, description, and licensed. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith and isNull. Sample queries include the following:
    • Search by name starting with: /dataSources/providers/{providerId}/sources/{sourceId}/engines?filter=startsWith(name, 'SASI')
    • Search by name: /dataSources/providers/{providerId}/sources/{sourceId}/engines?filter=eq(name, 'SASIONZA')
    • Search for multiple engines: /dataSources/providers/{providerId}/sources/{sourceId}/engines?filter=in(name, 'SASIONZA', 'SASORA')
    sortBy query string(sort-criteria) false Sort returned sources. The sort criteria supports the following fields in either ascending or descending order: name, label, description, and licensed. Sample sorts include the following:
    • Sort ascending by engine name: /dataSources/providers/{providerId}/sources/{sourceId}/engines?sortBy=name:ascending
    • Sort descending by engine name: /dataSources/providers/{providerId}/sources/{sourceId}/engines?sortBy=name:descending

    The default sort is by name in ascending order.
    sessionId query string false The unique identifier of the session used to access the data service provider's backing service. When this identifier is not specified, the data service provider creates a temporary session and then destroys it after the request is complete. If this is specified, all returned links, except the \"self\" link, have the sessionId query parameter added to their respective URIs. They also contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.
    preserveSession query boolean false This only has effect when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided and the session created by the data service provider is not destroyed. All returned links, except the \"self\" link, have the sessionId query parameter added to their respective URIs. They also contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is destroyed after the request is complete. Defaults to false.
    Detailed descriptions

    filter: Filter criteria for returned engines.
    The valid filter fields are name, label, description, and licensed. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith and isNull. Sample queries include the following:

    sortBy: Sort returned sources. The sort criteria supports the following fields in either ascending or descending order: name, label, description, and licensed. Sample sorts include the following:


    The default sort is by name in ascending order.

    sessionId: The unique identifier of the session used to access the data service provider's backing service. When this identifier is not specified, the data service provider creates a temporary session and then destroys it after the request is complete. If this is specified, all returned links, except the \"self\" link, have the sessionId query parameter added to their respective URIs. They also contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.

    preserveSession: This only has effect when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided and the session created by the data service provider is not destroyed. All returned links, except the \"self\" link, have the sessionId query parameter added to their respective URIs. They also contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is destroyed after the request is complete. Defaults to false.

    Example responses

    200 Response

    {
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines?start=0&limit=10",
          "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines?start=0&limit=10",
          "type": "application/vnd.sas.collection"
        },
        {
          "method": "GET",
          "rel": "collection",
          "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
          "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
          "type": "application/vnd.sas.collection"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/",
          "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/",
          "type": "application/vnd.sas.data.source"
        }
      ],
      "name": "engines",
      "accept": "application/vnd.sas.data.engine",
      "start": 0,
      "limit": 10,
      "count": 1,
      "items": [
        {
          "name": "sasionza",
          "label": "NETEZZA",
          "description": "SAS/ACCESS to Netezza",
          "providerId": "compute",
          "licensed": true,
          "links": [
            {
              "method": "GET",
              "rel": "self",
              "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
              "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
              "type": "application/vnd.sas.data.engine"
            },
            {
              "method": "GET",
              "rel": "up",
              "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
              "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
              "type": "application/vnd.sas.collection",
              "itemType": "application/vnd.sas.data.engine"
            },
            {
              "method": "GET",
              "rel": "provider",
              "href": "/dataSources/providers/Compute",
              "uri": "/dataSources/providers/Compute",
              "type": "application/vnd.sas.data.provider"
            },
            {
              "method": "GET",
              "rel": "dataSource",
              "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
              "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
              "type": "application/vnd.sas.data.source"
            },
            {
              "method": "GET",
              "rel": "definition",
              "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
              "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
              "type": "application/schema"
            }
          ],
          "version": 1
        }
      ],
      "version": 2
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. engineCollection
    400 Bad Request The request was invalid. An invalid filter or combination of request parameters was provided. error2
    404 Not Found No provider or data source exists at the requested path. error2
    501 Not Implemented One of the following query parameters is not supported (parameter - errorCode):
    • sortBy - 11901
    • filter - 11902
    error2

    Get an engine name

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName} \
      -H 'Accept: application/vnd.sas.data.engine+json'
    
    
    
    const headers = {
      'Accept':'application/vnd.sas.data.engine+json'
    };
    
    fetch('https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/vnd.sas.data.engine+json'
    }
    
    r = requests.get('https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}', headers = headers)
    
    print(r.json())
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/vnd.sas.data.engine+json"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("GET", "https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}", data)
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        // ...
    }
    

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

    Returns information about a single engine based on its unique name.

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

    sessionId: 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: This only has effect when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided and the session created by the data service provider is not destroyed. All returned links, except the \"self\" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is destroyed after the request is complete. Defaults to false.

    Example responses

    200 Response

    {
      "version": 1,
      "id": "d75b412f-6004-4a03-9e6a-f447fdfc1eff",
      "providerId": "cas",
      "owner": "bob",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
          "uri": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
          "type": "application/vnd.sas.data.session"
        },
        {
          "method": "DELETE",
          "rel": "delete",
          "href": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff",
          "uri": "/dataSources/providers/cas/sources/casServer/sessions/d75b412f-6004-4a03-9e6a-f447fdfc1eff"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataSources/providers/cas",
          "uri": "/dataSources/providers/cas",
          "type": "application/vnd.sas.data.provider"
        }
      ]
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. session
    404 Not Found No provider, data source, or engine exists at the requested path. error2

    Get an engine definition

    Code samples

    # You can also use wget
    curl -X GET https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}/definition \
      -H 'Accept: application/schema+json'
    
    
    
    const headers = {
      'Accept':'application/schema+json'
    };
    
    fetch('https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}/definition',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/schema+json'
    }
    
    r = requests.get('https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}/definition', headers = headers)
    
    print(r.json())
    
    package main
    
    import (
           "bytes"
           "net/http"
    )
    
    func main() {
    
        headers := map[string][]string{
            "Accept": []string{"application/schema+json"},
        }
    
        data := bytes.NewBuffer([]byte{jsonReq})
        req, err := http.NewRequest("GET", "https://www.example.com/dataSources/providers/{providerId}/sources/{sourceId}/engines/{engineName}/definition", data)
        req.Header = headers
    
        client := &http.Client{}
        resp, err := client.Do(req)
        // ...
    }
    

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

    Returns the definition of the engine as application or schema+json. This definition includes all available engine options.

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

    sessionId: 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: This only has effect when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided and the session created by the data service provider is not destroyed. All returned links, except the \"self\" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false or not specified, the session is destroyed after the request is complete. Defaults to false.

    Example responses

    200 Response

    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "SASE7",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "engineName"
      ],
      "properties": {
        "engineName": {
          "label": "V9",
          "type": "string",
          "default": "SASE7",
          "enum": [
            "SASE7"
          ]
        }
      }
    }
    
    Responses
    Status Meaning Description Schema
    200 OK The request succeeded. engineDefinition
    404 Not Found No provider, data source, or engine exists at the requested path. error2

    Schemas

    emptyResponse

    ""
    
    

    Empty Response

    Properties
    Name Type Required Restrictions Description
    Empty Response string false none A response with an empty body

    provider

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

    Provider

    Properties
    Name Type Required Restrictions Description
    id string false none The unique provider identifier.
    version integer false none The provider schema version.
    apiVersion integer false none The provider API version.
    usesSessions boolean false none If this value is true, this provider supports sessions. If false, sessions are
    not supported.
    sourceDefinitionsSupport string false none Indicates to the dataSources service how it should handle source definition persistence for this provider. The possible values are none (no support) and providedByDataSources (data sources service stores source definitions for the provider).
    attributes object false none Additional provider-specific attributes.
    » additionalProperties any false none none
    links [any] false none Links that apply to this resource.
    » Link object false none A link to a related operation or resource.
    »» method string false none The HTTP method for the link.
    »» rel string true none The relationship of the link to the resource.
    »» uri string false none The relative URI for the link.
    »» href string false none The URL for the link.
    »» title string false none The title for the link.
    »» type string false none The media type or link type for the link.
    »» itemType string false none If this is a link to a container, itemType is the media type or link type for the items in the container.
    »» responseType string false none The media type or link type of the response body for a PUT, POST, or PATCH operation.
    »» responseItemType string false none The media type or link type of the items in the response body for a PUT, POST, or PATCH operation.

    providerSummary

    {
      "id": "cas",
      "version": 1,
      "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"
        }
      ]
    }
    
    

    Provider Summary

    Properties
    Name Type Required Restrictions Description
    id string false none The unique provider identifier.
    version integer false none The provider schema version.
    links [link] false none Links that apply to this resource.

    providerSummaryCollection

    {
      "name": "providers",
      "accept": "application/vnd.sas.data.provider.summary application/vnd.sas.data.provider",
      "start": 0,
      "count": 1,
      "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
        }
      ],
      "limit": 10,
      "version": 2,
      "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"
        }
      ]
    }
    
    

    Provider Summary Collection

    Properties

    allOf

    Name Type Required Restrictions Description
    anonymous object false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)
    » name string false none The name of the collection.
    » start integer(int64) false none The zero-based index of the first item in the collection.
    » limit integer false none The number of items that were requested for the collection.
    » count integer(int64) false none If populated indicates the number of items in the collection.
    » accept string false none A space-delimited list of media types from which an Accept header may be constructed.
    » links [link] false none The links that apply to the collection.
    » version integer false none The version number of the collection representation. This representation is version 2.

    and

    Name Type Required Restrictions Description
    anonymous object false none none
    » items [providerSummary] true none The array that contains provider summary resources.

    source

    {
      "id": "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/children",
          "uri": "/dataSources/providers/cas/sources/cas/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        }
      ]
    }
    
    

    Data Source

    Properties
    Name Type Required Restrictions Description
    id string false none The unique data source identifier.
    providerId string false none The source provider identifier.
    name string false none The non-unique name of the data source.
    description string false none A brief description of the source.
    hasTables boolean false none If this value is true, this source is a table container. If this value
    is false, this source is not a table container.
    hasEngines string false none If this value is true, this source, this source has engines available for it.
    If this value is false, this source does not have engines available for it.
    createdBy string false none The user who created this source.
    modifiedBy string false none The last user to modify this source.
    creationTimeStamp string(date-time) false none The timestamp for the source creation.
    modifiedTimeStamp string(date-time) false none The timestamp for the last source modification.
    attributes object false none The attributes for this source.
    » additionalProperties object false none none
    version integer false none The source schema version.
    links [link] false none The paging links that apply to this object.

    sourceCollection

    {
      "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,
      "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/children",
              "uri": "/dataSources/providers/cas/sources/cas/children",
              "type": "application/vnd.sas.collection",
              "itemType": "application/vnd.sas.data.source"
            }
          ]
        }
      ],
      "version": 2
    }
    
    

    Data Source Collection

    Properties

    allOf

    Name Type Required Restrictions Description
    anonymous providerSummaryCollection false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

    and

    Name Type Required Restrictions Description
    anonymous object false none none
    » items [source] true none The array that contains data source resources.

    sourceChildrenCollection

    {
      "links": [
        {
          "method": "GET",
          "rel": "collection",
          "href": "/dataSources/providers/cas/sources/cas/children",
          "uri": "/dataSources/providers/cas/sources/cas/children",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source"
        },
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/cas/sources/cas/children?start=0&limit=10",
          "uri": "/dataSources/providers/cas/sources/cas/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",
      "items": [
        {
          "id": "CASTestTmp",
          "name": "CASTestTmp",
          "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~fs~CASTestTmp",
              "uri": "/dataSources/providers/cas/sources/cas~fs~CASTestTmp",
              "type": "application/vnd.sas.data.source"
            },
            {
              "method": "GET",
              "rel": "alternate",
              "href": "/dataSources/providers/cas/sources/cas~fs~CASTestTmp",
              "uri": "/dataSources/providers/cas/sources/cas~fs~CASTestTmp",
              "type": "application/vnd.sas.data.source.summary"
            },
            {
              "method": "GET",
              "rel": "up",
              "href": "/dataSources/providers/cas/sources/cas/children",
              "uri": "/dataSources/providers/cas/sources/cas/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~CASTestTmp/tables",
              "uri": "/dataTables/dataSources/cas~fs~cas~fs~CASTestTmp/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/children",
              "uri": "/dataSources/providers/cas/sources/cas/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/children",
              "uri": "/dataSources/providers/cas/sources/cas/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/children",
              "uri": "/dataSources/providers/cas/sources/cas/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"
            }
          ]
        }
      ],
      "version": 2
    }
    
    

    Data Source Children Collection

    Properties

    allOf

    Name Type Required Restrictions Description
    anonymous providerSummaryCollection false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

    and

    Name Type Required Restrictions Description
    anonymous object false none none
    » items [source] true none The array that contains data source resources.

    engineCollection

    {
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines?start=0&limit=10",
          "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines?start=0&limit=10",
          "type": "application/vnd.sas.collection"
        },
        {
          "method": "GET",
          "rel": "collection",
          "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
          "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
          "type": "application/vnd.sas.collection"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/",
          "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/",
          "type": "application/vnd.sas.data.source"
        }
      ],
      "name": "engines",
      "accept": "application/vnd.sas.data.engine",
      "start": 0,
      "limit": 10,
      "count": 1,
      "items": [
        {
          "name": "sasionza",
          "label": "NETEZZA",
          "description": "SAS/ACCESS to Netezza",
          "providerId": "compute",
          "licensed": true,
          "links": [
            {
              "method": "GET",
              "rel": "self",
              "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
              "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",
              "type": "application/vnd.sas.data.engine"
            },
            {
              "method": "GET",
              "rel": "up",
              "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
              "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",
              "type": "application/vnd.sas.collection",
              "itemType": "application/vnd.sas.data.engine"
            },
            {
              "method": "GET",
              "rel": "provider",
              "href": "/dataSources/providers/Compute",
              "uri": "/dataSources/providers/Compute",
              "type": "application/vnd.sas.data.provider"
            },
            {
              "method": "GET",
              "rel": "dataSource",
              "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
              "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",
              "type": "application/vnd.sas.data.source"
            },
            {
              "method": "GET",
              "rel": "definition",
              "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
              "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",
              "type": "application/schema"
            }
          ],
          "version": 1
        }
      ],
      "version": 2
    }
    
    

    Engine Collection

    Properties

    allOf

    Name Type Required Restrictions Description
    anonymous providerSummaryCollection false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

    and

    Name Type Required Restrictions Description
    anonymous object false none none
    » items [engine] true none The array that contains engine resources.

    sourceDefinition

    {
      "creationTimeStamp": "2017-04-12T13:29:14.212Z",
      "modifiedTimeStamp": "2017-04-12T13:29:14.212Z",
      "createdBy": "bob",
      "modifiedBy": "bob",
      "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
      "name": "sourceDefName1",
      "providerId": "Compute",
      "description": "my description",
      "dataSourceId": "myComputeContext",
      "defaultLibref": "ORAFW",
      "attributes": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3",
        "key4": "value4",
        "key5": "value5",
        "key6": "value6",
        "key7": "value7",
        "key8": "value8",
        "key9": "value9",
        "key10": "value10"
      },
      "version": 2,
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "PUT",
          "rel": "update",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "type": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "DELETE",
          "rel": "delete",
          "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
          "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/Compute/sourceDefinitions",
          "uri": "/dataSources/providers/Compute/sourceDefinitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "GET",
          "rel": "provider",
          "href": "/dataSources/providers/Compute",
          "uri": "/dataSources/providers/Compute",
          "type": "application/vnd.sas.data.provider"
        }
      ]
    }
    
    

    Data Source Definition

    Properties
    Name Type Required Restrictions Description
    id string false none The unique data source definition identifier.
    providerId string false none The provider identifier.
    dataSourceId string false none A unique identifier of the associated data source.
    name string false none The non-unique name of the data source.
    description string false none A brief description of the data source definition.
    createdBy string false none The user who created this source definition.
    modifiedBy string false none The last user to modify this data source definition.
    creationTimeStamp string(date-time) false none The timestamp for the source definition creation.
    modifiedTimeStamp string(date-time) false none The timestamp for the last source definition modification.
    defaultLibref string false none A libref for use when LIBNAME statement is auto generated.
    attributes object false none The map of attribute names to values for this source definition. The value of each attribute may be of types: number, string, boolean, or object like a map. If an attribute does not have a value, the value should be set to null.
    » additionalProperties object false none none
    version integer false none The source definition schema version.
    links [link] false none Paging links that apply to this object.

    updateSourceDefinition

    {
      "id": "string",
      "providerId": "string",
      "name": "string",
      "description": "string",
      "dataSourceId": "string",
      "defaultLibref": "string",
      "attributes": {
        "property1": {},
        "property2": {}
      },
      "version": 0
    }
    
    

    Update Source Definition Request

    Properties
    Name Type Required Restrictions Description
    id string false none The unique data source definition identifier.
    providerId string false none The provider identifier.
    name string false none The non-unique name for the data source definition.
    description string false none A brief description for the data source definition.
    dataSourceId string false none The unique identifier for the associated data source.
    defaultLibref string false none A libref for use when LIBNAME statement is auto generated.
    attributes object false none The map of attribute names to values for this source definition. The value of each attribute may be of types: number, string, boolean, or object like a map. If an attribute does not have a value, the value should be set to null.
    » additionalProperties object false none none
    version integer false none The source definition schema version.

    createSourceDefinition

    {
      "providerId": "string",
      "name": "string",
      "description": "string",
      "dataSourceId": "string",
      "defaultLibref": "string",
      "attributes": {
        "property1": {},
        "property2": {}
      },
      "version": 0
    }
    
    

    Create Data Source Definition Request

    Properties
    Name Type Required Restrictions Description
    providerId string false none The provider identifier.
    name string false none The non-unique name for the data source definition.
    description string false none A brief description of the data source definition.
    dataSourceId string false none The unique identifier for the associated data source.
    defaultLibref string false none A libref for use when LIBNAME statement is auto generated.
    attributes object false none The map of attribute names to values for this source definition. The value of each attribute may be of types: number, string, boolean, or object like a map. If an attribute does not have a value, the value should be set to null.
    » additionalProperties object false none none
    version integer false none The source definition schema version.

    sourceDefinitionCollection

    {
      "links": [
        {
          "method": "GET",
          "rel": "collection",
          "href": "/dataSources/providers/myProvider/sourceDefinitions",
          "uri": "/dataSources/providers/myProvider/sourceDefinitions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "GET",
          "rel": "self",
          "href": "/dataSources/providers/myProvider/sourceDefinitions?sortBy=name:ascending&start=0&limit=10",
          "uri": "/dataSources/providers/myProvider/sourceDefinitions?sortBy=name:ascending&start=0&limit=10",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.data.source.definition"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/dataSources/providers/myProvider",
          "uri": "/dataSources/providers/myProvider",
          "type": "application/vnd.sas.data.provider"
        },
        {
          "method": "POST",
          "rel": "createSourceDefinition",
          "href": "/dataSources/providers/myProvider/sourceDefinitions",
          "uri": "/dataSources/providers/myProvider/sourceDefinitions",
          "type": "application/vnd.sas.data.source.definition"
        }
      ],
      "name": "sourceDefinitions",
      "accept": "application/vnd.sas.data.source.definition",
      "start": 0,
      "count": 1,
      "items": [
        {
          "creationTimeStamp": "2017-04-12T13:39:09.424Z",
          "modifiedTimeStamp": "2017-04-12T13:39:09.424Z",
          "createdBy": "bob",
          "modifiedBy": "bob",
          "id": "84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
          "name": "sourceDefName1",
          "providerId": "Compute",
          "description": "my",
          "dataSourceId": "myComputeContext",
          "defaultLibref": "ORAFW",
          "attributes": {
            "key1": "value1",
            "key2": "value2",
            "key3": "value3",
            "key4": "value4",
            "key5": "value5",
            "key6": "value6",
            "key7": "value7",
            "key8": "value8",
            "key9": "value9",
            "key10": "value10"
          },
          "version": 2,
          "links": [
            {
              "method": "GET",
              "rel": "self",
              "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
              "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
              "type": "application/vnd.sas.data.source.definition"
            },
            {
              "method": "PUT",
              "rel": "update",
              "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
              "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
              "type": "application/vnd.sas.data.source.definition"
            },
            {
              "method": "DELETE",
              "rel": "delete",
              "href": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3",
              "uri": "/dataSources/providers/Compute/sourceDefinitions/84df1ec8-8f06-46c9-bcd7-e38e3d96aef3"
            },
            {
              "method": "GET",
              "rel": "up",
              "href": "/dataSources/providers/Compute/sourceDefinitions",
              "uri": "/dataSources/providers/Compute/sourceDefinitions",
              "type": "application/vnd.sas.collection",
              "itemType": "application/vnd.sas.data.source.definition"
            },
            {
              "method": "GET",
              "rel": "provider",
              "href": "/dataSources/providers/Compute",
              "uri": "/dataSources/providers/Compute",
              "type": "application/vnd.sas.data.provider"
            }
          ]
        }
      ],
      "limit": 10,
      "version": 2
    }
    
    

    Data Source Definition Collection

    Properties

    allOf

    Name Type Required Restrictions Description
    anonymous providerSummaryCollection false none This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

    and

    Name Type Required Restrictions Description
    anonymous object false none none
    » items [sourceDefinition] true none The array that contains source definition resources.

    session

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