Skip to content
This repository has been archived by the owner on Dec 1, 2022. It is now read-only.

Latest commit

 

History

History
65 lines (64 loc) · 19.5 KB

DataDictionary.md

File metadata and controls

65 lines (64 loc) · 19.5 KB
Raw

Data Objects

Name Type Description
accepted boolean Set by the from_node to indicate that it has accepted the request. (Once set to true, this field is read only.)
admin_node string Namespace of the node that has administrative rights to this bag
algorithm string Algorithm used to calculate the value. (read only)
api_root string null or the root location of this node's server. This field MUST NOT be changed during normal operations; it should only change out of band
bag_type string Single character specifying the type of this bag.
'D'->Data, 'I'->Interpretive, 'R'->Rights
bag_uuid_path string UUIDv4 of the target bag
BagReference string bag - UUIDv4 of the associated bag
cancel_reason string Null or the reason for cancelling. The cancel_reason must not be treated as an actionable field; it is only for debugging and analytics. Can only be set at the same time as cancelled.
enum": ["reject","bag_invalid","fixity_reject","other" ]
cancelled boolean Set by either node to immediately end the transaction. (Once set to true, the entire record is read-only)
count integer32 Count of total result set
created_at timestamp DPN-formatted date-time when this record was first created. (read only)
dpn_token apiKey DPN Authorization Token
Error object String of the encountered errors, possibly json formatted.
finished boolean Set by the to_node to indicate the transfer completed successfully. (Once set to true, the entire record is read-only.)
first_version_uuid string UUID of the first version of this bag. (read only)
fixity_algorithm string Name of the fixity algorithm expected for the receipt. (read only)
fixity_algorithms string Array of currently supported fixity algorithm
fixity_check_id string UUIDv4 that uniquely identifies this fixity check. (read only)
fixity_nonce string null or the nonce to be used for verification. (read only)
fixity_value string null or the string of the fixity value calculated by the to_node after transferring the bag to its staging area. (Once set to a value, this field is read only.)
from_node string Namespace of the node sending the bag. This is the node that generated this request. (read only)
ingest_id string UUIDv4 that uniquely identifies this record. (read only)
ingest_node string Namespace of the node that originally ingest this bag. (read only)
ingested boolean Whether the ingested criteria was met or lost (read only)
interpretive array Empty array or array of uuids of this bag's interpretive bags
link string URL of the bag to be transferred. (read only)
local_id string Primary local identifier
local_id string Primary local identifier
member string UUIDv4 of the member who "owns" this bag
member string UUIDv4 that identifies this member. (read only)
name string The name the member goes by
namespace string Lowercase identifier to unambiguously reference this node
next string URL of next page, or null. Note that null (correct) is not "null" (incorrect)
previous string URL of previous page, or null. Note that null (correct) is not "null" (incorrect)
protocol string Name of the transfer protocol. (read only)
protocols string Array of currently supported transfer protocols
region string Region where bags are stored
replicate_from array Array of namespaces of the nodes that this node will replicate from
replicating_nodes array Empty array or array of namespaces of this bag's replicating nodes
replicating_nodes array The node namespaces of nodes that were storing the bag at the time this record was generated. Note that this list should include the state of the replicating nodes after the change. (read only)
replication_id string UUIDv4 that uniquely identifies this replication transfer request. (read only)
repliciate_to array Array of namespaces of the nodes that this node will replicate to
responses string 200: success
201: record created
400: Bad Resource or Illegal Change
401: Authentication Failed
403: Authenticated, Not Authorized
404: Not found
409: Duplicate
restore_from array Array of namespaces of the nodes that this node will restore from
restore_id string UUIDv4 that uniquely identifies this restore transfer request. (read only)
restore_to array Array of namespaces of the nodes that this node will restore to
ResultList object count - Count of total results
next - URL of next page, or null.
previous - URL of previous page, or null.
Note that null (correct) is not "null" (incorrect)
rights array Empty array or array of uuids of this bag's rights bags
size integer64 Size of the bag in bytes. (read only)
size integer64 Size of the bag in bytes
ssh_pubkey string null or the ssh public key of this node
storage string Storage profile for this node
store_requested boolean Set by the from_node after it receives a correct fixity_value to instruct the to_node to complete the replication. (Once set to true, this field is read only.)
stored boolean Set by the to_node to indicate the bag has been transferred into its storage repository from the staging area. The to_node promises to fulfill replicating node duties by setting this field. Must not be set before store_requested. (Once set to true, this field is read only.)
Timestamps object created_at - DPN-formatted date-time when this record was first created.
updated_at - DPN-formatted date-time when this record was last updated
ISO 8601 compliant
http://www.iso.org/iso/home/standards/iso8601.htm
to_node string Namespace of the node receiving the bag. Must not be a replicating_node for the bag being transferred
total_size integer32 Total size of bags from query
type string Type of storage used
updated_at timestamp DPN-formatted date-time when this record was last updated
uuid string Unique UUIDv4 identifier for this bag. (read only)
version integer This bag's version number, beginning with 1. (read only)