Web Service Method: Request Top Concepts of a Concept Scheme

Abstract

Description
Returns a list of direct top concepts for a concept scheme.

URL: /PoolParty/api/thesaurus/{project}/topconcepts

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
scheme	URI of the concept scheme	String	true
properties	List of concept properties that should be fetched. E.g. you can choose a list like: `skos:altLabel, skos:hiddenLabel, skos:definition, skos:broader` See full list of Retrieve Properties in API Requests.	String	false
language	Only top concepts with labels in this language will be displayed. The default language of the project will be used if no language is given.	String	false
workflowStatus	Set to `true` in case a workflow is applied and workflow status should be retrieved. Default is `false`. See details: Using Workflow Status Information	boolean	false

Response

Array of concepts of the 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
`definitions`	Array of Strings	Definitions
`broaders`	Array of Strings	Broader concepts
`narrowers`	Array of Strings	Narrower concepts
`relateds`	Array of Strings	Related concepts
`conceptSchemes`	Array of Strings	Concept schemes

Example

Example Request

http://<server-url>/PoolParty/api/thesaurus/bb2df837-7654-4c89-8994-d23f5468b56b/topconcepts?scheme=http://vocabulary.semantic-web.at/doku/Regions

Example Response

[
 {
  uri: "http://vocabulary.semantic-web.at/doku/Oceania",
  prefLabel: "Oceania"
 },
 {
  uri: "http://vocabulary.semantic-web.at/doku/Americas",
  prefLabel: "Americas"
 },
 {
  uri: "http://vocabulary.semantic-web.at/doku/Europe",
  prefLabel: "Europe"
 },
 {
  uri: "http://vocabulary.semantic-web.at/doku/Africa",
  prefLabel: "Africa"
 },
 {
  uri: "http://vocabulary.semantic-web.at/doku/Antartica",
  prefLabel: "Antartica"
 },
 {
  uri: "http://vocabulary.semantic-web.at/doku/Asia",
  prefLabel: "Asia"
 }
]

In this section: