Watson Explorer Engine API Function Reference

alert-list-xml
Retrieves a list of alerts for all users. The SOAP name of this function is: AlertListXml
alert-run
Starts the alert service and run alerts for user or id provided. The SOAP name of this function is: AlertRun
alert-service-start
Starts the alert service and run all user alerts. The SOAP name of this function is: AlertServiceStart
alert-service-status-xml
Retrieves the status of the alert service, whether it is running or not. The SOAP name of this function is: AlertServiceStatusXml
alert-service-stop
Stops the alert service if it is running. The SOAP name of this function is: AlertServiceStop
annotation-add
Enqueues content(s) as standard annotations, attributed to the specified user, on a specific document in a collection. The name of the annotation is specified in the <content> node's name attribute. Each user can associate multiple instances of any standard annotation with each document. The SOAP name of this function is: AnnotationAdd
annotation-delete
Deletes a tag content specified by its content-id on a certain document in a collection by a user. The SOAP name of this function is: AnnotationDelete
annotation-express-add-doc-list
Enqueues content(s) as standard annotations, attributed to the specified user, on multiple documents in a collection. The name of the annotation is specified in the <content> node's name attribute. Each user can associate multiple instances of any standard annotation with each document. The SOAP name of this function is: AnnotationExpressAddDocList
annotation-express-add-query
Enqueues content(s) as standard annotations, attributed to the specified user, on all documents in a collection that match the specified query. The name of the annotation is specified in the <content> node's name attribute. Each user can associate multiple instances of any standard annotation with each document. The SOAP name of this function is: AnnotationExpressAddQuery
annotation-express-delete-doc-list
Deletes standard annotation content(s), attributed to the specified user, from multiple documents in a collection. The SOAP name of this function is: AnnotationExpressDeleteDocList
annotation-express-delete-query
Deletes standard annotation content(s), attributed to the specified user, from the documents in a collection that match the specified query. The SOAP name of this function is: AnnotationExpressDeleteQuery
annotation-express-global-set-doc-list
Enqueues content(s) as global annotation(s), attributed to the specified user (if a user is specified), on multiple documents in a collection. Only one instance of each global annotation can be present on a document. The SOAP name of this function is: AnnotationExpressGlobalSetDocList
annotation-express-global-set-query
Enqueues content(s) as global annotation(s), attributed to the specified user, on the documents in a collection that match the specified query. Only one instance of each global annotation can be present on a document. The SOAP name of this function is: AnnotationExpressGlobalSetQuery
annotation-express-update-doc-list
Updates content(s) containing standard annotations, attributed to the specified user, on multiple documents in a collection. The SOAP name of this function is: AnnotationExpressUpdateDocList
annotation-express-update-query
Updates content(s) containing standard annotations, attributed to the specified user, on the documents in a collection that match the specified query The SOAP name of this function is: AnnotationExpressUpdateQuery
annotation-express-user-set-doc-list
Enqueues content(s) as user annotations, attributed to the specified user, on multiple documents in a collection. Each user can only have one instance of each user attribute per document. The SOAP name of this function is: AnnotationExpressUserSetDocList
annotation-express-user-set-query
Enqueues content(s) as user annotations, attributed to the specified user, on the documents in a collection that match the specified query. Each user can only have one instance of each user attribute per document. The SOAP name of this function is: AnnotationExpressUserSetQuery
annotation-global-set
Enqueues content(s) as global annotation(s), attributed to the specified user, on a specified document in a collection. Only one instance of each global annotation can be present on a document. The SOAP name of this function is: AnnotationGlobalSet
annotation-permissions
The SOAP name of this function is: AnnotationPermissions
annotation-update
Updates a tag content specified by its content-id on a certain document in a collection by a user. The SOAP name of this function is: AnnotationUpdate
annotation-user-set
Enqueues content(s) as user annotations, attributed to the specified user, on a specified document in a collection. Each user can only have one instance of each user attribute per document. The SOAP name of this function is: AnnotationUserSet
auto-classify-refresh-tags
Calling this will tag documents with the classification set specified from the Auto Classify interface. Useful when a refresh of a collection has added new documents that match the queries in the classification set but have not been tagged yet. The SOAP name of this function is: AutoClassifyRefreshTags
autocomplete-suggest
Returns autocomplete suggestions for a given input string. The SOAP name of this function is: AutocompleteSuggest
axl-service-status
The SOAP name of this function is: AxlServiceStatus
collection-broker-abort-transactions
Aborts open transactions in a collection. The SOAP name of this function is: CollectionBrokerAbortTransactions
collection-broker-crawler-offline-status
Returns information pertaining to the crawler's offline queue. The SOAP name of this function is: CollectionBrokerCrawlerOfflineStatus
collection-broker-enqueue-xml
Enqueues raw XML for processing by the crawler. The SOAP name of this function is: CollectionBrokerEnqueueXml
collection-broker-export-data
Exports a set of results from the source collection to a destination collection. The SOAP name of this function is: CollectionBrokerExportData
collection-broker-get
Return Collection Broker configuration. The SOAP name of this function is: CollectionBrokerGet
collection-broker-ignore-collection
Instructs the collection broker to ignores the specified collection. Ignored collections will not be automatically checked as frequently as actively monitored collections, and will never be started to process data in the offline queue. You can instruct the broker to actively monitor a collection by performing a search or enqueue. The SOAP name of this function is: CollectionBrokerIgnoreCollection
collection-broker-search
Query one or more sources. Most of the advanced options offered here apply mostly to search collections (and can be specified on a per collection basis as well in the form of their associated sources). If you use the browse mode, search results will be cached into a temporary file and can be browsed using the query-browse function. The SOAP name of this function is: CollectionBrokerSearch
collection-broker-set
Set the Collection Broker configuration. The SOAP name of this function is: CollectionBrokerSet
collection-broker-start
Starts the Collection Broker. The SOAP name of this function is: CollectionBrokerStart
collection-broker-start-collection
Starts the crawler for the specified collection if URLs are pending in an offline queue for that collection. The SOAP name of this function is: CollectionBrokerStartCollection
collection-broker-status
Return Collection Broker status information. The SOAP name of this function is: CollectionBrokerStatus
collection-broker-stop
Stops the Collection Broker. The SOAP name of this function is: CollectionBrokerStop
crawler-runtime-options
Changes runtime crawl options. The SOAP name of this function is: CrawlerRuntimeOptions
dictionary-build
Starts a new build of the specified dictionary. The SOAP name of this function is: DictionaryBuild
dictionary-create
Creates a new dictionary, optionally based on an existing dictionary. The SOAP name of this function is: DictionaryCreate
dictionary-delete
Delete a dictionary and all associated files and directories, including the configuration. The SOAP name of this function is: DictionaryDelete
dictionary-list-xml
This function returns a list of dictionary nodes which contain the name of the dictionary and other information. The SOAP name of this function is: DictionaryListXml
dictionary-read-from-collection
The SOAP name of this function is: DictionaryReadFromCollection
dictionary-status-xml
Returns the status of the specified dictionary. The SOAP name of this function is: DictionaryStatusXml
dictionary-stop
Stops the build of the specified dictionary. The SOAP name of this function is: DictionaryStop
indexer-runtime-options
Changes runtime indexer options. The SOAP name of this function is: IndexerRuntimeOptions
ping
A useful way to detect that you are able to talk to the server. The SOAP name of this function is: Ping
query-browse
Navigate the results (search and clustering) stored in a temporary file by query-search. The SOAP name of this function is: QueryBrowse
query-cluster
The SOAP name of this function is: QueryCluster
query-parse
The SOAP name of this function is: QueryParse
query-search
Query one or more sources. Most of the advanced options offered here apply mostly to search collections (and can be specified on a per collection basis as well in the form of their associated sources). If you use the browse mode, search results will be cached into a temporary file and can be browsed using the query-browse function. The SOAP name of this function is: QuerySearch
query-similar-documents
Creates a query that can be used with the query-search function to find documents similar to the input document. The SOAP name of this function is: QuerySimilarDocuments
reporting-clean-now
Performs a purge of both system and application reporting databases according to the current administration options configured by the administrator. The SOAP name of this function is: ReportingCleanNow
reports-enqueue
Enqueues the specified report. The SOAP name of this function is: ReportsEnqueue
reports-results-xml
Retrieves the results for the chosen report. The SOAP name of this function is: ReportsResultsXml
reports-run-now-xml
Starts building the specified report. The report will not be built using the report-service and may take a long time for large reports. It is recommended to use reports-enqueue to build reports. The SOAP name of this function is: ReportsRunNowXml
reports-status-xml
Retrieves the status of the report service. The SOAP name of this function is: ReportsStatusXml
reports-stop
Stops the report service or a specific report if a report id is provided. The SOAP name of this function is: ReportsStop
reports-system-reporting
Returns system messages from the specified time period. Querying large time periods may take a significant amount of time to return and may cause the web server to timeout. Smaller time periods should be used when feasible. The SOAP name of this function is: ReportsSystemReporting
repository-add
Add a configuration node to the repository. The SOAP name of this function is: RepositoryAdd
repository-delete
Delete a configuration node in the repository. The SOAP name of this function is: RepositoryDelete
repository-get
Retrieve a configuration node from the repository. The SOAP name of this function is: RepositoryGet
repository-get-md5
Retrieve a configuration node from the repository in combination with its md5. The SOAP name of this function is: RepositoryGetMd5
repository-list-xml
List all the nodes (without their children) in the configuration repository. The SOAP name of this function is: RepositoryListXml
repository-update
The SOAP name of this function is: RepositoryUpdate
scheduler-jobs
Retrieves a list of scheduler jobs. The SOAP name of this function is: SchedulerJobs
scheduler-service-start
Starts the scheduler service if it is not already running. The SOAP name of this function is: SchedulerServiceStart
scheduler-service-status-xml
Retrieves the status of the scheduler service, whether it is running or not. The SOAP name of this function is: SchedulerServiceStatusXml
scheduler-service-stop
Stops the scheduler service if it is running. The SOAP name of this function is: SchedulerServiceStop
search-collection-abort-transactions
Aborts open transactions in a collection. The SOAP name of this function is: SearchCollectionAbortTransactions
search-collection-audit-log-purge
Purge results from the audit log. The SOAP name of this function is: SearchCollectionAuditLogPurge
search-collection-audit-log-retrieve
Retrieve results from the audit log. The SOAP name of this function is: SearchCollectionAuditLogRetrieve
search-collection-clean
Remove all data associated with a subcollection. The configuration for the collection will be untouched. The SOAP name of this function is: SearchCollectionClean
search-collection-crawler-restart
Restarts the crawler if it is running. The SOAP name of this function is: SearchCollectionCrawlerRestart
search-collection-crawler-start
Starts the crawler, if it is not running. The SOAP name of this function is: SearchCollectionCrawlerStart
search-collection-crawler-stop
Stops the crawler service, if it is running. The SOAP name of this function is: SearchCollectionCrawlerStop
search-collection-create
Create a new collection based on the configuration of an existing collection. All necessary files and directories will be created but no services will be started at this point. The SOAP name of this function is: SearchCollectionCreate
search-collection-delete
Delete a collection and all associated files and directories, including the configuration. The crawler and indexer services need to be stopped before running this. The SOAP name of this function is: SearchCollectionDelete
search-collection-enqueue
Enqueue content (or URL references) to be processed by the crawler. The SOAP name of this function is: SearchCollectionEnqueue
search-collection-enqueue-deletes
Enqueue a set of deletions to be processed by the crawler. The SOAP name of this function is: SearchCollectionEnqueueDeletes
search-collection-enqueue-url
Enqueues a URL for processing by the crawler. The SOAP name of this function is: SearchCollectionEnqueueUrl
search-collection-enqueue-xml
Enqueues raw XML for processing by the crawler. The SOAP name of this function is: SearchCollectionEnqueueXml
search-collection-indexer-full-merge
Merges multiple index files into one. Documents that have been marked as deleted from the index will be removed. The SOAP name of this function is: SearchCollectionIndexerFullMerge
search-collection-indexer-restart
Restarts the indexer if it is running. The SOAP name of this function is: SearchCollectionIndexerRestart
search-collection-indexer-start
Starts the indexer, if it is not running. The SOAP name of this function is: SearchCollectionIndexerStart
search-collection-indexer-stop
Stops the indexer service, if it is running. The SOAP name of this function is: SearchCollectionIndexerStop
search-collection-list-status-xml
Retrieves the status of currently running crawler and indexer services. The SOAP name of this function is: SearchCollectionListStatusXml
search-collection-list-xml
This function returns a list of vse-collection nodes which contain the name of the collection and other information. The SOAP name of this function is: SearchCollectionListXml
search-collection-push-staging
Make the staging subcollection live. A source test will be performed on the staging subcollection. If the source test passes, the staging subcollection will be made live. The SOAP name of this function is: SearchCollectionPushStaging
search-collection-read-only
Enables or disables read-only mode for a collection and queries the current read-only mode. The SOAP name of this function is: SearchCollectionReadOnly
search-collection-read-only-all
Enables or disables read-only mode for all collections and returns the current read-only mode status for all collections. The SOAP name of this function is: SearchCollectionReadOnlyAll
search-collection-set-xml
Updates the XML for a collection. This function correctly separates the parts of the collection configuration that must go in to the repository from the parts that must be saved in the status file. It should be used in combination with search-collection-xml. The SOAP name of this function is: SearchCollectionSetXml
search-collection-status
This function returns the XML of a collection either by querying the collection-service or by using a saved status. The SOAP name of this function is: SearchCollectionStatus
search-collection-update-configuration
Updates the collection-service with the current configuration for this collection. The SOAP name of this function is: SearchCollectionUpdateConfiguration
search-collection-url-status-query
Query a collection for the status of a set of URLs. The SOAP name of this function is: SearchCollectionUrlStatusQuery
search-collection-working-copy-accept
Accepts the working-copy configuration for a collection. The data in the staging subcollection will not be pushed to live automatically. The SOAP name of this function is: SearchCollectionWorkingCopyAccept
search-collection-working-copy-create
Creates a working-copy from the specified collection. The SOAP name of this function is: SearchCollectionWorkingCopyCreate
search-collection-working-copy-delete
Deletes the working-copy configuration for the specified collection. The data in the staging subcollection will not be pushed to live automatically. The SOAP name of this function is: SearchCollectionWorkingCopyDelete
search-collection-xml
This function returns the XML of a collection either by querying the collection-service or by using a saved status. The SOAP name of this function is: SearchCollectionXml
search-service-get
Returns the configuration for the search-service. The SOAP name of this function is: SearchServiceGet
search-service-restart
Restarts the search service. The SOAP name of this function is: SearchServiceRestart
search-service-set
Sets the configuration for the search-service. The search-service must be restarted for the configuration to take effect. The SOAP name of this function is: SearchServiceSet
search-service-start
Starts the search service if it's not already running. The SOAP name of this function is: SearchServiceStart
search-service-status-xml
Retrieves the status of the currently running search service. The SOAP name of this function is: SearchServiceStatusXml
search-service-stop
Stops the search service if it's running. The SOAP name of this function is: SearchServiceStop
source-test-enqueued-ids-xml
Returns a list of ids for enqueued source tests for a given source The SOAP name of this function is: SourceTestEnqueuedIdsXml
source-test-service-status-xml
Retrieves the status of the source test service, whether it is running or not. The SOAP name of this function is: SourceTestServiceStatusXml
source-test-start
Starts the source testing service if it is not already running and tests for the given source are enqueued. The SOAP name of this function is: SourceTestStart
source-test-stop
Aborts source tests for the given source or test id. The SOAP name of this function is: SourceTestStop
write-environment-list
Write list of feature environments to disk. The SOAP name of this function is: WriteEnvironmentList

Parent topic: Developing SOAP/REST Watson Explorer Applications