API V3 Documentation – RES

PQFORCE 4.26.6 Preview

Preview: this documents PQFORCE 4.26.6, which has not been released yet.

Endpoints

GET /API/V3/RES/Holiday/:holidayId

Returns a single holiday of a holiday locale

HTTP syntax

GET /API/V3/RES/Holiday/:holidayId
<- application/json : Holiday

JavaScript syntax

Pqf.res.getHoliday(holidayId) // returns Holiday

Required permission

Requires permission READ on object of type Holiday and ID specified in parameter holidayId.

Parameters

Name Type Description Required Assertion
holidayId UUID The holiday ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: Holiday

PUT /API/V3/RES/Holiday/:holidayId

Creates or updates a single holiday of a holiday locale. This is an expensive operation: every single write of a holiday recalculates the availability, presence and work plan of every resource that works by the holiday's locale, so consider res.updateHolidays to write several holidays of one locale in one single operation instead

HTTP syntax

PUT /API/V3/RES/Holiday/:holidayId
-> application/json : Holiday

JavaScript syntax

Pqf.res.putHoliday(holidayId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission UPDATE or CREATE on object of type Holiday and ID specified in parameter holidayId.

Parameters

Name Type Description Required Assertion
holidayId UUID The holiday ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 Holiday JSON object of type Holiday ✔️

DELETE /API/V3/RES/Holiday/:holidayId

Deletes a single holiday of a holiday locale

HTTP syntax

DELETE /API/V3/RES/Holiday/:holidayId

JavaScript syntax

Pqf.res.delHoliday(holidayId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission DELETE on object of type Holiday and ID specified in parameter holidayId.

Parameters

Name Type Description Required Assertion
holidayId UUID The holiday ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/HolidayLocale/:holidayLocaleId

Get a holiday locale

HTTP syntax

GET /API/V3/RES/HolidayLocale/:holidayLocaleId
<- application/json : HolidayLocale

JavaScript syntax

Pqf.res.getHolidayLocale(holidayLocaleId) // returns HolidayLocale

Other endpoints for objects of type holiday locale

This endpoint is part of a group of endpoints manipulating objects of type holiday locale. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type HolidayLocale and ID specified in parameter holidayLocaleId.

Parameters

Name Type Description Required Assertion
holidayLocaleId UUID The holiday locale's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: HolidayLocale

PUT /API/V3/RES/HolidayLocale/:holidayLocaleId

Update an existing holiday locale

HTTP syntax

PUT /API/V3/RES/HolidayLocale/:holidayLocaleId
-> application/json : HolidayLocale

JavaScript syntax

Pqf.res.putHolidayLocale(holidayLocaleId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type holiday locale

This endpoint is part of a group of endpoints manipulating objects of type holiday locale. The following endpoints belong to the same group:

Required license

This endpoint requires the following licenses:

  • multiholidaylocale

Required permission

Requires permission UPDATE or CREATE on object of type HolidayLocale and ID specified in parameter holidayLocaleId.

Parameters

Name Type Description Required Assertion
holidayLocaleId UUID The holiday locale's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 HolidayLocale JSON object of type HolidayLocale ✔️

DELETE /API/V3/RES/HolidayLocale/:holidayLocaleId

Delete a holiday locale

HTTP syntax

DELETE /API/V3/RES/HolidayLocale/:holidayLocaleId

JavaScript syntax

Pqf.res.delHolidayLocale(holidayLocaleId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type holiday locale

This endpoint is part of a group of endpoints manipulating objects of type holiday locale. The following endpoints belong to the same group:

Required license

This endpoint requires the following licenses:

  • multiholidaylocale

Required permission

Requires permission DELETE on object of type HolidayLocale and ID specified in parameter holidayLocaleId.

Parameters

Name Type Description Required Assertion
holidayLocaleId UUID The holiday locale's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/HolidayLocale/:holidayLocaleId/Holidays

Returns all holidays of a holiday locale

HTTP syntax

GET /API/V3/RES/HolidayLocale/:holidayLocaleId/Holidays?beg=...&end=...
<- application/json

JavaScript syntax

Pqf.res.getHolidayLocaleHolidays(holidayLocaleId, beg, end) // returns HolidayReference[]

// Overloads for optional parameters
Pqf.res.getHolidayLocaleHolidays(holidayLocaleId, beg) // returns HolidayReference[]
Pqf.res.getHolidayLocaleHolidays(holidayLocaleId) // returns HolidayReference[]

Required permission

Requires permission READ on object of type HolidayLocale and ID specified in parameter holidayLocaleId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
holidayLocaleId UUID The holiday locale ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 range that 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.)
end date The day after the last day of the range that 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: array of HolidayReference

POST /API/V3/RES/HolidayLocale/:holidayLocaleId/Holidays/Import

Imports holidays from a file

HTTP syntax

POST /API/V3/RES/HolidayLocale/:holidayLocaleId/Holidays/Import?format=...&filter=...
-> application/octet-stream

JavaScript syntax

Pqf.res.importHolidays(holidayLocaleId, format, filter, requestBinary) // returns Number - the return code (HTTP 2xx code) of the call

// Overloads for optional parameters
Pqf.res.importHolidays(holidayLocaleId, format, requestBinary) // returns Number - the return code (HTTP 2xx code) of the call
Pqf.res.importHolidays(holidayLocaleId, requestBinary) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission UPDATE on object of type HolidayLocale and ID specified in parameter holidayLocaleId.

Parameters

Name Type Description Required Assertion
holidayLocaleId UUID The holiday locale ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
format CalendarFileFormat the file format
filter array of date the dates that should be imported, all if not specified null;non-null (The array is optional. Each element must not be null.)
requestBinary Binary Raw content of mime type application/octet-stream ✔️

POST /API/V3/RES/HolidayLocale/:holidayLocaleId/Holidays/Update

Creates or updates multiple holidays of a holiday locale in one single operation. Holidays of the locale the request does not name remain untouched

HTTP syntax

POST /API/V3/RES/HolidayLocale/:holidayLocaleId/Holidays/Update
-> application/json

JavaScript syntax

Pqf.res.updateHolidays(holidayLocaleId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission UPDATE on object of type HolidayLocale and ID specified in parameter holidayLocaleId.

Parameters

Name Type Description Required Assertion
holidayLocaleId UUID The holiday locale ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 array of Holiday JSON object of type array of Holiday ✔️

GET /API/V3/RES/HolidayLocale/:holidayLocaleId/Identification

Get a holiday locale identification

HTTP syntax

GET /API/V3/RES/HolidayLocale/:holidayLocaleId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.res.getHolidayLocaleIdentification(holidayLocaleId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.res.getHolidayLocaleIdentification(holidayLocaleId) // returns PF.IdentificationExtended

Other endpoints for objects of type holiday locale

This endpoint is part of a group of endpoints manipulating objects of type holiday locale. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type HolidayLocale and ID specified in parameter holidayLocaleId.

Parameters

Name Type Description Required Assertion Default, if omitted
holidayLocaleId UUID The holiday locale's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: PF.IdentificationExtended

GET /API/V3/RES/HolidayLocales

Returns references to all holiday locales

HTTP syntax

GET /API/V3/RES/HolidayLocales?sort=...
<- application/json

JavaScript syntax

Pqf.res.getAllHolidayLocales(sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getAllHolidayLocales() // returns PF.Reference[]

Required permission

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, name, code, description, color pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

GET /API/V3/RES/HolidayLocales/:holidayLocaleIds

Get multiple holiday locales

HTTP syntax

GET /API/V3/RES/HolidayLocales/:holidayLocaleIds
<- application/json

JavaScript syntax

Pqf.res.getHolidayLocales(holidayLocaleIds) // returns HolidayLocale[]

Other endpoints for objects of type holiday locale

This endpoint is part of a group of endpoints manipulating objects of type holiday locale. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type HolidayLocale and ID in specified in parameter holidayLocaleIds.

Parameters

Name Type Description Required Assertion
holidayLocaleIds array of UUID The holiday locale IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 HolidayLocale

GET /API/V3/RES/HolidayLocales/:holidayLocaleIds/Identification

Get multiple holiday locale identifications

HTTP syntax

GET /API/V3/RES/HolidayLocales/:holidayLocaleIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.res.getHolidayLocaleIdentifications(holidayLocaleIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.res.getHolidayLocaleIdentifications(holidayLocaleIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type holiday locale

This endpoint is part of a group of endpoints manipulating objects of type holiday locale. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type HolidayLocale and ID in specified in parameter holidayLocaleIds.

Parameters

Name Type Description Required Assertion Default, if omitted
holidayLocaleIds array of UUID The holiday locale IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: array of PF.IdentificationExtended

POST /API/V3/RES/HolidayLocales/Add

Adds a new holiday locale

HTTP syntax

POST /API/V3/RES/HolidayLocales/Add?copy=...&name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.res.addHolidayLocale(copy, name, code, description, color, iconRef) // returns PF.Reference

// Overloads for optional parameters
Pqf.res.addHolidayLocale(copy, name, code, description, color) // returns PF.Reference
Pqf.res.addHolidayLocale(copy, name, code, description) // returns PF.Reference
Pqf.res.addHolidayLocale(copy, name, code) // returns PF.Reference
Pqf.res.addHolidayLocale(copy, name) // returns PF.Reference
Pqf.res.addHolidayLocale(copy) // returns PF.Reference
Pqf.res.addHolidayLocale() // returns PF.Reference

Required license

This endpoint requires the following licenses:

  • multiholidaylocale

Required permission

Requires permission CREATE on object of type HolidayLocale.

Requires permission READ on object of type HolidayLocale and ID specified in parameter copy if it is set.

Parameters

Name Type Description Required Assertion
copy UUID Locale ID to create a copy from matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name string The name of the new holiday locale, a localized default name if omitted
code string A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string A descriptive text about the new holiday locale, may contain HTML
color color The color of the new holiday locale
iconRef URI The icon of the new holiday locale, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/RES/Holidays/:holidayIds

Returns some holidays of a holiday locale specified by their IDs

HTTP syntax

GET /API/V3/RES/Holidays/:holidayIds
<- application/json

JavaScript syntax

Pqf.res.getHolidays(holidayIds) // returns Holiday[]

Required permission

Requires permission READ on object of type Holiday and ID in specified in parameter holidayIds.

Parameters

Name Type Description Required Assertion
holidayIds array of UUID The holiday IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 Holiday

DELETE /API/V3/RES/Holidays/:holidayIds

Deletes multiple holidays of holiday locales

HTTP syntax

DELETE /API/V3/RES/Holidays/:holidayIds

JavaScript syntax

Pqf.res.delHolidays(holidayIds) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission DELETE on object of type Holiday and ID in specified in parameter holidayIds.

Parameters

Name Type Description Required Assertion
holidayIds array of UUID The holiday IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)

POST /API/V3/RES/Holidays/Import/Preview

Parses a holiday file and returns the holidays it contains without storing them

HTTP syntax

POST /API/V3/RES/Holidays/Import/Preview?format=...
-> application/octet-stream
<- application/json

JavaScript syntax

Pqf.res.previewHolidays(format, requestBinary) // returns Holiday[]

// Overloads for optional parameters
Pqf.res.previewHolidays(requestBinary) // returns Holiday[]

Parameters

Name Type Description Required Assertion Default, if omitted
format CalendarFileFormat the file format Ical
requestBinary Binary Raw content of mime type application/octet-stream ✔️

Result

This endpoint returns the following data: array of Holiday

POST /API/V3/RES/Resource/:fromId/AddLink

Add link to the given resource

HTTP syntax

POST /API/V3/RES/Resource/:fromId/AddLink?linkType=...&toId=...&name=...&code=...&description=...&color=...&iconRef=...&validityStart=...&validityUntil=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.res.addResourceLink(fromId, linkType, toId, name, code, description, color, iconRef, validityStart, validityUntil) // returns PF.Reference

// Overloads for optional parameters
Pqf.res.addResourceLink(fromId, linkType, toId, name, code, description, color, iconRef, validityStart) // returns PF.Reference
Pqf.res.addResourceLink(fromId, linkType, toId, name, code, description, color, iconRef) // returns PF.Reference
Pqf.res.addResourceLink(fromId, linkType, toId, name, code, description, color) // returns PF.Reference
Pqf.res.addResourceLink(fromId, linkType, toId, name, code, description) // returns PF.Reference
Pqf.res.addResourceLink(fromId, linkType, toId, name, code) // returns PF.Reference
Pqf.res.addResourceLink(fromId, linkType, toId, name) // returns PF.Reference
Pqf.res.addResourceLink(fromId, linkType, toId) // returns PF.Reference

Required permission

Requires permission LINK on object of type Resource and ID specified in parameter fromId.

Requires permission LINK on object of type Resource and ID specified in parameter toId.

Parameters

Name Type Description Required Assertion
fromId UUID The from resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
linkType UUID The link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
toId UUID The to resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name string The name of the new link
code string A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string A descriptive text about the new link, may contain HTML
color color The color of the new link
iconRef URI The icon of the new link, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
validityStart date The first day the new link is valid (omit it for a link that has always been valid)
validityUntil date The first day the new link is no longer valid (omit it for a link that does not expire)

Result

This endpoint returns the following data: PF.Reference

POST /API/V3/RES/Resource/:parentResourceId/AddChild

Adds a new resource to the given parent link type (note that CREATE authorization is also checked, depending on link target type)

HTTP syntax

POST /API/V3/RES/Resource/:parentResourceId/AddChild?linkTypeId=...&name=...&code=...&description=...&color=...&iconRef=...&email=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.res.addResourceChild(parentResourceId, linkTypeId, name, code, description, color, iconRef, email) // returns PF.Reference

// Overloads for optional parameters
Pqf.res.addResourceChild(parentResourceId, linkTypeId, name, code, description, color, iconRef) // returns PF.Reference
Pqf.res.addResourceChild(parentResourceId, linkTypeId, name, code, description, color) // returns PF.Reference
Pqf.res.addResourceChild(parentResourceId, linkTypeId, name, code, description) // returns PF.Reference
Pqf.res.addResourceChild(parentResourceId, linkTypeId, name, code) // returns PF.Reference
Pqf.res.addResourceChild(parentResourceId, linkTypeId, name) // returns PF.Reference
Pqf.res.addResourceChild(parentResourceId, linkTypeId) // returns PF.Reference
Pqf.res.addResourceChild(parentResourceId) // returns PF.Reference

Required permission

Requires permission LINK on object of type Resource and ID specified in parameter parentResourceId.

Parameters

Name Type Description Required Assertion
parentResourceId UUID The parent resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
linkTypeId UUID The link type to use to add a child matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name string The name of the new resource, a localized default name if omitted
code string A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string A descriptive text about the new resource, may contain HTML
color color The color of the new resource
iconRef URI The icon of the new resource, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
email string The email address of the new resource (this information may be used for single sign on) matches '\|[\w-\.]+@(?:[\w-]+\.)+[\w-]{2,}' (The value, if present, must be empty or an e-mail address.)

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/RES/Resource/:resourceId

Get a resource (employee, group, skill, infrastructure, ...)

HTTP syntax

GET /API/V3/RES/Resource/:resourceId
<- application/json : Resource

JavaScript syntax

Pqf.res.getResource(resourceId) // returns Resource

Other endpoints for objects of type resource

This endpoint is part of a group of endpoints manipulating objects of type resource. The following endpoints belong to the same group:

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 (employee, group, skill, infrastructure, ...)'s ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: Resource

PUT /API/V3/RES/Resource/:resourceId

Update an existing resource (employee, group, skill, infrastructure, ...)

HTTP syntax

PUT /API/V3/RES/Resource/:resourceId
-> application/json : Resource

JavaScript syntax

Pqf.res.putResource(resourceId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type resource

This endpoint is part of a group of endpoints manipulating objects of type resource. The following endpoints belong to the same group:

Required permission

Requires permission UPDATE or CREATE on object of type Resource and ID specified in parameter resourceId.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource (employee, group, skill, infrastructure, ...)'s ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 Resource JSON object of type Resource ✔️

DELETE /API/V3/RES/Resource/:resourceId

Delete a resource (employee, group, skill, infrastructure, ...)

HTTP syntax

DELETE /API/V3/RES/Resource/:resourceId

JavaScript syntax

Pqf.res.delResource(resourceId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type resource

This endpoint is part of a group of endpoints manipulating objects of type resource. The following endpoints belong to the same group:

Required permission

Requires permission DELETE on object of type Resource and ID specified in parameter resourceId.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource (employee, group, skill, infrastructure, ...)'s ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/Resource/:resourceId/Ancestors

Read resource's ancestors

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/Ancestors?deleted=...
<- application/json

JavaScript syntax

Pqf.res.getResourceAncestors(resourceId, deleted) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getResourceAncestors(resourceId) // returns PF.Reference[]

Required permission

Requires permission READ on object of type Resource and ID specified in parameter resourceId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion Default, if omitted
resourceId UUID The resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
deleted boolean Allow the referenced resource to be deleted false

Result

This endpoint returns the following data: array of PF.Reference

GET /API/V3/RES/Resource/:resourceId/Availabilities

Returns the availabilities of a resource

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/Availabilities?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourceAvailabilities(resourceId, sort) // returns AvailabilityReference[]

// Overloads for optional parameters
Pqf.res.getResourceAvailabilities(resourceId) // returns AvailabilityReference[]

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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, validityStart pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of AvailabilityReference

GET /API/V3/RES/Resource/:resourceId/Availabilities/:availabilityIds

Read resource's availabilities by their ID

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/Availabilities/:availabilityIds
<- application/json

JavaScript syntax

Pqf.res.getAvailabilities(resourceId, availabilityIds) // returns Availability[]

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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
availabilityIds array of UUID The availabilities' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 Availability

GET /API/V3/RES/Resource/:resourceId/Availability/:availabilityId

Read resource's availability by ID

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/Availability/:availabilityId
<- application/json : Availability

JavaScript syntax

Pqf.res.getAvailability(resourceId, availabilityId) // returns Availability

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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
availabilityId UUID The availability's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: Availability

PUT /API/V3/RES/Resource/:resourceId/Availability/:availabilityId

Update or create a resource's availability

HTTP syntax

PUT /API/V3/RES/Resource/:resourceId/Availability/:availabilityId
-> application/json : Availability

JavaScript syntax

Pqf.res.putAvailability(resourceId, availabilityId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission UPDATE on object of type Resource and ID specified in parameter resourceId.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
availabilityId UUID The availability's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 Availability JSON object of type Availability ✔️

DELETE /API/V3/RES/Resource/:resourceId/Availability/:availabilityId

Delete a resource's availability

HTTP syntax

DELETE /API/V3/RES/Resource/:resourceId/Availability/:availabilityId

JavaScript syntax

Pqf.res.delAvailability(resourceId, availabilityId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission UPDATE on object of type Resource and ID specified in parameter resourceId.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
availabilityId UUID The availability's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/Resource/:resourceId/AvailabilitySlot

Returns the availability 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: its working time without absences, before the base load of its worktime model is taken off

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/AvailabilitySlot?beg=...&end=...
<- application/json : PF.DurationSlot

JavaScript syntax

Pqf.res.getResourceAvailabilitySlot(resourceId, beg, end) // returns PF.DurationSlot

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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/Resource/:resourceId/AvailabilitySlots

Returns the availability of a resource in time slots: its working time without absences, before the base load of its worktime model is taken off

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/AvailabilitySlots?beg=...&end=...&zoom=...
<- application/json

JavaScript syntax

Pqf.res.getResourceAvailabilitySlots(resourceId, beg, end, zoom) // returns PF.DurationSlot[]

// Overloads for optional parameters
Pqf.res.getResourceAvailabilitySlots(resourceId, beg, end) // returns PF.DurationSlot[]

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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/Resource/:resourceId/Children

Read resource's children

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/Children?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourceChildren(resourceId, sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getResourceChildren(resourceId) // returns PF.Reference[]

Required permission

Requires permission READ on object of type Resource and ID specified in parameter resourceId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

GET /API/V3/RES/Resource/:resourceId/Children/:linkTypeId

Read resource's children of a given link type

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/Children/:linkTypeId?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourceChildrenByLinkType(resourceId, linkTypeId, sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getResourceChildrenByLinkType(resourceId, linkTypeId) // returns PF.Reference[]

Required permission

Requires permission READ on object of type Resource and ID specified in parameter resourceId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
linkTypeId UUID The resource link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

Read the links to a resource's children

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/ChildrenLinks?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourceChildrenLinks(resourceId, sort) // returns ResourceLinkReference[]

// Overloads for optional parameters
Pqf.res.getResourceChildrenLinks(resourceId) // returns ResourceLinkReference[]

Required permission

Requires permission READ on object of type Resource and ID specified in parameter resourceId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, validityStart, validityUntil and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of ResourceLinkReference

GET /API/V3/RES/Resource/:resourceId/ChildrenLinks/:linkTypeId

Read the links to a resource's children of a given link type

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/ChildrenLinks/:linkTypeId?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourceChildrenLinksByLinkType(resourceId, linkTypeId, sort) // returns ResourceLinkReference[]

// Overloads for optional parameters
Pqf.res.getResourceChildrenLinksByLinkType(resourceId, linkTypeId) // returns ResourceLinkReference[]

Required permission

Requires permission READ on object of type Resource and ID specified in parameter resourceId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
linkTypeId UUID The resource link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, validityStart, validityUntil and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of ResourceLinkReference

GET /API/V3/RES/Resource/:resourceId/Identification

Get a resource (employee, group, skill, infrastructure, ...) identification

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.res.getResourceIdentification(resourceId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.res.getResourceIdentification(resourceId) // returns PF.IdentificationExtended

Other endpoints for objects of type resource

This endpoint is part of a group of endpoints manipulating objects of type resource. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type Resource and ID specified in parameter resourceId.

Parameters

Name Type Description Required Assertion Default, if omitted
resourceId UUID The resource (employee, group, skill, infrastructure, ...)'s ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: PF.IdentificationExtended

GET /API/V3/RES/Resource/:resourceId/Parents

Read resource's parents

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/Parents?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourceParents(resourceId, sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getResourceParents(resourceId) // returns PF.Reference[]

Required permission

Requires permission READ on object of type Resource and ID specified in parameter resourceId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

GET /API/V3/RES/Resource/:resourceId/Parents/:linkTypeId

Read resource's parents of a given link type

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/Parents/:linkTypeId?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourceParentsByLinkType(resourceId, linkTypeId, sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getResourceParentsByLinkType(resourceId, linkTypeId) // returns PF.Reference[]

Required permission

Requires permission READ on object of type Resource and ID specified in parameter resourceId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
linkTypeId UUID The resource link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

Read the links to a resource's parents

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/ParentsLinks?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourceParentsLinks(resourceId, sort) // returns ResourceLinkReference[]

// Overloads for optional parameters
Pqf.res.getResourceParentsLinks(resourceId) // returns ResourceLinkReference[]

Required permission

Requires permission READ on object of type Resource and ID specified in parameter resourceId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, validityStart, validityUntil and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of ResourceLinkReference

GET /API/V3/RES/Resource/:resourceId/ParentsLinks/:linkTypeId

Read the links to a resource's parents of a given link type

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/ParentsLinks/:linkTypeId?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourceParentsLinksByLinkType(resourceId, linkTypeId, sort) // returns ResourceLinkReference[]

// Overloads for optional parameters
Pqf.res.getResourceParentsLinksByLinkType(resourceId, linkTypeId) // returns ResourceLinkReference[]

Required permission

Requires permission READ on object of type Resource and ID specified in parameter resourceId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceId UUID The resource's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
linkTypeId UUID The resource link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, validityStart, validityUntil and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of ResourceLinkReference

GET /API/V3/RES/Resource/:resourceId/Timeline

Get a resource (employee, group, skill, infrastructure, ...)'s version timeline

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.res.getResourceTimeline(resourceId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.res.getResourceTimeline(resourceId, limit, until, from) // returns PF.VersionTimeline
Pqf.res.getResourceTimeline(resourceId, limit, until) // returns PF.VersionTimeline
Pqf.res.getResourceTimeline(resourceId, limit) // returns PF.VersionTimeline
Pqf.res.getResourceTimeline(resourceId) // returns PF.VersionTimeline

Other endpoints for objects of type resource

This endpoint is part of a group of endpoints manipulating objects of type resource. The following endpoints belong to the same group:

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 (employee, group, skill, infrastructure, ...)'s ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/Resource/:resourceId/Version/:versionId

Get a resource (employee, group, skill, infrastructure, ...)'s specific (historic) version

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/Version/:versionId
<- application/json : Resource

JavaScript syntax

Pqf.res.getResourceVersion(resourceId, versionId) // returns Resource

Other endpoints for objects of type resource

This endpoint is part of a group of endpoints manipulating objects of type resource. The following endpoints belong to the same group:

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 (employee, group, skill, infrastructure, ...)'s ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 retrieve ✔️ 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: Resource

GET /API/V3/RES/Resource/:resourceId/WeekDaysToWorkDaysMapping

Returns the weekdays (7 days week) to workdays (~5 days week) mapping

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/WeekDaysToWorkDaysMapping?beg=...&end=...
<- application/json : WorkdayMapping

JavaScript syntax

Pqf.res.getWeekDaysToWorkDaysMapping(resourceId, beg, end) // returns WorkdayMapping

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 ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 to be included (serves as 0-reference, 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 to be included (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: WorkdayMapping

GET /API/V3/RES/Resource/:resourceId/WorkDaysToWeekDaysMapping

Returns the workdays (~5 days week) to weekdays (7 days week) mapping

HTTP syntax

GET /API/V3/RES/Resource/:resourceId/WorkDaysToWeekDaysMapping?beg=...&end=...
<- application/json : WorkdayMapping

JavaScript syntax

Pqf.res.getWorkDaysToWeekDaysMapping(resourceId, beg, end) // returns WorkdayMapping

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 ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 to be included (serves as 0-reference, 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 to be included (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: WorkdayMapping

GET /API/V3/RES/ResourceGroup/:groupId

Returns a specific resource group

HTTP syntax

GET /API/V3/RES/ResourceGroup/:groupId
<- application/json : ResourceGroup

JavaScript syntax

Pqf.res.getResourceGroup(groupId) // returns ResourceGroup

Parameters

Name Type Description Required Assertion
groupId UUID The resource group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: ResourceGroup

GET /API/V3/RES/ResourceGroup/:groupId/Resources

Returns all resources of a given group

HTTP syntax

GET /API/V3/RES/ResourceGroup/:groupId/Resources?sort=...
<- application/json

JavaScript syntax

Pqf.res.getAllResourcesByGroup(groupId, sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getAllResourcesByGroup(groupId) // returns PF.Reference[]

Required permission

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
groupId UUID The resource group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

GET /API/V3/RES/ResourceGroup/:groupId/StandardWorktime

Returns the standard worktime of a given resource group

HTTP syntax

GET /API/V3/RES/ResourceGroup/:groupId/StandardWorktime
<- application/json : ResourceGroupStandardWorktime

JavaScript syntax

Pqf.res.getResourceGroupStandardWorktime(groupId) // returns ResourceGroupStandardWorktime

Parameters

Name Type Description Required Assertion
groupId UUID The resource group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: ResourceGroupStandardWorktime

PUT /API/V3/RES/ResourceGroup/:groupId/StandardWorktime

Updates the standard worktime for a given resource group

HTTP syntax

PUT /API/V3/RES/ResourceGroup/:groupId/StandardWorktime
-> application/json : ResourceGroupStandardWorktime

JavaScript syntax

Pqf.res.putResourceGroupStandardWorktime(groupId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
groupId UUID The resource group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceGroupStandardWorktime JSON object of type ResourceGroupStandardWorktime ✔️

GET /API/V3/RES/ResourceGroup/:groupId/WithTranslations

Returns a specific resource group with translations

HTTP syntax

GET /API/V3/RES/ResourceGroup/:groupId/WithTranslations
<- application/json : ResourceGroupTranslated

JavaScript syntax

Pqf.res.getResourceGroupTranslated(groupId) // returns ResourceGroupTranslated

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
groupId UUID The resource group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: ResourceGroupTranslated

PUT /API/V3/RES/ResourceGroup/:groupId/WithTranslations

Updates a specific resource group with translations. A resource group is created by addResourceGroup only, so an unknown group is not found (404). The root resource is read-only: a request may omit it or repeat it, anything else is refused (400)

HTTP syntax

PUT /API/V3/RES/ResourceGroup/:groupId/WithTranslations
-> application/json : ResourceGroupTranslated

JavaScript syntax

Pqf.res.putResourceGroupTranslated(groupId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
groupId UUID The resource group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceGroupTranslated JSON object of type ResourceGroupTranslated ✔️

DELETE /API/V3/RES/ResourceGroup/:groupId/WithTranslations

Deletes a specific resource group together with its root resource type and its root resource. A group that is still in use - by resource types besides its root type, by types of resource links at its root type, or by resources and links besides its root resource - is not deleted (403)

HTTP syntax

DELETE /API/V3/RES/ResourceGroup/:groupId/WithTranslations

JavaScript syntax

Pqf.res.delResourceGroupTranslated(groupId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
groupId UUID The resource group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/ResourceGroup/:groupId/WorktimeUnitFactors

Returns the individual factors for worktime conversions for a given resource group (infrastructure works 24h a day, humans don't)

HTTP syntax

GET /API/V3/RES/ResourceGroup/:groupId/WorktimeUnitFactors
<- application/json

JavaScript syntax

Pqf.res.getResourceGroupWorktimeUnitFactors(groupId) // returns PF.UnitFactor[]

Parameters

Name Type Description Required Assertion
groupId UUID The resource group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 PF.UnitFactor

GET /API/V3/RES/ResourceGroup/:groupId/WorktimeUnits

Returns all worktime units that apply for a certain group of resources

HTTP syntax

GET /API/V3/RES/ResourceGroup/:groupId/WorktimeUnits
<- application/json

JavaScript syntax

Pqf.res.getResourceGroupWorktimeUnits(groupId) // returns PF.Unit[]

Parameters

Name Type Description Required Assertion
groupId UUID The resource group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 PF.Unit

GET /API/V3/RES/ResourceGroups

Returns all resource groups

HTTP syntax

GET /API/V3/RES/ResourceGroups?sort=...
<- application/json

JavaScript syntax

Pqf.res.getAllResourceGroups(sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getAllResourceGroups() // returns PF.Reference[]

Parameters

Name Type Description Required Assertion
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, sortIndex pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

GET /API/V3/RES/ResourceGroups/:groupIds

Returns some resource groups specified by their IDs

HTTP syntax

GET /API/V3/RES/ResourceGroups/:groupIds
<- application/json

JavaScript syntax

Pqf.res.getResourceGroups(groupIds) // returns ResourceGroup[]

Parameters

Name Type Description Required Assertion
groupIds array of UUID The resource groups' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceGroup

GET /API/V3/RES/ResourceGroups/:groupIds/StandardWorktime

Returns the standard worktimes of some resource groups specified by their IDs

HTTP syntax

GET /API/V3/RES/ResourceGroups/:groupIds/StandardWorktime
<- application/json

JavaScript syntax

Pqf.res.getResourceGroupsStandardWorktime(groupIds) // returns ResourceGroupStandardWorktime[]

Parameters

Name Type Description Required Assertion
groupIds array of UUID The resource groups' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceGroupStandardWorktime

GET /API/V3/RES/ResourceGroups/:groupIds/WithTranslations

Returns some resource groups specified by their IDs with translations

HTTP syntax

GET /API/V3/RES/ResourceGroups/:groupIds/WithTranslations
<- application/json

JavaScript syntax

Pqf.res.getResourceGroupsTranslated(groupIds) // returns ResourceGroupTranslated[]

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
groupIds array of UUID The resource groups' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceGroupTranslated

GET /API/V3/RES/ResourceGroups/:groupIds/WorktimeUnitFactors

Returns the individual factors for worktime conversions for some resource groups (infrastructure works 24h a day, humans don't)

HTTP syntax

GET /API/V3/RES/ResourceGroups/:groupIds/WorktimeUnitFactors
<- application/json

JavaScript syntax

Pqf.res.getResourceGroupsWorktimeUnitFactors(groupIds) // returns PF.UnitFactor[][]

Parameters

Name Type Description Required Assertion
groupIds array of UUID The resource groups' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 array of PF.UnitFactor

GET /API/V3/RES/ResourceGroups/:groupIds/WorktimeUnits

Returns all worktime units that apply for some groups of resources

HTTP syntax

GET /API/V3/RES/ResourceGroups/:groupIds/WorktimeUnits
<- application/json

JavaScript syntax

Pqf.res.getResourceGroupsWorktimeUnits(groupIds) // returns PF.Unit[][]

Parameters

Name Type Description Required Assertion
groupIds array of UUID The resource groups' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 array of PF.Unit

POST /API/V3/RES/ResourceGroups/Add

Adds a resource group. A resource group needs a root resource, so its root resource type and its root resource are created with it; both carry the group's basic properties, their names prefixed with "Root type of" and "Root resource of". Texts are stored for the default language only

HTTP syntax

POST /API/V3/RES/ResourceGroups/Add?costsTypeId=...&name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.res.addResourceGroup(costsTypeId, name, code, description, color, iconRef) // returns PF.Reference

// Overloads for optional parameters
Pqf.res.addResourceGroup(costsTypeId, name, code, description, color) // returns PF.Reference
Pqf.res.addResourceGroup(costsTypeId, name, code, description) // returns PF.Reference
Pqf.res.addResourceGroup(costsTypeId, name, code) // returns PF.Reference
Pqf.res.addResourceGroup(costsTypeId, name) // returns PF.Reference
Pqf.res.addResourceGroup(costsTypeId) // returns PF.Reference

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
costsTypeId UUID The costs type of the group's root resource type ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name string The name of the new resource group, a localized default name if omitted
code string A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string A descriptive text about the new resource group, may contain HTML
color color The color of the new resource group
iconRef URI The icon of the new resource group, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/RES/ResourceKind/:kind

Returns a given resource kind

HTTP syntax

GET /API/V3/RES/ResourceKind/:kind
<- application/json : PF.NamedReference

JavaScript syntax

Pqf.res.getResourceKind(kind) // returns PF.NamedReference

Parameters

Name Type Description Required Assertion
kind ResourceKind The resource kind's ID ✔️

Result

This endpoint returns the following data: PF.NamedReference

GET /API/V3/RES/ResourceKind/:kind/Resources

Returns all resources of a given kind

HTTP syntax

GET /API/V3/RES/ResourceKind/:kind/Resources?sort=...
<- application/json

JavaScript syntax

Pqf.res.getAllResourcesByKind(kind, sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getAllResourcesByKind(kind) // returns PF.Reference[]

Required permission

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
kind ResourceKind The resource kind ✔️
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

GET /API/V3/RES/ResourceKinds

Returns the different kinds of resources that may have been configured

HTTP syntax

GET /API/V3/RES/ResourceKinds
<- application/json

JavaScript syntax

Pqf.res.getResourceKinds() // returns PF.NamedReference[]

Result

This endpoint returns the following data: array of PF.NamedReference

GET /API/V3/RES/ResourceLink/:linkType/:resourceLinkId

Get a link between two resources (i.e. membership of an employee in an organization unit)

HTTP syntax

GET /API/V3/RES/ResourceLink/:linkType/:resourceLinkId
<- application/json : ResourceLink

JavaScript syntax

Pqf.res.getResourceLink(linkType, resourceLinkId) // returns ResourceLink

This endpoint is part of a group of endpoints manipulating objects of type resource link. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type specified in parameter linkType and ID specified in parameter resourceLinkId.

Parameters

Name Type Description Required Assertion
linkType UUID The link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
resourceLinkId UUID The link between two resources (i.e. membership of an employee in an organization unit)'s ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: ResourceLink

PUT /API/V3/RES/ResourceLink/:linkType/:resourceLinkId

Update an existing link between two resources (i.e. membership of an employee in an organization unit)

HTTP syntax

PUT /API/V3/RES/ResourceLink/:linkType/:resourceLinkId
-> application/json : ResourceLink

JavaScript syntax

Pqf.res.putResourceLink(linkType, resourceLinkId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

This endpoint is part of a group of endpoints manipulating objects of type resource link. The following endpoints belong to the same group:

Required permission

Requires permission UPDATE or CREATE on object of type specified in parameter linkType and ID specified in parameter resourceLinkId.

Parameters

Name Type Description Required Assertion
linkType UUID The link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
resourceLinkId UUID The link between two resources (i.e. membership of an employee in an organization unit)'s ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceLink JSON object of type ResourceLink ✔️

DELETE /API/V3/RES/ResourceLink/:linkType/:resourceLinkId

Delete a link between two resources (i.e. membership of an employee in an organization unit)

HTTP syntax

DELETE /API/V3/RES/ResourceLink/:linkType/:resourceLinkId

JavaScript syntax

Pqf.res.delResourceLink(linkType, resourceLinkId) // returns Number - the return code (HTTP 2xx code) of the call

This endpoint is part of a group of endpoints manipulating objects of type resource link. The following endpoints belong to the same group:

Required permission

Requires permission DELETE on object of type specified in parameter linkType and ID specified in parameter resourceLinkId.

Parameters

Name Type Description Required Assertion
linkType UUID The link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
resourceLinkId UUID The link between two resources (i.e. membership of an employee in an organization unit)'s ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/ResourceLink/:linkType/:resourceLinkId/Identification

Get a link between two resources (i.e. membership of an employee in an organization unit) identification

HTTP syntax

GET /API/V3/RES/ResourceLink/:linkType/:resourceLinkId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.res.getResourceLinkIdentification(linkType, resourceLinkId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.res.getResourceLinkIdentification(linkType, resourceLinkId) // returns PF.IdentificationExtended

This endpoint is part of a group of endpoints manipulating objects of type resource link. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type specified in parameter linkType and ID specified in parameter resourceLinkId.

Parameters

Name Type Description Required Assertion Default, if omitted
linkType UUID The link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
resourceLinkId UUID The link between two resources (i.e. membership of an employee in an organization unit)'s ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: PF.IdentificationExtended

GET /API/V3/RES/ResourceLinks/:linkType/:resourceLinkIds

Get multiple link between two resources (i.e. membership of an employee in an organization unit)s

HTTP syntax

GET /API/V3/RES/ResourceLinks/:linkType/:resourceLinkIds
<- application/json

JavaScript syntax

Pqf.res.getResourceLinks(linkType, resourceLinkIds) // returns ResourceLink[]

This endpoint is part of a group of endpoints manipulating objects of type resource link. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type specified in parameter linkType and ID in specified in parameter resourceLinkIds.

Parameters

Name Type Description Required Assertion
linkType UUID The link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
resourceLinkIds array of UUID The link between two resources (i.e. membership of an employee in an organization unit) IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceLink

GET /API/V3/RES/ResourceLinks/:linkType/:resourceLinkIds/Identification

Get multiple link between two resources (i.e. membership of an employee in an organization unit) identifications

HTTP syntax

GET /API/V3/RES/ResourceLinks/:linkType/:resourceLinkIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.res.getResourceLinkIdentifications(linkType, resourceLinkIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.res.getResourceLinkIdentifications(linkType, resourceLinkIds) // returns PF.IdentificationExtended[]

This endpoint is part of a group of endpoints manipulating objects of type resource link. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type specified in parameter linkType and ID in specified in parameter resourceLinkIds.

Parameters

Name Type Description Required Assertion Default, if omitted
linkType UUID The link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
resourceLinkIds array of UUID The link between two resources (i.e. membership of an employee in an organization unit) IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: array of PF.IdentificationExtended

GET /API/V3/RES/ResourceLinkType/:linkTypeId

Returns a specific type of resource link

HTTP syntax

GET /API/V3/RES/ResourceLinkType/:linkTypeId
<- application/json : ResourceLinkType

JavaScript syntax

Pqf.res.getResourceLinkType(linkTypeId) // returns ResourceLinkType

Parameters

Name Type Description Required Assertion
linkTypeId UUID The resource link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: ResourceLinkType

GET /API/V3/RES/ResourceLinkType/:linkTypeId/WithTranslations

Returns a specific type of resource link with translations

HTTP syntax

GET /API/V3/RES/ResourceLinkType/:linkTypeId/WithTranslations
<- application/json : ResourceLinkTypeTranslated

JavaScript syntax

Pqf.res.getResourceLinkTypeTranslated(linkTypeId) // returns ResourceLinkTypeTranslated

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
linkTypeId UUID The resource link type's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: ResourceLinkTypeTranslated

PUT /API/V3/RES/ResourceLinkType/:linkTypeId/WithTranslations

Creates or updates a specific type of resource link with translations. The source type, the target type and whether the link is hard are fixed once the type of link exists; changing them is refused (400), as is an implicit relation type ID other than the one PQFORCE derives for the type of link. A deleted type of link may be created anew with other values

HTTP syntax

PUT /API/V3/RES/ResourceLinkType/:linkTypeId/WithTranslations
-> application/json : ResourceLinkTypeTranslated

JavaScript syntax

Pqf.res.putResourceLinkTypeTranslated(linkTypeId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
linkTypeId UUID The resource link type's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceLinkTypeTranslated JSON object of type ResourceLinkTypeTranslated ✔️

DELETE /API/V3/RES/ResourceLinkType/:linkTypeId/WithTranslations

Deletes a specific type of resource link. A type of link that is still in use by links between resources is not deleted (403)

HTTP syntax

DELETE /API/V3/RES/ResourceLinkType/:linkTypeId/WithTranslations

JavaScript syntax

Pqf.res.delResourceLinkTypeTranslated(linkTypeId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
linkTypeId UUID The resource link type's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/ResourceLinkTypes

Returns all types of resource links that are available

HTTP syntax

GET /API/V3/RES/ResourceLinkTypes?sort=...
<- application/json

JavaScript syntax

Pqf.res.getAllResourceLinkTypes(sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getAllResourceLinkTypes() // returns PF.Reference[]

Parameters

Name Type Description Required Assertion
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, fromResourceTypeId, toResourceTypeId, nameForward, nameBackward, description, color, sortIndexForward, sortIndexBackward. Sorting by createdAt or modifiedAt requires the resource administration permission and is ignored without it pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

GET /API/V3/RES/ResourceLinkTypes/:linkTypeIds

Returns some types of resource link specified by their IDs

HTTP syntax

GET /API/V3/RES/ResourceLinkTypes/:linkTypeIds
<- application/json

JavaScript syntax

Pqf.res.getResourceLinkTypes(linkTypeIds) // returns ResourceLinkType[]

Parameters

Name Type Description Required Assertion
linkTypeIds array of UUID The resource link type IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceLinkType

GET /API/V3/RES/ResourceLinkTypes/:linkTypeIds/WithTranslations

Returns some types of resource link specified by their IDs with translations

HTTP syntax

GET /API/V3/RES/ResourceLinkTypes/:linkTypeIds/WithTranslations
<- application/json

JavaScript syntax

Pqf.res.getResourceLinkTypesTranslated(linkTypeIds) // returns ResourceLinkTypeTranslated[]

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
linkTypeIds array of UUID The resource link types' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceLinkTypeTranslated

GET /API/V3/RES/Resources/:resourceIds

Get multiple resource (employee, group, skill, infrastructure, ...)s

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds
<- application/json

JavaScript syntax

Pqf.res.getResources(resourceIds) // returns Resource[]

Other endpoints for objects of type resource

This endpoint is part of a group of endpoints manipulating objects of type resource. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type Resource and ID in specified in parameter resourceIds.

Parameters

Name Type Description Required Assertion
resourceIds array of UUID The resource (employee, group, skill, infrastructure, ...) IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 Resource

GET /API/V3/RES/Resources/:resourceIds/AvailabilitySlot

Returns the availability 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: their working time without absences, before the base load of their worktime model is taken off. All resources share the same slot

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds/AvailabilitySlot?beg=...&end=...
<- application/json

JavaScript syntax

Pqf.res.getResourcesAvailabilitySlot(resourceIds, beg, end) // returns PF.DurationSlot[]

Required permission

Requires permission READ 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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/Resources/:resourceIds/AvailabilitySlots

Returns the availability of one or more resources in time slots: their working time without absences, before the base load of their worktime model is taken off. All resources share the same slots

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds/AvailabilitySlots?beg=...&end=...&zoom=...
<- application/json

JavaScript syntax

Pqf.res.getResourcesAvailabilitySlots(resourceIds, beg, end, zoom) // returns PF.DurationSlot[][]

// Overloads for optional parameters
Pqf.res.getResourcesAvailabilitySlots(resourceIds, beg, end) // returns PF.DurationSlot[][]

Required permission

Requires permission READ 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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/Resources/:resourceIds/Children

Read the children of one or more resources

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds/Children?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourcesChildren(resourceIds, sort) // returns PF.Reference[][]

// Overloads for optional parameters
Pqf.res.getResourcesChildren(resourceIds) // returns PF.Reference[][]

Required permission

Requires permission READ on object of type Resource and ID in specified in parameter resourceIds.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceIds array of UUID The resources' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of array of PF.Reference

GET /API/V3/RES/Resources/:resourceIds/Children/:linkTypeId

Read the children of a given link type of one or more resources

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds/Children/:linkTypeId?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourcesChildrenByLinkType(resourceIds, linkTypeId, sort) // returns PF.Reference[][]

// Overloads for optional parameters
Pqf.res.getResourcesChildrenByLinkType(resourceIds, linkTypeId) // returns PF.Reference[][]

Required permission

Requires permission READ on object of type Resource and ID in specified in parameter resourceIds.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceIds array of UUID The resources' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
linkTypeId UUID The resource link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of array of PF.Reference

Read the links to the children of one or more resources

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds/ChildrenLinks?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourcesChildrenLinks(resourceIds, sort) // returns ResourceLinkReference[][]

// Overloads for optional parameters
Pqf.res.getResourcesChildrenLinks(resourceIds) // returns ResourceLinkReference[][]

Required permission

Requires permission READ on object of type Resource and ID in specified in parameter resourceIds.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceIds array of UUID The resources' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, validityStart, validityUntil and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of array of ResourceLinkReference

GET /API/V3/RES/Resources/:resourceIds/ChildrenLinks/:linkTypeId

Read the links to the children of a given link type of one or more resources

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds/ChildrenLinks/:linkTypeId?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourcesChildrenLinksByLinkType(resourceIds, linkTypeId, sort) // returns ResourceLinkReference[][]

// Overloads for optional parameters
Pqf.res.getResourcesChildrenLinksByLinkType(resourceIds, linkTypeId) // returns ResourceLinkReference[][]

Required permission

Requires permission READ on object of type Resource and ID in specified in parameter resourceIds.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceIds array of UUID The resources' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
linkTypeId UUID The resource link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, validityStart, validityUntil and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of array of ResourceLinkReference

GET /API/V3/RES/Resources/:resourceIds/Identification

Get multiple resource (employee, group, skill, infrastructure, ...) identifications

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.res.getResourceIdentifications(resourceIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.res.getResourceIdentifications(resourceIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type resource

This endpoint is part of a group of endpoints manipulating objects of type resource. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type Resource and ID in specified in parameter resourceIds.

Parameters

Name Type Description Required Assertion Default, if omitted
resourceIds array of UUID The resource (employee, group, skill, infrastructure, ...) IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: array of PF.IdentificationExtended

GET /API/V3/RES/Resources/:resourceIds/Parents

Read the parents of one or more resources

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds/Parents?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourcesParents(resourceIds, sort) // returns PF.Reference[][]

// Overloads for optional parameters
Pqf.res.getResourcesParents(resourceIds) // returns PF.Reference[][]

Required permission

Requires permission READ on object of type Resource and ID in specified in parameter resourceIds.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceIds array of UUID The resources' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of array of PF.Reference

GET /API/V3/RES/Resources/:resourceIds/Parents/:linkTypeId

Read the parents of a given link type of one or more resources

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds/Parents/:linkTypeId?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourcesParentsByLinkType(resourceIds, linkTypeId, sort) // returns PF.Reference[][]

// Overloads for optional parameters
Pqf.res.getResourcesParentsByLinkType(resourceIds, linkTypeId) // returns PF.Reference[][]

Required permission

Requires permission READ on object of type Resource and ID in specified in parameter resourceIds.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceIds array of UUID The resources' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
linkTypeId UUID The resource link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of array of PF.Reference

Read the links to the parents of one or more resources

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds/ParentsLinks?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourcesParentsLinks(resourceIds, sort) // returns ResourceLinkReference[][]

// Overloads for optional parameters
Pqf.res.getResourcesParentsLinks(resourceIds) // returns ResourceLinkReference[][]

Required permission

Requires permission READ on object of type Resource and ID in specified in parameter resourceIds.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceIds array of UUID The resources' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, validityStart, validityUntil and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of array of ResourceLinkReference

GET /API/V3/RES/Resources/:resourceIds/ParentsLinks/:linkTypeId

Read the links to the parents of a given link type of one or more resources

HTTP syntax

GET /API/V3/RES/Resources/:resourceIds/ParentsLinks/:linkTypeId?sort=...
<- application/json

JavaScript syntax

Pqf.res.getResourcesParentsLinksByLinkType(resourceIds, linkTypeId, sort) // returns ResourceLinkReference[][]

// Overloads for optional parameters
Pqf.res.getResourcesParentsLinksByLinkType(resourceIds, linkTypeId) // returns ResourceLinkReference[][]

Required permission

Requires permission READ on object of type Resource and ID in specified in parameter resourceIds.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
resourceIds array of UUID The resources' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
linkTypeId UUID The resource link type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, validityStart, validityUntil and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of array of ResourceLinkReference

GET /API/V3/RES/Resources/Deleted/Recently

Get recently deleted resource (employee, group, skill, infrastructure, ...)s

HTTP syntax

GET /API/V3/RES/Resources/Deleted/Recently
<- application/json

JavaScript syntax

Pqf.res.getRecentlyDeletedResources() // returns PF.IdentificationRecentlyDeleted[]

Other endpoints for objects of type resource

This endpoint is part of a group of endpoints manipulating objects of type resource. The following endpoints belong to the same group:

Required license

This endpoint requires the following licenses:

  • undelete

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Result

This endpoint returns the following data: array of PF.IdentificationRecentlyDeleted

GET /API/V3/RES/ResourceShift/:shiftId

Returns a single shift in resource planning

HTTP syntax

GET /API/V3/RES/ResourceShift/:shiftId
<- application/json : ResourceShift

JavaScript syntax

Pqf.res.getResourceShift(shiftId) // returns ResourceShift

Parameters

Name Type Description Required Assertion
shiftId UUID The resource shift's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: ResourceShift

GET /API/V3/RES/ResourceShifts

Returns all available shifts in resource planning

HTTP syntax

GET /API/V3/RES/ResourceShifts
<- application/json

JavaScript syntax

Pqf.res.getResourceShifts() // returns ResourceShift[]

Result

This endpoint returns the following data: array of ResourceShift

GET /API/V3/RES/ResourceType/:typeId

Returns a specific type of resource

HTTP syntax

GET /API/V3/RES/ResourceType/:typeId
<- application/json : ResourceType

JavaScript syntax

Pqf.res.getResourceType(typeId) // returns ResourceType

Parameters

Name Type Description Required Assertion
typeId UUID The resource's type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: ResourceType

GET /API/V3/RES/ResourceType/:typeId/Resources

Returns all resources of a given type

HTTP syntax

GET /API/V3/RES/ResourceType/:typeId/Resources?sort=...
<- application/json

JavaScript syntax

Pqf.res.getAllResourcesByType(typeId, sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getAllResourcesByType(typeId) // returns PF.Reference[]

Required permission

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
typeId UUID The resource's type ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

GET /API/V3/RES/ResourceType/:typeId/WithTranslations

Returns a specific type of resource with translations

HTTP syntax

GET /API/V3/RES/ResourceType/:typeId/WithTranslations
<- application/json : ResourceTypeTranslated

JavaScript syntax

Pqf.res.getResourceTypeTranslated(typeId) // returns ResourceTypeTranslated

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
typeId UUID The resource type's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: ResourceTypeTranslated

PUT /API/V3/RES/ResourceType/:typeId/WithTranslations

Creates or updates a specific type of resource with translations

HTTP syntax

PUT /API/V3/RES/ResourceType/:typeId/WithTranslations
-> application/json : ResourceTypeTranslated

JavaScript syntax

Pqf.res.putResourceTypeTranslated(typeId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
typeId UUID The resource type's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceTypeTranslated JSON object of type ResourceTypeTranslated ✔️

DELETE /API/V3/RES/ResourceType/:typeId/WithTranslations

Deletes a specific type of resource. A type that is still in use (by resources or by types of resource links) is not deleted (403)

HTTP syntax

DELETE /API/V3/RES/ResourceType/:typeId/WithTranslations

JavaScript syntax

Pqf.res.delResourceTypeTranslated(typeId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
typeId UUID The resource type's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/RES/ResourceTypes

Returns all types of resource that are available

HTTP syntax

GET /API/V3/RES/ResourceTypes?sort=...
<- application/json

JavaScript syntax

Pqf.res.getAllResourceTypes(sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getAllResourceTypes() // returns PF.Reference[]

Parameters

Name Type Description Required Assertion
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, resourceGroupId, resourceKind pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

GET /API/V3/RES/ResourceTypes/:typeIds

Returns some types of resource specified by their IDs

HTTP syntax

GET /API/V3/RES/ResourceTypes/:typeIds
<- application/json

JavaScript syntax

Pqf.res.getResourceTypes(typeIds) // returns ResourceType[]

Parameters

Name Type Description Required Assertion
typeIds array of UUID The resource types' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceType

GET /API/V3/RES/ResourceTypes/:typeIds/Resources

Returns all resources of given types

HTTP syntax

GET /API/V3/RES/ResourceTypes/:typeIds/Resources?sort=...
<- application/json

JavaScript syntax

Pqf.res.getAllResourcesByTypes(typeIds, sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.res.getAllResourcesByTypes(typeIds) // returns PF.Reference[]

Required permission

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
typeIds array of UUID The resource types' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, email and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

GET /API/V3/RES/ResourceTypes/:typeIds/WithTranslations

Returns some types of resource specified by their IDs with translations

HTTP syntax

GET /API/V3/RES/ResourceTypes/:typeIds/WithTranslations
<- application/json

JavaScript syntax

Pqf.res.getResourceTypesTranslated(typeIds) // returns ResourceTypeTranslated[]

Required license

This endpoint requires the following licenses:

  • config-resourcetypes

Required permission

Requires permission 20992979D2E34BE59C715B21AAA40DFE.

Parameters

Name Type Description Required Assertion
typeIds array of UUID The resource types' IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ResourceTypeTranslated

Data types

RES.AbsenceType

This is a structure data contract.

A type of absence for resources

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
availabilityPercentage int The percentage of availability for work (0 for absent, 100 for full availability) 100 >= n >= 0 (The value must be between 0 and 100, both inclusive.)
presencePercentage int The percentage of physical presence at office (0 for absent, 100 for full presence) 100 >= n >= 0 (The value must be between 0 and 100, both inclusive.)
category int Some obscure value affecting the grouping of absences on the client (ask the client team about details) 100 >= n >= 0 (The value must be between 0 and 100, both inclusive.)

RES.AbsenceTypeTranslated

This is a structure data contract.

A type of absence for resources with translations

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name array of PF.TextTranslation ✔️ The name of the object in different languages length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description array of PF.TextTranslation ✔️ A descriptive text about the object, may contain HTML (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef array of PF.IconTranslation ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
availabilityPercentage int The percentage of availability for work (0 for absent, 100 for full availability) 100 >= n >= 0 (The value must be between 0 and 100, both inclusive.)
presencePercentage int The percentage of physical presence at office (0 for absent, 100 for full presence) 100 >= n >= 0 (The value must be between 0 and 100, both inclusive.)
category int Some obscure value affecting the grouping of absences on the client (ask the client team about details) 100 >= n >= 0 (The value must be between 0 and 100, both inclusive.)

RES.Availability

This is a structure data contract.

Availability model 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 '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
parent PF.Reference A reference to indicate the place in the resource tree where this object belongs to (read-only) non-null (The value is required.)
inheritFromParent boolean a flag indicating that model has to be inherited from parent (ignored if root resource)
inheritedFrom PF.Reference A reference to indicate the resource tree where the model has been inherited from (read-only)
validityStart date the first day of validity non-null (The value is required.)
holidayLocaleId UUID the locale for the holidays (in Switzerland, each Kanton has its own holidays - and yes, Zug has a lot of them) matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
models array of ShiftModel the standard availabilities for each shift on each weekday non-null;non-null (The array is required. Each element must not be null.)
basicLoadPercentage int the basic load of resource (the percentage of time that has to be spent for other things than projects, i.e. administrative tasks) 100 >= n >= 0 (The value must be between 0 and 100, both inclusive.)
costPerHour PF.CurrencyAmount the costs per hour for a resource (needed to transform efforts into costs)
ftePercentage int the amount of full time equivalents that a resource counts for (0 for groups, 100 for single resources) 100 >= n >= 0 (The value must be between 0 and 100, both inclusive.)
standardAvailabilities array of duration the standard availabilities per day (may differ from the sum of shift availabilities, always 7 elements, mon - sun) null;non-null (The array is optional. Each element must not be null.)

RES.AvailabilityReference

This is a structure data contract.

A reference to an availability, together with the resource it is defined on

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
parent PF.Reference ✔️ A reference to a parent (if any)
validityStart date the first day of validity non-null (The value is required.)
inheritFromParent boolean a flag indicating that model has to be inherited from parent (ignored if root resource)
inheritedFrom PF.Reference A reference to indicate the resource tree where the model has been inherited from (read-only)

RES.CalendarFileFormat

This is an enumeration data contract.

Calendar format for holiday import

Enum values

ID Description
Ical iCal calendar format

RES.Holiday

This is a structure data contract.

Describes a holiday for resources (assigned to a date and a shift)

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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
holidayLocaleId UUID The ID of the holiday locale the holiday belongs to non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 of the holiday non-null (The value is required.)
shiftId UUID The ID of the shift that is affected non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name string The name of the holiday in the user's language

RES.HolidayLocale

This is a structure data contract.

A place reference for a collection of bank holidays

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)

RES.HolidayReference

This is a structure data contract.

References a holiday for resources (assigned to a date and a shift)

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
holidayLocaleId UUID The ID of the holiday locale the holiday belongs to non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 of the holiday non-null (The value is required.)
shiftId UUID The ID of the shift that is affected non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)

RES.Presence

This is a structure data contract.

A resource presence as part of its worktime model

Members

Name Type Inherited Description Assertion
present boolean a flag indicating whether a resource is normally present
duration duration the duration if present

RES.Resource

This is a structure data contract.

A resource (an entity that may be allocated to projects and work items)

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
properties array of PF.Property ✔️ A collection of dynamic properties belonging to the object non-null;non-null (The array is required. Each element must not be null.)
email string the email address of a resource (this information may be used for single sign on) matches '\|[\w-\.]+@(?:[\w-]+\.)+[\w-]{2,}' (The value, if present, must be empty or an e-mail address.)

RES.ResourceGroup

This is a structure data contract.

A resource group (HRM, KSM, ...)

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
rootResource PF.Reference the root resource of the group
sortIndex double The index that defines the default order of the resource groups (lowest first)

RES.ResourceGroupStandardWorktime

This is a structure data contract.

Describes the standard worktime of a resource group

Members

Name Type Inherited Description Assertion
resourceGroupId UUID The ID of the resource group matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
timePerWeek duration the time per week that resources work non-null (The value is required.)
daysPerWeek int the days per week that resources work 7 >= n > 0 (The value must be greater than 0 and at most 7.)

RES.ResourceGroupTranslated

This is a structure data contract.

A resource group (HRM, KSM, ...) with translations

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name array of PF.TextTranslation ✔️ The name of the object in different languages length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description array of PF.TextTranslation ✔️ A descriptive text about the object, may contain HTML (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef array of PF.IconTranslation ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
rootResource PF.Reference the root resource of the group. Read-only: a request may omit it or repeat it
rootLinkTypeName array of PF.TextTranslation The name of the link from the group to its root resource (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
sortIndex int The index that defines the default order of the resource groups (lowest first)

RES.ResourceKind

This is an enumeration data contract.

A resource kind, grouping different resource types with same semantics

Enum values

ID Description
RES-KIND-ABSTRACT an abstract resource, like knowledge
RES-KIND-GROUP a group of resources
RES-KIND-INFRASTRUCTURE infrastructural resources like buildings or machines
RES-KIND-PERSON a resource that is a human being

This is a structure data contract.

A link between two resources

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
properties array of PF.Property ✔️ A collection of dynamic properties belonging to the object non-null;non-null (The array is required. Each element must not be null.)
fromResource PF.Reference A reference to the source resource non-null (The value is required.)
toResource PF.Reference A reference to the target resource non-null (The value is required.)
validityStart date the first day the link is valid (may be null for a link that has always been valid)
validityUntil date the first day the link is no longer valid (may be null for a link that does not expire)

RES.ResourceLinkReference

This is a structure data contract.

A reference to a link between two resources

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
fromResource PF.Reference A reference to the source resource non-null (The value is required.)
toResource PF.Reference A reference to the target resource non-null (The value is required.)

RES.ResourceLinkType

This is a structure data contract.

A resource link type

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
nameForward string the name of the resource link type in the user's language
nameBackward string the reverse name of the resource link type in the user's language
description string A descriptive text about the object, may contain HTML
color color A color or any identifier of a color
iconRef URI value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
fromResourceTypeId UUID the ID of the source resource's type matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
toResourceTypeId UUID the ID of the destination resource's type matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
hard boolean flag to indicate a hard link (a link that builds the resource tree structure)
targetObjectNeedsParentPermission boolean require permission of source resource if trying to access target resource
targetObjectInheritRelations boolean inherit relations of source resource if trying to access target resource
implicitRelationTypeId UUID The ID of the relation type PQFORCE created for this link type, null if there is none matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
sortIndexForward double Defines the sort index seen from the source resource (lowest first)
sortIndexBackward double Defines the sort index seen from the target resource (lowest first)

RES.ResourceLinkTypeTranslated

This is a structure data contract.

A resource link type with translations

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
nameForward array of PF.TextTranslation The name of the resource link type seen from the source resource, in different languages non-null & length > 0;non-null (The array is required and must contain at least one element. Each element must not be null.)
nameBackward array of PF.TextTranslation The name of the resource link type seen from the target resource, in different languages non-null & length > 0;non-null (The array is required and must contain at least one element. Each element must not be null.)
description array of PF.TextTranslation A descriptive text about the object, may contain HTML (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
color color A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef array of PF.IconTranslation value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
fromResourceTypeId UUID the ID of the source resource's type, fixed once the type of link exists non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
toResourceTypeId UUID the ID of the destination resource's type, fixed once the type of link exists non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
hard boolean flag to indicate a hard link (a link that builds the resource tree structure), fixed once the type of link exists
treeFollow boolean flag to indicate that resource trees follow links of this type
inheritWorkload boolean flag to indicate that the source resource inherits the workload of the target resource
targetObjectNeedsParentPermission boolean require permission of source resource if trying to access target resource
targetObjectInheritRelations boolean inherit relations of source resource if trying to access target resource
implicitRelation boolean flag to indicate that PQFORCE creates a relation type for this link type, so that permissions can follow the links
implicitRelationTypeId UUID The ID of the relation type PQFORCE created for this link type, null if there is none. Read-only: a request may omit it or repeat the ID PQFORCE derives for the type of link matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
userResourceInheritRelations array of UUID The relation types that a user inherits from the source resource of a link of this type to the user's resource (empty if none) non-null;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The array is required. 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.)
sortIndexForward double Defines the sort index seen from the source resource (lowest first)
sortIndexBackward double Defines the sort index seen from the target resource (lowest first)
dropPriority double Defines which type of link is preferred when a resource is dropped onto another one (lowest first)
features array of UUID The features / tabs that are available for the type of link (defined by the client) non-null;matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The array is required. Each element, if not null, 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.)

RES.ResourceShift

This is a structure data contract.

Defines a worktime shift for a resource.

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
duration duration the effective duration of the shift (may not match begTime until endTime) non-null (The value is required.)
startTime duration the time of day the shift starts (duration since midnight) non-null (The value is required.)
endTime duration the time of day the shift ends (duration since midnight) non-null (The value is required.)

RES.ResourceType

This is a structure data contract.

A resource type

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
resourceGroupId UUID the group this resource type belongs to matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
costsTypeId UUID the costs type that efforts of such resources will be accounted for matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
resourceKind ResourceKind the kind of resource (semantics)
features array of UUID The features / tabs that are available for the type non-null;matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The array is required. Each element, if not null, 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.)

RES.ResourceTypeTranslated

This is a structure data contract.

A resource type with translations

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
name array of PF.TextTranslation ✔️ The name of the object in different languages length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description array of PF.TextTranslation ✔️ A descriptive text about the object, may contain HTML (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef array of PF.IconTranslation ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
resourceGroupId UUID the group this resource type belongs to non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
costsTypeId UUID the costs type that efforts of such resources will be accounted for non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
resourceKind ResourceKind the kind of resource (semantics) non-null (The value is required.)
ftePercentage int the amount of full time equivalents that a resource of this type counts for (0 for groups, 100 for single resources) 100 >= n >= 0 (The value must be between 0 and 100, both inclusive.)
features array of UUID The features / tabs that are available for the type (defined by the client) non-null;matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The array is required. Each element, if not null, 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.)

RES.ShiftModel

This is a structure data contract.

Presences for a specific shift

Members

Name Type Inherited Description Assertion
shiftId UUID The ID of the shift non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
presencePerDay array of Presence an array containing the presences for each weekday (always 7 elements, mon - sun) non-null & 7 >= length >= 7;non-null (The array is required and must contain exactly 7 elements. Each element must not be null.)

RES.WorkdayMapping

This is a structure data contract.

Maps a workday scheme to weekdays or vice versa

Members

Name Type Inherited Description Assertion
resource PF.Reference a reference to the resource non-null (The value is required.)
referenceDay date the 0-reference day
mapping array of int the mapping (distance to reference date in days) non-null;non-null (The array is required. Each element must not be null.)
↑

Notification

Portal tour

A guided tour walks you through the page step by step, highlighting one control at a time and explaining what it does. You can stop at any point and pick up later.

    Tours can be restarted at any time.

    Release notes are automatically translated into German.