Get an Agent by its ID

get/bots/{agentId}
Internal-Use Only

Get an Agent by its ID.

Request Samples

1

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 "provider": "TABLE-BOT",
11 "parameters": {
12 "datasourceURI": "/dataSources/providers/Compute/sources/eb654570-efb4-4d61-9814-3444869805b0~fs~SASHELP"
13 },
14 "links": [
15 {
16 "method": "GET",
17 "rel": "self",
18 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
19 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
20 "type": "application/vnd.sas.metadata.bot"
21 },
22 {
23 "method": "GET",
24 "rel": "alternate",
25 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
26 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
27 "type": "application/vnd.sas.metadata.bot.summary"
28 },
29 {
30 "method": "PUT",
31 "rel": "update",
32 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
33 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
34 "type": "application/vnd.sas.metadata.bot",
35 "responseType": "application/vnd.sas.metadata.bot"
36 },
37 {
38 "method": "DELETE",
39 "rel": "delete",
40 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a",
41 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a"
42 },
43 {
44 "method": "GET",
45 "rel": "runState",
46 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state",
47 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state",
48 "type": "text/plain"
49 },
50 {
51 "method": "PUT",
52 "rel": "updateRunState",
53 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state?value=running",
54 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/state?value=running",
55 "type": "text/plain"
56 },
57 {
58 "method": "GET",
59 "rel": "history",
60 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/history",
61 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/history",
62 "type": "application/vnd.sas.collection",
63 "itemType": "application/vnd.sas.metadata.bot.history"
64 },
65 {
66 "method": "PUT",
67 "rel": "runPreview",
68 "href": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/preview?value=running",
69 "uri": "/catalog/bots/ba14bc66-8aaf-4a57-bff1-87a39774ac1a/preview?value=running",
70 "type": "application/vnd.sas.metadata.bot.preview"
71 },
72 {
73 "method": "GET",
74 "rel": "up",
75 "href": "/catalog/bots",
76 "uri": "/catalog/bots",
77 "type": "application/vnd.sas.collection",
78 "itemType": "application/vnd.sas.metadata.bot.summary"
79 }
80 ]
81}

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
200OKThe request succeeded.HeadersSchema
400Bad RequestBad request (the request is not well-formed).Schema
401UnauthorizedNot authenticated.Schema
403ForbiddenThe user does not have permission to complete this request.Schema
404Not FoundThe specified resource was not found.Schema
406Not AcceptableNot Acceptable. Include an Accept header with a supported value on the request.Schema