You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 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

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.

nonSQL 
<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>
connection 
<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>
serverVersion 
<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>
Json Output 
{
  "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.

Output:

  • If security is enabled, a new aspire-session-id cookie will be returned along the regular response.

connector 
<result application="/aspire" outcome="ok" server="http://localhost:50505">
    <params>
        <param name="servlet_scheme">http</param>
        <param name="refresh">false</param>
        <param name="cmd">getAvailableApplications</param>
        <param name="type">connector</param>
    </params>
    <appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.aspire-snapshot-rdbms-source" isRAP="true" name="RDB via Snapshots">com.searchtechnologies.aspire:aspire-snapshot-rdbms-source</appbundle>
    <appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.aspire-filesystem-source" isRAP="true" name="File System">com.searchtechnologies.aspire:aspire-filesystem-source</appbundle>
    <appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.aspire-cifs-source" isRAP="true" name="CIFS Connector">com.searchtechnologies.aspire:aspire-cifs-source</appbundle>
    <appbundle available="false" icon="NOT-AVAILABLE" name="RightNow">com.searchtechnologies.aspire:aspire-rightnow-source</appbundle>
    <appbundle available="true" custom="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.aspire-jira-issue-source" isRAP="true" name="Aspire Jira Issue Source" typeFlags="scheduled,group-expansion">com.searchtechnologies.aspire:aspire-jira-issue-source:4.0-SNAPSHOT</appbundle>
</result>
publisher 
<result application="/aspire" outcome="ok" server="http://localhost:50505">
    <params>
        <param name="servlet_scheme">http</param>
        <param name="refresh">false</param>
        <param name="cmd">getAvailableApplications</param>
        <param name="type">publisher</param>
    </params>
    <appbundle available="true" name="Publish To File">com.searchtechnologies.aspire:app-publish-to-file</appbundle>
    <appbundle available="true" name="Publish To GSA">com.searchtechnologies.aspire:app-publish-to-gsa</appbundle>
    <appbundle available="true" name="Publish To Solr">com.searchtechnologies.aspire:app-publish-to-solr</appbundle>
    <appbundle available="true" name="Publish to ElasticSearch">com.searchtechnologies.aspire:app-publish-to-elasticsearch</appbundle>
</result>
application 
<result application="/aspire" outcome="ok" server="http://localhost:50505">
    <params>
        <param name="servlet_scheme">http</param>
        <param name="refresh">false</param>
        <param name="cmd">getAvailableApplications</param>
        <param name="type">application</param>
    </params>
    <appbundle available="true" name="Extract Text - Apache Tika">com.searchtechnologies.aspire:app-extract-text</appbundle>
    <appbundle available="true" name="Hierarchy Extractor">com.searchtechnologies.aspire:app-hierarchy-extractor</appbundle>
    <appbundle available="true" name="Mimetype Normalizer">com.searchtechnologies.aspire:app-mimetype-normalizer</appbundle>
</result>
big_data 
<result application="/aspire" outcome="ok" server="http://localhost:50505">
    <params>
        <param name="servlet_scheme">http</param>
        <param name="refresh">false</param>
        <param name="cmd">getAvailableApplications</param>
        <param name="type">big_data</param>
    </params>
    <appbundle available="true" name="Phrase Extraction">com.searchtechnologies.aspire:app-phrase-extraction-hadoop</appbundle>
    <appbundle available="true" name="Phrase Statistics">com.searchtechnologies.aspire:app-phrase-statistics-hadoop</appbundle>
    <appbundle available="true" name="Export HDFS to Redis">com.searchtechnologies.aspire:app-hadoop-export-to-redis</appbundle>
    <appbundle available="true" name="Hadoop Job Launcher">com.searchtechnologies.aspire:app-hadoop-job-launcher</appbundle>
    <appbundle available="true" name="HDFS Tools">com.searchtechnologies.aspire:app-hdfs-hadoop</appbundle>
    <appbundle available="true" name="Redis Bitmap Calculator">com.searchtechnologies.aspire:app-redis-bitmap-calculator</appbundle>
    <appbundle available="true" name="Token Processing">com.searchtechnologies.aspire:app-token-processing-hadoop</appbundle>   
	<appbundle available="true" name="Token Statistics">com.searchtechnologies.aspire:app-token-statistics-hadoop</appbundle>
    <appbundle available="true" name="Co-occurrence">com.searchtechnologies.aspire:app-semantic-co-occurrence-hadoop</appbundle>
</result>
service 
<result application="/aspire" outcome="ok" server="http://localhost:50505">
    <params>
        <param name="servlet_scheme">http</param>
        <param name="refresh">false</param>
        <param name="cmd">getAvailableApplications</param>
        <param name="type">service</param>
    </params>
    <appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.app-fast-listener" isRAP="false" name="Fast Content API">com.searchtechnologies.aspire:app-fast-listener</appbundle>
    <appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.app-fast-query-listener" isRAP="false" name="Fast Query Listener">com.searchtechnologies.aspire:app-fast-query-listener</appbundle>
	<appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.app-ldap-services" isRAP="false" name="Ldap services">com.searchtechnologies.aspire:app-ldap-services</appbundle>
    <appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.app-fast-completion-listener" isRAP="false" name="Fast Query Completion Listener">com.searchtechnologies.aspire:app-fast-completion-listener</appbundle>
    <appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.app-jms-server" isRAP="false" name="JMS Server">com.searchtechnologies.aspire:app-jms-server</appbundle>
    <appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.app-sp2013-cews-listener" isRAP="false" name="SharePoint 2013 CEWS listener">com.searchtechnologies.aspire:app-sp2013-cews-listener</appbundle>
    <appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.app-azure-groupexpander" isRAP="false" name="Azure Group Expander" typeFlags="group-expansion,external-groups">com.searchtechnologies.aspire:app-azure-groupexpander</appbundle>
    <appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.app-group-expansion-manager" isRAP="false" name="Group Expansion Manager" typeFlags="gem">com.searchtechnologies.aspire:app-group-expansion-manager</appbundle>
    <appbundle available="true" icon="aspire/files/entitlementsIcons/com.searchtechnologies.aspire.app-ldap-group-cache" isRAP="false" name="Ldap Cache" typeFlags="ldap-group-expansion,group-expansion,external-groups,attribute-server">com.searchtechnologies.aspire:app-ldap-group-cache</appbundle>
</result>
Json Output 
{
  "result": {
    "params": {
      "param": [        
		{
          "@name":"servlet_scheme",
          "$": "http"
        },
        {
          "@name":"refresh",
          "$":"false"
        },
        {
          "@name":"json",
          "$": "1"
        },
        {
          "@name":"cmd",
          "$":"getAvailableApplications"
        },
        {
          "@name":"type",
          "$":"publisher"
        }
      ]
    },
    "appbundle": [
      {
        "@available":"true",
        "@name": "Publish To File",
        "$":"com.searchtechnologies.aspire:app-publish-to-file"
      },
      {
        "@available":"true",
        "@name": "Publish To GSA",
        "$":"com.searchtechnologies.aspire:app-publish-to-gsa"
      },
      {
        "@available":"true",
        "@name": "Publish To Solr",
        "$": "com.searchtechnologies.aspire:app-publish-to-solr"
      }
    ],
    "@outcome": "ok",
    "@server":"http://localhost:50505",
    "@application":"/aspire"
  }
}


Action Request

triggerAction






  • No labels