regionbegins with "aws:") are the following:
maximumPartSize: 5368709120 (5 GiB)
minimumPartSize: 5242880 (5 MiB)
maximumFileSize: 5497558138880 (5 TiB)
projectstring ID of the project or container to which the record should belong (e.g. the string "project-xxxx")
namestring (optional, default is the new ID) The name of the object
tagsarray of strings (optional) Tags to associate with the object
typesarray of strings (optional) Types to associate with the object
hiddenboolean (optional, default false) Whether the object should be hidden
propertiesmapping (optional) Properties to associate with the object
folderstring (optional, default "/") Full path of the folder that is to contain the new object
parentsboolean (optional, default false) Whether all folders in the path provided in
foldershould be created if they do not exist
mediastring (optional, default "") The Internet Media Type (formerly known as MIME type or Content-type) of the file
idstring ID of the created file object (i.e. a string in the form "file-xxxx")
detailsbut is not the only key in the hash
detailsbut has value other than a string
noncewas reused in a request but some of the other inputs had changed signifying a new and different request
noncemay not exceed 128 bytes
projectis not a project ID
folderdoes not exist, and
fileUploadParameters.minimumPartSizefield of the /project-xxxx/describe output. If the
fileUploadParameters.emptyLastPartAllowedfield of the /project-xxxx/describe has the value
false, then the last part must contain at least 1 byte.
sizeint The size in bytes of this file part
urlstring A URL (of the https scheme) to which data may be sent via HTTP PUT
expirestimestamp Time at which
urlwill expire; this will be a couple of minutes in the future
headersmapping HTTP headers which must be supplied with any PUT request to
sizemust be a non-negative integer, no greater than
sizemust be at least
md5must be a hex string of the appropriate length
index(if provided) must a positive integer, no greater than
idof the file, and by the
watermarkVersionassociated with the file in a specific project. The third-party data provider may update the watermark to a new version from time to time, thus changing the content of the watermarked file associated with the changed watermark.
projectstring (optional) Project or container ID to be used as a hint for finding the object in an accessible project. This field should be provided to get consistent output for watermarked files.
defaultFieldsboolean (optional, default false if
fieldsis supplied, true otherwise) whether to include the default set of fields in the output (the default fields are described in the "Outputs" section below). The selections are overridden by any fields explicitly named in
fieldsmapping (optional) include or exclude the specified fields from the output. These selections override the settings in
partsboolean (optional, default true if file is in the "open" state and false otherwise) Whether additional information for each part should be returned
propertiesboolean (optional, default false) Whether the properties should be returned
detailsboolean (optional, default false) Whether the details should also be returned
idstring The object ID (i.e. the string "file-xxxx")
projectstring ID of the project or container in which the object was found
classstring The value "file"
typesarray of strings Types associated with the object
createdtimestamp Time at which this object was created
statestring The value "open", "closing", or "closed"
hiddenboolean Whether the object is hidden or not
linksarray of strings The object IDs that are pointed to from this object
namestring The name of the object
folderstring The full path to the folder containing the object
sponsoredboolean Whether the object is sponsored by DNAnexus
tagsarray of strings Tags associated with the object
modifiedtimestamp Time at which the user-provided metadata of the object was last modified
mediastring The Internet Media Type of the file
createdBymapping How the object was created
userstring ID of the user who created the object or launched an execution which created the object
jobstring present if a job created the object ID of the job that created the object
executablestring present if a job created the object ID of the app or applet that the job was running
partsmapping Information on the file parts that have been or are being uploaded
statestring Either "pending" or "complete"
sizeint or null The size of the part (in bytes) if
stateis "complete"; null otherwise
sizeint Size of the file in bytes
sponsoredUntiltimestamp Indicates the expiration time of data sponsorship (this field is only set if the object is currently sponsored, and if set, the specified time is always in the future)
fieldsinput is set to
propertiesmapping Properties associated with the object
detailsmapping or array Contents of the object’s details
watermarkIdstring ID of the watermark applied to the file's content during download
watermarkVersionstring version of the watermark's content applied to the file's content during download
resolvedPoliciesmapping A mapping of policies affecting file-xxxx within the scope of a single project. Note that
projectmust be specified in the input to receive consistent results. Also note that policies may be updated by your data provider at any time. Fields in this mapping will be:
isExternalDownloadableboolean True if file-xxxx is able to be downloaded, false otherwise.
project, if specified, does not exist
projectis specified, VIEW access is required to that project
true, there must be at least one part.
detailfield will be set as shown in "Outputs" below.
idstring ID of the manipulated object (i.e. the string "file-xxxx")
detailstring String containing an explanatory message
trueand there are zero parts
falseand the part with the highest index has 0 bytes
durationint (optional, default is equivalent to 24 hours) Number of seconds (starting from the time this call is made, according to the server) during which the generated URL will be valid
filenamestring (optional) The desired filename of the downloaded file, to be affixed to the returned URL. If provided, this filename will be encoded as a URI component and affixed to the download URL, whose resource portion will end in e.g. '/filename', to ease downloads through web browsers and utilities such as wget.
projectstring (optional) ID of a project containing the file, with which the download URL will be associated. Requests to the download URL will succeed only so long as 1. the file still resides in this project and 2. the user who generated the URL still has at least VIEW permission to this project. If this value is not provided, the URL will work so long as the file resides in any project to which the user who generated the URL has at least VIEW permission. This field must be provided to get the download URL for a watermarked file when invoked outside the context of a DNAnexus job.
preauthenticatedboolean (optional, default false) Whether to generate a "preauthenticated" download URL, which embeds any necessary authentication information in the URL itself, rather than requiring separate request headers
stickyIPboolean (optional if
preauthenticatedis true; required to be false otherwise; default false) Whether HTTP GET requests to the preauthenticated download URL should be restricted to a single origin IP address. If
preauthenticatedare true, then the first HTTP GET request to the preauthenticated download URL will dictate the IP address from which all subsequent requests must originate.
urlstring An absolute URL to which HTTP GET requests can be made to download the file
headersmapping HTTP headers which MUST be supplied with any GET request to url
projectis specified but the file object is not in the specified project
projectis specified, VIEW access is required to that project
duration(if provided) is not a positive integer
/file-xxxx/downloadrequests to the separate endpoint
https://api.dnanexus.com. Browser requests to non-preauthenticated file download URLs are authenticated by means of a URL-specific cookie, set by the API server's response to the
/file-xxxx/downloadroute on this separate endpoint.