Web Service Method: Suggest Free Concept

Abstract

Warning

This service is outdated. Please use Web Service Method: Suggest Concept instead.

Allows to suggest a new concept. The service returns the generated URI of the created concept that appears under "Suggested Concepts" in the targeted project in tab "Workflow Dashboard". Since the suggested concept is not part of the thesaurus, it is called "free concept".

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

Note

A prefLabel in the default language has to be provided. Only labels in languages can be suggested that are defined as project language.

Note

If you want to create a narrower concept directly, without using the Suggested Concepts List, you may consider to use Web Service Method: Create New Concept.

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

Request object to suggest a new free concept.

Attribute	Type	Required	Comment
`prefLabels`	Array of LanguageLiterals	true	Object representing preferred labels in certain languages. Attributes: label (String), language (String)
`checkForDuplicates`	boolean	false	If another concept with the same preferred label already exists, an error will be thrown. (Default: true)
`broaderConcept`	Array of URIs	false	Suggested parent (can be concept or concept scheme) of the new concept.
`relatedConcept`	Array of URIs	false	Suggested related concepts of the new concept.
`definition`	Array of LanguageLiterals	false	Textual definitions of the new concept.
`note`	String	false	Notes describing the new concept.
`score`	float	false	Custom score for the new concept between 0 and 1.

Response

http status code:

200 if OK.

A String containing the URL of the suggested concept.

Example

POST Request

POST /PoolParty/api/thesaurus/{project}/suggestFreeConcept HTTP/1.1
Host: <server-url>
Content-Type: application/json

{
  "prefLabels": [
    {
      "label":"test concept",
      "language":"en"
    },
    {
      "label":"Testkonzept",
      "language":"de"
    }
  ],
  "broaderConcept": [
    {
      "uri":"http://test.poolparty.biz/thesaurus/2"
    }
  ],
  "checkForDuplicates" : true
}

Response:

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

Screen shot

In this section: