Web Service Method: Execute Agent to Index RSS Feeds

Abstract

Description
This method runs the specified RSS agent to index new RSS feed entries manually and immediately.

URL: /api/agents/runAgent

Request

Supported Method
POST

Request Parameters

Parameter	Description	Type	Required
searchSpaceId	ID of the search space	String	true
id	Agent ID	Long	true

Run RSS Agent with Identifier 7

POST /GraphSearch/api/agents/runAgent HTTP/1.1
Host: localhost

id=7
searchSpaceId=fc101c6f-6a8a-4123-8d0a-7998be1cfd65

Status code 200 is returned when request was successful. Otherwise an error message is returned with the message attribute in a JSON response.

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.

In this section: