| Notetable-plus |
|---|
| applyColStyleToCell | true |
|---|
| heading | 0 |
|---|
| columnTypes | s,s,s,s |
|---|
| multiple | false |
|---|
| columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
|---|
| enableSorting | false |
|---|
|
Syntax | tempoGetAllocations(user, startDate, endDate[, projects, issues]) | Package | tempo | Alias | | Pkg Usage | getAllocations(user, startDate, endDate[, projects, issues]) | |
| Warning |
|---|
| Note that this routine is only available if the Tempo Planner add-on is installed. |
Syntax
tempoGetAllocations(user, startDate, endDate[, projects, issues])
Description
Description
| Excerpt |
|---|
|
| Routine returns the allocations that might exists for a user between the specified dates, optionally filtered by projects or even for individual issues |
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
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| columnTypes | s,s,s,s |
|---|
| heading | 0 |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
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. | endDate |
|
...
Date | Yes | The stop date; if null, no such filter will be applied. | projects |
|
...
String [] | No | The projects array filter; if provided, only allocations on the specified projects will be accounted for. | issues |
|
...
String [] | No | The issues array filter; if provided, only allocations on the specified issues will be accounted for. |
|
Return
...
Type
TempoAllocation []
See also
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 25 |
|---|
| showSpace | false | sort | title |
|---|
| cql | label = "tempo-planner"_routine" and space = currentSpace ( ) |
|---|
| labels | array_routines |
|---|
|