{"info":{"_postman_id":"ddf11a6d-2055-4914-bd3a-a4379ddb96a4","name":"zzz Archived - PoolParty API - Basic ReadOnly Examples Collection","description":"

Basic set of PoolParty API requests

Full documentation of the PoolParty API you can find here: PoolParty Developer API Guide

Credentials needed to execute the presented example requests need to be inserted in the Postman environment: {username} {password}

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Basic set of PoolParty API requests","slug":"basic-set-of-poolparty-api-requests"}],"owner":"304363","collectionId":"ddf11a6d-2055-4914-bd3a-a4379ddb96a4","publishedId":"RWEdsf2v","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"2B2B2C","highlight":"25AAE1"},"publishDate":"2019-05-08T13:37:53.000Z"},"item":[{"name":"Request Concept Schemes of a Project","event":[{"listen":"test","script":{"id":"085978b4-9aaf-461b-9612-c97c4a94702b","type":"text/javascript","exec":[""]}}],"id":"3d7afba9-b42d-470c-a2ba-9d2079c5529c","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic aHViZXJmOmh1YmVwcGh1YmVwcA=="},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"{{url}}/PoolParty/api/thesaurus/{{project}}/schemes?properties=http://purl.org/dc/terms/publisher, http://purl.org/dc/terms/description, http://purl.org/dc/terms/creator, http://purl.org/dc/terms/created, http://purl.org/dc/terms/title, http://schema.semantic-web.at/ppt/appliedType?properties=http://purl.org/dc/terms/publisher, http://purl.org/dc/terms/description, http://purl.org/dc/terms/creator, http://purl.org/dc/terms/created, http://purl.org/dc/terms/title, http://schema.semantic-web.at/ppt/appliedType","description":"

Returns a list of all concept schemes in the given project

docu

\n","urlObject":{"path":["PoolParty","api","thesaurus","{{project}}","schemes"],"host":["{{url}}"],"query":[{"key":"properties","value":"http://purl.org/dc/terms/publisher, http://purl.org/dc/terms/description, http://purl.org/dc/terms/creator, http://purl.org/dc/terms/created, http://purl.org/dc/terms/title, http://schema.semantic-web.at/ppt/appliedType"}],"variable":[]}},"response":[],"_postman_id":"3d7afba9-b42d-470c-a2ba-9d2079c5529c"},{"name":"Request Top Concepts of a Concept Scheme","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Successful POST request\"] = responseCode.code === 200;","","// remove previous url","postman.clearEnvironmentVariable(\"topConceptUrl\");","","// response is url as String. Double quotes have to be removed.","var url = responseBody;","url = url.replace(/['\"]+/g, '');","postman.setEnvironmentVariable(\"topConceptUrl\", url);"]}}],"id":"24ae786f-0ae6-467f-8021-b9e84c3197d7","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic aHViZXJmOmh1YmVwcHBw"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"{{url}}/PoolParty/api/thesaurus/{{project}}/topconcepts?scheme={{conceptScheme}}&language=en","description":"

Returns a list of top concepts for a concept scheme

docu

\n","urlObject":{"path":["PoolParty","api","thesaurus","{{project}}","topconcepts"],"host":["{{url}}"],"query":[{"key":"scheme","value":"{{conceptScheme}}"},{"key":"language","value":"en"}],"variable":[]}},"response":[],"_postman_id":"24ae786f-0ae6-467f-8021-b9e84c3197d7"},{"name":"Request Top Concepts of a Concept Scheme - collecting all property data","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Successful POST request\"] = responseCode.code === 200;","","// remove previous url","postman.clearEnvironmentVariable(\"topConceptUrl\");","","// response is url as String. Double quotes have to be removed.","var url = responseBody;","url = url.replace(/['\"]+/g, '');","postman.setEnvironmentVariable(\"topConceptUrl\", url);"]}}],"id":"d872b76f-827e-4385-9c44-704c3977a616","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic aHViZXJmOmh1YmVwcHBw"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"{{url}}/PoolParty/api/thesaurus/{{project}}/topconcepts?scheme={{conceptScheme}}&language=en&properties=all","description":"

Returns a list of top concepts for a concept scheme

docu

\n","urlObject":{"path":["PoolParty","api","thesaurus","{{project}}","topconcepts"],"host":["{{url}}"],"query":[{"key":"scheme","value":"{{conceptScheme}}"},{"key":"language","value":"en"},{"key":"properties","value":"all"}],"variable":[]}},"response":[],"_postman_id":"d872b76f-827e-4385-9c44-704c3977a616"},{"name":"Request Subtree of Concept or Concept Scheme","id":"fc388ee1-f732-4f93-b941-707e98e10b18","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/PoolParty/api/thesaurus/{{project}}/subtree?root={{conceptScheme}}&properties=skos:definition","description":"

Returns a list of all narrower concepts (recursively) of a given concept or concept scheme

docu

\n","urlObject":{"path":["PoolParty","api","thesaurus","{{project}}","subtree"],"host":["{{url}}"],"query":[{"key":"root","value":"{{conceptScheme}}"},{"key":"properties","value":"skos:definition"}],"variable":[]}},"response":[],"_postman_id":"fc388ee1-f732-4f93-b941-707e98e10b18"},{"name":"Request Paths Between Concept and Concept Schemes","id":"48ba6b61-4774-4c1b-9e7f-8cc506dfe470","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/PoolParty/api/thesaurus/{{project}}/getPaths?concept={{concept-Fireball}}&properties=skos:definition","description":"

Returns a list of all existing paths between the requested concept and all concept schemes it is located in

docu

\n","urlObject":{"path":["PoolParty","api","thesaurus","{{project}}","getPaths"],"host":["{{url}}"],"query":[{"key":"concept","value":"{{concept-Fireball}}"},{"key":"properties","value":"skos:definition"}],"variable":[]}},"response":[],"_postman_id":"48ba6b61-4774-4c1b-9e7f-8cc506dfe470"},{"name":"Request a Concept's Details","id":"a52f5501-4dd4-49e1-a09f-51ef536f0d7e","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/PoolParty/api/thesaurus/{{project}}/concept?concept={{concept-Margarita}}&properties=all","description":"

Returns details of a single concept

docu

\n","urlObject":{"path":["PoolParty","api","thesaurus","{{project}}","concept"],"host":["{{url}}"],"query":[{"key":"concept","value":"{{concept-Margarita}}"},{"key":"properties","value":"all"}],"variable":[]}},"response":[],"_postman_id":"a52f5501-4dd4-49e1-a09f-51ef536f0d7e"},{"name":"Request Suggested Concepts of a Project","id":"c8947c97-8220-404f-810d-4ce5e4fc2547","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic aHViZXJmOmh1YmVwcHBw"}],"body":{"mode":"raw","raw":"{\n \"conceptSuggestRequests\" : [ {\n \"prefLabels\" : [ {\n \"language\" : \"en\",\n \"label\" : \"some label\"\n }, {\n \"language\" : \"de\",\n \"label\" : \"some label\"\n } ],\n \"note\" : \"some note\",\n \"score\" : 0.75294167,\n \"broaderConcept\" : [ {\n \"uri\" : \"http://testing.com/testID/2\"\n } ],\n \"checkForDuplicates\" : true,\n \"definition\" : [ {\n \"language\" : \"en\",\n \"label\" : \"some definition\"\n } ]\n },\n{\n \"prefLabels\" : [ {\n \"language\" : \"en\",\n \"label\" : \"another label\"\n }, {\n \"language\" : \"de\",\n \"label\" : \"das nächste label\"\n } ],\n \"note\" : \"another note\",\n \"broaderConcept\" : [ {\n \"uri\" : \"http://testing.com/testID/1\"\n } ],\n \"checkForDuplicates\" : true,\n \"definition\" : [ {\n \"language\" : \"en\",\n \"label\" : \"definition test content 2\"\n } ]\n } ]\n}\n\n\n"},"url":"{{url}}/PoolParty/api/thesaurus/{{project}}/suggestedConcepts","description":"

Returns the list of suggested concepts for the specified project

docu

