Get a list of engines for a data source
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.
1{2 "name": "engines",3 "accept": "application/vnd.sas.data.engine",4 "start": 0,5 "limit": 10,6 "count": 1,7 "version": 2,8 "items": [9 {10 "name": "sasionza",11 "label": "NETEZZA",12 "description": "SAS/ACCESS to Netezza",13 "providerId": "compute",14 "licensed": true,15 "version": 1,16 "links": [17 {18 "method": "GET",19 "rel": "self",20 "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",21 "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza",22 "type": "application/vnd.sas.data.engine"23 },24 {25 "method": "GET",26 "rel": "up",27 "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",28 "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",29 "type": "application/vnd.sas.collection",30 "itemType": "application/vnd.sas.data.engine"31 },32 {33 "method": "GET",34 "rel": "provider",35 "href": "/dataSources/providers/Compute",36 "uri": "/dataSources/providers/Compute",37 "type": "application/vnd.sas.data.provider"38 },39 {40 "method": "GET",41 "rel": "dataSource",42 "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",43 "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",44 "type": "application/vnd.sas.data.source"45 },46 {47 "method": "GET",48 "rel": "definition",49 "href": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",50 "uri": "/dataSources/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines/sasionza/definition",51 "type": "application/schema"52 }53 ]54 }55 ],56 "links": [57 {58 "method": "GET",59 "rel": "self",60 "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines?start=0&limit=10",61 "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines?start=0&limit=10",62 "type": "application/vnd.sas.collection"63 },64 {65 "method": "GET",66 "rel": "collection",67 "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",68 "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af/engines",69 "type": "application/vnd.sas.collection"70 },71 {72 "method": "GET",73 "rel": "up",74 "href": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",75 "uri": "/providers/Compute/sources/940c9a86-05be-4099-b694-e2bca22d92af",76 "type": "application/vnd.sas.data.source"77 }78 ]79}
| Name | Type | Required | Description |
|---|---|---|---|
providerId | string | true | The ID for the provider. |
sourceId | string | true | The ID for the source. |
| Name | Type | Required | Description |
|---|---|---|---|
filter | 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') |
limit | 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. |
preserveSession | 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. |
sessionId | 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. |
sortBy | 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. |
start | integer | false | The starting index of the first engine in a page. Defaults to 0. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | The request succeeded. | Schema | |
| 400 | Bad Request | The request was invalid. An invalid filter or combination of request parameters was provided. | Schema | |
| 404 | Not Found | No provider or data source exists at the requested path. | Schema |