Web Service Method: Request a Concept's Details

Abstract

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

In this section: