LOCKSS Metadata Service REST API

REST API of the LOCKSS Metadata Service
More information: http://www.lockss.org/
Contact Info: lockss-support@lockss.org
Version: 2.0.0
BasePath:/
BSD-3-Clause
https://opensource.org/licenses/BSD-3-Clause

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Metadata

Status

Urls

Metadata

Up 
get /metadata/aus/{auid}
Get the metadata stored for an AU (getMetadataAusAuid)
Get the full metadata stored for an AU given the AU identifier or a pageful of the metadata defined by the continuation token and size

Path parameters

auid (required)
Path Parameter — The identifier of the AU for which the metadata is requested

Query parameters

limit (optional)
Query Parameter — The number of items per page default: 50
continuationToken (optional)
Query Parameter — The continuation token of the next page of metadata to be returned

Return type

auMetadataPageInfo

Example data

Content-Type: application/json
{
  "pageInfo" : {
    "curLink" : "curLink",
    "resultsPerPage" : 6,
    "totalCount" : 0,
    "continuationToken" : "continuationToken",
    "nextLink" : "nextLink"
  },
  "items" : [ {
    "scalarMap" : {
      "key" : "scalarMap"
    },
    "listMap" : {
      "key" : [ "listMap", "listMap" ]
    },
    "setMap" : {
      "key" : [ "setMap", "setMap" ]
    },
    "mapMap" : {
      "key" : {
        "key" : "mapMap"
      }
    }
  }, {
    "scalarMap" : {
      "key" : "scalarMap"
    },
    "listMap" : {
      "key" : [ "listMap", "listMap" ]
    },
    "setMap" : {
      "key" : [ "setMap", "setMap" ]
    },
    "mapMap" : {
      "key" : {
        "key" : "mapMap"
      }
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The metadata of the specified AU auMetadataPageInfo

400

Bad Request

401

Unauthorized

404

Not found

409

Conflict

500

Internal Server Error

Status

Up 
get /status
Get the status of the service (getStatus)
Get the status of the service

Return type

apiStatus

Example data

Content-Type: application/json
{
  "startupStatus" : "NONE",
  "reason" : "reason",
  "readyTime" : 0,
  "apiVersion" : "apiVersion",
  "ready" : true,
  "componentName" : "componentName",
  "componentVersion" : "componentVersion",
  "serviceName" : "serviceName",
  "lockssVersion" : "lockssVersion"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The status of the service apiStatus

401

Unauthorized

500

Internal Server Error

Urls

Up 
get /urls/doi
Gets the URL for a DOI (getUrlsDoi)
Provides the URL for a DOI given the DOI

Query parameters

doi (required)
Query Parameter — The DOI for which the URL is requested

Return type

urlInfo

Example data

Content-Type: application/json
{
  "urls" : [ "urls", "urls" ],
  "params" : {
    "key" : "params"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The URL for the specified DOI urlInfo

400

Bad Request

401

Unauthorized

500

Internal Server Error
Up 
get /urls/openurl
Performs an OpenURL query (getUrlsOpenUrl)
Provides the URL that results from performing an OpenURL query. With query parameters inline

Query parameters

params (required)
Query Parameter — The OpenURL parameters

Return type

urlInfo

Example data

Content-Type: application/json
{
  "urls" : [ "urls", "urls" ],
  "params" : {
    "key" : "params"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The data related to the performed OpenURL query urlInfo

400

Bad Request

401

Unauthorized

500

Internal Server Error

Models

[ Jump to Methods ]

Table of Contents

  1. apiStatus
  2. auMetadataPageInfo
  3. itemMetadata
  4. pageInfo
  5. urlInfo

apiStatus Up

The status information of the service
apiVersion
String The version of the API
componentName (optional)
String The name of the component
componentVersion (optional)
String The version of the component software
lockssVersion (optional)
String The version of the LOCKSS system
ready
Boolean The indication of whether the service is available
serviceName (optional)
String The name of the service
readyTime (optional)
Long The time the service last became ready. format: int64
reason (optional)
String The reason the service isn't ready.
startupStatus (optional)
String Enum indicating progress of plugin/AU processing at startup.
Enum:
NONE
PLUGINS_CRAWLING
PLUGINS_COLLECTED
PLUGINS_LOADING
PLUGINS_LOADED
AUS_STARTING
AUS_STARTED

auMetadataPageInfo Up

The display page of AU metadata
items
array[itemMetadata] The metadata for the AU items in the page
pageInfo
pageInfo

itemMetadata Up

The metadata generated for a single item
scalarMap (optional)
map[String, String] The map of scalar metadata elements for this item
setMap (optional)
map[String, array[String]] The map of set-bound metadata elements for this item
listMap (optional)
map[String, array[String]] The map of listed metadata elements for this item
mapMap (optional)
map[String, map[String, String]] The map of mapped metadata elements for this item

pageInfo Up

The information related to pagination of content
totalCount
Integer The total number of elements to be paginated format: int32
resultsPerPage
Integer The number of results per page format: int32
continuationToken
String The continuation token
curLink
String The link to the current page
nextLink (optional)
String The link to the next page

urlInfo Up

The information related to a resulting list of URLs
params
map[String, String] The parameters that define the resulting URLs
urls
array[String] The URLs