Web Service Method: Request Available Corpora

Abstract

Description
Returns a list of all corpora in the given project.

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

Request

Supported Methods
GET

Path Variables

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

Response

Returns

Array of corpora (JSON) in requested PoolParty project.

Attribute	Type	Comment
corpusName	String	Name of the corpus
corpusId + uri	String	URI of the corpus
language	String	Language, the corpus is using, e.g. `'en'`
upToDate	boolean	`true`, when corpus analysis results are based on latest version of corpus document set. As soon as a document set is edited (add/delete), this value switches to `false`.

Example

Example Request

http://<server-url>/PoolParty/api/corpusmanagement/1DCE489D-9695-0001-E272-285217B0181E/corpora

Example Response

[
    {
        "message": "Retrieving corpora successful.",
        "success": true,
        "corpusName": "test2",
        "corpusId": {
            "uri": "corpus:7748f361-959e-43b0-b7e3-4bdf4907f8e0"
        },
        "language": "en",
        "upToDate": false
    },
    {
        "message": "Retrieving corpora successful.",
        "success": true,
        "corpusName": "test",
        "corpusId": {
            "uri": "corpus:e62d3b7e-ce07-48c0-b2c3-696a159227e2"
        },
        "language": "en",
        "upToDate": true
    }
]

In this section: