API V3 Documentation – ACT
Preview: this documents PQFORCE 4.26.6, which has not been released yet.
Endpoints
GET /API/V3/ACT/ActualsPeriod
Returns the actuals period for a given date
HTTP syntax
GET /API/V3/ACT/ActualsPeriod?day=...
<- application/json : ActualsPeriod JavaScript syntax
Pqf.act.getActualsPeriodByDay(day) // returns ActualsPeriod
// Overloads for optional parameters
Pqf.act.getActualsPeriodByDay() // returns ActualsPeriod Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
day |
date | The day for which the actuals period should be retrieved | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: ActualsPeriod
GET /API/V3/ACT/ActualsPeriod/:periodId
Returns the actuals period with given ID
HTTP syntax
GET /API/V3/ACT/ActualsPeriod/:periodId
<- application/json : ActualsPeriod JavaScript syntax
Pqf.act.getActualsPeriod(periodId) // returns ActualsPeriod Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
periodId |
UUID | The actuals period's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ActualsPeriod
GET /API/V3/ACT/ActualsPeriods
Returns all actuals periods
HTTP syntax
GET /API/V3/ACT/ActualsPeriods
<- application/jsonJavaScript syntax
Pqf.act.getAllActualsPeriods() // returns ActualsPeriod[]Result
This endpoint returns the following data: array of ActualsPeriod
GET /API/V3/ACT/ActualsPeriods/:periodIds
Returns the actuals periods with the given IDs
HTTP syntax
GET /API/V3/ACT/ActualsPeriods/:periodIds
<- application/json JavaScript syntax
Pqf.act.getActualsPeriods(periodIds) // returns ActualsPeriod[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
periodIds |
array of UUID | The actuals periods' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ActualsPeriod
GET /API/V3/ACT/Project/:projectId/Resources/:resourceIds/Efforts
Returns the efforts (planned/actual/remaining) of some resources in a project
HTTP syntax
GET /API/V3/ACT/Project/:projectId/Resources/:resourceIds/Efforts?beg=...&end=...
<- application/json JavaScript syntax
Pqf.act.getProjectResourcesEfforts(projectId, resourceIds, beg, end) // returns ResourceProjectEfforts[]
// Overloads for optional parameters
Pqf.act.getProjectResourcesEfforts(projectId, resourceIds, beg) // returns ResourceProjectEfforts[]
Pqf.act.getProjectResourcesEfforts(projectId, resourceIds) // returns ResourceProjectEfforts[] Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Requires permission ALLOCATE on object of type Resource and ID in specified in parameter resourceIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourceIds |
array of UUID | The resources' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of ResourceProjectEfforts
GET /API/V3/ACT/Project/:projectId/Resources/:resourceIds/ProjectTimeActuals
Returns references to the times some resources booked on a project, optionally limited to a day range. The answer holds those the caller may read: a time sitting in an actuals period they may not read is left out rather than reported
HTTP syntax
GET /API/V3/ACT/Project/:projectId/Resources/:resourceIds/ProjectTimeActuals?beg=...&end=...
<- application/json JavaScript syntax
Pqf.act.getProjectResourcesProjectTimeActuals(projectId, resourceIds, beg, end) // returns ResourceProjectTimeActualReference[]
// Overloads for optional parameters
Pqf.act.getProjectResourcesProjectTimeActuals(projectId, resourceIds, beg) // returns ResourceProjectTimeActualReference[]
Pqf.act.getProjectResourcesProjectTimeActuals(projectId, resourceIds) // returns ResourceProjectTimeActualReference[] Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Requires permission READ_ACTUALS on object of type Resource and ID in specified in parameter resourceIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourceIds |
array of UUID | The resources' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of ResourceProjectTimeActualReference
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriod
Returns the actuals period of a resource for a given date
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriod?day=...
<- application/json : ResourceActualsPeriod JavaScript syntax
Pqf.act.getResourceActualsPeriodByDay(resourceId, day) // returns ResourceActualsPeriod
// Overloads for optional parameters
Pqf.act.getResourceActualsPeriodByDay(resourceId) // returns ResourceActualsPeriod Required permission
Requires permission READ on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
day |
date | The day for which the actuals period should be retrieved | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: ResourceActualsPeriod
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriod/:periodId
Returns the actuals period of a resource with given ID
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriod/:periodId
<- application/json : ResourceActualsPeriod JavaScript syntax
Pqf.act.getResourceActualsPeriod(resourceId, periodId) // returns ResourceActualsPeriod Required permission
Requires permission READ on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
periodId |
UUID | The actuals period's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ResourceActualsPeriod
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriod/:periodId/Presences
Returns references to the presences of a resource in a given actuals period
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriod/:periodId/Presences
<- application/json JavaScript syntax
Pqf.act.getAllResourcePresencesByPeriod(resourceId, periodId) // returns ResourcePresenceReference[] Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
periodId |
UUID | The actuals period's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ResourcePresenceReference
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriod/:periodId/ProjectTimeActuals
Returns references to the times a resource booked on projects in a given actuals period
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriod/:periodId/ProjectTimeActuals
<- application/json JavaScript syntax
Pqf.act.getAllResourceProjectTimeActualsByPeriod(resourceId, periodId) // returns ResourceProjectTimeActualReference[] Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
periodId |
UUID | The actuals period's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ResourceProjectTimeActualReference
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriods
Returns all actuals periods of a resource
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriods
<- application/json JavaScript syntax
Pqf.act.getAllResourceActualsPeriods(resourceId) // returns ResourceActualsPeriod[] Required permission
Requires permission READ on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ResourceActualsPeriod
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriods/:periodIds
Returns the actuals periods of a resource with the given IDs
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/ActualsPeriods/:periodIds
<- application/json JavaScript syntax
Pqf.act.getResourceActualsPeriods(resourceId, periodIds) // returns ResourceActualsPeriod[] Required permission
Requires permission READ on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
periodIds |
array of UUID | The actuals periods' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ResourceActualsPeriod
GET /API/V3/ACT/Resource/:resourceId/Presence/:resourcePresenceId
Returns a presence of a resource
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Presence/:resourcePresenceId
<- application/json : ResourcePresence JavaScript syntax
Pqf.act.getResourcePresence(resourceId, resourcePresenceId) // returns ResourcePresence Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourcePresenceId |
UUID | The presence's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ResourcePresence
PUT /API/V3/ACT/Resource/:resourceId/Presence/:resourcePresenceId
Modifies the presence of a resource with the given ID. The day a presence counts on and the timezone it was recorded in are fixed when it is added and cannot be modified here, and a presence that does not exist is not created either - use act.addResourcePresence for that
HTTP syntax
PUT /API/V3/ACT/Resource/:resourceId/Presence/:resourcePresenceId
-> application/json : ResourcePresence JavaScript syntax
Pqf.act.putResourcePresence(resourceId, resourcePresenceId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission PLAN on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourcePresenceId |
UUID | The presence's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ResourcePresence | JSON object of type ResourcePresence | ✔️ |
DELETE /API/V3/ACT/Resource/:resourceId/Presence/:resourcePresenceId
Deletes a presence of a resource
HTTP syntax
DELETE /API/V3/ACT/Resource/:resourceId/Presence/:resourcePresenceId JavaScript syntax
Pqf.act.delResourcePresence(resourceId, resourcePresenceId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission PLAN on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourcePresenceId |
UUID | The presence's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/ACT/Resource/:resourceId/Presence/:resourcePresenceId/Timeline
Retrieves the version (history) timeline for a presence of a resource
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Presence/:resourcePresenceId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.act.getResourcePresenceTimeline(resourceId, resourcePresenceId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.act.getResourcePresenceTimeline(resourceId, resourcePresenceId, limit, until, from) // returns PF.VersionTimeline
Pqf.act.getResourcePresenceTimeline(resourceId, resourcePresenceId, limit, until) // returns PF.VersionTimeline
Pqf.act.getResourcePresenceTimeline(resourceId, resourcePresenceId, limit) // returns PF.VersionTimeline
Pqf.act.getResourcePresenceTimeline(resourceId, resourcePresenceId) // returns PF.VersionTimeline Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourcePresenceId |
UUID | The presence's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
limit |
int? | Limits the number of slots | i > 0 (The value, if present, must be greater than 0.) |
|
until |
datetime | Latest date of the timeline | ||
from |
datetime | Earliest date of the timeline | ||
granularity |
PF.CalendarGranularity | The granularity of the timeline |
Result
This endpoint returns the following data: PF.VersionTimeline
GET /API/V3/ACT/Resource/:resourceId/Presence/:resourcePresenceId/Version/:versionId
Retrieves a specific version (historic) of a presence of a resource
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Presence/:resourcePresenceId/Version/:versionId
<- application/json : ResourcePresence JavaScript syntax
Pqf.act.getResourcePresenceVersion(resourceId, resourcePresenceId, versionId) // returns ResourcePresence Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourcePresenceId |
UUID | The presence's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | The version to get | ✔️ | matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.) |
Result
This endpoint returns the following data: ResourcePresence
GET /API/V3/ACT/Resource/:resourceId/Presences
Returns references to the presences of a resource, optionally limited to a day range. The answer holds those the caller may read: a presence in an actuals period they may not read is left out rather than reported
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Presences?beg=...&end=...
<- application/json JavaScript syntax
Pqf.act.getAllResourcePresences(resourceId, beg, end) // returns ResourcePresenceReference[]
// Overloads for optional parameters
Pqf.act.getAllResourcePresences(resourceId, beg) // returns ResourcePresenceReference[]
Pqf.act.getAllResourcePresences(resourceId) // returns ResourcePresenceReference[] Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of ResourcePresenceReference
GET /API/V3/ACT/Resource/:resourceId/Presences/:resourcePresenceIds
Returns the presences of a resource with the given IDs
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Presences/:resourcePresenceIds
<- application/json JavaScript syntax
Pqf.act.getResourcePresences(resourceId, resourcePresenceIds) // returns ResourcePresence[] Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourcePresenceIds |
array of UUID | The presences' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ResourcePresence
POST /API/V3/ACT/Resource/:resourceId/Presences/Add
Adds a presence for a given resource
HTTP syntax
POST /API/V3/ACT/Resource/:resourceId/Presences/Add?day=...&timezone=...&start=...&end=...&comment=...
<- application/json : PF.Reference JavaScript syntax
Pqf.act.addResourcePresence(resourceId, day, timezone, start, end, comment) // returns PF.Reference
// Overloads for optional parameters
Pqf.act.addResourcePresence(resourceId, day, timezone, start, end) // returns PF.Reference
Pqf.act.addResourcePresence(resourceId, day, timezone, start) // returns PF.Reference
Pqf.act.addResourcePresence(resourceId, day, timezone) // returns PF.Reference
Pqf.act.addResourcePresence(resourceId, day) // returns PF.Reference Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission PLAN on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
day |
date | The day the presence counts on, read in the given timezone | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
timezone |
string | The timezone the presence was recorded in, e.g. Europe/Zurich. Start and end are UTC instants; this is what turns them back into the wall clock the resource saw. Defaults to the timezone of the calling user | matches '(Z (The value, if present, must be a time zone: "Z", "UTC", a UTC offset such as "+02:00", or a region such as "Europe/Zurich".) |
|
start |
datetime | The start of the presence as a UTC instant; at least one of start and end must be given | '2099-12-31T23:59:59.999Z' >= at >= '2000-01-01T00:00:00.000Z' (The value, if present, must be between 2000-01-01T00:00:00.000Z and 2099-12-31T23:59:59.999Z, both inclusive.) |
|
end |
datetime | The end of the presence as a UTC instant; at least one of start and end must be given | '2099-12-31T23:59:59.999Z' >= at >= '2000-01-01T00:00:00.000Z' (The value, if present, must be between 2000-01-01T00:00:00.000Z and 2099-12-31T23:59:59.999Z, both inclusive.) |
|
comment |
string | A comment describing what the resource worked on during the presence or why presence was needed |
Result
This endpoint returns the following data: PF.Reference
POST /API/V3/ACT/Resource/:resourceId/Presences/Clock
Clocks in/out a presence for a given resource
HTTP syntax
POST /API/V3/ACT/Resource/:resourceId/Presences/Clock?time=...&timezone=...
<- application/json : PF.Reference JavaScript syntax
Pqf.act.clockResourcePresence(resourceId, time, timezone) // returns PF.Reference
// Overloads for optional parameters
Pqf.act.clockResourcePresence(resourceId, time) // returns PF.Reference
Pqf.act.clockResourcePresence(resourceId) // returns PF.Reference Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission PLAN on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
time |
datetime | The moment of clocking in or out, as a UTC instant. Defaults to now | '2099-12-31T23:59:59.999Z' >= at >= '2000-01-01T00:00:00.000Z' (The value, if present, must be between 2000-01-01T00:00:00.000Z and 2099-12-31T23:59:59.999Z, both inclusive.) |
|
timezone |
string | The timezone the resource is clocking in, e.g. Europe/Zurich. It decides which day the stamp counts on, and turns the instant back into the wall clock the resource saw. Defaults to the timezone of the calling user | matches '(Z (The value, if present, must be a time zone: "Z", "UTC", a UTC offset such as "+02:00", or a region such as "Europe/Zurich".) |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/ACT/Resource/:resourceId/Presences/Summary/Balance
Returns a resource's time balance and its per absence type balances up to and including a given year. Both are cumulated over every year from 2000 on rather than covering the given year alone: the time balance totals the presences and the time corrections against the targets, and an absence balance totals the corrections booked on its absence type against the absences taken on it, so it turns negative once more was taken than was credited. Every absence type is reported, including the ones the resource has neither been credited nor been absent on
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Presences/Summary/Balance?year=...
<- application/json : ResourceBalance JavaScript syntax
Pqf.act.getResourcePresenceBalance(resourceId, year) // returns ResourceBalance Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
year |
int? | The year up to and including which the balances are calculated (required) | ✔️ | 2099 >= y >= 2000 (The value must be between 2000 and 2099, both inclusive.) |
Result
This endpoint returns the following data: ResourceBalance
GET /API/V3/ACT/Resource/:resourceId/Presences/Summary/Daily
Returns the day by day summary of a resource's target, presence and absence times over a day range. The whole range has to be readable: a day sitting in an actuals period the caller may not read takes the answer down rather than dropping out of it. The range must not span more than the days pqforce.dayrange.max allows, which is what one call may be answered day by day
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Presences/Summary/Daily?beg=...&end=...
<- application/json JavaScript syntax
Pqf.act.getResourcePresenceDailySummary(resourceId, beg, end) // returns ResourceDaySummary[] Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
end |
date | The day after the last day of the time span (exclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of ResourceDaySummary
GET /API/V3/ACT/Resource/:resourceId/Presences/Summary/Range
Returns the summary of a resource's target, presence and absence times over a day range, totalled over the whole range. The whole range has to be readable: a day sitting in an actuals period the caller may not read takes the answer down rather than dropping out of it. The range must not span more than the days pqforce.dayrange.max allows, which is what one call may be answered day by day, because the total is built from that very answer
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Presences/Summary/Range?beg=...&end=...
<- application/json : ResourceRangeSummary JavaScript syntax
Pqf.act.getResourcePresenceRangeSummary(resourceId, beg, end) // returns ResourceRangeSummary Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
end |
date | The day after the last day of the time span (exclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: ResourceRangeSummary
GET /API/V3/ACT/Resource/:resourceId/PresenceSlot
Returns the reported presence of a resource as one single slot over exactly the requested time span. Its unit is the smallest calendar unit one instance of which contains the whole span (a day, a week, a month, a quarter or a year), and it is complete if the span is exactly that instance
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/PresenceSlot?beg=...&end=...
<- application/json : PF.DurationSlot JavaScript syntax
Pqf.act.getResourcePresenceSlot(resourceId, beg, end) // returns PF.DurationSlot Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
end |
date | The day after the last day of the time span (exclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: PF.DurationSlot
GET /API/V3/ACT/Resource/:resourceId/PresenceSlots
Returns the reported presence of a resource in time slots
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/PresenceSlots?beg=...&end=...&zoom=...
<- application/json JavaScript syntax
Pqf.act.getResourcePresenceSlots(resourceId, beg, end, zoom) // returns PF.DurationSlot[]
// Overloads for optional parameters
Pqf.act.getResourcePresenceSlots(resourceId, beg, end) // returns PF.DurationSlot[] Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
end |
date | The day after the last day of the time span (exclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
zoom |
PF.CalendarGranularity | The calendar unit of the slots. If set, all slots are of this unit, only the first and the last one may be cut by the time span. If omitted, the server chooses the slots, which may then differ in width |
Result
This endpoint returns the following data: array of PF.DurationSlot
GET /API/V3/ACT/Resource/:resourceId/Project/:projectId/Efforts
Returns the efforts (planned/actual/remaining) of a resource in a project
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Project/:projectId/Efforts?beg=...&end=...
<- application/json : ResourceProjectEfforts JavaScript syntax
Pqf.act.getResourceProjectEfforts(resourceId, projectId, beg, end) // returns ResourceProjectEfforts
// Overloads for optional parameters
Pqf.act.getResourceProjectEfforts(resourceId, projectId, beg) // returns ResourceProjectEfforts
Pqf.act.getResourceProjectEfforts(resourceId, projectId) // returns ResourceProjectEfforts Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission ALLOCATE on object of type Resource and ID specified in parameter resourceId.
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: ResourceProjectEfforts
GET /API/V3/ACT/Resource/:resourceId/Project/:projectId/Efforts/WithWorkItems
Returns the efforts (planned/actual/remaining) of a resource in a project, broken down by work item. The totals are the ones act.getResourceProjectEfforts answers, and the breakdown sums back to them: one entry per work item the resource is allocated on, plus the entry naming no work item, which carries what was allocated on the project itself
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Project/:projectId/Efforts/WithWorkItems?beg=...&end=...
<- application/json : ResourceProjectWithWorkItemEfforts JavaScript syntax
Pqf.act.getResourceProjectWithWorkItemEfforts(resourceId, projectId, beg, end) // returns ResourceProjectWithWorkItemEfforts
// Overloads for optional parameters
Pqf.act.getResourceProjectWithWorkItemEfforts(resourceId, projectId, beg) // returns ResourceProjectWithWorkItemEfforts
Pqf.act.getResourceProjectWithWorkItemEfforts(resourceId, projectId) // returns ResourceProjectWithWorkItemEfforts Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission ALLOCATE on object of type Resource and ID specified in parameter resourceId.
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: ResourceProjectWithWorkItemEfforts
GET /API/V3/ACT/Resource/:resourceId/Projects/:projectIds/Efforts
Returns the efforts (planned/actual/remaining) of a resource in some projects
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Projects/:projectIds/Efforts?beg=...&end=...
<- application/json JavaScript syntax
Pqf.act.getResourceProjectsEfforts(resourceId, projectIds, beg, end) // returns ResourceProjectEfforts[]
// Overloads for optional parameters
Pqf.act.getResourceProjectsEfforts(resourceId, projectIds, beg) // returns ResourceProjectEfforts[]
Pqf.act.getResourceProjectsEfforts(resourceId, projectIds) // returns ResourceProjectEfforts[] Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission ALLOCATE on object of type Resource and ID specified in parameter resourceId.
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of ResourceProjectEfforts
GET /API/V3/ACT/Resource/:resourceId/Projects/:projectIds/Efforts/WithWorkItems
Returns the efforts (planned/actual/remaining) of a resource in some projects, each broken down by work item. The totals are the ones act.getResourceProjectsEfforts answers, and the breakdown sums back to them: one entry per work item the resource is allocated on, plus the entry naming no work item, which carries what was allocated on the project itself
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/Projects/:projectIds/Efforts/WithWorkItems?beg=...&end=...
<- application/json JavaScript syntax
Pqf.act.getResourceProjectsWithWorkItemEfforts(resourceId, projectIds, beg, end) // returns ResourceProjectWithWorkItemEfforts[]
// Overloads for optional parameters
Pqf.act.getResourceProjectsWithWorkItemEfforts(resourceId, projectIds, beg) // returns ResourceProjectWithWorkItemEfforts[]
Pqf.act.getResourceProjectsWithWorkItemEfforts(resourceId, projectIds) // returns ResourceProjectWithWorkItemEfforts[] Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission ALLOCATE on object of type Resource and ID specified in parameter resourceId.
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of ResourceProjectWithWorkItemEfforts
GET /API/V3/ACT/Resource/:resourceId/ProjectTimeActual/:resourceProjectTimeActualId
Returns a time a resource booked on a project
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/ProjectTimeActual/:resourceProjectTimeActualId
<- application/json : ResourceProjectTimeActual JavaScript syntax
Pqf.act.getResourceProjectTimeActual(resourceId, resourceProjectTimeActualId) // returns ResourceProjectTimeActual Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourceProjectTimeActualId |
UUID | The project time actual's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ResourceProjectTimeActual
PUT /API/V3/ACT/Resource/:resourceId/ProjectTimeActual/:resourceProjectTimeActualId
Modifies the time a resource booked on a project with the given ID. The day it counts on, the resource that booked it and the project it was booked on are fixed when it is added and cannot be modified here, and a time that does not exist is not created either - use act.
HTTP syntax
PUT /API/V3/ACT/Resource/:resourceId/ProjectTimeActual/:resourceProjectTimeActualId
-> application/json : ResourceProjectTimeActual JavaScript syntax
Pqf.act.putResourceProjectTimeActual(resourceId, resourceProjectTimeActualId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission PLAN on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourceProjectTimeActualId |
UUID | The project time actual's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ResourceProjectTimeActual | JSON object of type ResourceProjectTimeActual | ✔️ |
DELETE /API/V3/ACT/Resource/:resourceId/ProjectTimeActual/:resourceProjectTimeActualId
Deletes a time a resource booked on a project
HTTP syntax
DELETE /API/V3/ACT/Resource/:resourceId/ProjectTimeActual/:resourceProjectTimeActualId JavaScript syntax
Pqf.act.delResourceProjectTimeActual(resourceId, resourceProjectTimeActualId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission PLAN on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourceProjectTimeActualId |
UUID | The project time actual's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/ACT/Resource/:resourceId/ProjectTimeActual/:resourceProjectTimeActualId/Timeline
Retrieves the version (history) timeline for a time a resource booked on a project
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/ProjectTimeActual/:resourceProjectTimeActualId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.act.getResourceProjectTimeActualTimeline(resourceId, resourceProjectTimeActualId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.act.getResourceProjectTimeActualTimeline(resourceId, resourceProjectTimeActualId, limit, until, from) // returns PF.VersionTimeline
Pqf.act.getResourceProjectTimeActualTimeline(resourceId, resourceProjectTimeActualId, limit, until) // returns PF.VersionTimeline
Pqf.act.getResourceProjectTimeActualTimeline(resourceId, resourceProjectTimeActualId, limit) // returns PF.VersionTimeline
Pqf.act.getResourceProjectTimeActualTimeline(resourceId, resourceProjectTimeActualId) // returns PF.VersionTimeline Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourceProjectTimeActualId |
UUID | The project time actual's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
limit |
int? | Limits the number of slots | i > 0 (The value, if present, must be greater than 0.) |
|
until |
datetime | Latest date of the timeline | ||
from |
datetime | Earliest date of the timeline | ||
granularity |
PF.CalendarGranularity | The granularity of the timeline |
Result
This endpoint returns the following data: PF.VersionTimeline
GET /API/V3/ACT/Resource/:resourceId/ProjectTimeActual/:resourceProjectTimeActualId/Version/:versionId
Retrieves a specific version (historic) of a time a resource booked on a project
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/ProjectTimeActual/:resourceProjectTimeActualId/Version/:versionId
<- application/json : ResourceProjectTimeActual JavaScript syntax
Pqf.act.getResourceProjectTimeActualVersion(resourceId, resourceProjectTimeActualId, versionId) // returns ResourceProjectTimeActual Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourceProjectTimeActualId |
UUID | The project time actual's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | The version to get | ✔️ | matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.) |
Result
This endpoint returns the following data: ResourceProjectTimeActual
GET /API/V3/ACT/Resource/:resourceId/ProjectTimeActuals
Returns references to the times a resource booked on projects, optionally limited to a day range. The answer holds those the caller may read: a time sitting in an actuals period they may not read is left out rather than reported
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/ProjectTimeActuals?beg=...&end=...
<- application/json JavaScript syntax
Pqf.act.getAllResourceProjectTimeActuals(resourceId, beg, end) // returns ResourceProjectTimeActualReference[]
// Overloads for optional parameters
Pqf.act.getAllResourceProjectTimeActuals(resourceId, beg) // returns ResourceProjectTimeActualReference[]
Pqf.act.getAllResourceProjectTimeActuals(resourceId) // returns ResourceProjectTimeActualReference[] Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of ResourceProjectTimeActualReference
GET /API/V3/ACT/Resource/:resourceId/ProjectTimeActuals/:resourceProjectTimeActualIds
Returns the times a resource booked on projects with the given IDs
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/ProjectTimeActuals/:resourceProjectTimeActualIds
<- application/json JavaScript syntax
Pqf.act.getResourceProjectTimeActuals(resourceId, resourceProjectTimeActualIds) // returns ResourceProjectTimeActual[] Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
resourceProjectTimeActualIds |
array of UUID | The project time actuals' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ResourceProjectTimeActual
POST /API/V3/ACT/Resource/:resourceId/ProjectTimeActuals/Add
Books a time of a given resource on a project, or on one of its work items
HTTP syntax
POST /API/V3/ACT/Resource/:resourceId/ProjectTimeActuals/Add?day=...&projectId=...&projectWorkItemId=...&duration=...&comment=...
<- application/json : PF.Reference JavaScript syntax
Pqf.act.addResourceProjectTimeActual(resourceId, day, projectId, projectWorkItemId, duration, comment) // returns PF.Reference
// Overloads for optional parameters
Pqf.act.addResourceProjectTimeActual(resourceId, day, projectId, projectWorkItemId, duration) // returns PF.Reference Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission PLAN on object of type Resource and ID specified in parameter resourceId.
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
day |
date | The day the time counts on | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
projectId |
UUID | The ID of the project the time is booked on | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectWorkItemId |
UUID | The ID of the work item the time is booked on; leave it out to book on the project itself | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
duration |
duration | The amount of time that is booked | ✔️ | |
comment |
string | A comment describing what the resource worked on |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/ACT/Resource/:resourceId/TimeActualSlot/ByProject
Returns the reported project time actuals of a resource as one single slot over exactly the requested time span, grouped by project. Its unit is the smallest calendar unit one instance of which contains the whole span (a day, a week, a month, a quarter or a year), and it is complete if the span is exactly that instance. Every project counts, whatever its state, with its active scenario, or with its single inactive scenario if it has no active one; select the projects of interest from the answer. The actuals reported on projects the caller may not identify are summed up as base load, referenced by the type BaseLoad and an ID derived from the resource's ID. Unlike planning, this base load contains nothing of the worktime model's base load
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/TimeActualSlot/ByProject?beg=...&end=...
<- application/json : PF.GroupedDurationSlot JavaScript syntax
Pqf.act.getResourceTimeActualSlotByProject(resourceId, beg, end) // returns PF.GroupedDurationSlot Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
end |
date | The day after the last day of the time span (exclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: PF.GroupedDurationSlot
GET /API/V3/ACT/Resource/:resourceId/TimeActualSlots/ByProject
Returns the reported project time actuals of a resource in time slots, grouped by project. Every project counts, whatever its state, with its active scenario, or with its single inactive scenario if it has no active one; select the projects of interest from the answer. The actuals reported on projects the caller may not identify are summed up as base load, referenced by the type BaseLoad and an ID derived from the resource's ID. Unlike planning, this base load contains nothing of the worktime model's base load
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/TimeActualSlots/ByProject?beg=...&end=...&zoom=...
<- application/json JavaScript syntax
Pqf.act.getResourceTimeActualSlotsByProject(resourceId, beg, end, zoom) // returns PF.GroupedDurationSlot[]
// Overloads for optional parameters
Pqf.act.getResourceTimeActualSlotsByProject(resourceId, beg, end) // returns PF.GroupedDurationSlot[] Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
end |
date | The day after the last day of the time span (exclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
zoom |
PF.CalendarGranularity | The calendar unit of the slots. If set, all slots are of this unit, only the first and the last one may be cut by the time span. If omitted, the server chooses the slots, which may then differ in width |
Result
This endpoint returns the following data: array of PF.GroupedDurationSlot
GET /API/V3/ACT/Resource/:resourceId/TimeCorrection/:correctionId
Returns a time correction of a resource
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/TimeCorrection/:correctionId
<- application/json : ResourceTimeCorrection JavaScript syntax
Pqf.act.getResourceTimeCorrection(resourceId, correctionId) // returns ResourceTimeCorrection Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ on object of type ResourceTimeCorrection and ID specified in parameter resourceId.
Requires permission READ on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
correctionId |
UUID | The time correction's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ResourceTimeCorrection
PUT /API/V3/ACT/Resource/:resourceId/TimeCorrection/:correctionId
Creates or updates a time correction of a resource
HTTP syntax
PUT /API/V3/ACT/Resource/:resourceId/TimeCorrection/:correctionId
-> application/json : ResourceTimeCorrection JavaScript syntax
Pqf.act.putResourceTimeCorrection(resourceId, correctionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission UPDATE on object of type ResourceTimeCorrection and ID specified in parameter resourceId.
Requires permission READ on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
correctionId |
UUID | The time correction's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ResourceTimeCorrection | JSON object of type ResourceTimeCorrection | ✔️ |
DELETE /API/V3/ACT/Resource/:resourceId/TimeCorrection/:correctionId
Deletes a time correction of a resource
HTTP syntax
DELETE /API/V3/ACT/Resource/:resourceId/TimeCorrection/:correctionId JavaScript syntax
Pqf.act.delResourceTimeCorrection(resourceId, correctionId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission DELETE on object of type ResourceTimeCorrection and ID specified in parameter resourceId.
Requires permission READ on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
correctionId |
UUID | The time correction's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/ACT/Resource/:resourceId/TimeCorrection/:correctionId/Timeline
Retrieves the version (history) timeline for a time correction of a resource
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/TimeCorrection/:correctionId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.act.getResourceTimeCorrectionTimeline(resourceId, correctionId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.act.getResourceTimeCorrectionTimeline(resourceId, correctionId, limit, until, from) // returns PF.VersionTimeline
Pqf.act.getResourceTimeCorrectionTimeline(resourceId, correctionId, limit, until) // returns PF.VersionTimeline
Pqf.act.getResourceTimeCorrectionTimeline(resourceId, correctionId, limit) // returns PF.VersionTimeline
Pqf.act.getResourceTimeCorrectionTimeline(resourceId, correctionId) // returns PF.VersionTimeline Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ on object of type ResourceTimeCorrection and ID specified in parameter resourceId.
Requires permission READ on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
correctionId |
UUID | The time correction's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
limit |
int? | Limits the number of slots | i > 0 (The value, if present, must be greater than 0.) |
|
until |
datetime | Latest date of the timeline | ||
from |
datetime | Earliest date of the timeline | ||
granularity |
PF.CalendarGranularity | The granularity of the timeline |
Result
This endpoint returns the following data: PF.VersionTimeline
GET /API/V3/ACT/Resource/:resourceId/TimeCorrection/:correctionId/Version/:versionId
Retrieves a specific version (historic) of a time correction of a resource
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/TimeCorrection/:correctionId/Version/:versionId
<- application/json : ResourceTimeCorrection JavaScript syntax
Pqf.act.getResourceTimeCorrectionVersion(resourceId, correctionId, versionId) // returns ResourceTimeCorrection Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ on object of type ResourceTimeCorrection and ID specified in parameter resourceId.
Requires permission READ on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
correctionId |
UUID | The time correction's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | The version to get | ✔️ | matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.) |
Result
This endpoint returns the following data: ResourceTimeCorrection
GET /API/V3/ACT/Resource/:resourceId/TimeCorrections
Returns references to all time corrections of a resource
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/TimeCorrections
<- application/json JavaScript syntax
Pqf.act.getAllResourceTimeCorrections(resourceId) // returns ResourceTimeCorrectionReference[] Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ on object of type ResourceTimeCorrection and ID specified in parameter resourceId.
Requires permission READ on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ResourceTimeCorrectionReference
GET /API/V3/ACT/Resource/:resourceId/TimeCorrections/:correctionIds
Returns the time corrections of a resource with the given IDs
HTTP syntax
GET /API/V3/ACT/Resource/:resourceId/TimeCorrections/:correctionIds
<- application/json JavaScript syntax
Pqf.act.getResourceTimeCorrections(resourceId, correctionIds) // returns ResourceTimeCorrection[] Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ on object of type ResourceTimeCorrection and ID specified in parameter resourceId.
Requires permission READ on object of type Resource and ID specified in parameter resourceId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
correctionIds |
array of UUID | The time corrections' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ResourceTimeCorrection
GET /API/V3/ACT/Resources/:resourceIds/PresenceSlot
Returns the reported presence of one or more resources as one single slot over exactly the requested time span. Its unit is the smallest calendar unit one instance of which contains the whole span (a day, a week, a month, a quarter or a year), and it is complete if the span is exactly that instance. All resources share the same slot
HTTP syntax
GET /API/V3/ACT/Resources/:resourceIds/PresenceSlot?beg=...&end=...
<- application/json JavaScript syntax
Pqf.act.getResourcesPresenceSlot(resourceIds, beg, end) // returns PF.DurationSlot[] Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID in specified in parameter resourceIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceIds |
array of UUID | The resources' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
end |
date | The day after the last day of the time span (exclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of PF.DurationSlot
GET /API/V3/ACT/Resources/:resourceIds/PresenceSlots
Returns the reported presence of one or more resources in time slots. All resources share the same slots
HTTP syntax
GET /API/V3/ACT/Resources/:resourceIds/PresenceSlots?beg=...&end=...&zoom=...
<- application/json JavaScript syntax
Pqf.act.getResourcesPresenceSlots(resourceIds, beg, end, zoom) // returns PF.DurationSlot[][]
// Overloads for optional parameters
Pqf.act.getResourcesPresenceSlots(resourceIds, beg, end) // returns PF.DurationSlot[][] Required license
This endpoint requires the following licenses:
- resourcepresenceactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID in specified in parameter resourceIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceIds |
array of UUID | The resources' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
end |
date | The day after the last day of the time span (exclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
zoom |
PF.CalendarGranularity | The calendar unit of the slots. If set, all slots are of this unit, only the first and the last one may be cut by the time span. If omitted, the server chooses the slots, which may then differ in width |
Result
This endpoint returns the following data: array of array of PF.DurationSlot
GET /API/V3/ACT/Resources/:resourceIds/TimeActualSlot/ByProject
Returns the reported project time actuals of one or more resources as one single slot over exactly the requested time span, grouped by project. Its unit is the smallest calendar unit one instance of which contains the whole span (a day, a week, a month, a quarter or a year), and it is complete if the span is exactly that instance. Every project counts, whatever its state, with its active scenario, or with its single inactive scenario if it has no active one; select the projects of interest from the answer. The actuals reported on projects the caller may not identify are summed up as base load, referenced by the type BaseLoad and an ID derived from the resource's ID. Unlike planning, this base load contains nothing of the worktime model's base load. All resources share the same slot
HTTP syntax
GET /API/V3/ACT/Resources/:resourceIds/TimeActualSlot/ByProject?beg=...&end=...
<- application/json JavaScript syntax
Pqf.act.getResourcesTimeActualSlotByProject(resourceIds, beg, end) // returns PF.GroupedDurationSlot[] Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID in specified in parameter resourceIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceIds |
array of UUID | The resources' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
end |
date | The day after the last day of the time span (exclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of PF.GroupedDurationSlot
GET /API/V3/ACT/Resources/:resourceIds/TimeActualSlots/ByProject
Returns the reported project time actuals of one or more resources in time slots, grouped by project. Every project counts, whatever its state, with its active scenario, or with its single inactive scenario if it has no active one; select the projects of interest from the answer. The actuals reported on projects the caller may not identify are summed up as base load, referenced by the type BaseLoad and an ID derived from the resource's ID. Unlike planning, this base load contains nothing of the worktime model's base load. All resources share the same slots
HTTP syntax
GET /API/V3/ACT/Resources/:resourceIds/TimeActualSlots/ByProject?beg=...&end=...&zoom=...
<- application/json JavaScript syntax
Pqf.act.getResourcesTimeActualSlotsByProject(resourceIds, beg, end, zoom) // returns PF.GroupedDurationSlot[][]
// Overloads for optional parameters
Pqf.act.getResourcesTimeActualSlotsByProject(resourceIds, beg, end) // returns PF.GroupedDurationSlot[][] Required license
This endpoint requires the following licenses:
- projecttimeactuals
Required permission
Requires permission READ_ACTUALS on object of type Resource and ID in specified in parameter resourceIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceIds |
array of UUID | The resources' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
end |
date | The day after the last day of the time span (exclusive, required) | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
zoom |
PF.CalendarGranularity | The calendar unit of the slots. If set, all slots are of this unit, only the first and the last one may be cut by the time span. If omitted, the server chooses the slots, which may then differ in width |
Result
This endpoint returns the following data: array of array of PF.GroupedDurationSlot
Data types
ACT.ActualsPeriod
This is a structure data contract.
Describes a period of actuals reporting which is the base unit to control whether reporting or modifying is possible or not.
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | Contains the start day of the period (inclusive) | non-null (The value is required.) |
|
end |
date | Contains the end day of the period (exclusive) | non-null (The value is required.) |
ACT.ResourceAbsence
This is a structure data contract.
Describes how much of a summarized time span a resource was absent on one absence type
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
absenceTypeId |
UUID | Contains the ID of the absence type the absence was booked on | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
duration |
duration | Specifies the total amount of the absence | non-null (The value is required.) |
ACT.ResourceAbsenceBalance
This is a structure data contract.
Describes a resource's balance on one absence type: what the time corrections booked on that type credited, minus what the resource took as absences on it
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
absenceTypeId |
UUID | Contains the ID of the absence type the balance is reported for | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
duration |
duration | Specifies the balance, credited minus taken, which is negative once more was taken than was credited | non-null (The value is required.) |
ACT.ResourceActualsPeriod
This is a structure data contract.
Describes a period of actuals reporting of resource times which is the base unit to control whether reporting or modifying is possible or not.
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | ✔️ | Contains the start day of the period (inclusive) | non-null (The value is required.) |
end |
date | ✔️ | Contains the end day of the period (exclusive) | non-null (The value is required.) |
resourceId |
UUID | Contains the ID of the resource that has been working | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
ACT.ResourceBalance
This is a structure data contract.
Describes the time balance and the per absence type balances of a resource up to and including a certain year
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
resourceId |
UUID | Contains the ID of the resource the balances are reported for | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
year |
int | Specifies the year up to and including which the balances are calculated | 2099 >= y >= 2000 (The value must be between 2000 and 2099, both inclusive.) |
|
time |
duration | Specifies the time balance: the presences and the time corrections, minus the targets | non-null (The value is required.) |
|
absences |
array of ResourceAbsenceBalance | The absence balances of the resource, one entry per absence type | non-null;non-null (The array is required. Each element must not be null.) |
ACT.ResourceDaySummary
This is a structure data contract.
Summarizes the target, presence and absence times of a resource on one day
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
target |
duration | ✔️ | Specifies the target time, with the absences already deducted from it | non-null (The value is required.) |
sumAbsences |
duration | ✔️ | Specifies the total amount of absences | non-null (The value is required.) |
sumPresences |
duration | ✔️ | Specifies the total amount of presences | non-null (The value is required.) |
absences |
array of ResourceAbsence | ✔️ | The absences of the resource, one entry per absence type | non-null;non-null (The array is required. Each element must not be null.) |
day |
date | The day the summary covers | non-null & '2099-12-31' >= d >= '2000-01-01' (The value is required and must be between 2000-01-01 and 2099-12-31, both inclusive.) |
ACT.ResourcePresence
This is a structure data contract.
Describes the presence of a resource
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
day |
date | Specifies the day this presence belongs to | non-null & '2099-12-31' >= d >= '2000-01-01' (The value is required and must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
timezone |
string | Specifies the timezone this presence was taking place in. The start and end times are UTC instants; this is what turns them back into the wall clock the resource saw | non-null & matches '(Z (The value is required and must be a time zone: "Z", "UTC", a UTC offset such as "+02:00", or a region such as "Europe/Zurich".) |
|
start |
datetime | Specifies the start of the presence | '2099-12-31T23:59:59.999Z' >= at >= '2000-01-01T00:00:00.000Z' (The value, if present, must be between 2000-01-01T00:00:00.000Z and 2099-12-31T23:59:59.999Z, both inclusive.) |
|
end |
datetime | Specifies the end of the presence | '2099-12-31T23:59:59.999Z' >= at >= '2000-01-01T00:00:00.000Z' (The value, if present, must be between 2000-01-01T00:00:00.000Z and 2099-12-31T23:59:59.999Z, both inclusive.) |
|
startClocked |
datetime | Specifies the start of the presence, set from clocking in | '2099-12-31T23:59:59.999Z' >= at >= '2000-01-01T00:00:00.000Z' (The value, if present, must be between 2000-01-01T00:00:00.000Z and 2099-12-31T23:59:59.999Z, both inclusive.) |
|
endClocked |
datetime | Specifies the end of the presence, set from clocking out | '2099-12-31T23:59:59.999Z' >= at >= '2000-01-01T00:00:00.000Z' (The value, if present, must be between 2000-01-01T00:00:00.000Z and 2099-12-31T23:59:59.999Z, both inclusive.) |
|
overrideStart |
boolean | Specifies if the clocked value for start is overridden | ||
overrideEnd |
boolean | Specifies if the clocked value for end is overridden | ||
remark |
string | Contains a comment describing what the resource worked on during the presence or why presence was needed |
ACT.ResourcePresenceReference
This is a structure data contract.
A reference to a presence of a resource, together with the day it counts on
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
day |
date | The day the presence counts on, read in the timezone it was recorded in | non-null & '2099-12-31' >= d >= '2000-01-01' (The value is required and must be between 2000-01-01 and 2099-12-31, both inclusive.) |
ACT.ResourcePresenceSummary
This is a structure data contract.
Summarizes the target, presence and absence times of a resource over a time span
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
target |
duration | Specifies the target time, with the absences already deducted from it | non-null (The value is required.) |
|
sumAbsences |
duration | Specifies the total amount of absences | non-null (The value is required.) |
|
sumPresences |
duration | Specifies the total amount of presences | non-null (The value is required.) |
|
absences |
array of ResourceAbsence | The absences of the resource, one entry per absence type | non-null;non-null (The array is required. Each element must not be null.) |
ACT.ResourceProjectEfforts
This is a structure data contract.
Describes the total efforts of a resource in a project
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
resourceId |
UUID | Contains the ID of the resource the efforts belong to | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectId |
UUID | Contains the ID of the project the efforts were spent on | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
planned |
duration | Specifies the total planned effort | non-null (The value is required.) |
|
actual |
duration | Specifies the total actual effort | non-null (The value is required.) |
|
remaining |
duration | Specifies the total remaining effort | non-null (The value is required.) |
ACT.ResourceProjectTimeActual
This is a structure data contract.
Describes a time a resource booked on a project, or on one of its work items, on a certain day
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
day |
date | Specifies the day the time counts on | non-null & '2099-12-31' >= d >= '2000-01-01' (The value is required and must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
resourceId |
UUID | Contains the ID of the resource that booked the time | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectId |
UUID | Contains the ID of the project the time was booked on | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
workItemId |
UUID | Contains the ID of the work item the time was booked on, or nothing when it was booked on the project itself | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
duration |
duration | Specifies the amount of time that was booked | non-null (The value is required.) |
|
remark |
string | Contains a comment describing what the resource worked on |
ACT.ResourceProjectTimeActualReference
This is a structure data contract.
A reference to a time a resource booked on a project, together with the day, the resource, the project and the work item it was booked on
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
day |
date | Specifies the day the time counts on | non-null & '2099-12-31' >= d >= '2000-01-01' (The value is required and must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
resourceId |
UUID | Contains the ID of the resource that booked the time | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectId |
UUID | Contains the ID of the project the time was booked on | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
workItemId |
UUID | Contains the ID of the work item the time was booked on, or nothing when it was booked on the project itself | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
ACT.ResourceProjectWithWorkItemEfforts
This is a structure data contract.
Describes the total efforts of a resource in a project, broken down by work item
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
resourceId |
UUID | ✔️ | Contains the ID of the resource the efforts belong to | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectId |
UUID | ✔️ | Contains the ID of the project the efforts were spent on | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
planned |
duration | ✔️ | Specifies the total planned effort | non-null (The value is required.) |
actual |
duration | ✔️ | Specifies the total actual effort | non-null (The value is required.) |
remaining |
duration | ✔️ | Specifies the total remaining effort | non-null (The value is required.) |
workItems |
array of ResourceWorkItemEfforts | The efforts per work item, including the entry naming no work item, which carries what was allocated on the project itself; the totals above are their sum | non-null;non-null (The array is required. Each element must not be null.) |
ACT.ResourceRangeSummary
This is a structure data contract.
Summarizes the target, presence and absence times of a resource over a day range
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
target |
duration | ✔️ | Specifies the target time, with the absences already deducted from it | non-null (The value is required.) |
sumAbsences |
duration | ✔️ | Specifies the total amount of absences | non-null (The value is required.) |
sumPresences |
duration | ✔️ | Specifies the total amount of presences | non-null (The value is required.) |
absences |
array of ResourceAbsence | ✔️ | The absences of the resource, one entry per absence type | non-null;non-null (The array is required. Each element must not be null.) |
beg |
date | The first day of the time span the summary covers (inclusive) | non-null & '2099-12-31' >= d >= '2000-01-01' (The value is required and must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span the summary covers (exclusive) | non-null & '2099-12-31' >= d >= '2000-01-01' (The value is required and must be between 2000-01-01 and 2099-12-31, both inclusive.) |
ACT.ResourceTimeCorrection
This is a structure data contract.
Describes a time correction of a resource on a certain day
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
day |
date | Specifies the date of the time correction | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
duration |
duration | Specifies the amount of time for the time correction | ||
remark |
string | Contains a comment describing why the time correction was done | ||
correctionTypeId |
UUID | Type of the time correction, either the presence time correction or an absence type | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
ACT.ResourceTimeCorrectionReference
This is a structure data contract.
A reference to a time correction of a resource, together with its date and type
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
day |
date | Specifies the date of the time correction | ||
correctionTypeId |
UUID | Type of the time correction, either the presence time correction or an absence type | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
ACT.ResourceWorkItemEfforts
This is a structure data contract.
Describes the efforts of a resource on one work item of a project
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
workItemId |
UUID | Contains the ID of the work item the efforts were spent on, or nothing for what was allocated on the project itself | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
planned |
duration | Specifies the planned effort on this work item | non-null (The value is required.) |
|
actual |
duration | Specifies the actual effort on this work item | non-null (The value is required.) |
|
remaining |
duration | Specifies the remaining effort on this work item | non-null (The value is required.) |