The bag resource is used by the Ingest-Server and Replication Shell. It describes the base attributes of a collection in Chronopolis.
Bag
Field | Type | Description |
---|---|---|
id | Long | The ID of the Bag |
size | Long | The bag's size in bytes |
name | String | The name of the Bag |
creator | String | The user who created the bag in the Ingest Server |
depositor | String | The organization to which the Bag belongs |
status | BagStatus | Status of the Bag |
totalFiles | Long | Number of files in the Bag, including the tag files |
createdAt | DateTime | The date the Bag was created in the ingest server |
updatedAt | DateTime | The last time the Bag was updated |
replicatingNodes | Set<Node> | Nodes who have successfully replicated the bag |
requiredReplications | int | Number of replications required for preservation |
bagStorage | Active Staging Information for a bag's data | |
tokenStorage | StagingStorageModel | Active Staging Information for a bag's tokens |
BagStatus
An enumerated type describing the various states a bag can have in its lifetime.
- DEPOSITED - The ingest-server has created a DB record for the bag after notification from an intake service
- INITIALIZED - The ingest-server has performed necessary tasks before tokenizing (extracting form an archive/file counts and sizes for metadata)
- TOKENIZED - The ingest-server has created ACE tokens for a bag and written them to a file for replication
- REPLICATING - Replication requests have been created for a bag which are currently in progress
- PRESERVED - All replication requests have finished successfully and the number of required replications have been met
- ERROR - Somewhere along the line something bad happened
Deprecated Status Enums
- (1.3.0-RELEASE) REPLICATED
- (1.1.1-RELEASE) STAGED
POST /api/bags/
Description: Deposit a Bag in Chronopolis
Request Body: JSON