Web Service Method: Request Suggested Concepts of a Project

Abstract

Description
Returns the list of suggested concepts for the specified project.

Note

This service is equivalent to the list of the Suggested Concepts in the Workflow Dashboard tab in PoolParty frontend. For details refer to:Suggested Concepts Workflow

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

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
offset	Start index from where the suggested concepts results should be returned.	integer	false
noOfConcepts	The number of retrieved suggested concepts.	integer	false

Response

HTTP status code 200 if OK + a JSON formatted response.

Attribute	Type	Comment
`uri`	String	URI of the concept
`prefLabels`	Object, containing label and language	Array of preferred labels of suggested concept. A suggested concept may carry labels in different languages.
`definitions`	Array of Strings	Suggested concepts may carry alternative labels.
`broaderResources`	Array of Strings	Suggested concepts may carry broader concepts.
`relatedResources`	Array of Strings	Suggested concepts may carry related concepts.
`note`	String	Suggested concepts may carry a note.
`score`	float	Custom score for the new concept between 0 and 1.
`date`	Date	Last modification date

Example

cURL request

curl -u user:password -X GET "http://vocabulary.semantic-web.at/PoolParty/api/thesaurus/1DCE0ED2-D7E8-0001-86A1-18652DF0D7A0/suggestedConcepts"

Example Response

[ {
  "uri" : {
    "uri" : "http://vocabulary.semantic-web.at/cocktails/4c6a85a7-de2a-42a9-9664-3279e53bac48"
  },
  "prefLabels" : [ {
    "label" : "Calvados",
    "language" : "en"
  } ],
  "definitions" : [ ],
  "broaderResources" : [ ],
  "relatedResources" : [ ],
  "score" : 0.0,
  "date" : 1452700150000,
  "note" : ""
}, {
  "uri" : {
    "uri" : "http://vocabulary.semantic-web.at/doku/test-concept"
  },
  "prefLabels" : [ {
    "label" : "test concept",
    "language" : "en"
  }, {
    "label" : "Testkonzept",
    "language" : "de"
  } ],
  "definitions" : [ ],
  "broaderResources" : [ {
    "uri" : "http://vocabulary.semantic-web.at/doku/University-of-Vienna"
  } ],
  "relatedResources" : [ ],
  "score" : 0.0,
  "date" : 1447947012000,
  "note" : ""
} ]

Usage of a REST client

The following screenshot shows the request for the first five suggested concepts of a project using Postman:

In this section: