Skip to end of banner
Go to start of banner

tempoGetAllocations

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Note that this routine is only available if the Tempo Planner add-on is installed.

Syntax

tempoGetAllocations(user, startDate, endDate[, projects, issues])

Description

Routine returns the allocations that might exists for a user between the specified dates, optionally filtered by projects or even for individual issues. The return is represented by an array of TempoAllocation structures.

All parameters can be empty / null, in which case they will not be used as filter criteria. If all are null, all allocations will be returned, which is something you might be unprepared for.

Parameters

Parameter name

Type

Required

Description

user

string

Yes

The user you are requesting the allocations for. If empty, all allocations for all users will be returned.

startDate

date

Yes

The start date; if null, no such filter will be applied

endDatedateYesThe stop date; if null, no such filter will be applied
projectsstring []NoThe projects array filter; if provided, only allocations on the specified projects will be accounted for
issuesstring []NoThe issues array filter; if provided, only allocations on the specified issues will be accounted for

Return type

TempoAllocation []

See also

Filter by label

There are no items with the selected labels at this time.


  • No labels