Skip to end of banner
Go to start of banner

tempoDeleteAllocationForUser

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

« Previous Version 5 Next »

Syntax

tempoDeleteAllocationForUser(user, startDate, endDate[, issueKey])

Description

This routine deletes the allocation for a given user between specified dates, optionally filtering for a given issue. Specifically:


If we note:

sd = start date
ed = end date
ASD = allocation start date
AED = allocation end date
**** = modified allocation
---- = allocation interval to free
==== = timeline

the following actions will be taken:

============ ASD **** sd ---- ed **** AED =================== => split (i.e. 2 allocs)
============ ASD **** sd ------------ AED ---- ed =========== => move AED to sd
============ ASD **** sd ------------ AED/ed ================ => move AED to sd
============ sd/ASD ------------ ed **** AED ================ => move ASD to ed
============ sd/ASD -------------------- AED ---- ed ======== => delete
============ sd/ASD -------------------- AED/ed ============= => delete
============ sd ---- ASD ------------ ed **** AED =========== => move ASD to ed
============ sd ---- ASD -------------------- AED --- ed ==== => delete
============ sd ---- ASD -------------------- AED/ed ======== => delete

(warning) This routine is only available if Tempo Planner plugin is installed.

Parameters

Parameter name

Type

Required

Description

user

string

Yes

The user you are deleting the allocations for.

startDate

date

Yes

The start date; mandatory

endDatedateYesThe stop date; mandatory
issueKeystringNoThe issue key to delete allocation. Optional

Return type

TempoAllocation []

See also

Filter by label

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

  • No labels