/record/new
initializeFrom
is set to a hash specifying a record object, then all metadata fields of the new record created are initialized to be the same as the specified record (with the exception of any other specified fields).project
string ID of the project or container to which the record should belong (e.g. the string "project-xxxx")name
string (optional, default is the new ID) The name of the objecttags
array of strings (optional) Tags to associate with the objecttypes
array of strings (optional) Types to associate with the object; see the Types page for details on valid inputhidden
boolean (optional, default false) Whether the object should be hiddenproperties
mapping (optional) Properties to associate with the objectdetails
mapping or array (optional, default { }) JSON object or array that is to be associated with the object; see the Object Details section for details on valid inputfolder
string (optional, default "/") Full path of the folder that is to contain the new objectclose
boolean (optional, default false) Whether the record should be closed immediately after creationparents
boolean (optional, default false) Whether all folders in the path provided in folder
should be created if they do not existinitializeFrom
mapping (optional) Indicate an existing record from which to use the metadata as default values for all fields that are not given:project
string ID of the project or container containing the record to useid
string ID of the record to usenonce
string (optional) Unique identifier for this request. Ensures that even if multiple requests fail and are retried, only a single record is created. For more information, see Nonces.id
string ID of the created record object (i.e. a string in the form "record-xxxx")details
but is not the only key in the hashdetails
but has value other than a stringid
given under initializeFrom
is not a valid record IDnonce
was reused in a request but some of the other inputs had changed signifying a new and different requestnonce
may not exceed 128 bytesproject
is not a project ID)initializeFrom
if a record was specified)folder
does not exist while parents
is false, or the specified project and/or record ID specified in initializeFrom
are not found)/record-xxxx/describe
project
string (optional) Project or container ID to be used as a hint for finding the object in an accessible projectdefaultFields
boolean (optional, default false if fields
is 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 fields
.fields
mapping (optional) include or exclude the specified fields from the output. These selections override the settings in defaultFields
.fields
is present):properties
boolean (optional, default false) Whether the properties should be returneddetails
boolean (optional, default false) Whether the details should also be returnedid
string The object ID (i.e. the string "record-xxxx")fields
or defaultFields
):project
string ID of the project or container in which theclass
string The value "record"types
array of strings Types associated with the objectcreated
timestamp Time at which this object was createdstate
string Either "open" or "closed"hidden
boolean Whether the object is hidden or notlinks
array of strings The object IDs that are pointed to from this objectname
string The name of the objectfolder
string The full path to the folder containing the objectsponsored
boolean Whether the object is sponsored by DNAnexustags
array of strings Tags associated with the objectmodified
timestamp Time at which the user-provided metadata of the object was last modifiedcreatedBy
mapping How the object was createduser
string ID of the user who created the object orjob
string present if a job created the object ID of the job that created the objectexecutable
string present if a job created the object ID of the app or applet that the job was runningsponsoredUntil
timestamp 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)fields
input is set to true
:properties
mapping Properties associated with the objectdetails
mapping or array Contents of the object’s detailsproject
does not exist)project
(if supplied) is not a string, or the value of properties
(if supplied) is not a boolean)project
provided (if any), and VIEW access required for some project containing the specified object (not necessarily the same as the hint provided))