Skip to main content

Deposit

A deposit session against an RO-Crate.

A deposit is opened against a new RO-Crate (POST /deposits) or an existing one (POST /ro-crate/{id}/deposits), staged with a metadata document and files, then finalised. Deposits are single-use: once complete they are finished, and further changes open a new deposit.

depositIdstringrequired

Server-minted opaque identifier for this deposit.

Example: dep_8f14e45f
roCrateIdstring<uri>required

A URI-based identifier, used to reference the entity or file in the RO-Crate. This ensures global uniqueness and enables cross-linking of entities.

Example: https://catalog.paradisec.org.au/repository/NT1/001
statestringrequired

The deposit's lifecycle state. open - accepting staging calls; finalising - a finalise is in progress and staging calls are rejected with 409; complete - the RO-Crate's new version is published (terminal); aborted - explicitly aborted or expired, staged content discarded (terminal). A failed finalise returns the deposit to open with the failure recorded in errors.

Possible values: [open, finalising, complete, aborted]

Example: open
createdAtstring<date-time>

When the deposit was created. This is also the moment the carry-forward baseline is pinned for update deposits.

files object[]

The files staged in this deposit, with per-file upload status. Status MAY be updated eagerly or lazily; finalise is the authoritative verification point.

  • Array [
    • fileIdstring<uri-reference>required

    The file entity's @id in the deposited metadata document. For attached files this is the crate-relative path.

    Example: NT1-001-001A.mp3
    statusstringrequired

    pending - staged in presigned mode and the bytes have not (yet) been observed; received - the bytes are held. Finalise remains the authoritative verification point.

    Possible values: [pending, received]

    Example: received
    sizeinteger<int64>

    The file's size in bytes, where declared or known.

    Possible values: >= 0

    Example: 2048576
  • ]
    • errors object[]

    The violations recorded when the most recent finalise failed and the deposit returned to open. Cleared when the next finalise is accepted; absent when there has been no failure.

  • Array [
    • fieldstring

    The field or file the violation concerns

    messagestring

    Validation error message

    value

    The invalid value

  • ]
    • Deposit
    {
      "depositId": "dep_8f14e45f",
      "roCrateId": "https://catalog.paradisec.org.au/repository/NT1/001",
      "state": "open",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "files": [
        {
          "fileId": "NT1-001-001A.mp3",
          "status": "received",
          "size": 2048576
        }
      ],
      "errors": [
        {
          "field": "NT1-001-001A.wav",
          "message": "staged file bytes not received"
        }
      ]
    }