Skip to main content

Web Service Method: Request Broader Concepts

Abstract

Web Service Method: Request Broader Concepts

Description

Returns a list of direct broader concepts of the given concept.

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

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

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.

String

false

language

Only broader concepts with labels in this language will be displayed. If no language is given, the default language of the project will be used.

String

false

transitive

If true, all transitive broader concepts are returned instead of only direct broader concepts.

Note

Concept schemes are not returned with this request. When you want to retrieve full hierarchy path of a concept it is recommended to useWeb Service Method: Request Paths Between Concept and Concept Schemesinstead.

boolean

false

workflowStatus

Set to true in case a workflow is applied and workflow status should be retrieved. Default is false. See details: Using Workflow Status Information

boolean

false

Response

Array of concepts of the selected PoolParty project.

Attribute

Type

Comment

uri

String

URI of the concept

prefLabel

String

Preferred label

altLabels

Array of Strings

Alternative labels

hiddenLabels

Array of Strings

Hidden labels

definitions

Array of Strings

Definitions

Request Pattern

http://<server-url>/PoolParty/api/thesaurus/<project>/broaders?concept=<concept>
Examples

Example Request

http://vocabulary.semantic-web.at/PoolParty/api/thesaurus/cocktails/broaders?concept=http://vocabulary.semantic-web.at/cocktails/2d85fb1b-96cb-4c48-8df5-707032f34e71&properties=all

Example Response

[
  {
    "uri": "http://vocabulary.semantic-web.at/cocktails/b9bf3799-a4e4-47f7-9aea-7697cc998a34",
    "prefLabel": "Contemporary Classics",
    "broaders": [
      "http://vocabulary.semantic-web.at/cocktails/5ac37bec-e4b9-4d43-9bcc-8d6954903c25"
    ],
    "narrowers": [
      "http://vocabulary.semantic-web.at/cocktails/0f8cc862-9056-49be-b636-cd22f8d7282d",
      "http://vocabulary.semantic-web.at/cocktails/117bd4d2-6da3-4d69-8c79-bc1d873b5010",
      "http://vocabulary.semantic-web.at/cocktails/12f4790a-560f-4e1c-b57a-53b8171ae39a",
      "http://vocabulary.semantic-web.at/cocktails/13b85b5c-7f69-4871-bb08-3cd5281f6039",
      "http://vocabulary.semantic-web.at/cocktails/1529fd23-9c55-45d7-b8c6-b0fc229a3871",
      "http://vocabulary.semantic-web.at/cocktails/268fb62f-8ef1-45cd-844f-8c7da85a6a0b",
      "http://vocabulary.semantic-web.at/cocktails/2c032fe6-a518-44be-851a-dbf1c253be63",
      "http://vocabulary.semantic-web.at/cocktails/2d85fb1b-96cb-4c48-8df5-707032f34e71",
      "http://vocabulary.semantic-web.at/cocktails/33d9a47f-0622-4b0f-ad1b-62eb96fc6799",
      "http://vocabulary.semantic-web.at/cocktails/43111fc3-3b59-420c-a588-024cd2d33896",
      "http://vocabulary.semantic-web.at/cocktails/45788a96-1fde-486b-80fc-31ad243bba31",
      "http://vocabulary.semantic-web.at/cocktails/4792b0b8-0046-47ca-8c2a-f3ad58922182",
      "http://vocabulary.semantic-web.at/cocktails/4f85cadd-4fd4-4ffc-a78d-cddb0763fa4b",
      "http://vocabulary.semantic-web.at/cocktails/52117ab2-dcb8-4d28-a366-ddd932e58219",
      "http://vocabulary.semantic-web.at/cocktails/55c40695-8b41-41ed-8c6a-70fe6930067e",
      "http://vocabulary.semantic-web.at/cocktails/61a18ebf-fd92-4ef1-8ab1-bfd3c26867b9",
      "http://vocabulary.semantic-web.at/cocktails/698723d7-e8b8-410e-91a8-9bdc867b3f8a",
      "http://vocabulary.semantic-web.at/cocktails/926b14fe-1b83-4f46-bbf9-f946be1889aa",
      "http://vocabulary.semantic-web.at/cocktails/a73d88e9-0c50-45d2-b364-9dec5abe206d",
      "http://vocabulary.semantic-web.at/cocktails/b8075344-1e6d-4348-bdee-83948203a974",
      "http://vocabulary.semantic-web.at/cocktails/bca7bc6d-6709-48b8-ae52-fe194c212398",
      "http://vocabulary.semantic-web.at/cocktails/bee1e709-b317-4f46-b06f-a22367baefdf",
      "http://vocabulary.semantic-web.at/cocktails/c2249dc0-0529-4a11-ad82-5d710b5e9c31",
      "http://vocabulary.semantic-web.at/cocktails/c3b197cc-8583-4e2f-8e45-3a7fed1309c1",
      "http://vocabulary.semantic-web.at/cocktails/c8f4f6bd-4ac1-456a-a3aa-595e4b93d979",
      "http://vocabulary.semantic-web.at/cocktails/ce8f4591-ccd4-4d90-a761-244115d64061",
      "http://vocabulary.semantic-web.at/cocktails/dff0a7f4-ded0-48d5-bd31-881b70fbe36a",
      "http://vocabulary.semantic-web.at/cocktails/ea946e07-e812-4492-a0ed-124d73bfbba7",
      "http://vocabulary.semantic-web.at/cocktails/eddf4894-1683-44e9-9ee3-7920d3729d71",
      "http://vocabulary.semantic-web.at/cocktails/f01f6a10-01a5-4810-860f-d3a52fd36b1b"
    ],
    "inSchemes": [
      "http://vocabulary.semantic-web.at/cocktails/8d052dfc-44bf-4985-8ce3-4564570a161b"
    ],
    "properties": {
      "http://purl.org/dc/terms/creator": [
        "http://localhost/user/blumauera"
      ],
      "http://purl.org/dc/terms/created": [
        "2015-05-01T07:35:30Z"
      ],
      "http://purl.org/dc/terms/modified": [
        "2017-04-26T11:40:54Z"
      ],
      "http://purl.org/dc/terms/contributor": [
        "http://localhost/user/turdeant"
      ],
      "http://www.w3.org/1999/02/22-rdf-syntax-ns#type": [
        "http://vocabulary.semantic-web.at/cocktail-ontology/Cocktail",
        "http://www.w3.org/2004/02/skos/core#Concept"
      ]
    }
  },
  {
    "uri": "http://vocabulary.semantic-web.at/cocktails/7516b400-963a-4151-8fdc-f6b23bad1dd5",
    "prefLabel": "Sour",
    "altLabels": [
      "Sour Cocktail"
    ],
    "definitions": [
      "A sour is a traditional family of mixed drinks; the word itself is often used as a post-positive adjective when in the name of a drink. Common examples of sours are the margarita and the sidecar. Sours belong to one of the old families of original cocktails and are described by Jerry Thomas in his 1862 book How to Mix Drinks. Sours are mixed drinks containing a base liquor (bourbon or some other whiskey in the case of a whiskey sour), lemon or lime juice, egg white, and a sweetener."
    ],
    "narrowers": [
      "http://vocabulary.semantic-web.at/cocktails/2d85fb1b-96cb-4c48-8df5-707032f34e71",
      "http://vocabulary.semantic-web.at/cocktails/36671f9c-904a-4629-937a-519d094ecefc",
      "http://vocabulary.semantic-web.at/cocktails/43b786b6-a1f1-4b7f-a5d9-be43d386ffb4",
      "http://vocabulary.semantic-web.at/cocktails/53a05366-d473-4eb4-ac66-0d0119e0b759",
      "http://vocabulary.semantic-web.at/cocktails/76c0e55c-22df-4489-9551-4fe8a6a649f8",
      "http://vocabulary.semantic-web.at/cocktails/7e4a73d5-f73d-4890-972c-f3dfd6952fd8",
      "http://vocabulary.semantic-web.at/cocktails/a47e8f08-057a-45f2-8398-9be51ed351fc",
      "http://vocabulary.semantic-web.at/cocktails/b33091cd-8c57-45e3-a89b-9de91ffce1e8",
      "http://vocabulary.semantic-web.at/cocktails/bab016bd-2fd5-4809-bfe7-3225d25f116d",
      "http://vocabulary.semantic-web.at/cocktails/bca7bc6d-6709-48b8-ae52-fe194c212398",
      "http://vocabulary.semantic-web.at/cocktails/c151ee28-45d2-4128-8587-1f1b69060d9d",
      "http://vocabulary.semantic-web.at/cocktails/e039633b-03c1-47bd-a705-a104a4323e45"
    ],
    "inSchemes": [
      "http://vocabulary.semantic-web.at/cocktails/8d052dfc-44bf-4985-8ce3-4564570a161b"
    ],
    "topConceptOf": [
      "http://vocabulary.semantic-web.at/cocktails/8d052dfc-44bf-4985-8ce3-4564570a161b"
    ],
    "exactMatch": [
      "http://dbpedia.org/resource/Sour_(cocktail)"
    ],
    "properties": {
      "http://purl.org/dc/terms/creator": [
        "http://localhost/user/blumauera"
      ],
      "http://purl.org/dc/terms/created": [
        "2015-05-01T14:35:10Z"
      ],
      "http://purl.org/dc/terms/modified": [
        "2017-04-26T11:40:55Z"
      ],
      "http://purl.org/dc/terms/contributor": [
        "http://localhost/user/turdeant"
      ],
      "http://www.w3.org/1999/02/22-rdf-syntax-ns#type": [
        "http://vocabulary.semantic-web.at/cocktail-ontology/Cocktail",
        "http://www.w3.org/2004/02/skos/core#Concept"
      ]
    }
  }
]