You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
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.
- URL: <ASPIRE_HOST>:<ASPIRE_PORT>/aspire
- HTTP Request: GET
- Headers
- 'Set-Cookie': 'aspire-session-id=<SESSION_COOKIE>'
- Only if security is enabled.
- Parameters:
- cmd: 'check'
- type: Type of check to be performed.
- nonSQL: Checks connection to NoSQL database.
- connection: Checks connection to Aspire.
- serverVersion: Checks Aspire version.
- json: 1|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"
}
}