Skip to main content

Web Service Method: Request Details of Multiple Concepts

Abstract

Web Service Method: Request Details of Multiple Concepts

Description

Returns a description of one or more concepts.

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

Request

Supported Methods

GET

POST

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

concepts

URI of the concept

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 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

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

List of concepts within the respective 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

Concept schemes

ExampleGET

Example Request

http://<server-url>/PoolParty/api/thesaurus/1DDFEF08-2277-0001-2C3A-1A005A00E7A0/concepts?concepts=http://vocabulary.semantic-web.at/cocktails/ea946e07-e812-4492-a0ed-124d73bfbba7,http://vocabulary.semantic-web.at/cocktails/698723d7-e8b8-410e-91a8-9bdc867b3f8a
POST

POST request uses parameters in request body as form-data:

23901101.png
Result

Example Response

[
 {
  uri: "http://vocabulary.semantic-web.at/cocktails/ea946e07-e812-4492-a0ed-124d73bfbba7",
  prefLabel: "Kir Royale"
 },
 {
  uri: "http://vocabulary.semantic-web.at/cocktails/698723d7-e8b8-410e-91a8-9bdc867b3f8a",
  prefLabel: "Bellini"
 }
]