API V3 Documentation – STG

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/STG/FieldOfAction/:fieldOfActionId

Get a field of action

HTTP syntax

GET /API/V3/STG/FieldOfAction/:fieldOfActionId
<- application/json : FieldOfAction

JavaScript syntax

Pqf.stg.getFieldOfAction(fieldOfActionId) // returns FieldOfAction

Other endpoints for objects of type field ofaction

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type FieldOfAction and ID specified in parameter fieldOfActionId.

Parameters

Name Type Description Required Assertion
fieldOfActionId UUID The field of action'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: FieldOfAction

PUT /API/V3/STG/FieldOfAction/:fieldOfActionId

Update an existing field of action

HTTP syntax

PUT /API/V3/STG/FieldOfAction/:fieldOfActionId
-> application/json : FieldOfAction

JavaScript syntax

Pqf.stg.putFieldOfAction(fieldOfActionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type field ofaction

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission UPDATE or CREATE on object of type FieldOfAction and ID specified in parameter fieldOfActionId.

Parameters

Name Type Description Required Assertion
fieldOfActionId UUID The field of action'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 FieldOfAction JSON object of type FieldOfAction ✔️

DELETE /API/V3/STG/FieldOfAction/:fieldOfActionId

Delete a field of action

HTTP syntax

DELETE /API/V3/STG/FieldOfAction/:fieldOfActionId

JavaScript syntax

Pqf.stg.delFieldOfAction(fieldOfActionId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type field ofaction

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission DELETE on object of type FieldOfAction and ID specified in parameter fieldOfActionId.

Parameters

Name Type Description Required Assertion
fieldOfActionId UUID The field of action'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/STG/FieldOfAction/:fieldOfActionId/Identification

Get a field of action identification

HTTP syntax

GET /API/V3/STG/FieldOfAction/:fieldOfActionId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.stg.getFieldOfActionIdentification(fieldOfActionId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.stg.getFieldOfActionIdentification(fieldOfActionId) // returns PF.IdentificationExtended

Other endpoints for objects of type field ofaction

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission IDENTIFY on object of type FieldOfAction and ID specified in parameter fieldOfActionId.

Parameters

Name Type Description Required Assertion Default, if omitted
fieldOfActionId UUID The field of action'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/STG/FieldOfAction/:fieldOfActionId/Objectives

Returns references to all objectives belonging to a specific field of action

HTTP syntax

GET /API/V3/STG/FieldOfAction/:fieldOfActionId/Objectives?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getObjectivesOfFieldOfAction(fieldOfActionId, sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.stg.getObjectivesOfFieldOfAction(fieldOfActionId) // returns PF.ReferenceWithParent[]

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type FieldOfAction and ID specified in parameter fieldOfActionId.

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

Parameters

Name Type Description Required Assertion
fieldOfActionId UUID The field of action'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, fieldOfActionId, weight, progress, sortIndex 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/STG/FieldOfAction/:fieldOfActionId/Objectives/Add

Adds an objective

HTTP syntax

POST /API/V3/STG/FieldOfAction/:fieldOfActionId/Objectives/Add?copy=...&copyRelations=...&name=...&code=...&description=...&color=...&iconRef=...&sortIndex=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.stg.addObjective(fieldOfActionId, copy, copyRelations, name, code, description, color, iconRef, sortIndex) // returns PF.Reference

// Overloads for optional parameters
Pqf.stg.addObjective(fieldOfActionId, copy, copyRelations, name, code, description, color, iconRef) // returns PF.Reference
Pqf.stg.addObjective(fieldOfActionId, copy, copyRelations, name, code, description, color) // returns PF.Reference
Pqf.stg.addObjective(fieldOfActionId, copy, copyRelations, name, code, description) // returns PF.Reference
Pqf.stg.addObjective(fieldOfActionId, copy, copyRelations, name, code) // returns PF.Reference
Pqf.stg.addObjective(fieldOfActionId, copy, copyRelations, name) // returns PF.Reference
Pqf.stg.addObjective(fieldOfActionId, copy, copyRelations) // returns PF.Reference
Pqf.stg.addObjective(fieldOfActionId, copy) // returns PF.Reference
Pqf.stg.addObjective(fieldOfActionId) // returns PF.Reference

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission CREATE on object of type Objective.

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

Parameters

Name Type Description Required Assertion Default, if omitted
fieldOfActionId UUID the field of action'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.)
copy UUID use an existing objective as template matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
copyRelations boolean When copying (copy is set), also copy relations false
name string The name of the new objective, 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 objective, may contain HTML
color color The color of the new objective
iconRef URI The icon of the new objective, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
sortIndex double The sort index to use 0

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/STG/FieldOfAction/:fieldOfActionId/Timeline

Get a field of action's version timeline

HTTP syntax

GET /API/V3/STG/FieldOfAction/:fieldOfActionId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.stg.getFieldOfActionTimeline(fieldOfActionId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.stg.getFieldOfActionTimeline(fieldOfActionId, limit, until, from) // returns PF.VersionTimeline
Pqf.stg.getFieldOfActionTimeline(fieldOfActionId, limit, until) // returns PF.VersionTimeline
Pqf.stg.getFieldOfActionTimeline(fieldOfActionId, limit) // returns PF.VersionTimeline
Pqf.stg.getFieldOfActionTimeline(fieldOfActionId) // returns PF.VersionTimeline

Other endpoints for objects of type field ofaction

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type FieldOfAction and ID specified in parameter fieldOfActionId.

Parameters

Name Type Description Required Assertion
fieldOfActionId UUID The field of action'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/STG/FieldOfAction/:fieldOfActionId/Version/:versionId

Get a field of action's specific (historic) version

HTTP syntax

GET /API/V3/STG/FieldOfAction/:fieldOfActionId/Version/:versionId
<- application/json : FieldOfAction

JavaScript syntax

Pqf.stg.getFieldOfActionVersion(fieldOfActionId, versionId) // returns FieldOfAction

Other endpoints for objects of type field ofaction

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type FieldOfAction and ID specified in parameter fieldOfActionId.

Parameters

Name Type Description Required Assertion
fieldOfActionId UUID The field of action'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: FieldOfAction

GET /API/V3/STG/FieldsOfAction

Returns references to all fields of action

HTTP syntax

GET /API/V3/STG/FieldsOfAction?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getAllFieldsOfAction(sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.stg.getAllFieldsOfAction() // returns PF.ReferenceWithParent[]

Required license

This endpoint requires the following licenses:

  • strategymodule

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, visionId, achievementRate, progress, sortIndex 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/STG/FieldsOfAction/:fieldOfActionIds

Get multiple field of actions

HTTP syntax

GET /API/V3/STG/FieldsOfAction/:fieldOfActionIds
<- application/json

JavaScript syntax

Pqf.stg.getFieldsOfAction(fieldOfActionIds) // returns FieldOfAction[]

Other endpoints for objects of type field ofaction

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type FieldOfAction and ID in specified in parameter fieldOfActionIds.

Parameters

Name Type Description Required Assertion
fieldOfActionIds array of UUID The field of action 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 FieldOfAction

GET /API/V3/STG/FieldsOfAction/:fieldOfActionIds/Identification

Get multiple field of action identifications

HTTP syntax

GET /API/V3/STG/FieldsOfAction/:fieldOfActionIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.stg.getFieldOfActionIdentifications(fieldOfActionIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.stg.getFieldOfActionIdentifications(fieldOfActionIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type field ofaction

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission IDENTIFY on object of type FieldOfAction and ID in specified in parameter fieldOfActionIds.

Parameters

Name Type Description Required Assertion Default, if omitted
fieldOfActionIds array of UUID The field of action 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/STG/Objective/:objectiveId

Get a objective

HTTP syntax

GET /API/V3/STG/Objective/:objectiveId
<- application/json : Objective

JavaScript syntax

Pqf.stg.getObjective(objectiveId) // returns Objective

Other endpoints for objects of type objective

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Objective and ID specified in parameter objectiveId.

Parameters

Name Type Description Required Assertion
objectiveId UUID The objective'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: Objective

PUT /API/V3/STG/Objective/:objectiveId

Update an existing objective

HTTP syntax

PUT /API/V3/STG/Objective/:objectiveId
-> application/json : Objective

JavaScript syntax

Pqf.stg.putObjective(objectiveId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type objective

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission UPDATE or CREATE on object of type Objective and ID specified in parameter objectiveId.

Parameters

Name Type Description Required Assertion
objectiveId UUID The objective'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 Objective JSON object of type Objective ✔️

DELETE /API/V3/STG/Objective/:objectiveId

Delete a objective

HTTP syntax

DELETE /API/V3/STG/Objective/:objectiveId

JavaScript syntax

Pqf.stg.delObjective(objectiveId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type objective

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission DELETE on object of type Objective and ID specified in parameter objectiveId.

Parameters

Name Type Description Required Assertion
objectiveId UUID The objective'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/STG/Objective/:objectiveId/Identification

Get a objective identification

HTTP syntax

GET /API/V3/STG/Objective/:objectiveId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.stg.getObjectiveIdentification(objectiveId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.stg.getObjectiveIdentification(objectiveId) // returns PF.IdentificationExtended

Other endpoints for objects of type objective

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission IDENTIFY on object of type Objective and ID specified in parameter objectiveId.

Parameters

Name Type Description Required Assertion Default, if omitted
objectiveId UUID The objective'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/STG/Objective/:objectiveId/ObjectiveIndicators

Returns references to all objective indicators belonging to a specific objective

HTTP syntax

GET /API/V3/STG/Objective/:objectiveId/ObjectiveIndicators?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getObjectiveIndicatorsOfObjective(objectiveId, sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.stg.getObjectiveIndicatorsOfObjective(objectiveId) // returns PF.ReferenceWithParent[]

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission READ on object of type Objective and ID specified in parameter objectiveId.

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

Parameters

Name Type Description Required Assertion
objectiveId UUID The objective'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, objectiveId, weight, sortIndex 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/STG/Objective/:objectiveId/ObjectiveIndicators/Add

Adds a new objective indicator

HTTP syntax

POST /API/V3/STG/Objective/:objectiveId/ObjectiveIndicators/Add?copy=...&copyRelations=...&name=...&code=...&description=...&color=...&iconRef=...&sortIndex=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.stg.addObjectiveIndicator(objectiveId, copy, copyRelations, name, code, description, color, iconRef, sortIndex) // returns PF.Reference

// Overloads for optional parameters
Pqf.stg.addObjectiveIndicator(objectiveId, copy, copyRelations, name, code, description, color, iconRef) // returns PF.Reference
Pqf.stg.addObjectiveIndicator(objectiveId, copy, copyRelations, name, code, description, color) // returns PF.Reference
Pqf.stg.addObjectiveIndicator(objectiveId, copy, copyRelations, name, code, description) // returns PF.Reference
Pqf.stg.addObjectiveIndicator(objectiveId, copy, copyRelations, name, code) // returns PF.Reference
Pqf.stg.addObjectiveIndicator(objectiveId, copy, copyRelations, name) // returns PF.Reference
Pqf.stg.addObjectiveIndicator(objectiveId, copy, copyRelations) // returns PF.Reference
Pqf.stg.addObjectiveIndicator(objectiveId, copy) // returns PF.Reference
Pqf.stg.addObjectiveIndicator(objectiveId) // returns PF.Reference

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission CREATE on object of type ObjectiveIndicator.

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

Parameters

Name Type Description Required Assertion Default, if omitted
objectiveId UUID the objective'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.)
copy UUID use an existing objective indicator of the same objective as template matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
copyRelations boolean When copying (copy is set), also copy relations false
name string The name of the new objective indicator, 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 objective indicator, may contain HTML
color color The color of the new objective indicator
iconRef URI The icon of the new objective indicator, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
sortIndex double The sort index to use 0

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/STG/Objective/:objectiveId/ProjectContributions

Returns references to all contributions belonging to a specific objective

HTTP syntax

GET /API/V3/STG/Objective/:objectiveId/ProjectContributions?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getProjectContributionsOfObjective(objectiveId, sort) // returns ProjectContributionReference[]

// Overloads for optional parameters
Pqf.stg.getProjectContributionsOfObjective(objectiveId) // returns ProjectContributionReference[]

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Objective and ID specified in parameter objectiveId.

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

Parameters

Name Type Description Required Assertion
objectiveId UUID the objective'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, createdAt, modifiedAt, objectiveId, projectId, weight, progress, sortIndex 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 ProjectContributionReference

POST /API/V3/STG/Objective/:objectiveId/ProjectContributions/Add

Adds a new project contribution

HTTP syntax

POST /API/V3/STG/Objective/:objectiveId/ProjectContributions/Add?projectId=...&sortIndex=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.stg.addProjectContribution(objectiveId, projectId, sortIndex) // returns PF.Reference

// Overloads for optional parameters
Pqf.stg.addProjectContribution(objectiveId, projectId) // returns PF.Reference

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission CREATE on object of type ProjectContribution.

Requires permission IDENTIFY on object of type Objective and ID specified in parameter objectiveId.

Parameters

Name Type Description Required Assertion Default, if omitted
objectiveId UUID the objective'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.)
projectId UUID the project's ID (required) ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
sortIndex double The sort index to use 0

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/STG/Objective/:objectiveId/Timeline

Get a objective's version timeline

HTTP syntax

GET /API/V3/STG/Objective/:objectiveId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.stg.getObjectiveTimeline(objectiveId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.stg.getObjectiveTimeline(objectiveId, limit, until, from) // returns PF.VersionTimeline
Pqf.stg.getObjectiveTimeline(objectiveId, limit, until) // returns PF.VersionTimeline
Pqf.stg.getObjectiveTimeline(objectiveId, limit) // returns PF.VersionTimeline
Pqf.stg.getObjectiveTimeline(objectiveId) // returns PF.VersionTimeline

Other endpoints for objects of type objective

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Objective and ID specified in parameter objectiveId.

Parameters

Name Type Description Required Assertion
objectiveId UUID The objective'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/STG/Objective/:objectiveId/Version/:versionId

Get a objective's specific (historic) version

HTTP syntax

GET /API/V3/STG/Objective/:objectiveId/Version/:versionId
<- application/json : Objective

JavaScript syntax

Pqf.stg.getObjectiveVersion(objectiveId, versionId) // returns Objective

Other endpoints for objects of type objective

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Objective and ID specified in parameter objectiveId.

Parameters

Name Type Description Required Assertion
objectiveId UUID The objective'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: Objective

GET /API/V3/STG/ObjectiveIndicator/:objectiveIndicatorId

Get a objective indicator

HTTP syntax

GET /API/V3/STG/ObjectiveIndicator/:objectiveIndicatorId
<- application/json : ObjectiveIndicator

JavaScript syntax

Pqf.stg.getObjectiveIndicator(objectiveIndicatorId) // returns ObjectiveIndicator

Other endpoints for objects of type objective indicator

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission READ on object of type ObjectiveIndicator and ID specified in parameter objectiveIndicatorId.

Parameters

Name Type Description Required Assertion
objectiveIndicatorId UUID The objective indicator'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: ObjectiveIndicator

PUT /API/V3/STG/ObjectiveIndicator/:objectiveIndicatorId

Update an existing objective indicator

HTTP syntax

PUT /API/V3/STG/ObjectiveIndicator/:objectiveIndicatorId
-> application/json : ObjectiveIndicator

JavaScript syntax

Pqf.stg.putObjectiveIndicator(objectiveIndicatorId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type objective indicator

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission UPDATE or CREATE on object of type ObjectiveIndicator and ID specified in parameter objectiveIndicatorId.

Parameters

Name Type Description Required Assertion
objectiveIndicatorId UUID The objective indicator'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 ObjectiveIndicator JSON object of type ObjectiveIndicator ✔️

DELETE /API/V3/STG/ObjectiveIndicator/:objectiveIndicatorId

Delete a objective indicator

HTTP syntax

DELETE /API/V3/STG/ObjectiveIndicator/:objectiveIndicatorId

JavaScript syntax

Pqf.stg.delObjectiveIndicator(objectiveIndicatorId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type objective indicator

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission DELETE on object of type ObjectiveIndicator and ID specified in parameter objectiveIndicatorId.

Parameters

Name Type Description Required Assertion
objectiveIndicatorId UUID The objective indicator'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/STG/ObjectiveIndicator/:objectiveIndicatorId/Identification

Get a objective indicator identification

HTTP syntax

GET /API/V3/STG/ObjectiveIndicator/:objectiveIndicatorId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.stg.getObjectiveIndicatorIdentification(objectiveIndicatorId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.stg.getObjectiveIndicatorIdentification(objectiveIndicatorId) // returns PF.IdentificationExtended

Other endpoints for objects of type objective indicator

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission IDENTIFY on object of type ObjectiveIndicator and ID specified in parameter objectiveIndicatorId.

Parameters

Name Type Description Required Assertion Default, if omitted
objectiveIndicatorId UUID The objective indicator'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/STG/ObjectiveIndicator/:objectiveIndicatorId/Timeline

Get a objective indicator's version timeline

HTTP syntax

GET /API/V3/STG/ObjectiveIndicator/:objectiveIndicatorId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.stg.getObjectiveIndicatorTimeline(objectiveIndicatorId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.stg.getObjectiveIndicatorTimeline(objectiveIndicatorId, limit, until, from) // returns PF.VersionTimeline
Pqf.stg.getObjectiveIndicatorTimeline(objectiveIndicatorId, limit, until) // returns PF.VersionTimeline
Pqf.stg.getObjectiveIndicatorTimeline(objectiveIndicatorId, limit) // returns PF.VersionTimeline
Pqf.stg.getObjectiveIndicatorTimeline(objectiveIndicatorId) // returns PF.VersionTimeline

Other endpoints for objects of type objective indicator

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission READ on object of type ObjectiveIndicator and ID specified in parameter objectiveIndicatorId.

Parameters

Name Type Description Required Assertion
objectiveIndicatorId UUID The objective indicator'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/STG/ObjectiveIndicator/:objectiveIndicatorId/Version/:versionId

Get a objective indicator's specific (historic) version

HTTP syntax

GET /API/V3/STG/ObjectiveIndicator/:objectiveIndicatorId/Version/:versionId
<- application/json : ObjectiveIndicator

JavaScript syntax

Pqf.stg.getObjectiveIndicatorVersion(objectiveIndicatorId, versionId) // returns ObjectiveIndicator

Other endpoints for objects of type objective indicator

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission READ on object of type ObjectiveIndicator and ID specified in parameter objectiveIndicatorId.

Parameters

Name Type Description Required Assertion
objectiveIndicatorId UUID The objective indicator'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: ObjectiveIndicator

GET /API/V3/STG/ObjectiveIndicators

Returns references to all objective indicators

HTTP syntax

GET /API/V3/STG/ObjectiveIndicators?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getAllObjectiveIndicators(sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.stg.getAllObjectiveIndicators() // returns PF.ReferenceWithParent[]

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

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, objectiveId, weight, sortIndex 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/STG/ObjectiveIndicators/:objectiveIndicatorIds

Get multiple objective indicators

HTTP syntax

GET /API/V3/STG/ObjectiveIndicators/:objectiveIndicatorIds
<- application/json

JavaScript syntax

Pqf.stg.getObjectiveIndicators(objectiveIndicatorIds) // returns ObjectiveIndicator[]

Other endpoints for objects of type objective indicator

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission READ on object of type ObjectiveIndicator and ID in specified in parameter objectiveIndicatorIds.

Parameters

Name Type Description Required Assertion
objectiveIndicatorIds array of UUID The objective indicator 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 ObjectiveIndicator

GET /API/V3/STG/ObjectiveIndicators/:objectiveIndicatorIds/Identification

Get multiple objective indicator identifications

HTTP syntax

GET /API/V3/STG/ObjectiveIndicators/:objectiveIndicatorIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.stg.getObjectiveIndicatorIdentifications(objectiveIndicatorIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.stg.getObjectiveIndicatorIdentifications(objectiveIndicatorIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type objective indicator

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission IDENTIFY on object of type ObjectiveIndicator and ID in specified in parameter objectiveIndicatorIds.

Parameters

Name Type Description Required Assertion Default, if omitted
objectiveIndicatorIds array of UUID The objective indicator 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/STG/Objectives

Returns references to all objectives

HTTP syntax

GET /API/V3/STG/Objectives?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getAllObjectives(sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.stg.getAllObjectives() // returns PF.ReferenceWithParent[]

Required license

This endpoint requires the following licenses:

  • strategymodule

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, fieldOfActionId, weight, progress, sortIndex 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/STG/Objectives/:objectiveIds

Get multiple objectives

HTTP syntax

GET /API/V3/STG/Objectives/:objectiveIds
<- application/json

JavaScript syntax

Pqf.stg.getObjectives(objectiveIds) // returns Objective[]

Other endpoints for objects of type objective

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Objective and ID in specified in parameter objectiveIds.

Parameters

Name Type Description Required Assertion
objectiveIds array of UUID The objective 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 Objective

GET /API/V3/STG/Objectives/:objectiveIds/Identification

Get multiple objective identifications

HTTP syntax

GET /API/V3/STG/Objectives/:objectiveIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.stg.getObjectiveIdentifications(objectiveIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.stg.getObjectiveIdentifications(objectiveIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type objective

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission IDENTIFY on object of type Objective and ID in specified in parameter objectiveIds.

Parameters

Name Type Description Required Assertion Default, if omitted
objectiveIds array of UUID The objective 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/STG/Project/:projectId/ProjectContributions

Returns references to all contributions belonging to a specific project

HTTP syntax

GET /API/V3/STG/Project/:projectId/ProjectContributions?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getProjectContributionsOfProject(projectId, sort) // returns ProjectContributionReference[]

// Overloads for optional parameters
Pqf.stg.getProjectContributionsOfProject(projectId) // returns ProjectContributionReference[]

Required license

This endpoint requires the following licenses:

  • strategymodule

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, createdAt, modifiedAt, objectiveId, projectId, weight, progress, sortIndex 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 ProjectContributionReference

PUT /API/V3/STG/ProjectContribution/:projectContributionId

Updates a project contribution

HTTP syntax

PUT /API/V3/STG/ProjectContribution/:projectContributionId
-> application/json : ProjectContribution

JavaScript syntax

Pqf.stg.putProjectContribution(projectContributionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission UPDATE on object of type ProjectContribution and ID specified in parameter projectContributionId.

Parameters

Name Type Description Required Assertion
projectContributionId UUID The ID of the project contribution ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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 ProjectContribution JSON object of type ProjectContribution ✔️

DELETE /API/V3/STG/ProjectContribution/:projectContributionId

Deletes a project contribution

HTTP syntax

DELETE /API/V3/STG/ProjectContribution/:projectContributionId

JavaScript syntax

Pqf.stg.delProjectContribution(projectContributionId) // returns Number - the return code (HTTP 2xx code) of the call

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission DELETE on object of type ProjectContribution and ID specified in parameter projectContributionId.

Parameters

Name Type Description Required Assertion
projectContributionId UUID The ID of the project contribution ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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/STG/ProjectContribution/:projectContributionId/Timeline

Retrieves the version (history) timeline for a project contribution

HTTP syntax

GET /API/V3/STG/ProjectContribution/:projectContributionId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.stg.getProjectContributionTimeline(projectContributionId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.stg.getProjectContributionTimeline(projectContributionId, limit, until, from) // returns PF.VersionTimeline
Pqf.stg.getProjectContributionTimeline(projectContributionId, limit, until) // returns PF.VersionTimeline
Pqf.stg.getProjectContributionTimeline(projectContributionId, limit) // returns PF.VersionTimeline
Pqf.stg.getProjectContributionTimeline(projectContributionId) // returns PF.VersionTimeline

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type ProjectContribution and ID specified in parameter projectContributionId.

Parameters

Name Type Description Required Assertion
projectContributionId UUID The ID of the project contribution ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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/STG/ProjectContribution/:projectContributionId/Version/:versionId

Retrieves a specific version (historic) of a project contribution

HTTP syntax

GET /API/V3/STG/ProjectContribution/:projectContributionId/Version/:versionId
<- application/json : ProjectContribution

JavaScript syntax

Pqf.stg.getProjectContributionVersion(projectContributionId, versionId) // returns ProjectContribution

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type ProjectContribution and ID specified in parameter projectContributionId.

Parameters

Name Type Description Required Assertion
projectContributionId UUID The ID of the project contribution ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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 get ✔️ 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: ProjectContribution

GET /API/V3/STG/ProjectContributions

Returns references to all project contributions

HTTP syntax

GET /API/V3/STG/ProjectContributions?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getAllProjectContributions(sort) // returns ProjectContributionReference[]

// Overloads for optional parameters
Pqf.stg.getAllProjectContributions() // returns ProjectContributionReference[]

Required license

This endpoint requires the following licenses:

  • strategymodule

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, createdAt, modifiedAt, objectiveId, projectId, weight, progress, sortIndex 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 ProjectContributionReference

GET /API/V3/STG/ProjectContributions/:projectContributionIds

Retrieves some project contributions specified by their IDs

HTTP syntax

GET /API/V3/STG/ProjectContributions/:projectContributionIds
<- application/json

JavaScript syntax

Pqf.stg.getProjectContributions(projectContributionIds) // returns ProjectContribution[]

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type ProjectContribution and ID in specified in parameter projectContributionIds.

Parameters

Name Type Description Required Assertion
projectContributionIds array of UUID The IDs of the project contributions ✔️ 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 ProjectContribution

GET /API/V3/STG/Strategies

Returns references to all strategies

HTTP syntax

GET /API/V3/STG/Strategies?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getAllStrategies(sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.stg.getAllStrategies() // returns PF.Reference[]

Required license

This endpoint requires the following licenses:

  • strategymodule

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 and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

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

GET /API/V3/STG/Strategies/:strategyIds

Get multiple strategies

HTTP syntax

GET /API/V3/STG/Strategies/:strategyIds
<- application/json

JavaScript syntax

Pqf.stg.getStrategies(strategyIds) // returns Strategy[]

Other endpoints for objects of type strategy

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Strategy and ID in specified in parameter strategyIds.

Parameters

Name Type Description Required Assertion
strategyIds array of UUID The strategy 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 Strategy

GET /API/V3/STG/Strategies/:strategyIds/Identification

Get multiple strategy identifications

HTTP syntax

GET /API/V3/STG/Strategies/:strategyIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.stg.getStrategyIdentifications(strategyIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.stg.getStrategyIdentifications(strategyIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type strategy

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission IDENTIFY on object of type Strategy and ID in specified in parameter strategyIds.

Parameters

Name Type Description Required Assertion Default, if omitted
strategyIds array of UUID The strategy 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

POST /API/V3/STG/Strategies/Add

Adds a new strategy

HTTP syntax

POST /API/V3/STG/Strategies/Add?copy=...&copyRelations=...&name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.stg.addStrategy(copy, copyRelations, name, code, description, color, iconRef) // returns PF.Reference

// Overloads for optional parameters
Pqf.stg.addStrategy(copy, copyRelations, name, code, description, color) // returns PF.Reference
Pqf.stg.addStrategy(copy, copyRelations, name, code, description) // returns PF.Reference
Pqf.stg.addStrategy(copy, copyRelations, name, code) // returns PF.Reference
Pqf.stg.addStrategy(copy, copyRelations, name) // returns PF.Reference
Pqf.stg.addStrategy(copy, copyRelations) // returns PF.Reference
Pqf.stg.addStrategy(copy) // returns PF.Reference
Pqf.stg.addStrategy() // returns PF.Reference

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission CREATE on object of type Strategy.

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

Parameters

Name Type Description Required Assertion Default, if omitted
copy UUID use an existing strategy as template matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
copyRelations boolean When copying (copy is set), also copy relations false
name string The name of the new strategy, 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 strategy, may contain HTML
color color The color of the new strategy
iconRef URI The icon of the new strategy, 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/STG/Strategy/:strategyId

Get a strategy

HTTP syntax

GET /API/V3/STG/Strategy/:strategyId
<- application/json : Strategy

JavaScript syntax

Pqf.stg.getStrategy(strategyId) // returns Strategy

Other endpoints for objects of type strategy

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Strategy and ID specified in parameter strategyId.

Parameters

Name Type Description Required Assertion
strategyId UUID The strategy'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: Strategy

PUT /API/V3/STG/Strategy/:strategyId

Update an existing strategy

HTTP syntax

PUT /API/V3/STG/Strategy/:strategyId
-> application/json : Strategy

JavaScript syntax

Pqf.stg.putStrategy(strategyId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type strategy

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission UPDATE or CREATE on object of type Strategy and ID specified in parameter strategyId.

Parameters

Name Type Description Required Assertion
strategyId UUID The strategy'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 Strategy JSON object of type Strategy ✔️

DELETE /API/V3/STG/Strategy/:strategyId

Delete a strategy

HTTP syntax

DELETE /API/V3/STG/Strategy/:strategyId

JavaScript syntax

Pqf.stg.delStrategy(strategyId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type strategy

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission DELETE on object of type Strategy and ID specified in parameter strategyId.

Parameters

Name Type Description Required Assertion
strategyId UUID The strategy'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/STG/Strategy/:strategyId/Identification

Get a strategy identification

HTTP syntax

GET /API/V3/STG/Strategy/:strategyId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.stg.getStrategyIdentification(strategyId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.stg.getStrategyIdentification(strategyId) // returns PF.IdentificationExtended

Other endpoints for objects of type strategy

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission IDENTIFY on object of type Strategy and ID specified in parameter strategyId.

Parameters

Name Type Description Required Assertion Default, if omitted
strategyId UUID The strategy'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/STG/Strategy/:strategyId/Timeline

Get a strategy's version timeline

HTTP syntax

GET /API/V3/STG/Strategy/:strategyId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.stg.getStrategyTimeline(strategyId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.stg.getStrategyTimeline(strategyId, limit, until, from) // returns PF.VersionTimeline
Pqf.stg.getStrategyTimeline(strategyId, limit, until) // returns PF.VersionTimeline
Pqf.stg.getStrategyTimeline(strategyId, limit) // returns PF.VersionTimeline
Pqf.stg.getStrategyTimeline(strategyId) // returns PF.VersionTimeline

Other endpoints for objects of type strategy

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission READ on object of type Strategy and ID specified in parameter strategyId.

Parameters

Name Type Description Required Assertion
strategyId UUID The strategy'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/STG/Strategy/:strategyId/Version/:versionId

Get a strategy's specific (historic) version

HTTP syntax

GET /API/V3/STG/Strategy/:strategyId/Version/:versionId
<- application/json : Strategy

JavaScript syntax

Pqf.stg.getStrategyVersion(strategyId, versionId) // returns Strategy

Other endpoints for objects of type strategy

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

Required license

This endpoint requires the following licenses:

  • strategymodule
  • strategymodule-extended

Required permission

Requires permission READ on object of type Strategy and ID specified in parameter strategyId.

Parameters

Name Type Description Required Assertion
strategyId UUID The strategy'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: Strategy

GET /API/V3/STG/Strategy/:strategyId/Visions

Returns references to all visions belonging to a specific strategy

HTTP syntax

GET /API/V3/STG/Strategy/:strategyId/Visions?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getVisionsOfStrategy(strategyId, sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.stg.getVisionsOfStrategy(strategyId) // returns PF.ReferenceWithParent[]

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Strategy and ID specified in parameter strategyId.

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

Parameters

Name Type Description Required Assertion
strategyId UUID The strategy'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, strategyId, sortIndex 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/STG/Strategy/:strategyId/Visions/Add

Adds a new vision

HTTP syntax

POST /API/V3/STG/Strategy/:strategyId/Visions/Add?copy=...&copyRelations=...&name=...&code=...&description=...&color=...&iconRef=...&sortIndex=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.stg.addVision(strategyId, copy, copyRelations, name, code, description, color, iconRef, sortIndex) // returns PF.Reference

// Overloads for optional parameters
Pqf.stg.addVision(strategyId, copy, copyRelations, name, code, description, color, iconRef) // returns PF.Reference
Pqf.stg.addVision(strategyId, copy, copyRelations, name, code, description, color) // returns PF.Reference
Pqf.stg.addVision(strategyId, copy, copyRelations, name, code, description) // returns PF.Reference
Pqf.stg.addVision(strategyId, copy, copyRelations, name, code) // returns PF.Reference
Pqf.stg.addVision(strategyId, copy, copyRelations, name) // returns PF.Reference
Pqf.stg.addVision(strategyId, copy, copyRelations) // returns PF.Reference
Pqf.stg.addVision(strategyId, copy) // returns PF.Reference
Pqf.stg.addVision(strategyId) // returns PF.Reference

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission CREATE on object of type Vision.

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

Parameters

Name Type Description Required Assertion Default, if omitted
strategyId UUID the strategy'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.)
copy UUID use an existing vision as template matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
copyRelations boolean When copying (copy is set), also copy relations false
name string The name of the new vision, 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 vision, may contain HTML
color color The color of the new vision
iconRef URI The icon of the new vision, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
sortIndex double The sort index to use 0

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/STG/Vision/:visionId

Get a vision

HTTP syntax

GET /API/V3/STG/Vision/:visionId
<- application/json : Vision

JavaScript syntax

Pqf.stg.getVision(visionId) // returns Vision

Other endpoints for objects of type vision

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Vision and ID specified in parameter visionId.

Parameters

Name Type Description Required Assertion
visionId UUID The vision'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: Vision

PUT /API/V3/STG/Vision/:visionId

Update an existing vision

HTTP syntax

PUT /API/V3/STG/Vision/:visionId
-> application/json : Vision

JavaScript syntax

Pqf.stg.putVision(visionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type vision

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission UPDATE or CREATE on object of type Vision and ID specified in parameter visionId.

Parameters

Name Type Description Required Assertion
visionId UUID The vision'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 Vision JSON object of type Vision ✔️

DELETE /API/V3/STG/Vision/:visionId

Delete a vision

HTTP syntax

DELETE /API/V3/STG/Vision/:visionId

JavaScript syntax

Pqf.stg.delVision(visionId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type vision

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission DELETE on object of type Vision and ID specified in parameter visionId.

Parameters

Name Type Description Required Assertion
visionId UUID The vision'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/STG/Vision/:visionId/FieldsOfAction

Returns references to all fields of action belonging to a specific vision

HTTP syntax

GET /API/V3/STG/Vision/:visionId/FieldsOfAction?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getFieldsOfActionOfVision(visionId, sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.stg.getFieldsOfActionOfVision(visionId) // returns PF.ReferenceWithParent[]

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Vision and ID specified in parameter visionId.

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

Parameters

Name Type Description Required Assertion
visionId UUID The vision'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, visionId, achievementRate, progress, sortIndex 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/STG/Vision/:visionId/FieldsOfAction/Add

Adds a new field of action

HTTP syntax

POST /API/V3/STG/Vision/:visionId/FieldsOfAction/Add?copy=...&copyRelations=...&name=...&code=...&description=...&color=...&iconRef=...&sortIndex=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.stg.addFieldOfAction(visionId, copy, copyRelations, name, code, description, color, iconRef, sortIndex) // returns PF.Reference

// Overloads for optional parameters
Pqf.stg.addFieldOfAction(visionId, copy, copyRelations, name, code, description, color, iconRef) // returns PF.Reference
Pqf.stg.addFieldOfAction(visionId, copy, copyRelations, name, code, description, color) // returns PF.Reference
Pqf.stg.addFieldOfAction(visionId, copy, copyRelations, name, code, description) // returns PF.Reference
Pqf.stg.addFieldOfAction(visionId, copy, copyRelations, name, code) // returns PF.Reference
Pqf.stg.addFieldOfAction(visionId, copy, copyRelations, name) // returns PF.Reference
Pqf.stg.addFieldOfAction(visionId, copy, copyRelations) // returns PF.Reference
Pqf.stg.addFieldOfAction(visionId, copy) // returns PF.Reference
Pqf.stg.addFieldOfAction(visionId) // returns PF.Reference

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission CREATE on object of type FieldOfAction.

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

Parameters

Name Type Description Required Assertion Default, if omitted
visionId UUID the vision'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.)
copy UUID use an existing field of action as template matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
copyRelations boolean When copying (copy is set), also copy relations false
name string The name of the new field of action, 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 field of action, may contain HTML
color color The color of the new field of action
iconRef URI The icon of the new field of action, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
sortIndex double The sort index to use 0

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/STG/Vision/:visionId/Identification

Get a vision identification

HTTP syntax

GET /API/V3/STG/Vision/:visionId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.stg.getVisionIdentification(visionId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.stg.getVisionIdentification(visionId) // returns PF.IdentificationExtended

Other endpoints for objects of type vision

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission IDENTIFY on object of type Vision and ID specified in parameter visionId.

Parameters

Name Type Description Required Assertion Default, if omitted
visionId UUID The vision'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/STG/Vision/:visionId/Timeline

Get a vision's version timeline

HTTP syntax

GET /API/V3/STG/Vision/:visionId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.stg.getVisionTimeline(visionId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.stg.getVisionTimeline(visionId, limit, until, from) // returns PF.VersionTimeline
Pqf.stg.getVisionTimeline(visionId, limit, until) // returns PF.VersionTimeline
Pqf.stg.getVisionTimeline(visionId, limit) // returns PF.VersionTimeline
Pqf.stg.getVisionTimeline(visionId) // returns PF.VersionTimeline

Other endpoints for objects of type vision

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Vision and ID specified in parameter visionId.

Parameters

Name Type Description Required Assertion
visionId UUID The vision'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/STG/Vision/:visionId/Version/:versionId

Get a vision's specific (historic) version

HTTP syntax

GET /API/V3/STG/Vision/:visionId/Version/:versionId
<- application/json : Vision

JavaScript syntax

Pqf.stg.getVisionVersion(visionId, versionId) // returns Vision

Other endpoints for objects of type vision

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Vision and ID specified in parameter visionId.

Parameters

Name Type Description Required Assertion
visionId UUID The vision'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: Vision

GET /API/V3/STG/Visions

Returns references to all visions

HTTP syntax

GET /API/V3/STG/Visions?sort=...
<- application/json

JavaScript syntax

Pqf.stg.getAllVisions(sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.stg.getAllVisions() // returns PF.ReferenceWithParent[]

Required license

This endpoint requires the following licenses:

  • strategymodule

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, strategyId, sortIndex 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/STG/Visions/:visionIds

Get multiple visions

HTTP syntax

GET /API/V3/STG/Visions/:visionIds
<- application/json

JavaScript syntax

Pqf.stg.getVisions(visionIds) // returns Vision[]

Other endpoints for objects of type vision

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission READ on object of type Vision and ID in specified in parameter visionIds.

Parameters

Name Type Description Required Assertion
visionIds array of UUID The vision 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 Vision

GET /API/V3/STG/Visions/:visionIds/Identification

Get multiple vision identifications

HTTP syntax

GET /API/V3/STG/Visions/:visionIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.stg.getVisionIdentifications(visionIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.stg.getVisionIdentifications(visionIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type vision

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

Required license

This endpoint requires the following licenses:

  • strategymodule

Required permission

Requires permission IDENTIFY on object of type Vision and ID in specified in parameter visionIds.

Parameters

Name Type Description Required Assertion Default, if omitted
visionIds array of UUID The vision 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

Data types

STG.AchievementRate

This is a structure data contract.

Describes the degree of achievement measured in a specific numeric metric

Members

Name Type Inherited Description Assertion
target double? The target in the defined metric
actual double? The actual value in the defined metric
metric string a metric that can be used to measure the degree of achievement
rate double? The achievement rate in percent (calculated)

STG.FieldOfAction

This is a structure data contract.

A field of action

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.)
visionId UUID The ID of the parent vision matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
achievementRate double? The achievement rate in percent calculated from the weighted objectives (may be null, read-only)
progressByContributionState array of ProgressByState The progress in percent calculated from the weighted project contributions by their state
progress double? The progress in percent calculated from the weighted objectives (may be null, read-only)
indicatorStatuses array of ObjectiveIndicatorStatus The statistics about indicator statuses
sortIndex double The index to sort for (lowest first)

STG.Objective

This is a structure data contract.

An objective for a field of action

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.)
fieldOfActionId UUID The ID of the parent field of action matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
weight int The weight of the objective w >= 0 (The value must be at least 0.)
achievementRate AchievementRate The degree of achievement measured in a specific numeric metric
progressByContributionState array of ProgressByState The progress in percent calculated from the weighted project contributions by their state
progress double? The progress in percent calculated from the weighted project contributions (may be null, read-only)
indicatorStatuses array of ObjectiveIndicatorStatus The statistics about indicator statuses
sortIndex double The index to sort for (lowest first)

STG.ObjectiveIndicator

This is a structure data contract.

An indicator for objective achievement measurement

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.)
objectiveId UUID the objective this indicator 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.)
targetType ObjectiveIndicatorTargetType The type of quantitative target measurement, null to indicate qualitative measurement
target string The target value (dynamic)
actual string The actual value (dynamic)
unit string A unit for measurement, may be also something countable
remark string a simple remark about the values
weight int the weight for statistics on objective object w >= 0 (The value must be at least 0.)
statusClassId UUID The ID of the status, a value of enum STG-OBJECTIVE-INDICATOR-STATUS matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
sortIndex double The index to sort for (lowest first)

STG.ObjectiveIndicatorStatus

This is a structure data contract.

Statistics about objective indicator statuses

Members

Name Type Inherited Description Assertion
statusClassId UUID The ID of the status, a value of enum STG-OBJECTIVE-INDICATOR-STATUS matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
accumulatedWeights int The accumulated weights of all indicators with that status class

STG.ObjectiveIndicatorTargetType

This is an enumeration data contract.

The type of quantitative target measurement on objective indicators

Enum values

ID Description
Numeric Numeric measurement

STG.ProgressByState

This is a structure data contract.

The accumulated progress of all projects by the contribution's state

Members

Name Type Inherited Description Assertion
stateId UUID The ID of the state matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
weight int The sum of weights w >= 0 (The value must be at least 0.)
progress double The progress in percent calculated from the weighted project contributions (read-only)

STG.ProjectContribution

This is a structure data contract.

A contribution to an objective

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
objectiveId UUID A reference to the objective matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
projectId UUID A reference to the project matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
weight int The weight of the contribution w >= 0 (The value must be at least 0.)
remark string A remark describing some facts about the contribution
progress double? The accumulated progress (in percent) of the active scenario's main phase (may be null, read-only)
manualProgressOverride double? The manual progress override (in percent) of the active scenario's main phase (is null if not overridden, read-only)
sortIndex double The index to sort for (lowest first)
properties array of PF.Property A collection of dynamic properties belonging to the object

STG.ProjectContributionReference

This is a structure data contract.

A reference to a project contribution, together with its objective and project

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.)
objectiveId UUID The ID of the objective matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
projectId UUID The ID of the project matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)

STG.Strategy

This is a structure data contract.

A strategy

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

STG.Vision

This is a structure data contract.

A vision

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.)
strategyId UUID The ID of the parent strategy matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\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.)
sortIndex double The index to sort for (lowest first)
↑

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.