API V3 Documentation – CLF

PQFORCE 4.26.6 Preview

Diese Dokumentation gibt es nur auf Englisch.

Vorschau: Diese Dokumentation beschreibt PQFORCE 4.26.6, das noch nicht veröffentlicht ist.

Endpoints

GET /API/V3/CLF/CockpitWidget/:widgetId

Get cockpit widget by ID

HTTP syntax

GET /API/V3/CLF/CockpitWidget/:widgetId
<- application/json : CockpitWidget

JavaScript syntax

Pqf.clf.getCockpitWidget(widgetId) // returns CockpitWidget

Required license

This endpoint requires the following licenses:

  • cockpits

Parameters

Name Type Description Required Assertion
widgetId UUID The desired widget'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: CockpitWidget

POST /API/V3/CLF/CockpitWidget/:widgetId/:objectType/:objectId/Calculate

Calculates a scripted cockpit widget for a given object. Be aware that some permissions apply depending on the source script.

HTTP syntax

POST /API/V3/CLF/CockpitWidget/:widgetId/:objectType/:objectId/Calculate
-> application/json
<- application/json : PF.JtfWithCharts

Required license

This endpoint requires the following licenses:

  • cockpits

Parameters

Name Type Description Required Assertion
widgetId UUID The desired widget'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.)
objectType UUID The reference 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.)
objectId UUID The reference 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 JSON Raw content of mime type application/json ✔️

Result

This endpoint returns the following data: PF.JtfWithCharts

GET /API/V3/CLF/CockpitWidget/:widgetId/WithTranslations

Get cockpit widget with translation by ID

HTTP syntax

GET /API/V3/CLF/CockpitWidget/:widgetId/WithTranslations
<- application/json : CockpitWidgetTranslated

JavaScript syntax

Pqf.clf.getCockpitWidgetTranslated(widgetId) // returns CockpitWidgetTranslated

Required license

This endpoint requires the following licenses:

  • cockpits

Required permission

Requires permission 65E0999B1C0C433382BA5A9BFBB7F231.

Parameters

Name Type Description Required Assertion
widgetId UUID The desired widget'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: CockpitWidgetTranslated

PUT /API/V3/CLF/CockpitWidget/:widgetId/WithTranslations

Stores a cockpit widget with translation. Requires coding license and permission if referring to a JS sandbox.

HTTP syntax

PUT /API/V3/CLF/CockpitWidget/:widgetId/WithTranslations
-> application/json : CockpitWidgetTranslated

JavaScript syntax

Pqf.clf.putCockpitWidgetTranslated(widgetId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

  • cockpits

Required permission

Requires permission 65E0999B1C0C433382BA5A9BFBB7F231.

Parameters

Name Type Description Required Assertion
widgetId UUID The desired widget'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 CockpitWidgetTranslated JSON object of type CockpitWidgetTranslated ✔️

DELETE /API/V3/CLF/CockpitWidget/:widgetId/WithTranslations

Deletes a cockpit widget

HTTP syntax

DELETE /API/V3/CLF/CockpitWidget/:widgetId/WithTranslations

JavaScript syntax

Pqf.clf.delCockpitWidgetTranslated(widgetId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

  • cockpits

Required permission

Requires permission 65E0999B1C0C433382BA5A9BFBB7F231.

Parameters

Name Type Description Required Assertion
widgetId UUID The desired widget'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/CLF/CockpitWidgets

Get references to all cockpit widgets

HTTP syntax

GET /API/V3/CLF/CockpitWidgets?sort=...
<- application/json

JavaScript syntax

Pqf.clf.getAllCockpitWidgets(sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.clf.getAllCockpitWidgets() // returns PF.Reference[]

Required license

This endpoint requires the following licenses:

  • cockpits

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, createdAt, modifiedAt, objectType, widgetType, sortIndex, category. Sorting by createdAt or modifiedAt requires the client settings permission and is ignored without it pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

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

GET /API/V3/CLF/CockpitWidgets/:widgetIds

Get cockpit widgets by IDs

HTTP syntax

GET /API/V3/CLF/CockpitWidgets/:widgetIds
<- application/json

JavaScript syntax

Pqf.clf.getCockpitWidgets(widgetIds) // returns CockpitWidget[]

Required license

This endpoint requires the following licenses:

  • cockpits

Parameters

Name Type Description Required Assertion
widgetIds array of UUID The desired widgets' 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 CockpitWidget

GET /API/V3/CLF/CockpitWidgets/:widgetIds/WithTranslations

Get cockpit widgets with translations by IDs

HTTP syntax

GET /API/V3/CLF/CockpitWidgets/:widgetIds/WithTranslations
<- application/json

JavaScript syntax

Pqf.clf.getCockpitWidgetsTranslated(widgetIds) // returns CockpitWidgetTranslated[]

Required license

This endpoint requires the following licenses:

  • cockpits

Required permission

Requires permission 65E0999B1C0C433382BA5A9BFBB7F231.

Parameters

Name Type Description Required Assertion
widgetIds array of UUID The desired widgets' 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 CockpitWidgetTranslated

POST /API/V3/CLF/Error/Report

Report an error that happened on the client side

HTTP syntax

POST /API/V3/CLF/Error/Report
-> application/json : ErrorReport
<- application/json : PF.Reference

Parameters

Name Type Description Required Assertion
requestJson ErrorReport JSON object of type ErrorReport ✔️

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/CLF/GlobalStore/:storeId

Retrieves some arbitrary JSON value previously stored in a global store

HTTP syntax

GET /API/V3/CLF/GlobalStore/:storeId
<- application/json

JavaScript syntax

Pqf.clf.getGlobalStore(storeId) // returns Object

Parameters

Name Type Description Required Assertion
storeId UUID The ID of the desired global store ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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: JSON

PUT /API/V3/CLF/GlobalStore/:storeId

Stores some arbitrary JSON value in a global store

HTTP syntax

PUT /API/V3/CLF/GlobalStore/:storeId
-> application/json

JavaScript syntax

Pqf.clf.putGlobalStore(storeId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name Type Description Required Assertion
storeId UUID The ID of the desired global store ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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 JSON Raw content of mime type application/json ✔️

DELETE /API/V3/CLF/GlobalStore/:storeId

Deletes a previously stored JSON value from a global store

HTTP syntax

DELETE /API/V3/CLF/GlobalStore/:storeId

JavaScript syntax

Pqf.clf.delGlobalStore(storeId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name Type Description Required Assertion
storeId UUID The ID of the desired global store ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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/CLF/GlobalStores

Retrieves all global store IDs in use

HTTP syntax

GET /API/V3/CLF/GlobalStores
<- application/json : UuidArray

JavaScript syntax

Pqf.clf.getGlobalStoreIds() // returns UuidArray

Result

This endpoint returns the following data: UuidArray

GET /API/V3/CLF/GlobalStores/:storeIds

Retrieves some arbitrary JSON values previously stored in global stores

HTTP syntax

GET /API/V3/CLF/GlobalStores/:storeIds
<- application/json

JavaScript syntax

Pqf.clf.getGlobalStores(storeIds) // returns Object

Parameters

Name Type Description Required Assertion
storeIds array of UUID The IDs of the desired global stores ✔️ 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: JSON

GET /API/V3/CLF/ObjectStore/:objectType/:objectId/:storeId

Get a previously stored JSON value from an object store

HTTP syntax

GET /API/V3/CLF/ObjectStore/:objectType/:objectId/:storeId
<- application/json

JavaScript syntax

Pqf.clf.getObjectStore(objectType, objectId, storeId) // returns Object

Required permission

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

Parameters

Name Type Description Required Assertion
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.)
storeId UUID The ID of the desired object store ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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: JSON

PUT /API/V3/CLF/ObjectStore/:objectType/:objectId/:storeId

Stores a JSON value into an object store

HTTP syntax

PUT /API/V3/CLF/ObjectStore/:objectType/:objectId/:storeId
-> application/json

JavaScript syntax

Pqf.clf.putObjectStore(objectType, objectId, storeId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

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

Parameters

Name Type Description Required Assertion
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.)
storeId UUID The ID of the desired object store ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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 JSON Raw content of mime type application/json ✔️

DELETE /API/V3/CLF/ObjectStore/:objectType/:objectId/:storeId

Deletes a previously stored JSON value from an object store

HTTP syntax

DELETE /API/V3/CLF/ObjectStore/:objectType/:objectId/:storeId

JavaScript syntax

Pqf.clf.delObjectStore(objectType, objectId, storeId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

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

Parameters

Name Type Description Required Assertion
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.)
storeId UUID The ID of the desired object store ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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/CLF/ObjectStores/Ids

Get IDs for previously stored JSON values in the object store

HTTP syntax

GET /API/V3/CLF/ObjectStores/Ids?objectTypes=...&storeIds=...
<- application/json

JavaScript syntax

Pqf.clf.getObjectStoreIds(objectTypes, storeIds) // returns ObjectStoreReference[]

// Overloads for optional parameters
Pqf.clf.getObjectStoreIds(objectTypes) // returns ObjectStoreReference[]
Pqf.clf.getObjectStoreIds() // returns ObjectStoreReference[]

Required permission

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

Parameters

Name Type Description Required Assertion
objectTypes array of UUID Filter by type of the object null;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 optional. 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.)
storeIds array of UUID Filter by ID of the desired object store 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.)

Result

This endpoint returns the following data: array of ObjectStoreReference

POST /API/V3/CLF/ShareData

Shares data to other users, identified by a hashed ID

HTTP syntax

POST /API/V3/CLF/ShareData
-> application/json
<- application/json : SharedDataReference

JavaScript syntax

Pqf.clf.shareData(requestJson) // returns SharedDataReference

Parameters

Name Type Description Required Assertion
requestJson JSON Raw content of mime type application/json ✔️

Result

This endpoint returns the following data: SharedDataReference

GET /API/V3/CLF/SharedData/:dataId

Retrieves shared data, identified by a hashed ID

HTTP syntax

GET /API/V3/CLF/SharedData/:dataId
<- application/json

JavaScript syntax

Pqf.clf.getSharedData(dataId) // returns Object

Parameters

Name Type Description Required Assertion
dataId string the hashed ID ✔️ 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/CLF/TranslationOverrides/:lang

Get customized translations for certain terms

HTTP syntax

GET /API/V3/CLF/TranslationOverrides/:lang
<- application/json

JavaScript syntax

Pqf.clf.getTranslationOverrides(lang) // returns Object

Parameters

Name Type Description Required Assertion
lang string the desired language ✔️ matches '[a-zA-Z]{2}(?:-[a-zA-Z]+)*' (The value must be a language tag such as "de" or "en-GB".)

Result

This endpoint returns the following data: JSON

GET /API/V3/CLF/UserStore/:storeId

Retrieves some arbitrary JSON value previously stored in a user dependent store

HTTP syntax

GET /API/V3/CLF/UserStore/:storeId?userId=...
<- application/json

JavaScript syntax

Pqf.clf.getUserStore(storeId, userId) // returns Object

// Overloads for optional parameters
Pqf.clf.getUserStore(storeId) // returns Object

Required permission

The usage of the optional parameter userId requires the permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name Type Description Required Assertion Required permission
storeId UUID The ID of the desired user store ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
userId UUID the user ID if getting the value for another user matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) 105D1AD65BC5405AA93607A0A20D3703

Result

This endpoint returns the following data: JSON

PUT /API/V3/CLF/UserStore/:storeId

Stores some arbitrary JSON value in a user dependent store

HTTP syntax

PUT /API/V3/CLF/UserStore/:storeId?userId=...
-> application/json

JavaScript syntax

Pqf.clf.putUserStore(storeId, userId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

// Overloads for optional parameters
Pqf.clf.putUserStore(storeId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

The usage of the optional parameter userId requires the permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name Type Description Required Assertion Required permission
storeId UUID The ID of the desired user store ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
userId UUID the user ID if changing the value for another user matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) 105D1AD65BC5405AA93607A0A20D3703
requestJson JSON Raw content of mime type application/json ✔️

DELETE /API/V3/CLF/UserStore/:storeId

Deletes a previously stored JSON value from a user dependent store

HTTP syntax

DELETE /API/V3/CLF/UserStore/:storeId?userId=...

JavaScript syntax

Pqf.clf.delUserStore(storeId, userId) // returns Number - the return code (HTTP 2xx code) of the call

// Overloads for optional parameters
Pqf.clf.delUserStore(storeId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

The usage of the optional parameter userId requires the permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name Type Description Required Assertion Required permission
storeId UUID The ID of the desired user store ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
userId UUID the user ID if deleting the value for another user matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) 105D1AD65BC5405AA93607A0A20D3703

GET /API/V3/CLF/UserStores

Retrieves the IDs of all user store entries in a user dependent store

HTTP syntax

GET /API/V3/CLF/UserStores?userId=...
<- application/json : UuidArray

JavaScript syntax

Pqf.clf.getUserStoreIds(userId) // returns UuidArray

// Overloads for optional parameters
Pqf.clf.getUserStoreIds() // returns UuidArray

Required permission

The usage of the optional parameter userId requires the permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name Type Description Required Assertion Required permission
userId UUID the user ID if getting the value for another user matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) 105D1AD65BC5405AA93607A0A20D3703

Result

This endpoint returns the following data: UuidArray

GET /API/V3/CLF/UserStores/:storeIds

Retrieves some arbitrary JSON values previously stored in user dependent stores

HTTP syntax

GET /API/V3/CLF/UserStores/:storeIds?userId=...
<- application/json

JavaScript syntax

Pqf.clf.getUserStores(storeIds, userId) // returns Object

// Overloads for optional parameters
Pqf.clf.getUserStores(storeIds) // returns Object

Required permission

The usage of the optional parameter userId requires the permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

Name Type Description Required Assertion Required permission
storeIds array of UUID The IDs of the desired user stores ✔️ 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.)
userId UUID the user ID if getting the value for another user matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) 105D1AD65BC5405AA93607A0A20D3703

Result

This endpoint returns the following data: JSON

Data types

CLF.CockpitWidget

This is a structure data contract.

Structure that contains information about cockpit widget

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.)
id UUID ✔️ The ID of the object (often a UUID, but not necessarily) non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
versionId UUID ✔️ A unique identifier for the version, a UUID matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.)
historic boolean ✔️ true, if there is a more recent version of this object; false, if this is the most recent version of this object
createdAt datetime ✔️ The point in time when the object was created
createdBy PF.Reference ✔️ Reference to the user that created this object
modifiedAt datetime ✔️ The point in time when the object was modified
modifiedBy PF.Reference ✔️ Reference to the user that modified this object
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
objectType UUID Type classification 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.)
widgetType UUID Type classification of the widget matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
definition string Contains information about the widget
sortIndex double An index value that indicates the correct order
tags array of string Strings assigned to widgets to mark them null;non-null (The array is optional. Each element must not be null.)
category string Group classification of the widget

CLF.CockpitWidgetTranslated

This is a structure data contract.

Structure that contains information about cockpit widget with translation

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.)
id UUID ✔️ The ID of the object (often a UUID, but not necessarily) non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
versionId UUID ✔️ A unique identifier for the version, a UUID matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.)
historic boolean ✔️ true, if there is a more recent version of this object; false, if this is the most recent version of this object
createdAt datetime ✔️ The point in time when the object was created
createdBy PF.Reference ✔️ Reference to the user that created this object
modifiedAt datetime ✔️ The point in time when the object was modified
modifiedBy PF.Reference ✔️ Reference to the user that modified this object
name array of PF.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 PF.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 PF.IconTranslation ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon (in different languages) null;non-null (The array is optional. Each element must not be null.)
objectType UUID Type classification 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.)
widgetType UUID Type classification of the widget matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
definition string Contains information about the widget
sortIndex double An index value that indicates the correct order
tags array of array of PF.TextTranslation Strings assigned to widgets to mark them with translation null;non-null;non-null (The array is optional. Each element must not be null. Each element at nesting level 2 must not be null.)
category array of PF.TextTranslation Group classification of the widget with translation null;non-null (The array is optional. Each element must not be null.)
sandboxId UUID A reference to JavaScript code returning JTF data matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)

CLF.ErrorReport

This is a structure data contract.

Describes an error that happened on web client, agent or other API consumer's side

Members

Name Type Inherited Description Assertion
type string The type of error that happened
method string The HTTP method of the call that was involved matches '.{0,8}' (The value, if present, must be a single line of at most 8 characters.)
url URI The URL of the call that was involved
statusCode string The status code of the call that was involved matches '.{0,8}' (The value, if present, must be a single line of at most 8 characters.)
message string Describes the error that happened
clientVersion string The exact version number of the client
details string More details about the error, i.e. a stack trace

CLF.ObjectStoreReference

This is a structure data contract.

A reference to an object's store

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.)
id UUID ✔️ The ID of the object (often a UUID, but not necessarily) non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
storeId UUID The object store ID 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.)

CLF.SharedDataReference

This is a structure data contract.

A reference to shared data, identified by type and ID

Members

Name Type Inherited Description Assertion
type UUID The type of the object (used for change notifications) matches 'SharedData' (The value, if present, must be exactly "SharedData".)
id string The ID of the object (base 32 or base62 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).)

CLF.UuidArray

This is a structure data contract.

Array of Universally Unique Identifiers (UUIDs)

Members

Name Type Inherited Description Assertion
uuids array of UUID UUIDs non-null;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The array is required. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
↑

Benachrichtigung

Portal-Tour

Eine geführte Tour zeigt Ihnen die Seite Schritt für Schritt: Sie hebt jeweils ein Bedienelement hervor und erklärt, wofür es da ist. Sie können jederzeit abbrechen und später weitermachen.

    Touren können jederzeit erneut gestartet werden.

    Versionshinweise wurden automatisch ins Deutsche übersetzt.