@spec access_status(binary()) :: DSpace.API.Operation.JSON.t()

Fetches the access status of an item

@spec create(
  map(),
  keyword()
) :: DSpace.API.Operation.JSON.t()

Creates a new item in the archive.

This operation requires administrator privileges.

Options

• :parent - Required. UUID of the collection that will own this item

@spec create_draft(keyword()) :: DSpace.API.Operation.JSON.t()

Creates a new draft item, starting a submission.

In DSpace-speak, draft state data associated with an item is called a "workspace item" and modelled as a separate entity from the main item. Executing this operation will return that data structure.

Options

• :parent - Required. UUID of the collection that will own this item.

@spec create_file_bundle(binary(), map()) :: DSpace.API.Operation.JSON.t()

Creates a new file bundle in an item.

Executing this operation will return an error if a bundle with the same name already exists in the item.

Parameters

• uuid - UUID of the item
• bundle - bundle attributes as a map. Supports "name" (defaults to "ORIGINAL") and "metadata".

@spec create_in_workspace(keyword()) :: DSpace.API.Operation.JSON.t()

Creates a "workspace item".

Alias, prefer create_draft/1.

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

Deletes an item.

Options

• :copy_virtual_metadata - Turn virtual metadata to actual metadata in related items
  • nil - no virtual metadata is expanded (default)
  • :all - all relationships are verified and virtual metadata is migrated
  • :configured - behavior retrieved from configuration
  • "relationship_type_id" - only specific relationship type IDs are migrated

@spec delete_draft(pos_integer()) :: DSpace.API.Operation.JSON.t()

Deletes a draft item from the workspace.

Note: The ws_id param is the workspace ID, not the Item's UUID.

@spec delete_from_workflow(
  pos_integer(),
  keyword()
) :: DSpace.API.Operation.JSON.t()

Deletes a workflow item.

By default, this sends the item back to the submitter's "workspace". With the :expunge option, it permanently destroys the workflow item and its associated item.

Options

• :expunge - If true, permanently deletes the item instead of returning it to the
• submitter's workspace (defaults to false)

@spec delete_from_workspace(pos_integer()) :: DSpace.API.Operation.JSON.t()

Deletes a "workspace item".

Alias, prefer delete_draft/1.

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

Fetches a single item by UUID.

@spec fetch_draft(binary()) :: DSpace.API.Operation.JSON.t()

Fetches the draft associated with an item.

In DSpace-speak, draft state data associated with an item is called a "workspace item" and modelled as a separate entity from the main item. Executing this operation will return that data structure.

@spec fetch_draft_by_id(pos_integer()) :: DSpace.API.Operation.JSON.t()

Fetches a draft by its workspace ID.

Note: The ID of the item in the workspace is an integer and different from the Item's UUID. If you want to fetch a draft via Item UUID, see fetch_draft/1.

@spec fetch_workflow(binary()) :: DSpace.API.Operation.JSON.t()

Fetches the workflow data associated with a given item UUID.

In DSpace-speak, workflow state data associated with an item is called a "workflow item" and modelled as a separate entity from the main item. There is at most one "workflow item" per item.

@spec fetch_workflow_by_id(pos_integer()) :: DSpace.API.Operation.JSON.t()

Fetches a "workflow item" by its ID.

Note: The "workflow item" ID is an integer and different from the Item's UUID. To find a workflow item via Item UUID, see fetch_workflow/1.

@spec fetch_workspace(binary()) :: DSpace.API.Operation.JSON.t()

Fetches the "workspace item" associated with an item.

Alias, prefer fetch_draft/1.

@spec find(keyword()) :: DSpace.API.Operation.JSON.t()

Finds items using Discovery search.

This operation can be streamed.

Parameters

• options - Search options, see DSpace.API.Search.query/1 for details

Examples

# Find all items
iex> Item.find()
%DSpace.API.Operation.JSON{path: "/api/discover/search/objects", ...}

# Find all items with filters
iex> Item.find(filters: [%{filter: "author", operator: "contains", value: "Smith"}])
%DSpace.API.Operation.JSON{...}

# Simple item search with text query
iex> Item.find(query: "elixir programming")
%DSpace.API.Operation.JSON{path: "/api/discover/search/objects", ...}

# Search with additional filters
iex> Item.find(query: "research", filters: [%{filter: "author", operator: "contains", value: "Armstrong"}])
%DSpace.API.Operation.JSON{...}

# Search within a specific collection
iex> Item.find(query: "data", scope: "collection-uuid")
%DSpace.API.Operation.JSON{...}

@spec hide(binary()) :: DSpace.API.Operation.JSON.t()

Hides an item from discovery, making it no longer findable via search.

This is a convenience wrapper around update/3 that sets the discoverable flag to false.

@spec list(keyword()) :: DSpace.API.Operation.JSON.t()

List items from the repository.

Note: Unless you pass a list of specific item UUIDs, this operation requires administrator privileges as it uses the direct database access endpoint. To fetch all items publicly, use find/1 instead. Passing a list of item UUIDs will only work with the CRIS fork of DSpace.

Due to "API limitations", the core endpoint currently only returns published items.

This operation can be streamed.

Options

• :id - Specific item UUIDs as a list
• :page - Page number (0-based, defaults to 0)
• :size - Number of items per page (usually defaults to 20)

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

Lists the file bundles of an item.

This operation can be streamed.

@spec list_in_workflow(keyword()) :: DSpace.API.Operation.JSON.t()

Lists "workflow items", optionally filtered by submitter.

This operation can be streamed.

Options

• :submitter - UUID of the submitter (eperson) to filter by; must be a non-empty binary
• :page - Page number (0-based)
• :size - Items per page

@spec metrics(binary()) :: DSpace.API.Operation.JSON.t()

Fetches stored metrics of an item.

This operation can be streamed.

@spec parent(binary()) :: DSpace.API.Operation.JSON.t()

Fetches the parent collection of an item.

@spec pids(binary()) :: DSpace.API.Operation.JSON.t()

Fetches all persistent identifiers associated with an item.

@spec register_doi(binary()) :: DSpace.API.Operation.JSON.t()

Mints and queues a DOI for registration for a given item.

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

Replaces an existing item.

@spec submit(
  pos_integer() | [pos_integer()],
  keyword()
) :: DSpace.API.Operation.JSON.t()

Submits one or more draft items.

This is the bridge from what in DSpace is called "workspace" to "workflow". Call this when an item is ready for editorial review or archiving. Accepts either a single workspace item ID or a list of IDs.

If no editorial workflow is configured for the collection, the item is published immediately and :archived is returned instead of a "workflow item" map.

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

Updates an existing item.

@spec update_draft(pos_integer(), list()) :: DSpace.API.Operation.JSON.t()

Updates a draft in the workspace.

Note: The ws_id param is the workspace ID, not the Item's UUID.

@spec update_in_workspace(pos_integer(), list()) :: DSpace.API.Operation.JSON.t()

Updates a "workspace item".

Alias, prefer update_draft/2.

@spec withdraw(binary()) :: DSpace.API.Operation.JSON.t()

Withdraws an item from the archive, making it no longer publicly accessible.

This is a convenience wrapper around update/3 that sets the withdrawn flag to true.