Update an Agent by its ID

put/bots/{agentId}

Internal-Use Only

Update an Agent by its ID.

Request Samples

application/vnd.sas.metadata.bot+json
1

Response Samples

200
application/vnd.sas.metadata.bot+json
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

Name	Type	Required	Description
agentId	string	true	The ID of the Agent

Header Parameters

Name	Type	Required	Description
Content-Type	string	true	The representation in the request body. Allowed values: application/vnd.sas.metadata.bot+jsonapplication/vnd.sas.metadata.scheduled.bot+jsonapplication/json Default: application/vnd.sas.metadata.bot+json
If-Match	string	true	The ETag that was returned from a GET, POST, PUT, PATCH, or HEAD of this object. If the ETag does not match, the update will fail.
Accept	string	false	The desired representation for the response. The default is application/vnd.sas.metadata.definition+summary+json. 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

Request Body

A Catalog agent representation. Note that this representation and a scheduled agent representation can refer to the same object. If the agent properties must be updated but the schedules do not, use this representation; the absence of scheduled triggers in this representation will not remove any schedules associated with the agent.

Name	Type	Required	Description
name	string	true	the name of this agent; the maximum length is 100.
description	string	false	The descriptive text for this agent; the maximum length is 1000.
provider	string	true	The name of the agent provider; the maximum length is 100. This is automatically prefixed with "CATALOG-" to determine the JES provider name.
parameters	object	true	Provider specific JSON parameters for the agent in the form of a map.
suppressChangeDetection	boolean	false	A hint to the provider that change detection is not needed when this property is set to true. This can be useful, for instance, when agent parameters have changed and necessitate a complete reanalysis of the content generated by the agent.
jobParameters	object	false	Additional parameters to be used during agent execution. jobParameters is a map of string values, keyed by string values, whose interpretation is left to the provider.
id	string	false	the unique identity of this object. Immutable after creation.
version	integer	false	The version of the media type.

Responses

Status	Meaning	Description
200	OK	The request succeeded.	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 specified resource was not found.		Schema
406	Not Acceptable	Not Acceptable. Include an Accept header with a supported value on the request.		Schema
412	Precondition Failed	Precondition failed. The target has changed since it was last fetched.		Schema
428	Precondition Required	Precondition required. Include an If-Match header with the request.		Schema
500	Internal Server Error	The Catalog service encountered an error.		Schema