Platform Explorer / Nuxeo Platform 6.0

Operation NuxeoDrive.Rename

Nuxeo Drive: Rename

Description

Operation id NuxeoDrive.Rename
Category Services
Label Nuxeo Drive: Rename
Requires
Since

Parameters

Name Description Type Required Default value
id string yes  
name string yes  

Signature

Inputs void
Outputs blob

Implementation information

Implementation class org.nuxeo.drive.operations.NuxeoDriveRename
Contributing component org.nuxeo.drive.operations.NuxeoDriveGetRootsOperation

JSON definition

{
  "id" : "NuxeoDrive.Rename",
  "label" : "Nuxeo Drive: Rename",
  "category" : "Services",
  "requires" : null,
  "description" : "Rename the document backing the file system item with the given id to the given name. Return the file system item backed by the renamed document as a JSON blob.",
  "url" : "NuxeoDrive.Rename",
  "signature" : [ "void", "blob" ],
  "params" : [ {
    "name" : "id",
    "description" : "Id of the file system item backed by the document to rename.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "name",
    "description" : "The new name.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}