Concept Management Services

Abstract

The following topics provide details and examples on the usage of methods in the PoolParty Thesaurus API for concepts.

Web Service Method: Create New Concept

Abstract

Web Service Method: Create New Concept

Description
Creates a new SKOS concept in your thesaurus.

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

Note

When you think about only suggesting a new concept as well as using a review process, you could use Web Service Method: Suggest Concept

For convenience, you can use this method to create top concepts and concepts as well. When you want to create a top concept, you simply use the concept scheme URI as parent.

                              Request

Supported Methods
POST

Content-Type

application/x-www-form-urlencoded

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 / concept scheme that should be parent.	String	true
prefLabel	Preferred label in the default language for the newly created concept.	String	true

Response

http status code 200if OK.

String containing URL of the newly created concept.

URL Pattern

POST Request

http://<server-url>/PoolParty/api/thesaurus/<project-Id>/createConcept?parent=<parent-url>&prefLabel=<label>

Response

http://<server-url>/<project-id>/<created-concept-id>

Example

Screenshot of an example call, done with Advanced REST client:

Example Response

http://test-pp-linux.semantic-web.at/FHcorpustest/1

Web Service Method: Request a Concept's Details

Abstract

Web Service Method: Request a Concept's Details

Description
Returns details of a single concept.

Note

To retrieve details of multiple concepts at once, use Web Service Method: Request Details of Multiple Concepts

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

Content-Type

application/x-www-form-urlencoded

Request

Supported Methods
GET

Path Variables

Variable	Comment
`{project}`	The UUID or the URI supplement (textual identifier) of the project to be used.

Request Parameters

Parameter	Comment	Type	Required
concept	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. Set to `all` to fetch all properties.	String	false
language	Only concept with label in specified 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 the workflow status should be retrieved. (Default value: `false`.) See details: Using Workflow Status Information	boolean	false

Response

A concept within the respective PoolParty project.

Attribute	Type	Comment
altLabels	Array of String	Alternative Labels
broaderMatch	Array of String	Broader Matching concepts
broaders	Array of String	Broader Concepts
closeMatch	Array of String	Close Matching concepts
conceptSchemes	Array of String	Concepts Schemes
definitions	Array of String	Definitions
exactMatch	Array of String	Exact Matching concepts
examples	Array of String	Examples
hiddenLabels	Array of String	Hidden Labels
inSchemes	Array of String	Lists inScheme relations
narrowerMatch	Array of String	Narrower Matching concepts
narrowers	Array of String	Narrower Concepts
notations	Array of String	Notations
prefLabel	String	Preferred Label
properties	Map of String	Custom Schema Relations and Attributes
relatedMatch	Array of String	Related Matching concepts
relateds	Array of String	Related Concepts
scopeNotes	Array of String	Scope notes
skosxlAltLabels	Array of String	SKOS-XL Alternative Label
skosxlHiddenLabels	Array of String	SKOS-XL Hidden Label
skosxlPrefLabels	Array of String	SKOS-XL Preferred Label
topConceptOf	Array of String	Lists topConceptOf relations
uri	String	Linked Data URI of the Concept
workflowStatus	WorkflowStatus	Workflow status

WorkflowStatus

Response attributes for the workflow status of a concept.

Attribute	Type	Comment
currentAssignee	IRI	Current assignee
lastChange	String	Date of last change
note	String	Workflow comment
state	ReviewState	Current review state DRAFT \| APPROVED \| DRAFTSKOSXL

Example Request

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

Example Response

{
  "exactMatch" : [ "https://semantic-web.com/api/exactMatch#26656", "https://semantic-web.com/api/exactMatch#17956" ],
  "scopeNotes" : [ "some scopeNotes", "some scopeNotes" ],
  "skosxlPrefLabels" : [ "some skosxlPrefLabels" ],
  "notations" : [ "some notations" ],
  "workflowStatus" : {
    "note" : "some note",
    "lastChange" : "Wed Aug 22 13:02:59 CEST 2018",
    "state" : "APPROVED",
    "currentAssignee" : {
      "uri" : "https://semantic-web.com/api/currentAssignee#31435"
    }
  },
  "prefLabel" : "some prefLabel",
  "skosxlHiddenLabels" : [ "some skosxlHiddenLabels" ],
  "broaderMatch" : [ "https://semantic-web.com/api/broaderMatch#4002" ],
  "broaders" : [ "https://semantic-web.com/api/broaders#10362", "https://semantic-web.com/api/broaders#16470" ],
  "conceptSchemes" : [ "https://semantic-web.com/api/conceptSchemes#30169", "https://semantic-web.com/api/conceptSchemes#7332", "https://semantic-web.com/api/conceptSchemes#26387" ],
  "uri" : "https://semantic-web.com/api/uri#634",
  "skosxlAltLabels" : [ "some skosxlAltLabels" ],
  "closeMatch" : [ "https://semantic-web.com/api/closeMatch#28423", "https://semantic-web.com/api/closeMatch#18763" ],
  "examples" : [ "some examples", "some examples" ],
  "hiddenLabels" : [ "some hiddenLabels", "some hiddenLabels", "some hiddenLabels" ],
  "narrowerMatch" : [ "https://semantic-web.com/api/narrowerMatch#15644", "https://semantic-web.com/api/narrowerMatch#19416", "https://semantic-web.com/api/narrowerMatch#1441" ],
  "narrowers" : [ "https://semantic-web.com/api/narrowers#2004" ],
  "relatedMatch" : [ "https://semantic-web.com/api/relatedMatch#15751", "https://semantic-web.com/api/relatedMatch#4219", "https://semantic-web.com/api/relatedMatch#20070" ],
  "inSchemes" : [ "https://semantic-web.com/api/inSchemes#12153" ],
  "relateds" : [ "https://semantic-web.com/api/relateds#16849", "https://semantic-web.com/api/relateds#27466" ],
  "topConceptOf" : [ "https://semantic-web.com/api/topConceptOf#31880", "https://semantic-web.com/api/topConceptOf#1963" ],
  "altLabels" : [ "some altLabels", "some altLabels" ],
  "definitions" : [ "some definitions", "some definitions", "some definitions" ],
  "properties" : { }
}

Example Response for the Request Attribute Workflow Status

{
  "note" : "some note",
  "lastChange" : "Wed Aug 22 13:02:59 CEST 2018",
  "state" : "DRAFTSKOSXL",
  "currentAssignee" : {
    "uri" : "https://semantic-web.com/api/currentAssignee#32176"
  }
}

Web Service Method: Request a Concept's Status

Abstract

Web Service Method: Request a Concept's Status

Description
Returns the status of a concept.

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

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
concept	URI of the concept	String	true

Response

A string describing the status of the concept. The possible status values are: SUGGESTED, REGULAR, MERGED or DELETED.

Example

GET Request

http://<server-url>/PoolParty/api/thesaurus/1DCE489D-9695-0001-E272-285217B0181E/getConceptStatus?concept=http://testserver.poolparty.biz/NeoGeo/5

Example Response

"REGULAR"

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:

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"
 }
]

Web Service Method: Add Literal to a Concept or Concept Scheme

Abstract

Web Service Method: Add Literal to a Concept or Concept Scheme

Description
Adds a SKOS literal to a concept or concept scheme.

Note

This is the opposite functionality of Web Service Method: Remove a Literal from a Concept or Concept Scheme. You can change an existing literal with Web Service Method: Update Literal of a Concept or Concept Scheme.

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

Request

Supported Methods
POST

Content-Type

application/x-www-form-urlencoded

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
resource	URI of the resource.	String	true
label	The value for the RDF literal that should be added.	String	true
language	The language of the literal - default language if not defined.	String	false
property	The type of skos label. Possible values for concepts: `skos:prefLabel, skos:altLabel, skos:hiddenLabel, skos:definition, skos:notation, skos:example, skos:scopeNote` Possible values for concept schemes: `dct:title, dct:subject, dct:description, dct:publisher, dct:contributor, dct:creator` See full list of Retrieve Properties in API Requests.	String	true

Response

http status code: 200if OK.

Note

The service checks if operation is SKOS compatible. For example you can not add an alternative label that is already defined as preferred label. In such cases a http status code 400 is returned, together with a message about the causes for the bad request error.

Example

POST Request

http://<server-url>/PoolParty/api/thesaurus/APItests/addLiteral?resource=http://test.info/glossary/2614&label=New label&language=en&property=skos:altLabel

Web Service Method: Update Literal of a Concept or Concept Scheme

Abstract

Web Service Method: Update Literal of a Concept or Concept Scheme

Description
Updates a SKOS literal of a concept or concept scheme.

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

Request

Supported Methods
POST

Content-Type

application/x-www-form-urlencoded

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
resource	URI of the Resource	String	true
newLabel	The new value for the RDF literal	String	true
oldLabel	The outdated value of the RDF literal	String	true
language	The language of the literal - default language if not defined	String	false
property	The type of skos label. Possible values for concepts: `skos:prefLabel, skos:altLabel, skos:hiddenLabel, skos:definition, skos:notation, skos:example, skos:scopeNote` Possible values for concept schemes: `dct:title, dct:subject, dct:description, dct:publisher, dct:contributor, dct:creator` See full list of Retrieve Properties in API Requests.	String	true

Response

http status code: 200 if OK.

Note

The service checks if operation is SKOS compatible. For example you can not update an alternative label so that it matches a preferred label. In such cases a http status code 400 is returned, together with a message about the causes for the bad request error.

Example

POST Request

http://<server-url>/PoolParty/api/thesaurus/APItests/updateLiteral?resource=http://test.info/glossary/2614&newLabel=Test preflabel&oldLabel=carbon price&language=en&property=skos:prefLabel

Web Service Method: Remove a Literal from a Concept or Concept Scheme

Abstract

Web Service Method: Remove a Literal from a Concept or Concept Scheme

Description
Removes the literal from a concept or concept scheme. This is the opposite functionality of Web Service Method: Add Literal to a Concept or Concept Scheme.

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

Request

Supported Methods
POST

Content-Type

application/x-www-form-urlencoded

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
resource	URI of the resource.	String	true
label	The value for the RDF literal that should be removed.	String	true
language	The language of the literal - default language if not defined.	String	false
property	The type of skos label. Possible values for concepts: `skos:prefLabel, skos:altLabel, skos:hiddenLabel, skos:definition, skos:notation, skos:example, skos:scopeNote` Possible values for concept schemes: `dct:title, dct:subject, dct:description, dct:publisher, dct:contributor, dct:creator` See full list of Retrieve Properties in API Requests.	String	true

Response

http status code: 200if OK.

Note

The service checks if the operation is SKOS compatible. For example you can not delete a preferred label of a concept in the default language. In such cases an http status code 400 is returned, together with a message about the causes for the bad request error.

Example

POST Request

http://<server-url>/PoolParty/api/thesaurus/APItests/removeLiteral?resource=http://test.info/glossary/2614&label=outdated label&language=en&property=skos:altLabel

Web Service Method: Request Broader Concepts

Abstract

Web Service Method: Request Broader Concepts

Description
Returns a list of direct broader concepts of the given concept.

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

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
concept	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 broader 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 broader concepts are returned instead of only direct broader concepts. Note Concept schemes are not returned with this request. When you want to retrieve full hierarchy path of a concept it is recommended to useWeb Service Method: Request Paths Between Concept and Concept Schemesinstead.	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

Response

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

Request Pattern

http://<server-url>/PoolParty/api/thesaurus/<project>/broaders?concept=<concept>

Examples

Example Request

http://vocabulary.semantic-web.at/PoolParty/api/thesaurus/cocktails/broaders?concept=http://vocabulary.semantic-web.at/cocktails/2d85fb1b-96cb-4c48-8df5-707032f34e71&properties=all

Example Response

[
  {
    "uri": "http://vocabulary.semantic-web.at/cocktails/b9bf3799-a4e4-47f7-9aea-7697cc998a34",
    "prefLabel": "Contemporary Classics",
    "broaders": [
      "http://vocabulary.semantic-web.at/cocktails/5ac37bec-e4b9-4d43-9bcc-8d6954903c25"
    ],
    "narrowers": [
      "http://vocabulary.semantic-web.at/cocktails/0f8cc862-9056-49be-b636-cd22f8d7282d",
      "http://vocabulary.semantic-web.at/cocktails/117bd4d2-6da3-4d69-8c79-bc1d873b5010",
      "http://vocabulary.semantic-web.at/cocktails/12f4790a-560f-4e1c-b57a-53b8171ae39a",
      "http://vocabulary.semantic-web.at/cocktails/13b85b5c-7f69-4871-bb08-3cd5281f6039",
      "http://vocabulary.semantic-web.at/cocktails/1529fd23-9c55-45d7-b8c6-b0fc229a3871",
      "http://vocabulary.semantic-web.at/cocktails/268fb62f-8ef1-45cd-844f-8c7da85a6a0b",
      "http://vocabulary.semantic-web.at/cocktails/2c032fe6-a518-44be-851a-dbf1c253be63",
      "http://vocabulary.semantic-web.at/cocktails/2d85fb1b-96cb-4c48-8df5-707032f34e71",
      "http://vocabulary.semantic-web.at/cocktails/33d9a47f-0622-4b0f-ad1b-62eb96fc6799",
      "http://vocabulary.semantic-web.at/cocktails/43111fc3-3b59-420c-a588-024cd2d33896",
      "http://vocabulary.semantic-web.at/cocktails/45788a96-1fde-486b-80fc-31ad243bba31",
      "http://vocabulary.semantic-web.at/cocktails/4792b0b8-0046-47ca-8c2a-f3ad58922182",
      "http://vocabulary.semantic-web.at/cocktails/4f85cadd-4fd4-4ffc-a78d-cddb0763fa4b",
      "http://vocabulary.semantic-web.at/cocktails/52117ab2-dcb8-4d28-a366-ddd932e58219",
      "http://vocabulary.semantic-web.at/cocktails/55c40695-8b41-41ed-8c6a-70fe6930067e",
      "http://vocabulary.semantic-web.at/cocktails/61a18ebf-fd92-4ef1-8ab1-bfd3c26867b9",
      "http://vocabulary.semantic-web.at/cocktails/698723d7-e8b8-410e-91a8-9bdc867b3f8a",
      "http://vocabulary.semantic-web.at/cocktails/926b14fe-1b83-4f46-bbf9-f946be1889aa",
      "http://vocabulary.semantic-web.at/cocktails/a73d88e9-0c50-45d2-b364-9dec5abe206d",
      "http://vocabulary.semantic-web.at/cocktails/b8075344-1e6d-4348-bdee-83948203a974",
      "http://vocabulary.semantic-web.at/cocktails/bca7bc6d-6709-48b8-ae52-fe194c212398",
      "http://vocabulary.semantic-web.at/cocktails/bee1e709-b317-4f46-b06f-a22367baefdf",
      "http://vocabulary.semantic-web.at/cocktails/c2249dc0-0529-4a11-ad82-5d710b5e9c31",
      "http://vocabulary.semantic-web.at/cocktails/c3b197cc-8583-4e2f-8e45-3a7fed1309c1",
      "http://vocabulary.semantic-web.at/cocktails/c8f4f6bd-4ac1-456a-a3aa-595e4b93d979",
      "http://vocabulary.semantic-web.at/cocktails/ce8f4591-ccd4-4d90-a761-244115d64061",
      "http://vocabulary.semantic-web.at/cocktails/dff0a7f4-ded0-48d5-bd31-881b70fbe36a",
      "http://vocabulary.semantic-web.at/cocktails/ea946e07-e812-4492-a0ed-124d73bfbba7",
      "http://vocabulary.semantic-web.at/cocktails/eddf4894-1683-44e9-9ee3-7920d3729d71",
      "http://vocabulary.semantic-web.at/cocktails/f01f6a10-01a5-4810-860f-d3a52fd36b1b"
    ],
    "inSchemes": [
      "http://vocabulary.semantic-web.at/cocktails/8d052dfc-44bf-4985-8ce3-4564570a161b"
    ],
    "properties": {
      "http://purl.org/dc/terms/creator": [
        "http://localhost/user/blumauera"
      ],
      "http://purl.org/dc/terms/created": [
        "2015-05-01T07:35:30Z"
      ],
      "http://purl.org/dc/terms/modified": [
        "2017-04-26T11:40:54Z"
      ],
      "http://purl.org/dc/terms/contributor": [
        "http://localhost/user/turdeant"
      ],
      "http://www.w3.org/1999/02/22-rdf-syntax-ns#type": [
        "http://vocabulary.semantic-web.at/cocktail-ontology/Cocktail",
        "http://www.w3.org/2004/02/skos/core#Concept"
      ]
    }
  },
  {
    "uri": "http://vocabulary.semantic-web.at/cocktails/7516b400-963a-4151-8fdc-f6b23bad1dd5",
    "prefLabel": "Sour",
    "altLabels": [
      "Sour Cocktail"
    ],
    "definitions": [
      "A sour is a traditional family of mixed drinks; the word itself is often used as a post-positive adjective when in the name of a drink. Common examples of sours are the margarita and the sidecar. Sours belong to one of the old families of original cocktails and are described by Jerry Thomas in his 1862 book How to Mix Drinks. Sours are mixed drinks containing a base liquor (bourbon or some other whiskey in the case of a whiskey sour), lemon or lime juice, egg white, and a sweetener."
    ],
    "narrowers": [
      "http://vocabulary.semantic-web.at/cocktails/2d85fb1b-96cb-4c48-8df5-707032f34e71",
      "http://vocabulary.semantic-web.at/cocktails/36671f9c-904a-4629-937a-519d094ecefc",
      "http://vocabulary.semantic-web.at/cocktails/43b786b6-a1f1-4b7f-a5d9-be43d386ffb4",
      "http://vocabulary.semantic-web.at/cocktails/53a05366-d473-4eb4-ac66-0d0119e0b759",
      "http://vocabulary.semantic-web.at/cocktails/76c0e55c-22df-4489-9551-4fe8a6a649f8",
      "http://vocabulary.semantic-web.at/cocktails/7e4a73d5-f73d-4890-972c-f3dfd6952fd8",
      "http://vocabulary.semantic-web.at/cocktails/a47e8f08-057a-45f2-8398-9be51ed351fc",
      "http://vocabulary.semantic-web.at/cocktails/b33091cd-8c57-45e3-a89b-9de91ffce1e8",
      "http://vocabulary.semantic-web.at/cocktails/bab016bd-2fd5-4809-bfe7-3225d25f116d",
      "http://vocabulary.semantic-web.at/cocktails/bca7bc6d-6709-48b8-ae52-fe194c212398",
      "http://vocabulary.semantic-web.at/cocktails/c151ee28-45d2-4128-8587-1f1b69060d9d",
      "http://vocabulary.semantic-web.at/cocktails/e039633b-03c1-47bd-a705-a104a4323e45"
    ],
    "inSchemes": [
      "http://vocabulary.semantic-web.at/cocktails/8d052dfc-44bf-4985-8ce3-4564570a161b"
    ],
    "topConceptOf": [
      "http://vocabulary.semantic-web.at/cocktails/8d052dfc-44bf-4985-8ce3-4564570a161b"
    ],
    "exactMatch": [
      "http://dbpedia.org/resource/Sour_(cocktail)"
    ],
    "properties": {
      "http://purl.org/dc/terms/creator": [
        "http://localhost/user/blumauera"
      ],
      "http://purl.org/dc/terms/created": [
        "2015-05-01T14:35:10Z"
      ],
      "http://purl.org/dc/terms/modified": [
        "2017-04-26T11:40:55Z"
      ],
      "http://purl.org/dc/terms/contributor": [
        "http://localhost/user/turdeant"
      ],
      "http://www.w3.org/1999/02/22-rdf-syntax-ns#type": [
        "http://vocabulary.semantic-web.at/cocktail-ontology/Cocktail",
        "http://www.w3.org/2004/02/skos/core#Concept"
      ]
    }
  }
]

Web Service Method: Request Narrower Concepts

Abstract

Web Service Method: Request Narrower Concepts

Description
Returns a list of narrower concepts of a given concept.

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

Note

See Web Service Method: Request Child Concepts of Concept Schemes or Concepts when you don't want to be 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
concept	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 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

Example

Example Request

http://<server-url>/PoolParty/api/thesaurus/2480fdb4-6b25-4f4b-9790-c49c7082931d/narrowers?concept=http://vocabulary.semantic-web.at/doku/Oceania

Example Response

[
 {
  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"
 }
]

Web Service Method: Add Relation Between Two Concepts

Abstract

Web Service Method: Add Relation Between Two Concepts

Description
Adds a SKOS relation between two concepts. This is the opposite functionality of Web Service Method: Remove Relation Between Two Concepts

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

Note

This service is restricted to SKOS relations. If you want to create a custom relation between concepts, you may consider to use Web Service Method: Add a Custom Relation to a Resource

Request

Supported Methods
POST

Content-Type

application/x-www-form-urlencoded

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
sourceConcept	URI of the source Concept	String	true
targetConcept	URI of the target Concept	String	true
property	The relation type. E.g. you can choose a property like: `skos:altLabel, skos:hiddenLabel, skos:definition, skos:broader` See full list of Retrieve Properties in API Requests.	String	true

Parameter

Comment

Type

Required

sourceConcept

URI of the source Concept

String

true

targetConcept

URI of the target Concept

String

true

property

The relation type. E.g. you can choose a property like: skos:altLabel, skos:hiddenLabel, skos:definition, skos:broader

See full list of Retrieve Properties in API Requests.

String

true

Response

http status code: 200if OK.

Note

The service checks if operation is SKOS compatible. For example you can not add a relationship that causes circles in the hierarchy. In such cases a http status code 400 is returned, together with a message about the causes for the bad request error.

Example

POST Request

http://<server-url>/PoolParty/api/thesaurus/APItests/addRelation?sourceConcept=http://test.info/glossary/2614&targetConcept=http://test.info/glossary/1365&property=related

Web Service Method: Request Related Concepts

Abstract

Web Service Method: Request Related Concepts

Description
Returns a list of related concepts for a given concept.

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

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
concept	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 related 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 related concepts are returned instead of only direct related 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

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
`definitions`	Array of Strings	Definitions

Example

Example Request

http://vocabulary.semantic-web.at/PoolParty/api/thesaurus/bb2df837-7654-4c89-8994-d23f5468b56b/relateds?concept=http://vocabulary.semantic-web.at/doku/Free_University_of_Berlin

Example Response

[
 {
  prefLabel: "Berlin",
  uri: "http://vocabulary.semantic-web.at/doku/Berlin_4"
 }
]

Web Service Method: Remove Relation Between Two Concepts

Abstract

Web Service Method: Remove Relation Between Two Concepts

Description
Removes a relation between two concepts. This is the opposite functionality of Web Service Method: Add Relation Between Two Concepts.

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

Request

Supported Methods
POST

Content-Type

application/x-www-form-urlencoded

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

sourceConcept

URI of the source Concept

String

true

targetConcept

URI of the target Concept

String

true

property

The relation type. E.g. you can choose a property like: skos:altLabel, skos:hiddenLabel, skos:definition, skos:broader

See full list of Retrieve Properties in API Requests.

String

true

Response

http status code: 200if OK.

Note

The service checks if the operation is SKOS compatible. For example you can not remove a relationship that causes a disintegration of the hierarchical structure of the thesaurus. In such cases an http status code 400 is returned, together with a message about the causes for the bad request error.

Example

POST Request

http://<server-url>/PoolParty/api/thesaurus/APItests/removeRelation?sourceConcept=http://test.info/glossary/1913&targetConcept=http://test.info/glossary/2614&property=narrower

Web Service Method: Delete a Concept

Abstract

Web Service Method: Delete a Concept

Description
Deletes a concept if it does not have any narrower concepts. All its relations will be deleted as well.

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

Request

Supported Methods
POST

Content-Type

application/x-www-form-urlencoded

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
concept	URI of the concept that should be removed. The concept cannot have any narrower concepts.	String	true

Response

http status code:

200 if OK.

Example

POST Request

http://<server-url>/PoolParty/api/thesaurus/APItests/deleteConcept?concept=http://test.semantic-web.at/APItest/3

Web Service Method: Change URI of a Concept

Abstract

Web Service Method: Change URI of a Concept

Description
Changes the URI of a concept.

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

Request

Supported Methods
POST

Content-Type

application/json

Path Variables

Variable	Comment
`{project}`	The UUID or the URI supplement (textual identifier) of the project to be used.

JSON UriChangeRequest

Attribute	Type	Comment
`oldUri`	String	Existing URI of the concept
`newUri`	String	NewURI of the concept

Response

http status code:

200 if OK.

Example

POST Request

POST http://<server-url>/PoolParty/api/thesaurus/APItests/changeUri


{
  "newUri" : "https://semantic-web.com/api/newUri#6211",
  "oldUri" : "https://semantic-web.com/api/oldUri#16511"
}

In this section: