Version Reference

Allows user to peform actions on Versions, such as activate, assign, create, discard, checkIn, and suspend.


Parameter nameTypeDescription
outputString The output type for the page. Possible types include 'XML', 'JSON', 'JSONXML', 'HTML', and 'CUSTOM'.
obsIdString (Required for JSON/JSONXML output) The object listening for the JSON callback.
obsSuccessMethodString (Required for JSON/JSONXML output) The JSON success callback function.
obsErrorMethodString (Required for JSON/JSONXML output) The JSON error callback function.
transformerString (Required for CUSTOM output) The XSLT to use to transform the XML output.
actionAlphabetic string(Required) One of the following actions:
activate - activates a pending or suspended Version.
assign - assigns edit permission to another user.
create - creates a new Version.
discard - discards changes.
checkIn - makes changes made by the Version visible to the public.
suspend - sets the Version aside.
versionIdAlpha-numeric string ID of an existing version. In the format: <sessionid>_<record sequence>. For example 1234_5.
(Required when action = activate, assign, discard, checkIn, or suspend)
assigneeIdInteger The assignee's user ID. (Required when action = assign)
recSeqInteger Record sequence - a unique integer to assign to each new Version created in a session. (Required when action = create)
nameString (optional, default: current date and time) Version name. (use when action = create)
descString (optional, default: null) Description (use when action = create)


An xml or json response.