TimeRocket Public API

Queries all undertaking structures. A structure defines actions and levels that are used by undertakings.

The actions defined by a structure can be shared by its undertakings. In addition, undertakings can have their own specific actions. However, undertaking specific actions can not be aggregated over several undertakings.

Response

Field	Type	Description
structureId	GUID	The ID of the structure.
label	JSON object literal	The label defines how the structure should be presented to users.
label.default	string	The default label. The fallback if no translation is present for a specific language.
label.de	OPTIONAL FIELD string	German translation.
label.en	OPTIONAL FIELD string	English translation.
label.fr	OPTIONAL FIELD string	French translation.
label.it	OPTIONAL FIELD string	Italian translation.

Gets a single undertaking structure.

A structure defines the form of its contained undertakings (levels, structure actions, permission definitions etc.).

Request

structureId: ID of the structure requested.

Response

Field	Type	Description
structureId	GUID	The ID of the structure.
label	JSON object literal	The label defines how the structure should be presented to users.
label.default	string	The default label. The fallback if no translation is present for a specific language.
label.de	OPTIONAL FIELD string	German translation.
label.en	OPTIONAL FIELD string	English translation.
label.fr	OPTIONAL FIELD string	French translation.
label.it	OPTIONAL FIELD string	Italian translation.
actions	array	All actions defined by this structure.
actions[].actionId	GUID	The ID of the action.
actions[].label	JSON object literal	The label of the action.
actions[].label.default / .de / .en / .fr / .it	string / OPTIONAL FIELDS string	The default and, optionally, the translations.
actions[].code	OPTIONAL FIELD string	The code of the action. Only available for structures with enabled codes. It may be empty if the action has no code.
levels	array	The ordered list of levels. Levels are used to group undertakings. Typical levels are "customers", "orders".
levels[].levelId	GUID	The ID of the level.
levels[].singularLabel	JSON object literal	The singular label (e.g. "Customer" or "Order") used for this level.
levels[].singularLabel.default / .de / .en / .fr / .it	string / OPTIONAL FIELDS string	The default and, optionally, the translations.
levels[].pluralLabel	JSON object literal	The plural label (e.g. "Customers" or "Orders") used for this level.
levels[].pluralLabel.default / .de / .en / .fr / .it	string / OPTIONAL FIELDS string	The default and, optionally, the translations.
codes	string	Either with or without. With: structure uses codes to identify undertakings, actions, and multi-actions. Without: no codes are available.

Gets the (active/non-archived) undertaking groups of a structure.

Request

structureId: ID of the structure to get the groups of.

Response

Field	Type	Description
undertakingGroupId	GUID	ID of the group.
label	JSON object literal	The label defines how the group should be presented to users.
label.default	string	The default label. The fallback if no translation is present for a specific language.
label.de	OPTIONAL FIELD string	German translation.
label.en	OPTIONAL FIELD string	English translation.
label.fr	OPTIONAL FIELD string	French translation.
label.it	OPTIONAL FIELD string	Italian translation.
levelId	GUID	The level this group belongs to in the structure.

Gets the permission definitions of a structure.

Permission definitions can be used to authorize persons to write or read activities. In addition, permissions can be granted on individual undertakings.

Request

structureId: ID of the structure to get the groups of.

Response

Field	Type	Description
permissionDefinitionId	GUID	The ID of the
label	JSON object literal	The label defines how the permission definition should be presented to users.
label.default	string	The default label. The fallback if no translation is present for a specific language.
label.de	OPTIONAL FIELD string	German translation
label.en	OPTIONAL FIELD string	English translation
label.fr	OPTIONAL FIELD string	French translation
label.it	OPTIONAL FIELD string	Italian translation
target	string	Eitherallorspecific. all: The permission definition applies to all employees. specific: The fieldpersonsspecifies the persons to whom this permission definition applies.
persons	OPTIONAL FIELD string array	The list of persons (names) to which this permission definition applies. Only available iftarget=specific.

Updates an undertaking group.

Request

Field	Type	Description
label	OPTIONAL FIELD JSON object literal	If specified, the label of the undertaking is updated.
label.default	string	The default label. The fallback if no translation is present for a specific language.
label.de	OPTIONAL FIELD string	German translation
label.en	OPTIONAL FIELD string	English translation
label.fr	OPTIONAL FIELD string	French translation
label.it	OPTIONAL FIELD string	Italian translation

Creates an undertaking.

Request

structureId: ID of the structure

Field	Type	Description
label	JSON object literal	The label defines how the undertaking should be presented to users.
label.default	string	The default label. The fallback if no translation is present for a specific language.
label.de	OPTIONAL FIELD string	German translation
label.en	OPTIONAL FIELD string	English translation
label.fr	OPTIONAL FIELD string	French translation
label.it	OPTIONAL FIELD string	Italian translation
actions	array of JSON object literal	The actions (structure or undertaking-specific) available in this undertaking. The order defines the order shown on the UI.
actions[].kind	string	Either "structure" for structure actions (already defined in the structure) or "undertaking" (undertaking-specific). Undertaking-specific actions are not available to other undertakings.
actions[].structureActionId	OPTIONAL FIELD GUID	The ID of the structure action. Only valid when kind =structure
actions[].undertakingAction	OPTIONAL FIELD JSON object literal	The undertaking-specific action. Only valid when kind =undertaking
actions[].undertakingAction.Label	JSON object literal	The label defines how the undertaking-specific action should be presented to users.
actions[].undertakingAction.code	OPTIONAL FIELD string	The code of the undertaking-specific action. Only available if the structure has codes enabled.
undertakingSpecificActions[].Label.default / .de / .en / .fr / .it	string	The default (required) and translations (optional).
groups	array of GUID	The groups this undertaking belongs to. Must be in the order of the levels given by the structure.
status	OPTIONAL FIELD string	"running"or"planned". If omitted,"running"is used. Other status are currently not supported by the API.
bookableRange	OPTIONAL FIELD string	The range defining when activities can be booked onto this undertaking. "yyyy-MM-dd/yyyy-MM-dd": a range with start and end (from - until) "yyyy-MM-dd/": a range with only a start and no end (from) "/yyyy-MM-dd": a range with no start and only an end (until)
finishedActionsSettings	OPTIONAL FIELD string	"all": all employees can mark actions as finished. "specific": only the persons specified by the field"employeesWhoCanFinishActions"can finish actions omitted: undertaking does not support finishing actions
employeesWhoCanFinishActions	OPTIONAL FIELD array of GUID	Only applicable when"finishedActionsSettings"="specific". The employees' IDs who can mark actions as finished.
permissionDefinitionIds	OPTIONAL FIELD array of GUID	The permission definitions to use for this undertaking.
managers	array of GUID	The employees' IDs who act as managers of this undertaking (e.g. project lead).
code	OPTIONAL FIELD string	The code of this undertaking. Ignored, if the structure does not support codes.

Response

The ID of the newly created undertaking.

Gets an undertaking.

Request

structureId: ID of the structure

undertakingId: ID of the undertaking

Response

Field	Type	Description
undertakingId	GUID	The ID of the undertaking.
label	JSON object literal	The label of the undertaking
label.default	string	The default label. The fallback if no translation is present for a specific language.
label.de	OPTIONAL FIELD string	German translation
label.en	OPTIONAL FIELD string	English translation
label.fr	OPTIONAL FIELD string	French translation
label.it	OPTIONAL FIELD string	Italian translation
groups	array of JSON object literal	The labels of the groups to which this undertaking is assigned.
groups[].default	string	The default label. The fallback if no translation is present for a specific language.
groups[].de	OPTIONAL FIELD string	German translation
groups[].en	OPTIONAL FIELD string	English translation
groups[].fr	OPTIONAL FIELD string	French translation
groups[].it	OPTIONAL FIELD string	Italian translation
status	string	One of - planned - running - finished - archived
bookableRange	string	The range defining when activities can be booked onto this undertaking. "yyyy-MM-dd/yyyy-MM-dd": a range with start and end (from - until) "yyyy-MM-dd/": a range with only a start and no end (from) "/yyyy-MM-dd": a range with no start and only an end (until)
code	string	The code of the undertaking. Empty if none.
actions	array of JSON object literal	The actions of the undertaking.
actions[].kind	string	The kind of the action: -"structure": the action is defined on the structure -"undertaking": it's an undertaking-specific action
actions[].action	JSON object literal	The action.
actions[].action.actionId	GUID	The action's ID.
actions[].action.label	JSON object literal	The label of the action
actions[].action.label.default	string	The default label. The fallback if no translation is present for a specific language.
actions[].action.label.de	OPTIONAL FIELD string	German translation
actions[].action.label.en	OPTIONAL FIELD string	English translation
actions[].action.label.fr	OPTIONAL FIELD string	French translation
actions[].action.label.it	OPTIONAL FIELD string	Italian translation

Updates an undertaking.

Request

structureId: ID of the structure with the undertaking to update.

undertakingId: ID of the undertaking to update.

Field	Type	Description
label	OPTIONAL FIELD JSON object literal	If specified, the label of the undertaking is updated.
label.default	string	The default label. The fallback if no translation is present for a specific language.
label.de	OPTIONAL FIELD string	German translation
label.en	OPTIONAL FIELD string	English translation
label.fr	OPTIONAL FIELD string	French translation
label.it	OPTIONAL FIELD string	Italian translation
code	OPTIONAL FIELD string	If specified, the code of the undertaking is updated. Ignored, if the structure does not support codes.
groups	GUID array	The Group IDs to assign to the undertaking. Needs an ID per level pointing to a group of the corresponding level. Pass "" (empty string) when a level has no assigned group (level settings must be set accordingly).
bookableRange	OPTIONAL FIELD string	If specified, the bookable range is updated. "yyyy-MM-dd/yyyy-MM-dd": a range with start and end (from - until) "yyyy-MM-dd/": a range with only a start and no end (from) "/yyyy-MM-dd": a range with no start and only an end (until)
status	OPTIONAL FIELD string	One of -"planned" -"running" -"finished": fieldfinishermust be specified, too -"archived": fieldarchivermust be specified, too
managers	OPTIONAL FIELD GUID array	The employees' IDs who act as managers of this undertaking (e.g. project lead).
NOT YET AVAILABLE finisher	OPTIONAL FIELD string	Must be specified when status = "finished". The ID of the employee who finished the undertaking.
NOT YET AVAILABLE archiver	OPTIONAL FIELD string	Must be specified when status = "archived". The ID of the employee who archived the undertaking.

Adds an undertaking-specific permission to an undertaking.

Request

structureId: ID of the structure

undertakingId: ID of the undertaking

Field	Type	Description
actions	OPTIONAL FIELD array of GUID	The actions' IDs to include in the permission (structure and undertaking specific actions possible) If omitted, the permission targets the whole undertaking (all actions).
permissionKind	string	"read"or"write"
employees	array of GUID	The employees' IDs to whom this permission applies.

Response

The ID of the newly added undertaking-specific permission.

Updates an undertaking-specific permission of an undertaking.

Request

structureId: ID of the structure

undertakingId: ID of the undertaking

undertakingSpecificPermissionId: ID of the undertaking-specific permission

Field	Type	Description
actions	OPTIONAL FIELD array of GUID	The actions' IDs to include in the permission (structure and undertaking specific actions possible) If omitted, the permission targets the whole undertaking (all actions).
permissionKind	string	"read"or"write"
employees	array of GUID	The employees' IDs to whom this permission applies.

Response

No content.

Removes an undertaking-specific permission from an undertaking.

Request

structureId: ID of the structure

undertakingId: ID of the undertaking

undertakingSpecificPermissionId: ID of the undertaking-specific permission

Response

No content.

Get the undertaking-specific permissions of an undertaking.

Request

structureId: ID of the structure

undertakingId: ID of the undertaking

Response

Field	Type	Description
undertakingSpecificPermissionId	GUID	The ID of the undertaking-specific permission.
permissionKind	string	"read"or"write"
employeeIds	Array of GUID	The IDs of the employees this permission applies to.

Creates a new manual activity.

Request

structureId: ID of the structure with the undertaking to update.

undertakingId: ID of the undertaking to update.

