Web Service Method: Analyse a Corpus

Description
Initiates the analysis of a corpus.

URL: /PoolParty/api/corpusmanagement/{project}/analyze

Request

Supported Methods
POST

Content-Type

application/x-www-form-urlencoded

Path Variables

VariableComment
{project}The UUID or the URI supplement (textual identifier) of the project to be used.

HTTP Parameters


ParameterCommentTypeRequired
corpusId

ID of the corpus which should be analyzed.

Please note that the provided value should start with "corpus:". The ID alone is not sufficient.

An example for corpusId value could be corpus:a7b55be0-17c6-44b6-807c-064c6734f03e

Stringtrue

Response

 This API call is asynchronous, which means a response is sent to the client, even though the analysis is not finished yet.

http status code 200 if OK + JSON formatted response.

Example

Screenshot of a sample call, done with Postman: