Manager REST services

This topic describes the REST services that are available on the manager server at http://<manager_host>:<client_port>/manager/services/client.

The following guidance applies to all the endpoints apart from getClusters:

  • Endpoints support only POST methods.

  • Endpoints accept multi-part MIME content.

  • Endpoints produce XML (text/xml) or JSON (application/json) results, depending on the MIME type passed in the Accept header.

    The results are returned in complex objects that contain the following top-level fields:

    • status: The queuing or processing status.

    • errorFound: true if the processing cluster reports an error; false otherwise.

    • results: The extraction analysis results, as a RosokaFullObject.

  • The flags parameter to processing is a string of space-separated strings that control which parts of the extraction analysis are passed back to the caller. Use this parameter to remove information from the results to improve performance. To accept the default behavior, pass an empty string.

    • -text: do not include the original text (included by default).

    • +gloss: include the glossed text (not included by default).

    • +tokens: include the raw token list (not included by default).

    • -pso: do not include the relationships (included by default).

getClusters

A GET method that returns a JSON-formatted list of the available clusters by name.

processString

Accepts simple text content for processing and returns results immediately to the caller.

  • cluster: The name of the cluster to use for processing. If unspecified or blank, use the default cluster.

  • flags: A space-separated list of flags that control what content is returned from extraction.

  • content: The text to be processed.

processRaw

Accepts raw, binary content for processing and returns results immediately to the caller. Content is analyzed for encoding and format before being converted to simple text for extraction analysis.

  • cluster: The name of the cluster to use for processing. If unspecified or blank, use the default cluster.

  • flags: A space-separated list of flags that control what content is returned from extraction.

  • content: The raw byte stream to be processed.

ingestString

Accepts simple text content and queues it for processing. Results from extraction analysis are sent to the output connector for the specified cluster. The caller receives only a status in return.

  • cluster: The name of the cluster to use for processing. If unspecified or blank, use the default cluster.

  • meta: A JSON-formatted set of key-value pairs to pass to the output connector. Some output connectors look for the _docID key to determine the name or URI of the document.

  • content: The text to be processed.

ingestFile

Accepts raw, binary content and queues it for processing. Results from extraction analysis are sent to the output connector for the specified cluster. The caller receives only a status in return.

  • cluster: The name of the cluster to use for processing. If unspecified or blank, use the default cluster.

  • meta: A JSON-formatted set of key-value pairs to pass to the output connector. Some output connectors look for the _docID key to determine the name or URI of the document.

  • content: The raw byte stream to be processed.