- Graphwise Platform Documentation
- Graphwise API Endpoints
- Thesaurus & Ontology Manager API
- Corpus Services
- Web Service Method: Request the Metadata of a Corpus
Web Service Method: Request the Metadata of a Corpus
18/03/2026
Description |
|---|
Returns metadata of the selected corpus. |
URL: /PoolParty/api/corpusmanagement/{project}/metadata
Supported Methods |
|---|
GET |
Path Variables
Variable | Comment |
|---|---|
| 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. NotePlease note that the provided value should start with "corpus:". The id alone is not sufficient. An example for corpusId value could be | String | true |
Returns
Array of corpora (JSON) in requested PoolParty project.
Attribute | Type | Comment |
|---|---|---|
| String | Name of the corpus |
| String | Id of the corpus, consisting of the uri |
| String | Language of the corpus |
| String | Name of user who created the corpus |
created | Date | Date when corpus was created |
extractedTerms | Integer | Number of terms that where extracted |
concepts | Integer | Number of concepts that where matched in corpus documents |
suggestedTermOccurrences | Integer | Occurrences of suggested terms |
conceptOccurrences | Integer | Occurrences of matched concepts |
quality | String | Type of quality |
overallFileSize | Integer | Size of corpus documents (bytes) |
lastModified | Date | Time when corpus was last modified |
storedDocuments | Integer | Number of documents that are part of the corpus |
Example Request
http://<server-url>/PoolParty/api/corpusmanagement/1DCE489D-9695-0001-E272-285217B0181E/metadata?corpusId=corpus:e62d3b7e-ce07-48c0-b2c3-696a159227e2
Example Response
{
"message": "Retrieving corpus metadata successful.",
"success": true,
"corpusName": "test",
"corpusId": {
"uri": "corpus:e62d3b7e-ce07-48c0-b2c3-696a159227e2"
},
"language": "en",
"createdBy": "huberf",
"created": "Thu Sep 17 15:07:43 CEST 2015",
"extractedTerms": 635,
"concepts": 1,
"suggestedTermOccurrences": 941,
"conceptOccurrences": 3,
"quality": "poor",
"overallFileSize": "641261",
"lastModified": "Tue Dec 29 15:10:53 CET 2015",
"storedDocuments": 4
}