This section will describe the Aspire REST API Endpoint uses by the UI to:
- Create and manipulate content sources.
- Trigger content source crawls.
- Retrieve statistics.
- Workflow manipulation.
- Application manipulation.
- Crawl results retrieval.
General Requests
Check Status
Performs a status check of the component in Aspire, the output depends on the type of check.
GET /aspire?cmd=check
- Headers
-
Set-Cookie ( type=string
| default=aspire-session-id=SESSION_COOKIE
| optional
)
- Only if security is enabled
- Parameters:
-
type ( type=string
| required
)
-
nonSQL ( type=string
| optional
)
- Checks connection to NonSQL database
-
connection ( type=string
| optional
)
- Checks connection to Aspire
-
serverVersion ( type=string
| optional
)
- Checks the Aspire version
-
json ( type=string
| default=0
| optional
)
- if 1, the response will be JSON instead of XML.
Output:
- If security is enabled, a new aspire-session-id cookie will be returned along the regular response.
<result application="/aspire" outcome="ok" server="http://localhost:50505">
<params>
<param name="servlet_scheme">http</param>
<param name="cmd">check</param>
<param name="type">nonSQL</param>
</params>
<check>true</check>
</result>
<result application="/aspire" outcome="ok" server="http://localhost:50505">
<params>
<param name="servlet_scheme">http</param>
<param name="cmd">check</param>
<param name="type">connection</param>
</params>
<check>true</check>
</result>
<result application="/aspire" outcome="ok" server="http://localhost:50505">
<params>
<param name="servlet_scheme">http</param>
<param name="cmd">check</param>
<param name="type">serverVersion</param>
</params>
<check>4.0-SNAPSHOT</check>
</result>
{
"result": {
"params": {
"param": [
{
"@name":"servlet_scheme",
"$": "http"
},
{
"@name":"json",
"$": "1"
},
{
"@name":"cmd",
"$":"check"
},
{
"@name":"type",
"$":"connection"
}
]
},
"check": true,
"@outcome": "ok",
"@server":"http://localhost:50505",
"@application":"/aspire"
}
}
Application Requests
getAvailableApplications
Retrieves information related to the available applications.
POST /aspire?cmd=getAvailableApplications
- Headers
-
Content-Type ( type=string
| default=application/x-www-form-urlencoded;charset=UTF-8
| required
)
-
Set-Cookie ( type=string
| default=aspire-session-id=SESSION_COOKIE
| optional
)
- Only if security is enabled
- Parameters:
-
type ( type=string
| required
)
- type of the application
-
connector ( type=string
| optional
)
- Get a list of the available connectors
-
publisher ( type=string
| optional
)
- Get a list of the available publishers
-
application ( type=string
| optional
)
- Get a list of the available applications
-
big_data ( type=string
| optional
)
- Get a list of the available big data applications
-
service ( type=string
| optional
)
- Get a list of the available services
-
refresh ( type=string
| default=true|false
| required
)
- If true Aspire will force a download the list, otherwise will use the local list
-
json ( type=string
| default=0
| optional
)
- if 1, the response will be JSON instead of XML.
· Headers:
o 'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8'
o 'Set-Cookie': 'aspire-session-id=<SESSION_COOKIE>'
§ Only if security is enabled.
· Parameters:
o cmd: 'getAvailableApplications'
o type: Type of application.
§ connector: Get a list of the available connectors.
§ publisher: Get a list of the available publishers.
§ application: Get a list of the available applications.
§ big_data: Get a list of the available big data applications.
§ service: Get a list of the available services.
o refresh: true|false. If true Aspire will force a download the list, otherwise will use the local list.
o json: 1|0, optional, if 1, the response will be JSON instead of XML.