Get a list of CAS servers
Returns a collection of CAS servers. Supports SAS standard paging query parameters, sorting, and filtering. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.server+json.
1{2 "links": [3 {4 "method": "GET",5 "rel": "up",6 "href": "/casManagement/",7 "uri": "/casManagement/",8 "type": "application/vnd.sas.api"9 },10 {11 "method": "GET",12 "rel": "self",13 "href": "/casManagement/servers?excludeItemLinks=false&start=0&limit=10",14 "uri": "/casManagement/servers?excludeItemLinks=false&start=0&limit=10",15 "type": "application/vnd.sas.collection",16 "itemType": "application/vnd.sas.cas.server"17 },18 {19 "method": "GET",20 "rel": "collection",21 "href": "/casManagement/servers",22 "uri": "/casManagement/servers",23 "type": "application/vnd.sas.collection",24 "itemType": "application/vnd.sas.cas.server"25 }26 ],27 "name": "servers",28 "accept": "application/vnd.sas.cas.server",29 "start": 0,30 "count": 1,31 "items": [32 {33 "version": 1,34 "name": "cas-shared-default",35 "description": "controller",36 "host": "myhost.example.com",37 "port": 5570,38 "restPort": 8777,39 "restProtocol": "http",40 "links": [41 {42 "method": "GET",43 "rel": "up",44 "href": "/casManagement/servers",45 "uri": "casManagement/servers",46 "type": "application/vnd.sas.collection",47 "itemType": "application/vnd.sas.cas.server"48 },49 {50 "method": "GET",51 "rel": "self",52 "href": "/casManagement/servers/cas-shared-default",53 "uri": "/casManagement/servers/cas-shared-default",54 "type": "application/vnd.sas.cas.server"55 },56 {57 "method": "GET",58 "rel": "connection",59 "href": "/casManagement/servers/cas-shared-default/connection",60 "uri": "/casManagement/servers/cas-shared-default/connection",61 "type": "application/vnd.sas.cas.server.connection"62 },63 {64 "method": "GET",65 "rel": "state",66 "href": "/casManagement/servers/cas-shared-default/state",67 "uri": "/casManagement/servers/cas-shared-default/state",68 "type": "text/plain"69 },70 {71 "method": "PUT",72 "rel": "updateState",73 "href": "/casManagement/servers/cas-shared-default/state",74 "uri": "/casManagement/servers/cas-shared-default/state",75 "type": "text/plain"76 },77 {78 "method": "GET",79 "rel": "nodes",80 "href": "/casManagement/servers/cas-shared-default/nodes",81 "uri": "/casManagement/servers/cas-shared-default/nodes",82 "type": "application/vnd.sas.collection",83 "itemType": "application/vnd.sas.cas.server.node"84 },85 {86 "method": "GET",87 "rel": "metrics",88 "href": "/casManagement/servers/cas-shared-default/metrics",89 "uri": "/casManagement/servers/cas-shared-default/metrics",90 "type": "application/vnd.sas.cas.server.metrics"91 },92 {93 "method": "GET",94 "rel": "sessions",95 "href": "/casManagement/servers/cas-shared-default/sessions",96 "uri": "/casManagement/servers/cas-shared-default/sessions",97 "type": "application/vnd.sas.collection",98 "itemType": "application/vnd.sas.cas.session.summary"99 },100 {101 "method": "POST",102 "rel": "createSession",103 "href": "/casManagement/servers/cas-shared-default/sessions",104 "uri": "/casManagement/servers/cas-shared-default/sessions",105 "type": "application/vnd.sas.cas.session",106 "responseType": "application/vnd.sas.cas.session"107 },108 {109 "method": "GET",110 "rel": "caslibs",111 "href": "/casManagement/servers/cas-shared-default/caslibs",112 "uri": "/casManagement/servers/cas-shared-default/caslibs",113 "type": "application/vnd.sas.collection",114 "itemType": "application/vnd.sas.cas.caslib"115 },116 {117 "method": "GET",118 "rel": "casProxy",119 "href": "/casProxy/servers/cas-shared-default/cas",120 "uri": "/casProxy/servers/cas-shared-default/cas",121 "type": "application/json"122 },123 {124 "method": "GET",125 "rel": "dataSource",126 "href": "/dataSources/providers/cas/sources/cas-shared-default",127 "uri": "/dataSources/providers/cas/sources/cas-shared-default",128 "type": "application/vnd.sas.data.source"129 }130 ],131 "tags": {132 "value": "appServerEnabled=True"133 }134 }135 ],136 "limit": 10,137 "version": 2138}
| Name | Type | Required | Description |
|---|---|---|---|
excludeItemLinks | boolean | false | Determines whether item links are excluded from results. Defaults to false. |
filter | string<filter-criteria> | false | Filter criteria for returned items. The valid filter fields are the first-level fields in each item. The supported functions are and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries: Search by name starting with: filter=startsWith(name, 'cas') Search by name: filter=eq(name, 'cas-shared-default') Search for multiple items: filter=in(name, 'cas-shared-default', 'cas-host-default') |
limit | integer | false | Maximum number of items to return in this page of results. The actual number of returned items can be less if the collection has been exhausted. Defaults to 10. |
sortBy | string<sort-criteria> | false | Sort returned items. The sort criteria supports the first-level fields in each item. Some sample sorts: Sort by ascending name: sortBy=name:ascending Sort by descending name: sortBy=name:descending The default sort is by name in ascending order. |
start | integer | false | The starting index of the first item in a page. Defaults to 0. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | The request succeeded. The collection of CAS servers was returned. | Schema | |
| 400 | Bad Request | The request was invalid. | Schema | |
| 404 | Not Found | The requested CAS server does not exist. |