Web Service Method: Request Concept Matches of a Corpus

Description
Returns matched concepts of the corpus.

URL: /PoolParty/api/corpusmanagement/{project}/results/concepts

Request

Supported Methods
GET

Path Variables

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

HTTP Parameters

ParameterCommentTypeRequired
corpusId

The corpus that contains requested documents.

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
startIndex

The result set is limited to 20 concepts. The user can define the startIndex of the result set to retrieve concepts with higher index number.

The default startIndex is 0.

Integerfalse


Response

Returns

Array of corpora (JSON) in requested PoolParty project.

AttributeTypeComment
conceptUri
StringURI of the matching concept
conceptSchemes
StringConcept schemes of the concept
broaderConcepts
StringLanguage of the corpus
frequency
booleanTrue, when corpus analysis is up-to-date

Example

Example Request
http://<server-url>/PoolParty/api/corpusmanagement/1DCE489D-9695-0001-E272-285217B0181E/results/concepts?corpusId=corpus:e62d3b7e-ce07-48c0-b2c3-696a159227e2
Example Response
[
    {
        "uri": {
            "uri": "conceptOccurrencesView:f9a2d44e-ddca-4e9d-9e6a-4fc2aaf14a64"
        },
        "name": "People",
        "frequency": 2,
        "mainLabel": "person",
        "broaderConcepts": [],
        "conceptSchemes": [
            {
                "uri": {
                    "uri": "http://pilot1.poolparty.biz/eurovoc/MT0421"
                },
                "label": {
                    "label": "0421 parliament",
                    "language": "en"
                },
                "enabled": true
            }
        ],
        "conceptUri": {
            "uri": "http://rockefeller.poolparty.biz/FHEurovoc/4"
        },
        "blacklisted": false
    },
    {
        "uri": {
            "uri": "conceptOccurrencesView:845d2bb3-acda-4340-8bdc-99388e803173"
        },
        "name": "department of state",
        "frequency": 3,
        "mainLabel": "department of state",
        "broaderConcepts": [
            {
                "uri": {
                    "uri": "http://pilot1.poolparty.biz/eurovoc/C2244"
                },
                "label": {
                    "label": "national parliament",
                    "language": "en"
                },
                "enabled": true
            }
        ],
        "conceptSchemes": [
            {
                "uri": {
                    "uri": "http://pilot1.poolparty.biz/eurovoc/MT0421"
                },
                "label": {
                    "label": "0421 parliament",
                    "language": "en"
                },
                "enabled": true
            }
        ],
        "conceptUri": {
            "uri": "http://rockefeller.poolparty.biz/FHEurovoc/1"
        },
        "blacklisted": false
    }, ...
]