Web Service Method: Request Specific Agent Configuration

Abstract

Description
This method retrieves configuration of one specific agent of a Search Space.

URL:/api/agents/config

Content-Type

application/json

Request

Supported Methods
GET

Note

The return to this request will display these errors in the following specific cases:

If the Search Space ID is wrong, you will receive a 404 'Bad Request' message, with specific information in a JSON message as to the value that was not found.
If the credentials were mistyped or wrong: a 403 'Forbidden', and a JSON message 'Access denied' will be returned.
If you didn't specify a Search Space ID: the return will be made for the default Search Space.
- If the default Search Space is private and you are not authenticated, you will also receive a 403 'Forbidden' in a JSON message.

HTTP Parameters

Parameter	Comment	Type	Required
searchSpaceId	ID of the search space	String	true
id	ID of the agent Note The ID needs to be URL encoded.	String	true

Response

This method returns agent configurations in JSON format. In case the request was not successful, an error message is returned with the "message" attribute in a JSON response.

Example

Get all agents

Example Request

GET /GraphSearch/api/agents?searchSpaceId=fc101c6f-6a8a-4123-8d0a-7998be1cfd65&id=https%3A%2F%2Fwww.abarabove.com%2Fblog%2Ffeed%2F

Example Response

{
    "searchSpaceId": "fc101c6f-6a8a-4123-8d0a-7998be1cfd65",
    "username": "huberf",
    "privateContent": false,
    "periodMillis": 3600000,
    "context": null,
    "source": "https://www.abarabove.com",
    "url": "https://www.abarabove.com/blog/feed/"
}

In this section: