LOCKSS Metadata Extraction Service REST API

API of the LOCKSS Metadata Extraction REST Service
More information: https://www.lockss.org/
Contact Info: lockss-support@lockss.org
Version: 1.0.0
BasePath:/
BSD-3-Clause
https://www.lockss.org/support/open-source-license/

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Mdupdates

Status

Mdupdates

Up
delete /mdupdates
Delete all of the currently queued and active jobs (deleteMdupdates)
Delete all of the currently queued and active jobs

Return type

Integer

Example data

Content-Type: application/json
0

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

Count of jobs successfully deleted Integer

401

Unauthorized

403

Forbidden

500

Internal Server Error

Up
delete /mdupdates/{jobid}
Delete a job (deleteMdupdatesJobid)
Delete a job given the job identifier, stopping any current processing, if necessary

Path parameters

jobid (required)
Path Parameter — The identifier of the job to be deleted

Return type

job

Example data

Content-Type: application/json
{
  "au" : {
    "name" : "name",
    "id" : "id",
    "job" : "job"
  },
  "endDate" : "2000-01-23",
  "description" : "description",
  "id" : "id",
  "creationDate" : "2000-01-23",
  "startDate" : "2000-01-23",
  "status" : {
    "msg" : "msg",
    "code" : 0
  }
}

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 deleted job job

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Up
get /mdupdates
Get a list of currently active jobs (getMdupdates)
Get a list of all currently active jobs or a pageful of the list defined by the continuation token and size

Query parameters

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

Return type

jobPageInfo

Example data

Content-Type: application/json
{
  "jobs" : [ {
    "au" : {
      "name" : "name",
      "id" : "id",
      "job" : "job"
    },
    "endDate" : "2000-01-23",
    "description" : "description",
    "id" : "id",
    "creationDate" : "2000-01-23",
    "startDate" : "2000-01-23",
    "status" : {
      "msg" : "msg",
      "code" : 0
    }
  }, {
    "au" : {
      "name" : "name",
      "id" : "id",
      "job" : "job"
    },
    "endDate" : "2000-01-23",
    "description" : "description",
    "id" : "id",
    "creationDate" : "2000-01-23",
    "startDate" : "2000-01-23",
    "status" : {
      "msg" : "msg",
      "code" : 0
    }
  } ],
  "pageInfo" : {
    "curLink" : "curLink",
    "resultsPerPage" : 1,
    "totalCount" : 6,
    "continuationToken" : "continuationToken",
    "nextLink" : "nextLink"
  }
}

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 requested jobs jobPageInfo

400

Bad Request

401

Unauthorized

409

Conflict

500

Internal Server Error

Up
get /mdupdates/{jobid}
Get a job (getMdupdatesJobid)
Get a job given the job identifier

Path parameters

jobid (required)
Path Parameter — The identifier of the requested job

Return type

status

Example data

Content-Type: application/json
{
  "msg" : "msg",
  "code" : 0
}

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 requested job status

401

Unauthorized

404

Not Found

500

Internal Server Error

Up
post /mdupdates
Perform an AU metadata update operation (postMdupdates)
Perform an AU metadata update operation given the update specification

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

metadataUpdateSpec metadataUpdateSpec (required)
Body Parameter — The information defining the AU metadata update operation

Return type

job

Example data

Content-Type: application/json
{
  "au" : {
    "name" : "name",
    "id" : "id",
    "job" : "job"
  },
  "endDate" : "2000-01-23",
  "description" : "description",
  "id" : "id",
  "creationDate" : "2000-01-23",
  "startDate" : "2000-01-23",
  "status" : {
    "msg" : "msg",
    "code" : 0
  }
}

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

202

The job created to perform the AU metadata update operation job

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

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
{
  "ready" : true,
  "version" : "version"
}

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

Models

[ Jump to Methods ]

Table of Contents

  1. apiStatus -
  2. au -
  3. job -
  4. jobPageInfo -
  5. metadataUpdateSpec -
  6. pageInfo -
  7. status -

apiStatus - Up

The status information of the service
version
String The version of the service
ready
Boolean The indication of whether the service is available

au - Up

An Archival Unit
id
String The identifier of this AU
job (optional)
String The identifier of the job associated with this AU
name (optional)
String The name of the AU, for display purposes

job - Up

An asynchronous task to be performed
au
id
String The identifier of this job
description (optional)
String A description of the task being performed by this job
creationDate
date The timestamp when this job was created format: date
startDate (optional)
date The timestamp when this job processing started format: date
endDate (optional)
date The timestamp when this job processing ended format: date
status

jobPageInfo - Up

A display page of jobs
jobs
array[job] The jobs displayed in the page
pageInfo

metadataUpdateSpec - Up

The information defining an AU metadata update operation
auid
String The identifier of the AU for which the metadata update is to be performed
updateType
String The type of metadata update to be performed

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

status - Up

The existing state of a job
code
Integer The numeric value for the current state format: int32
msg
String A text message defining the current state