_setName

Sets the name of a version of an object.

Parameters

id

The ID of the object version being modified.

name

The name that this version will be set to.

Example

FM_api('Undo_setName', [
    'id'=>'90002',
    'name'=>'2nd-Version'
    ]
);

Result

On Success

{"ok":1}

If nothing is changed by running this function:

{"ok":1,"warning":"no change needed"}

On Failure

If the "id" parameter is not set or has a value less than 1:

{"error":"missing or invalid parameter: id"}

If the "name" parameter value exceeds 32 characters even after being trimmed:

{"error":"name too long. max length 32"}

If the "id" parameter does not match the ID of an existing version:

{"error":"undo entry does not exist"}

Last updated