Get an Agent by its ID

get/bots/{agentId}

Get an Agent by its ID.

Request Samples

Response Samples

1{
2  "creationTimeStamp": "2021-09-17T14:46:05.376Z",
3  "createdBy": "sasuser",
4  "modifiedTimeStamp": "2021-09-17T14:46:33.836Z",
5  "modifiedBy": "sasuser",
6  "version": 1,
7  "id": "ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
8  "name": "Crawl SASHelp (compute)",
9  "description": "Crawl the SASHelp library",
10  "agentType": "DiscoveryAgent",
11  "agentTypeLabel": "Discovery agent",
12  "provider": "TABLE-BOT",
13  "parameters": {
14    "datasourceURI": "/dataSources/providers/Compute/sources/eb654570-efb4-4d61-9814-3444869805b0~fs~SASHELP"
15  },
16  "links": [
17    {
18      "method": "GET",
19      "rel": "self",
20      "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
21      "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
22      "type": "application/vnd.sas.metadata.bot"
23    },
24    {
25      "method": "GET",
26      "rel": "alternate",
27      "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
28      "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
29      "type": "application/vnd.sas.metadata.bot.summary"
30    },
31    {
32      "method": "PUT",
33      "rel": "update",
34      "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
35      "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
36      "type": "application/vnd.sas.metadata.bot",
37      "responseType": "application/vnd.sas.metadata.bot"
38    },
39    {
40      "method": "DELETE",
41      "rel": "delete",
42      "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
43      "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a"
44    },
45    {
46      "method": "GET",
47      "rel": "runState",
48      "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state",
49      "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state",
50      "type": "text/plain"
51    },
52    {
53      "method": "PUT",
54      "rel": "updateRunState",
55      "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state?value=running",
56      "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state?value=running",
57      "type": "text/plain"
58    },
59    {
60      "method": "GET",
61      "rel": "history",
62      "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/history",
63      "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/history",
64      "type": "application/vnd.sas.collection",
65      "itemType": "application/vnd.sas.metadata.bot.history"
66    },
67    {
68      "method": "PUT",
69      "rel": "runPreview",
70      "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/preview?value=running",
71      "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/preview?value=running",
72      "type": "application/vnd.sas.metadata.bot.preview"
73    },
74    {
75      "method": "GET",
76      "rel": "up",
77      "href": "/catalog/bots",
78      "uri": "/catalog/bots",
79      "type": "application/vnd.sas.collection",
80      "itemType": "application/vnd.sas.metadata.bot.summary"
81    }
82  ]
83}

Path Parameters

NameTypeRequiredDescription
agentId
string
true

The ID of the Agent.

Header Parameters

NameTypeRequiredDescription
Accept
string
false

The desired representation for the response.

Allowed values:
application/vnd.sas.metadata.bot+jsonapplication/vnd.sas.metadata.scheduled.bot+jsonapplication/vnd.sas.metadata.bot.summary+jsonapplication/json
Default:
application/vnd.sas.metadata.bot+json

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request
401Unauthorized

Not authenticated.

Schema
403Forbidden
404Not Found
406Not Acceptable

Not Acceptable. Include an Accept header with a supported value on the request.

Schema