LOCKSS Poller Service REST API

REST API of the LOCKSS Poller Service
More information: https://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

Export

Hash

Import

PollDetail

PollerPolls

Repo

Service

VoterPolls

Export

Up
get /aus/{auid}/export
Export artifacts in an Archival Unit (getExportFiles)
Export artifacts in an Archival Unit as a group of archives

Path parameters

auid (required)
Path Parameter — Identifier of the Archival Unit containing the artifacts

Query parameters

fileType (optional)
Query Parameter — The type of archive to create default: WARC_RESPONSE
isCompress (optional)
Query Parameter — Indication of whether contents should be compressed default: true
isExcludeDirNodes (optional)
Query Parameter — Indication of whether directories should be excluded default: true
xlateFilenames (optional)
Query Parameter — Type of filename translation to be done default: XLATE_NONE
filePrefix (optional)
Query Parameter — The prefix to be used to name the exported file default: lockss_export
maxSize (optional)
Query Parameter — The maximum size of the exported file default: -1 format: int64
maxVersions (optional)
Query Parameter — The maximum number of versions of an artifact to be exported default: -1

Return type

byte[]

Example data

Content-Type: application/json
""

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 archives with the requested artifacts byte[]

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

406

Not Acceptable

500

Internal Server Error

Hash

Up
delete /ws/hashes/requests/{requestId}
Remove an asynchronous hashing operation (deleteHash)
Remove from the system an asynchronous hashing operation,\ \ terminating it if it's still running

Path parameters

requestId (required)
Path Parameter — Identifier of the asynchronous hashing operation

Return type

String

Example data

Content-Type: application/json
""

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

Asynchronous hashing operation successfully removed String

400

Bad Request

401

Unauthorized

404

No asynchronous hashing operation found with that id

500

Internal Server Error

Up
get /ws/hashes
Get the results of all the asynchronous hashing operations (getAllHashes)
Get the results of all the asynchronous hashing operations

Return type

byte[]

Example data

Content-Type: application/json
""

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

Information about all the asynchronous hashing operations byte[]

401

Unauthorized

500

Internal Server Error

Up
get /ws/hashes/requests/{requestId}
Get the result of an asynchronous hashing operation (getHash)
Get the result of an asynchronous hashing operation

Path parameters

requestId (required)
Path Parameter — Identifier of the asynchronous hashing operation

Return type

byte[]

Example data

Content-Type: application/json
""

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

Information about the asynchronous hashing operation byte[]

400

Bad Request

401

Unauthorized

404

No asynchronous hashing operation found with that id

500

Internal Server Error

Up
put /ws/hashes
Perform a hashing operation (putHash)
Perform the hashing of an AU or a URL

Consumes

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

Request body

body hasherWsParams (required)
Body Parameter — The parameters needed to define a hash.

Query parameters

isAsynchronous (optional)
Query Parameter — Indication of whether the operation should be done synchronously default: true

Return type

byte[]

Example data

Content-Type: application/json
""

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

Information about the performed hashing operation byte[]

400

Bad Request

401

Unauthorized

500

Internal Server Error

Import

Up
put /ws/aus/import
Import a file into an Archival Unit (putImportFile)
Import a file as an artifact in an Archival Unit

Consumes

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

Form parameters

targetBaseUrlPath (required)
Form Parameter
targetUrl (required)
Form Parameter
userProperties (required)
Form Parameter
file (required)
Form Parameter — format: binary

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

415

Unsupported Media Type

500

Internal Server Error

PollDetail

Up
get /polls/{pollKey}/peer/{peerId}
Poll Peer Data (getPollPeerVoteUrls)
Return the list of urls of vote type for a given peer in a specific poll.

Path parameters

pollKey (required)
Path Parameter — The pollKey from the PollDetail.
peerId (required)
Path Parameter — The peerId from the Poll Detail.PeerData.

Query parameters

urls (required)
Query Parameter — The voter urls to return.
page (optional)
Query Parameter — The page number
size (optional)
Query Parameter — The page size

Return type

UrlPager

Example data

Content-Type: application/json
{
  "pageDesc" : {
    "total" : 150,
    "size" : 5,
    "nextPage" : "nextPage",
    "prevPage" : "prevPage",
    "page" : 10
  },
  "urls" : [ "urls", "urls" ]
}

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

