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,
- agentType,
- 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 "agentType": "DiscoveryAgent",19 "agentTypeLabel": "Discovery Agent",20 "provider": "TABLE-BOT",21 "parameters": {22 "datasourceURI": "/dataSources/providers/Compute/sources/eb654570-efb4-4d61-9814-3444869805b0~fs~SASHELP"23 },24 "links": [25 {26 "method": "GET",27 "rel": "self",28 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",29 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",30 "type": "application/vnd.sas.metadata.bot"31 },32 {33 "method": "GET",34 "rel": "alternate",35 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",36 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",37 "type": "application/vnd.sas.metadata.bot.summary"38 },39 {40 "method": "PUT",41 "rel": "update",42 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",43 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",44 "type": "application/vnd.sas.metadata.bot",45 "responseType": "application/vnd.sas.metadata.bot"46 },47 {48 "method": "DELETE",49 "rel": "delete",50 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",51 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a"52 },53 {54 "method": "GET",55 "rel": "runState",56 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state",57 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state",58 "type": "text/plain"59 },60 {61 "method": "PUT",62 "rel": "updateRunState",63 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state?value=running",64 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state?value=running",65 "type": "text/plain"66 },67 {68 "method": "GET",69 "rel": "history",70 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/history",71 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/history",72 "type": "application/vnd.sas.collection",73 "itemType": "application/vnd.sas.metadata.bot.history"74 },75 {76 "method": "PUT",77 "rel": "runPreview",78 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/preview?value=running",79 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/preview?value=running",80 "type": "application/vnd.sas.metadata.bot.preview"81 },82 {83 "method": "GET",84 "rel": "up",85 "href": "/catalog/bots",86 "uri": "/catalog/bots",87 "type": "application/vnd.sas.collection",88 "itemType": "application/vnd.sas.metadata.bot.summary"89 }90 ]91 }92 ],93 "links": [94 {95 "method": "GET",96 "rel": "self",97 "href": "/catalog/bots?start=0&limit=10&filter=eq%28provider%2C%27TABLE-BOT%27%29&sortBy=name",98 "uri": "/catalog/bots?start=0&limit=10&filter=eq%28provider%2C%27TABLE-BOT%27%29&sortBy=name",99 "type": "application/vnd.sas.collection",100 "itemType": "application/vnd.sas.metadata.bot.summary"101 },102 {103 "method": "GET",104 "rel": "collection",105 "href": "/catalog/bots",106 "uri": "/catalog/bots",107 "type": "application/vnd.sas.collection",108 "itemType": "application/vnd.sas.metadata.bot.summary"109 },110 {111 "method": "GET",112 "rel": "up",113 "href": "/catalog",114 "uri": "/catalog",115 "type": "application/vnd.sas.api"116 },117 {118 "method": "POST",119 "rel": "create",120 "href": "/catalog/bots",121 "uri": "/catalog/bots",122 "type": "application/vnd.sas.metadata.bot",123 "responseType": "application/vnd.sas.metadata.bot"124 },125 {126 "method": "POST",127 "rel": "runStates",128 "href": "/catalog/bots/state",129 "uri": "/catalog/bots/state",130 "type": "application/vnd.sas.selection",131 "responseType": "application/json"132 },133 {134 "method": "POST",135 "rel": "histories",136 "href": "/catalog/bots/history",137 "uri": "/catalog/bots/history",138 "type": "application/vnd.sas.selection",139 "responseType": "application/json"140 }141 ]142}| 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 |