RedSearch - API Calls

REST URL API for ECM Document Search and Publish  Base URL is https://sitecode.digitalcityplaform.online/[path/]api 

 

/stats 

Returns JSON with property, application and document counts. 

/reindex/property?id=X 
/reindex/property?id=all&from=Y 

Refresh properties in the database. 

X=Property identifier 

X=indexentry-12345-x-x-x-x-x-700 (ECM index entry identifier) 

X=all Refresh all properties in ECM (may take many days) 

X=all&from=Y Refresh properties from a specified record number in the database. 

X=unprocessed Check for new properties. 

/reindex/application?id=X 

Refresh applications and their properties in the database. 

X=Application identifier (RAM) 

X=indexentry-12345-x-x-x-x-x-702 (ECM index entry identifier) 

X=all Refresh all applications in ECM (may take many days) 

X=all&from=Y Refresh applications from a specified record number in the database. 

X=unprocessed Check for new applications. 

/reindex/changes 

Check when the last catchup was successfully completed (using the ECM changes log). 

/reindex/changes?from=X 

Start the changes catchup if a catchup process is not already running. 

X=now Process ECM changes made today.  

X=last Process ECM changes made since last successful catchup. 

X=yyyy-MM-dd Process ECM changes from the date specified. 

/reindex/changes?from=X&force=true 

Force start the changes catchup. Useful if last changes process crashed out without resetting its internal busy flag. Not valid for X=last. 

/reindex/refresh 

Refresh the full text database index. This must be done before the search will find the new records. Most APIs will do this step when it completes. 

/reindex/checkdocuments?id=X 

Refresh the index with a document. 

X=DocSetId Refresh a single document. 

X=all Refresh all documents in the database (may take days). 

X=allproperties Refresh all documents referenced by a property. 

X=allapplications Refresh all documents referenced by an application.