Skip to main content

    Web Service Method: Request Concepts List

    Abstract

    Web Service Method: Request Concepts List

    Description

    Returns the members of the list of concept, specified by the given URI.

    URL: /PoolParty/api/lists/{project}

    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

    uri

    The URI of the list

    String

    true

    properties

    List of skos properties that will be fetched. Possible values: skos:altLabel, skos:hiddenLabel, skos:definition

    Find details about using a list of request parameters here: API usage - General remarks

    String

    false

    locale

    Only concept schemes with labels matching this language will be displayed. If no language is given, the default language of the project is used.

    String

    false

    Response

    Array of concepts within a PoolParty thesaurus.

    Attribute

    Type

    Comment

    uri

    String

    URI of the concept

    prefLabel

    String

    preferred label

    altLabels

    array of Strings

    alternative labels

    hiddenLabels

    array of Strings

    hidden labels

    definition

    String

    definition

    Example

    Example Request 

     http://<server-url>/PoolParty/api/lists/2480fdb4-6b25-4f4b-9790-c49c7082931d?uri=http://test-pp-linux.punkt.at/doku/sparqllist/default/narrower/Oceania

    Example Response 

    [
{"uri": "http://test-pp-linux.punkt.at/doku/Micronesia",
"prefLabel": "Micronesia",
},
{"uri": "http://test-pp-linux.punkt.at/doku/Polynesia",
"prefLabel": "Polynesia",
},
{"uri": "http://test-pp-linux.punkt.at/doku/Melanesia",
"prefLabel": "Melanesia",
},
{"uri": "http://test-pp-linux.punkt.at/doku/Australia_and_New_Zealand",
"prefLabel": "Australia and New Zealand",
}
]