Skip to main content

Web Service Method: Request Blacklisted Concepts

Abstract

Web Service Method: Request Blacklisted Concepts

Description

Returns a list of concepts that are blacklisted.

Note

This service is an equivalent to the functionality of reviewing Blacklist Concepts and Terms in the user interface.

URL: /PoolParty/api/corpusmanagement/{project}/results/blacklist/concepts

Request

Supported Methods

GET

Path Variables

Variable

Comment

{project}

The UUID or the URI supplement (textual identifier) of the project to be used.

Response

Returns

Array of blacklisted concepts.

Attribute

Type

Comment

Required

startIndex

String

Index of first blacklisted concept. The service retrieves 20 concepts, starting with the given startIndex.

Default value is 0.

false

URL Pattern

https://{server-url}/PoolParty/api/corpusmanagement/{project-id}/results/blacklist/concepts

Examples

Example Request 

https://workingontologist.poolparty.biz/PoolParty/api/corpusmanagement/1DDFD0C2-5CF8-0001-A83E-300711A0150B/results/blacklist/concepts

Example Response 

[
 {
 "uri": {
 "uri": "https://workingontologist.poolparty.biz/newsUseCaseProject/2b830007-b08e-4e0c-8bcf-894d982c8399"
 },
 "prefLabels": [
 {
 "label": "Artists",
 "datatype": {
 "uri": "http://www.w3.org/1999/02/22-rdf-syntax-ns#langString"
 },
 "language": "en"
 }
 ],
 "altLabels": [],
 "hiddenLabels": [],
 "definitions": [],
 "scopeNotes": [],
 "examples": [],
 "notations": [],
 "excluded": true,
 "orderedBy": [],
 "skosXlPrefLabels": [],
 "skosXlAltLabels": [],
 "skosXlHiddenLabels": [],
 "propagateType": null,
 "appliedType": null,
 "allSkosXlLabels": []
 },
 {
 "uri": {
 "uri": "https://workingontologist.poolparty.biz/newsUseCaseProject/3e889c8a-b09e-4e2c-82cd-99bff522083b"
 },
 "prefLabels": [
 {
 "label": "Politicians",
 "datatype": {
 "uri": "http://www.w3.org/1999/02/22-rdf-syntax-ns#langString"
 },
 "language": "en"
 }
 ],
 "altLabels": [],
 "hiddenLabels": [],
 "definitions": [],
 "scopeNotes": [],
 "examples": [],
 "notations": [],
 "excluded": true,
 "orderedBy": [],
 "skosXlPrefLabels": [],
 "skosXlAltLabels": [],
 "skosXlHiddenLabels": [],
 "propagateType": null,
 "appliedType": null,
 "allSkosXlLabels": []
 }
]
In this section: