DOIP Client Library - JavaScript Version
    Preparing search index...

    Interface DigitalObject

    A digital object is the fundamental entity in DOIP, consisting of an identifier, type, attributes, and optional binary elements.

    const digitalObject: DigitalObject = {
      id: "20.500.123/1",
      type: "Document",
      attributes: {
        content: {
          name: "Example Document",
          description: "This is an example digital object"
        }
      }
    };
    interface DigitalObject {
        id?: string;
        type?: string;
        attributes: Record<string, Json>;
        elements?: Element[];
    }
    Index

    Properties

    id? type? attributes elements?

    Properties

    id?: string

    The unique identifier of the digital object. This is generally optional when creating a new object (the service will assign an ID), but will be present when retrieving an existing object.

    type?: string

    The type of the digital object. This typically corresponds to a schema that defines the structure of the object's attributes.

    attributes: Record<string, Json>

    The attributes (metadata) of the digital object. This is a flexible record that can contain any JSON-serializable data.

    elements?: Element[]

    Optional binary elements associated with the digital object. These can represent files, attachments, or other binary data.

    Settings

    Member Visibility

    On This Page

    Properties