Skip to content

PutTreeVersion

PUT
/treesversions

Creates a new tree version.

Authorizations

Request Body required

object
treeId
required

Tree unique ID.

string
/^[A-Za-z0-9-]+$/
treeVersionId
required

Tree version unique ID.

string
/^[A-Za-z0-9-]+$/
version

Tree version.

string
treeVersionName

Tree version name.

string
startDate

Tree version start date.

string
otherNodeId
required

Tree version other node unique ID.

string
/^[A-Za-z0-9-]+$/
nodes
required

Tree nodes.

Array<object>
object
treeNodeId
required

Tree node unique ID.

string
/^[A-Za-z0-9-]+$/
treeNodeName

Tree node name.

string
properties
object
investmentType

Tree node investment type.

string

Responses

200

PutTreeVersion 200 response

object
success

Tree version creation was successful.

boolean

400

ValidationException 400 response

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

object
message
required

A summary of the validation failure.

string
fieldList

A list of specific failures encountered while validating the input. A member can appear in this list more than once if it failed to satisfy multiple constraints.

Array<object>

Describes one specific validation failure for an input member.

object
path
required

A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.

string
message
required

A detailed description of the validation failure.

string

401

UnauthorizedError 401 response

object
message
required
string

403

ForbiddenError 403 response

object
message
required
string

409

ConflictError 409 response

object
message
required
string

500

InternalServerError 500 response

object
message
required
string

503

ServiceUnavailableError 503 response

object
message
required
string