API V3 Documentation – CLS
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/CLS/ClassificationSchema/:schemaId
Get a specific classification schema by its ID
HTTP syntax
GET /API/V3/CLS/ClassificationSchema/:schemaId
<- application/json : ClassificationSchema JavaScript syntax
Pqf.cls.getSchema(schemaId) // returns ClassificationSchemaParameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
schemaId |
UUID | the classification schema's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ClassificationSchema
GET /API/V3/CLS/ClassificationSchema/:schemaId/WithTranslations
Get a specific classification schema by its ID with translations
HTTP syntax
GET /API/V3/CLS/ClassificationSchema/:schemaId/WithTranslations
<- application/json : ClassificationSchemaTranslated JavaScript syntax
Pqf.cls.getSchemaTranslated(schemaId) // returns ClassificationSchemaTranslated Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
schemaId |
UUID | the classification schema's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ClassificationSchemaTranslated
PUT /API/V3/CLS/ClassificationSchema/:schemaId/WithTranslations
Create or update a classification schema
HTTP syntax
PUT /API/V3/CLS/ClassificationSchema/:schemaId/WithTranslations
-> application/json : ClassificationSchemaTranslated JavaScript syntax
Pqf.cls.putSchemaTranslated(schemaId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
schemaId |
UUID | The classification schema's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ClassificationSchemaTranslated | JSON object of type ClassificationSchemaTranslated | ✔️ |
DELETE /API/V3/CLS/ClassificationSchema/:schemaId/WithTranslations
Delete a classification schema
HTTP syntax
DELETE /API/V3/CLS/ClassificationSchema/:schemaId/WithTranslations JavaScript syntax
Pqf.cls.delSchemaTranslated(schemaId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
schemaId |
UUID | The classification schema's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/CLS/ObjectType/:typeId/ClassificationSchemas
Get all classification schemas for a given object type
HTTP syntax
GET /API/V3/CLS/ObjectType/:typeId/ClassificationSchemas
<- application/json JavaScript syntax
Pqf.cls.getSchemasForType(typeId) // returns ClassificationSchema[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
typeId |
UUID | the object's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ClassificationSchema
Data types
CLS.Classification
This is a structure data contract.
Contains a classification of a specific object including the ratings
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
classificationSchemaId |
UUID | A reference to the classification scheme | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
data |
array of ClassificationData | The different ratings for each attribute | non-null;non-null (The array is required. Each element must not be null.) |
|
classificationId |
UUID | A reference to the resulting classification depending on the ratings | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
score |
double? | A numeric value containing the score |
CLS.ClassificationAttribute
This is a structure data contract.
Describes an attribute which will be rated. Multiple attribute ratings result in an overall rating which will be represented by the classification
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
weight |
double | The weight that will be applied to calculate the weighted average which will be used to determine the resulting classification | w >= 0 (The value must be at least 0.) |
|
values |
array of ClassificationAttributeValue | The possible values that may be selected to rate this attribute | null;non-null (The array is optional. Each element must not be null.) |
CLS.ClassificationAttributeTranslated
This is a structure data contract.
Describes an attribute which will be rated, with translations. Multiple attribute ratings result in an overall rating which will be represented by the classification
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
weight |
double | The weight that will be applied to calculate the weighted average which will be used to determine the resulting classification | w >= 0 (The value must be at least 0.) |
|
values |
array of ClassificationAttributeValueTranslated | The possible values that may be selected to rate this attribute | null;non-null (The array is optional. Each element must not be null.) |
CLS.ClassificationAttributeValue
This is a structure data contract.
A value that might be selected to rate a classification attribute
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
points |
double | The amount of points that will be used to calculate the weighted average which will be used to determine the resulting classification |
CLS.ClassificationAttributeValueTranslated
This is a structure data contract.
A value that might be selected to rate a classification attribute, with translations
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
points |
double | The amount of points that will be used to calculate the weighted average which will be used to determine the resulting classification |
CLS.ClassificationClass
This is a structure data contract.
A resulting classification that is determined by categorizing the weighted average of all attribute's ratings
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
minPoints |
double | The minimum points of weighted average that is needed to be categorized as this classification |
CLS.ClassificationClassTranslated
This is a structure data contract.
A resulting classification that is determined by categorizing the weighted average of all attribute's ratings, with translations
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
minPoints |
double | The minimum points of weighted average that is needed to be categorized as this classification |
CLS.ClassificationData
This is a structure data contract.
Contains a rating of any attribute estimated by the user
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
attributeId |
UUID | The referenced attribute | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
valueId |
UUID | The estimated value | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
remark |
string | A descriptive text where the user may explain his/her estimation |
CLS.ClassificationPresentation
This is an enumeration data contract.
Defines the different attributes that may be used by any visualizing system to show classifications
Enum values
| ID | Description |
|---|---|
HideWeights |
Does not show weights in order to hide matrix classification logic |
HideValues |
Does not show values in order to hide matrix classification logic |
WeightedSpider |
Shows the spider diagram with weighted axes |
CLS.ClassificationSchema
This is a structure data contract.
Describes how a classification is determined
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
objectType |
UUID | The type of object for which the classification schema is defined | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
classes |
array of ClassificationClass | The different classifications that may result | null;non-null (The array is optional. Each element must not be null.) |
|
attributes |
array of ClassificationAttribute | The different attributes that must be rated to receive a classification | null;non-null (The array is optional. Each element must not be null.) |
|
sortIndex |
double | An index value that indicates the correct order | ||
presentation |
array of ClassificationPresentation | Different options that define how the results are presented | ||
precision |
int | Defines the number of digits after the decimal point to be shown | 16 >= n >= 0 (The value must be between 0 and 16, both inclusive.) |
|
customCalculationRule |
string | Contains a JavaScript snippet for calculating the score of the classification. The attribute values are provided as object "attributes", containing objects with value information (id and points). Set to null to for weighted standard calculation |
CLS.ClassificationSchemaTranslated
This is a structure data contract.
Describes how a classification is determined, with translations
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
objectType |
UUID | The type of object for which the classification schema is defined | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
classes |
array of ClassificationClassTranslated | The different classifications that may result | null;non-null (The array is optional. Each element must not be null.) |
|
attributes |
array of ClassificationAttributeTranslated | The different attributes that must be rated to receive a classification | null;non-null (The array is optional. Each element must not be null.) |
|
sortIndex |
double | An index value that indicates the correct order | ||
presentation |
array of ClassificationPresentation | Different options that define how the results are presented | ||
precision |
int | Defines the number of digits after the decimal point to be shown | 16 >= n >= 0 (The value must be between 0 and 16, both inclusive.) |
|
customCalculationRule |
string | Contains a JavaScript snippet for calculating the score of the classification. The attribute values are provided as object "attributes", containing objects with value information (id and points). Set to null to for weighted standard calculation |