Item Resource

The Item resource, also called a Processed Item, describes an item in the APTrust work queue, and includes the following fields:
  • id - (int) The item's unique ID.
  • created_at - (datetime) When this record was created.
  • updated_at - (datetime) When this record was last updated.
  • name - (string) The name of the tar file that was originally uploaded into the receiving bucket by the member.
  • etag - (string) The etag of the originally-uploaded tar file, as calculated by Amazon's S3 service. For tar files under 5GB that were uploaded in a single transaction, this will be the md5 file's digest. For files uploaded via multipart upload, and all files over 5GB in size, this will look like an md5 checksum, followed by a dash, followed by the number of chunks that comprised the upload and will not match the file's md5 checksum. AWS has some documentation on how etags for multipart uploads are calculated here.
  • bucket - (string) The name of the receiving bucket into which the original tar file was uploaded.
  • user - (string - nullable) The email address of the user who put the request into the queue. This will appear only on requests for restoration, deletion and copying to DPN.
  • institution - (string) The domain name of the institution that owns the bag.
  • note - (string) Contains human-readable information about the outcome of the work request. This is generally used to record error messages.
  • action - (string) The type of action requested. It will be one of the following, though this list may grow as APTrust adds services:
    • Ingest - 
    • Fixity Check - 
    • Restore - 
    • Delete - 
    • DPN - 
  • stage - (string)
    • Requested - 
    • Receive - 
    • Fetch - 
    • Unpack - 
    • Validate - 
    • Store - 
    • Record - 
    • Cleanup - 
    • Resolve - 
  • status - (string)
    • Pending - 
    • Started - 
    • Success - 
    • Failed - 
    • Cancelled - 
  • outcome - (string - nullable)
  • bag_date - (datetime)
  • date - (datetime)
  • retry - (boolean)
  • reviewed - (boolean)
  • object_identifier - (string - nullable)
  • generic_file_identifier - (string - nullable)


Updated on Feb 19, 2016 by Andrew Diamond (Version 7)