Run an Agent preview

put/bots/{agentId}/preview

Running an agent preview provides insights into how many resources will be processed by the agent. The preview runs asynchronously; both the 'Location' header and the 'self' link in the response can be used to determine the location of the preview resource, which can be polled until the preview completes.

Request Samples

1

Response Samples

1{
2 "version": 1,
3 "id": "af349db0-0691-4510-bd01-122417810f7b",
4 "status": "completed",
5 "creationTimeStamp": "2021-09-28T17:28:27.585Z",
6 "nEnumerated": 281,
7 "nExcluded": 2,
8 "links": [
9 {
10 "method": "GET",
11 "rel": "self",
12 "href": "/catalog/bots/af349db0-0691-4510-bd01-122417810f7b/preview/40d9150d-9fb4-4cc5-be1c-7e5aae74b06f",
13 "uri": "/catalog/bots/af349db0-0691-4510-bd01-122417810f7b/preview/40d9150d-9fb4-4cc5-be1c-7e5aae74b06f",
14 "type": "application/vnd.sas.metadata.bot.preview"
15 },
16 {
17 "method": "GET",
18 "rel": "up",
19 "href": "/catalog/bots/af349db0-0691-4510-bd01-122417810f7b",
20 "uri": "/catalog/bots/af349db0-0691-4510-bd01-122417810f7b",
21 "type": "application/vnd.sas.metadata.bot.summary"
22 }
23 ]
24}

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.preview+jsonapplication/json
Default:
application/vnd.sas.metadata.bot.preview+json

Responses

StatusMeaningDescription
202Accepted

Accepted. The requested agent preview has been submitted for processing.

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