\n","urlObject":{"path":["PoolParty","api","thesaurus","{{project}}","suggestedConcepts"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8947c97-8220-404f-810d-4ce5e4fc2547"},{"name":"Request the History of a Project","event":[{"listen":"test","script":{"id":"f2ce0741-0f2d-4784-9be3-9c32eff4ef3b","exec":[""],"type":"text/javascript"}}],"id":"fc861a09-20db-4226-a195-2261befce3c6","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic aHViZXJmOmh1YmVwcHBw"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"{{url}}/PoolParty/api/history/{{project}}?fromTime=2017-06-01T12:00:00&toTime=2020-08-01T12:00:00","description":"

Returns history events of a specific project

docu

\n","urlObject":{"path":["PoolParty","api","history","{{project}}"],"host":["{{url}}"],"query":[{"key":"fromTime","value":"2017-06-01T12:00:00"},{"key":"toTime","value":"2020-08-01T12:00:00"}],"variable":[]}},"response":[],"_postman_id":"fc861a09-20db-4226-a195-2261befce3c6"},{"name":"Check Extraction Model","id":"0a75da99-bf79-4fe0-994e-4e1f3a393096","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic aHViZXJmOmh1YmVwcHBw"}],"body":{"mode":"raw","raw":"{\n \"conceptSuggestRequests\" : [ {\n \"prefLabels\" : [ {\n \"language\" : \"en\",\n \"label\" : \"some label\"\n }, {\n \"language\" : \"de\",\n \"label\" : \"some label\"\n } ],\n \"note\" : \"some note\",\n \"score\" : 0.75294167,\n \"broaderConcept\" : [ {\n \"uri\" : \"http://testing.com/testID/2\"\n } ],\n \"checkForDuplicates\" : true,\n \"definition\" : [ {\n \"language\" : \"en\",\n \"label\" : \"some definition\"\n } ]\n },\n{\n \"prefLabels\" : [ {\n \"language\" : \"en\",\n \"label\" : \"another label\"\n }, {\n \"language\" : \"de\",\n \"label\" : \"das nächste label\"\n } ],\n \"note\" : \"another note\",\n \"broaderConcept\" : [ {\n \"uri\" : \"http://testing.com/testID/1\"\n } ],\n \"checkForDuplicates\" : true,\n \"definition\" : [ {\n \"language\" : \"en\",\n \"label\" : \"definition test content 2\"\n } ]\n } ]\n}\n\n\n"},"url":"{{url}}/PoolParty/api/indexbuilder/{{project}}","description":"

Checks whether the project's extraction model is up-to-date

docu

\n","urlObject":{"path":["PoolParty","api","indexbuilder","{{project}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a75da99-bf79-4fe0-994e-4e1f3a393096"},{"name":"Extract from Text","id":"d9779b42-fb33-4b62-bd04-0dcf9181b7cf","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic aHViZXJmOmh1YmVwcHBw"}],"body":{"mode":"raw","raw":"{\n \"conceptSuggestRequests\" : [ {\n \"prefLabels\" : [ {\n \"language\" : \"en\",\n \"label\" : \"some label\"\n }, {\n \"language\" : \"de\",\n \"label\" : \"some label\"\n } ],\n \"note\" : \"some note\",\n \"score\" : 0.75294167,\n \"broaderConcept\" : [ {\n \"uri\" : \"http://testing.com/testID/2\"\n } ],\n \"checkForDuplicates\" : true,\n \"definition\" : [ {\n \"language\" : \"en\",\n \"label\" : \"some definition\"\n } ]\n },\n{\n \"prefLabels\" : [ {\n \"language\" : \"en\",\n \"label\" : \"another label\"\n }, {\n \"language\" : \"de\",\n \"label\" : \"das nächste label\"\n } ],\n \"note\" : \"another note\",\n \"broaderConcept\" : [ {\n \"uri\" : \"http://testing.com/testID/1\"\n } ],\n \"checkForDuplicates\" : true,\n \"definition\" : [ {\n \"language\" : \"en\",\n \"label\" : \"definition test content 2\"\n } ]\n } ]\n}\n\n\n"},"url":"{{url}}/extractor/api/extract?projectId={{project}}&title=Perfect Negroni&text=Some may say there’s no better fix than the bitterly complex flavours of a negroni that come together with such ease, which could be one of the reasons it’s been inspiring countless variations for close to a century.\nToday, two Italian mixologists have created Seven Hills Italian Dry Gin, which they cite as the perfect Italian gin for the perfect negroni. An aromatic spirit, with citrus and herbal notes, the inspiration for the ingredients dates back to when Romans used to add juniper to their wine to help them gain an appetite, hence the aperitivo. Saluti!\nIngredients: 30ml Seven Hills Gin, 15ml Campari, 15ml Antica Formula Carpano Vermouth.\nMethod: Half fill a mixing glass with ice. Add the gin, Campari and vermouth. Stir well, then strain into an old-fashioned glass. Garnish with a twist of grapefruit.&filterNestedConcepts=true&numberOfTerms=2&numberOfConcepts=6","description":"

Extracts and returns meaningful metadata like concepts and terms from a given text

docu

\n","urlObject":{"path":["extractor","api","extract"],"host":["{{url}}"],"query":[{"key":"projectId","value":"{{project}}"},{"key":"title","value":"Perfect Negroni"},{"key":"text","value":"Some may say there’s no better fix than the bitterly complex flavours of a negroni that come together with such ease, which could be one of the reasons it’s been inspiring countless variations for close to a century.\nToday, two Italian mixologists have created Seven Hills Italian Dry Gin, which they cite as the perfect Italian gin for the perfect negroni. An aromatic spirit, with citrus and herbal notes, the inspiration for the ingredients dates back to when Romans used to add juniper to their wine to help them gain an appetite, hence the aperitivo. Saluti!\nIngredients: 30ml Seven Hills Gin, 15ml Campari, 15ml Antica Formula Carpano Vermouth.\nMethod: Half fill a mixing glass with ice. Add the gin, Campari and vermouth. Stir well, then strain into an old-fashioned glass. Garnish with a twist of grapefruit."},{"key":"filterNestedConcepts","value":"true"},{"key":"numberOfTerms","value":"2"},{"key":"numberOfConcepts","value":"6"}],"variable":[]}},"response":[],"_postman_id":"d9779b42-fb33-4b62-bd04-0dcf9181b7cf"}],"event":[{"listen":"prerequest","script":{"id":"69261543-3f6e-4461-9448-3518bedbe5d2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2ab31e5f-1ae9-4869-9870-d49d1242fc8c","type":"text/javascript","exec":[""]}}]}