Skip to content
yeekatee devs

GetTree

GET
/trees/{treeId}

Retrieves the information of a given tree.

Authorizations

Parameters

Path Parameters

treeId
required

Tree unique ID.

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

Tree unique ID.

Responses

200

GetTree 200 response

object
treeId
required

Tree unique ID.

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

Tree name.

string
isDynamic

Is a dynamic tree?

boolean
versions

Tree versions.

Array<object>
object
treeVersionId
required

Tree version unique ID.

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

Tree start date.

number
endDate

Tree end date.

number

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

404

NotFoundError 404 response

object
message
required
string

500

InternalServerError 500 response

object
message
required
string

503

ServiceUnavailableError 503 response

object
message
required
string