Web Service Method: Request Up-to-date Information about a Corpus

Abstract

Description
Returns if selected corpus is up-to-date.

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

Request

Supported Methods
GET

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	The corpus that contains requested documents. 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

Parameter

Comment

Type

Required

corpusId

The corpus that contains requested documents.

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

Returns

Array of corpora (JSON) in requested PoolParty project.

Attribute	Type	Comment
`corpusName`	String	Name of the corpus
`corpusId + uri`	String	Id of the corpus, consisting of the uri
`language`	String	Language of the corpus
upToDate	boolean	True, when corpus analysis is up-to-date

Example

Request

http://<server-url>/PoolParty/api/corpusmanagement/1DCE489D-9695-0001-E272-285217B0181E/uptodate?corpusId=corpus:e62d3b7e-ce07-48c0-b2c3-696a159227e2

Response

{
    "message": "Getting status information for corpus was successful.",
    "success": true,
    "corpusName": "test",
    "corpusId": {
        "uri": "corpus:e62d3b7e-ce07-48c0-b2c3-696a159227e2"
    },
    "language": "en",
    "upToDate": false
}

In this section: