Read Vocabulary List

This example request illustrates how to get a vocabulary list.

JSON

Request

GET /platform/vocab/lists/LA123
Accept-Language: en
Accept: application/ld+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/ld+json
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Content-location: /platform/vocab/lists/LA123
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-transform, max-age=604800
Transfer-encoding: chunked{
  "id" : "LA123",
  "@id" : "https://test.com/vocab/lists/LA123",
  "title" : "My garden",
  "description" : "The vegetables in my garden",
  "elements" : [ {
    "id" : "1231",
    "@id" : "https://test.com/vocab/terms/1231",
    "subclassOf" : "https://test.com/vocab/terms/ABC",
    "type" : "https://test.com/vocab/terms/official",
    "labels" : [ {
      "@language" : "en",
      "@value" : "carrot"
    } ],
    "descriptions" : [ {
      "@language" : "en",
      "@value" : "English carrot"
    } ]
  }, {
    "id" : "1232",
    "@id" : "https://test.com/vocab/terms/1232",
    "subclassOf" : "https://test.com/vocab/terms/ABC",
    "type" : "https://test.com/vocab/terms/official"
  }, {
    "id" : "1233",
    "@id" : "https://test.com/vocab/terms/1233",
    "subclassOf" : "https://test.com/vocab/terms/ABC",
    "type" : "https://test.com/vocab/terms/official",
    "labels" : [ {
      "@language" : "en",
      "@value" : "pea"
    } ],
    "descriptions" : [ {
      "@language" : "en",
      "@value" : "English pea"
    } ]
  }, {
    "id" : "1234",
    "@id" : "https://test.com/vocab/terms/1234",
    "subclassOf" : "https://test.com/vocab/terms/ABC",
    "type" : "https://test.com/vocab/terms/official",
    "labels" : [ {
      "@language" : "en",
      "@value" : "corn"
    } ],
    "descriptions" : [ {
      "@language" : "en",
      "@value" : "English corn"
    } ]
  }, {
    "id" : "1235",
    "@id" : "https://test.com/vocab/terms/1235",
    "subclassOf" : "https://test.com/vocab/terms/ABC",
    "type" : "https://test.com/vocab/terms/official",
    "labels" : [ {
      "@language" : "en",
      "@value" : "lettuce"
    } ],
    "descriptions" : [ {
      "@language" : "en",
      "@value" : "English lettuce"
    } ]
  } ],
  "http://www.w3.org/1999/02/22-rdf-syntax-ns#_1" : {
    "@id" : "https://test.com/vocab/terms/1231"
  },
  "http://www.w3.org/1999/02/22-rdf-syntax-ns#_2" : {
    "@id" : "https://test.com/vocab/terms/1232"
  },
  "http://www.w3.org/1999/02/22-rdf-syntax-ns#_3" : {
    "@id" : "https://test.com/vocab/terms/1233"
  },
  "http://www.w3.org/1999/02/22-rdf-syntax-ns#_4" : {
    "@id" : "https://test.com/vocab/terms/1234"
  },
  "http://www.w3.org/1999/02/22-rdf-syntax-ns#_5" : {
    "@id" : "https://test.com/vocab/terms/1235"
  },
  "@context" : {
    "title" : "http://purl.org/dc/terms/title",
    "description" : "http://purl.org/dc/terms/description",
    "elements" : {
      "@id" : "http://purl.org/dc/terms/hasPart",
      "@container" : "@list"
    },
    "id" : {
      "@id" : "http://purl.org/dc/terms/identifier"
    },
    "subclassOf" : {
      "@id" : "http://www.w3.org/2000/01/rdf-schema#subClassOf",
      "@type" : "@id"
    },
    "references" : {
      "@id" : "http://purl.org/dc/terms/references",
      "@type" : "@id"
    },
    "type" : {
      "@id" : "http://purl.org/dc/terms/type",
      "@type" : "@id"
    },
    "labels" : {
      "@id" : "http://www.w3.org/2000/01/rdf-schema#label"
    },
    "descriptions" : {
      "@id" : "http://www.w3.org/2000/01/rdf-schema#comment"
    }
  }
}

XML

Request

GET /platform/vocab/lists/LA123
Accept-Language: en
Accept: application/rdf+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/rdf+xml
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Content-location: /platform/vocab/lists/LA123
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-transform, max-age=604800
Transfer-encoding: chunked<?xml version='1.0' encoding='UTF-8'?>
<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xmlns:dc="http://purl.org/dc/terms/" xmlns:xml="http://www.w3.org/XML/1998/namespace">
  <Description about="https://test.com/vocab/lists/LA123">
    <type resource="http://www.w3.org/1999/02/22-rdf-syntax-ns#Seq"/>
    <dc:title>My garden</dc:title>
    <dc:description>The vegetables in my garden</dc:description>
    <dc:identifier>LA123</dc:identifier>
    <dc:hasPart parseType="Collection">
      <Description about="https://test.com/vocab/terms/1231"/>
      <Description about="https://test.com/vocab/terms/1232"/>
      <Description about="https://test.com/vocab/terms/1233"/>
      <Description about="https://test.com/vocab/terms/1234"/>
      <Description about="https://test.com/vocab/terms/1235"/>
    </dc:hasPart>
    <li>
      <Description about="https://test.com/vocab/terms/1231">
        <dc:identifier>1231</dc:identifier>
        <rdfs:subClassOf resource="https://test.com/vocab/terms/ABC"/>
        <dc:type resource="https://test.com/vocab/terms/official"/>
        <rdfs:label xml:lang="en">carrot</rdfs:label>
        <rdfs:comment xml:lang="en">English carrot</rdfs:comment>
      </Description>
    </li>
    <li>
      <Description about="https://test.com/vocab/terms/1232">
        <dc:identifier>1232</dc:identifier>
        <rdfs:subClassOf resource="https://test.com/vocab/terms/ABC"/>
        <dc:type resource="https://test.com/vocab/terms/official"/>
      </Description>
    </li>
    <li>
      <Description about="https://test.com/vocab/terms/1233">
        <dc:identifier>1233</dc:identifier>
        <rdfs:subClassOf resource="https://test.com/vocab/terms/ABC"/>
        <dc:type resource="https://test.com/vocab/terms/official"/>
        <rdfs:label xml:lang="en">pea</rdfs:label>
        <rdfs:comment xml:lang="en">English pea</rdfs:comment>
      </Description>
    </li>
    <li>
      <Description about="https://test.com/vocab/terms/1234">
        <dc:identifier>1234</dc:identifier>
        <rdfs:subClassOf resource="https://test.com/vocab/terms/ABC"/>
        <dc:type resource="https://test.com/vocab/terms/official"/>
        <rdfs:label xml:lang="en">corn</rdfs:label>
        <rdfs:comment xml:lang="en">English corn</rdfs:comment>
      </Description>
    </li>
    <li>
      <Description about="https://test.com/vocab/terms/1235">
        <dc:identifier>1235</dc:identifier>
        <rdfs:subClassOf resource="https://test.com/vocab/terms/ABC"/>
        <dc:type resource="https://test.com/vocab/terms/official"/>
        <rdfs:label xml:lang="en">lettuce</rdfs:label>
        <rdfs:comment xml:lang="en">English lettuce</rdfs:comment>
      </Description>
    </li>
  </Description>
</RDF>