executionRankEnabled active.execIds array of strings Must be a list of root executions (either jobs or analyses).rank integer The rank to set all executions to.dryRun boolean (optional) If set to true, the final update call will not be performed.updatedCount integer The amount of execution trees that were updated.file-xxxx/describe, etc.) for each object are determined from the following sources, in decreasing order of priority:describe field set, rather than as just a bare string, this value is used as the describe options (or, if set to the value true, empty describe options are given).classDescribeOptions field contains an entry for the class of the data object (e.g. "file"), this value is used as the describe options (or, if set to the value true, empty describe options are given).classDescribeOptions field contains an entry for the key "*", this value is used as the describe options (or, if set to the value true, empty describe options are given).objects array of strings or mappings array of items, each representing a data object to be described. The array may contain up to 1000 elements. Each item is one of the following:id string ID of the data object to be describeddescribe mapping or boolean (optional) a mapping containing describe options; or the boolean value true, indicating that empty describe options are to be supplied.classDescribeOptions mapping of strings to mappings or booleans (optional) specifies default describe options for each data object class (which may be overridden on a per-object basis). If supplied, this mapping should contain the following keys/values:"file"), indicating a default value to be supplied for all data objects of that class; or the string "*", indicating a default value to be supplied for all data objects that are of classes not otherwise named. For a list of data object classes, see the Data Object Classes reference.true, indicating that empty describe options are to be supplied.results array of mappings the results. This is an array of the same length as the objects field of the input, containing the corresponding describe call results in the same order. For each item in the input, the corresponding item is a mapping with the following fields:describe: mapping (only present if the item was successfully described) the output hash from the describe routeerror: mapping (only present if the item was NOT successfully described) a mapping, containing at least type and message fields, that indicates the nature of the error. See Errors (Protocols)​statusCode: int (only present if the item was NOT successfully described) the HTTP status code that would have been returned if the describe route had been invoked in a standalone mannerobjects is not an array, contains elements that are neither strings nor hashes of the form described above, contains more than 1000 elements, or contains IDs that are not of a data object class; classDescribeOptions contains values that are neither hashes nor the value truejob-xxxx/describe and/or /analysis-xxxx/describe) for each execution are determined from the following sources, in decreasing order of priority:describe field set, rather than as just a bare ID string, the describe field is used as the describe options (or, if set to the value true, empty describe options are given).classDescribeOptions field contains an entry for the class of the execution (i.e. "job" or "analysis"), this value is used as the describe options (or, if set to the value true, empty describe options are given).classDescribeOptions field contains an entry for the key "*", this value is used as the describe options (or, if set to the value true, empty describe options are given).executions array of strings or mappings array of items, each representing an execution to be described. The array may contain up to 1000 elements. Each item is one of the following:id string ID of the execution to be describeddescribe mapping or boolean (optional) a mapping containing the describe options to use for the corresponding execution or true, which is equivalent to specifying the empty hash as the describe optionsclassDescribeOptions mapping of strings to mappings or booleans (optional) specifies default describe options for each execution class (which may be overridden on a per-object basis). If supplied, this mapping should contain the following keys/values:"job" or "analysis"), indicating a default value to be supplied for all executions of that class; or the string "*", indicating a default value to be supplied for all executions that are of classes not otherwise named.true, indicating that empty describe options are to be supplied.results array of mappings an array of the same length as the executions field of the input, containing the corresponding describe call results in the same order. For each item in the input, the corresponding item is a mapping with the following fields:describe: mapping the output hash from the describe routeerror: mapping a mapping, containing at least type and message fields, that indicates the nature of the error.statusCode: int the HTTP status code that would have been returned if the describe route had been invoked in a standalone manner.executions is not an arrayexecutions contains elements that are neither strings nor hashes of the form described aboveexecutions contains more than 1000 elements, or contains IDs that are not of an execution class (i.e. "job" or "analysis")classDescribeOptions contains values that are neither hashes nor the value `true``/project-xxxx/describe method but is used to describe multiple projects at once. Describe options (the mapping normally provided as input to /project-xxxx/describe to customize its output) may be specified for all projects and/or overridden on a per-project basis. The project descriptions and/or error descriptions (for cases in which projects cannot be successfully described) will be returned in the SAME order in which the projects were specified in the input.projects array of strings or mappings array of items representing the projects to be described. The array may contain up to 1000 elements. Each element may be one of the following:defaultDescribeOptionsid string ID of the project to be describeddescribe mapping or boolean (optional, default defaultDescribeOptions) Mapping containing the describe options to use for the corresponding project or true, which is equivalent to specifying the empty hash as the describe optionsdefaultDescribeOptions mapping or boolean (optional, default true) mapping containing describe options or true; defaultDescribeOptions will be used as the describe options for each project in projects specified as a string or specified as a mapping without the describe field.results array of mappings results of invoking /project-xxxx/describe on each project in projects with its corresponding describe options. This is an array of the same length as the projects input, and it contains the results of /project-xxxx/describe in the same order in which the projects were specified in projects. Each result is a mapping with the following fields:describe mapping the output of invoking /project-xxxx/describeerror mapping a mapping containing the type and message fields to indicate the nature of the error; may contain additional fieldsstatusCode int the HTTP status code that would have been returned had /project-xxxx/describe been individually invoked for the projectprojects is not an array; projects contains elements that are neither strings nor mappings; projects contains more than 1000 elements; projects contains project ids that do not match the project ID syntaxproject string project IDfolder string folder path in project to recursively queryinputs mapping where each item is a mapping with the following format: inputName: regexp where inputName is name of an input for an applet and regexp is the query. At least one group must be providedinputName string the name of the inputregexp string regular expression to query for filesbatchInputs array of mappings array of results for each batchPatterninputs mapping each inputName found for the batchPattern.inputNamename string filenameids array array of file-idserror boolean (optional) true if multiple files are found for a single regexpbatchPattern string Pattern of first group matched by the regular expressionproject is not a project ID.regexp is not a valid regular expressionregexp query returns greater than 100,000 resultsproject is requiredproject and id and values being the respective DNAnexus IDs for the project and object.project string (required unless every objects entry contains project) The ID of the default project contextfolder string (optional, default "/") Folder path in project that will be used as the default folder for objects that do not explicitly specify a folder pathobjects array of mappings array of object specifications, each representing a data object to be resolved. The array may contain up to 1000 elements. Each item is a mapping with the following fields:name string the name of the data object to be resolvedfolder string (required if project is specified; otherwise optional, defaults to top level folder input) folder path of the data object to be resolvedproject string (optional, defaults to top level project input) ID of the project in which to resolve this data object. If specified, folder must also be specified in this mapping.results array of array of mappings the results. This is an array that is parallel to the objects input. Specifically, this means that this array has the same length as objects, and results[i] corresponds to objects[i]. Each entry in results contains zero or more mappings, each with the following fields:project: The project ID in which the data object was resolvedid: The data object IDproject is not a project ID. This applies to both the top level project and also to the project input in each element of objects.objects contains more than 1000 elementsfolder if specified, must be a valid folder pathobjects, folder must be specified if project is specifiedproject is required, as well as at least VIEW access to all of the project IDs specified in the objects mappings.fields mapping (optional) specifies the optional fields to include in the output of this method."clientIp"id string ID of the user.
The following fields are only returned if the corresponding field in the fields input is set to true:"clientIp" string IP address as seen by the API server.