Navigation
Basic Operations
Home
Issues & Requests
Member API
Partner Tools
Recent Changes
test page
 

Object Resource

The Object resource represents a single intellectual object, which includes the following fields: 
  • id - (string) APTrust's internal ID for this object. This is for internal use, and APTrust makes no guarantee that it will remain stable or useful to members in any way.
  • title - (string) The title of the intellectual object, taken from the Title tag of the aptrust-info.txt tag file.
  • description - (string) The description of the bag, taken from the Title tag of the aptrust-info.txt tag file. This may be an empty string, as the Description tag contents are optional.
  • access - (string) The access rights to this object, as specified in the Access tag of the aptrust-info.txt tag file. This will be one of the following:
    • consortia - Any APTrust member may view information about this object in the APTrust Web UI.
    • institution - Only users and admins from the object's owning institution can view information about this object.
    • restricted - Users and admins from the object's institution can see that the object is in the repository, but some details about the object are accessible to institutional admins only.
  • bag_name - (string) The name of the bag. This matches the name of the tar file uploaded into the receiving bucket, minus the .tar or .bag00x.of00x.tar extension.
  • identifier - (string) The unique identifier for this bag in the APTrust repository. This is composed of the depositing institution's domain name, plus a slash, plus the bag name. This is the identifier to use when you are looking for a specific bag.
  • state - (string) 'A' for active, 'D' is for deleted. An active bag is one that is still in the repository. Deleted bags have been deleted from the repository by some user. You can find out when a bag was deleted and who requested the deletion by querying the Items endpoint and filtering down to bags with a specific identifier and action=Delete.
  • alt_identifier - (array of strings) Although this is an array of strings, it will always contain either zero or one element. If you sent a value for the Internal-Sender-Identifier field in your bag_info.txt file, that value will appear as the first item in the alt_identifier array.
  • etag - (string) The etag of the tar file you uploaded that eventually became this intellectual object. S3 returns the etag on successful upload. For single-part uploads, the etag is the md5 digest of the tar file. For larger, multipart uploads, the etag looks like an md5 checksum, followed by a dash and the number of parts in the multipart upload. Amazon has some documentation on that here, and you'll find a good overview of how multipart etags are calculated here. The purpose of including the etag in the intellectual object JSON is to help you know which uploaded tar file we used to build your intellectual object. See the ingest documentation for more info about what happens when you upload multiple versions of the same bag.


Updated on Mar 29, 2016 by Andrew Diamond (Version 5)