API V3 Documentation – PI

PQFORCE 4.26.6 Preview

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

Endpoints

GET /API/V3/PI/ItemType/:itemType/Item/:projectItemId

Get a project item

HTTP syntax

GET /API/V3/PI/ItemType/:itemType/Item/:projectItemId
<- application/json : ProjectItem

JavaScript syntax

Pqf.pi.getProjectItem(itemType, projectItemId) // returns ProjectItem

Other endpoints for objects of type project item

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

Required permission

Requires permission READ on object of type specified in parameter itemType and ID specified in parameter projectItemId.

Parameters

Name Type Description Required Assertion
itemType UUID The ID of the item 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.)
projectItemId UUID The project item's ID ✔️ 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: ProjectItem

PUT /API/V3/PI/ItemType/:itemType/Item/:projectItemId

Update an existing project item

HTTP syntax

PUT /API/V3/PI/ItemType/:itemType/Item/:projectItemId
-> application/json : ProjectItem

JavaScript syntax

Pqf.pi.putProjectItem(itemType, projectItemId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type project item

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

Required permission

Requires permission UPDATE or CREATE on object of type specified in parameter itemType and ID specified in parameter projectItemId.

Parameters

Name Type Description Required Assertion
itemType UUID The ID of the item 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.)
projectItemId UUID The project item's ID ✔️ matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.)
requestJson ProjectItem JSON object of type ProjectItem ✔️

DELETE /API/V3/PI/ItemType/:itemType/Item/:projectItemId

Delete a project item

HTTP syntax

DELETE /API/V3/PI/ItemType/:itemType/Item/:projectItemId

JavaScript syntax

Pqf.pi.delProjectItem(itemType, projectItemId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type project item

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

Required permission

Requires permission DELETE on object of type specified in parameter itemType and ID specified in parameter projectItemId.

Parameters

Name Type Description Required Assertion
itemType UUID The ID of the item 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.)
projectItemId UUID The project item's ID ✔️ matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.)

GET /API/V3/PI/ItemType/:itemType/Item/:projectItemId/Identification

Get a project item identification

HTTP syntax

GET /API/V3/PI/ItemType/:itemType/Item/:projectItemId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.pi.getProjectItemIdentification(itemType, projectItemId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.pi.getProjectItemIdentification(itemType, projectItemId) // returns PF.IdentificationExtended

Other endpoints for objects of type project item

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

Required permission

Requires permission IDENTIFY on object of type specified in parameter itemType and ID specified in parameter projectItemId.

Parameters

Name Type Description Required Assertion Default, if omitted
itemType UUID The ID of the item 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.)
projectItemId UUID The project item's ID ✔️ matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: PF.IdentificationExtended

GET /API/V3/PI/ItemType/:itemType/Item/:projectItemId/Timeline

Get a project item's version timeline

HTTP syntax

GET /API/V3/PI/ItemType/:itemType/Item/:projectItemId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.pi.getProjectItemTimeline(itemType, projectItemId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.pi.getProjectItemTimeline(itemType, projectItemId, limit, until, from) // returns PF.VersionTimeline
Pqf.pi.getProjectItemTimeline(itemType, projectItemId, limit, until) // returns PF.VersionTimeline
Pqf.pi.getProjectItemTimeline(itemType, projectItemId, limit) // returns PF.VersionTimeline
Pqf.pi.getProjectItemTimeline(itemType, projectItemId) // returns PF.VersionTimeline

Other endpoints for objects of type project item

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

Required permission

Requires permission READ on object of type specified in parameter itemType and ID specified in parameter projectItemId.

Parameters

Name Type Description Required Assertion
itemType UUID The ID of the item 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.)
projectItemId UUID The project item's ID ✔️ matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.)
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/PI/ItemType/:itemType/Item/:projectItemId/Version/:versionId

Get a project item's specific (historic) version

HTTP syntax

GET /API/V3/PI/ItemType/:itemType/Item/:projectItemId/Version/:versionId
<- application/json : ProjectItem

JavaScript syntax

Pqf.pi.getProjectItemVersion(itemType, projectItemId, versionId) // returns ProjectItem

Other endpoints for objects of type project item

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

Required permission

Requires permission READ on object of type specified in parameter itemType and ID specified in parameter projectItemId.

Parameters

Name Type Description Required Assertion
itemType UUID The ID of the item 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.)
projectItemId UUID The project item's ID ✔️ matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.)
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: ProjectItem

GET /API/V3/PI/ItemType/:itemType/Items/:projectItemIds

Get multiple project items

HTTP syntax

GET /API/V3/PI/ItemType/:itemType/Items/:projectItemIds
<- application/json

JavaScript syntax

Pqf.pi.getProjectItems(itemType, projectItemIds) // returns ProjectItem[]

Other endpoints for objects of type project item

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

Required permission

Requires permission READ on object of type specified in parameter itemType and ID in specified in parameter projectItemIds.

Parameters

Name Type Description Required Assertion
itemType UUID The ID of the item 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.)
projectItemIds array of UUID The project item IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[0-9A-F]{32}' (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 a UUID written as 32 upper-case hexadecimal digits.)

Result

This endpoint returns the following data: array of ProjectItem

GET /API/V3/PI/ItemType/:itemType/Items/:projectItemIds/Identification

Get multiple project item identifications

HTTP syntax

GET /API/V3/PI/ItemType/:itemType/Items/:projectItemIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.pi.getProjectItemIdentifications(itemType, projectItemIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.pi.getProjectItemIdentifications(itemType, projectItemIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type project item

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

Required permission

Requires permission IDENTIFY on object of type specified in parameter itemType and ID in specified in parameter projectItemIds.

Parameters

Name Type Description Required Assertion Default, if omitted
itemType UUID The ID of the item 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.)
projectItemIds array of UUID The project item IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[0-9A-F]{32}' (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 a UUID written as 32 upper-case hexadecimal digits.)
deleted boolean Allow deleted objects to be returned false

Result

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

GET /API/V3/PI/ItemType/:type

Returns a specific project item type description

HTTP syntax

GET /API/V3/PI/ItemType/:type
<- application/json : ProjectItemType

JavaScript syntax

Pqf.pi.getProjectItemType(type) // returns ProjectItemType

Parameters

Name Type Description Required Assertion
type UUID The ID of the item 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.)

Result

This endpoint returns the following data: ProjectItemType

GET /API/V3/PI/ItemType/:type/Items

Returns references to all project items of a specific project item type

HTTP syntax

GET /API/V3/PI/ItemType/:type/Items?states=...&reachedAtOrAfter=...&reachedBefore=...&sort=...
<- application/json

JavaScript syntax

Pqf.pi.getAllProjectItems(type, states, reachedAtOrAfter, reachedBefore, sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.pi.getAllProjectItems(type, states, reachedAtOrAfter, reachedBefore) // returns PF.Reference[]
Pqf.pi.getAllProjectItems(type, states, reachedAtOrAfter) // returns PF.Reference[]
Pqf.pi.getAllProjectItems(type, states) // returns PF.Reference[]
Pqf.pi.getAllProjectItems(type) // returns PF.Reference[]

Required permission

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

Parameters

Name Type Description Required Assertion
type UUID The ID of the item 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.)
states array of UUID A status list to filter (optional) 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 optional. 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.)
reachedAtOrAfter datetime filter out items that reached their state before the given timestamp (requires states to be provided also)
reachedBefore datetime filter out items that reached their state at or after the given timestamp (requires states to be provided also)
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, colorId, createdAt, modifiedAt, sortIndex, validityStart, validityUntil, markerId 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

POST /API/V3/PI/ItemType/:type/Items/Add

Adds a new project item, related to a given object if relType, refType and refId are given, related by the relations copied from the cloned item or by the automatically created relations of the item type otherwise

HTTP syntax

POST /API/V3/PI/ItemType/:type/Items/Add?copy=...&name=...&code=...&description=...&colorId=...&iconRef=...&markerId=...&copyDocs=...&copyRelations=...&copyBwdRelations=...&relType=...&refType=...&refId=...&forward=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.pi.addProjectItem(type, copy, name, code, description, colorId, iconRef, markerId, copyDocs, copyRelations, copyBwdRelations, relType, refType, refId, forward) // returns PF.Reference

// Overloads for optional parameters
Pqf.pi.addProjectItem(type, copy, name, code, description, colorId, iconRef, markerId, copyDocs, copyRelations, copyBwdRelations, relType, refType, refId) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy, name, code, description, colorId, iconRef, markerId, copyDocs, copyRelations, copyBwdRelations, relType, refType) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy, name, code, description, colorId, iconRef, markerId, copyDocs, copyRelations, copyBwdRelations, relType) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy, name, code, description, colorId, iconRef, markerId, copyDocs, copyRelations, copyBwdRelations) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy, name, code, description, colorId, iconRef, markerId, copyDocs, copyRelations) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy, name, code, description, colorId, iconRef, markerId, copyDocs) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy, name, code, description, colorId, iconRef, markerId) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy, name, code, description, colorId, iconRef) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy, name, code, description, colorId) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy, name, code, description) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy, name, code) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy, name) // returns PF.Reference
Pqf.pi.addProjectItem(type, copy) // returns PF.Reference
Pqf.pi.addProjectItem(type) // returns PF.Reference

Required permission

Requires permission CREATE on object of type specified in parameter type.

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

Requires permission LINK on object of type specified in parameter refType and ID specified in parameter refId if it is set.

Parameters

Name Type Description Required Assertion Default, if omitted
type UUID The ID of the item 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.)
copy UUID The ID of any item to clone 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 item, the one of the cloned item or template 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 item, may contain HTML, the one of the cloned item or template if omitted
colorId UUID An ID pointing to a client's enum containing the color of the new item 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.)
iconRef URI The icon of the new item, 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.)
markerId UUID An ID of the marker enum to be used for the new item 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.)
copyDocs boolean Copy the document links and folders of the cloned item or template false
copyRelations boolean Copy the forward pointing relations of the cloned item or template false
copyBwdRelations boolean Copy the backward pointing relations of the cloned item or template false
relType UUID The type of the relation between the referenced object and the new item, to be given together with refType and refId or not at all 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.)
refType UUID The type of the object to relate the new item to, to be given together with relType and refId or not at all 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, if present, 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.)
refId UUID The ID of the object to relate the new item to, to be given together with relType and refType or not at all 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.)
forward boolean? The direction of the relation to the referenced object, necessary only if the relation type is ambiguous, derived from the relation type if omitted

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/PI/ItemType/:type/Ref/:relType/:refType/:refId/Items

Returns references to the project items of a specific project item type that are related to a given object

HTTP syntax

GET /API/V3/PI/ItemType/:type/Ref/:relType/:refType/:refId/Items?states=...&reachedAtOrAfter=...&reachedBefore=...&sort=...
<- application/json

JavaScript syntax

Pqf.pi.getProjectItemsByRef(type, relType, refType, refId, states, reachedAtOrAfter, reachedBefore, sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.pi.getProjectItemsByRef(type, relType, refType, refId, states, reachedAtOrAfter, reachedBefore) // returns PF.Reference[]
Pqf.pi.getProjectItemsByRef(type, relType, refType, refId, states, reachedAtOrAfter) // returns PF.Reference[]
Pqf.pi.getProjectItemsByRef(type, relType, refType, refId, states) // returns PF.Reference[]
Pqf.pi.getProjectItemsByRef(type, relType, refType, refId) // returns PF.Reference[]

Required permission

Requires permission IDENTIFY on object of type specified in parameter refType and ID specified in parameter refId.

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

Parameters

Name Type Description Required Assertion
type UUID The ID of the item 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.)
relType UUID The type of relation ✔️ 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.)
refType UUID The type of the referenced object ✔️ 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 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.)
refId UUID The ID of the referenced object ✔️ 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.)
states array of UUID A status list to filter (optional) 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 optional. 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.)
reachedAtOrAfter datetime filter out items that reached their state before the given timestamp (requires states to be provided also)
reachedBefore datetime filter out items that reached their state at or after the given timestamp (requires states to be provided also)
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, colorId, createdAt, modifiedAt, sortIndex, validityStart, validityUntil, markerId 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/PI/ItemTypes

Returns references to all available project item type descriptions

HTTP syntax

GET /API/V3/PI/ItemTypes?sort=...
<- application/json

JavaScript syntax

Pqf.pi.getAllProjectItemTypes(sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.pi.getAllProjectItemTypes() // 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, colorEnumTypeId, markerEnumTypeId 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/PI/ItemTypes/:types

Returns some project item type descriptions specified by their IDs

HTTP syntax

GET /API/V3/PI/ItemTypes/:types
<- application/json

JavaScript syntax

Pqf.pi.getProjectItemTypes(types) // returns ProjectItemType[]

Parameters

Name Type Description Required Assertion
types array of UUID The IDs of the item types ✔️ 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 ProjectItemType

Data types

PI.ProjectItem

This is a structure data contract.

Describes a project item like a TODO

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
colorId UUID An ID pointing to a client's enum containing the color 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.)
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.)
validityStart date Start (inclusive) of the validity period of the object (often null)
validityUntil date End (exclusive) of the validity period of the object (often null)
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.)
sortIndex double? A sort index that may be used by the client to fix a specific order, null keeps the current value
markerId UUID An ID of the marker enum to be used 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.)

PI.ProjectItemType

This is a structure data contract.

Describes some type of project 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.)
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.)
colorEnumTypeId UUID The enum type that can be used as color 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.)
markerEnumTypeId UUID The enum type that can be used as marker 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.)
↑

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.