A pagable list of voter urls with a given status. UrlPager

404

Poll or Voter ID not found.

500

Internal Server Error

Up
get /polls/{pollKey}/repairs
Poll Repairs (getRepairQueueData)
Return the repair status for a specific poll.

Path parameters

pollKey (required)
Path Parameter — The pollKey as listed in the PollDetail object.

Query parameters

repair (required)
Query Parameter — The repair queue elements to return.
page (optional)
Query Parameter — The page number.
size (optional)
Query Parameter — The size of the page.

Return type

RepairPager

Example data

Content-Type: application/json
{
  "repairs" : [ {
    "result" : "NoQuorum",
    "repairUrl" : "repairUrl",
    "repairFrom" : "repairFrom"
  }, {
    "result" : "NoQuorum",
    "repairUrl" : "repairUrl",
    "repairFrom" : "repairFrom"
  } ],
  "pageDesc" : {
    "total" : 150,
    "size" : 5,
    "nextPage" : "nextPage",
    "prevPage" : "prevPage",
    "page" : 10
  }
}

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

A pagable list of repair queue elements. RepairPager

404

Poll ID not found.

500

Internal Server Error

Up
get /polls/{pollKey}/tallies
Page Tally (getTallyUrls)
Return the vote tallies for a specific poll.

Path parameters

pollKey (required)
Path Parameter — The pollKey as listed in the PollDetail object.

Query parameters

tally (required)
Query Parameter — The kind of tally element to return.
page (optional)
Query Parameter — The page number.
size (optional)
Query Parameter — The size of the page.

Return type

UrlPager

Example data

Content-Type: application/json
{
  "pageDesc" : {
    "total" : 150,
    "size" : 5,
    "nextPage" : "nextPage",
    "prevPage" : "prevPage",
    "page" : 10
  },
  "urls" : [ "urls", "urls" ]
}

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

A pagable list of urls for given tally type. UrlPager

404

Poll Key not found.

500

Internal Server Error

PollerPolls

Up
get /polls/poller/{pollKey}
PollerDetails (getPollerPollDetails)
Return the detailed information about a poll.

Path parameters

pollKey (required)
Path Parameter — The key assigned by the PollManager.

Return type

PollerDetail

Example data

Content-Type: application/json
{
  "noAuPeers" : [ "noAuPeers", "noAuPeers" ],
  "pollerId" : "pollerId",
  "pollDesc" : {
    "auId" : "auId",
    "cuSetSpec" : {
      "upperBound" : "upperBound",
      "urlPrefix" : "urlPrefix",
      "lowerBound" : "lowerBound"
    },
    "protocol" : 6,
    "pollType" : 3,
    "variant" : "PoR",
    "pluginPollVersion" : "pluginPollVersion",
    "modulus" : 1
  },
  "quorum" : 7,
  "pollKey" : "pollKey",
  "votedPeers" : [ {
    "peerId" : "peerId",
    "lastStateChange" : 9,
    "agreement" : 1.2315135,
    "bytesRead" : 4,
    "bytesHashed" : 1,
    "wtNumDisagree" : 9.36931,
    "wtNumVoterOnly" : 8.762042,
    "numVoterOnly" : 7,
    "numAgree" : 1,
    "state" : "state",
    "agreeLink" : {
      "link" : "http:www.example.com/v1/element",
      "desc" : "pollerOnly"
    },
    "numPollerOnly" : 6,
    "wtAgreement" : 5.025005,
    "wtNumAgree" : 9.965781,
    "wtNumPollerOnly" : 6.6835623,
    "status" : "status",
    "numDisagree" : 1
  }, {
    "peerId" : "peerId",
    "lastStateChange" : 9,
    "agreement" : 1.2315135,
    "bytesRead" : 4,
    "bytesHashed" : 1,
    "wtNumDisagree" : 9.36931,
    "wtNumVoterOnly" : 8.762042,
    "numVoterOnly" : 7,
    "numAgree" : 1,
    "state" : "state",
    "agreeLink" : {
      "link" : "http:www.example.com/v1/element",
      "desc" : "pollerOnly"
    },
    "numPollerOnly" : 6,
    "wtAgreement" : 5.025005,
    "wtNumAgree" : 9.965781,
    "wtNumPollerOnly" : 6.6835623,
    "status" : "status",
    "numDisagree" : 1
  } ],
  "voteMargin" : 9,
  "voteDuration" : 2,
  "duration" : 5,
  "voteDeadline" : 3,
  "repairQueue" : {
    "numActive" : 3,
    "numCompleted" : 7,
    "numPending" : 3
  },
  "createTime" : 5,
  "outerCircleTarget" : 7,
  "pollEnd" : 4,
  "deadline" : 2,
  "tally" : {
    "numNoQuorum" : 1,
    "wtTooClose" : 5.9448957,
    "wtNoQuorum" : 6.704019,
    "numTooClose" : 6,
    "numAgree" : 6,
    "wtDisagreed" : 6.878052,
    "numError" : 2,
    "numDisagree" : 3,
    "wtAgreed" : 6.778325
  },
  "hashAlgorithm" : "hashAlgorithm",
  "status" : "status",
  "errorDetails" : "errorDetails"
}

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

