You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

The bag resource is used by the Ingest-Server and Replication Shell. It describes the base attributes of a collection in Chronopolis.

Bag

FieldTypeDescription

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

StagingStorageModel

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

API Methods

Bag API Methods

POST

/api/bags

GET

/api/bags
GET
/api/bags/<id>
GET
/api/bags/<id>/storage/<type>
PUT
/api/bags/<id>/storage/<type>
POST
/api/bags/<id>/storage/<type>/fixity
GET
/api/bags/<id>/storage/<type>/fixity
GET
/api/bags/<id>/storage/<type>/fixity/<alg>



Bag Json Example 
        {
            "id": 2,
            "size": 1030783586432,
            "totalFiles": 173357,
            "bagStorage": {
                "active": true,
                "size": 1030783586432,
                "region": 1,
                "totalFiles": 173357,
                "path": "ncar/acadis_20150419",
                "fixities": [
                    {
                        "value": "c9680a2ec9a367f2f218a3d90dbcde3bcff9ed3eb8f7d9c61e525ba1735270da",
                        "algorithm": "SHA-256",
                        "createdAt": "2017-11-30T11:02:50.85746Z"
                    }
                ]
            },
            "tokenStorage": {
                "active": true,
                "size": 1,
                "region": 2,
                "totalFiles": 1,
                "path": "ncar/acadis_201504192015-06-06",
                "fixities": [
                    {
                        "value": "67593e0c4b02a2cbeb1c2440589373654a44b7ef93c889f6290569e92ced21ea",
                        "algorithm": "SHA-256",
                        "createdAt": "2017-11-30T11:02:50.85746Z"
                    }
                ]
            },
            "createdAt": "2016-06-07T12:26:18.13944Z",
            "updatedAt": "2016-06-07T12:26:18.13944Z",
            "name": "acadis_20150419",
            "creator": "admin",
            "depositor": "ncar",
            "status": "PRESERVED",
            "requiredReplications": 3,
            "replicatingNodes": [
                "ncar",
                "umiacs",
                "ucsd"
            ]
        }

 

  • No labels

All content on the LYRASIS Wiki is licensed under the CC BY (Attribution) license, unless otherwise noted.