DB.ARCHIVE

POST 

To archive documents in a collection. Archiving will still exist, but it will no longer be available to query. You will need to unarchive the documents.

Request

application/json

Body

action stringrequired

Default value: db.archive

The action name

collection stringrequired

The collection name

matches objectrequired

The matches criteria

Responses

200

Archive or Delete response

application/json

Schema

Schema

data object

_ref string

The reference ID to be used to restore archived or deleted documents

Example (from schema)

{
  "data": {
    "_ref": "string"
  }
}

Loading...