Items

Preview trashing items

Returns what POST /items/trash would move to the trash for the same ids: each item and every item you can read that a cascading edge such as parent-of reaches, or comment or attachment whose hosts would all be in the trash. Nothing changes.

POST
/items/trash-preview

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Header parameters

X-Marfa-Instance-Id?string

The ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.

Match^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

application/json
  1. body
ids*array<string>

The IDs of the items you would trash, at most 20.

Items1 <= items <= 20

Response body

About errors

Returns the items and what their trash would take.

application/json
  1. response

What trashing items would move to the trash. Items you can't read are taken too and aren't listed or counted.

items*array<>

Each item you named, once, in the order you named them.

count*integer

How many items you can read that trashing the named items would move to the trash, each counted once, the named items included.

digest*string

A SHA-256 hash, in hex, of every item count counts with its version, listed or not. It changes if any of them changes, joins or leaves. Pass it to POST /items/trash with the same ids to trash only what it covers.

  • invalid_id: an ID in ids is not an item ID.
  • missing_required_field: ids is missing.
  • edge_constraint_violation: a cascade_on_delete: block edge holds a named item or one its trash would take.
  • validation_error: a named item is a live system.connection, ids is empty or has over 20 IDs, or the body has a field this endpoint doesn't take.
application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

  • type_not_permitted: you can read the item's type but don't have write on it, or your credential reaches no type. details.grant names the missing grant.
application/json
  1. response

An error response.

error*

What went wrong.

  • item_not_found: an ID in ids names no item, or names an item whose type you can't read. If that item is in the trash and you can read its type, details.trashed is true.
application/json
  1. response

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

application/json
  1. response

An error response.

error*

What went wrong.

instance_changed: X-Marfa-Instance-Id names another instance. Nothing is written. Rebuild the working copy from the instance at this address.

application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

request_too_large: the request body is larger than this instance accepts.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X POST 'http://localhost:8600/items/trash-preview' \  -H 'Content-Type: application/json' \  -d '{  "ids": [    "string"  ]}'
About errors
{  "items": [    {      "id": "01a1011a-c2a3-78ab-88fe-01dda6454da2",      "type": "acme.contact",      "version": 1,      "takes": [        {          "id": "01a1012b-f1d2-7b86-a3e9-0c5d7e4b2a69",          "type": "core.comment",          "version": 1        }      ],      "count": 2    }  ],  "count": 2,  "digest": "1023138a64a006e1e1a612ca419385d9f11c3729c2f691985fecc5f46dbae0dd"}