Update an Agent by its ID

put/bots/{agentId}

Update 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
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.

NameTypeRequiredDescription
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.

agentType
string
false

The type of this agent; the valid values are DiscoveryAgent or SchemaExtractionAgent. Defaults to DiscoveryAgent.

agentTypeLabel
string
false

The localized displayable name of the agent type.

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.

creationTimeStamp
string<date-time>
false

The date and time this object was created, in the format of YYYY-MM-DDThh:mm:ss.sssZ. The value is ignored on input.

modifiedTimeStamp
string<date-time>
false

The date and time this object was last modified, in the format of YYYY-MM-DDThh:mm:ss.sssZ. The value is ignored on input.

createdBy
string
false

The identity that created this object. The value is ignored on input.

modifiedBy
string
false

The identity that modified this object last. The value is ignored on input.

version
integer
false

The version of the media type.

links
array [Link]
false

The links that apply to the object. The value is ignored on input.

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

Bad request (the request is not well-formed).

Schema
401Unauthorized

Not authenticated.

Schema
403Forbidden

The user does not have permission to complete this request.

Schema
404Not Found

The specified resource was not found.

Schema
406Not Acceptable

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

Schema
412Precondition Failed

Precondition failed. The target has changed since it was last fetched.

Schema
428Precondition Required

Precondition required. Include an If-Match header with the request.

Schema
500Internal Server Error

The Catalog service encountered an error.

Schema