API V3 Documentation – RSK

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/RSK/Project/:projectId/Risks

Retrieves project risks of a project

HTTP syntax

GET /API/V3/RSK/Project/:projectId/Risks?sort=...
<- application/json

JavaScript syntax

Pqf.rsk.getProjectRisksOfProject(projectId, sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.rsk.getProjectRisksOfProject(projectId) // returns PF.ReferenceWithParent[]

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission READ on object of type Project and ID specified in parameter projectId.

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

Parameters

Name Type Description Required Assertion
projectId UUID The project's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectId, indicatorDimensionId, occurrenceProbability, occurrenceProbabilityClassificationId, extentOfLoss, extentOfLossClassificationId, riskRating, riskRatingClassificationId and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

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

POST /API/V3/RSK/Project/:projectId/Risks/Add

Adds a project risk to a project

HTTP syntax

POST /API/V3/RSK/Project/:projectId/Risks/Add?name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.rsk.addProjectRisk(projectId, name, code, description, color, iconRef) // returns PF.Reference

// Overloads for optional parameters
Pqf.rsk.addProjectRisk(projectId, name, code, description, color) // returns PF.Reference
Pqf.rsk.addProjectRisk(projectId, name, code, description) // returns PF.Reference
Pqf.rsk.addProjectRisk(projectId, name, code) // returns PF.Reference
Pqf.rsk.addProjectRisk(projectId, name) // returns PF.Reference
Pqf.rsk.addProjectRisk(projectId) // returns PF.Reference

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission CREATE on object of type ProjectRisk.

Parameters

Name Type Description Required Assertion
projectId UUID The project's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
name string The name of the new project risk, 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 project risk, may contain HTML
color color The color of the new project risk
iconRef URI The icon of the new project risk, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/RSK/ProjectPortfolio/:projectPortfolioId/Risks

Retrieves project risks of projects of a portfolio

HTTP syntax

GET /API/V3/RSK/ProjectPortfolio/:projectPortfolioId/Risks?sort=...
<- application/json

JavaScript syntax

Pqf.rsk.getProjectRisksOfProjectPortfolio(projectPortfolioId, sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.rsk.getProjectRisksOfProjectPortfolio(projectPortfolioId) // returns PF.ReferenceWithParent[]

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission READ on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.

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

Parameters

Name Type Description Required Assertion
projectPortfolioId UUID The project portfolio ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectId, indicatorDimensionId, occurrenceProbability, occurrenceProbabilityClassificationId, extentOfLoss, extentOfLossClassificationId, riskRating, riskRatingClassificationId and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

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

GET /API/V3/RSK/ProjectRisk/:projectRiskId

Get a project risk

HTTP syntax

GET /API/V3/RSK/ProjectRisk/:projectRiskId
<- application/json : ProjectRisk

JavaScript syntax

Pqf.rsk.getProjectRisk(projectRiskId) // returns ProjectRisk

Other endpoints for objects of type project risk

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

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission READ on object of type ProjectRisk and ID specified in parameter projectRiskId.

Parameters

Name Type Description Required Assertion
projectRiskId UUID The project risk'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: ProjectRisk

PUT /API/V3/RSK/ProjectRisk/:projectRiskId

Update an existing project risk

HTTP syntax

PUT /API/V3/RSK/ProjectRisk/:projectRiskId
-> application/json : ProjectRisk

JavaScript syntax

Pqf.rsk.putProjectRisk(projectRiskId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type project risk

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

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission UPDATE or CREATE on object of type ProjectRisk and ID specified in parameter projectRiskId.

Parameters

Name Type Description Required Assertion
projectRiskId UUID The project risk'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 ProjectRisk JSON object of type ProjectRisk ✔️

DELETE /API/V3/RSK/ProjectRisk/:projectRiskId

Delete a project risk

HTTP syntax

DELETE /API/V3/RSK/ProjectRisk/:projectRiskId

JavaScript syntax

Pqf.rsk.delProjectRisk(projectRiskId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type project risk

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

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission DELETE on object of type ProjectRisk and ID specified in parameter projectRiskId.

Parameters

Name Type Description Required Assertion
projectRiskId UUID The project risk'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/RSK/ProjectRisk/:projectRiskId/Identification

Get a project risk identification

HTTP syntax

GET /API/V3/RSK/ProjectRisk/:projectRiskId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.rsk.getProjectRiskIdentification(projectRiskId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.rsk.getProjectRiskIdentification(projectRiskId) // returns PF.IdentificationExtended

Other endpoints for objects of type project risk

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

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission IDENTIFY on object of type ProjectRisk and ID specified in parameter projectRiskId.

Parameters

Name Type Description Required Assertion Default, if omitted
projectRiskId UUID The project risk's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: PF.IdentificationExtended

GET /API/V3/RSK/ProjectRisk/:projectRiskId/Timeline

Get a project risk's version timeline

HTTP syntax

GET /API/V3/RSK/ProjectRisk/:projectRiskId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.rsk.getProjectRiskTimeline(projectRiskId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.rsk.getProjectRiskTimeline(projectRiskId, limit, until, from) // returns PF.VersionTimeline
Pqf.rsk.getProjectRiskTimeline(projectRiskId, limit, until) // returns PF.VersionTimeline
Pqf.rsk.getProjectRiskTimeline(projectRiskId, limit) // returns PF.VersionTimeline
Pqf.rsk.getProjectRiskTimeline(projectRiskId) // returns PF.VersionTimeline

Other endpoints for objects of type project risk

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

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission READ on object of type ProjectRisk and ID specified in parameter projectRiskId.

Parameters

Name Type Description Required Assertion
projectRiskId UUID The project risk's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
limit int? Limits the number of slots i > 0 (The value, if present, must be greater than 0.)
until datetime Latest date of the timeline
from datetime Earliest date of the timeline
granularity PF.CalendarGranularity The granularity of the timeline

Result

This endpoint returns the following data: PF.VersionTimeline

GET /API/V3/RSK/ProjectRisk/:projectRiskId/Version/:versionId

Get a project risk's specific (historic) version

HTTP syntax

GET /API/V3/RSK/ProjectRisk/:projectRiskId/Version/:versionId
<- application/json : ProjectRisk

JavaScript syntax

Pqf.rsk.getProjectRiskVersion(projectRiskId, versionId) // returns ProjectRisk

Other endpoints for objects of type project risk

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

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission READ on object of type ProjectRisk and ID specified in parameter projectRiskId.

Parameters

Name Type Description Required Assertion
projectRiskId UUID The project risk's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
versionId UUID the version to retrieve ✔️ matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.)

Result

This endpoint returns the following data: ProjectRisk

GET /API/V3/RSK/ProjectRisk/:projectRiskId/WithHistory/:history

Retrieves a project risk (with history)

HTTP syntax

GET /API/V3/RSK/ProjectRisk/:projectRiskId/WithHistory/:history?simplify=...
<- application/json : ProjectRiskWithHistory

JavaScript syntax

Pqf.rsk.getProjectRiskWithHistory(projectRiskId, history, simplify) // returns ProjectRiskWithHistory

// Overloads for optional parameters
Pqf.rsk.getProjectRiskWithHistory(projectRiskId, history) // returns ProjectRiskWithHistory

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission READ on object of type ProjectRisk and ID specified in parameter projectRiskId.

Parameters

Name Type Description Required Assertion
projectRiskId UUID The ID of the risk ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
history RiskHistoryGranularity The size of the history that should be retrieved ✔️
simplify PF.CalendarGranularity Reduces the history entries by combining entries that are close to each other

Result

This endpoint returns the following data: ProjectRiskWithHistory

GET /API/V3/RSK/ProjectRisks

Retrieves all project risks

HTTP syntax

GET /API/V3/RSK/ProjectRisks?sort=...
<- application/json

JavaScript syntax

Pqf.rsk.getAllProjectRisks(sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.rsk.getAllProjectRisks() // returns PF.ReferenceWithParent[]

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

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

Parameters

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

Result

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

GET /API/V3/RSK/ProjectRisks/:projectRiskIds

Get multiple project risks

HTTP syntax

GET /API/V3/RSK/ProjectRisks/:projectRiskIds
<- application/json

JavaScript syntax

Pqf.rsk.getProjectRisks(projectRiskIds) // returns ProjectRisk[]

Other endpoints for objects of type project risk

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

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission READ on object of type ProjectRisk and ID in specified in parameter projectRiskIds.

Parameters

Name Type Description Required Assertion
projectRiskIds array of UUID The project risk 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 ProjectRisk

GET /API/V3/RSK/ProjectRisks/:projectRiskIds/Identification

Get multiple project risk identifications

HTTP syntax

GET /API/V3/RSK/ProjectRisks/:projectRiskIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.rsk.getProjectRiskIdentifications(projectRiskIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.rsk.getProjectRiskIdentifications(projectRiskIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type project risk

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

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission IDENTIFY on object of type ProjectRisk and ID in specified in parameter projectRiskIds.

Parameters

Name Type Description Required Assertion Default, if omitted
projectRiskIds array of UUID The project risk IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
deleted boolean Allow deleted objects to be returned false

Result

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

GET /API/V3/RSK/ProjectRisks/:projectRiskIds/WithHistory/:history

Retrieves some project risks (with history) specified by their IDs

HTTP syntax

GET /API/V3/RSK/ProjectRisks/:projectRiskIds/WithHistory/:history?simplify=...
<- application/json

JavaScript syntax

Pqf.rsk.getProjectRisksWithHistory(projectRiskIds, history, simplify) // returns ProjectRiskWithHistory[]

// Overloads for optional parameters
Pqf.rsk.getProjectRisksWithHistory(projectRiskIds, history) // returns ProjectRiskWithHistory[]

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission READ on object of type ProjectRisk and ID in specified in parameter projectRiskIds.

Parameters

Name Type Description Required Assertion
projectRiskIds array of UUID The IDs of the risks ✔️ 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.)
history RiskHistoryGranularity The size of the history that should be retrieved ✔️
simplify PF.CalendarGranularity Reduces the history entries by combining entries that are close to each other

Result

This endpoint returns the following data: array of ProjectRiskWithHistory

POST /API/V3/RSK/RiskMatrix/Calculate

Calculates a risk

HTTP syntax

POST /API/V3/RSK/RiskMatrix/Calculate
-> application/json : RiskRating
<- application/json : RiskRating

JavaScript syntax

Pqf.rsk.calculateRisk(requestJson) // returns RiskRating

Required license

This endpoint requires the following licenses:

  • riskmanagement

Parameters

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

Result

This endpoint returns the following data: RiskRating

GET /API/V3/RSK/RiskMatrix/Definition

Retrieves the risk matrix definition

HTTP syntax

GET /API/V3/RSK/RiskMatrix/Definition
<- application/json : RiskMatrixDefinition

JavaScript syntax

Pqf.rsk.getRiskMatrixDefinition() // returns RiskMatrixDefinition

Required license

This endpoint requires the following licenses:

  • riskmanagement

Result

This endpoint returns the following data: RiskMatrixDefinition

GET /API/V3/RSK/RiskMatrix/Definition/WithTranslations

Retrieves the risk matrix definition in all available languages

HTTP syntax

GET /API/V3/RSK/RiskMatrix/Definition/WithTranslations
<- application/json : RiskMatrixDefinitionTranslated

JavaScript syntax

Pqf.rsk.getRiskMatrixDefinitionTranslated() // returns RiskMatrixDefinitionTranslated

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Result

This endpoint returns the following data: RiskMatrixDefinitionTranslated

PUT /API/V3/RSK/RiskMatrix/Definition/WithTranslations

Sets the risk matrix definition with translations

HTTP syntax

PUT /API/V3/RSK/RiskMatrix/Definition/WithTranslations
-> application/json : RiskMatrixDefinitionTranslated

JavaScript syntax

Pqf.rsk.putRiskMatrixDefinitionTranslated(requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

  • riskmanagement

Required permission

Requires permission 105D1AD65BC5405AA93607A0A20D3703.

Parameters

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

Data types

RSK.ProjectRisk

This is a structure data contract.

Describes a project risk without history

Based on

Members

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

RSK.ProjectRiskWithHistory

This is a structure data contract.

Describes a project risk with history

Based on

Members

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

RSK.Risk

This is a structure data contract.

Describes a risk with rating but without historic data

Based on

Members

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

RSK.RiskClassification

This is a structure data contract.

A classification for a risk rating, occurrence probability or extent of loss

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.)
id UUID ✔️ The ID of the object (often a UUID, but not necessarily) non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
limit double The lowest value for which this classification will be assigned

RSK.RiskClassificationTranslated

This is a structure data contract.

A classification for a risk rating, occurrence probability or extent of loss, in all available languages

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.)
id UUID ✔️ The ID of the object (often a UUID, but not necessarily) non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
name array of PF.TextTranslation ✔️ The name of the object in different languages length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description array of PF.TextTranslation ✔️ A descriptive text about the object, may contain HTML (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef array of PF.IconTranslation ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
limit double The lowest value for which this classification will be assigned

RSK.RiskHistoryGranularity

This is an enumeration data contract.

A time unit for risk history

Enum values

ID Description
Day A day
Week A week
Month A month
Year A year
Decade A decade

RSK.RiskMatrixAssignment

This is a structure data contract.

The calculated classifications of a risk according to the matrix definition

Members

Name Type Inherited Description Assertion
occurrenceProbabilityClassificationId UUID The classification of the occurrence probability matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
extentOfLossClassificationId UUID The classification of the extent of loss matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
riskRatingClassificationId UUID The classification of the risk rating matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)

RSK.RiskMatrixDefinition

This is a structure data contract.

Contains the definition of a risk matrix (different classes for the dimensions)

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.)
id UUID ✔️ The ID of the object (often a UUID, but not necessarily) non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
occurrenceProbabilityClassifications array of RiskClassification The possible classifications of the occurrence probability non-null;non-null (The array is required. Each element must not be null.)
extentOfLossClassifications array of RiskClassification The possible classifications of the extent of loss non-null;non-null (The array is required. Each element must not be null.)
riskRatingClassifications array of RiskClassification The possible classifications of the risk rating non-null;non-null (The array is required. Each element must not be null.)
fields array of RiskMatrixAssignment The fields of the matrix non-null;non-null (The array is required. Each element must not be null.)
customCalculationRule string A JavaScript based rule to calculate a risk rating

RSK.RiskMatrixDefinitionTranslated

This is a structure data contract.

Contains the definition of a risk matrix in all available languages (different classes for the dimensions)

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.)
id UUID ✔️ The ID of the object (often a UUID, but not necessarily) non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
name array of PF.TextTranslation ✔️ The name of the object in different languages length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description array of PF.TextTranslation ✔️ A descriptive text about the object, may contain HTML (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef array of PF.IconTranslation ✔️ value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon (in different languages) length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.)
occurrenceProbabilityClassifications array of RiskClassificationTranslated The possible classifications of the occurrence probability non-null;non-null (The array is required. Each element must not be null.)
extentOfLossClassifications array of RiskClassificationTranslated The possible classifications of the extent of loss non-null;non-null (The array is required. Each element must not be null.)
riskRatingClassifications array of RiskClassificationTranslated The possible classifications of the risk rating non-null;non-null (The array is required. Each element must not be null.)
fields array of RiskMatrixAssignment The fields of the matrix null;non-null (The array is optional. Each element must not be null.)
customCalculationRule string A JavaScript based rule to calculate a risk rating

RSK.RiskRating

This is a structure data contract.

Describes how a risk is rated

Members

Name Type Inherited Description Assertion
occurrenceProbability double The probability of the occurrence of an event
occurrenceProbabilityClassificationId UUID The classification of the probability of the occurrence of an event matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
extentOfLoss double The amount of damage in case of an event
extentOfLossClassificationId UUID The classification of the amount of damage in case of an event matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
riskRating double The rating of the risk (the product of occurrence probability and extent of loss)
riskRatingClassificationId UUID The classification of the rating of the risk matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)

RSK.RiskRatingHistoric

This is a structure data contract.

A historic value of a risk rating

Members

Name Type Inherited Description Assertion
at datetime The point in time when this rating was valid
rating RiskRating The rating
↑

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.