Auckland Museum API
This is technical documentation for the Auckland Museum API
COMMUNITYNO AUTH0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"host": "api.aucklandmuseum.com",
"info": {
"contact": {
"name": "Auckland Museum API Team",
"url": "http://www.aucklandmuseum.com"
},
"description": "This is technical documentation for the Auckland Museum API\n",
"license": {
"name": "Auckland Museum licence",
"url": "http://www.aucklandmuseum.com"
},
"termsOfService": "http://api.aucklandmuseum.com/terms/",
"title": "Auckland Museum API",
"version": "2.0.0",
"x-apisguru-categories": [
"open_data"
],
"x-logo": {
"backgroundColor": "#FFFFFF",
"url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_aucklandmuseum_profile_image.jpeg"
},
"x-origin": [
{
"format": "swagger",
"url": "http://api.aucklandmuseum.com/apidoc",
"version": "2.0"
}
],
"x-providerName": "aucklandmuseum.com"
},
"tags": [
{
"description": "media - images and documents",
"name": "media"
},
{
"description": "information about subjects",
"name": "subject"
},
{
"description": "search for interesting data",
"name": "search"
},
{
"description": "sparql queries",
"name": "sparql"
}
],
"paths": {
"/id/media/{path}": {
"get": {
"description": "Gets `media` at a given path\n",
"operationId": "get media",
"parameters": [
{
"description": "The media `identifier`\n",
"in": "path",
"name": "path",
"required": true,
"type": "string"
},
{
"description": "The desired media `rendering`\n\nPossible values:\n* `original.jpg`\n* `original.pdf`\n* `thumbnail.jpg` (fixed with 70px)\n* `standard.jpg` (fixed width 440px and height 440px)\n* `preview.jpg` (fixed height 100px)\n",
"in": "query",
"name": "rendering",
"required": false,
"type": "string"
}
],
"produces": [
"image/jpeg",
"application/pdf"
],
"responses": {
"200": {
"description": "`media` found\n"
},
"404": {
"description": "`media` not found\n"
}
},
"summary": "Retrieve media associated with Collections and Cenotaph subjects in Auckland Museum",
"tags": [
"media"
]
}
},
"/id/{identifier}": {
"get": {
"description": "Gets information about a `subject` identified by the `identifier`.\n\nThe response format depends upon the `Accept` header.\n - `text/html` - the default response type. Returned data can be easily viewed in any modern Internet Browser\n - `application/ld+json` - the response will be in [JSON-LD](http://json-ld.org/)\n - `application/json` - the response will be a simple JSON Object with keys (predicates) and values (objects).\n",
"operationId": "get subject",
"parameters": [
{
"description": "The identifier path of the `subject` you're looking for\n",
"in": "path",
"name": "identifier",
"required": true,
"type": "string"
}
],
"produces": [
"text/html",
"application/ld+json",
"application/json"
],
"responses": {
"200": {
"description": "`subject` found\n"
},
"404": {
"description": "`subject` not found\n"
}
},
"summary": "Explore details about a given subject node",
"tags": [
"subject"
]
}
},
"/search/{index}/{operation}": {
"get": {
"description": "Use this endpoint to perform simple search queries for finding information and subjects you may be interested in\n\nSearches performed via this endpoint run against an [Elastic](www.elastic.co) server. This endpoint mirrors the Elastic search API documented [here](https://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-search.html)\n\nUse the\n - `collectionsonline` index to perform searches over other all\nCollections data\n - `cenotaph` index to perform searches over Cenotaph data\n",
"operationId": "get search",
"parameters": [
{
"description": "search index name\nPossible values:\n* `collectionsonline`\n* `cenotaph`\n",
"in": "path",
"name": "index",
"required": true,
"type": "string"
},
{
"description": "One of the supported elasticsearch operations like `_search` or `_suggest`",
"in": "path",
"name": "operation",
"required": true,
"type": "string"
},
{
"description": "One of the supported elasticsearch query parameter values for key `q`",
"in": "query",
"name": "q",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "search results found"
},
"400": {
"description": "bad request"
},
"404": {
"description": "not found"
}
},
"summary": "Perform simple search queries over Auckland Museum Collections and Cenotaph data",
"tags": [
"search"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Searches performed via this endpoint run against an [Elastic](www.elastic.co) server. This endpoint mirrors the Elastic search API documented [here](https://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-search.html)\n\nUse the\n - `collectionsonline` index to perform searches over other all Collections data\n - `cenotaph` index to perform searches over Cenotaph data\n",
"operationId": "post search",
"parameters": [
{
"description": "search index name\nPossible values:\n* `collectionsonline`\n* `cenotaph`\n",
"in": "path",
"name": "index",
"required": true,
"type": "string"
},
{
"description": "One of the supported elasticsearch operations like `_search` or `_suggest`",
"in": "path",
"name": "operation",
"required": true,
"type": "string"
},
{
"description": "body",
"in": "body",
"name": "body",
"required": false,
"schema": {
"format": "application/json",
"type": "object"
}
}
],
"responses": {
"200": {
"description": "search results found"
},
"400": {
"description": "bad request"
},
"404": {
"description": "not found"
}
},
"summary": "Perform complex search queries over Auckland Museum Collections and Cenotaph data",
"tags": [
"search"
]
}
},
"/sparql": {
"get": {
"description": "You can execute your [SPARQL](http://www.w3.org/TR/rdf-sparql-query/) queries against this endpoint.\n\nThe sparql query should be provided as the value of the request parameter `query`.\nSet the `Accept` header to `application/sparql-results+xml` to get results in XML. Set it to `application/sparql-results+json` to get results in JSON. \n\n**Note:** This endpoints supports [JSON-P](http://json-p.org/). In order to get a JSON-P response, set the query parameter `callback` to your preferred callback function name. The default function name is `callback()`. When using JSON-P, there is no need to set the `Accept` header because the response will always be in `application/javascript`.\n",
"operationId": "get sparql",
"parameters": [
{
"description": "sparql query",
"in": "query",
"name": "query",
"required": true,
"type": "string"
},
{
"default": "callback",
"description": "The [JSON-P](http://json-p.org/) callback parameter",
"in": "query",
"name": "callback",
"required": false,
"type": "string"
},
{
"default": true,
"description": "Whether to get inferred results in the response",
"in": "query",
"name": "infer",
"required": false,
"type": "boolean"
}
],
"produces": [
"application/sparql-results+json",
"application/sparql-results+xml",
"application/javascript"
],
"responses": {
"200": {
"description": "success",
"schema": {
"title": "json",
"type": "object"
}
}
},
"summary": "Auckland Museum SPARQL endpoint",
"tags": [
"sparql"
]
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "You can execute your [SPARQL](http://www.w3.org/TR/rdf-sparql-query/) queries against this endpoint.\nThe sparql query should be provided as the value of the request parameter `query`.\nSet the `Accept` header to `application/sparql-results+xml` to get results in XML. Set it to `application/sparql-results+json` to get results in JSON. \n",
"operationId": "post sparql",
"parameters": [
{
"description": "sparql query",
"in": "formData",
"name": "query",
"required": true,
"type": "string"
},
{
"default": true,
"description": "Whether to get inferred results in the response",
"in": "formData",
"name": "infer",
"required": false,
"type": "boolean"
}
],
"produces": [
"application/sparql-results+json",
"application/sparql-results+xml"
],
"responses": {
"200": {
"description": "success"
}
},
"summary": "Auckland Museum SPARQL endpoint",
"tags": [
"sparql"
]
}
}
}
}