Team

Class finesse.restservices.Team

Extends finesse.restservices.RestBase Common Parameters

Represents a team and contains the URI, team name, and the users associated with the team. The Team object does not contain a full user object for each of the team's users, but a summary object that contains the User URI, loginId, firstName, lastName, ReasonCode, and extension parameters.

Example

Code Snippet

Copyvar _team = new finesse.restservices.Team({
    id: id,
    onLoad: _onTeamLoad,
    onChange: _onTeamChange,
    onError: _onTeamError
})

For additional parameters and methods, see RestBase Common Parameters.

Methods

getId()

Retrieves the team Id.

Returns

{String} The Id of the team.

getName()

Retrieves the team name.

Returns

{String} The name of the team.

getUsers(options)

Retrieves a collection of the users in the team.

Parameters


Name	Type	Description	Required
options	Object	Options for the Users collection object. For additional parameters and methods, see RestCollectionBase Common Parameters.	Yes

Returns

{Object} The collection of User object representing the users in the team.

For additional parameters and methods, see RestBase Common Parameters.