DNAnexus Documentation
Downloadsdx CommandsAPI MethodsLegal
Search…
Overview
Getting Started
User
Developer
Developing Portable Pipelines
Interactive Workstations
Apps
Workflows
Ingesting Data
Dataset Management
Apollo Datasets
Creating Custom Viewers
Client Libraries
Walkthroughs
DNAnexus API
Entity IDs
Protocols
Authentication
Regions
Nonces
Users
Organizations
Cloud Account
Data Containers
Data Object Lifecycle
Data Object Metadata
Name
Properties
Tags
Data Object Classes
Running Analyses
Search
System Methods
Directory of API Methods
DNAnexus Service Limits
Administrator
Science Corner
Downloads
FAQs
Release Notes
Technical Support
Legal
Powered By GitBook
Name
Within a project, each object has a name, which is a UTF-8 string which must not match the regular expression [\x00-\x1F] (i.e. non-printable characters like whitespace tabs and newlines are not allowed). Object names need not be unique within the same project.
The name of an object is returned by the "describe" method, and modified by the "rename" method.

API method: /class-xxxx/rename

Specification

Renames an existing object in the specified project.

Inputs

  • project string ID of the project or container containing the object to be modified
  • name string The new name of the object

Outputs

  • id string ID of the manipulated object

Errors

  • InvalidInput (the input is not a hash, project is missing or is not a string, name is missing or is an empty string or matches the regular expression [\x00-\x1F])
  • ResourceNotFound (the specified object does not exist, the specified project does not exist, or the specified project does not contain the specified object)
  • PermissionDenied (If the object is open, UPLOAD access is required, otherwise CONTRIBUTE access is required for the specified project)
Previous
Data Object Metadata
Next
Properties
Last modified 3yr ago
Export as PDF
Copy link
Contents
API method: /class-xxxx/rename
Specification
Inputs
Outputs
Errors