DSpace.API.Source (dspace_ex v0.1.0-alpha2)

Copy Markdown View Source

Operations for working with external authority sources.

Summary

Functions

Fetches the configuration for the given external authority source.

Fetches an entry from an external source by ID.

Searches an external authority source for entries matching the given query.

Lists all configured external authority sources.

Functions

config(name, options)

@spec config(
  binary(),
  keyword()
) :: DSpace.API.Operation.JSON.t()

Fetches the configuration for the given external authority source.

fetch(id, options)

@spec fetch(
  binary(),
  keyword()
) :: DSpace.API.Operation.JSON.t()

Fetches an entry from an external source by ID.

Options

  • :source - The external source name as an atom or string (required)

find_entries(query, options \\ [])

@spec find_entries(
  binary(),
  keyword()
) :: DSpace.API.Operation.JSON.t()

Searches an external authority source for entries matching the given query.

This operation can be streamed.

Options

  • :source - The external source name as an atom or string (required)
  • :page - Page number (0-based, defaults to 0)
  • :size - Number of items per page (usually defaults to 20)

list(options \\ [])

Lists all configured external authority sources.

This operation can be streamed.

Options

  • :page - Page number (0-based, defaults to 0)
  • :size - Number of items per page (usually defaults to 20)