Get Agents
get/bots
Get the agents as a summary representation. The full bot representation is maintained by a provider, and enumerating them may be prohibitively expensive. The summary representation provides a link to an individual bot that enables consumers to retrieve other representations. The properties that can be used as filter and sort criteria are:
- id,
- name,
- description,
- createdBy,
- creationTimeStamp,
- modifiedBy, and
- modifiedTimeStamp.
1{2 "version": 2,3 "accept": "application/vnd.sas.metadata.bot.summary",4 "count": 1,5 "start": 0,6 "limit": 10,7 "name": "bots",8 "items": [9 {10 "creationTimeStamp": "2021-09-17T14:46:05.376Z",11 "createdBy": "sasuser",12 "modifiedTimeStamp": "2021-09-17T14:46:33.836Z",13 "modifiedBy": "sasuser",14 "version": 1,15 "id": "ba14bc66-8aaf-4a57-bff1-87a39774ac1a",16 "name": "Crawl SASHelp (compute)",17 "description": "Crawl the SASHelp library",18 "provider": "TABLE-BOT",19 "parameters": {20 "datasourceURI": "/dataSources/providers/Compute/sources/eb654570-efb4-4d61-9814-3444869805b0~fs~SASHELP"21 },22 "links": [23 {24 "method": "GET",25 "rel": "self",26 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",27 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",28 "type": "application/vnd.sas.metadata.bot"29 },30 {31 "method": "GET",32 "rel": "alternate",33 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",34 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",35 "type": "application/vnd.sas.metadata.bot.summary"36 },37 {38 "method": "PUT",39 "rel": "update",40 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",41 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",42 "type": "application/vnd.sas.metadata.bot",43 "responseType": "application/vnd.sas.metadata.bot"44 },45 {46 "method": "DELETE",47 "rel": "delete",48 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",49 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a"50 },51 {52 "method": "GET",53 "rel": "runState",54 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state",55 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state",56 "type": "text/plain"57 },58 {59 "method": "PUT",60 "rel": "updateRunState",61 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state?value=running",62 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state?value=running",63 "type": "text/plain"64 },65 {66 "method": "GET",67 "rel": "history",68 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/history",69 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/history",70 "type": "application/vnd.sas.collection",71 "itemType": "application/vnd.sas.metadata.bot.history"72 },73 {74 "method": "PUT",75 "rel": "runPreview",76 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/preview?value=running",77 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/preview?value=running",78 "type": "application/vnd.sas.metadata.bot.preview"79 },80 {81 "method": "GET",82 "rel": "up",83 "href": "/catalog/bots",84 "uri": "/catalog/bots",85 "type": "application/vnd.sas.collection",86 "itemType": "application/vnd.sas.metadata.bot.summary"87 }88 ]89 }90 ],91 "links": [92 {93 "method": "GET",94 "rel": "self",95 "href": "/catalog/bots?start=0&limit=10&filter=eq%28provider%2C%27TABLE-BOT%27%29&sortBy=name",96 "uri": "/catalog/bots?start=0&limit=10&filter=eq%28provider%2C%27TABLE-BOT%27%29&sortBy=name",97 "type": "application/vnd.sas.collection",98 "itemType": "application/vnd.sas.metadata.bot.summary"99 },100 {101 "method": "GET",102 "rel": "collection",103 "href": "/catalog/bots",104 "uri": "/catalog/bots",105 "type": "application/vnd.sas.collection",106 "itemType": "application/vnd.sas.metadata.bot.summary"107 },108 {109 "method": "GET",110 "rel": "up",111 "href": "/catalog",112 "uri": "/catalog",113 "type": "application/vnd.sas.api"114 },115 {116 "method": "POST",117 "rel": "create",118 "href": "/catalog/bots",119 "uri": "/catalog/bots",120 "type": "application/vnd.sas.metadata.bot",121 "responseType": "application/vnd.sas.metadata.bot"122 },123 {124 "method": "POST",125 "rel": "runStates",126 "href": "/catalog/bots/state",127 "uri": "/catalog/bots/state",128 "type": "application/vnd.sas.selection",129 "responseType": "application/json"130 },131 {132 "method": "POST",133 "rel": "histories",134 "href": "/catalog/bots/history",135 "uri": "/catalog/bots/history",136 "type": "application/vnd.sas.selection",137 "responseType": "application/json"138 }139 ]140}
| Name | Type | Required | Description |
|---|---|---|---|
filter | string<filter-criteria> | false | Filter criteria for returned objects. See Filtering in REST APIs. |
limit | integer | false | Maximum number of objects to return. Defaults to 10. |
sortBy | string<sort-criteria> | false | Sort returned objects. See Sorting in REST APIs. |
start | integer | false | 0-based Offset of first object to return. Defaults to 0. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | OK. | Headers | Schema |
| 400 | Bad Request | Bad request (the request is not well-formed). | Schema | |
| 401 | Unauthorized | Not authenticated. | Schema | |
| 403 | Forbidden | The user does not have permission to complete this request. | Schema | |
| 404 | Not Found | The Catalog service is not available. | Schema | |
| 406 | Not Acceptable | Not Acceptable. Include an Accept header with a supported value on the request. | Schema | |
| 409 | Conflict | A conflict has occurred. | Schema | |
| 500 | Internal Server Error | The Catalog service encountered an error. | Schema |