Field	Type	Description
employeeId	GUID	The employee's ID.
actionId	GUID	The action's ID.
workday	yyyy-MM-dd	The date when the activity happenend. This is the date the activity belongs to regarding accounting. It may differ from the calendar date when working over midnight.
duration	OPTIONAL FIELD number	The duration of the activity. Either specifydurationorfromandto.
from	OPTIONAL FIELD hh:mm / hh:mm-shift / hh:mmshift	When the activity started. Either specifydurationorfromandto. The format is one of: hh:mm: local time (e.g. 10:30) hh:mm-shift: local time and a negative day shift (e.g. 23:00-1 = 23:00 on the day before theworkday) hh:mmshift: local time and a (positive) day shift (e.g. 01:001 = 01:00 on the day after theworkday)
to	OPTIONAL FIELD hh:mm / hh:mm-shift / hh:mmshift	When the activity stopped. Either specifydurationorfromandto. The format is one of: hh:mm: local time (e.g. 10:30) hh:mm-shift: local time and a negative day shift (e.g. 23:00-1 = 23:00 on the day before theworkday) hh:mmshift: local time and a (positive) day shift (e.g. 01:001 = 01:00 on the day after theworkday)
description	OPTIONAL FIELD string	An optional description.

Response

The ID of the newly created manual activity.

Query activities.

The result contains

• manual activities: activities enter manually or via the API as manual activities,
• activities generated from attendance by setting a default action,
• multi action activities,
• multi action activities generated from attendance.

Request

structureId: ID of the structure with the undertaking to update.

URL Paramter	Type	Description
employeeIds	OPTIONAL semicolon-delimited list of GUIDs	The employees' IDs to get the activities for. If omitted, the activities of all employees are returned.
groups	OPTIONAL comma-delimited list of GUIDs	Only activities of undertakings in the specified groups are returned. Activities from all undertakings are returned if omitted.
start	yyyy-MM-dd	Only activities betweenstartandendare returned. Including boundaries.
end	yyyy-MM-dd	Only activities betweenstartandendare returned. Including boundaries.
undertakingStatus	OPTIONAL string	One of: "running": only running undertakings are considered "plannedRunningFinished": undertakings that are either planned, running, or finished are considered (archived is excluded) "all": all undertakings are considered If omitted,"running"is used.

Response

Field	Type	Description
kind	string	One of: -"manual activity" -"multi action activity instance" -"activity from attendance" -"multi action activity instance from attendance"
activityId	OPTIONAL FIELD GUID	The ID of the activity. Depending on the type of activity, this is a stable ID (manual activity) or a non-stable ID (other kinds).
multiActionId	OPTIONAL FIELD GUID	The ID of the multi action. Only available whenkindis"multi action activity instance"or"multi action activity instance from attendance".
employeeId	string	The employee's ID.
workday	yyyy-MM-dd	The date this activity belongs to.
undertakingId	GUID	The undertaking's ID.
actionId	GUID	The action's ID.
from	OPTIONAL FIELD hh:mm / hh:mm-shift / hh::mmshift	When the activity started. Only available for activities with start/end information. The format is one of: hh:mm: local time (e.g. 10:30) hh:mm-shift: local time and a negative day shift (e.g. 23:00-1 = 23:00 on the day before the workday) hh:mmshift: local time and a (positive) day shift (e.g. 01:001 = 01:00 on the day after the workday)
to	OPTIONAL FIELD hh:mm / hh:mm-shift / hh::mmshift	When the activity ended. Only available for activities with start/end information. The format is one of: hh:mm: local time (e.g. 10:30) hh:mm-shift: local time and a negative day shift (e.g. 23:00-1 = 23:00 on the day before the workday) hh:mmshift: local time and a (positive) day shift (e.g. 01:001 = 01:00 on the day after the workday)
duration	number	The duration of the activity. Use this number for calculations. Caution: It can be a decimal number. E.g. when 17 minutes is distributed to two activities of a single multi action, resulting in twice 8.5 minutes.
sharedFrom	OPTIONAL FIELD hh:mm / hh:mm-shift / hh::mmshift	Only available for multi action activities and multi action activities from attendance. The start of the shared timeframe. The format is one of: hh:mm: local time (e.g. 10:30) hh:mm-shift: local time and a negative day shift (e.g. 23:00-1 = 23:00 on the day before the workday) hh:mmshift: local time and a (positive) day shift (e.g. 01:001 = 01:00 on the day after the workday)
sharedTo	OPTIONAL FIELD hh:mm / hh:mm-shift / hh::mmshift	Only available for multi action activities and multi action activities from attendance. The end of the shared timeframe. The format is one of: hh:mm: local time (e.g. 10:30) hh:mm-shift: local time and a negative day shift (e.g. 23:00-1 = 23:00 on the day before the workday) hh:mmshift: local time and a (positive) day shift (e.g. 01:001 = 01:00 on the day after the workday)
sharedDuration	OPTIONAL FIELD number	Only available for multi action activities and multi action activities from attendance. The duration of the shared timeframe.
description	string	The description.
action	JSON object literal	The label of the action.
action.default	string	The default label. The fallback if no translation is present for a specific language.
action.de	OPTIONAL FIELD string	German translation
action.en	OPTIONAL FIELD string	English translation
action.fr	OPTIONAL FIELD string	French translation
action.it	OPTIONAL FIELD string	Italian translation
undertaking	JSON object literal	The label of the undertaking.
undertaking.default	string	The default label. The fallback if no translation is present for a specific language.
undertaking.de	OPTIONAL FIELD string	German translation
undertaking.en	OPTIONAL FIELD string	English translation
undertaking.fr	OPTIONAL FIELD string	French translation
undertaking.it	OPTIONAL FIELD string
groups	array of JSON object literal	The labels of the groups the undertaking belongs to. The order is according to the levels of the structure.
groups[].default	string	The default label. The fallback if no translation is present for a specific language.
groups[].de	OPTIONAL FIELD string	German translation
groups[].en	OPTIONAL FIELD string	English translation
groups[].fr	OPTIONAL FIELD string	French translation
groups[].it	OPTIONAL FIELD string	Italian translation

Params

employeeIds	{emloyeeIds}
start	{start}
end	{end}
groups	{groupIds}

Query undertakings of a structure by their status.

Request

structureId: The ID of the structure to be queried.

URL parameter	Type	Description
status	OPTIONAL string	One of: -planned: return planned undertakings -running: return running undertakings -finished: return finished undertakings -archived: return archived undertakings -all: return all undertakings If omitted,runningis used.

Response

Field	Type	Description
undertakingId	GUID	The ID of the undertaking.
label	JSON object literal	The label of the undertaking
label.default	string	The default label. The fallback if no translation is present for a specific language.
label.de	OPTIONAL FIELD string	German translation
label.en	OPTIONAL FIELD string	English translation
label.fr	OPTIONAL FIELD string	French translation
label.it	OPTIONAL FIELD string	Italian translation
groups	array of JSON object literal	The labels of the groups to which this undertaking is assigned.
groups[].default	string	The default label. The fallback if no translation is present for a specific language.
groups[].de	OPTIONAL FIELD string	German translation
groups[].en	OPTIONAL FIELD string	English translation
groups[].fr	OPTIONAL FIELD string	French translation
groups[].it	OPTIONAL FIELD string	Italian translation
status	string	One of - planned - running - finished - archived
bookableRange	string	The range defining when activities can be booked onto this undertaking. "yyyy-MM-dd/yyyy-MM-dd": a range with start and end (from - until) "yyyy-MM-dd/": a range with only a start and no end (from) "/yyyy-MM-dd": a range with no start and only an end (until)
code	string	The code of the undertaking. Empty if none.
actions	array of JSON object literal	The actions of the undertaking.
actions[].kind	string	The kind of the action: -"structure": the action is defined on the structure -"undertaking": it's an undertaking-specific action
actions[].action	JSON object literal	The action.
actions[].action.actionId	GUID	The action's ID.
actions[].action.label	JSON object literal	The label of the action
actions[].action.label.default	string	The default label. The fallback if no translation is present for a specific language.
actions[].action.label.de	OPTIONAL FIELD string	German translation
actions[].action.label.en	OPTIONAL FIELD string	English translation
actions[].action.label.fr	OPTIONAL FIELD string	French translation
actions[].action.label.it	OPTIONAL FIELD string	Italian translation

Params

status	{status}

Request

structureId: ID of the structure in which the budget should be created.

