Public
Documentation Settings
No Environment
Double Column
cURL - cURL
zzz Archived - PoolParty API - Basic ReadOnly Examples Collection
Introduction
Basic set of PoolParty API requests
GET
Request Concept Schemes of a Project
GET
Request Top Concepts of a Concept Scheme
GET
Request Top Concepts of a Concept Scheme - collecting all property data
GET
Request Subtree of Concept or Concept Scheme
GET
Request Paths Between Concept and Concept Schemes
GET
Request a Concept's Details
GET
Request Suggested Concepts of a Project
GET
Request the History of a Project
GET
Check Extraction Model
GET
Extract from Text

zzz Archived - PoolParty API - Basic ReadOnly Examples Collection

Basic set of PoolParty API requests

Full documentation of the PoolParty API you can find here: PoolParty Developer API Guide

Credentials needed to execute the presented example requests need to be inserted in the Postman environment: {username} {password}

GETRequest Concept Schemes of a Project

{{url}}/PoolParty/api/thesaurus/{{project}}/schemes?properties=http://purl.org/dc/terms/publisher, http://purl.org/dc/terms/description, http://purl.org/dc/terms/creator, http://purl.org/dc/terms/created, http://purl.org/dc/terms/title, http://schema.semantic-web.at/ppt/appliedType?properties=http://purl.org/dc/terms/publisher, http://purl.org/dc/terms/description, http://purl.org/dc/terms/creator, http://purl.org/dc/terms/created, http://purl.org/dc/terms/title, http://schema.semantic-web.at/ppt/appliedType

Returns a list of all concept schemes in the given project

docu

AUTHORIZATIONBasic Auth
Username

{{username}}

Password

{{password}}

HEADERS
Authorization

Basic aHViZXJmOmh1YmVwcGh1YmVwcA==

Content-Type

application/x-www-form-urlencoded

PARAMS
properties

http://purl.org/dc/terms/publisher, http://purl.org/dc/terms/description, http://purl.org/dc/terms/creator, http://purl.org/dc/terms/created, http://purl.org/dc/terms/title, http://schema.semantic-web.at/ppt/appliedType

Example Request
Request Concept Schemes of a Project
curl
curl --location -g '{{url}}/PoolParty/api/thesaurus/{{project}}/schemes?properties=http%3A%2F%2Fpurl.org%2Fdc%2Fterms%2Fpublisher%2C%20http%3A%2F%2Fpurl.org%2Fdc%2Fterms%2Fdescription%2C%20http%3A%2F%2Fpurl.org%2Fdc%2Fterms%2Fcreator%2C%20http%3A%2F%2Fpurl.org%2Fdc%2Fterms%2Fcreated%2C%20http%3A%2F%2Fpurl.org%2Fdc%2Fterms%2Ftitle%2C%20http%3A%2F%2Fschema.semantic-web.at%2Fppt%2FappliedType' \
--header 'Authorization: Basic aHViZXJmOmh1YmVwcGh1YmVwcA==' \
--header 'Content-Type: application/x-www-form-urlencoded'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETRequest Top Concepts of a Concept Scheme

{{url}}/PoolParty/api/thesaurus/{{project}}/topconcepts?scheme={{conceptScheme}}&language=en

Returns a list of top concepts for a concept scheme

docu

AUTHORIZATIONBasic Auth
Username

{{username}}

Password

{{password}}

HEADERS
Authorization

Basic aHViZXJmOmh1YmVwcHBw

Content-Type

application/x-www-form-urlencoded

PARAMS
scheme

{{conceptScheme}}

language

en

Example Request
Request Top Concepts of a Concept Scheme
curl
curl --location -g '{{url}}/PoolParty/api/thesaurus/{{project}}/topconcepts?scheme={{conceptScheme}}&language=en' \
--header 'Authorization: Basic aHViZXJmOmh1YmVwcHBw' \
--header 'Content-Type: application/x-www-form-urlencoded'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETRequest Top Concepts of a Concept Scheme - collecting all property data

{{url}}/PoolParty/api/thesaurus/{{project}}/topconcepts?scheme={{conceptScheme}}&language=en&properties=all

Returns a list of top concepts for a concept scheme

docu

AUTHORIZATIONBasic Auth
Username

{{username}}

Password

{{password}}

HEADERS
Authorization

Basic aHViZXJmOmh1YmVwcHBw

Content-Type

application/x-www-form-urlencoded

PARAMS
scheme

{{conceptScheme}}

language

en

properties

all

Example Request
Request Top Concepts of a Concept Scheme - collecting all property data
curl
curl --location -g '{{url}}/PoolParty/api/thesaurus/{{project}}/topconcepts?scheme={{conceptScheme}}&language=en&properties=all' \
--header 'Authorization: Basic aHViZXJmOmh1YmVwcHBw' \
--header 'Content-Type: application/x-www-form-urlencoded'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETRequest Subtree of Concept or Concept Scheme

{{url}}/PoolParty/api/thesaurus/{{project}}/subtree?root={{conceptScheme}}&properties=skos:definition

Returns a list of all narrower concepts (recursively) of a given concept or concept scheme

docu

AUTHORIZATIONBasic Auth
Username

{{username}}

Password

{{password}}

PARAMS
root

{{conceptScheme}}

properties

skos:definition

Example Request
Request Subtree of Concept or Concept Scheme
curl
curl --location -g '{{url}}/PoolParty/api/thesaurus/{{project}}/subtree?root={{conceptScheme}}&properties=skos%3Adefinition'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers