Skip to main content

Web Service Method: Request Child Concepts of Concept Schemes or Concepts

Abstract

Web Service Method: Request Child Concepts of Concept Schemes or Concepts

Description

Returns a list of narrower concepts of a given concept or concept scheme.

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

Note

This request is similar to Web Service Method: Request Narrower Concepts but not restricted to Concepts as input parameter.

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

parent

URI of the Concept or ConceptScheme

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 narrower concepts with labels in this language will be displayed. If no language is given, the default language of the project will be used.

String

false

transitive

If true, all transitive narrower concepts are returned instead of only direct narrower concepts.

Boolean

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

ResponseReturns

Array of concepts of the selected PoolParty project.

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

Concepts Schemes

Example

Example Request

http://<server-url>/PoolParty/api/thesaurus/<project>/childconcepts?parent=http://vocabulary.semantic-web.at/doku/Oceania

Example Request

[
 {
  uri: "http://vocabulary.semantic-web.at/doku/Micronesia",
  prefLabel: "Micronesia"
 },
 {
  uri: "http://vocabulary.semantic-web.at/doku/Polynesia",
  prefLabel: "Polynesia"
 },
 {
  uri: "http://vocabulary.semantic-web.at/doku/Melanesia",
  prefLabel: "Melanesia"
 },
 {
  uri: "http://vocabulary.semantic-web.at/doku/Australia_and_New_Zealand",
  prefLabel: "Australia and New Zealand"
 }
]