This section describes the Aspire REST API Endpoints used by the UI.
Panel | ||||
---|---|---|---|---|
| ||||
|
Performs a status check of the component in Aspire. The output depends on the type of check.
Rest_endpoint | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||
|
Output:
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<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> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<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> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<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> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "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" } } |
Retrieves information related to the available applications.
Rest_endpoint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Output:
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<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> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<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> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<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> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<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> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<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> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "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" } } |
Makes connectors perform specified actions.
Rest_endpoint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Output:
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="cmd">triggerAction</param> <param name="action">start</param> <param name="csname">File_System</param> </params> <message>Content source 'File_System' started to crawl successfully</message> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="action">start</param> <param name="cmd">triggerAction</param> <param name="incremental">true</param> <param name="csname">File_System</param> </params> <message>Content source 'File_System' started to crawl successfully</message> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="action">resume</param> <param name="cmd">triggerAction</param> <param name="csname">File_System</param> </params> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="action">pause</param> <param name="cmd">triggerAction</param> <param name="csname">File_System</param> </params> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="action">stop</param> <param name="cmd">triggerAction</param> <param name="csname">File_System</param> </params> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="action">abort</param> <param name="cmd">triggerAction</param> <param name="csname">File_System</param> </params> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="action">activate</param> <param name="cmd">triggerAction</param> <param name="csname">File_System</param> </params> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="action">deactivate</param> <param name="cmd">triggerAction</param> <param name="csname">File_System</param> </params> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="action">delete</param> <param name="cmd">triggerAction</param> <param name="csname">File_System</param> </params> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="cmd">triggerAction</param> <param name="action">copy</param> <param name="csname">File_System</param> </params> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "result": { "params": { "param": [ { "@name":"servlet_scheme", "$": "http" }, { "@name":"action", "$":"start" }, { "@name":"json", "$": "1" }, { "@name":"cmd", "$":"triggerAction" }, { "@name":"csname", "$":"File_System" } ] }, "message": "Content source 'File_System' started to crawl successfully", "@outcome": "ok", "@server": "http://localhost:50505", "@application": "/aspire" } } |
Gets statistics from content sources or services.
Rest_endpoint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Output:
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="cmd">getStatistics</param> <param name="csname">File_System</param> <param name="timestamp">1496682284898</param> </params> <statistics detailed="true"> <status>S</status> <startTime>1496682284898</startTime> <endTime>1496682290104</endTime> <crawlMode>F</crawlMode> <auditExists>true</auditExists> <summary cs="File_System" currentTime="1496683779292" endTime="1496682290104" mode="F" startTime="1496682284898" status="S"> <queue> <scan scanned="1" scanning="0" toScan="0" total="1"/> <process processed="0" processing="0" toProcess="0" total="0"/> </queue> <inProgress adding="0" deleting="0" total="0" updating="0"/> <processed added="0" deleting="0" errored="0"excluded="0" terminated="0" total="0" unchanged="0" updated="0"/> <errors batch="0" document="0" scan="0" total="0"/> </summary> <statistics cs="File_System" currentTime="1496683779291" endTime="1496682290104" mode="F" processor="File_System-192.168.56.1:50505" server="192.168.56.1:50505" startTime="1496682284898" status="S"> <queue> <scan scanned="1" scanning="0" toScan="0" total="1"/> <process processed="0" processing="0" toProcess="0" total="0"/> </queue> <inProgress adding="0" deleting="0" total="0" updating="0"/> <processed added="0" deleting="0" errored="0" excluded="0" terminated="0" total="0" unchanged="0" updated="0"/> <errors batch="0" document="0" scan="0" total="0"/> </statistics> <scanned> <directories>1</directories> <files>0</files> <queued>0</queued> </scanned> <submitted> <updates>0</updates> <deletes>0</deletes> </submitted> <completed> <updates>0</updates> <deletes>0</deletes> </completed> <errors> <scanner>0</scanner> <document>0</document> <batch>0</batch> <total>0</total> </errors> </statistics> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="refresh">true</param> <param name="cmd">getStatistics</param> <param name="csname">File_System</param> </params> <statistics detailed="true"> <status>S</status> <startTime>1496682284898</startTime> <endTime>1496682290104</endTime> <crawlMode>F</crawlMode> <auditExists>true</auditExists> <summary cs="File_System" currentTime="1496685238400" endTime="1496682290104" mode="F" startTime="1496682284898" status="S"> <queue> <scan scanned="1" scanning="0" toScan="0" total="1"/> <process processed="0" processing="0" toProcess="0" total="0"/> </queue> <inProgress adding="0" deleting="0" total="0" updating="0"/> <processed added="0" deleting="0" errored="0" excluded="0" terminated="0" total="0" unchanged="0" updated="0"/> <errors batch="0" document="0" scan="0" total="0"/> </summary> <statistics cs="File_System" currentTime="1496685238399" endTime="1496682290104" mode="F" processor="File_System-192.168.56.1:50505" server="192.168.56.1:50505" startTime="1496682284898" status="S"> <queue> <scan scanned="1" scanning="0" toScan="0" total="1"/> <process processed="0" processing="0" toProcess="0" total="0"/> </queue> <inProgress adding="0" deleting="0" total="0" updating="0"/> <processed added="0" deleting="0" errored="0" excluded="0" terminated="0" total="0" unchanged="0" updated="0"/> <errors batch="0" document="0" scan="0" total="0"/> </statistics> <scanned> <directories>1</directories> <files>0</files> <queued>0</queued> </scanned> <submitted> <updates>0</updates> <deletes>0</deletes> </submitted> <completed> <updates>0</updates> <deletes>0</deletes> </completed> <errors> <scanner>0</scanner> <document>0</document> <batch>0</batch> <total>0</total> </errors> </statistics> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "result": { "params": { "param": [ { "@name":"servlet_scheme", "$": "http" }, { "@name":"json", "$": "1" }, { "@name":"refresh", "$":"false" }, { "@name":"cmd", "$":"getStatistics" }, { "@name":"csname", "$":"File_System" }, { "@name":"timestamp", "$":"1496682284898" } ] }, "statistics": { "@detailed": false, "status": "F", "startTime": 0, "currentTime":1496865535389, "crawlMode":"U", "auditExists": false, "scanned": { "directories": 0, "files": 0, "queued": 0 }, "submitted": { "updates": 0, "deletes": 0 }, "completed": { "updates": 0, "deletes": 0 }, "errors": { "scanner": 0, "document": 1, "batch": 0, "total": 1 } }, "@outcome": "ok", "@server":"http://localhost:50505", "@application":"/aspire" } } |
Gets a list of the statistics of the previously run crawls of a content source.
Rest_endpoint | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
|
Output:
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="cmd">getHistoricalStatistics</param> <param name="csname">File_System</param> </params> <historicalStatistics> <crawlStatistics id="1496682284898">2017-06-05T11:04:44Z</crawlStatistics> <crawlStatistics id="1496685634351">2017-06-05T12:00:34Z</crawlStatistics> </historicalStatistics> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "result": { "params": { "param": [ { "@name":"servlet_scheme", "$": "http" }, { "@name":"json", "$": "1" }, { "@name": "cmd", "$":"getHistoricalStatistics" }, { "@name":"csname", "$":"File_System" } ] }, "historicalStatistics": { "crawlStatistics": { "@id": 1496866152867, "$":"2017-06-07T14:09:12Z" } }, "@outcome": "ok", "@server":"http://localhost:50505", "@application":"/aspire" } } |
Authenticates the user and enables it to perform other requests.
Rest_endpoint | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
|
This is an example, using the authentication type 'ConfigFile', at the settings.xml file.
..config\settings.xml
<?xml version="1.0" encoding="UTF-8"?> . . . <authentication> . . . <properties> <property name="adminPassword">searchtech</property> . . . </settings> Post Url: http://localhost:50505/aspire/admin/ui/files/login.html?login=true&username=admin&password=searchtech |
---|
Output:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Set-Cookie: aspire-session-id=encrypted:A0ACBB17DF478D0C69885219E2733E866A54DAC4E890913C2D309E3144058B4A3E81EAC1CA939408B2C020B5BABA4EFBC38601A927E54AE8230ACB7E55FEFE218151CA8447A71A0323B5F53FE3AA979817E76021B1734FE601487670AB01A94B5A6AE03B1A698EBA6D3C63EB6E98BC59E2383F3FA87ECF51587DE43FCD0560B7;path=/;HttpOnly |
Status | Name | Description |
N | New | The content source crawl has not been run before. |
I | Running | The content source crawl is running. |
IP | Paused | The content source crawl is paused. It will not process more documents until it resumes. |
E | Error | The content source crawl had an error and could not be completed. |
S | Completed | The content source crawl is completed successfully. |
IWP | Pausing | The content source crawl is in transition to |
IWS | Stopping | The content source crawl is in transition to |
IWR | Resuming | The content source crawl is in transition to |
IWA | Aborting | The content source crawl is in transition to |
L | Loading | The content source is being loaded by Aspire. |
F | Failed | The content source could not be loaded by Aspire. |
A | Aborted | The content source crawl was aborted. The next crawl will reset the statistics. |
X | Cancelled | The content source crawl was cancelled. |
IA | Inactive | The content source is inactive. |
Rest_endpoint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Output:
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="cmd">updateContentSource</param> <param name="contentSource">File_System</param> <param name="json">1</param> <param name="action">update</param> <param name="connectorLocation">com.accenture.aspire:aspire-filesystem-source</param> <param name="connectorProperties"><contentSourceConfig> <connectorSource> <multipleStartPoints>false</multipleStartPoints> <url>C:\small</url> <partialScan>false</partialScan> <subDirUrl/> <indexContainers>true</indexContainers> <scanRecursively>true</scanRecursively> <scanExcludedItems>true</scanExcludedItems> <ignoreScanErrors>false</ignoreScanErrors> <ignoreSymLinks>false</ignoreSymLinks> <useACLs>false</useACLs> <acls/> <includes/> <excludes/> </connectorSource> <properties> <enableFetcher>true</enableFetcher> <enableTextExtract>true</enableTextExtract> <extractTextConfiguration>false</extractTextConfiguration> <extractTextMaxSize>20971520</extractTextMaxSize> <extractTimeout>180000</extractTimeout> <xmlMaxDepth>100</xmlMaxDepth> <structuredText>false</structuredText> <enable-non-text-filter>true</enable-non-text-filter> <non-text-document>true</non-text-document> <nonTextDocumentsExtensions>jpg,jpeg,gif,png,tif,mp3,mp4,mpg,mpeg,avi,mkv,wav,bmp,swf,war,rar,tgz,dll,exe,class</nonTextDocumentsExtensions> <enableFetchUrl>true</enableFetchUrl> <tikaConfig/> <addHierarchy>true</addHierarchy> <hierarchyCacheSize>5000</hierarchyCacheSize> <useGE>false</useGE> <generalConfiguration>false</generalConfiguration> <useBulk>false</useBulk> <bulkSize>1000</bulkSize> <bulkTimeout>1000</bulkTimeout> <flushSyncTime>15s</flushSyncTime> <computeFinalStats>false</computeFinalStats> <statusUpdateTime>1s</statusUpdateTime> <statisticsUpdateTime>5s</statisticsUpdateTime> <claimSleep>1s</claimSleep> <deleteCompleteQueueEntries/> <workflowReloadPeriod>15s</workflowReloadPeriod> <workflowErrorTolerant>false</workflowErrorTolerant> <batchSize>50</batchSize> <batchNumber>2</batchNumber> <batchTimeout>10000</batchTimeout> <waitForSubJobs>600000</waitForSubJobs> <scanThreads>10</scanThreads> <scanQueue>50</scanQueue> <processThreads>20</processThreads> <processQueue>200</processQueue> <processQueuePrefetchSize>100</processQueuePrefetchSize> <scanQueuePrefetchSize>100</scanQueuePrefetchSize> <distributedChildrenProcessing>true</distributedChildrenProcessing> <waitForWfApps>true</waitForWfApps> <waitForWfAppsRetries>20</waitForWfAppsRetries> <waitForWfAppsRetryPeriod>30s</waitForWfAppsRetryPeriod> <jobQueue>30</jobQueue> <enableAuditing>true</enableAuditing> <emitStartJob>true</emitStartJob> <emitEndJob>true</emitEndJob> <useExtendedSecurity>false</useExtendedSecurity> <lmCompatibility>0</lmCompatibility> <debug>false</debug> <wDebug>false</wDebug> <enableJobLoggers>false</enableJobLoggers> <maxRetries>3</maxRetries> <retriesEnabled>false</retriesEnabled> <useThrottle>false</useThrottle> <throttleThreads>10</throttleThreads> <throttleRate>1s</throttleRate> </properties> </contentSourceConfig></param> <param name="general"><contentSource active="true"> <displayName>File System</displayName> <schedules> <schedule type="manually" actionProperties="incremental" action="start"/> </schedules> <normalizedName>File_System</normalizedName> </contentSource></param> <param name="workflow">File_System</param> </params> </result> |
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "@application": "/aspire", "@outcome": "ok", "@server": "http://localhost:50505", "params": [ { "@name": "servlet_scheme", "#text": "http" }, { "@name": "cmd", "#text": "updateContentSource" }, { "@name": "contentSource", "#text": "File_System" }, { "@name": "json", "#text": "1" }, { "@name": "action", "#text": "update" }, { "@name": "connectorLocation", "#text": "com.accenture.aspire:aspire-filesystem-source" }, { "@name": "connectorProperties", "contentSourceConfig": { "connectorSource": { "multipleStartPoints": "false", "url": "C:\\small", "partialScan": "false", "subDirUrl": [], "indexContainers": "true", "scanRecursively": "true", "scanExcludedItems": "true", "ignoreScanErrors": "false", "ignoreSymLinks": "false", "useACLs": "false", "acls": [], "includes": [], "excludes": [] }, "properties": { "enableFetcher": "true", "enableTextExtract": "true", "extractTextConfiguration": "false", "extractTextMaxSize": "20971520", "extractTimeout": "180000", "xmlMaxDepth": "100", "structuredText": "false", "enable-non-text-filter": "true", "non-text-document": "true", "nonTextDocumentsExtensions": "jpg,jpeg,gif,png,tif,mp3,mp4,mpg,mpeg,avi,mkv,wav,bmp,swf,war,rar,tgz,dll,exe,class", "enableFetchUrl": "true", "tikaConfig": [], "addHierarchy": "true", "hierarchyCacheSize": "5000", "useGE": "false", "generalConfiguration": "false", "useBulk": "false", "bulkSize": "1000", "bulkTimeout": "1000", "flushSyncTime": "15s", "computeFinalStats": "false", "statusUpdateTime": "1s", "statisticsUpdateTime": "5s", "claimSleep": "1s", "deleteCompleteQueueEntries": [], "workflowReloadPeriod": "15s", "workflowErrorTolerant": "false", "batchSize": "50", "batchNumber": "2", "batchTimeout": "10000", "waitForSubJobs": "600000", "scanThreads": "10", "scanQueue": "50", "processThreads": "20", "processQueue": "200", "processQueuePrefetchSize": "100", "scanQueuePrefetchSize": "100", "distributedChildrenProcessing": "true", "waitForWfApps": "true", "waitForWfAppsRetries": "20", "waitForWfAppsRetryPeriod": "30s", "jobQueue": "30", "enableAuditing": "true", "emitStartJob": "true", "emitEndJob": "true", "useExtendedSecurity": "false", "lmCompatibility": "0", "debug": "false", "wDebug": "false", "enableJobLoggers": "false", "maxRetries": "3", "retriesEnabled": "false", "useThrottle": "false", "throttleThreads": "10", "throttleRate": "1s" } } }, { "@name": "general", "contentSource": { "@active": "true", "displayName": "File System", "schedules": { "schedule": { "@actionProperties": "incremental", "@action": "start" } }, "normalizedName": "File_System" } }, { "@name": "workflow", "#text": "File_System" } ] } |
Gets the list of all content sources.
Output:
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<result application="/aspire" outcome="ok" server="http://localhost:50505"> <params> <param name="servlet_scheme">http</param> <param name="cmd">getContentSources</param> </params> <contentSource id="Box"> <displayName>Box</displayName> <schedules> <schedule action="start" actionProperties="incremental" type="manually"/> </schedules> <active>true</active> <startTime/> <endTime/> <currentTime>2020-07-15T02:57:21Z</currentTime> <status>N</status> <completed>0</completed> <errors>0</errors> <type>com.accenture.aspire:aspire-box-source</type> <rap>true</rap> <bgp>false</bgp> <typeFlags>group-expansion,scheduled</typeFlags> </contentSource> <contentSource id="my_File_System"> <displayName>my File System</displayName> <schedules> <schedule action="start" actionProperties="incremental" type="daily">0 1 1 1/1 * ? *</schedule> </schedules> <active>true</active> <startTime>2020-07-15T00:49:27Z</startTime> <endTime>2020-07-15T00:51:00Z</endTime> <currentTime>2020-07-15T02:57:21Z</currentTime> <status>S</status> <completed>254</completed> <errors>4</errors> <type>com.accenture.aspire:aspire-filesystem-source</type> <rap>true</rap> <bgp>false</bgp> <typeFlags>group-expansion,scheduled</typeFlags> </contentSource> </result> |