Tags

Granular, topic-based, non-hierarchical taxonomy used to categorize announcements, articles, and events.

Get a collection

GET /tags HTTP/1.1

Query string parameters

All query string parameters are optional.

callback string

Wraps the response in a callback function of the given name. Use this parameter to facilitate JSONP requests.

excluded_ids comma-separated list of IDs

Returns tags, except those with the given IDs.

ids comma-separated list of IDs

Return tags with the given IDs.

order_by comma-separated list

Sort tags by one or more ORDER_BY and ORDER parameter pairs. Options:

• ORDER:
  • asc: order from lowest to highest values
  • desc: order from highest to lowest values
• ORDER_BY:
  • id: order by tag ID
  • list: order by the order of IDs given in the ids parameter
  • name: order by term name
  • weight: order by term weight

Format: ORDER_BY|ORDER[,ORDER_BY|ORDER,...]

Default value: name|asc

page integer

Return tags from a specific page of a collection.

Default value: 1

per_page integer

Number of tags to return per page of a collection. Maximum: 100

Default value: 5

slug comma-separated list

Return tags matching the given slug(s).

Response

In the example response, embedded tags are truncated for illustrative purposes. In the real-world version of the response, "...tag object..." is an entire tag resource.

{
   "_embedded": {
      "tags": [
         "...tag object...",
         "...tag object...",
         "...tag object...",
         "...tag object...",
         "...tag object..."
      ]
   },
   "_links": {
      "find": {
         "href": "/tags/{?id}",
         "templated": true
      },
      "next": {
         "href": "/tags?page=3"
      },
      "prev": {
         "href": "/tags?page=1"
      },
      "self": {
         "href": "/tags?page=2"
      }
   },
   "page": 1,
   "per_page": 5,
   "return_count": 5,
   "total_available": 100
}

Attributes

_embedded hash

Embedded resources.

Toggle child attributes

_embedded.tags[] array

An array of tag objects.

_links hash

Links to resources associated with the tag collection.

Toggle child attributes

_links.find link object

A templated link that can be used to find a specific resource in the collection.

Toggle child attributes

_links.find.href string

URI of the link.

_links.find.templated boolean

Identifies the href as a templated URI.

_links.next link object

A link to the next set of resources in the collection. If there is not a next page, this link will not be present.

Toggle child attributes

_links.next.href string

URI of the link.

_links.prev link object

A link to the previous set of resources in the collection. If there is not a previous page, this link will not be present.

Toggle child attributes

_links.prev.href string

URI of the link.

_links.self link object

A link that identifies the current resource.

Toggle child attributes

_links.self.href string

URI of the link.

page integer

The page number of the returned collection.

per_page integer

The number of tags requested per page.

return_count integer

Number of tags returned.

total_available integer

Total number of tags available in the collection.

Get one

GET /tags/:id HTTP/1.1

Endpoint parameters

id integer required

The unique identifier of the tag.

Response

{
   "_embedded": {},
   "_links": {
      "self": {
         "href": "/tags/229"
      }
   },
   "id": 229,
   "name": "space exploration",
   "slug": "space-exploration",
   "type": "tag",
   "url": {
      "articles": "https://hub.jhu.edu/tags/space-exploration/articles/",
      "events": "https://hub.jhu.edu/tags/space-exploration/events/"
   }
}

Attributes

_embedded hash

Embedded resources.

_links hash

Links to resources associated with the tag.

Toggle child attributes

_links.self link object

A link that identifies the current resource.

Toggle child attributes

_links.self.href string

URI of the link.

id integer

Unique identifier of the tag.

name string

The nice name of the tag.

slug string

The name of the tag used in URLs.

type string

Type of resource.

url hash

URLs that point to collections of content in this tag on the Hub website.

Toggle child attributes

url.articles string

Points to the collection of articles in this tag on the Hub.

url.events string

Points to the collection of events in this tag on the Hub.

Get a subcollection

A subcollection is a collection of objects contained within a tag.

GET /tags/:id/:subcollection HTTP/1.1

Endpoint parameters

id integer

The unique identifier of the tag.

subcollection string

The name of the subcollection to retrieve. Options: announcements, articles, or events

Query string parameters

To filter the subcollection, see the list of available parameters associated with the chosen subcollection:

• announcements
• articles
• events

Response

See the response associated with the chosen subcollection:

• announcements
• articles
• events