Field	Type	Description
source	OPTIONAL FIELD JSON object literal	Specifies what the budget accumulates. Either specifysourceorsourcesandlabel.
source.undertakingId	GUID	The ID of the undertaking (e.g. project).
source.actionId	OPTIONAL FIELD GUID	If specified, the budget only accumulates the durations of activities of this action in the specified undertaking. Otherwise, all actions of the undertaking are accumulated.
sources	OPTIONAL FIELD JSON object literal array	Used to accumulate durations from different projects or actions (within projects). Either specifysourceorsourcesandlabel. The elements of the array follow the definition of the singlesourceabove. Use this to specify a budget that accumulates durations of activities from several undertakings, and or actions.
label	OPTIONAL FIELD JSON object literal	Specifies the name of the label. Only valid when creating a budget with multiple sources. Either specifysourceorsourcesandlabel.
bookingRecurrencePattern	JSON object literal	The recurrence pattern for the budget booking. The budget booking can either be once or a fixed set of dates. More options are available through the TimeRocket UI.
bookingRecurrencePattern.once	OPTIONAL FIELD string in the formatyyyy-MM-dd	The date for the single budget booking. Eitherspecifyonce orfixDates.
bookingRecurrencePattern.fixDates	OPTIONAL FIELD array of strings in the formatyyyy-MM-dd	The dates for the recurring budget bookings. Eitherspecifyonce orfixDates.
bookingAmount	number	The amount of the budget in minutes (a non-negative whole number).
bookingKind	string	Either -"absolute": the budget (re)starts at the booking date and no prior activtiies are considered; or -"additive": the amount is added to a prior amount and prior activities are considered.

Response

The GUID of the created budget.

Request

structureId: ID of the structure in which the budget exists.

budgetId: ID of the budget to add a booking to.

Field	Type	Description
recurrencePattern	JSON object literal	The recurrence pattern for the budget booking. The budget booking can either be once or a fixed set of dates. More options are available through the TimeRocket UI.
recurrencePattern.once	OPTIONAL FIELD string in the formatyyyy-MM-dd	The date for the single budget booking. Eitherspecifyonce orfixDates.
recurrencePattern.fixDates	OPTIONAL FIELD array of strings in the formatyyyy-MM-dd	The dates for the recurring budget bookings. Eitherspecifyonce orfixDates.
amount	number	The amount of the budget in minutes (a non-negative whole number).
kind	string	Either -"absolute": the budget (re)starts at the booking date and no prior activtiies are considered; or -"additive": the amount is added to a prior amount and prior activities are considered.

Response

The GUID of the created budget booking.

Marks an action on an undertaking as finished.