Detailed poll info returned. PollerDetail

401

Unauthorized request.

404

Poll Key not found.

500

Internal Server Error

Up
get /polls/poller
Get the list of recent polls as poller. (getPollsAsPoller)
Get the list of recent polls as poller from the poll queue. if size and page are passed in use those arguments to limit return data.

Query parameters

size (optional)
Query Parameter — Size of the page to retrieve. format: int32
page (optional)
Query Parameter — Number of the page to retrieve. format: int32

Return type

PollerPager

Example data

Content-Type: application/json
{
  "pageDesc" : {
    "total" : 150,
    "size" : 5,
    "nextPage" : "nextPage",
    "prevPage" : "prevPage",
    "page" : 10
  },
  "polls" : [ {
    "numCompletedRepairs" : 5,
    "auId" : "auId",
    "numHashErrors" : 1,
    "numTalliedUrls" : 6,
    "start" : 2,
    "pollKey" : "pollKey",
    "variant" : "variant",
    "numAgreeUrls" : 5,
    "pollEnd" : 9,
    "deadline" : 7,
    "detailLink" : {
      "link" : "http:www.example.com/v1/element",
      "desc" : "pollerOnly"
    },
    "status" : "status",
    "participants" : 0
  }, {
    "numCompletedRepairs" : 5,
    "auId" : "auId",
    "numHashErrors" : 1,
    "numTalliedUrls" : 6,
    "start" : 2,
    "pollKey" : "pollKey",
    "variant" : "variant",
    "numAgreeUrls" : 5,
    "pollEnd" : 9,
    "deadline" : 7,
    "detailLink" : {
      "link" : "http:www.example.com/v1/element",
      "desc" : "pollerOnly"
    },
    "status" : "status",
    "participants" : 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

A pagable list has been returned. PollerPager

401

Unauthorized request

500

Internal Server Error

Repo

Up
get /ws/aurepositories
Query the properties of repositories (getRepositories)
Query the system for selected repository properties

Query parameters

repositoryQuery (required)
Query Parameter — The query that specifies the repository properties to be returned

Return type

array[repositoryWsResult]

Example data

Content-Type: application/json
[ {
  "repositorySpaceId" : "repositorySpaceId"
}, {
  "repositorySpaceId" : "repositorySpaceId"
} ]

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

Information about the requested TDB AUs

400

Bad Request

401

Unauthorized

500

Internal Server Error

Up
get /ws/repositoryspaces
Query the properties of repository spaces (getRepositorySpaces)
Query the system for selected repository space properties

Query parameters

repositorySpaceQuery (required)
Query Parameter — The query that specifies the repository space properties to be returned

Return type

array[repositorySpaceWsResult]

Example data

Content-Type: application/json
[ {
  "repositorySpaceId" : "repositorySpaceId"
}, {
  "repositorySpaceId" : "repositorySpaceId"
} ]

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

Information about the requested TDB AUs

400

Bad Request

401

Unauthorized

500

Internal Server Error

Service

Up
post /polls
Send a request to call a poll to the poller (callPoll)
Use the information found in the descriptor object to initiate a poll.

Consumes

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

Request body

body PollDesc (required)
Body Parameter — A poll descriptor object used to define the poll being requested.

Return type

String

Example data

Content-Type: application/json
""

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 Poll request has been accepted and added to the queue. String

401

The Request is unauthorized

403

The Au is not eligible for polling

404

The descriptor (au) can not be found.

500

Internal Server Error

Up
delete /polls/{psId}
Stop a poll and remove from queue. (cancelPoll)
Stop a running poll and delete any schecduled polls for poll with the poll service id.

Path parameters

psId (required)
Path Parameter — The poll id.

Responses

200

Poll successfully stopped

401

Unauthorized request

404

No poll found with that id

500

Internal Server Error

Up
get /ws/peers
Query for peer properties (getPeers)
Query for peers that meet a set of specified conditions

Query parameters

peerQuery (required)
Query Parameter — The query that specifies the peers to be returned

Return type

array[peerWsResult]

Example data

Content-Type: application/json
[ {
  "peerId" : "peerId"
}, {
  "peerId" : "peerId"
} ]

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

Information about the requested peers

400

Bad Request

401

Unauthorized

500

Internal Server Error

Up
get /polls/{psId}
Get queued poll status (getPollStatus)
Get the status of a previously queued poll.

Path parameters

psId (required)
Path Parameter — The poll id.

Return type

PollerSummary

Example data

Content-Type: application/json
{
  "numCompletedRepairs" : 5,
  "auId" : "auId",
  "numHashErrors" : 1,
  "numTalliedUrls" : 6,
  "start" : 2,
  "pollKey" : "pollKey",
  "variant" : "variant",
  "numAgreeUrls" : 5,
  "pollEnd" : 9,
  "deadline" : 7,
  "detailLink" : {
    "link" : "http:www.example.com/v1/element",
    "desc" : "pollerOnly"
  },
  "status" : "status",
  "participants" : 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

Poll info returned. PollerSummary

401

Unauthorized request

404

No such poll service id.

500

Internal Server Error

Up
get /ws/polls
Query for poll properties (getPolls)
Query for polls that meet a set of specified conditions

Query parameters

pollQuery (required)
Query Parameter — The query that specifies the polls to be returned

Return type

array[pollWsResult]

Example data

Content-Type: application/json
[ {
  "auId" : "auId",
  "auName" : "auName"
}, {
  "auId" : "auId",
  "auName" : "auName"
} ]

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

Information about the requested polls

400

Bad Request

401

Unauthorized

500

Internal Server Error

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 request

500

Internal server error

503

Some or all of the system is not available

Up
get /ws/votes
Query for vote properties (getVotes)
Query for votes that meet a set of specified conditions

Query parameters

voteQuery (required)
Query Parameter — The query that specifies the votes to be returned

Return type

array[voteWsResult]

Example data

Content-Type: application/json
[ {
  "auId" : "auId",
  "auName" : "auName"
}, {
  "auId" : "auId",
  "auName" : "auName"
} ]

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

Information about the requested votes

400

Bad Request

401

Unauthorized

500

Internal Server Error

VoterPolls

Up
get /polls/voter
Get the list of recent voter only polls. (getPollsAsVoter)
Get the list of recent polls as voter from the poll queue. if size and page are passed in use those arguments to limit return data.

Query parameters

size (optional)
Query Parameter — Size of the page to retrieve. format: int32
page (optional)
Query Parameter — Number of the page to retrieve. format: int32

Return type

VoterPager

Example data

Content-Type: application/json
{
  "pageDesc" : {
    "total" : 150,
    "size" : 5,
    "nextPage" : "nextPage",
    "prevPage" : "prevPage",
    "page" : 10
  },
  "polls" : [ {
    "auId" : "auId",
    "caller" : "caller",
    "start" : 0,
    "pollKey" : "pollKey",
    "deadline" : 6,
    "detailLink" : {
      "link" : "http:www.example.com/v1/element",
      "desc" : "pollerOnly"
    },
    "status" : "status"
  }, {
    "auId" : "auId",
    "caller" : "caller",
    "start" : 0,
    "pollKey" : "pollKey",
    "deadline" : 6,
    "detailLink" : {
      "link" : "http:www.example.com/v1/element",
      "desc" : "pollerOnly"
    },
    "status" : "status"
  } ]
}

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

A pagable list has been returned. VoterPager

401

Unauthorized request

500

Internal Server Error

Up
get /polls/voter/{pollKey}
VoterDetails (getVoterPollDetails)
Return the detailed information about a poll.

Path parameters

pollKey (required)
Path Parameter — The key assigned by the PollManager.

Return type

VoterDetail

Example data

Content-Type: application/json
{
  "pollerNonce" : "pollerNonce",
  "pollerId" : "pollerId",
  "agreement" : 5.962133916683182,
  "pollDesc" : {
    "auId" : "auId",
    "cuSetSpec" : {
      "upperBound" : "upperBound",
      "urlPrefix" : "urlPrefix",
      "lowerBound" : "lowerBound"
    },
    "protocol" : 6,
    "pollType" : 3,
    "variant" : "PoR",
    "pluginPollVersion" : "pluginPollVersion",
    "modulus" : 1
  },
  "wtSymmetricAgreement" : 7.061401241503109,
  "pollKey" : "pollKey",
  "voterNonce" : "voterNonce",
  "duration" : 6,
  "voteDeadline" : 9,
  "createTime" : 0,
  "voter2Nonce" : "voter2Nonce",
  "numVoterOnly" : 7,
  "symmetricAgreement" : 2.3021358869347655,
  "numAgree" : 3,
  "callerId" : "callerId",
  "deadline" : 1,
  "wtAgreement" : 5.637376656633329,
  "numPollerOnly" : 4,
  "hashAlgorithm" : "hashAlgorithm",
  "status" : "status",
  "numDisagree" : 2,
  "errorDetails" : "errorDetails"
}

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

Detailed poll info returned. VoterDetail

401

Unauthorized request

404

No such poll key.

500

Internal Server Error

Models

[ Jump to Methods ]

Table of Contents

  1. CachedUriSetSpec
  2. LinkDesc
  3. PageDesc
  4. PeerData
  5. PollDesc
  6. PollerDetail
  7. PollerPager
  8. PollerSummary
  9. RepairData
  10. RepairPager
  11. RepairQueue
  12. TallyData
  13. UrlPager
  14. VoterDetail
  15. VoterPager
  16. VoterSummary
  17. apiStatus
  18. aus_import_body
  19. hasherWsParams
  20. peerWsResult
  21. pollWsResult
  22. repositorySpaceWsResult
  23. repositoryWsResult
  24. voteWsResult

CachedUriSetSpec Up

A set of urls bounded by upper and lower restraints. If lower = "." this is a singleContentNode. If lower is null then start at the root url, if upper is null end with the last.
urlPrefix
String The base which roots the lower and upper bound
lowerBound (optional)
String lower bound of the prefix range, inclusive.
upperBound (optional)
String upper bound of prefix range, inclusive.

LinkDesc Up

A wrapper for a link and a string description.
link
String The actual link suitable for a standard GET request
example: http:www.example.com/v1/element
desc (optional)
String A description of this link
example: pollerOnly

PageDesc Up

The information needed to page in a long list of data
page
Integer The page number
example: 10
size
Integer The size or number of elements on a page
example: 5
total
Integer The mTotal number of elements.
example: 150
prevPage (optional)
String The url of the prev page of results or null
nextPage (optional)
String The url to the next page of results or null.

PeerData Up

Detail for a single voter in a poll.
peerId
String the peer id for this participant
status
String the status of this peer
agreement (optional)
Float the percentage of vote agreement. format: float
numAgree (optional)
Long The number of urls for which there was agreement. format: int64
agreeLink (optional)
numDisagree (optional)
Long The number of urls for which there was disagreement. format: int64
disagreeLink (optional)
numPollerOnly (optional)
Long The number of urls which were poller only. format: int64
pollerOnlyLink (optional)
numVoterOnly (optional)
Long The number of urls for which were voter only. format: int64
voterOnlyLink (optional)
bytesHashed (optional)
Long the number of bytes hashed. format: int64
bytesRead (optional)
Long the number of bytes read. format: int64
wtAgreement (optional)
Float the weight of vote percentage agreement. format: float
wtNumAgree (optional)
Float the weight of number agree votes. format: float
wtNumDisagree (optional)
Float the weight of number of disagree votes. format: float
wtNumPollerOnly (optional)
Float the weight of number of poller only votes. format: float
wtNumVoterOnly (optional)
Float the weight of number of voter only votes. format: float
state (optional)
String the state machine state.
lastStateChange (optional)
Long the time of last state change. format: int64

PollDesc Up

The Poller Services poll spec used to define a poll.
auId
String The id which defines the poll
cuSetSpec (optional)
pollType (optional)
Integer The type of poll to run. Only V3 is supported.
protocol (optional)
Integer The version of polling protocol.
pluginPollVersion (optional)
String The version of the polling features needed by the plugin.
variant (optional)
String The V3 poll variation.
Enum:
PoR
PoP
Local
NoPoll
modulus (optional)
Integer Poll on every 'n'th url.

PollerDetail Up

The details of a poll being performed or queued by the Poller
pollDesc
pollerId
String The id of the poller who called the poll
status
String The current status of the poll.
pollKey (optional)
String Key generated by poll manager when poll is created.
createTime (optional)
Long The timestamp at which the poll was created. format: int64
duration (optional)
Long The estimated duration for the poll. format: int64
deadline (optional)
Long The time by which the poll must have completed format: int64
outerCircleTarget (optional)
Integer The number of peers from the poller outer circle to taget. format: int32
hashAlgorithm (optional)
String The algorithm used by the hasher for this poll.
voteMargin (optional)
Integer The required agreement need to decide landslide agreement or disagreement. format: int32
voteDeadline (optional)
Long The time by which all voters must have voted. format: int64
voteDuration (optional)
Long The estimated duration for voters. format: int64
pollEnd (optional)
Long the time at which the poll ended or -1 if still running. format: int64
quorum (optional)
Integer The minimum required for a quroum format: int32
errorDetails (optional)
String The error which caused the poll to fail.
votedPeers (optional)
array[PeerData] The data from peers whom voted.
noAuPeers (optional)
array[String] The peers who do not have the au.
tally (optional)
repairQueue (optional)

PollerPager Up

A page of poller poll summaries.
pageDesc
polls (optional)
array[PollerSummary] The list of polls for the current page or null

PollerSummary Up

A summary of a poll in which we are the poller.
auId
String The id for the au being polled.
variant
String The V3 Poll variant.
status
String The current status of the poll.
participants (optional)
Integer The number of participants voting. format: int32
numTalliedUrls (optional)
Integer The number of tallied urls. format: int32
numHashErrors (optional)
Integer The number of hash errors. format: int32
numCompletedRepairs (optional)
Integer The number of completed repairs. format: int32
numAgreeUrls (optional)
Integer The number of urls with agreement. format: int32
start
Long The timestamp for when the poll started. format: int64
deadline
Long The deadline for voting in this poll. format: int64
pollEnd (optional)
Long The time at which the poll ended. format: int64
pollKey
String Key generated by poll manager when poll was created.
detailLink (optional)

RepairData Up

structure used to define a repair source for url. if the source is null than repair from publisher
repairUrl
String The url to repair
repairFrom
String The peer to repair from
result (optional)
String The status of this repair
Enum:
NoQuorum
TooClose
Lost
LostPollerOnly
LostVoterOnly
Won

RepairPager Up

A Pager for a list of urls found in poll details.
pageDesc
repairs (optional)
array[RepairData] The list of repair data on this page or null.

RepairQueue Up

Description of the RepairQueue.
numPending
Integer The number of pending repairs format: int32
pendingLink (optional)
numActive
Integer The number of active repairs format: int32
activeLink (optional)
numCompleted
Integer The number of completed repairs format: int32
completedLink (optional)

TallyData Up

The tally for the current poll.
numAgree
Integer The number of urls with agreement. format: int32
agreeLink (optional)
numDisagree
Integer The number of urls with disagreement. format: int32
disagreeLink (optional)
numTooClose
Integer The number of urls too close. format: int32
tooCloseLink (optional)
numNoQuorum
Integer The number of urls without enough voters. format: int32
noQuorumLink (optional)
numError
Integer The number of urls wit errors. format: int32
errorLink (optional)
wtAgreed (optional)
Float The weighted sum agreed uris. format: float
wtDisagreed (optional)
Float The weighted sum of disagree uris. format: float
wtTooClose (optional)
Float The sum of the tooClose uris. format: float
wtNoQuorum (optional)
Float The weighted sum of NoQuorum uris. format: float

UrlPager Up

A Pager for a list of urls found in poll details.
pageDesc
urls (optional)
array[String] The urls on this page.

VoterDetail Up

The details of a poll being performed or queued as the Voter.
pollDesc
pollerId
String The id of the voter in the poll
callerId (optional)
String The id of the poller who called the poll
status
String The current status of the poll.
pollKey (optional)
String Key generated by poll manager when poll is created.
createTime (optional)
Long The timestamp at which the poll was created. format: int64
duration (optional)
Long The estimated duration for the poll. format: int64
deadline (optional)
Long The time by which the poll must have completed format: int64
hashAlgorithm (optional)
String The algorithm used by the hasher for this poll.
agreement (optional)
Double The percentage agreement. format: double
wtAgreement (optional)
Double The weighted percentage agreement. format: double
symmetricAgreement (optional)
Double The percentage of symmetric agreement. format: double
wtSymmetricAgreement (optional)
Double The weighted percentage of symmetric agreement. format: double
pollerNonce (optional)
String the poller nonce
voterNonce (optional)
String the voter nonce
voter2Nonce (optional)
String the voter2 nonce
voteDeadline (optional)
Long The time by which all voters must have voted. format: int64
numAgree (optional)
Integer The number of urls with agreement. format: int32
numDisagree (optional)
Integer The number of urls with disagreement. format: int32
numPollerOnly (optional)
Integer The number of urls found by only the poller. format: int32
numVoterOnly (optional)
Integer The number of urls found by only a voter. format: int32
errorDetails (optional)
String The error which caused the poll to fail.

VoterPager Up

A page of voter poll summary.
pageDesc
polls (optional)
array[VoterSummary] The list of polls for the current page or null

VoterSummary Up

A summary of a poll in which we are acting just as a voter.
auId
String The id for the au being polled.
caller
String The id of who called the poll.
start
Long The timestamp for when the poll started. format: int64
status
String The current status of the poll.
deadline
Long The deadline for voting in this poll. format: int64
pollKey
String Key generated by poll manager when poll was created.
detailLink (optional)

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

aus_import_body Up

targetBaseUrlPath
String The base URL path of the target AU
targetUrl
String The target AU URL
userProperties (optional)
array[String] The user-specified properties
file
byte[] The content of the file to be imported format: binary

hasherWsParams Up

The parameters of a hash operation
auId
String The identifier of the Archival Unit content to be hashed
url
String The identifier of the URL content to be hashed
lower
String The lower boundary URL
upper
String The upper boundary URL
recordFilteredStream
Boolean An indication of whether the filtered stream should be recorded
excludeSuspectVersions
Boolean An indication of whether to exclude suspect versions
includeWeight
Boolean An indication of whether to include hash weight
algorithm
String The name of the hashing algorithm to be used [SHA-1 (or SHA1), MD5 or SHA-256]
hashType
String The type of hashing to be performed [V1Content, V1Name, V1File, V3Tree or V3File]
resultEncoding
String The result encoding to be used [Base64 or Hex]
challenge
String The encoded challenge
verifier
String The encoded verifier

peerWsResult Up

The properties of a peer
peerId
String The identifier of the Archival Unit

pollWsResult Up

The properties of a poll
auId
String The identifier of the Archival Unit
auName
String The name of the Archival Unit

repositorySpaceWsResult Up

Information about the requested repository spaces
repositorySpaceId
String The Repository Space identifier

repositoryWsResult Up

Information about the requested repositories
repositorySpaceId
String The Repository Space identifier

voteWsResult Up

The properties of a vote
auId
String The identifier of the Archival Unit
auName
String The name of the Archival Unit