Notes Services

Abstract

Notes Services

Notes services provide methods to manage notes assigned to concepts.

Note

These services are a programmatic equivalent to manually Adding Notes to your Concepts.

Web Service Method: Create a New Note for a Concept

Abstract

Web Service Method: Create a New Note for a Concept

Description
Creates a new note for a concept.

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

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 get the note.	String	true
title	Title of the note	String	true
comment	Comment of the note	String
type	Type of the note. Can be either `historyNote`, `changeNote` or `editorialNote`	String	true

Response

http status code 200if OK.

URL Pattern

POST Request Example

http://<server-url>/PoolParty/api/thesaurus/<project-Id>/createNote?concept=http://rockefeller.poolparty.biz/Eurovoc/8&title=My note&type=historyNote&comment=The comment

Web Service Method: Delete a Concept Note

Abstract

Web Service Method: Delete a Concept Note

Description
Deletes a concept note.

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

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 the note should be deleted from.	String	true
bNodeId	Blank node ID	String	true

Response

http status code 200 if OK.

URL Pattern

POST Request Example

http://<server-url>/PoolParty/api/thesaurus/<project-Id>/deleteNote?concept=http://rockefeller.poolparty.biz/Eurovoc/8&bNodeId=node1a728uifrx8

Web Service Method: Request Concept Notes

Abstract

Web Service Method: Request Concept Notes

Description
Returns a list of notes of a concept.

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

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

Notes of the requested concept.

Attribute	Type	Comment
`uri`	String	URI of the concept
`title`	String	Preferred label
`comment`	Strings	Alternative labels
`created`	Strings	Hidden labels
`creator`	Strings	Definitions
`type`	Strings	Broader concepts

URL Pattern

http://<server-url>/PoolParty/api/thesaurus/<projectID>/notes?concept=<concept-uri>

Example

GET Request

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

Example Response

[
    {
        "uri": "node1a728uifrx4",
        "title": "Test history note",
        "comment": "This note describes the history",
        "created": "2015-12-21T16:50:16Z",
        "creator": "huberf",
        "type": "http://www.w3.org/2004/02/skos/core#historyNote"
    },
    {
        "uri": "node1a728uifrx3",
        "title": "An editorial note",
        "comment": "Containing editorial description.",
        "created": "2015-12-21T16:49:42Z",
        "creator": "huberf",
        "type": "http://www.w3.org/2004/02/skos/core#editorialNote"
    },
    {
        "uri": "node1a728uifrx2",
        "title": "A change note",
        "comment": "With description of latest change",
        "created": "2015-12-21T16:49:21Z",
        "creator": "huberf",
        "type": "http://www.w3.org/2004/02/skos/core#changeNote"
    }
]

In this section: