Tracker
No description given.
Endpoints
- get /api/v3/workflow/tracker/last
- post /api/v3/workflow/tracker/pause(/:account_id)?
- post /api/v3/workflow/tracker/resume
- post /api/v3/workflow/tracker/start
get/api/v3/workflow/tracker/last
Get the last time period of work for this user, if any. Allow to show information before resuming.
post/api/v3/workflow/tracker/pause(/:account_id)?
Pause the current time period of work, if any. If the time period is an activity, it will pause this activity.
If account id is provided, it will pause the time period of work for the account, assuming the caller has the rights to do so (manager).
Input Schema
object
account_id: integer or null
Typescript
type InputSchema = { account_id: number | null };
post/api/v3/workflow/tracker/resume
Resume the last time period of work, if any.
- If the time period is an activity, it will resume this activity. If the activity is already finished, it will return an error.
- If the previous time period is not an activity, it will resume the previous activity by marking the new time period exactly like the previous one. Return in the metadata the total time spent of the activity or time period. Will raise an error if the user is currently working.
post/api/v3/workflow/tracker/start
Start a time period of work, on a specific activity or project. If the user is already working, it will pause the current activity and create a new time period.
If an activity is provided, it will start this activity, assuming the person is already assigned to work on this activity.
Input Schema
object
data:
object
attributes:
object
activity_id?: string
project_id?: integer
billable?: boolean
details?: string
Typescript
type InputSchema = {
data: {
attributes: {
activity_id?: string;
project_id?: number;
billable?: boolean;
details?: string;
};
};
};