Get endpoint¶

Endpoint for retrieving SKOS concepts by their unique identifier.

GET /get¶

Get SKOS concepts by their URI

Example request:

GET /get?uri=http://id.worldcat.org/fast/869764 HTTP/1.1
Host: 127.0.0.1
Accept: application/json

Example request with multiple URIs:

GET /get?uri=http://id.worldcat.org/fast/1902995&uri=http://id.worldcat.org/fast/869764
Host: 127.0.0.1
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "_links":
        {"self":
            {"href":"/search?uri=http://id.worldcat.org/fast/1902995&uri=http://id.worldcat.org/fast/869764"}},
    "_embedded":
        {"concepts":
            [{"uri":"http://id.worldcat.org/fast/1902995",
            "prefLabel":"Depressions in motion pictures",
            "altLabels":[],"related":[]},
            {"uri":"http://id.worldcat.org/fast/869764",
            "prefLabel":"Commodore 64 (Computer)",
            "altLabels":[],
            "related":[{"label":"Electronic digital computers","uri":"http://id.worldcat.org/fast/907122"},{"label":"Commodore computers","uri":"http://id.worldcat.org/fast/869771"}]}
]}}

Expect the same response if only one concept is requested (i.e. a list of one concept).

Query Parameters:
	uri – unique identifier of a SKOS concept
Status Codes:	200 OK – request done 400 Bad Request – Bad request (if you don’t pass the parameter) 500 Internal Server Error – an exception occured

Search endpoint¶

Endpoint for searching SKOS concepts

GET /search¶

Search for SKOS concepts by labels

Example request:

GET /search?q=http HTTP/1.1
Host: 127.0.0.1
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{"concepts":[
    {"uri":"http://id.worldcat.org/fast/950001",
    "prefLabel":"HTTP (Computer network protocol)",
    "altLabels":["HyperText Transfer Protocol (Computer network protocol)"],
    "related":[
        {"label":"Computer network protocols",
        "uri":"http://id.worldcat.org/fast/872279"}
    ]},
    {"uri":"http://id.worldcat.org/fast/878049",
    "prefLabel":"Cookies (Computer science)",
    "altLabels":["Persistent cookies (Computer science)","HTTP cookies (Computer science)","Magic cookies (Computer science)"],
    "related":[
        {"label":"Data structures (Computer science)",
        "uri":"http://id.worldcat.org/fast/887978"}]}
    ]
}

Query Parameters:
	q – search query count – number of results page – page (pagination)
Status Codes:	200 OK – request done 400 Bad Request – Bad request (if you don’t pass the parameter) 404 Not Found – Not found 500 Internal Server Error – an exception occured

Suggest endpoint¶

Endpoint for suggesting SKOS concepts

Mainly used for type-ahead

GET /suggest¶

Suggest SKOS concepts

Example request:

GET /suggest?q=secu HTTP/1.1
Host: 127.0.0.1
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{"concepts":[
    {"uri":"http://id.worldcat.org/fast/872484","prefLabel":"Computer security","altLabels":[],"related":[]},
    {"uri":"http://id.worldcat.org/fast/869774","prefLabel":"Common Data Security Architecture (Computer security standard)","altLabels":[],"related":[]},
    {"uri":"http://id.worldcat.org/fast/1005142","prefLabel":"Macintosh (Computer)--Security measures","altLabels":[],"related":[]},
    {"uri":"http://id.worldcat.org/fast/872590","prefLabel":"Computer software--Security measures","altLabels":[],"related":[]},
    {"uri":"http://id.worldcat.org/fast/872437","prefLabel":"Computer programs--Security measures","altLabels":[],"related":[]},
    {"uri":"http://id.worldcat.org/fast/872486","prefLabel":"Computer security--Computer programs","altLabels":[],"related":[]},
    {"uri":"http://id.worldcat.org/fast/872485","prefLabel":"Computer security--Auditing","altLabels":[],"related":[]},
    {"uri":"http://id.worldcat.org/fast/925719","prefLabel":"Firewalls (Computer security)","altLabels":[],"related":[]},
    {"uri":"http://id.worldcat.org/fast/872487","prefLabel":"Computer security--Costs","altLabels":[],"related":[]},
    {"uri":"http://id.worldcat.org/fast/872488","prefLabel":"Computer security--Evaluation","altLabels":[],"related":[]}]
}

Query Parameters:
	q – search query count – number of results page – page (pagination)
Status Codes:	200 OK – request done 400 Bad Request – Bad request (if you don’t pass the parameter) 404 Not Found – Not found 500 Internal Server Error – an exception occured

RDF file importer¶

Imports SKOS concepts from an RDF file. This is the recommended method if you have a small dataset as it is easier to use.

Jena TDB importer¶

Imports SKOS concepts from a Jena TDB dataset. This is the recommended method if you have a fairly large dataset (e.g. FAST (Faceted Application of Subject Terminology) topics).

Javadoc¶