Name
Within a project, each object has a name, which is a UTF-8 string which must not match the regular expression [\x00-\x1F]. This means 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
/class-xxxx/renameSpecification
Renames an existing object in the specified project.
Inputs
projectstring ID of the project or container containing the object to be modifiednamestring The new name of the object
Outputs
idstring ID of the manipulated object
Errors
InvalidInput (the input is not a hash,
projectis missing or is not a string,nameis 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)
Last updated
Was this helpful?