This is only available when the undertaking supports finished actions (see undertaking's settings).

Request

structureId: ID of the structure

undertakingId: ID of the undertaking

actionId: ID of the action

Marks an action on an undertaking as not finished anymore.

This is only available when the undertaking supports finished actions (see undertaking's settings).

Request

structureId: ID of the structure

undertakingId: ID of the undertaking

actionId: ID of the action

Adds an activity booking to an undertaking.

Request

structureId: ID of the structure

undertakingId: ID of the undertaking

actionId: ID of the action

Field	Type	Description
effective	yyyy-MM-dd	The effective date for the booking.
amount	number	The amount of the booking in minutes with decimals, e.g. 120.5 = 2 hours and 30 minutes.
employeeId	OPTIONAL FIELD GUID	The optional employee's ID to associate with this booking.

Response

The ID of the created booking.

Removes an activity booking from an undertaking.

Request

activityBookingId: ID of the activity booking

Query activity bookings.

Request

URL Paramter	Type	Description
undertakingIds	comma-delimited list of GUIDs	The undertakings' IDs to get the activity bookings for.

Response

Field	Type	Description
activityBookingId	GUID	The ID of the activity booking.
effective	yyyy-MM-dd	The effective date of the activity booking.
undertakingId	GUID	The undertaking's ID.
actionId	GUID	The action's ID.
amount	number	The amount of the activity booking (can be positive or negative and contain decimal places).

Params

undertakingIds	{undertakingIds}

Adds an item to an existing set. The set is identified by the ID of the activity structure and the ID of the set.

Set IDs are unique inside an activity structure.

An activity structure defines a hierarchy of items to model different ways of reporting activities.

Example structure:

• Customers
  • Meier Treuhand
    • Activities
      • Concept
      • Realisation
  • Müller Bau AG
    • Activities
      • Design
      • Realisation

In the above example, Realisation occurs twice (same ID, same label). Therefore, reports sum activities for both into a single value (sum per item ID). If items are reused, the ID and label must match; otherwise a validation error is returned.

Structures can be freely defined. There are no fixed levels:

• Customers
  • Meier Treuhand
    • Projects
      • New Attendance Time Tool
        • Activities
          • Concept
          • Roll-out
      • Security Alerts
        • Activities
          • Installation
  • Müller Bau AG
    • Objects
      • Headquarter
        • Todos
          • Concept
          • Working
      • Mountain hut

In the above example, sets with the same name need unique IDs. Sets always need unique IDs, and reports never aggregate over sets with the same name. Sets can share the same name without resulting in a validation error.

Every set and item can specify an activityBehavior that defines whether activities can be reported on items. If activityBehavior is omitted the item or set inherits the setting from its parent. When evaluating the behavior, TimeRocket starts with prohibited. So to enable reporting of activities, set the activityBehavior to permitted on the according item or set.

Field	Type	Description
id	Guid, all uppercase	ID of the item. If the ID is reused in any structure, then these nodes represent all the same item. This can be used to create statistics and reports for nodes in several locations in multiple activity structures. If IDs occur several times, the labels have to match; otherwise, a validation error is returned.
label	JSON object literal	Name of the item in different languages. Add a key/value pair per language with the key equal to the short language code ("de", "en", "fr", "it") and the value equal to the translation.
activityBehavior	OPTIONAL FIELD: string, either "permitted" or "prohibited"	If not specified the activity behavior of the parent set is inherited. If specified , the behavior is overridden.
set	OPTIONAL FIELD: JSON object literal	The set of items below this item.
set.id	Guid, all uppercase	ID of the set. Must be unique.
set.label	JSON object literal	The label of the set defines how the activity is displayed to the user.
set.label.key	string	The key to identify the set. Acts as a fallback in case there is no translation given for the queried language.
set.label.translations	JSON object literal	Name of the set in different languages. Add a key/value pair per language with the key equal to the short language code ("de", "en", "fr", "it") and the value equal to the translation.
set.activityBehavior	OPTIONAL FIELD: string, either "permitted" or "prohibited"	If not specified the activity behavior of the parent item is inherited. If specified , the behavior is overridden.
set.items	JSON array	The list of items in the set.

When defining an item, you can define its sub-set and therein contained items in a single request.

Response

If successful then the response is empty; otherwise the response contains a JSON object literal containing the error message.

Updates an item in the activity structure.

Request

Field	Type	Description
activityBehavior	OPTIONAL FIELD string, either inherited, permitted or prohibited	Updates the activity behavior of the item that specifies whether activities can be added to this item. inherited: inherit setting from above permitted: activities can be added to this item prohibited: activities cannot be added to this item
archived	OPTIONAL FIELD boolean	If set to true the item is archived and will not show up in searches anymore (until it is activated again). If set to false the item is active again.
label	JSON object literal	The label of the item defines how the activity is displayed to the user.
label.key	string	The key to identify the item. Acts as a fallback in case there is no translation given for the queried language.
label.translations	JSON object literal	Name of the item in different languages. Add a key/value pair per language with the key equal to the short language code ("de", "en", "fr", "it") and the value equal to the translation.

Response

If successful then the response is empty; otherwise the response contains a JSON object literal containing the error message.

Deletes the item with the specified id in the specified parent set.

Adds a set to the specified item in the specified set. If there is already a set present, an error is returned.

StartFragment

Please refer to the description of Add Item for a description if the fields of the item (see fields starting with .set).

Response

If successful then the response is empty; otherwise the response contains a JSON object literal containing the error message.

Request

Field	Type	Description
activityBehavior	OPTIONAL FIELD string, either inherited, permitted or prohibited	Updates the activity behavior of the set that specifies whether activities can be added to items in this set (when not overridden). inherited: inherit setting from above permitted: activities can be added to items prohibited: activities cannot be added to items
archived	OPTIONAL FIELD boolean	If set to true the setis archived and will not show up in searches anymore (until it is activated again). If set to false the set is active again.
label	JSON object literal	The label of the set defines how the activity is displayed to the user.
label.key	string	The key to identify the set. Acts as a fallback in case there is no translation given for the queried language.
label.translations	JSON object literal	Name of the set in different languages. Add a key/value pair per language with the key equal to the short language code ("de", "en", "fr", "it") and the value equal to the translation.

Response

If successful then the response is empty; otherwise the response contains a JSON object literal containing the error message.

Deletes the set with the specified id.

Creates an activity.

Request

Field	Type	Description
activityStructureId	Guid	ID of the activity structure.
setId	Guid	ID of the set.
itemId	Guid	ID of the item.
activityId	Guid	ID of the activity. Must be unique.
affectedEmployeeId	Guid	ID of the employee the activity is added to. Must be one of the IDs returned by .
executingEmployeeId	Guid	ID of the employee acting as the executer of the command. Must be one of the IDs returned by .
workday	date in the format yyyy-MM-dd	The workday the activity is added to.
duration	OPTIONAL FIELD: int	The duration of the activity in minutes. Either duration or from and to must be specified.
from	OPTIONAL FIELD: time in the format HH:mm with +/-1 for night shifts (i.e. 23:50-1)	When the activity started. If specified to must be specified as well and duration must be omitted
to	OPTIONAL FIELD: time in the format HH:mm with +/-1 for night shifts (i.e. 23:50-1)	When the activity ended. If specified from must be specified as well and duration must be omitted
description	UTF8 string	A text describing the activity.

Response

If successful then the response is empty; otherwise the response contains a JSON object literal containing the error message.

Queries activities of employees.

Request

Field	Type	Description
employeeIds	OPTIONAL: Array of GUIDs	The list of employees for whom the activities are to be retrieved. If not specified, activities for all employees are returned.
activityStructureId	GUID	The ID of the activity structure. Only activities of this activity structure are returned.
setId	OPTIONAL FIELD: GUID	The ID of the set. If the setId is provided the itemId must be present as well. Only activities below the item with ID itemId in the set with the ID setId are returned. Use this to query only a branch of the whole activity structure.
itemId	OPTIONAL FIELD: GUID	The ID of the item. If the itemId is provided the setId must be present as well. Only activities below the item with ID itemId in the set with the ID setId are returned. Use this to query only a branch of the whole activity structure.
start	ISO 2014 date representation in the format yyyy-MM-dd	Only activities on workdays between start and end are returned (including boundaries).
end	ISO 2014 date representation in the format yyyy-MM-dd	Only activities on workdays between start and end are returned (including boundaries).
includeActivitiesFromAttendance	OPTIONAL FIELD: boolean	If set to true, activities will be generated from attendance for employees with a corresponding rule configured.

Response

Field	Type	Description
activityId	OPTIONAL FIELD: GUID	The ID of the activity when it is a manually entered activity.
label	JSON object literal	The label defines how the activity should be presented to users.
label.key	string	The key of the activity. Should act as a fallback if no translation is present for a specific language.
label.translations	JSON object literal	The name of the activity in different languages. The keys in the JSON object represent a language ("de", "en", "fr", "it"), the values the translation.
employeeId	GUID	The employee's ID.
workday	ISO 2014 date representation in the format yyyy-MM-dd	The workday the activity is associated with.
activityStructureId	GUID	The ID of the activity structure the activity belongs to.
setId	GUID	The ID of the set the activity belongs to.
itemId	GUID	The ID of the item the activity belongs to.
duration	OPTIONAL FIELD: number (minutes)	The duration of the activity in minutes. Either duration or from and to are present.
from	OPTIONAL FIELD: JSON object literal	When the activity started. If from is present to is present as well, but no duration.
from.time	Local time in the format hh:mm	The time (local time) the activity started.
from.workdayShift	OPTIONALE FIELD: number	If present specifies how many days the workday has to be shifted to get the calendar day when the activity started. E.g. a workdayShift of -1 means that the activity started on the calendar day prior to the workday.
to	JSON object literal	When the activity ended. If to is present from is present as well, but no duration.
to.time	Local time in the format hh:mm	The time (local time) the activity ended.
to.workdayShift	OPTIONALE FIELD: number	If present specifies how many days the workday has to be shifted to get the calendar day when the activity ended. E.g. a workdayShift of 1 means that the activity ended on the calendar day following the workday.
description	string	The description that was passed along when the activity was created.