endpoints.md

Endpoints

REST Overview Documentation

Available Endpoints

• /api/core/sites
• /api/core/communities
• /api/core/collections
• /api/core/items
• /api/core/itemtemplates
• /api/core/bitstreams
• /api/core/bitstreamformats
• /api/core/bundles
• /api/core/metadatafields
• /api/core/metadataschemas
• /api/core/epersons
• /api/eperson/orcidqueues
• /api/eperson/orcidhistories
• /api/eperson/profiles
• /api/core/groups
• /api/core/{model}/search
• /api/authn/login
• /api/authn/logout
• /api/authn/status
• /api/config/harvestermetadata
• /api/config/submissiondefinitions
• /api/config/submissionsections
• /api/config/submissionforms
• /api/config/submissionuploads
• /api/config/submissionaccessoptions
• /api/config/workflowdefinitions
• /api/config/workflowsteps
• /api/discover/browses
• /api/discover/search
• /api/pid
• /api/submission/workspaceitems
• /api/submission/vocabularies
• /api/submission/vocabularyEntryDetails
• /api/system/systemwidealerts
• /api/versioning/versions
• /api/versioning/versionhistories
• /api/workflow/workflowitems
• /api/workflow/pooltasks
• /api/workflow/claimedtasks
• /api/tools/feedbacks
• /api/integration/qualityassurancesources
• /api/integration/qualityassurancetopics
• /api/integration/qualityassuranceevents
• /api/integration/suggestions
• /api/integration/suggestionsources
• /api/integration/suggestiontargets
• /api/submission/duplicates
• /api/security/csrf (added in DS8)

Endpoints Under Development/Discussion

• /api/authz/resourcepolicies
• /api/config/bulkaccessconditionoptions
• /api/authz/authorizations
• /api/authz/features
• /api/statistics
• /api/tools/itemrequests
• /api/contentreport/filteredcollections
• /api/contentreport/filtereditems

Actuator endpoints

The following endpoints are implemented using Spring Boot Actuator and are enabled by default:

• /actuator/info
• /actuator/health

For more details see the /actuator endpoint

Other Endpoints (raw list)

• /api/authorize/(dso)
• /api/curate
• /api/export
• /api/app/bulkmetadataedit
• /api/statistics/(dso)
• /api/configuration
  • return relevant configuration values to the client
    • DSpace version
    • Root url
    • Site name
    • Contact info
    • Root handle
    • Supported themes
    • Default language
    • Languages supported
  • question, how will we mark / designate the values that are safe to expose?
• /api/feature
  • return the status of features that are enabled for a site
    • statistics viewing
  • return the status of features that are enabled for authorized users
    • item versioning

Other Endpoints not under /api context

• /oai
  • endpoint for OAI-PMH data provider (if enabled)
• /opensearch
  • endpoint for opensearch service
• /signposting
  • endpoint returning information for linkset (signposting)
• /sword
  • endpoint for sword (if enabled)
• /sword2
  • endpoint for sword2 (if enabled)