---

Purpose

Obtains one or more properties of a Toggl Time Entry, given its ID.

---

Macro Compatibility

---

Usage

This macro may only run if you have the appropriate Toggl subscription. Admins can set a default Workspace ID in the Toggl Connection (Configuration section), instead of specifying the 'workspaceId' parameter in the macro (which when set takes precedence), like this: { "DefaultWorkspaceId" : 1234567 }. See the Connecting to Toggl help for more details.

---

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
properties	List<String>	Use instead of: property		Mandatory	The property or properties to obtain, each separated by a semi-colon e.g. properties=id;propertyA;propertyB.	All AllAsJObject AllAsJson BillableAmountInCents Currency Description HourlyRateInCents IsBillable ProjectId RowNumber TagIds TaskId TimeEntries UserId Username	N/A
property	List<String>	Deprecated	properties		The property or properties to obtain, each separated by a semi-colon e.g. properties=id;propertyA;propertyB.	All AllAsJObject AllAsJson BillableAmountInCents Currency Description HourlyRateInCents IsBillable ProjectId RowNumber TagIds TaskId TimeEntries UserId Username	N/A
workspaceId	Int64			Conditional	This can be set in 1) the macro or 2) in a macro default (by an Admin) or 3) in the Toggl Connection's Configuration section (by an Admin), in that order of precedence.	N/A	0
calculate	String			Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
colorTableCell	Boolean			Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
comment	String			Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
connectionName	String			Optional	The name of the Toggl Connection.	N/A	N/A
errorOnOverflow	Boolean			Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
failureText	String			Optional	The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message.	N/A	N/A
fontBackgroundColor	Color			Optional	The font background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontBold	Boolean			Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fontColor	Color			Optional	The font color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontSize	Double			Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A
format	String			Optional	The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings.	N/A	N/A
from	DateTimeOffset			Optional	Only include items since this date time in the format YYYY-MM-DD. If not set, defaults to the first day of the last calendar month.	N/A	N/A
hidden	Boolean			Optional	Whether to hide the macro output.	true false	false
id	Int64	Deprecated	timeEntryId		The Time Entry ID.	N/A	0
ids	Int64	Deprecated	timeEntryId		The Time Entry ID.	N/A	0
if	String			Optional	The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z').	N/A	true
mode	MacroMode			Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
obfuscation	ObfuscationType			Optional	Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen.	None UkTown DeviceName Company IpAddress PrivateIpAddress	None
outputListsAsJarray Normal mode	Boolean			Optional	Any macros that output lists can optionally (in Normal mode) output a jArray instead.	true false	true
redact	Boolean			Optional	Whether substituted variables are hidden from macro results (and the word 'REDACTED' will appear in progress screens and elsewhere in the web UI).	true false	false
singleValueList Normal mode	Boolean			Optional	In Normal Mode and for macros that output JArrays only, whether to convert a JArray of single-property jObjects into a flat JArray of values.	true false	false
storeAs	String			Optional	The variable to store the result as.	N/A	N/A
storeAsHidden	String			Optional	The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'.	N/A	N/A
storeAsVariableDelimiter	Char			Optional	The delimiter used by storeAs to split the input (Legacy mode only), when there are multiple stored variables. For example, in this macro, we indicate that the value to be stored should be split by the asterisk when being stored: [String:value=a*b*c*d, storeAs=var1;var2;var3;var4, storeAsVariableDelimiter=*]	N/A	;
storeFormattedValueAs	String			Optional	The name of the STRING variable to store the result as and output (both will use the same format) into the report. Note that if you also use 'storeAsHidden' in the same macro, you should not expect the output to be hidden, as this parameter overrides that.	N/A	N/A
timeEntryId	Int64	Use instead of: id ids		Optional	The Time Entry ID.	N/A	0
to	DateTimeOffset			Optional	Only include items until this date time in the format YYYY-MM-DD. If not set, defaults to the last day of the last calendar month.	N/A	N/A
warning	String			Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A

---

Examples (1)

Example 1:

This example obtains various properties for a Toggl Time Entry, specified by its workspace ID and time entry ID:

[Toggl.WorkspaceList: properties=Id;Name;Created, =>MyWorkspaces][Json.List: jArray=`{MyWorkspaces}`, jsonPath="$.[0].Id", =>FirstWorkspaceId][Toggl.ProjectList: workspaceId={FirstWorkspaceId}, properties=Id;Name, =>ProjectIdsAndNames][Json.List: jArray=`{ProjectIdsAndNames}`, jsonPath="$.[*].Id", =>AllProjectIds][Toggl.TimeEntryList: workspaceId={FirstWorkspaceId}, property=Id, projectIds={AllProjectIds}, =>TimeEntrys][Json.List: jArray=`{TimeEntrys}`, jsonPath="$.[0].Id", =>FirstTimeEntryId][Toggl.TimeEntryProperty: timeEntryId={FirstTimeEntryId}, workspaceId={FirstWorkspaceId}, properties=Username;Description;TimeEntries, storeAs=Details]