LOCKSS Metadata Extraction Service REST API
REST API of the LOCKSS Metadata Extraction Service
Version: 2.0.0
BasePath:/
BSD-3-Clause
https://opensource.org/licenses/BSD-3-Clause
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
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 request header;
the media type will be conveyed by the 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
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 request header;
the media type will be conveyed by the response header.
Responses
200
The deleted job
job
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
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
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 request header;
the media type will be conveyed by the 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
Example data
Content-Type: application/json
{
"msg" : "msg",
"code" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The status of the requested job
status
401
Unauthorized
404
Not Found
500
Internal Server Error
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 request header:
Request body
Body Parameter — The information defining the AU metadata update operation
Query parameters
force (optional)
Query Parameter — An indication of whether to force the operation regardless of the current state of the AU default: true
Return type
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 request header;
the media type will be conveyed by the 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
409
Conflict
415
Unsupported Media Type
500
Internal Server Error
Get the status of the service (getStatus)
Get the status of the service
Return type
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 request header;
the media type will be conveyed by the response header.
Responses
200
The status of the service
apiStatus
401
Unauthorized
500
Internal Server Error
[ Jump to Methods ]
Table of Contents
apiStatusaujobjobPageInfometadataUpdateSpecpageInfostatus
The status information of the service
apiVersion
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.
NONE
PLUGINS_CRAWLING
PLUGINS_COLLECTED
PLUGINS_LOADING
PLUGINS_LOADED
AUS_STARTING
AUS_STARTED
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
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
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
example: full_extraction | incremental_extraction | delete
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
curLink
String The link to the current page
nextLink (optional)
String The link to the next page
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