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

Variable

Comment

{project}

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

HTTP Parameters

Parameter

Comment

Type

Required

corpusId

ID of the corpus which should be analyzed.

Note

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

String

true

Response

Note

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 200if OK + JSON formatted response.

Example

Screenshot of a sample call, done with Postman:

23901201.png