Class DoipConstants

OK: The operation was successfully processed.

Bad Request: The request was invalid in some way.

Unauthenticated: The client did not successfully authenticate.

Forbidden: The client successfully authenticated, but is unauthorized to invoke the operation.

Not Found: The digital object is not known to the service to exist.

Conflict: The client tried to create a new digital object with an identifier already in use by an existing digital object.

Declined: The service declines to execute the extended operation.

System Error: Error other than the ones stated above occurred.

This operation allows a client to get information about the DOIP service.

• Request attributes: none
• Input: empty
• Response attributes: none
• Output: the default serialization of the DOIP Service Information as a digital object.

This operation requests the list of operations that can be invoked on the target object.

• Request attributes: none
• Input: none
• Response attributes: none
• Output: a serialized list of strings based on the default serialization, each of which is an operation id that the target object supports.

This operation creates a digital object within the DOIP service. The target of a creation operation is the DOIP service itself.

• Request attributes: none
• Input: a serialized digital object. The "id" can be omitted to ask the DOIP service to automatically choose the id.
• Response attributes: none
• Output: the default serialization of the created object omitting element data. Notably, includes the identifier of the object (even if chosen by the client) and any changes to the object automatically performed by the DOIP service.

This operation retrieves (some parts of the) information represented by the target object.

• Request attributes:
  • "element": if specified, retrieves the data for that element
  • "includeElementData": if present, returns the serialization of the object including all element data
• Input: none
• Response attributes: none
• Output: the default output is the serialization of the object using the default serialization without element data. If "element" was specified, the output is a single bytes segment with the bytes of the specified element. If "includeElementData" was specified, the output is the full serialized digital object.

This operation updates (some parts of the) information represented by the target object.

• Request attributes: none
• Input: a serialized digital object. Elements which are not intended to be changed can be omitted from the input.
• Response attributes: none
• Output: the default serialization of the created object omitting element data. Notably, includes any changes to the object automatically performed by the DOIP service.

This operation removes the target digital object from the management of the DOIP service.

• Request attributes: none
• Input: none
• Response attributes: none
• Output: none

This operation is used to discover digital objects by searching metadata contained in the set of digital objects managed by the DOIP service.

• Request attributes:
  • "query": the search query to be performed, in a textual representation
  • "pageNum": the page number to be returned, starting with 0
  • "pageSize": the page size to be returned; if missing or negative, all results will be returned; if zero, no results are returned, but the "size" is still returned
  • "sortFields": a comma-separated list of sort specifications, each of which is a field name optionally followed by ASC or DESC
  • "type": either "id", to return just object ids, or "full", to return full object data (omitting element data); defaults to "full"
• Input: none
• Response attributes: none
• Output: an object based on the default serialization with top-level properties:
  • "size": the number of results across all pages
  • "results": a list of results, each of which is either a string (the object id) or the default serialization of an object omitting element data.