Vocabularies

These are giving synonyms to search for or to mapping between data-models. They will deliver structured taxonomies.

Get all vocabulary schemes for a namespace

GET /:namespace/vocab/schemes

Params:
since (optional, datetime) Format: 2018-01-18T11:03:26.395Z
sort (optional, string) can be one of updated_at_asc or updated_at_desc
per_page (optional, integer) defaults to 30
page (integer) the page you want to display

Get a single scheme

GET /:namespace/vocab/schemes/:slug

--

Get all concepts nested under a scheme

GET /:namespace/vocab/schemes/:slug/concepts

Params:
since (optional, datetime) Format: 2018-01-18T11:03:26.395Z
sort (optional, string) can be one of updated_at_asc or updated_at_desc
per_page (optional, integer) defaults to 30
page (integer) the page you want to display
synsets if true only returns arrays of preferred, alternative and hidden labels of any language.

Get all concepts

GET /:namespace/vocab/concepts

Params:
in_scheme the :slug of a schema
since (optional, datetime) Format: 2018-01-18T11:03:26.395Z
sort (optional, string) can be one of updated_at_asc or updated_at_desc
per_page (optional, integer) defaults to 30
page (integer) the page you want to display
synsets if true only returns arrays of preferred, alternative and hidden labels of any language.

--

Get a single concept

GET /:namespace/vocab/schemes/:slug/concepts/:id

Params:
synsets if true only returns a single array of preferred, alternative and hidden labels of any language.

The concepts :id is a string like 'e7acaad6-0002-aca9-0daa'. The second block is unique to every concept in a scheme.

{
  concepts: [
    {
      id: "a8fc3ace-0004-b0a7-7d10",
      status: "Unstable",
      default_label: "Babylon",
      url: "http://localhost:3000/api/vocab/schemes/places/concepts/a8fc3ace-0004-b0a7-7d10",
      html_url: "http://localhost:3000/vocabularies/schemes/places/concepts/a8fc3ace-0004-b0a7-7d10",
      created_at: "2018-01-29T17:55:16.767Z",
      updated_at: "2018-01-29T17:55:16.767Z",
      creator: {
        name: "Tobias Schmidt M.A.",
        url: "http://localhost:3000/api/users/1",
        html_url: "http://localhost:3000/profiles/tobias-schmidt-m-a"
      },
      contributors: [
        {
          name: "Tobias Schmidt M.A.",
          url: "http://localhost:3000/api/users/1",
          html_url: "http://localhost:3000/profiles/tobias-schmidt-m-a"
        }
      ],
      broader: [ ],
      narrower: [
        {
          default_label: "Amran",
          url: "http://localhost:3000/api/vocab/schemes/places/concepts/7bf5181f-0004-f68f-7184-fc5fb38db3af",
          html_url: "http://localhost:3000/vocabularies/schemes/places/concepts/7bf5181f-0004-f68f-7184-fc5fb38db3af"
        }
      ],
      matches: [ ],
      notes: [
        {
          type: "Definition",
          body: "test",
          language: "deu (de) - German"
        }
      ],
      labels: [
        {
          type: "Preferred",
          body: "Babylon",
          language: "deu (de) - German",
          abbreviation: false,
          vernacular: "Undetermined",
          historical: "Current"
        }
      ],
      in_scheme: {
        id: "places",
        abbr: "places",
        title: "Places and locations in Babylon",
        definition: "",
        url: "http://localhost:3000/api/vocab/schemes/places",
        html_url: "http://localhost:3000/vocabularies/schemes/places",
        creator: {
          name: "Tobias Schmidt M.A.",
          html_url: "http://localhost:3000/profiles/tobias-schmidt-m-a"
        }
      }
    },
    ...
  ]
}