API V3 Documentation – PF

Endpoints

GET /API/V3/PF/Attachment/:attachmentId

Retrieves an attachment stored in PQFORCE

HTTP syntax

GET /API/V3/PF/Attachment/:attachmentId?name=...
<- application/octet-stream

Parameters

Name	Type	Description	Required	Assertion
attachmentId	string	The ID of the attachment	✔️	matches '[0-9A-Z]{52}\|[0-9a-zA-Z]{43}' (The value must be a hashed ID (52 upper-case letters and digits, or 43 letters and digits).)
name	string	The filename that has to be proposed when downloading the attachment

Result

This endpoint returns the following data: Binary

GET /API/V3/PF/Attachment/:attachmentId/Binary

Retrieves an attachment stored in PQFORCE as binary

JavaScript syntax

Pqf.pf.getAttachmentBinary(attachmentId) // returns Object

Parameters

Name	Type	Description	Required	Assertion
attachmentId	string	The ID of the attachment	✔️	matches '[0-9A-Z]{52}\|[0-9a-zA-Z]{43}' (The value must be a hashed ID (52 upper-case letters and digits, or 43 letters and digits).)

Result

This endpoint returns the following data: binary

GET /API/V3/PF/Attachment/:attachmentId/Details

Retrieves information (no data) about an attachment stored in PQFORCE

HTTP syntax

GET /API/V3/PF/Attachment/:attachmentId/Details
<- application/json : AttachmentDetails

JavaScript syntax

Pqf.pf.getAttachmentDetails(attachmentId) // returns AttachmentDetails

Parameters

Name	Type	Description	Required	Assertion
attachmentId	string	The ID of the attachment	✔️	matches '[0-9A-Z]{52}\|[0-9a-zA-Z]{43}' (The value must be a hashed ID (52 upper-case letters and digits, or 43 letters and digits).)

Result

This endpoint returns the following data: AttachmentDetails

GET /API/V3/PF/Attachment/:attachmentId/Json

Retrieves an attachment stored in PQFORCE as JSON

JavaScript syntax

Pqf.pf.getAttachmentJson(attachmentId) // returns Object

Parameters

Name	Type	Description	Required	Assertion
attachmentId	string	The ID of the attachment	✔️	matches '[0-9A-Z]{52}\|[0-9a-zA-Z]{43}' (The value must be a hashed ID (52 upper-case letters and digits, or 43 letters and digits).)

Result

This endpoint returns the following data: JSON

GET /API/V3/PF/Attachment/:attachmentId/Text

Retrieves an attachment stored in PQFORCE as text

JavaScript syntax

Pqf.pf.getAttachmentText(attachmentId, encoding) // returns String

// Overloads for optional parameters
Pqf.pf.getAttachmentText(attachmentId) // returns String

Parameters

Name	Type	Description	Required	Assertion
attachmentId	string	The ID of the attachment	✔️	matches '[0-9A-Z]{52}\|[0-9a-zA-Z]{43}' (The value must be a hashed ID (52 upper-case letters and digits, or 43 letters and digits).)
encoding	string	The text encoding to use

Result

This endpoint returns the following data: string

POST /API/V3/PF/Attachment/Add

Stores an attachment in PQFORCE

HTTP syntax

POST /API/V3/PF/Attachment/Add
-> application/octet-stream
<- application/json : AttachmentDetails

Required license

This endpoint requires the following licenses:

• documentupload

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Parameters

Name	Type	Description	Required	Assertion
requestBinary	Binary	Raw content of mime type application/octet-stream	✔️

Result

This endpoint returns the following data: AttachmentDetails

POST /API/V3/PF/Attachment/Add/Binary/:mimeType

Stores a binary attachment in PQFORCE

JavaScript syntax

Pqf.pf.addAttachmentBinary(mimeType, requestRaw) // returns AttachmentDetails

Required license

This endpoint requires the following licenses:

• documentupload

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Parameters

Name	Type	Description	Required	Assertion
mimeType	string	MIME type (now properly called "media type", but also sometimes "content type")	✔️	matches '[0-9A-Za-z][0-9A-Za-z!#$&\-^_]{0,63}/[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]{0,63}(?:;[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*=[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*)*' (The value must be a media (MIME) type such as "application/json", optionally with parameters.)
requestRaw	binary	Raw content of mime type application/octet-stream	✔️

Result

This endpoint returns the following data: AttachmentDetails

POST /API/V3/PF/Attachment/Add/Json/:mimeType

Stores a JSON attachment in PQFORCE

JavaScript syntax

Pqf.pf.addAttachmentJson(mimeType, requestJson) // returns AttachmentDetails

Required license

This endpoint requires the following licenses:

• documentupload

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Parameters

Name	Type	Description	Required	Assertion
mimeType	string	MIME type (now properly called "media type", but also sometimes "content type")	✔️	matches '[0-9A-Za-z][0-9A-Za-z!#$&\-^_]{0,63}/[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]{0,63}(?:;[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*=[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*)*' (The value must be a media (MIME) type such as "application/json", optionally with parameters.)
requestJson	JSON	Raw content of mime type application/json	✔️

Result

This endpoint returns the following data: AttachmentDetails

POST /API/V3/PF/Attachment/Add/Text/:mimeType

Stores a text attachment in PQFORCE

JavaScript syntax

Pqf.pf.addAttachmentText(mimeType, encoding, requestText) // returns AttachmentDetails

// Overloads for optional parameters
Pqf.pf.addAttachmentText(mimeType, requestText) // returns AttachmentDetails

Required license

This endpoint requires the following licenses:

• documentupload

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Parameters

Name	Type	Description	Required	Assertion
mimeType	string	MIME type (now properly called "media type", but also sometimes "content type")	✔️	matches '[0-9A-Za-z][0-9A-Za-z!#$&\-^_]{0,63}/[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]{0,63}(?:;[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*=[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*)*' (The value must be a media (MIME) type such as "application/json", optionally with parameters.)
encoding	string	The text encoding to use
requestText	string	Raw content of mime type text/plain	✔️

Result

This endpoint returns the following data: AttachmentDetails

POST /API/V3/PF/ChangeNotification/CreateNew

Creates a new WebSocket and returns its URL. The change notification WebSocket serves as change notifier for agents and other interface components.

HTTP syntax

POST /API/V3/PF/ChangeNotification/CreateNew
<- application/json : WebSocketInfo

Hint: This endpoint is available only in public API access.

Websocket

This endpoint returns an URL to a WebSocket (note the limited validity). A WebSocket is a full-duplex communication protocol that runs over a single, long-lived TCP connection, allowing a client and server to exchange messages in both directions without repeatedly opening new connections. It is standardized in RFC 6455, and connections are established through an HTTP-based handshake that upgrades the protocol.

The WebSocket uses JSON messages, based on data contracts. As these data contracts use choice semantics, each member of them defines a message which is transferred on its own.

The server does not accept messages on this WebSocket, however an empty message {} may be sent.

The messages that may be received by the client are based on ChangeNotificationWebSocketServerToClient

Message type	Syntax	Data type	Description
sessionInfo	{"sessionInfo":…}	SessionInfo	This message is sent by server once to inform about the current session
dataChange	{"dataChange":…}	ChangeNotification	This message is sent by server to inform about an object that was changed or created
-	{}		The client may receive am empty message.

Result

This endpoint returns the following data: WebSocketInfo

GET /API/V3/PF/Config/:configId

Returns a configuration value that is tenant-specific

HTTP syntax

GET /API/V3/PF/Config/:configId
<- text/plain

JavaScript syntax

Pqf.pf.getConfig(configId) // returns String

Parameters

Name	Type	Description	Required	Assertion
configId	UUID	The ID of the configuration value	✔️	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: string

PUT /API/V3/PF/Config/:configId

Sets a configuration value that is tenant-specific

HTTP syntax

PUT /API/V3/PF/Config/:configId
-> text/plain

JavaScript syntax

Pqf.pf.putConfig(configId, requestText) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
configId	UUID	The ID of the configuration value	✔️	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.)
requestText	string	Raw content of mime type text/plain	✔️

DELETE /API/V3/PF/Config/:configId

Deletes a configuration value that is tenant-specific

HTTP syntax

DELETE /API/V3/PF/Config/:configId

JavaScript syntax

Pqf.pf.delConfig(configId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
configId	UUID	The ID of the configuration value	✔️	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/PF/DefaultIcon/:objectType

Returns the default icon for an object given its name and / or code

HTTP syntax

GET /API/V3/PF/DefaultIcon/:objectType?name=...&code=...
<- image/svg+xml

Hint: This endpoint is static. This means that every call to the same URL will return exactly the same result. Therefore the reposne may be cached. When sending an ETag in the HTTP headers (If-None-Match header), the result 304indicates that the content in cache is still valid.

JavaScript syntax

Pqf.pf.getDefaultIcon(objectType, name, code) // returns String

// Overloads for optional parameters
Pqf.pf.getDefaultIcon(objectType, name) // returns String
Pqf.pf.getDefaultIcon(objectType) // returns String

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of 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.)
name	string	The name of the object
code	string	The code of the object

Result

This endpoint returns the following data: string

GET /API/V3/PF/DocFolder/:objectType/:objectId/:folderId

Returns a document folder of a given object

HTTP syntax

GET /API/V3/PF/DocFolder/:objectType/:objectId/:folderId
<- application/json : DocumentFolder

JavaScript syntax

Pqf.pf.getDocumentFolder(objectType, objectId, folderId) // returns DocumentFolder

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission READ on object of type specified in parameter objectType suffixed with /DocumentFolder and ID specified in parameter folderId.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the document folder	✔️	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: DocumentFolder

PUT /API/V3/PF/DocFolder/:objectType/:objectId/:folderId

Updates an existing document folder of a given object

HTTP syntax

PUT /API/V3/PF/DocFolder/:objectType/:objectId/:folderId
-> application/json : DocumentFolder

JavaScript syntax

Pqf.pf.putDocumentFolder(objectType, objectId, folderId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission UPDATE on object of type specified in parameter objectType suffixed with /DocumentFolder and ID specified in parameter folderId.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the document folder	✔️	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	DocumentFolder	JSON object of type DocumentFolder	✔️

DELETE /API/V3/PF/DocFolder/:objectType/:objectId/:folderId

Deletes a document folder of a given object

HTTP syntax

DELETE /API/V3/PF/DocFolder/:objectType/:objectId/:folderId

JavaScript syntax

Pqf.pf.delDocumentFolder(objectType, objectId, folderId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission DELETE on object of type specified in parameter objectType suffixed with /DocumentFolder and ID specified in parameter folderId.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the document folder	✔️	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/PF/DocFolder/:objectType/:objectId/:folderId/DocFolders

Returns all document folders of a given object's folder

HTTP syntax

GET /API/V3/PF/DocFolder/:objectType/:objectId/:folderId/DocFolders?depth=...
<- application/json

JavaScript syntax

Pqf.pf.getAllDocumentFoldersOfFolder(objectType, objectId, folderId, depth) // returns DocumentReference[]

// Overloads for optional parameters
Pqf.pf.getAllDocumentFoldersOfFolder(objectType, objectId, folderId) // returns DocumentReference[]

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission READ on object of type specified in parameter objectType suffixed with /DocumentFolder and ID specified in parameter folderId.

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

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the document folder	✔️	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.)
depth	int?	Limit the tree depth, whole subtree if omitted		d > 0 (The value, if present, must be greater than 0.)

Result

This endpoint returns the following data: array of DocumentReference

GET /API/V3/PF/DocFolder/:objectType/:objectId/:folderId/DocLinks

Returns all document links of a given object's folder

HTTP syntax

GET /API/V3/PF/DocFolder/:objectType/:objectId/:folderId/DocLinks?depth=...
<- application/json

JavaScript syntax

Pqf.pf.getAllDocumentLinksOfFolder(objectType, objectId, folderId, depth) // returns DocumentReference[]

// Overloads for optional parameters
Pqf.pf.getAllDocumentLinksOfFolder(objectType, objectId, folderId) // returns DocumentReference[]

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission READ on object of type specified in parameter objectType suffixed with /DocumentFolder and ID specified in parameter folderId.

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

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the document folder	✔️	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.)
depth	int?	Limit the tree depth, whole subtree if omitted		d > 0 (The value, if present, must be greater than 0.)

Result

This endpoint returns the following data: array of DocumentReference

POST /API/V3/PF/DocFolder/:objectType/:objectId/:folderId/MoveTo

Moves a document folder of a given object into another document folder of the same object

HTTP syntax

POST /API/V3/PF/DocFolder/:objectType/:objectId/:folderId/MoveTo?destFolderId=...

JavaScript syntax

Pqf.pf.moveDocumentFolder(objectType, objectId, folderId, destFolderId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission UPDATE on object of type specified in parameter objectType suffixed with /DocumentFolder and ID specified in parameter folderId.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentFolder.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the document folder	✔️	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.)
destFolderId	UUID	The ID of the document folder to move into (required)	✔️	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.)

POST /API/V3/PF/DocFolder/:objectType/:objectId/:folderId/MoveToTop

Moves a document folder of a given object to the top, i.e. directly below the object itself

HTTP syntax

POST /API/V3/PF/DocFolder/:objectType/:objectId/:folderId/MoveToTop

JavaScript syntax

Pqf.pf.moveDocumentFolderToTop(objectType, objectId, folderId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission UPDATE on object of type specified in parameter objectType suffixed with /DocumentFolder and ID specified in parameter folderId.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentFolder.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the document folder	✔️	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/PF/DocFolderParent/:folderId

Returns the object a document folder hangs below, together with the folder holding it

HTTP syntax

GET /API/V3/PF/DocFolderParent/:folderId
<- application/json : DocumentReference

JavaScript syntax

Pqf.pf.getDocumentFolderParent(folderId) // returns DocumentReference

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

An object is only returned if the user has permission IDENTIFY on it.

Parameters

Name	Type	Description	Required	Assertion
folderId	UUID	The ID of the document folder	✔️	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: DocumentReference

GET /API/V3/PF/DocFolderParents/:folderIds

Returns the objects some document folders hang below, together with the folders holding them

HTTP syntax

GET /API/V3/PF/DocFolderParents/:folderIds
<- application/json

JavaScript syntax

Pqf.pf.getDocumentFoldersParents(folderIds) // returns DocumentReference[]

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

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

Parameters

Name	Type	Description	Required	Assertion
folderIds	array of UUID	The IDs of the document folders	✔️	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 DocumentReference

GET /API/V3/PF/DocFolders/:objectType/:objectId

Returns all document folders of a given object

HTTP syntax

GET /API/V3/PF/DocFolders/:objectType/:objectId?depth=...
<- application/json

JavaScript syntax

Pqf.pf.getAllDocumentFolders(objectType, objectId, depth) // returns DocumentReference[]

// Overloads for optional parameters
Pqf.pf.getAllDocumentFolders(objectType, objectId) // returns DocumentReference[]

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission READ on object of type specified in parameter objectType and ID specified in parameter objectId.

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

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
depth	int?	Limit the tree depth, whole subtree if omitted		d > 0 (The value, if present, must be greater than 0.)

Result

This endpoint returns the following data: array of DocumentReference

POST /API/V3/PF/DocFolders/:objectType/:objectId/:folderId/Add

Adds a document folder of a given object's document folder

HTTP syntax

POST /API/V3/PF/DocFolders/:objectType/:objectId/:folderId/Add?name=...&code=...&description=...&color=...&iconRef=...
<- application/json : Reference

JavaScript syntax

Pqf.pf.addDocumentFolderSubFolder(objectType, objectId, folderId, name, code, description, color, iconRef) // returns Reference

// Overloads for optional parameters
Pqf.pf.addDocumentFolderSubFolder(objectType, objectId, folderId, name, code, description, color) // returns Reference
Pqf.pf.addDocumentFolderSubFolder(objectType, objectId, folderId, name, code, description) // returns Reference
Pqf.pf.addDocumentFolderSubFolder(objectType, objectId, folderId, name, code) // returns Reference
Pqf.pf.addDocumentFolderSubFolder(objectType, objectId, folderId, name) // returns Reference
Pqf.pf.addDocumentFolderSubFolder(objectType, objectId, folderId) // returns Reference

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentFolder.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the folder	✔️	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 document folder, 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 document folder, may contain HTML
color	color	The color of the new document folder
iconRef	URI	The icon of the new document folder, 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: Reference

GET /API/V3/PF/DocFolders/:objectType/:objectId/:folderIds

Returns some document folders of a given object specified by their IDs

HTTP syntax

GET /API/V3/PF/DocFolders/:objectType/:objectId/:folderIds
<- application/json

JavaScript syntax

Pqf.pf.getDocumentFolders(objectType, objectId, folderIds) // returns DocumentFolder[]

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission READ on object of type specified in parameter objectType suffixed with /DocumentFolder and ID in specified in parameter folderIds.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderIds	array of UUID	The IDs of the document folders	✔️	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 DocumentFolder

POST /API/V3/PF/DocFolders/:objectType/:objectId/Add

Adds a document folder to a given object

HTTP syntax

POST /API/V3/PF/DocFolders/:objectType/:objectId/Add?name=...&code=...&description=...&color=...&iconRef=...
<- application/json : Reference

JavaScript syntax

Pqf.pf.addDocumentFolder(objectType, objectId, name, code, description, color, iconRef) // returns Reference

// Overloads for optional parameters
Pqf.pf.addDocumentFolder(objectType, objectId, name, code, description, color) // returns Reference
Pqf.pf.addDocumentFolder(objectType, objectId, name, code, description) // returns Reference
Pqf.pf.addDocumentFolder(objectType, objectId, name, code) // returns Reference
Pqf.pf.addDocumentFolder(objectType, objectId, name) // returns Reference
Pqf.pf.addDocumentFolder(objectType, objectId) // returns Reference

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentFolder.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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 document folder, 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 document folder, may contain HTML
color	color	The color of the new document folder
iconRef	URI	The icon of the new document folder, 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: Reference

GET /API/V3/PF/DocLink/:objectType/:objectId/:linkId

Returns a document link of a given object

HTTP syntax

GET /API/V3/PF/DocLink/:objectType/:objectId/:linkId
<- application/json : DocumentLink

JavaScript syntax

Pqf.pf.getDocumentLink(objectType, objectId, linkId) // returns DocumentLink

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission READ on object of type specified in parameter objectType suffixed with /DocumentLink and ID specified in parameter linkId.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
linkId	UUID	The ID of the document 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 must be an ID: a UUID written as 32 upper-case hexadecimal 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: DocumentLink

PUT /API/V3/PF/DocLink/:objectType/:objectId/:linkId

Updates an existing document link of a given object

HTTP syntax

PUT /API/V3/PF/DocLink/:objectType/:objectId/:linkId
-> application/json : DocumentLink

JavaScript syntax

Pqf.pf.putDocumentLink(objectType, objectId, linkId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission UPDATE on object of type specified in parameter objectType suffixed with /DocumentLink and ID specified in parameter linkId.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
linkId	UUID	The ID of the document 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 must be an ID: a UUID written as 32 upper-case hexadecimal 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	DocumentLink	JSON object of type DocumentLink	✔️

DELETE /API/V3/PF/DocLink/:objectType/:objectId/:linkId

Deletes a document link of a given object

HTTP syntax

DELETE /API/V3/PF/DocLink/:objectType/:objectId/:linkId

JavaScript syntax

Pqf.pf.delDocumentLink(objectType, objectId, linkId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission DELETE on object of type specified in parameter objectType suffixed with /DocumentLink and ID specified in parameter linkId.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
linkId	UUID	The ID of the document 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 must be an ID: a UUID written as 32 upper-case hexadecimal 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/PF/DocLink/:objectType/:objectId/:linkId/MoveTo

Moves a document link of a given object into a document folder of the same object

HTTP syntax

POST /API/V3/PF/DocLink/:objectType/:objectId/:linkId/MoveTo?destFolderId=...

JavaScript syntax

Pqf.pf.moveDocumentLink(objectType, objectId, linkId, destFolderId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission UPDATE on object of type specified in parameter objectType suffixed with /DocumentLink and ID specified in parameter linkId.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
linkId	UUID	The ID of the document 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 must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
destFolderId	UUID	The ID of the document folder to move into (required)	✔️	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.)

POST /API/V3/PF/DocLink/:objectType/:objectId/:linkId/MoveToTop

Moves a document link of a given object to the top, i.e. directly below the object itself

HTTP syntax

POST /API/V3/PF/DocLink/:objectType/:objectId/:linkId/MoveToTop

JavaScript syntax

Pqf.pf.moveDocumentLinkToTop(objectType, objectId, linkId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission UPDATE on object of type specified in parameter objectType suffixed with /DocumentLink and ID specified in parameter linkId.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
linkId	UUID	The ID of the document 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 must be an ID: a UUID written as 32 upper-case hexadecimal 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/PF/DocLinkParent/:linkId

Returns the object a document link hangs below, together with the folder holding it

HTTP syntax

GET /API/V3/PF/DocLinkParent/:linkId
<- application/json : DocumentReference

JavaScript syntax

Pqf.pf.getDocumentLinkParent(linkId) // returns DocumentReference

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

An object is only returned if the user has permission IDENTIFY on it.

Parameters

Name	Type	Description	Required	Assertion
linkId	UUID	The ID of the document 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 must be an ID: a UUID written as 32 upper-case hexadecimal 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: DocumentReference

GET /API/V3/PF/DocLinkParents/:linkIds

Returns the objects some document links hang below, together with the folders holding them

HTTP syntax

GET /API/V3/PF/DocLinkParents/:linkIds
<- application/json

JavaScript syntax

Pqf.pf.getDocumentLinksParents(linkIds) // returns DocumentReference[]

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

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

Parameters

Name	Type	Description	Required	Assertion
linkIds	array of UUID	The IDs of the document links	✔️	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 DocumentReference

GET /API/V3/PF/DocLinks/:objectType/:objectId

Returns all document links of a given object

HTTP syntax

GET /API/V3/PF/DocLinks/:objectType/:objectId?depth=...
<- application/json

JavaScript syntax

Pqf.pf.getAllDocumentLinks(objectType, objectId, depth) // returns DocumentReference[]

// Overloads for optional parameters
Pqf.pf.getAllDocumentLinks(objectType, objectId) // returns DocumentReference[]

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission READ on object of type specified in parameter objectType and ID specified in parameter objectId.

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

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
depth	int?	Limit the tree depth, whole subtree if omitted		d > 0 (The value, if present, must be greater than 0.)

Result

This endpoint returns the following data: array of DocumentReference

POST /API/V3/PF/DocLinks/:objectType/:objectId/:folderId/Add

Adds a document link to a given object's document folder

HTTP syntax

POST /API/V3/PF/DocLinks/:objectType/:objectId/:folderId/Add?url=...&name=...&code=...&description=...&color=...&iconRef=...&sortIndex=...
<- application/json : Reference

JavaScript syntax

Pqf.pf.addDocumentFolderDocumentLink(objectType, objectId, folderId, url, name, code, description, color, iconRef, sortIndex) // returns Reference

// Overloads for optional parameters
Pqf.pf.addDocumentFolderDocumentLink(objectType, objectId, folderId, url, name, code, description, color, iconRef) // returns Reference
Pqf.pf.addDocumentFolderDocumentLink(objectType, objectId, folderId, url, name, code, description, color) // returns Reference
Pqf.pf.addDocumentFolderDocumentLink(objectType, objectId, folderId, url, name, code, description) // returns Reference
Pqf.pf.addDocumentFolderDocumentLink(objectType, objectId, folderId, url, name, code) // returns Reference
Pqf.pf.addDocumentFolderDocumentLink(objectType, objectId, folderId, url, name) // returns Reference
Pqf.pf.addDocumentFolderDocumentLink(objectType, objectId, folderId, url) // returns Reference

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the folder	✔️	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.)
url	URI	The URL of the document the new document link points to, which may be on any external system	✔️
name	string	The name of the new document link, 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 document link, may contain HTML
color	color	The color of the new document link
iconRef	URI	The icon of the new document 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.)
sortIndex	double	A sort index that may be used by the client to fix a specific order			0

Result

This endpoint returns the following data: Reference

POST /API/V3/PF/DocLinks/:objectType/:objectId/:folderId/Attach

Stores an attachment in PQFORCE and links it to a given object's document folder

HTTP syntax

POST /API/V3/PF/DocLinks/:objectType/:objectId/:folderId/Attach?name=...&code=...&description=...&color=...&iconRef=...&sortIndex=...
-> application/octet-stream
<- application/json : Reference

Required license

This endpoint requires the following licenses:

• documentupload
• documentlink

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the folder	✔️	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 document link, which is also used as the attachment's filename, 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 document link, may contain HTML
color	color	The color of the new document link
iconRef	URI	The icon of the new document 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.)
sortIndex	double	A sort index that may be used by the client to fix a specific order			0
requestBinary	Binary	Raw content of mime type application/octet-stream	✔️

Result

This endpoint returns the following data: Reference

POST /API/V3/PF/DocLinks/:objectType/:objectId/:folderId/Attach/Binary/:mimeType

Stores a binary attachment in PQFORCE and links it to a given object's document folder

JavaScript syntax

Pqf.pf.addDocumentFolderAttachmentBinaryAndLink(objectType, objectId, folderId, mimeType, name, code, description, color, iconRef, sortIndex, requestRaw) // returns Reference

// Overloads for optional parameters
Pqf.pf.addDocumentFolderAttachmentBinaryAndLink(objectType, objectId, folderId, mimeType, name, code, description, color, iconRef, requestRaw) // returns Reference
Pqf.pf.addDocumentFolderAttachmentBinaryAndLink(objectType, objectId, folderId, mimeType, name, code, description, color, requestRaw) // returns Reference
Pqf.pf.addDocumentFolderAttachmentBinaryAndLink(objectType, objectId, folderId, mimeType, name, code, description, requestRaw) // returns Reference
Pqf.pf.addDocumentFolderAttachmentBinaryAndLink(objectType, objectId, folderId, mimeType, name, code, requestRaw) // returns Reference
Pqf.pf.addDocumentFolderAttachmentBinaryAndLink(objectType, objectId, folderId, mimeType, name, requestRaw) // returns Reference
Pqf.pf.addDocumentFolderAttachmentBinaryAndLink(objectType, objectId, folderId, mimeType, requestRaw) // returns Reference

Required license

This endpoint requires the following licenses:

• documentupload
• documentlink

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the folder	✔️	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.)
mimeType	string	MIME type (now properly called "media type", but also sometimes "content type")	✔️	matches '[0-9A-Za-z][0-9A-Za-z!#$&\-^_]{0,63}/[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]{0,63}(?:;[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*=[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*)*' (The value must be a media (MIME) type such as "application/json", optionally with parameters.)
name	string	The name of the new document link, which is also used as the attachment's filename, 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 document link, may contain HTML
color	color	The color of the new document link
iconRef	URI	The icon of the new document 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.)
sortIndex	double	A sort index that may be used by the client to fix a specific order			0
requestRaw	binary	Raw content of mime type application/octet-stream	✔️

Result

This endpoint returns the following data: Reference

POST /API/V3/PF/DocLinks/:objectType/:objectId/:folderId/Attach/Json/:mimeType

Stores a JSON attachment in PQFORCE and links it to a given object's document folder

JavaScript syntax

Pqf.pf.addDocumentFolderAttachmentJsonAndLink(objectType, objectId, folderId, mimeType, name, code, description, color, iconRef, sortIndex, requestJson) // returns Reference

// Overloads for optional parameters
Pqf.pf.addDocumentFolderAttachmentJsonAndLink(objectType, objectId, folderId, mimeType, name, code, description, color, iconRef, requestJson) // returns Reference
Pqf.pf.addDocumentFolderAttachmentJsonAndLink(objectType, objectId, folderId, mimeType, name, code, description, color, requestJson) // returns Reference
Pqf.pf.addDocumentFolderAttachmentJsonAndLink(objectType, objectId, folderId, mimeType, name, code, description, requestJson) // returns Reference
Pqf.pf.addDocumentFolderAttachmentJsonAndLink(objectType, objectId, folderId, mimeType, name, code, requestJson) // returns Reference
Pqf.pf.addDocumentFolderAttachmentJsonAndLink(objectType, objectId, folderId, mimeType, name, requestJson) // returns Reference
Pqf.pf.addDocumentFolderAttachmentJsonAndLink(objectType, objectId, folderId, mimeType, requestJson) // returns Reference

Required license

This endpoint requires the following licenses:

• documentupload
• documentlink

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the folder	✔️	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.)
mimeType	string	MIME type (now properly called "media type", but also sometimes "content type")	✔️	matches '[0-9A-Za-z][0-9A-Za-z!#$&\-^_]{0,63}/[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]{0,63}(?:;[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*=[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*)*' (The value must be a media (MIME) type such as "application/json", optionally with parameters.)
name	string	The name of the new document link, which is also used as the attachment's filename, 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 document link, may contain HTML
color	color	The color of the new document link
iconRef	URI	The icon of the new document 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.)
sortIndex	double	A sort index that may be used by the client to fix a specific order			0
requestJson	JSON	Raw content of mime type application/json	✔️

Result

This endpoint returns the following data: Reference

POST /API/V3/PF/DocLinks/:objectType/:objectId/:folderId/Attach/Text/:mimeType

Stores a text attachment in PQFORCE and links it to a given object's document folder

JavaScript syntax

Pqf.pf.addDocumentFolderAttachmentTextAndLink(objectType, objectId, folderId, mimeType, name, code, description, color, iconRef, sortIndex, encoding, requestText) // returns Reference

// Overloads for optional parameters
Pqf.pf.addDocumentFolderAttachmentTextAndLink(objectType, objectId, folderId, mimeType, name, code, description, color, iconRef, sortIndex, requestText) // returns Reference
Pqf.pf.addDocumentFolderAttachmentTextAndLink(objectType, objectId, folderId, mimeType, name, code, description, color, iconRef, requestText) // returns Reference
Pqf.pf.addDocumentFolderAttachmentTextAndLink(objectType, objectId, folderId, mimeType, name, code, description, color, requestText) // returns Reference
Pqf.pf.addDocumentFolderAttachmentTextAndLink(objectType, objectId, folderId, mimeType, name, code, description, requestText) // returns Reference
Pqf.pf.addDocumentFolderAttachmentTextAndLink(objectType, objectId, folderId, mimeType, name, code, requestText) // returns Reference
Pqf.pf.addDocumentFolderAttachmentTextAndLink(objectType, objectId, folderId, mimeType, name, requestText) // returns Reference
Pqf.pf.addDocumentFolderAttachmentTextAndLink(objectType, objectId, folderId, mimeType, requestText) // returns Reference

Required license

This endpoint requires the following licenses:

• documentupload
• documentlink

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
folderId	UUID	The ID of the folder	✔️	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.)
mimeType	string	MIME type (now properly called "media type", but also sometimes "content type")	✔️	matches '[0-9A-Za-z][0-9A-Za-z!#$&\-^_]{0,63}/[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]{0,63}(?:;[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*=[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*)*' (The value must be a media (MIME) type such as "application/json", optionally with parameters.)
name	string	The name of the new document link, which is also used as the attachment's filename, 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 document link, may contain HTML
color	color	The color of the new document link
iconRef	URI	The icon of the new document 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.)
sortIndex	double	A sort index that may be used by the client to fix a specific order			0
encoding	string	The text encoding to use
requestText	string	Raw content of mime type text/plain	✔️

Result

This endpoint returns the following data: Reference

GET /API/V3/PF/DocLinks/:objectType/:objectId/:linkIds

Returns some document links of a given object specified by their IDs

HTTP syntax

GET /API/V3/PF/DocLinks/:objectType/:objectId/:linkIds
<- application/json

JavaScript syntax

Pqf.pf.getDocumentLinks(objectType, objectId, linkIds) // returns DocumentLink[]

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission READ on object of type specified in parameter objectType suffixed with /DocumentLink and ID in specified in parameter linkIds.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
linkIds	array of UUID	The IDs of the document links	✔️	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 DocumentLink

POST /API/V3/PF/DocLinks/:objectType/:objectId/Add

Adds a document link to a given object

HTTP syntax

POST /API/V3/PF/DocLinks/:objectType/:objectId/Add?url=...&name=...&code=...&description=...&color=...&iconRef=...&sortIndex=...
<- application/json : Reference

JavaScript syntax

Pqf.pf.addDocumentLink(objectType, objectId, url, name, code, description, color, iconRef, sortIndex) // returns Reference

// Overloads for optional parameters
Pqf.pf.addDocumentLink(objectType, objectId, url, name, code, description, color, iconRef) // returns Reference
Pqf.pf.addDocumentLink(objectType, objectId, url, name, code, description, color) // returns Reference
Pqf.pf.addDocumentLink(objectType, objectId, url, name, code, description) // returns Reference
Pqf.pf.addDocumentLink(objectType, objectId, url, name, code) // returns Reference
Pqf.pf.addDocumentLink(objectType, objectId, url, name) // returns Reference
Pqf.pf.addDocumentLink(objectType, objectId, url) // returns Reference

Required license

This endpoint requires the following licenses:

• documentlink

Required permission

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
url	URI	The URL of the document the new document link points to, which may be on any external system	✔️
name	string	The name of the new document link, 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 document link, may contain HTML
color	color	The color of the new document link
iconRef	URI	The icon of the new document 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.)
sortIndex	double	A sort index that may be used by the client to fix a specific order			0

Result

This endpoint returns the following data: Reference

POST /API/V3/PF/DocLinks/:objectType/:objectId/Attach

Stores an attachment in PQFORCE and links it to a given object

HTTP syntax

POST /API/V3/PF/DocLinks/:objectType/:objectId/Attach?name=...&code=...&description=...&color=...&iconRef=...&sortIndex=...
-> application/octet-stream
<- application/json : Reference

Required license

This endpoint requires the following licenses:

• documentupload
• documentlink

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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 document link, which is also used as the attachment's filename, 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 document link, may contain HTML
color	color	The color of the new document link
iconRef	URI	The icon of the new document 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.)
sortIndex	double	A sort index that may be used by the client to fix a specific order			0
requestBinary	Binary	Raw content of mime type application/octet-stream	✔️

Result

This endpoint returns the following data: Reference

POST /API/V3/PF/DocLinks/:objectType/:objectId/Attach/Binary/:mimeType

Stores a binary attachment in PQFORCE and links it to a given object

JavaScript syntax

Pqf.pf.addAttachmentBinaryAndLink(objectType, objectId, mimeType, name, code, description, color, iconRef, sortIndex, requestRaw) // returns Reference

// Overloads for optional parameters
Pqf.pf.addAttachmentBinaryAndLink(objectType, objectId, mimeType, name, code, description, color, iconRef, requestRaw) // returns Reference
Pqf.pf.addAttachmentBinaryAndLink(objectType, objectId, mimeType, name, code, description, color, requestRaw) // returns Reference
Pqf.pf.addAttachmentBinaryAndLink(objectType, objectId, mimeType, name, code, description, requestRaw) // returns Reference
Pqf.pf.addAttachmentBinaryAndLink(objectType, objectId, mimeType, name, code, requestRaw) // returns Reference
Pqf.pf.addAttachmentBinaryAndLink(objectType, objectId, mimeType, name, requestRaw) // returns Reference
Pqf.pf.addAttachmentBinaryAndLink(objectType, objectId, mimeType, requestRaw) // returns Reference

Required license

This endpoint requires the following licenses:

• documentupload
• documentlink

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
mimeType	string	MIME type (now properly called "media type", but also sometimes "content type")	✔️	matches '[0-9A-Za-z][0-9A-Za-z!#$&\-^_]{0,63}/[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]{0,63}(?:;[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*=[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*)*' (The value must be a media (MIME) type such as "application/json", optionally with parameters.)
name	string	The name of the new document link, which is also used as the attachment's filename, 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 document link, may contain HTML
color	color	The color of the new document link
iconRef	URI	The icon of the new document 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.)
sortIndex	double	A sort index that may be used by the client to fix a specific order			0
requestRaw	binary	Raw content of mime type application/octet-stream	✔️

Result

This endpoint returns the following data: Reference

POST /API/V3/PF/DocLinks/:objectType/:objectId/Attach/Json/:mimeType

Stores a JSON attachment in PQFORCE and links it to a given object

JavaScript syntax

Pqf.pf.addAttachmentJsonAndLink(objectType, objectId, mimeType, name, code, description, color, iconRef, sortIndex, requestJson) // returns Reference

// Overloads for optional parameters
Pqf.pf.addAttachmentJsonAndLink(objectType, objectId, mimeType, name, code, description, color, iconRef, requestJson) // returns Reference
Pqf.pf.addAttachmentJsonAndLink(objectType, objectId, mimeType, name, code, description, color, requestJson) // returns Reference
Pqf.pf.addAttachmentJsonAndLink(objectType, objectId, mimeType, name, code, description, requestJson) // returns Reference
Pqf.pf.addAttachmentJsonAndLink(objectType, objectId, mimeType, name, code, requestJson) // returns Reference
Pqf.pf.addAttachmentJsonAndLink(objectType, objectId, mimeType, name, requestJson) // returns Reference
Pqf.pf.addAttachmentJsonAndLink(objectType, objectId, mimeType, requestJson) // returns Reference

Required license

This endpoint requires the following licenses:

• documentupload
• documentlink

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
mimeType	string	MIME type (now properly called "media type", but also sometimes "content type")	✔️	matches '[0-9A-Za-z][0-9A-Za-z!#$&\-^_]{0,63}/[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]{0,63}(?:;[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*=[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*)*' (The value must be a media (MIME) type such as "application/json", optionally with parameters.)
name	string	The name of the new document link, which is also used as the attachment's filename, 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 document link, may contain HTML
color	color	The color of the new document link
iconRef	URI	The icon of the new document 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.)
sortIndex	double	A sort index that may be used by the client to fix a specific order			0
requestJson	JSON	Raw content of mime type application/json	✔️

Result

This endpoint returns the following data: Reference

POST /API/V3/PF/DocLinks/:objectType/:objectId/Attach/Text/:mimeType

Stores a text attachment in PQFORCE and links it to a given object

JavaScript syntax

Pqf.pf.addAttachmentTextAndLink(objectType, objectId, mimeType, name, code, description, color, iconRef, sortIndex, encoding, requestText) // returns Reference

// Overloads for optional parameters
Pqf.pf.addAttachmentTextAndLink(objectType, objectId, mimeType, name, code, description, color, iconRef, sortIndex, requestText) // returns Reference
Pqf.pf.addAttachmentTextAndLink(objectType, objectId, mimeType, name, code, description, color, iconRef, requestText) // returns Reference
Pqf.pf.addAttachmentTextAndLink(objectType, objectId, mimeType, name, code, description, color, requestText) // returns Reference
Pqf.pf.addAttachmentTextAndLink(objectType, objectId, mimeType, name, code, description, requestText) // returns Reference
Pqf.pf.addAttachmentTextAndLink(objectType, objectId, mimeType, name, code, requestText) // returns Reference
Pqf.pf.addAttachmentTextAndLink(objectType, objectId, mimeType, name, requestText) // returns Reference
Pqf.pf.addAttachmentTextAndLink(objectType, objectId, mimeType, requestText) // returns Reference

Required license

This endpoint requires the following licenses:

• documentupload
• documentlink

Required permission

Requires permission E0E3762860A34D0F9C5C7F419C269379.

Requires permission CREATE on object of type specified in parameter objectType suffixed with /DocumentLink.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of the object that is linked	✔️	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.)
objectId	UUID	The ID of the object that is linked	✔️	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.)
mimeType	string	MIME type (now properly called "media type", but also sometimes "content type")	✔️	matches '[0-9A-Za-z][0-9A-Za-z!#$&\-^_]{0,63}/[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]{0,63}(?:;[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*=[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*)*' (The value must be a media (MIME) type such as "application/json", optionally with parameters.)
name	string	The name of the new document link, which is also used as the attachment's filename, 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 document link, may contain HTML
color	color	The color of the new document link
iconRef	URI	The icon of the new document 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.)
sortIndex	double	A sort index that may be used by the client to fix a specific order			0
encoding	string	The text encoding to use
requestText	string	Raw content of mime type text/plain	✔️

Result

This endpoint returns the following data: Reference

GET /API/V3/PF/Enum/:typeId/Value/:valueId

Returns a value of an enum in the user's language

HTTP syntax

GET /API/V3/PF/Enum/:typeId/Value/:valueId?deleted=...
<- application/json : IdentificationExtended

JavaScript syntax

Pqf.pf.getEnumValue(typeId, valueId, deleted) // returns IdentificationExtended

// Overloads for optional parameters
Pqf.pf.getEnumValue(typeId, valueId) // returns IdentificationExtended

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
typeId	UUID	The enum 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.)
valueId	UUID	The enum value 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 a deleted value to be returned			false

Result

This endpoint returns the following data: IdentificationExtended

GET /API/V3/PF/Enum/:typeId/Value/:valueId/WithTranslations

Returns a value of an enum with translations

HTTP syntax

GET /API/V3/PF/Enum/:typeId/Value/:valueId/WithTranslations
<- application/json : IdentificationTranslated

JavaScript syntax

Pqf.pf.getEnumValueTranslated(typeId, valueId) // returns IdentificationTranslated

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
typeId	UUID	The enum 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.)
valueId	UUID	The enum value 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: IdentificationTranslated

PUT /API/V3/PF/Enum/:typeId/Value/:valueId/WithTranslations

Updates or creates a value of an enum with translations

HTTP syntax

PUT /API/V3/PF/Enum/:typeId/Value/:valueId/WithTranslations
-> application/json : IdentificationTranslated

JavaScript syntax

Pqf.pf.putEnumValueTranslated(typeId, valueId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
typeId	UUID	The enum 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.)
valueId	UUID	The enum value 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	IdentificationTranslated	JSON object of type IdentificationTranslated	✔️

DELETE /API/V3/PF/Enum/:typeId/Value/:valueId/WithTranslations

Deletes a specific enum value

HTTP syntax

DELETE /API/V3/PF/Enum/:typeId/Value/:valueId/WithTranslations

JavaScript syntax

Pqf.pf.delEnumValueTranslated(typeId, valueId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
typeId	UUID	The enum 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.)
valueId	UUID	The enum value 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/PF/Enum/:typeId/Values

Returns references to all values of an enum

HTTP syntax

GET /API/V3/PF/Enum/:typeId/Values?sort=...
<- application/json

JavaScript syntax

Pqf.pf.getAllEnumValues(typeId, sort) // returns Reference[]

// Overloads for optional parameters
Pqf.pf.getAllEnumValues(typeId) // returns Reference[]

Parameters

Name	Type	Description	Required	Assertion
typeId	UUID	The enum 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		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 Reference

GET /API/V3/PF/Enum/:typeId/Values/:valueIds

Returns some values of an enum in the user's language, specified by their IDs

HTTP syntax

GET /API/V3/PF/Enum/:typeId/Values/:valueIds?deleted=...
<- application/json

JavaScript syntax

Pqf.pf.getEnumValues(typeId, valueIds, deleted) // returns IdentificationExtended[]

// Overloads for optional parameters
Pqf.pf.getEnumValues(typeId, valueIds) // returns IdentificationExtended[]

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
typeId	UUID	The enum 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.)
valueIds	array of UUID	The enum value 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 values to be returned			false

Result

This endpoint returns the following data: array of IdentificationExtended

GET /API/V3/PF/Enum/:typeId/Values/:valueIds/WithTranslations

Returns values of an enum with translations

HTTP syntax

GET /API/V3/PF/Enum/:typeId/Values/:valueIds/WithTranslations
<- application/json

JavaScript syntax

Pqf.pf.getEnumValuesTranslated(typeId, valueIds) // returns IdentificationTranslated[]

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
typeId	UUID	The enum 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.)
valueIds	array of UUID	The enum value 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 IdentificationTranslated

GET /API/V3/PF/EnumType/:typeId

Returns the type of enum in the user's language

HTTP syntax

GET /API/V3/PF/EnumType/:typeId
<- application/json : EnumType

JavaScript syntax

Pqf.pf.getEnumType(typeId) // returns EnumType

Parameters

Name	Type	Description	Required	Assertion
typeId	UUID	The enum 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: EnumType

GET /API/V3/PF/EnumType/:typeId/WithTranslations

Returns the type of enum with translations (only DB type enum)

HTTP syntax

GET /API/V3/PF/EnumType/:typeId/WithTranslations
<- application/json : IdentificationTranslated

JavaScript syntax

Pqf.pf.getEnumTypeTranslated(typeId) // returns IdentificationTranslated

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
typeId	UUID	The enum 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: IdentificationTranslated

PUT /API/V3/PF/EnumType/:typeId/WithTranslations

Updates or creates the type of enum with translations (only DB type enum)

HTTP syntax

PUT /API/V3/PF/EnumType/:typeId/WithTranslations
-> application/json : IdentificationTranslated

JavaScript syntax

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

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
typeId	UUID	The enum 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.)
requestJson	IdentificationTranslated	JSON object of type IdentificationTranslated	✔️

DELETE /API/V3/PF/EnumType/:typeId/WithTranslations

Deletes the type of enum with translations (only DB type enum)

HTTP syntax

DELETE /API/V3/PF/EnumType/:typeId/WithTranslations

JavaScript syntax

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

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
typeId	UUID	The enum 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.)

GET /API/V3/PF/EnumTypes

Returns all enum types

HTTP syntax

GET /API/V3/PF/EnumTypes?sort=...
<- application/json

JavaScript syntax

Pqf.pf.getAllEnumTypes(sort) // returns Reference[]

// Overloads for optional parameters
Pqf.pf.getAllEnumTypes() // returns 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		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 Reference

GET /API/V3/PF/EnumTypes/:typeIds

Returns some enum types specified by their IDs

HTTP syntax

GET /API/V3/PF/EnumTypes/:typeIds
<- application/json

JavaScript syntax

Pqf.pf.getEnumTypes(typeIds) // returns EnumType[]

Parameters

Name	Type	Description	Required	Assertion
typeIds	array of UUID	The enum 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 EnumType

GET /API/V3/PF/EnumTypes/:typeIds/WithTranslations

Returns some enum types with translations (only DB type enum)

HTTP syntax

GET /API/V3/PF/EnumTypes/:typeIds/WithTranslations
<- application/json

JavaScript syntax

Pqf.pf.getEnumTypesTranslated(typeIds) // returns IdentificationTranslated[]

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
typeIds	array of UUID	The enum 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 IdentificationTranslated

GET /API/V3/PF/ExplicitRelation/:relationType/:relationId

Returns an explicit relation between two objects; requires permission IDENTIFY on both the relation's source object and its target object

HTTP syntax

GET /API/V3/PF/ExplicitRelation/:relationType/:relationId
<- application/json : Relation

JavaScript syntax

Pqf.pf.getExplicitRelation(relationType, relationId) // returns Relation

Parameters

Name	Type	Description	Required	Assertion
relationType	UUID	The relation 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.)
relationId	UUID	The relation 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: Relation

POST /API/V3/PF/ExplicitRelations/:relationType/Add

Adds an explicit relation between two objects

HTTP syntax

POST /API/V3/PF/ExplicitRelations/:relationType/Add?sourceType=...&sourceId=...&targetType=...&targetId=...
<- application/json : Reference

JavaScript syntax

Pqf.pf.addExplicitRelation(relationType, sourceType, sourceId, targetType, targetId) // returns Reference

Required permission

Requires permission LINK on object of type specified in parameter sourceType and ID specified in parameter sourceId.

Requires permission IDENTIFY on object of type specified in parameter targetType and ID specified in parameter targetId.

Parameters

Name	Type	Description	Required	Assertion
relationType	UUID	The relation 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.)
sourceType	UUID	the source object's type	✔️	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.)
sourceId	UUID	the source object'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.)
targetType	UUID	the target object's type	✔️	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.)
targetId	UUID	the target object'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: Reference

POST /API/V3/PF/ExplicitRelations/:relationType/Remove

Removes an explicit relation between two objects

HTTP syntax

POST /API/V3/PF/ExplicitRelations/:relationType/Remove?sourceType=...&sourceId=...&targetType=...&targetId=...

JavaScript syntax

Pqf.pf.removeExplicitRelation(relationType, sourceType, sourceId, targetType, targetId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission LINK on object of type specified in parameter sourceType and ID specified in parameter sourceId.

Requires permission IDENTIFY on object of type specified in parameter targetType and ID specified in parameter targetId.

Parameters

Name	Type	Description	Required	Assertion
relationType	UUID	The relation 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.)
sourceType	UUID	the source object's type	✔️	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.)
sourceId	UUID	the source object'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.)
targetType	UUID	the target object's type	✔️	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.)
targetId	UUID	the target object'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/PF/ExplicitRelationType/:relationType/WithTranslations

Returns an explicit relation type with translations

HTTP syntax

GET /API/V3/PF/ExplicitRelationType/:relationType/WithTranslations
<- application/json : ExplicitRelationTypeTranslated

JavaScript syntax

Pqf.pf.getExplicitRelationTypeTranslated(relationType) // returns ExplicitRelationTypeTranslated

Required license

This endpoint requires the following licenses:

• config-relations

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
relationType	UUID	The relation 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: ExplicitRelationTypeTranslated

PUT /API/V3/PF/ExplicitRelationType/:relationType/WithTranslations

Creates or updates an explicit relation type with translations

HTTP syntax

PUT /API/V3/PF/ExplicitRelationType/:relationType/WithTranslations
-> application/json : ExplicitRelationTypeTranslated

JavaScript syntax

Pqf.pf.putExplicitRelationTypeTranslated(relationType, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• config-relations

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
relationType	UUID	The relation 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.)
requestJson	ExplicitRelationTypeTranslated	JSON object of type ExplicitRelationTypeTranslated	✔️

DELETE /API/V3/PF/ExplicitRelationType/:relationType/WithTranslations

Deletes an explicit relation type with translations

HTTP syntax

DELETE /API/V3/PF/ExplicitRelationType/:relationType/WithTranslations

JavaScript syntax

Pqf.pf.delExplicitRelationTypeTranslated(relationType) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• config-relations

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
relationType	UUID	The relation 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.)

GET /API/V3/PF/ExplicitRelationTypes/:relationTypes/WithTranslations

Returns some explicit relation types with translations

HTTP syntax

GET /API/V3/PF/ExplicitRelationTypes/:relationTypes/WithTranslations
<- application/json

JavaScript syntax

Pqf.pf.getExplicitRelationTypesTranslated(relationTypes) // returns ExplicitRelationTypeTranslated[]

Required license

This endpoint requires the following licenses:

• config-relations

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
relationTypes	array of UUID	the relation 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 ExplicitRelationTypeTranslated

GET /API/V3/PF/Icon/:iconId

Retrieves an icon (PNG | JPEG | GIF) stored in PQFORCE (inline)

HTTP syntax

GET /API/V3/PF/Icon/:iconId
<- application/octet-stream

Hint: This endpoint is static. This means that every call to the same URL will return exactly the same result. Therefore the reposne may be cached. When sending an ETag in the HTTP headers (If-None-Match header), the result 304indicates that the content in cache is still valid.

Parameters

Name	Type	Description	Required	Assertion
iconId	string	The ID of the icon	✔️	matches '[0-9A-Z]{52}\|[0-9a-zA-Z]{43}' (The value must be a hashed ID (52 upper-case letters and digits, or 43 letters and digits).)

Result

This endpoint returns the following data: Binary

GET /API/V3/PF/Limits/MaxParallelRequests

Returns the maximum number of parallel requests per user or token for the current type of interaction

HTTP syntax

GET /API/V3/PF/Limits/MaxParallelRequests
<- application/json : ParallelRequestsLimit

Result

This endpoint returns the following data: ParallelRequestsLimit

GET /API/V3/PF/PropertyDefinition/:definitionId

Returns the definition of a dynamic property: the object type it belongs to and the semantics of its value

HTTP syntax

GET /API/V3/PF/PropertyDefinition/:definitionId
<- application/json : PropertyDefinition

JavaScript syntax

Pqf.pf.getPropertyDefinition(definitionId) // returns PropertyDefinition

Parameters

Name	Type	Description	Required	Assertion
definitionId	UUID	The property definition 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: PropertyDefinition

PUT /API/V3/PF/PropertyDefinition/:definitionId

Updates or creates the definition of a dynamic property; only the semantics can be changed, a property cannot move to another object type

HTTP syntax

PUT /API/V3/PF/PropertyDefinition/:definitionId
-> application/json : PropertyDefinition

JavaScript syntax

Pqf.pf.putPropertyDefinition(definitionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• config-properties

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
definitionId	UUID	The property definition 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	PropertyDefinition	JSON object of type PropertyDefinition	✔️

DELETE /API/V3/PF/PropertyDefinition/:definitionId

Deletes the definition of a dynamic property; fails as long as any client still presents it

HTTP syntax

DELETE /API/V3/PF/PropertyDefinition/:definitionId

JavaScript syntax

Pqf.pf.delPropertyDefinition(definitionId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• config-properties

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
definitionId	UUID	The property definition 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/PF/PropertyDefinitions/OfObjectType/:objectType

Returns the definitions of all dynamic properties of an object type, of every client, ordered by property ID

HTTP syntax

GET /API/V3/PF/PropertyDefinitions/OfObjectType/:objectType
<- application/json

JavaScript syntax

Pqf.pf.getAllPropertyDefinitions(objectType) // returns PropertyDefinition[]

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of object the properties belong to	✔️	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.)

Result

This endpoint returns the following data: array of PropertyDefinition

PUT /API/V3/PF/PropertyDefinitions/OfObjectType/:objectType

Replaces the definitions of the dynamic properties of an object type; a definition missing from the list is deleted, which fails as long as any client still presents it

HTTP syntax

PUT /API/V3/PF/PropertyDefinitions/OfObjectType/:objectType
-> application/json

JavaScript syntax

Pqf.pf.putAllPropertyDefinitions(objectType, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• config-properties

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of object the properties belong to	✔️	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.)
requestJson	array of PropertyDefinition	JSON object of type array of PropertyDefinition	✔️

GET /API/V3/PF/PropertyObjectTypes

Returns the object types that can carry dynamic properties, ordered by type

HTTP syntax

GET /API/V3/PF/PropertyObjectTypes
<- application/json

JavaScript syntax

Pqf.pf.getAllPropertyObjectTypes() // returns NamedReference[]

Result

This endpoint returns the following data: array of NamedReference

GET /API/V3/PF/PropertyPresentation/:definitionId/OfClient/:clientId

Returns how a client presents a dynamic property, in the user's language

HTTP syntax

GET /API/V3/PF/PropertyPresentation/:definitionId/OfClient/:clientId
<- application/json : PropertyPresentation

JavaScript syntax

Pqf.pf.getPropertyPresentation(definitionId, clientId) // returns PropertyPresentation

Parameters

Name	Type	Description	Required	Assertion
definitionId	UUID	The property definition 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.)
clientId	ClientId	The client the presentation belongs to	✔️

Result

This endpoint returns the following data: PropertyPresentation

GET /API/V3/PF/PropertyPresentation/:definitionId/OfClient/:clientId/WithTranslations

Returns how a client presents a dynamic property, with translations

HTTP syntax

GET /API/V3/PF/PropertyPresentation/:definitionId/OfClient/:clientId/WithTranslations
<- application/json : PropertyPresentationTranslated

JavaScript syntax

Pqf.pf.getPropertyPresentationTranslated(definitionId, clientId) // returns PropertyPresentationTranslated

Required license

This endpoint requires the following licenses:

• config-properties

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
definitionId	UUID	The property definition 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.)
clientId	ClientId	The client the presentation belongs to	✔️

Result

This endpoint returns the following data: PropertyPresentationTranslated

PUT /API/V3/PF/PropertyPresentation/:definitionId/OfClient/:clientId/WithTranslations

Updates or creates how a client presents a dynamic property, with translations; the property definition must already exist

HTTP syntax

PUT /API/V3/PF/PropertyPresentation/:definitionId/OfClient/:clientId/WithTranslations
-> application/json : PropertyPresentationTranslated

JavaScript syntax

Pqf.pf.putPropertyPresentationTranslated(definitionId, clientId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• config-properties

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
definitionId	UUID	The property definition 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.)
clientId	ClientId	The client the presentation belongs to	✔️
requestJson	PropertyPresentationTranslated	JSON object of type PropertyPresentationTranslated	✔️

DELETE /API/V3/PF/PropertyPresentation/:definitionId/OfClient/:clientId/WithTranslations

Removes a dynamic property from what a client presents; the property definition itself is left alone

HTTP syntax

DELETE /API/V3/PF/PropertyPresentation/:definitionId/OfClient/:clientId/WithTranslations

JavaScript syntax

Pqf.pf.delPropertyPresentationTranslated(definitionId, clientId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• config-properties

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
definitionId	UUID	The property definition 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.)
clientId	ClientId	The client the presentation belongs to	✔️

GET /API/V3/PF/PropertyPresentations/OfClient/:clientId/OfObjectType/:objectType

Returns how a client presents the dynamic properties of an object type, in the user's language and in that client's order

HTTP syntax

GET /API/V3/PF/PropertyPresentations/OfClient/:clientId/OfObjectType/:objectType
<- application/json

JavaScript syntax

Pqf.pf.getAllPropertyPresentations(clientId, objectType) // returns PropertyPresentation[]

Parameters

Name	Type	Description	Required	Assertion
clientId	ClientId	The client the presentation belongs to	✔️
objectType	UUID	The type of object the properties belong to	✔️	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.)

Result

This endpoint returns the following data: array of PropertyPresentation

GET /API/V3/PF/PropertyPresentations/OfClient/:clientId/OfObjectType/:objectType/WithTranslations

Returns how a client presents the dynamic properties of an object type, with translations and in that client's order

HTTP syntax

GET /API/V3/PF/PropertyPresentations/OfClient/:clientId/OfObjectType/:objectType/WithTranslations
<- application/json

JavaScript syntax

Pqf.pf.getAllPropertyPresentationsTranslated(clientId, objectType) // returns PropertyPresentationTranslated[]

Required license

This endpoint requires the following licenses:

• config-properties

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
clientId	ClientId	The client the presentation belongs to	✔️
objectType	UUID	The type of object the properties belong to	✔️	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.)

Result

This endpoint returns the following data: array of PropertyPresentationTranslated

PUT /API/V3/PF/PropertyPresentations/OfClient/:clientId/OfObjectType/:objectType/WithTranslations

Replaces what a client presents for an object type, with translations; every property definition must already exist and none is ever deleted, a property missing from the list only loses this client's presentation

HTTP syntax

PUT /API/V3/PF/PropertyPresentations/OfClient/:clientId/OfObjectType/:objectType/WithTranslations
-> application/json

JavaScript syntax

Pqf.pf.putAllPropertyPresentationsTranslated(clientId, objectType, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

• config-properties

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
clientId	ClientId	The client the presentation belongs to	✔️
objectType	UUID	The type of object the properties belong to	✔️	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.)
requestJson	array of PropertyPresentationTranslated	JSON object of type array of PropertyPresentationTranslated	✔️

GET /API/V3/PF/Relations/OfCurrentUser/All

Returns all relations that start or end on the current user's resource

HTTP syntax

GET /API/V3/PF/Relations/OfCurrentUser/All?otherType=...&otherId=...&type=...&includeImplicit=...&includeExplicit=...
<- application/json

JavaScript syntax

Pqf.pf.getCurrentUserAllRelations(otherType, otherId, type, includeImplicit, includeExplicit) // returns Relation[]

// Overloads for optional parameters
Pqf.pf.getCurrentUserAllRelations(otherType, otherId, type, includeImplicit) // returns Relation[]
Pqf.pf.getCurrentUserAllRelations(otherType, otherId, type) // returns Relation[]
Pqf.pf.getCurrentUserAllRelations(otherType, otherId) // returns Relation[]
Pqf.pf.getCurrentUserAllRelations(otherType) // returns Relation[]
Pqf.pf.getCurrentUserAllRelations() // returns Relation[]

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
otherType	UUID	Filter by source or target object type		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.)
otherId	UUID	Filter by source or target object 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, 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.)
type	UUID	Filter by relation 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.)
includeImplicit	boolean	Include also implicit relations			true
includeExplicit	boolean	Include also explicit relations			true

Result

This endpoint returns the following data: array of Relation

GET /API/V3/PF/Relations/OfCurrentUser/Backward

Returns all relations that end on the current user's resource

HTTP syntax

GET /API/V3/PF/Relations/OfCurrentUser/Backward?sourceType=...&sourceId=...&type=...&includeImplicit=...&includeExplicit=...
<- application/json

JavaScript syntax

Pqf.pf.getCurrentUserBackwardRelations(sourceType, sourceId, type, includeImplicit, includeExplicit) // returns Relation[]

// Overloads for optional parameters
Pqf.pf.getCurrentUserBackwardRelations(sourceType, sourceId, type, includeImplicit) // returns Relation[]
Pqf.pf.getCurrentUserBackwardRelations(sourceType, sourceId, type) // returns Relation[]
Pqf.pf.getCurrentUserBackwardRelations(sourceType, sourceId) // returns Relation[]
Pqf.pf.getCurrentUserBackwardRelations(sourceType) // returns Relation[]
Pqf.pf.getCurrentUserBackwardRelations() // returns Relation[]

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
sourceType	UUID	Filter by source object type		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.)
sourceId	UUID	Filter by source object 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, 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.)
type	UUID	Filter by relation 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.)
includeImplicit	boolean	Include also implicit relations			true
includeExplicit	boolean	Include also explicit relations			true

Result

This endpoint returns the following data: array of Relation

GET /API/V3/PF/Relations/OfCurrentUser/Forward

Returns all relations that start on the current user's resource

HTTP syntax

GET /API/V3/PF/Relations/OfCurrentUser/Forward?targetType=...&targetId=...&type=...&includeImplicit=...&includeExplicit=...
<- application/json

JavaScript syntax

Pqf.pf.getCurrentUserForwardRelations(targetType, targetId, type, includeImplicit, includeExplicit) // returns Relation[]

// Overloads for optional parameters
Pqf.pf.getCurrentUserForwardRelations(targetType, targetId, type, includeImplicit) // returns Relation[]
Pqf.pf.getCurrentUserForwardRelations(targetType, targetId, type) // returns Relation[]
Pqf.pf.getCurrentUserForwardRelations(targetType, targetId) // returns Relation[]
Pqf.pf.getCurrentUserForwardRelations(targetType) // returns Relation[]
Pqf.pf.getCurrentUserForwardRelations() // returns Relation[]

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
targetType	UUID	Filter by target object type		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.)
targetId	UUID	Filter by target object 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, 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.)
type	UUID	Filter by relation 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.)
includeImplicit	boolean	Include also implicit relations			true
includeExplicit	boolean	Include also explicit relations			true

Result

This endpoint returns the following data: array of Relation

GET /API/V3/PF/Relations/OfObject/:objectType/:objectId/All

Returns all relations that start or end on a given object

HTTP syntax

GET /API/V3/PF/Relations/OfObject/:objectType/:objectId/All?otherType=...&otherId=...&type=...&includeImplicit=...&includeExplicit=...
<- application/json

JavaScript syntax

Pqf.pf.getAllRelations(objectType, objectId, otherType, otherId, type, includeImplicit, includeExplicit) // returns Relation[]

// Overloads for optional parameters
Pqf.pf.getAllRelations(objectType, objectId, otherType, otherId, type, includeImplicit) // returns Relation[]
Pqf.pf.getAllRelations(objectType, objectId, otherType, otherId, type) // returns Relation[]
Pqf.pf.getAllRelations(objectType, objectId, otherType, otherId) // returns Relation[]
Pqf.pf.getAllRelations(objectType, objectId, otherType) // returns Relation[]
Pqf.pf.getAllRelations(objectType, objectId) // returns Relation[]

Required permission

Requires permission IDENTIFY on object of type specified in parameter objectType and ID specified in parameter objectId.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of the 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.)
objectId	UUID	The ID of the 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.)
otherType	UUID	Filter by source or target object type		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.)
otherId	UUID	Filter by source or target object 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, 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.)
type	UUID	Filter by relation 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.)
includeImplicit	boolean	Include also implicit relations			true
includeExplicit	boolean	Include also explicit relations			true

Result

This endpoint returns the following data: array of Relation

GET /API/V3/PF/Relations/OfObject/:sourceType/:sourceId/Forward

Returns all relations that start on a given object

HTTP syntax

GET /API/V3/PF/Relations/OfObject/:sourceType/:sourceId/Forward?targetType=...&targetId=...&type=...&includeImplicit=...&includeExplicit=...
<- application/json

JavaScript syntax

Pqf.pf.getForwardRelations(sourceType, sourceId, targetType, targetId, type, includeImplicit, includeExplicit) // returns Relation[]

// Overloads for optional parameters
Pqf.pf.getForwardRelations(sourceType, sourceId, targetType, targetId, type, includeImplicit) // returns Relation[]
Pqf.pf.getForwardRelations(sourceType, sourceId, targetType, targetId, type) // returns Relation[]
Pqf.pf.getForwardRelations(sourceType, sourceId, targetType, targetId) // returns Relation[]
Pqf.pf.getForwardRelations(sourceType, sourceId, targetType) // returns Relation[]
Pqf.pf.getForwardRelations(sourceType, sourceId) // returns Relation[]

Required permission

Requires permission IDENTIFY on object of type specified in parameter sourceType and ID specified in parameter sourceId.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
sourceType	UUID	The type of the 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.)
sourceId	UUID	The ID of the 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.)
targetType	UUID	Filter by target object type		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.)
targetId	UUID	Filter by target object 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, 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.)
type	UUID	Filter by relation 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.)
includeImplicit	boolean	Include also implicit relations			true
includeExplicit	boolean	Include also explicit relations			true

Result

This endpoint returns the following data: array of Relation

GET /API/V3/PF/Relations/OfObject/:targetType/:targetId/Backward

Returns all relations that end on a given object

HTTP syntax

GET /API/V3/PF/Relations/OfObject/:targetType/:targetId/Backward?sourceType=...&sourceId=...&type=...&includeImplicit=...&includeExplicit=...
<- application/json

JavaScript syntax

Pqf.pf.getBackwardRelations(targetType, targetId, sourceType, sourceId, type, includeImplicit, includeExplicit) // returns Relation[]

// Overloads for optional parameters
Pqf.pf.getBackwardRelations(targetType, targetId, sourceType, sourceId, type, includeImplicit) // returns Relation[]
Pqf.pf.getBackwardRelations(targetType, targetId, sourceType, sourceId, type) // returns Relation[]
Pqf.pf.getBackwardRelations(targetType, targetId, sourceType, sourceId) // returns Relation[]
Pqf.pf.getBackwardRelations(targetType, targetId, sourceType) // returns Relation[]
Pqf.pf.getBackwardRelations(targetType, targetId) // returns Relation[]

Required permission

Requires permission IDENTIFY on object of type specified in parameter targetType and ID specified in parameter targetId.

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
targetType	UUID	The type of the 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.)
targetId	UUID	The ID of the 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.)
sourceType	UUID	Filter by source object type		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.)
sourceId	UUID	Filter by source object 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, 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.)
type	UUID	Filter by relation 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.)
includeImplicit	boolean	Include also implicit relations			true
includeExplicit	boolean	Include also explicit relations			true

Result

This endpoint returns the following data: array of Relation

GET /API/V3/PF/RelationType/:relationType

Returns a specific relation type

HTTP syntax

GET /API/V3/PF/RelationType/:relationType
<- application/json : RelationTypeWithConstraints

JavaScript syntax

Pqf.pf.getRelationType(relationType) // returns RelationTypeWithConstraints

Parameters

Name	Type	Description	Required	Assertion
relationType	UUID	the relation 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: RelationTypeWithConstraints

GET /API/V3/PF/RelationTypes

Returns all relation type references

HTTP syntax

GET /API/V3/PF/RelationTypes?implicit=...&explicit=...&sort=...
<- application/json

JavaScript syntax

Pqf.pf.getAllRelationTypes(implicit, explicit, sort) // returns Reference[]

// Overloads for optional parameters
Pqf.pf.getAllRelationTypes(implicit, explicit) // returns Reference[]
Pqf.pf.getAllRelationTypes(implicit) // returns Reference[]
Pqf.pf.getAllRelationTypes() // returns Reference[]

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
implicit	boolean	return implicit relations			true
explicit	boolean	return explicit relations			true
sort	array of string	Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, nameForward, nameBackward, description, color, sortIndexForward, sortIndexBackward		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 Reference

GET /API/V3/PF/RelationTypes/:relationTypes

Returns some relation types with their constraints

HTTP syntax

GET /API/V3/PF/RelationTypes/:relationTypes
<- application/json

JavaScript syntax

Pqf.pf.getRelationTypes(relationTypes) // returns RelationTypeWithConstraints[]

Parameters

Name	Type	Description	Required	Assertion
relationTypes	array of UUID	the relation 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 RelationTypeWithConstraints

GET /API/V3/PF/RelationTypes/OfObjectType/:objectType/All

Returns all relation types of relations that may start or end on a given type of object

HTTP syntax

GET /API/V3/PF/RelationTypes/OfObjectType/:objectType/All?implicit=...&explicit=...&sort=...
<- application/json

JavaScript syntax

Pqf.pf.getAllRelationTypesForType(objectType, implicit, explicit, sort) // returns Reference[]

// Overloads for optional parameters
Pqf.pf.getAllRelationTypesForType(objectType, implicit, explicit) // returns Reference[]
Pqf.pf.getAllRelationTypesForType(objectType, implicit) // returns Reference[]
Pqf.pf.getAllRelationTypesForType(objectType) // returns Reference[]

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
objectType	UUID	The type of objects	✔️	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.)
implicit	boolean	return implicit relations			true
explicit	boolean	return explicit relations			true
sort	array of string	Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, nameForward, nameBackward, description, color, sortIndexForward, sortIndexBackward		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 Reference

GET /API/V3/PF/RelationTypes/OfObjectType/:objectType/Backward

Returns all relation types of relations that may end on a given type of object

HTTP syntax

GET /API/V3/PF/RelationTypes/OfObjectType/:objectType/Backward
<- application/json

JavaScript syntax

Pqf.pf.getBackwardRelationTypesForType(objectType) // returns Reference[]

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of objects	✔️	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.)

Result

This endpoint returns the following data: array of Reference

GET /API/V3/PF/RelationTypes/OfObjectType/:objectType/Forward

Returns all relation types of relations that may start on a given type of object

HTTP syntax

GET /API/V3/PF/RelationTypes/OfObjectType/:objectType/Forward
<- application/json

JavaScript syntax

Pqf.pf.getForwardRelationTypesForType(objectType) // returns Reference[]

Parameters

Name	Type	Description	Required	Assertion
objectType	UUID	The type of objects	✔️	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.)

Result

This endpoint returns the following data: array of Reference

GET /API/V3/PF/ServerConfig/:configKey

Returns a server-specific configuration value that is shared between tenants

HTTP syntax

GET /API/V3/PF/ServerConfig/:configKey
<- text/plain

JavaScript syntax

Pqf.pf.getServerConfig(configKey) // returns String

Parameters

Name	Type	Description	Required	Assertion
configKey	string	A shared configuration value's key	✔️

Result

This endpoint returns the following data: string

GET /API/V3/PF/Tenant/Current

May be used by the client to show the currently selected tenant on login screen. Returns no secret information

HTTP syntax

GET /API/V3/PF/Tenant/Current
<- application/json : Tenant

JavaScript syntax

Pqf.pf.getCurrentTenant() // returns Tenant

Result

This endpoint returns the following data: Tenant

GET /API/V3/PF/Tenant/Current/License/Features

May be used by the client to enable or disable certain features to optimize the client's screen design depending on licensed features

HTTP syntax

GET /API/V3/PF/Tenant/Current/License/Features
<- application/json : LicenseFeatures

JavaScript syntax

Pqf.pf.getCurrentTenantLicenseFeatures() // returns LicenseFeatures

Result

This endpoint returns the following data: LicenseFeatures

GET /API/V3/PF/Tenant/Current/WithAdditionalData

May be used by the client to show the currently selected tenant on screens where the user is authenticated

HTTP syntax

GET /API/V3/PF/Tenant/Current/WithAdditionalData
<- application/json : TenantWithAdditionalData

JavaScript syntax

Pqf.pf.getCurrentTenantWithAdditionalData() // returns TenantWithAdditionalData

Result

This endpoint returns the following data: TenantWithAdditionalData

GET /API/V3/PF/UndeleteLimit

Returns the amount of time an object stays in the waste bin for undeletion

HTTP syntax

GET /API/V3/PF/UndeleteLimit
<- application/json : UndeleteLimit

JavaScript syntax

Pqf.pf.getUndeleteLimit() // returns UndeleteLimit

Required license

This endpoint requires the following licenses:

• undelete

Result

This endpoint returns the following data: UndeleteLimit

GET /API/V3/PF/UniqueReadableCodeDef/:typeId

Returns a unique readable code definition

HTTP syntax

GET /API/V3/PF/UniqueReadableCodeDef/:typeId
<- application/json : UniqueReadableCodeDef

JavaScript syntax

Pqf.pf.getUniqueReadableCodeDef(typeId) // returns UniqueReadableCodeDef

Parameters

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

Result

This endpoint returns the following data: UniqueReadableCodeDef

PUT /API/V3/PF/UniqueReadableCodeDef/:typeId

Sets a unique readable code definition

HTTP syntax

PUT /API/V3/PF/UniqueReadableCodeDef/:typeId
-> application/json : UniqueReadableCodeDef

JavaScript syntax

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

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
typeId	UUID	The type of the 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.)
requestJson	UniqueReadableCodeDef	JSON object of type UniqueReadableCodeDef	✔️

DELETE /API/V3/PF/UniqueReadableCodeDef/:typeId

Deletes a unique readable code definition

HTTP syntax

DELETE /API/V3/PF/UniqueReadableCodeDef/:typeId

JavaScript syntax

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

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

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

GET /API/V3/PF/UniqueReadableCodeDefs

Returns all unique readable code definitions

HTTP syntax

GET /API/V3/PF/UniqueReadableCodeDefs
<- application/json

JavaScript syntax

Pqf.pf.getAllUniqueReadableCodeDefs() // returns Reference[]

Result

This endpoint returns the following data: array of Reference

GET /API/V3/PF/UnitSystem/:systemId/Convert

Converts a value into a specific unit

HTTP syntax

GET /API/V3/PF/UnitSystem/:systemId/Convert?source=...&dest=...&value=...
<- application/json : ValueWithUnit

JavaScript syntax

Pqf.pf.convertUnit(systemId, source, dest, value) // returns ValueWithUnit

// Overloads for optional parameters
Pqf.pf.convertUnit(systemId, source, dest) // returns ValueWithUnit
Pqf.pf.convertUnit(systemId, source) // returns ValueWithUnit
Pqf.pf.convertUnit(systemId) // returns ValueWithUnit

Parameters

Name	Type	Description	Required	Assertion	Default, if omitted
systemId	UUID	The unit system'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.)
source	string	The source unit identifier
dest	string	The destination unit identifier
value	double	The value			0

Result

This endpoint returns the following data: ValueWithUnit

GET /API/V3/PF/UnitSystem/:systemId/Factors

Returns the factors that apply to all units of a unit system

HTTP syntax

GET /API/V3/PF/UnitSystem/:systemId/Factors?ref=...
<- application/json

JavaScript syntax

Pqf.pf.getUnitFactors(systemId, ref) // returns UnitFactor[]

// Overloads for optional parameters
Pqf.pf.getUnitFactors(systemId) // returns UnitFactor[]

Parameters

Name	Type	Description	Required	Assertion
systemId	UUID	The unit system'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.)
ref	string	The reference unit (optional)

Result

This endpoint returns the following data: array of UnitFactor

PUT /API/V3/PF/UnitSystem/:systemId/Factors

Manipulates the factors of a unit system

HTTP syntax

PUT /API/V3/PF/UnitSystem/:systemId/Factors
-> application/json

JavaScript syntax

Pqf.pf.putUnitFactors(systemId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
systemId	UUID	The unit system'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	array of UnitFactor	JSON object of type array of UnitFactor	✔️

GET /API/V3/PF/UnitSystem/:systemId/Preference

Returns the preference of unit in a unit system

HTTP syntax

GET /API/V3/PF/UnitSystem/:systemId/Preference
<- application/json : UnitPreference

JavaScript syntax

Pqf.pf.getUnitPreference(systemId) // returns UnitPreference

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
systemId	UUID	The unit system'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: UnitPreference

PUT /API/V3/PF/UnitSystem/:systemId/Preference

Manipulates the preference of unit in a unit system

HTTP syntax

PUT /API/V3/PF/UnitSystem/:systemId/Preference
-> application/json : UnitPreference

JavaScript syntax

Pqf.pf.putUnitPreference(systemId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name	Type	Description	Required	Assertion
systemId	UUID	The unit system'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	UnitPreference	JSON object of type UnitPreference	✔️

GET /API/V3/PF/UnitSystem/:systemId/Unit/:unit

Returns a specific unit

HTTP syntax

GET /API/V3/PF/UnitSystem/:systemId/Unit/:unit
<- application/json : Unit

JavaScript syntax

Pqf.pf.getUnit(systemId, unit) // returns Unit

Parameters

Name	Type	Description	Required	Assertion
systemId	UUID	The unit system'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.)
unit	string	The unit identifier	✔️

Result

This endpoint returns the following data: Unit

GET /API/V3/PF/UnitSystem/:systemId/Units

Returns all units of a unit system

HTTP syntax

GET /API/V3/PF/UnitSystem/:systemId/Units
<- application/json

JavaScript syntax

Pqf.pf.getUnits(systemId) // returns Unit[]

Parameters

Name	Type	Description	Required	Assertion
systemId	UUID	The unit system'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 Unit

Data types

PF.Access

This is a structure data contract.

Access information to be provided in the WebSocket by the client to inform about object usage

Based on

• Reference

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.)
access	AccessType		The type of access (view / edit)

PF.AccessConcurrency

This is a structure data contract.

Access information to be provided in the WebSocket by the server to inform about object usage of other users

Members

Name	Type	Inherited	Description	Assertion
object	Reference		The object that is in use	non-null (The value is required.)
userIds	array of UUID		The user IDs of the users accessing the object references	non-null;non-null & matches '[0-9A-F]{32}' (The array is required. Each element must not be null and must be a UUID written as 32 upper-case hexadecimal digits.)

PF.AccessType

This is an enumeration data contract.

Type of access for concurrency information over WebSocket

Enum values

ID	Description
VIEW	Object is being viewed
EDIT	Object is being edited

PF.Action

This is an enumeration data contract.

Describes an action that was performed on any object

Enum values

ID	Description
CREATED	An object was created
UPDATED	An object was updated
DELETED	An object was deleted
LIFECYCLE	An object's lifecycle state was changed
PERMISSION	An object's permission (confidentiality) was changed

PF.ApiVersion

This is an enumeration data contract.

Contains the different generations (versions) of API

Enum values

ID	Description
V1	V1 API, as since 2014
V2	V2 API, as since 2019
V3	V3 API, as since 2026

PF.AttachmentDetails

This is a structure data contract.

Contains basic information about an attachment, but no data

Based on

• AttachmentReference

Members

Name	Type	Inherited	Description	Assertion
type	UUID	✔️	The type of the object (used for change notifications)	non-null & matches 'Attachment' (The value is required and must be exactly "Attachment".)
id	string	✔️	The ID of the attachment (base 32 encoded hash)	non-null & matches '[0-9A-Z]{52}\|[0-9a-zA-Z]{43}' (The value is required and must be a hashed ID (52 upper-case letters and digits, or 43 letters and digits).)
mimeType	string		The MIME type of the attachment (see https://www.iana.org/assignments/media-types/media-types.xhtml)	non-null & matches '[0-9A-Za-z][0-9A-Za-z!#$&\-^_]{0,63}/[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]{0,63}(?:;[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*=[0-9A-Za-z][0-9A-Za-z!#$&\-^_.+]*)*' (The value is required and must be a media (MIME) type such as "application/json", optionally with parameters.)
size	long		The size of the attachment in bytes
timestamp	datetime		The point in time when the attachment was added

PF.AttachmentReference

This is a structure data contract.

A reference to an attachment, identified by type and ID

Members

Name	Type	Inherited	Description	Assertion
type	UUID		The type of the object (used for change notifications)	non-null & matches 'Attachment' (The value is required and must be exactly "Attachment".)
id	string		The ID of the attachment (base 32 encoded hash)	non-null & matches '[0-9A-Z]{52}\|[0-9a-zA-Z]{43}' (The value is required and must be a hashed ID (52 upper-case letters and digits, or 43 letters and digits).)

PF.Authorization

This is a structure data contract.

Describes authorizations that are granted for an object

Members

Name	Type	Inherited	Description	Assertion
objectType	UUID		The type of object	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.)
objectId	UUID		The ID of the object	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.)
action	string		The action that may be performed on that object (null, if transition is set)
transitionId	UUID		The ID of the lifecycle transition that may be performed on that object (null, if action is set)	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.)
grant	Grant		Indicator whether the action or transition will be granted or not	non-null (The value is required.)

PF.BackupMetadata

This is a structure data contract.

Additional information stored in a backup file

Members

Name	Type	Inherited	Description	Assertion
name	string		The name of the object stored within the backup
code	string		The code of the object stored within the backup	matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description	string		The description of the object stored within the backup
type	UUID		The type of object stored within the backup	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.)
createdAt	datetime		The point in time when the backup was created

PF.BasicObject

This is a structure data contract.

A generic item with basic identifying information

Based on

• Reference
• VersionReference
• VersionedReference

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	Reference	✔️	Reference to the user that created this object
modifiedAt	datetime	✔️	The point in time when the object was modified
modifiedBy	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.)

PF.BasicObjectTranslated

This is a structure data contract.

A generic item with basic identifying information in different languages

Based on

• Reference
• VersionReference
• VersionedReference

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	Reference	✔️	Reference to the user that created this object
modifiedAt	datetime	✔️	The point in time when the object was modified
modifiedBy	Reference	✔️	Reference to the user that modified this object
name	array of TextTranslation		The name of the object in different languages	null;non-null (The array is optional. 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 TextTranslation		A descriptive text about the object, may contain HTML (in different languages)	null;non-null (The array is optional. 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 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)	null;non-null (The array is optional. Each element must not be null.)

PF.Calendar

This is a structure data contract.

A hierarchical calendar made up of one or more layers of increasing granularity

Members

Name	Type	Inherited	Description	Assertion
layers	array of CalendarLayer		The calendar's layers, from coarsest to finest

PF.CalendarGranularity

This is an enumeration data contract.

Defines a granularity (scaling) of a calendar

Enum values

ID	Description
Day	Day
Week	Week
Month	Month
Quarter	Quarter
Third	Third
Semester	Semester
Year	Year

PF.CalendarLayer

This is a structure data contract.

A calendar layer, split into ranges according to its granularity

Members

Name	Type	Inherited	Description	Assertion
unit	CalendarGranularity		The granularity (time unit) of this layer
ranges	array of CalendarRange		The individual ranges making up this layer

PF.CalendarRange

This is a structure data contract.

A single range (period) within a calendar layer

Members

Name	Type	Inherited	Description	Assertion
label	string		The label describing the range, in the user's language (e.g. "January 2024")
first	date		The first day belonging to the range
last	date		The last day belonging to the range

PF.CertificateInfo

This is a structure data contract.

Descriptive information about a certificate

Members

Name	Type	Inherited	Description	Assertion
serialNumber	string		Contains the serial number of the certificate
commonName	string		Contains the common name of the certificate
expiry	datetime		Contains the expiry of the certificate
fingerprint	string		Contains the fingerprint (SHA 256) of the certificate

PF.ChangeNotification

This is a structure data contract.

Structure for WebSocket notification about changed objects

Members

Name	Type	Inherited	Description	Assertion
action	ChangeNotificationAction		The action that was performed on an object (C, U, D, L)	non-null (The value is required.)
data	Reference		A reference to the object the action was performed on	non-null (The value is required.)
parent	array of Reference		Parent objects that may be affected (i.e., when creating objects)	non-null;non-null (The array is required. Each element must not be null.)

PF.ChangeNotificationAction

This is an enumeration data contract.

Describes an action that was performed on an object

Enum values

ID	Description
C	Create
U	Update
D	Delete
L	Lifecycle

PF.ChangeNotificationWebSocketClientToServer

This is a structure data contract. It has choice semantics, not more than one member is set, all others are null.

This structure defines all possible messages that may be sent from client to server over WebSocket

Members

Name	Type	Inherited	Description	Assertion

Note: Members that are null will be skipped in server responses.

PF.ChangeNotificationWebSocketServerToClient

This is a structure data contract. It has choice semantics, not more than one member is set, all others are null.

This structure defines all possible messages that may be sent from server to client over WebSocket

Members

Name	Type	Inherited	Description	Assertion
sessionInfo	SessionInfo		This message is sent by server once to inform about the current session
dataChange	ChangeNotification		This message is sent by server to inform about an object that was changed or created

Note: Members that are null will be skipped in server responses.

PF.ClientId

This is an enumeration data contract.

A front end talking to this server. Everything a client decides for itself - which dynamic properties it shows and how - hangs off this id.

Enum values

ID	Description
Client4	The web client shipped with this server; every API V2 endpoint assumes it
Client5	The next generation web client

PF.ClientSessionWebSocketClientToServer

This is a structure data contract. It has choice semantics, not more than one member is set, all others are null.

This structure defines all possible messages that may be sent from client to server over WebSocket

Members

Name	Type	Inherited	Description	Assertion
feature	Feature		This message is sent by client to inform about features (tabs) of objects being displayed
access	Access		This message is sent by client to inform about an object being viewed or edited

Note: Members that are null will be skipped in server responses.

PF.ClientSessionWebSocketServerToClient

This is a structure data contract. It has choice semantics, not more than one member is set, all others are null.

This structure defines all possible messages that may be sent from server to client over WebSocket

Members

Name	Type	Inherited	Description	Assertion
sessionInfo	SessionInfo		This message is sent by server once to inform about the current session
dataChange	ChangeNotification		This message is sent by server to inform about an object that was changed or created
featureConcurrency	array of FeatureConcurrency		This message is sent by server to inform about other users being on the same feature (tab) of an object	null;non-null (The array is optional. Each element must not be null.)
accessConcurrency	array of AccessConcurrency		This message is sent by server to inform about other users viewing or editing the same object	null;non-null (The array is optional. Each element must not be null.)

Note: Members that are null will be skipped in server responses.

PF.CurrencyAmount

This is a structure data contract.

A numeric value with currency, indicating some monetary value

Members

Name	Type	Inherited	Description	Assertion
currencyId	UUID		The currency	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.)
amount	double		The amount

PF.CustomizedObject

This is a structure data contract.

A generic item with basic identifying information and dynamic properties

Based on

• Reference
• VersionReference
• VersionedReference
• BasicObject

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	Reference	✔️	Reference to the user that created this object
modifiedAt	datetime	✔️	The point in time when the object was modified
modifiedBy	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 Property		A collection of dynamic properties belonging to the object	non-null;non-null (The array is required. Each element must not be null.)

PF.CustomizedObjectTranslated

This is a structure data contract.

A generic item with basic identifying information in different languages and dynamic properties

Based on

• Reference
• VersionReference
• VersionedReference
• BasicObjectTranslated

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	Reference	✔️	Reference to the user that created this object
modifiedAt	datetime	✔️	The point in time when the object was modified
modifiedBy	Reference	✔️	Reference to the user that modified this object
name	array of TextTranslation	✔️	The name of the object in different languages	null;non-null (The array is optional. 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 TextTranslation	✔️	A descriptive text about the object, may contain HTML (in different languages)	null;non-null (The array is optional. 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 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)	null;non-null (The array is optional. Each element must not be null.)
properties	array of Property		A collection of dynamic properties belonging to the object	non-null;non-null (The array is required. Each element must not be null.)

PF.DocumentFolder

This is a structure data contract.

A folder to organize documents on an object

Based on

• Reference
• VersionReference
• VersionedReference
• BasicObject
• CustomizedObject

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	Reference	✔️	Reference to the user that created this object
modifiedAt	datetime	✔️	The point in time when the object was modified
modifiedBy	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 Property	✔️	A collection of dynamic properties belonging to the object	non-null;non-null (The array is required. Each element must not be null.)
parentFolderId	UUID		The parent folder's ID (may be null for a folder directly on the 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, 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.)

PF.DocumentLink

This is a structure data contract.

A link between an object and a document

Based on

• Reference
• VersionReference
• VersionedReference
• BasicObject
• CustomizedObject

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	Reference	✔️	Reference to the user that created this object
modifiedAt	datetime	✔️	The point in time when the object was modified
modifiedBy	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 Property	✔️	A collection of dynamic properties belonging to the object	non-null;non-null (The array is required. Each element must not be null.)
parentFolderId	UUID		The parent folder's ID (may be null for a link directly on the 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, 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.)
url	URI		The URL of the document the document link points to, which may be on any external system	non-null (The value is required.)
mimeType	string		The MIME type of the referenced document (see https://www.iana.org/assignments/media-types/media-types.xhtml, if known)
size	long?		The size of the referenced document in bytes (if known)
sortIndex	double		A sort index that may be used by the client to fix a specific order

PF.DocumentReference

This is a structure data contract.

Describes a reference to a document link or document folder

Based on

• Reference

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	Reference		A reference to the parent object	non-null (The value is required.)
folderId	UUID		A folder id if not on root	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.)

PF.DurationSlot

This is a structure data contract.

A time slot holding one single amount of time

Based on

• TimeSlot

Members

Name	Type	Inherited	Description	Assertion
beg	date	✔️	The first day of the slot (inclusive)	non-null (The value is required.)
end	date	✔️	The day after the last day of the slot (exclusive)	non-null (The value is required.)
unit	CalendarGranularity	✔️	The calendar unit the slot belongs to	non-null (The value is required.)
complete	boolean	✔️	true, if the slot covers its calendar unit completely; false, if it has been cut, e.g. by the start or the end of the requested time span
capacity	duration	✔️	The capacity of the resource within the slot, as defined by its worktime model (meant for scaling the slot, the times of the slot may exceed it)	non-null (The value is required.)
time	duration		The amount of time within the slot	non-null (The value is required.)

PF.EnumType

This is a structure data contract.

Describes an enum type

Based on

• Reference
• Identification

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.)
hardcoded	boolean		Specifies whether this is a hardcoded or customizable enum

PF.ErrorInformation

This is a structure data contract.

Information about an error that is provided to the client in case of error (HTTP code >= 400)

Members

Name	Type	Inherited	Description	Assertion
id	UUID		An ID that defines the error. In the server's error log, there might be additional details stored with reference to this ID.	matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.)
message	string		A detailed or generic message that may be in the user's language or not

Note: Members that are null will be skipped in server responses.

PF.ExplicitRelationTypeTranslated

This is a structure data contract.

Describes an explicit (configured) relation with translations

Based on

• Reference
• VersionReference
• VersionedReference

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	Reference	✔️	Reference to the user that created this object
modifiedAt	datetime	✔️	The point in time when the object was modified
modifiedBy	Reference	✔️	Reference to the user that modified this object
nameForward	array of TextTranslation		Defines the name which describes the relation seen from the source in different languages	length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
nameBackward	array of TextTranslation		Defines the name which describes the relation seen from the target in different languages	length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
description	array of 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
iconRef	array of 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	length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
sourceTypes	array of UUID		Defines the possible object types for the source part of the (directed) relation	non-null & length > 0;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 array is required and must contain at least one element. Each element must not be null 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.)
sourcesUrl	URI		Defines a URL which may be used to enumerate all possible objects for the source part of the (directed) relation
createTargetFromSourceUrl	URI		Url that may be used to create a target and a relation at the same time given a source object (use :type and :id as placeholders for source reference)
targetTypes	array of UUID		Defines the possible object types for the target part of the (directed) relation	non-null & length > 0;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 array is required and must contain at least one element. Each element must not be null 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.)
targetsUrl	URI		Defines a URL which may be used to enumerate all possible objects for the target part of the (directed) relation
createSourceFromTargetUrl	URI		Url that may be used to create a source and a relation at the same time given a target object (use :type and :id as placeholders for target reference)
sortIndexForward	double		Defines the sort index seen from the source (lowest first)
sortIndexBackward	double		Defines the sort index seen from the target (lowest first)
autoSet	boolean		Automatically create a relation to the user when he/she creates a new object (makes only sense, if relation may be linked to a resource)

PF.Feature

This is a structure data contract.

Describes a feature view (tab) of any object

Based on

• Reference

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.)
featureId	string		The feature ID	non-null (The value is required.)

PF.FeatureConcurrency

This is a structure data contract.

Information about other users viewing the same object

Members

Name	Type	Inherited	Description	Assertion
feature	string		The feature (tab) of the object	non-null (The value is required.)
userIds	array of UUID		The users that are viewing the feature (tab) of the object	non-null;non-null & matches '[0-9A-F]{32}' (The array is required. Each element must not be null and must be a UUID written as 32 upper-case hexadecimal digits.)

PF.Grant

This is an enumeration data contract.

The result of an authorization check

Enum values

ID	Description
DENY	Indicates that the desired action is not allowed
ALLOW	Indicates that the desired action is allowed

PF.GrantLevel

This is an enumeration data contract.

The result of an authorization check, taking the confidentiality of the object into account

Enum values

ID	Description
DENY	Indicates that the desired action is not allowed
ALLOW_NON_CONFIDENTIAL	Indicates that the desired action is allowed on non-confidential objects only
ALLOW_ALL	Indicates that the desired action is allowed on all objects, including confidential ones

PF.GroupedDurationSlot

This is a structure data contract.

A time slot holding amounts of time grouped by the objects they belong to

Based on

• TimeSlot

Members

Name	Type	Inherited	Description	Assertion
beg	date	✔️	The first day of the slot (inclusive)	non-null (The value is required.)
end	date	✔️	The day after the last day of the slot (exclusive)	non-null (The value is required.)
unit	CalendarGranularity	✔️	The calendar unit the slot belongs to	non-null (The value is required.)
complete	boolean	✔️	true, if the slot covers its calendar unit completely; false, if it has been cut, e.g. by the start or the end of the requested time span
capacity	duration	✔️	The capacity of the resource within the slot, as defined by its worktime model (meant for scaling the slot, the times of the slot may exceed it)	non-null (The value is required.)
times	array of ReferenceDuration		The amounts of time within the slot, one per object they belong to. Objects without any time within the slot are omitted	non-null;non-null (The array is required. Each element must not be null.)

PF.IconTranslation

This is a structure data contract.

Contains a uri for icons in a certain language

Members

Name	Type	Inherited	Description	Assertion
language	string		The language code (ISO 639-1 with optional country)	non-null & matches '[a-zA-Z]{2}(?:-[a-zA-Z]+)*' (The value is required and must be a language tag such as "de" or "en-GB".)
icon	URI		The translated icon URI, 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	non-null & 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 is required and must match the regular expression shown.)

PF.Identification

This is a structure data contract.

A generic item with basic identifying information

Based on

• Reference

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.)

PF.IdentificationExtended

This is a structure data contract.

A generic item with basic identifying information and deleted flag

Based on

• Reference
• Identification

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.)
deleted	boolean		true, if object is deleted, false otherwise

PF.IdentificationRecentlyDeleted

This is a structure data contract.

Contains information about an item that was recently deleted

Based on

• Reference
• Identification

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.)
parent	Reference		a reference to a parent
deletedAt	datetime		The point in time when the object was deleted
deletedBy	Reference		Reference to the user that deleted this object

PF.IdentificationTranslated

This is a structure data contract.

A generic item with basic identifying information in different languages

Based on

• Reference

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 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 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 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.)

PF.Jtf

This is a structure data contract.

The JSON table format defined by Client Team to support dynamic table visualization on client

Members

Name	Type	Inherited	Description	Assertion
mimeType	string		must be "application/x.pqf.table.json"	matches 'application/x\.pqf\.table\.json' (The value, if present, must match the regular expression shown.)
type	UUID		Identifier for the table structure defined in the meta section. Documents with identical table structure should have the same type. User settings like sort or filter will be stored per 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.)
id	UUID		An identification of the document (optional)	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	JSON		Name of the document (localized)
code	JSON		Visualized type name of the document (optional, localized)
description	JSON		Description of the document visualized as hint (optional, localized)
color	color		Color for the document (optional, localized)
iconRef	JSON		Icon for the document (optional, localized)
createdAt	datetime		Timestamp of the document creation (optional, ISO formatted, UTC)
createdBy	string		Name of the creator (optional)
meta	JtfMeta		Meta data
data	JSON		The table content is based on an array of rows. id: Row ID (optional), style: Object of CSS styling for this column (optional), data; Array of values according to the type in the column definitions. It is possible to reduce the row data to the array of values.
hints	JSON		Hints is an array of information that can be displayed on top of the grid or charts. The items of the array are either directly HTML formatted strings (shown as type info and without a label), or objects

Note: Members that are null will be skipped in server responses.

PF.JtfChart

This is a structure data contract.

Chart definition for the JSON table format defined by Client Team

Members

Name	Type	Inherited	Description	Assertion
id	UUID		An identification of the chart (optional)	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	JSON		Name of the Chart. Will be shown in the Tab. (optional)
description	JSON		Description of the chart visualized as hint (optional, localized)
color	color		Color for the chart (optional, localized)
iconRef	JSON		Icon for the chart (optional, localized)
hidden	boolean?		Hides the chart
type	JtfChartType		Type of the Chart
baseline	JtfChartBaseline		Data represented on the x-axis (in case of "line", "bar" and "stackedbar") or the data for the names/groups of the slices (in case of "pie", "donut")
datasets	array of JtfChartDataset		Data represented along the y-axis. Multiple Datasets possible for "line","bar" and "stackedbar". Think of it as multiple lines, bars.	null;non-null (The array is optional. Each element must not be null.)
axis	JtfChartAxis		Axis options
showLegend	boolean?		Whether to show legend or not
bubbleSettings	JtfChartBubbleSettings		Offers additional control for charts/widgets of type "bubble" (optional)
pieDonutSettings	JtfChartPieDonutSettings		Offers additional control for charts/widgets of type "pie" and "donut" (optional)

Note: Members that are null will be skipped in server responses.

PF.JtfChartAxis

This is a structure data contract.

Chart axis definition for the JSON table format defined by Client Team

Members

Name	Type	Inherited	Description	Assertion
showAxisName	boolean?		Declares whether the names of the axis' are shown. Is ignored for "pie" and "donut" charts
x	JtfChartAxisOptions		Considers the x-axis
y	JtfChartAxisOptions		Considers the y-axis

Note: Members that are null will be skipped in server responses.

PF.JtfChartAxisOptions

This is a structure data contract.

Chart axis options definition for the JSON table format defined by Client Team

Members

Name	Type	Inherited	Description	Assertion
name	JSON		Name of the axis. Can provide options for different languages.
unit	JSON		Unit will be added at the end of the Axis-Name
format	JtfChartDataFormat		Renders the tick labels of the axis (optional)
labels	array of JtfChartBubbleAxisLabel		Fixed tick labels (optional)	null;non-null (The array is optional. Each element must not be null.)
lines	boolean?		Draws a gridline for every tick of the axis (optional)

Note: Members that are null will be skipped in server responses.

PF.JtfChartBaseline

This is a structure data contract.

Chart baseline definition for the JSON table format defined by Client Team

Members

Name	Type	Inherited	Description	Assertion
id	UUID		An identification of the column. Must match the id of a column defined in the columns section of the document	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	JSON		Name of the column. Must not necessarily match the name of the column in the columns section. Will be shown in the "tip" (when hovering over the data in the chart)
description	JSON		Description of the chart baseline visualized as hint (optional, localized)
type	JtfChartDataType		Type of the data
format	JtfChartDataFormat		Format data depending on type

Note: Members that are null will be skipped in server responses.

PF.JtfChartBubbleAxisLabel

This is a structure data contract.

Data regarding labels on axis

Members

Name	Type	Inherited	Description	Assertion
value	int?		Value of the label on the axis
name	JSON		Text of the label
line	boolean?		Draws a gridline for this label

Note: Members that are null will be skipped in server responses.

PF.JtfChartBubbleCategory

This is a structure data contract.

Category shown in bubble chart

Members

Name	Type	Inherited	Description	Assertion
key	UUID		Key the category is applied 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.)
name	JSON		Legend entry
color	color		Color of the bubbles in this category

Note: Members that are null will be skipped in server responses.

PF.JtfChartBubbleLabel

This is a structure data contract.

Labels shown in the bubble chart

Members

Name	Type	Inherited	Description	Assertion
key	UUID		Value of the baseline the label is applied 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.)
name	JSON		Name shown in the bubble

Note: Members that are null will be skipped in server responses.

PF.JtfChartBubbleSettings

This is a structure data contract.

Options for charts/widgets of type "bubble"

Members

Name	Type	Inherited	Description	Assertion
names	array of JtfChartBubbleLabel		Maps a key to the name that is shown in the bubble (optional)	null;non-null (The array is optional. Each element must not be null.)
categories	array of JtfChartBubbleCategory		Maps a key to a color and a name (optional)	null;non-null (The array is optional. Each element must not be null.)
size	int?		Size of the bubbles in percentage (optional)

Note: Members that are null will be skipped in server responses.

PF.JtfChartDataFormat

This is a structure data contract.

Chart format definition for the JSON table format defined by Client Team

Members

Name	Type	Inherited	Description	Assertion
format	string		In case of the type of the data being "date" or "daterange", one can use the attribute "format" (String) to define how the date should be shown. The options from the moment.js library are supported.
decimal	int?		In case of the type of the data being "number", one can use the attribute "decimal" (Number) to declare the number of decimal points that are shown.
startAndEnd	boolean?		This is an unknown member which exists in the sample code

Note: Members that are null will be skipped in server responses.

PF.JtfChartDataset

This is a structure data contract.

Chart dataset definition for the JSON table format defined by Client Team

Members

Name	Type	Inherited	Description	Assertion
id	UUID		An identification of the column. Must match the id of a column defined in the columns section of the document.	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	JSON		Name of the column. Must not necessarily match the name of the column in the columns section. Will be shown in the "tip" (when hovering over the data in the chart)
description	JSON		Description of the chart dataset visualized as hint (optional, localized)
type	JtfChartDataType		Type of the data
color	string		Color of a dataset
aggregation	JtfMetaColumnOptionsAggregation		Data aggregation
unit	JSON		Unit of the data. Will be shown in the "tip" (when hovering over the data in the chart)
format	JtfChartDataFormat		Format data depending on type

Note: Members that are null will be skipped in server responses.

PF.JtfChartDataType

This is an enumeration data contract.

Chart data type definition for the JSON table format defined by Client Team

Enum values

ID	Description
number	Number type
date	date or date/time type
daterange	Date range type
group	The datatype "group" is used if the data cannot be represented on a continuous axis and there is no clear order
money	Money type

PF.JtfChartPieDonutSettings

This is a structure data contract.

Options for charts/widgets of type "pie" and "donut"

Members

Name	Type	Inherited	Description	Assertion
cutoffPercentage	double?		Slices contributing less than this percentage of the total are combined into a single rest slice (optional)	100 >= x >= 0 (The value, if present, must be between 0 and 100, both inclusive.)
cutoffAmount	int?		Maximum number of slices shown; the remaining slices are combined into a single rest slice (optional)	x >= 0 (The value, if present, must be at least 0.)
sortMode	JtfChartSortMode		Order in which the slices are arranged (optional)

Note: Members that are null will be skipped in server responses.

PF.JtfChartSortMode

This is an enumeration data contract.

Sort order for chart data of the JSON table format defined by Client Team

Enum values

ID	Description
asc	Ascending by value
desc	Descending by value
custom	The order given by the data is kept

PF.JtfChartType

This is an enumeration data contract.

Chart type for the JSON table format defined by Client Team

Enum values

ID	Description
line	Line chart
bar	Bar chart
stackedbar	Stacked bar chart
pie	Pie chart
donut	Donut chart
funnel	Funnel chart
structuredbar	The first dataset is used as benchmark. The other datasets are visualized as stacked bar. The deviation between benchmark and the sum of the stacked bars is calculated automatically
bubble	Bubble chart

PF.JtfMeta

This is a structure data contract.

Metadata for the JSON table format defined by Client Team

Members

Name	Type	Inherited	Description	Assertion
categories	array of JtfMetaCategory		Definition of the categories grouping columns	null;non-null (The array is optional. Each element must not be null.)
columns	array of JtfMetaColumn		Array of column definitions	null;non-null (The array is optional. Each element must not be null.)
options	JSON		Options for visualization or behavior of the grid

Note: Members that are null will be skipped in server responses.

PF.JtfMetaCategory

This is a structure data contract.

Metadata categories for the JSON table format defined by Client Team

Members

Name	Type	Inherited	Description	Assertion
id	UUID		Identification of the category	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.)
label	JSON		Label of the category (localized)

PF.JtfMetaColumn

This is a structure data contract.

Metadata columns for the JSON table format defined by Client Team

Members

Name	Type	Inherited	Description	Assertion
id	UUID		Identification of the column (optional)	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.)
catid	string		ID of the category this column is member of (optional, can be null)
type	JtfMetaColumnDataType		Data type
label	JSON		Name of the column (localized)
options	JtfMetaColumnOptions		Additional options (optional)
format	JSON		Formatting of data (optional, see data types)
style	JSON		Object of CSS styling for this column (optional)

Note: Members that are null will be skipped in server responses.

PF.JtfMetaColumnDataType

This is an enumeration data contract.

Column data types for the JSON table format defined by Client Team

Enum values

ID	Description
boolean	Boolean (true or false)
number	Numbers like 123 or 123.45
string	Quoted string like "Abc"
html	Quoted HTML string like "Abc"
date	ISO formatted date "2023-11-09" or date/time "2023-11-09T16:12:00Z" in UTC
daterange	ISO formatted date range "2023-11-09 - 2023-12-09" or date/time "2023-11-09T16:12:00Z - 2023-12-09T16:12:00Z" in UTC
duration	ISO formatted duration string like "PT0S" or "PT4D"
enum	Object like { "id": "...", "name": "...", "description": "...", "iconRef": "...", "color": "..." }
multienum	Array of objects like { "id": "...", "name": "...", "description": "...", "iconRef": "...", "color": "..." }
money	Object like { "currencyCode": "...", "amount": n.nn }
bars	Represents a list of values as a stacked bar

PF.JtfMetaColumnOptions

This is a structure data contract.

Column options for the JSON table format defined by Client Team

Members

Name	Type	Inherited	Description	Assertion
width	int?		Width of the column (optional, default 100)
fixed	JtfMetaColumnOptionsFixed		Column attached at the left or right side (default, null not attached)
resizable	boolean?		Column resizable (default true)
sortable	boolean?		Column sortable (default true)
groupable	boolean?		Column groupable (default true)
filterable	boolean?		Column filterable (default true)
aggregation	JtfMetaColumnOptionsAggregation		Data aggregations: null: no aggregation, sum: sum up (default)
hidden	boolean?		Whether column is hidden or not

Note: Members that are null will be skipped in server responses.

PF.JtfMetaColumnOptionsAggregation

This is an enumeration data contract.

Column aggregation options for the JSON table format defined by Client Team

Enum values

ID	Description
none	No aggregation
sum	Sum up
min	Minimum
max	Maximum
avg	Average

PF.JtfMetaColumnOptionsFixed

This is an enumeration data contract.

Column fixed options for the JSON table format defined by Client Team

Enum values

ID	Description
left	Column attached at the left side
right	Column attached at the right side

PF.JtfWithCharts

This is a structure data contract.

The JSON table format defined by Client Team to support dynamic table and chart visualization on client

Based on

• Jtf

Members

Name	Type	Inherited	Description	Assertion
mimeType	string	✔️	must be "application/x.pqf.table.json"	matches 'application/x\.pqf\.table\.json' (The value, if present, must match the regular expression shown.)
type	UUID	✔️	Identifier for the table structure defined in the meta section. Documents with identical table structure should have the same type. User settings like sort or filter will be stored per 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.)
id	UUID	✔️	An identification of the document (optional)	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	JSON	✔️	Name of the document (localized)
code	JSON	✔️	Visualized type name of the document (optional, localized)
description	JSON	✔️	Description of the document visualized as hint (optional, localized)
color	color	✔️	Color for the document (optional, localized)
iconRef	JSON	✔️	Icon for the document (optional, localized)
createdAt	datetime	✔️	Timestamp of the document creation (optional, ISO formatted, UTC)
createdBy	string	✔️	Name of the creator (optional)
meta	JtfMeta	✔️	Meta data
data	JSON	✔️	The table content is based on an array of rows. id: Row ID (optional), style: Object of CSS styling for this column (optional), data; Array of values according to the type in the column definitions. It is possible to reduce the row data to the array of values.
hints	JSON	✔️	Hints is an array of information that can be displayed on top of the grid or charts. The items of the array are either directly HTML formatted strings (shown as type info and without a label), or objects
charts	array of JtfChart		The JSON Documents intended for the Table Viewer can be expanded with Charts Definitions. Currently, we support line-, bar-, stackedbar-, pie-, donut-, funnel-, structuredbar- and bubble-charts.	null;non-null (The array is optional. Each element must not be null.)
initialChart	string		defines the id of the initially shown chart

Note: Members that are null will be skipped in server responses.

PF.LicenseFeatures

This is a structure data contract.

Contains all licensed features as string identifiers

Members

Name	Type	Inherited	Description	Assertion
features	array of string		The different string identifiers	null;non-null (The array is optional. Each element must not be null.)

PF.LinearFunction

This is a structure data contract.

A mathematic linear function defined by y = ax + b

Members

Name	Type	Inherited	Description	Assertion
a	double		The first constant
b	double		The second constant

PF.NamedReference

This is a structure data contract.

A reference to a certain object, identified by type and ID with its name (to avoid further requests by client to show the reference)

Based on

• Reference

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 that should be displayed in the user's language

PF.ParallelRequestsLimit

This is a structure data contract.

Contains information about the maximum concurrent requests allowed for this interaction type

Members

Name	Type	Inherited	Description	Assertion
maxParallel	int		The limit of requests running at the same time

PF.Property

This is a structure data contract.

A dynamic property of an object

Members

Name	Type	Inherited	Description	Assertion
key	UUID		A key identifying the property (unique per object instance)	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.)
value	PropertyValue		The value of the dynamic property. Its syntax and semantics depend on the type.

PF.PropertyConstraint

This is a structure data contract.

A specification of a dynamic property: the base type and the arguments that qualify it

Members

Name	Type	Inherited	Description	Assertion
baseType	UUID		The basic data type of the dynamic property	matches '[\w.-]{0,64}' (The value, if present, must match the regular expression shown.)
args	array of PropertyConstraintArg		The arguments of the constraint, in the order they were defined; the same key may occur more than once

PF.PropertyConstraintArg

This is a structure data contract.

One argument of a property constraint

Members

Name	Type	Inherited	Description	Assertion
key	UUID		The name of the argument	non-null & matches '[\w.-]{1,64}' (The value is required and must match the regular expression shown.)
value	JSON		The value of the argument, of whatever JSON type it was given; absent for an argument that is a flag rather than a value

PF.PropertyDefinition

This is a structure data contract.

What a dynamic property is, shared by every client: the object type it belongs to and the semantics of its value

Based on

• Reference

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.)
objectType	UUID		The type of object this property belongs to	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.)
semantics	ValueSemantics		The semantics of the value	non-null (The value is required.)

PF.PropertyPresentation

This is a structure data contract.

How one client presents one dynamic property, in the user's language

Based on

• Reference
• PropertyDefinition

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.)
objectType	UUID	✔️	The type of object this property belongs to	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.)
semantics	ValueSemantics	✔️	The semantics of the value	non-null (The value is required.)
clientId	ClientId		The client this presentation belongs to	non-null (The value is required.)
sortIndex	double		The index to order the properties within this client (the lowest first)
label	string		The label to be shown for that property in the user's language
identifier	string		An identifier that allows the users to identify the property in dropdown lists or similar cases
hint	string		The hint (often a tooltip) to be shown for that property in the user's language
constraint	PropertyConstraint		The constraints (type, number formats, string lengths, ...) this client applies to the property

PF.PropertyPresentationTranslated

This is a structure data contract.

How one client presents one dynamic property, with translations

Based on

• Reference
• PropertyDefinition

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.)
objectType	UUID	✔️	The type of object this property belongs to	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.)
semantics	ValueSemantics	✔️	The semantics of the value	non-null (The value is required.)
clientId	ClientId		The client this presentation belongs to	non-null (The value is required.)
sortIndex	double		The index to order the properties within this client (the lowest first)
label	array of TextTranslation		The label to be shown for that property in different languages	length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
identifier	array of TextTranslation		An identifier that allows the users to identify the property in dropdown lists or similar cases	length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
hint	array of TextTranslation		A hint that will be shown when hovering the ℹ icon	length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
constraint	PropertyConstraint		The constraints (type, number formats, string lengths, ...) this client applies to the property

PF.PropertyValue

This is a structure data contract. It has choice semantics, exactly one member is set, all others are null.

A dynamic property value. Exactly one member must be set, all others must be skipped or set to null.

Members

Name	Type	Inherited	Description	Assertion
string	string		String value
uuid	UUID		UUID value	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.)
int	int?		Integer value
long	long?		Long value
double	double?		Floating point value
bool	boolean?		Boolean value (true or false)
uuidArray	array of UUID		Array of UUIDs	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.)
duration	duration		Duration value
datetime	datetime		Date and time value
date	date		Date value
currencyAmount	CurrencyAmount		Monetary value
uri	URI		URI value
color	color		Color value
json	JSON		Arbitrary JSON object

Note: Members that are null will be skipped in server responses.

PF.Reference

This is a structure data contract.

A reference to a certain object, identified by type and ID

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.)

PF.ReferenceDuration

This is a structure data contract.

Contains a reference to an object with an amount of time belonging to it

Based on

• Reference

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.)
time	duration		The amount of time belonging to the object	non-null (The value is required.)

PF.ReferenceFactor

This is a structure data contract.

Contains a reference to an object with a factor

Based on

• Reference

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.)
factor	double		the factor that applies

PF.ReferenceTimeline

This is a structure data contract.

A timeline that contains references

Members

Name	Type	Inherited	Description	Assertion
from	datetime		The earliest point in time in the timeline	non-null (The value is required.)
until	datetime		The latest point in time in the timeline	non-null (The value is required.)
slots	array of ReferenceTimelineSlot		The slots of the timeline, from latest to earliest. Slots without changes are omitted	non-null;non-null (The array is required. Each element must not be null.)

PF.ReferenceTimelineSlot

This is a structure data contract.

A slot in a timeline, containing the latest reference and number of changes in the slot (from the earlier slot until point in time refenced in until)

Members

Name	Type	Inherited	Description	Assertion
until	datetime		The end of the slot	non-null (The value is required.)
latestReference	Reference		The object that was referenced at the end of the slot; not set, if nothing was referenced then
changeCount	int		The number of events during the slot

PF.ReferenceWithParent

This is a structure data contract.

A reference to a certain object, identified by type and ID, together with a reference to its parent

Based on

• Reference

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	Reference		A reference to a parent (if any)

PF.ReferenceWithParents

This is a structure data contract.

A reference to a certain object, identified by type and ID, together with references to its parents

Based on

• Reference

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.)
parents	array of Reference		References to the parents (if any)	non-null;non-null (The array is required. Each element must not be null.)

PF.Relation

This is a structure data contract.

Describes a relation between two objects. Note that the inherited type member carries the relation type, which is also what a reference to a relation reports (as returned by addExplicitRelation), so that type and ID together are the pair addressing the relation. A relation is additionally announced under a fixed Relation type on the change notification websocket, so a listener is reached whichever of the two it subscribed to; that second spelling never appears in a response body.

Based on

• Reference

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.)
source	Reference		The source part of the (directed) relation	non-null (The value is required.)
target	Reference		The target part of the (directed) relation	non-null (The value is required.)

PF.RelationType

This is a structure data contract.

Describes a relation type which defines the rules of a relation

Based on

• Reference

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		Defines the name which describes the relation seen from the source in the user's language
nameBackward	string		Defines the name which describes the relation seen from the target 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.)

PF.RelationTypeWithConstraints

This is a structure data contract.

Describes a relation type which defines the rules of a relation including its constraints

Based on

• Reference
• RelationType

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	✔️	Defines the name which describes the relation seen from the source in the user's language
nameBackward	string	✔️	Defines the name which describes the relation seen from the target 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.)
explicit	boolean		true, if this kind of relation must be set explicitly, that means it can not be derived from other data
sourceTypes	array of UUID		Defines the possible object types for the source part of the (directed) relation	non-null & length > 0;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 array is required and must contain at least one element. Each element must not be null 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.)
targetTypes	array of UUID		Defines the possible object types for the target part of the (directed) relation	non-null & length > 0;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 array is required and must contain at least one element. Each element must not be null 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.)
sourcesUrl	URI		Defines a URL which may be used to enumerate all possible objects for the source part of the (directed) relation
targetsUrl	URI		Defines a URL which may be used to enumerate all possible objects for the target part of the (directed) relation
sortIndexForward	double		Defines the sort index seen from the source (lowest first)
sortIndexBackward	double		Defines the sort index seen from the target (lowest first)

PF.SessionInfo

This is a structure data contract.

Information about the current session sent to the client over WebSocket

Members

Name	Type	Inherited	Description	Assertion
sessionId	UUID		The session ID of the current session (unique for each WebSocket connection)	non-null & matches '[0-9A-F]{32}' (The value is required and must be a UUID written as 32 upper-case hexadecimal digits.)

PF.SubObject

This is a structure data contract.

Contains a sub object which is part of any other object but has its own access control rights

Based on

• Reference
• VersionReference
• VersionedReference

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	Reference	✔️	Reference to the user that created this object
modifiedAt	datetime	✔️	The point in time when the object was modified
modifiedBy	Reference	✔️	Reference to the user that modified this object
properties	array of Property		Dynamic properties following the property definition (customizable)	null;non-null (The array is optional. Each element must not be null.)

PF.Tenant

This is a structure data contract.

A short description of the current tenant, only publicly available information that can be shown on login screen

Based on

• Reference

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.)
alias	string		The tenant's alias that is part of the starting URL, may be empty
company	string		The tenant's name that will be shown on logon screen
color	color		The color defined in the license
iconRef	URI		The icon defined in the license, 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.)
languages	array of string		The languages available for this tenant, null means no restriction	non-null;non-null (The array is required. Each element must not be null.)

PF.TenantWithAdditionalData

This is a structure data contract.

A short description of the current tenant, with information that may only be available after successful authentication

Based on

• Reference
• Tenant

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.)
alias	string	✔️	The tenant's alias that is part of the starting URL, may be empty
company	string	✔️	The tenant's name that will be shown on logon screen
color	color	✔️	The color defined in the license
iconRef	URI	✔️	The icon defined in the license, 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.)
languages	array of string	✔️	The languages available for this tenant, null means no restriction	non-null;non-null (The array is required. Each element must not be null.)
adminEmail	string		The administrator's / support's email	matches '\|[\w-\.]+@(?:[\w-]+\.)+[\w-]{2,}' (The value, if present, must be empty or an e-mail address.)

PF.TextTranslation

This is a structure data contract.

Contains a string in a certain language

Members

Name	Type	Inherited	Description	Assertion
language	string		The language code (ISO 639-1 with optional country)	non-null & matches '[a-zA-Z]{2}(?:-[a-zA-Z]+)*' (The value is required and must be a language tag such as "de" or "en-GB".)
text	string		The translated text (may contain HTML, depending on context)	non-null (The value is required.)

PF.TimeSlot

This is a structure data contract.

A slot of a timeline. The slots of one answer are sorted, leave no gaps, do not overlap and cover exactly the requested time span. Their widths may differ, even within the same answer

Members

Name	Type	Inherited	Description	Assertion
beg	date		The first day of the slot (inclusive)	non-null (The value is required.)
end	date		The day after the last day of the slot (exclusive)	non-null (The value is required.)
unit	CalendarGranularity		The calendar unit the slot belongs to	non-null (The value is required.)
complete	boolean		true, if the slot covers its calendar unit completely; false, if it has been cut, e.g. by the start or the end of the requested time span
capacity	duration		The capacity of the resource within the slot, as defined by its worktime model (meant for scaling the slot, the times of the slot may exceed it)	non-null (The value is required.)

PF.UndeleteLimit

This is a structure data contract.

Describes how long an object stays in the waste bin for possible undeletion

Members

Name	Type	Inherited	Description	Assertion
days	int		the amount of days

PF.UniqueReadableCodeDef

This is a structure data contract.

Defines a unique readable code to associate to an object type, where the ID of the reference is the ID of that object type and the type of the reference is the fixed pseudo type "UniqueReadableCodeDef"

Based on

• Reference

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.)
pattern	string		Regular expression that defines the code: exactly one group "(\d+)" for the number, optionally surrounded by a literal prefix and suffix which must not contain any of the characters "(", ")", ".", "+", "*" or a backslash. A new code is the highest number currently in use incremented by one, written without leading zeroes, so "P-(\d+)" yields P-1, P-2, ...	non-null & matches '[^().+*\\]*\(\\d\+\)[^().+*\\]*' (The value is required and must match the regular expression shown.)
readOnly	boolean		Read-only flag for the client: if set, the code is always generated by the server and a code supplied by the client is ignored, otherwise the client may set a code of its own as long as it is not in use already and does not skip ahead of the numbers generated so far

PF.Unit

This is a structure data contract.

Information about a unit (time, length, volume, ...); its ID is the unit's sign (often the international abbreviation)

Based on

• Reference

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.)
abbreviation	string		The abbreviation in the user's language
name	string		The name in the user's language

PF.UnitFactor

This is a structure data contract.

Describes the factor that can be applied to values to convert them between different units

Members

Name	Type	Inherited	Description	Assertion
unitId	string		The ID (sign) of the unit	non-null (The value is required.)
factor	fraction		The factor that a value with this unit has to be multiplied with to convert it to the base unit (i.e., 0.01 for cm, if base unit is m)	non-null (The value is required.)

PF.UnitPreference

This is a structure data contract.

Describes the preferred units (order) in a system

Members

Name	Type	Inherited	Description	Assertion
preferredUnitIds	array of string		The IDs (signs) of the preferred units	null;non-null (The array is optional. Each element must not be null.)

PF.ValueSemantics

This is an enumeration data contract.

Semantics of a value (i.e. for dynamic properties)

Enum values

ID	Description
String	String value
UUID	UUID value
Integer	Integer value
Long	Long value
Double	Floating point value
Boolean	Boolean value (true or false)
UUIDArray	Array of UUIDs
Duration	Duration value
DateTime	Date and time value
Date	Date value
CurrencyAmount	Monetary value
URI	URI value
Color	Color value
JSON	JSON value

PF.ValueWithUnit

This is a structure data contract.

Contains a floating point value with a unit

Members

Name	Type	Inherited	Description	Assertion
value	double		The amount
unitId	string		The ID of the unit the value is expressed in, see pf.getUnit	matches '[a-zA-Z]\w{0,31}' (The value, if present, must match the regular expression shown.)

PF.VersionedReference

This is a structure data contract.

A reference to a certain object, identified by type, ID and version, with some additional information

Based on

• Reference
• VersionReference

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	Reference		Reference to the user that created this object
modifiedAt	datetime		The point in time when the object was modified
modifiedBy	Reference		Reference to the user that modified this object

PF.VersionInfo

This is a structure data contract.

A version reference in the version timeline

Members

Name	Type	Inherited	Description	Assertion
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
modifiedAt	datetime		The point in time when the object was modified
modifiedBy	Reference		Reference to the user that modified this object
deleted	boolean		If this flag is set, the referenced object was marked as deleted.

PF.VersionReference

This is a structure data contract.

A reference to a certain version of an object

Based on

• Reference

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.)

PF.VersionTimeline

This is a structure data contract.

A timeline that contains versions

Members

Name	Type	Inherited	Description	Assertion
from	datetime		The earliest point in time in the timeline	non-null (The value is required.)
until	datetime		The latest point in time in the timeline	non-null (The value is required.)
slots	array of VersionTimelineSlot		The slots of the timeline, from latest to earliest. Slots without changes are omitted	non-null;non-null (The array is required. Each element must not be null.)

PF.VersionTimelineSlot

This is a structure data contract.

A slot in a timeline, containing the latest version and number of changes in the slot (from the earlier slot until point in time refenced in until)

Members

Name	Type	Inherited	Description	Assertion
until	datetime		The end of the slot	non-null (The value is required.)
latestVersion	VersionInfo		The latest version (the version that was the current version at 'until')
changeCount	int		The number of events during the slot

PF.WebSocketInfo

This is a structure data contract.

Information about a WebSocket connection

Members

Name	Type	Inherited	Description	Assertion
url	URI		Contains the URL to connect to	non-null (The value is required.)
validUntil	datetime		Contains the validity of the URL	non-null (The value is required.)