API V3 Documentation – PM
Preview: this documents PQFORCE 4.26.6, which has not been released yet.
Endpoints
GET /API/V3/PM/IndicatorClassification/:indicatorClassificationId
Returns an indicator classification scheme
HTTP syntax
GET /API/V3/PM/IndicatorClassification/:indicatorClassificationId
<- application/json : IndicatorClassification JavaScript syntax
Pqf.pm.getIndicatorClassification(indicatorClassificationId) // returns IndicatorClassification Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationId |
UUID | The indicator classification scheme's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: IndicatorClassification
GET /API/V3/PM/IndicatorClassification/:indicatorClassificationId/Values
Returns references to the steps of one indicator classification scheme, each with the scheme it belongs to
HTTP syntax
GET /API/V3/PM/IndicatorClassification/:indicatorClassificationId/Values?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllIndicatorClassificationValuesByClassification(indicatorClassificationId, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getAllIndicatorClassificationValuesByClassification(indicatorClassificationId) // returns PF.ReferenceWithParent[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationId |
UUID | The indicator classification scheme's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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, indicatorClassificationId, valueStart, rating. Sorting by createdAt or modifiedAt requires the PM administration permission and is ignored without it | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/IndicatorClassification/:indicatorClassificationId/WithTranslations
Returns an indicator classification scheme with translations
HTTP syntax
GET /API/V3/PM/IndicatorClassification/:indicatorClassificationId/WithTranslations
<- application/json : IndicatorClassificationTranslated JavaScript syntax
Pqf.pm.getIndicatorClassificationTranslated(indicatorClassificationId) // returns IndicatorClassificationTranslated Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationId |
UUID | The indicator classification scheme's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: IndicatorClassificationTranslated
PUT /API/V3/PM/IndicatorClassification/:indicatorClassificationId/WithTranslations
Creates or updates an indicator classification scheme with translations, including its steps
HTTP syntax
PUT /API/V3/PM/IndicatorClassification/:indicatorClassificationId/WithTranslations
-> application/json : IndicatorClassificationTranslated JavaScript syntax
Pqf.pm.putIndicatorClassificationTranslated(indicatorClassificationId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationId |
UUID | The indicator classification scheme's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
IndicatorClassificationTranslated | JSON object of type IndicatorClassificationTranslated | ✔️ |
DELETE /API/V3/PM/IndicatorClassification/:indicatorClassificationId/WithTranslations
Deletes an indicator classification scheme
HTTP syntax
DELETE /API/V3/PM/IndicatorClassification/:indicatorClassificationId/WithTranslations JavaScript syntax
Pqf.pm.delIndicatorClassificationTranslated(indicatorClassificationId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationId |
UUID | The indicator classification scheme's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/IndicatorClassifications
Returns references to all indicator classification schemes
HTTP syntax
GET /API/V3/PM/IndicatorClassifications?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllIndicatorClassifications(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllIndicatorClassifications() // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt. Sorting by createdAt or modifiedAt requires the PM administration permission and is ignored without it | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/IndicatorClassifications/:indicatorClassificationIds
Returns some indicator classification schemes specified by their IDs
HTTP syntax
GET /API/V3/PM/IndicatorClassifications/:indicatorClassificationIds
<- application/json JavaScript syntax
Pqf.pm.getIndicatorClassifications(indicatorClassificationIds) // returns IndicatorClassification[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationIds |
array of UUID | The indicator classification schemes' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 IndicatorClassification
GET /API/V3/PM/IndicatorClassifications/:indicatorClassificationIds/WithTranslations
Returns some indicator classification schemes with translations, specified by their IDs
HTTP syntax
GET /API/V3/PM/IndicatorClassifications/:indicatorClassificationIds/WithTranslations
<- application/json JavaScript syntax
Pqf.pm.getIndicatorClassificationsTranslated(indicatorClassificationIds) // returns IndicatorClassificationTranslated[] Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationIds |
array of UUID | The indicator classification schemes' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 IndicatorClassificationTranslated
GET /API/V3/PM/IndicatorClassificationValue/:indicatorClassificationValueId
Returns one step of an indicator classification scheme
HTTP syntax
GET /API/V3/PM/IndicatorClassificationValue/:indicatorClassificationValueId
<- application/json : IndicatorClassificationValue JavaScript syntax
Pqf.pm.getIndicatorClassificationValue(indicatorClassificationValueId) // returns IndicatorClassificationValue Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationValueId |
UUID | The classification step's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: IndicatorClassificationValue
GET /API/V3/PM/IndicatorClassificationValue/:indicatorClassificationValueId/WithTranslations
Returns one step of an indicator classification scheme with translations
HTTP syntax
GET /API/V3/PM/IndicatorClassificationValue/:indicatorClassificationValueId/WithTranslations
<- application/json : IndicatorClassificationValueTranslated JavaScript syntax
Pqf.pm.getIndicatorClassificationValueTranslated(indicatorClassificationValueId) // returns IndicatorClassificationValueTranslated Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationValueId |
UUID | The classification step's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: IndicatorClassificationValueTranslated
PUT /API/V3/PM/IndicatorClassificationValue/:indicatorClassificationValueId/WithTranslations
Creates or updates one step of an indicator classification scheme with translations
HTTP syntax
PUT /API/V3/PM/IndicatorClassificationValue/:indicatorClassificationValueId/WithTranslations
-> application/json : IndicatorClassificationValueTranslated JavaScript syntax
Pqf.pm.putIndicatorClassificationValueTranslated(indicatorClassificationValueId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationValueId |
UUID | The classification step's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
IndicatorClassificationValueTranslated | JSON object of type IndicatorClassificationValueTranslated | ✔️ |
DELETE /API/V3/PM/IndicatorClassificationValue/:indicatorClassificationValueId/WithTranslations
Deletes one step of an indicator classification scheme
HTTP syntax
DELETE /API/V3/PM/IndicatorClassificationValue/:indicatorClassificationValueId/WithTranslations JavaScript syntax
Pqf.pm.delIndicatorClassificationValueTranslated(indicatorClassificationValueId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationValueId |
UUID | The classification step's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/IndicatorClassificationValues
Returns references to the steps of all indicator classification schemes, each with the scheme it belongs to
HTTP syntax
GET /API/V3/PM/IndicatorClassificationValues?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllIndicatorClassificationValues(sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getAllIndicatorClassificationValues() // returns PF.ReferenceWithParent[] 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, indicatorClassificationId, valueStart, rating. Sorting by createdAt or modifiedAt requires the PM administration permission and is ignored without it | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/IndicatorClassificationValues/:indicatorClassificationValueIds
Returns some steps of indicator classification schemes specified by their IDs
HTTP syntax
GET /API/V3/PM/IndicatorClassificationValues/:indicatorClassificationValueIds
<- application/json JavaScript syntax
Pqf.pm.getIndicatorClassificationValues(indicatorClassificationValueIds) // returns IndicatorClassificationValue[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationValueIds |
array of UUID | The classification steps' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 IndicatorClassificationValue
GET /API/V3/PM/IndicatorClassificationValues/:indicatorClassificationValueIds/WithTranslations
Returns some steps of indicator classification schemes with translations, specified by their IDs
HTTP syntax
GET /API/V3/PM/IndicatorClassificationValues/:indicatorClassificationValueIds/WithTranslations
<- application/json JavaScript syntax
Pqf.pm.getIndicatorClassificationValuesTranslated(indicatorClassificationValueIds) // returns IndicatorClassificationValueTranslated[] Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorClassificationValueIds |
array of UUID | The classification steps' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 IndicatorClassificationValueTranslated
GET /API/V3/PM/IndicatorDetail/:indicatorDetailId
Returns an indicator detail definition
HTTP syntax
GET /API/V3/PM/IndicatorDetail/:indicatorDetailId
<- application/json : IndicatorDetail JavaScript syntax
Pqf.pm.getIndicatorDetail(indicatorDetailId) // returns IndicatorDetail Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDetailId |
UUID | The indicator detail definition's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: IndicatorDetail
GET /API/V3/PM/IndicatorDetail/:indicatorDetailId/WithTranslations
Returns an indicator detail definition with translations
HTTP syntax
GET /API/V3/PM/IndicatorDetail/:indicatorDetailId/WithTranslations
<- application/json : IndicatorDetailTranslated JavaScript syntax
Pqf.pm.getIndicatorDetailTranslated(indicatorDetailId) // returns IndicatorDetailTranslated Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDetailId |
UUID | The indicator detail definition's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: IndicatorDetailTranslated
PUT /API/V3/PM/IndicatorDetail/:indicatorDetailId/WithTranslations
Creates or updates an indicator detail definition with translations
HTTP syntax
PUT /API/V3/PM/IndicatorDetail/:indicatorDetailId/WithTranslations
-> application/json : IndicatorDetailTranslated JavaScript syntax
Pqf.pm.putIndicatorDetailTranslated(indicatorDetailId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDetailId |
UUID | The indicator detail definition's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
IndicatorDetailTranslated | JSON object of type IndicatorDetailTranslated | ✔️ |
DELETE /API/V3/PM/IndicatorDetail/:indicatorDetailId/WithTranslations
Deletes an indicator detail definition
HTTP syntax
DELETE /API/V3/PM/IndicatorDetail/:indicatorDetailId/WithTranslations JavaScript syntax
Pqf.pm.delIndicatorDetailTranslated(indicatorDetailId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDetailId |
UUID | The indicator detail definition's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/IndicatorDetails
Returns references to all indicator detail definitions of all project report types
HTTP syntax
GET /API/V3/PM/IndicatorDetails?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllIndicatorDetails(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllIndicatorDetails() // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectReportTypeId, indicatorDimensionId, sortIndex. Sorting by createdAt or modifiedAt requires the PM administration permission and is ignored without it | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/IndicatorDetails/:indicatorDetailIds
Returns some indicator detail definitions specified by their IDs
HTTP syntax
GET /API/V3/PM/IndicatorDetails/:indicatorDetailIds
<- application/json JavaScript syntax
Pqf.pm.getIndicatorDetails(indicatorDetailIds) // returns IndicatorDetail[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDetailIds |
array of UUID | The indicator detail definitions' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 IndicatorDetail
GET /API/V3/PM/IndicatorDetails/:indicatorDetailIds/WithTranslations
Returns some indicator detail definitions with translations, specified by their IDs
HTTP syntax
GET /API/V3/PM/IndicatorDetails/:indicatorDetailIds/WithTranslations
<- application/json JavaScript syntax
Pqf.pm.getIndicatorDetailsTranslated(indicatorDetailIds) // returns IndicatorDetailTranslated[] Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDetailIds |
array of UUID | The indicator detail definitions' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 IndicatorDetailTranslated
GET /API/V3/PM/IndicatorDimension/:indicatorDimensionId
Returns an indicator dimension definition
HTTP syntax
GET /API/V3/PM/IndicatorDimension/:indicatorDimensionId
<- application/json : IndicatorDimension JavaScript syntax
Pqf.pm.getIndicatorDimension(indicatorDimensionId) // returns IndicatorDimension Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDimensionId |
UUID | The indicator dimension definition's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: IndicatorDimension
GET /API/V3/PM/IndicatorDimension/:indicatorDimensionId/Details
Returns references to the indicator detail definitions that belong to one dimension
HTTP syntax
GET /API/V3/PM/IndicatorDimension/:indicatorDimensionId/Details?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllIndicatorDimensionDetails(indicatorDimensionId, sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllIndicatorDimensionDetails(indicatorDimensionId) // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDimensionId |
UUID | The indicator dimension definition's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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, projectReportTypeId, indicatorDimensionId, sortIndex. Sorting by createdAt or modifiedAt requires the PM administration permission and is ignored without it | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/IndicatorDimension/:indicatorDimensionId/WithTranslations
Returns an indicator dimension definition with translations
HTTP syntax
GET /API/V3/PM/IndicatorDimension/:indicatorDimensionId/WithTranslations
<- application/json : IndicatorDimensionTranslated JavaScript syntax
Pqf.pm.getIndicatorDimensionTranslated(indicatorDimensionId) // returns IndicatorDimensionTranslated Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDimensionId |
UUID | The indicator dimension definition's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: IndicatorDimensionTranslated
PUT /API/V3/PM/IndicatorDimension/:indicatorDimensionId/WithTranslations
Creates or updates an indicator dimension definition with translations
HTTP syntax
PUT /API/V3/PM/IndicatorDimension/:indicatorDimensionId/WithTranslations
-> application/json : IndicatorDimensionTranslated JavaScript syntax
Pqf.pm.putIndicatorDimensionTranslated(indicatorDimensionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDimensionId |
UUID | The indicator dimension definition's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
IndicatorDimensionTranslated | JSON object of type IndicatorDimensionTranslated | ✔️ |
DELETE /API/V3/PM/IndicatorDimension/:indicatorDimensionId/WithTranslations
Deletes an indicator dimension definition
HTTP syntax
DELETE /API/V3/PM/IndicatorDimension/:indicatorDimensionId/WithTranslations JavaScript syntax
Pqf.pm.delIndicatorDimensionTranslated(indicatorDimensionId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDimensionId |
UUID | The indicator dimension definition's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/IndicatorDimensions
Returns references to all indicator dimension definitions of all project report types
HTTP syntax
GET /API/V3/PM/IndicatorDimensions?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllIndicatorDimensions(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllIndicatorDimensions() // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectReportTypeId, sortIndex. Sorting by createdAt or modifiedAt requires the PM administration permission and is ignored without it | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/IndicatorDimensions/:indicatorDimensionIds
Returns some indicator dimension definitions specified by their IDs
HTTP syntax
GET /API/V3/PM/IndicatorDimensions/:indicatorDimensionIds
<- application/json JavaScript syntax
Pqf.pm.getIndicatorDimensions(indicatorDimensionIds) // returns IndicatorDimension[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDimensionIds |
array of UUID | The indicator dimension definitions' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 IndicatorDimension
GET /API/V3/PM/IndicatorDimensions/:indicatorDimensionIds/WithTranslations
Returns some indicator dimension definitions with translations, specified by their IDs
HTTP syntax
GET /API/V3/PM/IndicatorDimensions/:indicatorDimensionIds/WithTranslations
<- application/json JavaScript syntax
Pqf.pm.getIndicatorDimensionsTranslated(indicatorDimensionIds) // returns IndicatorDimensionTranslated[] Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
indicatorDimensionIds |
array of UUID | The indicator dimension definitions' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 IndicatorDimensionTranslated
GET /API/V3/PM/Methodologies
Returns references to all available project management methodologies
HTTP syntax
GET /API/V3/PM/Methodologies?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectManagementMethodologies(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectManagementMethodologies() // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/Methodologies/:methodIds
Returns project management methodologies
HTTP syntax
GET /API/V3/PM/Methodologies/:methodIds
<- application/json JavaScript syntax
Pqf.pm.getProjectManagementMethodologies(methodIds) // returns ProjectManagementMethodology[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodIds |
array of UUID | The IDs of the project management methodologies | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectManagementMethodology
GET /API/V3/PM/Methodologies/:methodIds/WithTranslations
Returns project management methodologies with translations
HTTP syntax
GET /API/V3/PM/Methodologies/:methodIds/WithTranslations
<- application/json JavaScript syntax
Pqf.pm.getProjectManagementMethodologiesTranslated(methodIds) // returns ProjectManagementMethodologyTranslated[] Required license
This endpoint requires the following licenses:
- config-methodology
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodIds |
array of UUID | The IDs of the project management methodologies | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectManagementMethodologyTranslated
GET /API/V3/PM/Methodology/:methodId
Returns a project management methodology
HTTP syntax
GET /API/V3/PM/Methodology/:methodId
<- application/json : ProjectManagementMethodology JavaScript syntax
Pqf.pm.getProjectManagementMethodology(methodId) // returns ProjectManagementMethodology Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectManagementMethodology
GET /API/V3/PM/Methodology/:methodId/Phase/:phaseId
Returns a phase of a project management methodology
HTTP syntax
GET /API/V3/PM/Methodology/:methodId/Phase/:phaseId
<- application/json : ProjectManagementMethodologyPhase JavaScript syntax
Pqf.pm.getProjectManagementMethodologyPhase(methodId, phaseId) // returns ProjectManagementMethodologyPhase Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
phaseId |
UUID | The ID of the project management methodology phase | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectManagementMethodologyPhase
GET /API/V3/PM/Methodology/:methodId/Phase/:phaseId/WithTranslations
Returns a phase of a project management methodology with translations
HTTP syntax
GET /API/V3/PM/Methodology/:methodId/Phase/:phaseId/WithTranslations
<- application/json : ProjectManagementMethodologyPhaseTranslated JavaScript syntax
Pqf.pm.getProjectManagementMethodologyPhaseTranslated(methodId, phaseId) // returns ProjectManagementMethodologyPhaseTranslated Required license
This endpoint requires the following licenses:
- config-methodology
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
phaseId |
UUID | The ID of the project management methodology phase | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectManagementMethodologyPhaseTranslated
PUT /API/V3/PM/Methodology/:methodId/Phase/:phaseId/WithTranslations
Updates a phase of a project management methodology with translations
HTTP syntax
PUT /API/V3/PM/Methodology/:methodId/Phase/:phaseId/WithTranslations
-> application/json : ProjectManagementMethodologyPhaseTranslated JavaScript syntax
Pqf.pm.putProjectManagementMethodologyPhaseTranslated(methodId, phaseId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-methodology
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
phaseId |
UUID | The ID of the project management methodology phase | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectManagementMethodologyPhaseTranslated | JSON object of type ProjectManagementMethodologyPhaseTranslated | ✔️ |
DELETE /API/V3/PM/Methodology/:methodId/Phase/:phaseId/WithTranslations
Deletes a phase of a project management methodology with translations
HTTP syntax
DELETE /API/V3/PM/Methodology/:methodId/Phase/:phaseId/WithTranslations JavaScript syntax
Pqf.pm.delProjectManagementMethodologyPhaseTranslated(methodId, phaseId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-methodology
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
phaseId |
UUID | The ID of the project management methodology phase | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/Methodology/:methodId/PhaseLifecycleAssignments
Returns the assignments between lifecycle states and the phases of a project management methodology
HTTP syntax
GET /API/V3/PM/Methodology/:methodId/PhaseLifecycleAssignments
<- application/json JavaScript syntax
Pqf.pm.getProjectManagementMethodologyPhaseLifecycleAssignments(methodId) // returns ProjectManagementMethodologyPhaseLifecycleAssignment[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ProjectManagementMethodologyPhaseLifecycleAssignment
GET /API/V3/PM/Methodology/:methodId/Phases
Returns references to all phases of a project management methodology
HTTP syntax
GET /API/V3/PM/Methodology/:methodId/Phases?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectManagementMethodologyPhases(methodId, sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectManagementMethodologyPhases(methodId) // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, name, code, description, color, sortIndex | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/Methodology/:methodId/Phases/:phaseIds
Returns phases of a project management methodology
HTTP syntax
GET /API/V3/PM/Methodology/:methodId/Phases/:phaseIds
<- application/json JavaScript syntax
Pqf.pm.getProjectManagementMethodologyPhases(methodId, phaseIds) // returns ProjectManagementMethodologyPhase[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
phaseIds |
array of UUID | The IDs of the project management methodology phases | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectManagementMethodologyPhase
GET /API/V3/PM/Methodology/:methodId/Phases/:phaseIds/WithTranslations
Returns phases of a project management methodology with translations
HTTP syntax
GET /API/V3/PM/Methodology/:methodId/Phases/:phaseIds/WithTranslations
<- application/json JavaScript syntax
Pqf.pm.getProjectManagementMethodologyPhasesTranslated(methodId, phaseIds) // returns ProjectManagementMethodologyPhaseTranslated[] Required license
This endpoint requires the following licenses:
- config-methodology
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
phaseIds |
array of UUID | The IDs of the project management methodology phases | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectManagementMethodologyPhaseTranslated
GET /API/V3/PM/Methodology/:methodId/WithTranslations
Returns a project management methodology with translations
HTTP syntax
GET /API/V3/PM/Methodology/:methodId/WithTranslations
<- application/json : ProjectManagementMethodologyTranslated JavaScript syntax
Pqf.pm.getProjectManagementMethodologyTranslated(methodId) // returns ProjectManagementMethodologyTranslated Required license
This endpoint requires the following licenses:
- config-methodology
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectManagementMethodologyTranslated
PUT /API/V3/PM/Methodology/:methodId/WithTranslations
Updates a project management methodology with translations
HTTP syntax
PUT /API/V3/PM/Methodology/:methodId/WithTranslations
-> application/json : ProjectManagementMethodologyTranslated JavaScript syntax
Pqf.pm.putProjectManagementMethodologyTranslated(methodId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-methodology
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectManagementMethodologyTranslated | JSON object of type ProjectManagementMethodologyTranslated | ✔️ |
DELETE /API/V3/PM/Methodology/:methodId/WithTranslations
Deletes a project management methodology with translations
HTTP syntax
DELETE /API/V3/PM/Methodology/:methodId/WithTranslations JavaScript syntax
Pqf.pm.delProjectManagementMethodologyTranslated(methodId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-methodology
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
methodId |
UUID | The ID of the project management method | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/MethodologyPhaseLifecycleAssignments
Returns the assignments between lifecycle states and the phases of all project management methodologies
HTTP syntax
GET /API/V3/PM/MethodologyPhaseLifecycleAssignments
<- application/json JavaScript syntax
Pqf.pm.getAllProjectManagementMethodologyPhaseLifecycleAssignments() // returns ProjectManagementMethodologyPhaseLifecycleAssignment[] Result
This endpoint returns the following data: array of ProjectManagementMethodologyPhaseLifecycleAssignment
PUT /API/V3/PM/MethodologyPhaseLifecycleAssignments
Replaces the assignments between lifecycle states and the phases of all project management methodologies
HTTP syntax
PUT /API/V3/PM/MethodologyPhaseLifecycleAssignments
-> application/json JavaScript syntax
Pqf.pm.putProjectManagementMethodologyPhaseLifecycleAssignments(requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-methodology
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
requestJson |
array of ProjectManagementMethodologyPhaseLifecycleAssignment | JSON object of type array of ProjectManagementMethodologyPhaseLifecycleAssignment | ✔️ |
GET /API/V3/PM/PortfolioSimulation/:portfolioSimulationId
Get a portfolio simulation
HTTP syntax
GET /API/V3/PM/PortfolioSimulation/:portfolioSimulationId
<- application/json : PortfolioSimulation JavaScript syntax
Pqf.pm.getPortfolioSimulation(portfolioSimulationId) // returns PortfolioSimulation Other endpoints for objects of type portfolio simulation
This endpoint is part of a group of endpoints manipulating objects of type portfolio simulation. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple portfolio simulationsPM/ PortfolioSimulations/ :portfolioSimulationIds - PUT /API/
V3/ : Update an existing portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - DELETE /API/
V3/ : Delete a portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - GET /API/
V3/ : Get a portfolio simulation identificationPM/ PortfolioSimulation/ :portfolioSimulationId/ Identification - GET /API/
V3/ : Get multiple portfolio simulation identificationsPM/ PortfolioSimulations/ :portfolioSimulationIds/ Identification
Required license
This endpoint requires the following licenses:
- portfoliosim
Required permission
Requires permission READ on object of type PortfolioSimulation and ID specified in parameter portfolioSimulationId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
portfolioSimulationId |
UUID | The portfolio simulation's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: PortfolioSimulation
PUT /API/V3/PM/PortfolioSimulation/:portfolioSimulationId
Update an existing portfolio simulation
HTTP syntax
PUT /API/V3/PM/PortfolioSimulation/:portfolioSimulationId
-> application/json : PortfolioSimulation JavaScript syntax
Pqf.pm.putPortfolioSimulation(portfolioSimulationId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type portfolio simulation
This endpoint is part of a group of endpoints manipulating objects of type portfolio simulation. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - GET /API/
V3/ : Get multiple portfolio simulationsPM/ PortfolioSimulations/ :portfolioSimulationIds - DELETE /API/
V3/ : Delete a portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - GET /API/
V3/ : Get a portfolio simulation identificationPM/ PortfolioSimulation/ :portfolioSimulationId/ Identification - GET /API/
V3/ : Get multiple portfolio simulation identificationsPM/ PortfolioSimulations/ :portfolioSimulationIds/ Identification
Required license
This endpoint requires the following licenses:
- portfoliosim
Required permission
Requires permission UPDATE or CREATE on object of type PortfolioSimulation and ID specified in parameter portfolioSimulationId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
portfolioSimulationId |
UUID | The portfolio simulation's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
PortfolioSimulation | JSON object of type PortfolioSimulation | ✔️ |
DELETE /API/V3/PM/PortfolioSimulation/:portfolioSimulationId
Delete a portfolio simulation
HTTP syntax
DELETE /API/V3/PM/PortfolioSimulation/:portfolioSimulationId JavaScript syntax
Pqf.pm.delPortfolioSimulation(portfolioSimulationId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type portfolio simulation
This endpoint is part of a group of endpoints manipulating objects of type portfolio simulation. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - GET /API/
V3/ : Get multiple portfolio simulationsPM/ PortfolioSimulations/ :portfolioSimulationIds - PUT /API/
V3/ : Update an existing portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - GET /API/
V3/ : Get a portfolio simulation identificationPM/ PortfolioSimulation/ :portfolioSimulationId/ Identification - GET /API/
V3/ : Get multiple portfolio simulation identificationsPM/ PortfolioSimulations/ :portfolioSimulationIds/ Identification
Required license
This endpoint requires the following licenses:
- portfoliosim
Required permission
Requires permission DELETE on object of type PortfolioSimulation and ID specified in parameter portfolioSimulationId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
portfolioSimulationId |
UUID | The portfolio simulation's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/PortfolioSimulation/:portfolioSimulationId/Identification
Get a portfolio simulation identification
HTTP syntax
GET /API/V3/PM/PortfolioSimulation/:portfolioSimulationId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getPortfolioSimulationIdentification(portfolioSimulationId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getPortfolioSimulationIdentification(portfolioSimulationId) // returns PF.IdentificationExtended Other endpoints for objects of type portfolio simulation
This endpoint is part of a group of endpoints manipulating objects of type portfolio simulation. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - GET /API/
V3/ : Get multiple portfolio simulationsPM/ PortfolioSimulations/ :portfolioSimulationIds - PUT /API/
V3/ : Update an existing portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - DELETE /API/
V3/ : Delete a portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - GET /API/
V3/ : Get multiple portfolio simulation identificationsPM/ PortfolioSimulations/ :portfolioSimulationIds/ Identification
Required license
This endpoint requires the following licenses:
- portfoliosim
Required permission
Requires permission IDENTIFY on object of type PortfolioSimulation and ID specified in parameter portfolioSimulationId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
portfolioSimulationId |
UUID | The portfolio simulation's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/PortfolioSimulations
Returns references to all portfolio simulations
HTTP syntax
GET /API/V3/PM/PortfolioSimulations?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllPortfolioSimulations(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllPortfolioSimulations() // returns PF.Reference[] Required license
This endpoint requires the following licenses:
- portfoliosim
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 '[ (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/PM/PortfolioSimulations/:portfolioSimulationIds
Get multiple portfolio simulations
HTTP syntax
GET /API/V3/PM/PortfolioSimulations/:portfolioSimulationIds
<- application/json JavaScript syntax
Pqf.pm.getPortfolioSimulations(portfolioSimulationIds) // returns PortfolioSimulation[] Other endpoints for objects of type portfolio simulation
This endpoint is part of a group of endpoints manipulating objects of type portfolio simulation. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - PUT /API/
V3/ : Update an existing portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - DELETE /API/
V3/ : Delete a portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - GET /API/
V3/ : Get a portfolio simulation identificationPM/ PortfolioSimulation/ :portfolioSimulationId/ Identification - GET /API/
V3/ : Get multiple portfolio simulation identificationsPM/ PortfolioSimulations/ :portfolioSimulationIds/ Identification
Required license
This endpoint requires the following licenses:
- portfoliosim
Required permission
Requires permission READ on object of type PortfolioSimulation and ID in specified in parameter portfolioSimulationIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
portfolioSimulationIds |
array of UUID | The portfolio simulation IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 PortfolioSimulation
GET /API/V3/PM/PortfolioSimulations/:portfolioSimulationIds/Identification
Get multiple portfolio simulation identifications
HTTP syntax
GET /API/V3/PM/PortfolioSimulations/:portfolioSimulationIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getPortfolioSimulationIdentifications(portfolioSimulationIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getPortfolioSimulationIdentifications(portfolioSimulationIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type portfolio simulation
This endpoint is part of a group of endpoints manipulating objects of type portfolio simulation. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - GET /API/
V3/ : Get multiple portfolio simulationsPM/ PortfolioSimulations/ :portfolioSimulationIds - PUT /API/
V3/ : Update an existing portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - DELETE /API/
V3/ : Delete a portfolio simulationPM/ PortfolioSimulation/ :portfolioSimulationId - GET /API/
V3/ : Get a portfolio simulation identificationPM/ PortfolioSimulation/ :portfolioSimulationId/ Identification
Required license
This endpoint requires the following licenses:
- portfoliosim
Required permission
Requires permission IDENTIFY on object of type PortfolioSimulation and ID in specified in parameter portfolioSimulationIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
portfolioSimulationIds |
array of UUID | The portfolio simulation IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/PortfolioSimulations/Add
Adds a new portfolio simulation
HTTP syntax
POST /API/V3/PM/PortfolioSimulations/Add?name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addPortfolioSimulation(name, code, description, color, iconRef) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.addPortfolioSimulation(name, code, description, color) // returns PF.Reference
Pqf.pm.addPortfolioSimulation(name, code, description) // returns PF.Reference
Pqf.pm.addPortfolioSimulation(name, code) // returns PF.Reference
Pqf.pm.addPortfolioSimulation(name) // returns PF.Reference
Pqf.pm.addPortfolioSimulation() // returns PF.Reference Required license
This endpoint requires the following licenses:
- portfoliosim
Required permission
Requires permission CREATE on object of type PortfolioSimulation.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
name |
string | The name of the new portfolio simulation, 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 portfolio simulation, may contain HTML | ||
color |
color | The color of the new portfolio simulation | ||
iconRef |
URI | The icon of the new portfolio simulation, 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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/Project/:projectId
Get a project
HTTP syntax
GET /API/V3/PM/Project/:projectId
<- application/json : ProjectJavaScript syntax
Pqf.pm.getProject(projectId) // returns ProjectOther endpoints for objects of type project
This endpoint is part of a group of endpoints manipulating objects of type project. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple projectsPM/ Projects/ :projectIds - PUT /API/V3/PM/Project/:projectId: Update an existing project
- DELETE /API/V3/PM/Project/:projectId: Delete a project
- GET /API/
V3/ : Get a project identificationPM/ Project/ :projectId/ Identification - GET /API/
V3/ : Get multiple project identificationsPM/ Projects/ :projectIds/ Identification - GET /API/
V3/ : Get a project's version timelinePM/ Project/ :projectId/ Timeline - GET /API/
V3/ : Get a project's specific (historic) versionPM/ Project/ :projectId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted projectsPM/ Projects/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted projectPM/ Project/ :projectId/ Undelete
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: Project
PUT /API/V3/PM/Project/:projectId
Update an existing project
HTTP syntax
PUT /API/V3/PM/Project/:projectId
-> application/json : ProjectJavaScript syntax
Pqf.pm.putProject(projectId, requestJson) // returns Number - the return code (HTTP 2xx code) of the callOther endpoints for objects of type project
This endpoint is part of a group of endpoints manipulating objects of type project. The following endpoints belong to the same group:
- GET /API/V3/PM/Project/:projectId: Get a project
- GET /API/
V3/ : Get multiple projectsPM/ Projects/ :projectIds - DELETE /API/V3/PM/Project/:projectId: Delete a project
- GET /API/
V3/ : Get a project identificationPM/ Project/ :projectId/ Identification - GET /API/
V3/ : Get multiple project identificationsPM/ Projects/ :projectIds/ Identification - GET /API/
V3/ : Get a project's version timelinePM/ Project/ :projectId/ Timeline - GET /API/
V3/ : Get a project's specific (historic) versionPM/ Project/ :projectId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted projectsPM/ Projects/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted projectPM/ Project/ :projectId/ Undelete
Required permission
Requires permission UPDATE or CREATE on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
Project | JSON object of type Project | ✔️ |
DELETE /API/V3/PM/Project/:projectId
Delete a project
HTTP syntax
DELETE /API/V3/PM/Project/:projectIdJavaScript syntax
Pqf.pm.delProject(projectId) // returns Number - the return code (HTTP 2xx code) of the callOther endpoints for objects of type project
This endpoint is part of a group of endpoints manipulating objects of type project. The following endpoints belong to the same group:
- GET /API/V3/PM/Project/:projectId: Get a project
- GET /API/
V3/ : Get multiple projectsPM/ Projects/ :projectIds - PUT /API/V3/PM/Project/:projectId: Update an existing project
- GET /API/
V3/ : Get a project identificationPM/ Project/ :projectId/ Identification - GET /API/
V3/ : Get multiple project identificationsPM/ Projects/ :projectIds/ Identification - GET /API/
V3/ : Get a project's version timelinePM/ Project/ :projectId/ Timeline - GET /API/
V3/ : Get a project's specific (historic) versionPM/ Project/ :projectId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted projectsPM/ Projects/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted projectPM/ Project/ :projectId/ Undelete
Required permission
Requires permission DELETE on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/Project/:projectId/AccumulatedValues/Costs
Returns the costs group of the accumulated values (costs budget and costs forecasts), optionally restricted to a day range, of a project's active scenario (or of its single scenario if that is not active), accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. All money values are converted into the target currency. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/Project/:projectId/AccumulatedValues/Costs?beg=...&end=...&targetCurrencyId=...
<- application/json : AccumulatedCosts JavaScript syntax
Pqf.pm.getAccumulatedCostsOfProject(projectId, beg, end, targetCurrencyId) // returns AccumulatedCosts
// Overloads for optional parameters
Pqf.pm.getAccumulatedCostsOfProject(projectId, beg, end) // returns AccumulatedCosts
Pqf.pm.getAccumulatedCostsOfProject(projectId, beg) // returns AccumulatedCosts
Pqf.pm.getAccumulatedCostsOfProject(projectId) // returns AccumulatedCosts Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive) to restrict the costs to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: AccumulatedCosts
GET /API/V3/PM/Project/:projectId/AccumulatedValues/Progress
Returns the progress group of the accumulated values (calculated progress and its manual override) of a project's active scenario (or of its single scenario if that is not active), accumulated over all its top-most work items as if they were its children; the scenario has no values of its own
HTTP syntax
GET /API/V3/PM/Project/:projectId/AccumulatedValues/Progress
<- application/json : AccumulatedProgress JavaScript syntax
Pqf.pm.getAccumulatedProgressOfProject(projectId) // returns AccumulatedProgress Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: AccumulatedProgress
GET /API/V3/PM/Project/:projectId/AccumulatedValues/Structure
Returns the structure group of the accumulated values (children, planning errors, time budget and planned time) of a project's active scenario (or of its single scenario if that is not active), accumulated over all its top-most work items as if they were its children; the scenario has no values of its own
HTTP syntax
GET /API/V3/PM/Project/:projectId/AccumulatedValues/Structure
<- application/json : AccumulatedStructure JavaScript syntax
Pqf.pm.getAccumulatedStructureOfProject(projectId) // returns AccumulatedStructure Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: AccumulatedStructure
GET /API/V3/PM/Project/:projectId/AccumulatedValues/Times
Returns the times group of the accumulated values (allocated, spent, pending and remaining time and the overload), optionally restricted to a day range of a project's active scenario (or of its single scenario if that is not active), accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/Project/:projectId/AccumulatedValues/Times?beg=...&end=...
<- application/json : AccumulatedTime JavaScript syntax
Pqf.pm.getAccumulatedTimesOfProject(projectId, beg, end) // returns AccumulatedTime
// Overloads for optional parameters
Pqf.pm.getAccumulatedTimesOfProject(projectId, beg) // returns AccumulatedTime
Pqf.pm.getAccumulatedTimesOfProject(projectId) // returns AccumulatedTime Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive) to restrict the times to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: AccumulatedTime
GET /API/V3/PM/Project/:projectId/ActiveScenario
Returns the active scenario of a project
HTTP syntax
GET /API/V3/PM/Project/:projectId/ActiveScenario?allowSingleInactive=...
<- application/json : PF.ReferenceWithParent JavaScript syntax
Pqf.pm.getActiveScenarioOfProject(projectId, allowSingleInactive) // returns PF.ReferenceWithParent
// Overloads for optional parameters
Pqf.pm.getActiveScenarioOfProject(projectId) // returns PF.ReferenceWithParent Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
allowSingleInactive |
boolean | Return also singleton scenarios that are not in an active state | false |
Result
This endpoint returns the following data: PF.ReferenceWithParent
GET /API/V3/PM/Project/:projectId/ActiveScenario/Timeline
Returns the reference (history) timeline of the active scenario of a project
HTTP syntax
GET /API/V3/PM/Project/:projectId/ActiveScenario/Timeline?allowSingleInactive=...&limit=...&until=...&from=...&granularity=...
<- application/json : PF.ReferenceTimeline JavaScript syntax
Pqf.pm.getActiveScenarioTimelineOfProject(projectId, allowSingleInactive, limit, until, from, granularity) // returns PF.ReferenceTimeline
// Overloads for optional parameters
Pqf.pm.getActiveScenarioTimelineOfProject(projectId, allowSingleInactive, limit, until, from) // returns PF.ReferenceTimeline
Pqf.pm.getActiveScenarioTimelineOfProject(projectId, allowSingleInactive, limit, until) // returns PF.ReferenceTimeline
Pqf.pm.getActiveScenarioTimelineOfProject(projectId, allowSingleInactive, limit) // returns PF.ReferenceTimeline
Pqf.pm.getActiveScenarioTimelineOfProject(projectId, allowSingleInactive) // returns PF.ReferenceTimeline
Pqf.pm.getActiveScenarioTimelineOfProject(projectId) // returns PF.ReferenceTimeline Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
allowSingleInactive |
boolean | Return also singleton scenarios that are not in an active state | false |
||
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.ReferenceTimeline
GET /API/V3/PM/Project/:projectId/Classification
Returns the classification of a project (including calculated values)
HTTP syntax
GET /API/V3/PM/Project/:projectId/Classification
<- application/json JavaScript syntax
Pqf.pm.getProjectClassification(projectId) // returns CLS.Classification[] Required license
This endpoint requires the following licenses:
- classifications
Required permission
Requires permission READ on object of type ProjectClassification and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CLS.Classification
PUT /API/V3/PM/Project/:projectId/Classification
Sets all classification values of a project (except calculated values)
HTTP syntax
PUT /API/V3/PM/Project/:projectId/Classification
-> application/json JavaScript syntax
Pqf.pm.putProjectClassification(projectId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- classifications
Required permission
Requires permission UPDATE on object of type ProjectClassification and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
array of CLS.Classification | JSON object of type array of Classification | ✔️ |
GET /API/V3/PM/Project/:projectId/Dependencies
Returns references to all dependencies that start or end in the active scenario of a given project, each one with the project scenarios and project portfolios its two ends sit in
HTTP syntax
GET /API/V3/PM/Project/:projectId/Dependencies?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectDependenciesOfProject(projectId, sort) // returns PF.ReferenceWithParents[]
// Overloads for optional parameters
Pqf.pm.getAllProjectDependenciesOfProject(projectId) // returns PF.ReferenceWithParents[] Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, predecessorType, predecessorId, successorType, successorId, minDistance, maxDistance | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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.ReferenceWithParents
GET /API/V3/PM/Project/:projectId/Identification
Get a project identification
HTTP syntax
GET /API/V3/PM/Project/:projectId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectIdentification(projectId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectIdentification(projectId) // returns PF.IdentificationExtended Other endpoints for objects of type project
This endpoint is part of a group of endpoints manipulating objects of type project. The following endpoints belong to the same group:
- GET /API/V3/PM/Project/:projectId: Get a project
- GET /API/
V3/ : Get multiple projectsPM/ Projects/ :projectIds - PUT /API/V3/PM/Project/:projectId: Update an existing project
- DELETE /API/V3/PM/Project/:projectId: Delete a project
- GET /API/
V3/ : Get multiple project identificationsPM/ Projects/ :projectIds/ Identification - GET /API/
V3/ : Get a project's version timelinePM/ Project/ :projectId/ Timeline - GET /API/
V3/ : Get a project's specific (historic) versionPM/ Project/ :projectId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted projectsPM/ Projects/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted projectPM/ Project/ :projectId/ Undelete
Required permission
Requires permission IDENTIFY on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId
Get a project's selection of an indicator, with the target it sets for it
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId
<- application/json : ProjectIndicatorDetail JavaScript syntax
Pqf.pm.getProjectIndicatorDetail(projectId, projectIndicatorDetailId) // returns ProjectIndicatorDetail Other endpoints for objects of type project indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for itsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds - PUT /API/
V3/ : Create or update a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - DELETE /API/
V3/ : Delete a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it identificationPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for it identificationsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDetailId |
UUID | The project's selection of an indicator, with the target it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectIndicatorDetail
PUT /API/V3/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId
Create or update a project's selection of an indicator, with the target it sets for it
HTTP syntax
PUT /API/V3/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId
-> application/json : ProjectIndicatorDetail JavaScript syntax
Pqf.pm.putProjectIndicatorDetail(projectId, projectIndicatorDetailId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for itsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds - DELETE /API/
V3/ : Delete a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it identificationPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for it identificationsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Version/ :versionId
Required permission
Requires permission UPDATE or CREATE on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDetailId |
UUID | The project's selection of an indicator, with the target it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectIndicatorDetail | JSON object of type ProjectIndicatorDetail | ✔️ |
DELETE /API/V3/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId
Delete a project's selection of an indicator, with the target it sets for it
HTTP syntax
DELETE /API/V3/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId JavaScript syntax
Pqf.pm.delProjectIndicatorDetail(projectId, projectIndicatorDetailId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for itsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds - PUT /API/
V3/ : Create or update a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it identificationPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for it identificationsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Version/ :versionId
Required permission
Requires permission DELETE on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDetailId |
UUID | The project's selection of an indicator, with the target it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId/Identification
Get a project's selection of an indicator, with the target it sets for it identification
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectIndicatorDetailIdentification(projectId, projectIndicatorDetailId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectIndicatorDetailIdentification(projectId, projectIndicatorDetailId) // returns PF.IdentificationExtended Other endpoints for objects of type project indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for itsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds - PUT /API/
V3/ : Create or update a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - DELETE /API/
V3/ : Delete a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for it identificationsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Version/ :versionId
Required permission
Requires permission IDENTIFY on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectIndicatorDetailId |
UUID | The project's selection of an indicator, with the target it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId/Timeline
Get a project's selection of an indicator, with the target it sets for it's version timeline
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.pm.getProjectIndicatorDetailTimeline(projectId, projectIndicatorDetailId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.pm.getProjectIndicatorDetailTimeline(projectId, projectIndicatorDetailId, limit, until, from) // returns PF.VersionTimeline
Pqf.pm.getProjectIndicatorDetailTimeline(projectId, projectIndicatorDetailId, limit, until) // returns PF.VersionTimeline
Pqf.pm.getProjectIndicatorDetailTimeline(projectId, projectIndicatorDetailId, limit) // returns PF.VersionTimeline
Pqf.pm.getProjectIndicatorDetailTimeline(projectId, projectIndicatorDetailId) // returns PF.VersionTimeline Other endpoints for objects of type project indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for itsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds - PUT /API/
V3/ : Create or update a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - DELETE /API/
V3/ : Delete a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it identificationPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for it identificationsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDetailId |
UUID | The project's selection of an indicator, with the target it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId/Version/:versionId
Get a project's selection of an indicator, with the target it sets for it's specific (historic) version
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDetail/:projectIndicatorDetailId/Version/:versionId
<- application/json : ProjectIndicatorDetail JavaScript syntax
Pqf.pm.getProjectIndicatorDetailVersion(projectId, projectIndicatorDetailId, versionId) // returns ProjectIndicatorDetail Other endpoints for objects of type project indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for itsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds - PUT /API/
V3/ : Create or update a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - DELETE /API/
V3/ : Delete a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it identificationPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for it identificationsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Timeline
Required permission
Requires permission READ on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDetailId |
UUID | The project's selection of an indicator, with the target it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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: ProjectIndicatorDetail
GET /API/V3/PM/Project/:projectId/IndicatorDetails
Returns references to a project's indicator selections, optionally only those of one project report type
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDetails?projectReportTypeId=...
<- application/json JavaScript syntax
Pqf.pm.getProjectIndicatorDetailsOfProject(projectId, projectReportTypeId) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getProjectIndicatorDetailsOfProject(projectId) // returns PF.Reference[] Required permission
Requires permission READ on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportTypeId |
UUID | Only the selections belonging to this project report type | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/PM/Project/:projectId/IndicatorDetails/:projectIndicatorDetailIds
Get multiple project's selection of an indicator, with the target it sets for its
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDetails/:projectIndicatorDetailIds
<- application/json JavaScript syntax
Pqf.pm.getProjectIndicatorDetails(projectId, projectIndicatorDetailIds) // returns ProjectIndicatorDetail[] Other endpoints for objects of type project indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - PUT /API/
V3/ : Create or update a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - DELETE /API/
V3/ : Delete a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it identificationPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for it identificationsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDetailIds |
array of UUID | The project's selection of an indicator, with the target it sets for it IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectIndicatorDetail
GET /API/V3/PM/Project/:projectId/IndicatorDetails/:projectIndicatorDetailIds/Identification
Get multiple project's selection of an indicator, with the target it sets for it identifications
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDetails/:projectIndicatorDetailIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectIndicatorDetailIdentifications(projectId, projectIndicatorDetailIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectIndicatorDetailIdentifications(projectId, projectIndicatorDetailIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get multiple project's selection of an indicator, with the target it sets for itsPM/ Project/ :projectId/ IndicatorDetails/ :projectIndicatorDetailIds - PUT /API/
V3/ : Create or update a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - DELETE /API/
V3/ : Delete a project's selection of an indicator, with the target it sets for itPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it identificationPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Identification - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator, with the target it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDetail/ :projectIndicatorDetailId/ Version/ :versionId
Required permission
Requires permission IDENTIFY on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectIndicatorDetailIds |
array of UUID | The project's selection of an indicator, with the target it sets for it IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId
Get a project's selection of an indicator dimension, with the guidelines it sets for it
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId
<- application/json : ProjectIndicatorDimension JavaScript syntax
Pqf.pm.getProjectIndicatorDimension(projectId, projectIndicatorDimensionId) // returns ProjectIndicatorDimension Other endpoints for objects of type project indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for itsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds - PUT /API/
V3/ : Create or update a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - DELETE /API/
V3/ : Delete a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it identificationPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for it identificationsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDimensionId |
UUID | The project's selection of an indicator dimension, with the guidelines it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectIndicatorDimension
PUT /API/V3/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId
Create or update a project's selection of an indicator dimension, with the guidelines it sets for it
HTTP syntax
PUT /API/V3/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId
-> application/json : ProjectIndicatorDimension JavaScript syntax
Pqf.pm.putProjectIndicatorDimension(projectId, projectIndicatorDimensionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for itsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds - DELETE /API/
V3/ : Delete a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it identificationPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for it identificationsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Version/ :versionId
Required permission
Requires permission UPDATE or CREATE on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDimensionId |
UUID | The project's selection of an indicator dimension, with the guidelines it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectIndicatorDimension | JSON object of type ProjectIndicatorDimension | ✔️ |
DELETE /API/V3/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId
Delete a project's selection of an indicator dimension, with the guidelines it sets for it
HTTP syntax
DELETE /API/V3/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId JavaScript syntax
Pqf.pm.delProjectIndicatorDimension(projectId, projectIndicatorDimensionId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for itsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds - PUT /API/
V3/ : Create or update a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it identificationPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for it identificationsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Version/ :versionId
Required permission
Requires permission DELETE on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDimensionId |
UUID | The project's selection of an indicator dimension, with the guidelines it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId/Identification
Get a project's selection of an indicator dimension, with the guidelines it sets for it identification
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectIndicatorDimensionIdentification(projectId, projectIndicatorDimensionId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectIndicatorDimensionIdentification(projectId, projectIndicatorDimensionId) // returns PF.IdentificationExtended Other endpoints for objects of type project indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for itsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds - PUT /API/
V3/ : Create or update a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - DELETE /API/
V3/ : Delete a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for it identificationsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Version/ :versionId
Required permission
Requires permission IDENTIFY on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectIndicatorDimensionId |
UUID | The project's selection of an indicator dimension, with the guidelines it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId/Timeline
Get a project's selection of an indicator dimension, with the guidelines it sets for it's version timeline
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.pm.getProjectIndicatorDimensionTimeline(projectId, projectIndicatorDimensionId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.pm.getProjectIndicatorDimensionTimeline(projectId, projectIndicatorDimensionId, limit, until, from) // returns PF.VersionTimeline
Pqf.pm.getProjectIndicatorDimensionTimeline(projectId, projectIndicatorDimensionId, limit, until) // returns PF.VersionTimeline
Pqf.pm.getProjectIndicatorDimensionTimeline(projectId, projectIndicatorDimensionId, limit) // returns PF.VersionTimeline
Pqf.pm.getProjectIndicatorDimensionTimeline(projectId, projectIndicatorDimensionId) // returns PF.VersionTimeline Other endpoints for objects of type project indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for itsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds - PUT /API/
V3/ : Create or update a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - DELETE /API/
V3/ : Delete a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it identificationPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for it identificationsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDimensionId |
UUID | The project's selection of an indicator dimension, with the guidelines it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId/Version/:versionId
Get a project's selection of an indicator dimension, with the guidelines it sets for it's specific (historic) version
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDimension/:projectIndicatorDimensionId/Version/:versionId
<- application/json : ProjectIndicatorDimension JavaScript syntax
Pqf.pm.getProjectIndicatorDimensionVersion(projectId, projectIndicatorDimensionId, versionId) // returns ProjectIndicatorDimension Other endpoints for objects of type project indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for itsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds - PUT /API/
V3/ : Create or update a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - DELETE /API/
V3/ : Delete a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it identificationPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for it identificationsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Timeline
Required permission
Requires permission READ on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDimensionId |
UUID | The project's selection of an indicator dimension, with the guidelines it sets for it's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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: ProjectIndicatorDimension
GET /API/V3/PM/Project/:projectId/IndicatorDimensions
Returns references to a project's indicator dimension selections, optionally only those of one project report type
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDimensions?projectReportTypeId=...
<- application/json JavaScript syntax
Pqf.pm.getProjectIndicatorDimensionsOfProject(projectId, projectReportTypeId) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getProjectIndicatorDimensionsOfProject(projectId) // returns PF.Reference[] Required permission
Requires permission READ on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportTypeId |
UUID | Only the selections belonging to this project report type | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/PM/Project/:projectId/IndicatorDimensions/:projectIndicatorDimensionIds
Get multiple project's selection of an indicator dimension, with the guidelines it sets for its
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDimensions/:projectIndicatorDimensionIds
<- application/json JavaScript syntax
Pqf.pm.getProjectIndicatorDimensions(projectId, projectIndicatorDimensionIds) // returns ProjectIndicatorDimension[] Other endpoints for objects of type project indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - PUT /API/
V3/ : Create or update a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - DELETE /API/
V3/ : Delete a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it identificationPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Identification - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for it identificationsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds/ Identification - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectIndicatorDimensionIds |
array of UUID | The project's selection of an indicator dimension, with the guidelines it sets for it IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectIndicatorDimension
GET /API/V3/PM/Project/:projectId/IndicatorDimensions/:projectIndicatorDimensionIds/Identification
Get multiple project's selection of an indicator dimension, with the guidelines it sets for it identifications
HTTP syntax
GET /API/V3/PM/Project/:projectId/IndicatorDimensions/:projectIndicatorDimensionIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectIndicatorDimensionIdentifications(projectId, projectIndicatorDimensionIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectIndicatorDimensionIdentifications(projectId, projectIndicatorDimensionIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get multiple project's selection of an indicator dimension, with the guidelines it sets for itsPM/ Project/ :projectId/ IndicatorDimensions/ :projectIndicatorDimensionIds - PUT /API/
V3/ : Create or update a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - DELETE /API/
V3/ : Delete a project's selection of an indicator dimension, with the guidelines it sets for itPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it identificationPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Identification - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's version timelinePM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Timeline - GET /API/
V3/ : Get a project's selection of an indicator dimension, with the guidelines it sets for it's specific (historic) versionPM/ Project/ :projectId/ IndicatorDimension/ :projectIndicatorDimensionId/ Version/ :versionId
Required permission
Requires permission IDENTIFY on object of type ProjectIndicatorSel and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectIndicatorDimensionIds |
array of UUID | The project's selection of an indicator dimension, with the guidelines it sets for it IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/Project/:projectId/LatestReport
Returns a reference to the latest report of a project, optionally only among reports of some types and in some lifecycle states. A report the caller may not identify is reported as not found
HTTP syntax
GET /API/V3/PM/Project/:projectId/LatestReport?reportTypeFilter=...&stateFilter=...&skip=...
<- application/json : PF.ReferenceWithParent JavaScript syntax
Pqf.pm.getLatestProjectReportOfProject(projectId, reportTypeFilter, stateFilter, skip) // returns PF.ReferenceWithParent
// Overloads for optional parameters
Pqf.pm.getLatestProjectReportOfProject(projectId, reportTypeFilter, stateFilter) // returns PF.ReferenceWithParent
Pqf.pm.getLatestProjectReportOfProject(projectId, reportTypeFilter) // returns PF.ReferenceWithParent
Pqf.pm.getLatestProjectReportOfProject(projectId) // returns PF.ReferenceWithParent Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
reportTypeFilter |
array of UUID | Only reports of these types count, all types if omitted | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
stateFilter |
array of UUID | Only reports in one of these lifecycle states count, any state if omitted | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
skip |
int | Skips the latest n matching reports | s >= 0 (The value must be at least 0.) |
0 |
Result
This endpoint returns the following data: PF.ReferenceWithParent
DELETE /API/V3/PM/Project/:projectId/Link
Unlinks a project from a portfolio
HTTP syntax
DELETE /API/V3/PM/Project/:projectId/Link?projectPortfolioId=... JavaScript syntax
Pqf.pm.unlinkProject(projectId, projectPortfolioId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission UPDATE on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Requires permission UPDATE on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectPortfolioId |
UUID | The portfolio ID from which the project should be unlinked (required) | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
POST /API/V3/PM/Project/:projectId/Link
Links a project to a portfolio
HTTP syntax
POST /API/V3/PM/Project/:projectId/Link?projectPortfolioId=... JavaScript syntax
Pqf.pm.linkProject(projectId, projectPortfolioId) // returns Number - the return code (HTTP 2xx code) of the callRequired permission
Requires permission UPDATE on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Requires permission UPDATE on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectPortfolioId |
UUID | The portfolio ID to which the project should be linked (required) | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/Project/:projectId/Methodology
Returns a reference to the project management methodology a project follows
HTTP syntax
GET /API/V3/PM/Project/:projectId/Methodology
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.getProjectManagementMethodologyOfProject(projectId) // returns PF.Reference Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/Project/:projectId/MethodologyPhase
Returns a reference to the project management methodology phase a project is in, with its methodology as parent
HTTP syntax
GET /API/V3/PM/Project/:projectId/MethodologyPhase
<- application/json : PF.ReferenceWithParent JavaScript syntax
Pqf.pm.getProjectManagementMethodologyPhaseOfProject(projectId) // returns PF.ReferenceWithParent Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: PF.ReferenceWithParent
GET /API/V3/PM/Project/:projectId/MethodologyTimeline
Returns the project management methodology of a project, its phases and its timing according to the project's lifecycle history and active scenario planning
HTTP syntax
GET /API/V3/PM/Project/:projectId/MethodologyTimeline
<- application/json : ProjectManagementMethodologyTimeline JavaScript syntax
Pqf.pm.getProjectManagementMethodologyTimelineOfProject(projectId) // returns ProjectManagementMethodologyTimeline Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectManagementMethodologyTimeline
POST /API/V3/PM/Project/:projectId/MoveTo
Moves a project from one portfolio to another
HTTP syntax
POST /API/V3/PM/Project/:projectId/MoveTo?fromPortfolioId=...&toPortfolioId=... JavaScript syntax
Pqf.pm.moveProject(projectId, fromPortfolioId, toPortfolioId) // returns Number - the return code (HTTP 2xx code) of the callRequired permission
Requires permission UPDATE on object of type Project and ID specified in parameter projectId.
Requires permission UPDATE on object of type ProjectPortfolio and ID specified in parameter fromPortfolioId.
Requires permission UPDATE on object of type ProjectPortfolio and ID specified in parameter toPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
fromPortfolioId |
UUID | The portfolio ID from which to move (required) | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
toPortfolioId |
UUID | The portfolio ID to move to (required) | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/Project/:projectId/Parents
Returns references to the parent portfolios of a project, in the same order as getAllProjects reports them
HTTP syntax
GET /API/V3/PM/Project/:projectId/Parents
<- application/json JavaScript syntax
Pqf.pm.getProjectParents(projectId) // returns PF.Reference[] Required permission
Requires permission IDENTIFY on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/PM/Project/:projectId/Reports
Returns all project reports of a given project
HTTP syntax
GET /API/V3/PM/Project/:projectId/Reports?reportTypeFilter=...&sort=...
<- application/json JavaScript syntax
Pqf.pm.getProjectReportsOfProject(projectId, reportTypeFilter, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getProjectReportsOfProject(projectId, reportTypeFilter) // returns PF.ReferenceWithParent[]
Pqf.pm.getProjectReportsOfProject(projectId) // returns PF.ReferenceWithParent[] 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 '[ (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.) |
reportTypeFilter |
array of UUID | filter by type, return all types, if not provided | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectId, currencyId and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/Project/:projectId/Reports/Add/:reportType
Adds a new report of the given type to a project. If the report type has a JavaScript data collector and this endpoint is called from JavaScript, it answers with HTTP 202 and returns the reference before the report is stored: the data collector can only run after the calling script has finished, so the referenced report does not exist yet while the calling script is running.
HTTP syntax
POST /API/V3/PM/Project/:projectId/Reports/Add/:reportType?copy=...¤cyId=...&name=...&code=...&description=...&color=...&iconRef=...&periodStart=...&periodEnd=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addProjectReport(projectId, reportType, copy, currencyId, name, code, description, color, iconRef, periodStart, periodEnd) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.addProjectReport(projectId, reportType, copy, currencyId, name, code, description, color, iconRef, periodStart) // returns PF.Reference
Pqf.pm.addProjectReport(projectId, reportType, copy, currencyId, name, code, description, color, iconRef) // returns PF.Reference
Pqf.pm.addProjectReport(projectId, reportType, copy, currencyId, name, code, description, color) // returns PF.Reference
Pqf.pm.addProjectReport(projectId, reportType, copy, currencyId, name, code, description) // returns PF.Reference
Pqf.pm.addProjectReport(projectId, reportType, copy, currencyId, name, code) // returns PF.Reference
Pqf.pm.addProjectReport(projectId, reportType, copy, currencyId, name) // returns PF.Reference
Pqf.pm.addProjectReport(projectId, reportType, copy, currencyId) // returns PF.Reference
Pqf.pm.addProjectReport(projectId, reportType, copy) // returns PF.Reference
Pqf.pm.addProjectReport(projectId, reportType) // returns PF.Reference Required permission
Requires permission CREATE on object of type specified in parameter reportType.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
copy |
UUID | A report of the same type to be used as template, an empty report if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
currencyId |
UUID | The currency the report is calculated and stored in, the user's default currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
name |
string | The name of the new project report, unnamed if omitted | ||
code |
string | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
|
description |
string | A descriptive text about the new project report, may contain HTML | ||
color |
color | The color of the new project report | ||
iconRef |
URI | The icon of the new project report, 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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
|
periodStart |
date | Start (inclusive) of the reporting period of the new project report, derived from the report type's schedule if omitted | ||
periodEnd |
date | End (exclusive) of the reporting period of the new project report, derived from the report type's schedule if omitted |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/Project/:projectId/Scenarios
Returns all scenarios of a project
HTTP syntax
GET /API/V3/PM/Project/:projectId/Scenarios?sort=...
<- application/json JavaScript syntax
Pqf.pm.getScenariosOfProject(projectId, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getScenariosOfProject(projectId) // returns PF.ReferenceWithParent[] 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 '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectId 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 '[ (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/PM/Project/:projectId/Scenarios/Add
Adds a new scenario to a project
HTTP syntax
POST /API/V3/PM/Project/:projectId/Scenarios/Add?copy=...©Relations=...©PlannedCosts=...©DocumentLinks=...©ShiftPlans=...©Dependencies=...©Allocations=...©Logs=...©TodoLinks=...©Todos=...&name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos, name, code, description, color, iconRef) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos, name, code, description, color) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos, name, code, description) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos, name, code) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos, name) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks, copyShiftPlans) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts, copyDocumentLinks) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations, copyPlannedCosts) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy, copyRelations) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId, copy) // returns PF.Reference
Pqf.pm.addProjectScenario(projectId) // returns PF.Reference Required permission
Requires permission CREATE on object of type Scenario.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
copy |
UUID | Creates a copy of an existing scenario, if set | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
copyRelations |
boolean | Copy relations | false |
||
copyPlannedCosts |
boolean | Copy plannedCosts | false |
||
copyDocumentLinks |
boolean | Copy document links | false |
||
copyShiftPlans |
boolean | Copy shift plans | false |
||
copyDependencies |
boolean | Copy dependencies | false |
||
copyAllocations |
boolean | Copy allocations | false |
||
copyLogs |
boolean | Copy logs | false |
||
copyTodoLinks |
boolean | Copy todo links | false |
||
copyTodos |
boolean | Copy todos | false |
||
name |
string | The name of the new scenario, 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 scenario, may contain HTML | |||
color |
color | The color of the new scenario | |||
iconRef |
URI | The icon of the new scenario, 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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
Result
This endpoint returns the following data: PF.Reference
POST /API/V3/PM/Project/:projectId/Scenarios/Import
Adds a new scenario to a project by uploading a project file (MS Project, MPX, XML, ...)
HTTP syntax
POST /API/V3/PM/Project/:projectId/Scenarios/Import?format=...
-> application/octet-stream
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.importProjectScenario(projectId, format, requestBinary) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.importProjectScenario(projectId, requestBinary) // returns PF.Reference Required permission
Requires permission CREATE on object of type Scenario.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
format |
string | The file format of the uploaded project file, auto detected from the file content when omitted. Possible values: MPP (MS Project), MPX (MS Project exchange), MSPDI (MS Project XML), XML (Planner), PM (Primavera P6 XML), XER (Primavera P6 XER), MPXJ (ProjectLibre) | matches '(?i)MPP (The value, if present, must be one of "MPP", "MPX", "MSPDI", "XML", "PM", "XER" or "MPXJ" (case-insensitive).) |
|
requestBinary |
Binary | Raw content of mime type application/octet-stream | ✔️ |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/Project/:projectId/SubObject/:subObjectType
Returns a specific sub object for a given project (that the user is permitted to READ)
HTTP syntax
GET /API/V3/PM/Project/:projectId/SubObject/:subObjectType
<- application/json : PF.SubObject JavaScript syntax
Pqf.pm.getProjectSubObject(projectId, subObjectType) // returns PF.SubObject Required permission
Requires permission READ on object of type specified in parameter subObjectType and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subObjectType |
UUID | The sub object's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: PF.SubObject
PUT /API/V3/PM/Project/:projectId/SubObject/:subObjectType
Updates a specific sub object for a given project (that the user is permitted to UPDATE)
HTTP syntax
PUT /API/V3/PM/Project/:projectId/SubObject/:subObjectType
-> application/json : PF.SubObject JavaScript syntax
Pqf.pm.putProjectSubObject(projectId, subObjectType, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission UPDATE on object of type specified in parameter subObjectType and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subObjectType |
UUID | The sub object's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
PF.SubObject | JSON object of type SubObject | ✔️ |
GET /API/V3/PM/Project/:projectId/SubObject/:subObjectType/Timeline
Returns the version timeline of a specific sub object of a given project (that the user is permitted to READ)
HTTP syntax
GET /API/V3/PM/Project/:projectId/SubObject/:subObjectType/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.pm.getProjectSubObjectTimeline(projectId, subObjectType, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.pm.getProjectSubObjectTimeline(projectId, subObjectType, limit, until, from) // returns PF.VersionTimeline
Pqf.pm.getProjectSubObjectTimeline(projectId, subObjectType, limit, until) // returns PF.VersionTimeline
Pqf.pm.getProjectSubObjectTimeline(projectId, subObjectType, limit) // returns PF.VersionTimeline
Pqf.pm.getProjectSubObjectTimeline(projectId, subObjectType) // returns PF.VersionTimeline Required permission
Requires permission READ on object of type specified in parameter subObjectType and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subObjectType |
UUID | The sub object's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/PM/Project/:projectId/SubObject/:subObjectType/Version/:versionId
Returns a specific (historic) version of a sub object of a given project (that the user is permitted to READ)
HTTP syntax
GET /API/V3/PM/Project/:projectId/SubObject/:subObjectType/Version/:versionId
<- application/json : PF.SubObject JavaScript syntax
Pqf.pm.getProjectSubObjectVersion(projectId, subObjectType, versionId) // returns PF.SubObject Required permission
Requires permission READ on object of type specified in parameter subObjectType and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subObjectType |
UUID | The sub object's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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: PF.SubObject
GET /API/V3/PM/Project/:projectId/SubObjects
Returns all sub objects for a given project (that the user is permitted to READ)
HTTP syntax
GET /API/V3/PM/Project/:projectId/SubObjects
<- application/json JavaScript syntax
Pqf.pm.getProjectSubObjects(projectId) // returns PF.SubObject[] Required permission
The returned array is filtered and contains only objects with permission READ.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.SubObject
GET /API/V3/PM/Project/:projectId/Timeline
Get a project's version timeline
HTTP syntax
GET /API/V3/PM/Project/:projectId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.pm.getProjectTimeline(projectId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.pm.getProjectTimeline(projectId, limit, until, from) // returns PF.VersionTimeline
Pqf.pm.getProjectTimeline(projectId, limit, until) // returns PF.VersionTimeline
Pqf.pm.getProjectTimeline(projectId, limit) // returns PF.VersionTimeline
Pqf.pm.getProjectTimeline(projectId) // returns PF.VersionTimeline Other endpoints for objects of type project
This endpoint is part of a group of endpoints manipulating objects of type project. The following endpoints belong to the same group:
- GET /API/V3/PM/Project/:projectId: Get a project
- GET /API/
V3/ : Get multiple projectsPM/ Projects/ :projectIds - PUT /API/V3/PM/Project/:projectId: Update an existing project
- DELETE /API/V3/PM/Project/:projectId: Delete a project
- GET /API/
V3/ : Get a project identificationPM/ Project/ :projectId/ Identification - GET /API/
V3/ : Get multiple project identificationsPM/ Projects/ :projectIds/ Identification - GET /API/
V3/ : Get a project's specific (historic) versionPM/ Project/ :projectId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted projectsPM/ Projects/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted projectPM/ Project/ :projectId/ Undelete
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/PM/Project/:projectId/Version/:versionId
Get a project's specific (historic) version
HTTP syntax
GET /API/V3/PM/Project/:projectId/Version/:versionId
<- application/json : Project JavaScript syntax
Pqf.pm.getProjectVersion(projectId, versionId) // returns Project Other endpoints for objects of type project
This endpoint is part of a group of endpoints manipulating objects of type project. The following endpoints belong to the same group:
- GET /API/V3/PM/Project/:projectId: Get a project
- GET /API/
V3/ : Get multiple projectsPM/ Projects/ :projectIds - PUT /API/V3/PM/Project/:projectId: Update an existing project
- DELETE /API/V3/PM/Project/:projectId: Delete a project
- GET /API/
V3/ : Get a project identificationPM/ Project/ :projectId/ Identification - GET /API/
V3/ : Get multiple project identificationsPM/ Projects/ :projectIds/ Identification - GET /API/
V3/ : Get a project's version timelinePM/ Project/ :projectId/ Timeline - GET /API/
V3/ : Get recently deleted projectsPM/ Projects/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted projectPM/ Project/ :projectId/ Undelete
Required permission
Requires permission READ on object of type Project and ID specified in parameter projectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectId |
UUID | The project's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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: Project
GET /API/V3/PM/ProjectDependencies
Returns references to all dependencies between milestones the caller may read, each one with the project scenarios and project portfolios its two ends sit in: a dependency in objects they may not read is left out rather than reported
HTTP syntax
GET /API/V3/PM/ProjectDependencies?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectDependencies(sort) // returns PF.ReferenceWithParents[]
// Overloads for optional parameters
Pqf.pm.getAllProjectDependencies() // returns PF.ReferenceWithParents[] 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, predecessorType, predecessorId, successorType, successorId, minDistance, maxDistance | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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.ReferenceWithParents
GET /API/V3/PM/ProjectDependencies/:projectDependencyIds
Returns some dependencies between milestones specified by their IDs; requires permission READ on the project scenario or the project portfolio behind either of the two ends of each one
HTTP syntax
GET /API/V3/PM/ProjectDependencies/:projectDependencyIds
<- application/json JavaScript syntax
Pqf.pm.getProjectDependencies(projectDependencyIds) // returns ProjectDependency[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectDependencyIds |
array of UUID | The IDs of the project dependencies | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectDependency
POST /API/V3/PM/ProjectDependencies/Add
Adds a dependency between two milestones; requires permission UPDATE on the project scenario or the project portfolio behind either of its two ends
HTTP syntax
POST /API/V3/PM/ProjectDependencies/Add?predecessorType=...&predecessorId=...&successorType=...&successorId=...&minDistance=...&maxDistance=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addProjectDependency(predecessorType, predecessorId, successorType, successorId, minDistance, maxDistance) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.addProjectDependency(predecessorType, predecessorId, successorType, successorId, minDistance) // returns PF.Reference
Pqf.pm.addProjectDependency(predecessorType, predecessorId, successorType, successorId) // returns PF.Reference Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
predecessorType |
UUID | The type of the milestone where the dependency starts, either ProjectMilestone or ProjectPortfolioMilestone | ✔️ | non-null & matches 'ProjectMilestone (The value is required and must be either "ProjectMilestone" or "ProjectPortfolioMilestone".) |
|
predecessorId |
UUID | The ID of the milestone where the dependency starts | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
successorType |
UUID | The type of the milestone where the dependency ends, either ProjectMilestone or ProjectPortfolioMilestone | ✔️ | non-null & matches 'ProjectMilestone (The value is required and must be either "ProjectMilestone" or "ProjectPortfolioMilestone".) |
|
successorId |
UUID | The ID of the milestone where the dependency ends | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
minDistance |
int? | The minimal number of days between the two milestones | 0 |
||
maxDistance |
int? | The maximal number of days between the two milestones (omit it for a dependency without an upper limit) |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/ProjectDependency/:projectDependencyId
Returns a dependency between two milestones; requires permission READ on the project scenario or the project portfolio behind either of its two ends
HTTP syntax
GET /API/V3/PM/ProjectDependency/:projectDependencyId
<- application/json : ProjectDependency JavaScript syntax
Pqf.pm.getProjectDependency(projectDependencyId) // returns ProjectDependency Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectDependencyId |
UUID | The project dependency's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectDependency
PUT /API/V3/PM/ProjectDependency/:projectDependencyId
Creates or updates a dependency between two milestones; the two ends of an existing dependency cannot be changed. Requires permission UPDATE on the project scenario or the project portfolio behind either of its two ends
HTTP syntax
PUT /API/V3/PM/ProjectDependency/:projectDependencyId
-> application/json : ProjectDependency JavaScript syntax
Pqf.pm.putProjectDependency(projectDependencyId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectDependencyId |
UUID | The project dependency's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectDependency | JSON object of type ProjectDependency | ✔️ |
DELETE /API/V3/PM/ProjectDependency/:projectDependencyId
Deletes a dependency between two milestones; requires permission UPDATE on the project scenario or the project portfolio behind either of its two ends
HTTP syntax
DELETE /API/V3/PM/ProjectDependency/:projectDependencyId JavaScript syntax
Pqf.pm.delProjectDependency(projectDependencyId) // returns Number - the return code (HTTP 2xx code) of the call Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectDependencyId |
UUID | The project dependency's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectMilestone/:projectMilestoneId
returns a project milestone (a real milestone's position or a task's start or end)
HTTP syntax
GET /API/V3/PM/ProjectMilestone/:projectMilestoneId
<- application/json : ProjectMilestone JavaScript syntax
Pqf.pm.getProjectMilestone(projectMilestoneId) // returns ProjectMilestone Required permission
Requires permission READ on parent with type ProjectWorkItemobject of type ProjectMilestone and ID specified in parameter projectMilestoneId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectMilestoneId |
UUID | the milestone's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectMilestone
PUT /API/V3/PM/ProjectMilestone/:projectMilestoneId
Sets a project milestone's position and fixed flag; unlike a move, no other work item or milestone is adjusted
HTTP syntax
PUT /API/V3/PM/ProjectMilestone/:projectMilestoneId
-> application/json : ProjectMilestone JavaScript syntax
Pqf.pm.putProjectMilestone(projectMilestoneId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission UPDATE on parent with type ProjectWorkItemobject of type ProjectMilestone and ID specified in parameter projectMilestoneId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectMilestoneId |
UUID | the milestone's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectMilestone | JSON object of type ProjectMilestone | ✔️ |
GET /API/V3/PM/ProjectMilestone/:projectMilestoneId/Constraints
Returns references to the constraints that start or end in a given project milestone; requires permission READ on the work item the milestone belongs to
HTTP syntax
GET /API/V3/PM/ProjectMilestone/:projectMilestoneId/Constraints?direction=...&sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectMilestoneConstraintsOfProjectMilestone(projectMilestoneId, direction, sort) // returns ProjectMilestoneConstraintReference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectMilestoneConstraintsOfProjectMilestone(projectMilestoneId, direction) // returns ProjectMilestoneConstraintReference[]
Pqf.pm.getAllProjectMilestoneConstraintsOfProjectMilestone(projectMilestoneId) // returns ProjectMilestoneConstraintReference[] Required permission
Requires permission READ on parent with type ProjectWorkItemobject of type ProjectMilestone and ID specified in parameter projectMilestoneId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectMilestoneId |
UUID | The project milestone's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
direction |
string | Limits the answer to the constraints the milestone is the PREDECESSOR resp. the SUCCESSOR of, both if omitted | matches 'PREDECESSOR\|SUCCESSOR' (The value, if present, must be either "PREDECESSOR" or "SUCCESSOR".) |
|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, constraintType, predecessorMilestoneId, successorMilestoneId, minDistance, maxDistance | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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 ProjectMilestoneConstraintReference
GET /API/V3/PM/ProjectMilestoneConstraint/:projectMilestoneConstraintId
Returns a constraint between two milestones of the same project scenario; requires permission READ on that project scenario
HTTP syntax
GET /API/V3/PM/ProjectMilestoneConstraint/:projectMilestoneConstraintId
<- application/json : ProjectMilestoneConstraint JavaScript syntax
Pqf.pm.getProjectMilestoneConstraint(projectMilestoneConstraintId) // returns ProjectMilestoneConstraint Required permission
Requires permission READ on parent with type Scenarioobject of type ProjectMilestoneConstraint and ID specified in parameter projectMilestoneConstraintId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectMilestoneConstraintId |
UUID | The project milestone constraint's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectMilestoneConstraint
PUT /API/V3/PM/ProjectMilestoneConstraint/:projectMilestoneConstraintId
Updates the distances of an existing constraint between two milestones of the same project scenario; its two ends and its constraint type cannot be changed, and a distance other than a minimum of 0 needs the advancedtaskdependencies license. Requires permission UPDATE on the project scenario
HTTP syntax
PUT /API/V3/PM/ProjectMilestoneConstraint/:projectMilestoneConstraintId
-> application/json : ProjectMilestoneConstraint JavaScript syntax
Pqf.pm.putProjectMilestoneConstraint(projectMilestoneConstraintId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission UPDATE on parent with type Scenarioobject of type ProjectMilestoneConstraint and ID specified in parameter projectMilestoneConstraintId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectMilestoneConstraintId |
UUID | The project milestone constraint's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectMilestoneConstraint | JSON object of type ProjectMilestoneConstraint | ✔️ |
DELETE /API/V3/PM/ProjectMilestoneConstraint/:projectMilestoneConstraintId
Deletes a constraint between two milestones of the same project scenario; requires permission UPDATE on that project scenario
HTTP syntax
DELETE /API/V3/PM/ProjectMilestoneConstraint/:projectMilestoneConstraintId JavaScript syntax
Pqf.pm.delProjectMilestoneConstraint(projectMilestoneConstraintId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission UPDATE on parent with type Scenarioobject of type ProjectMilestoneConstraint and ID specified in parameter projectMilestoneConstraintId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectMilestoneConstraintId |
UUID | The project milestone constraint's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
POST /API/V3/PM/ProjectMilestoneConstraint/:projectMilestoneConstraintId/Fix
Moves one of the two milestones of a constraint so that the constraint holds; requires permission UPDATE on the project scenario the constraint sits in
HTTP syntax
POST /API/V3/PM/ProjectMilestoneConstraint/:projectMilestoneConstraintId/Fix?move=...&resourceId=... JavaScript syntax
Pqf.pm.fixProjectMilestoneConstraint(projectMilestoneConstraintId, move, resourceId) // returns Number - the return code (HTTP 2xx code) of the call
// Overloads for optional parameters
Pqf.pm.fixProjectMilestoneConstraint(projectMilestoneConstraintId, move) // returns Number - the return code (HTTP 2xx code) of the call Required license
The usage of the parameter resourceId requires the following licenses:
- fivedaysweek
Required permission
Requires permission UPDATE on parent with type Scenarioobject of type ProjectMilestoneConstraint and ID specified in parameter projectMilestoneConstraintId.
Parameters
| Name | Type | Description | Required | Assertion | Required license |
|---|---|---|---|---|---|
projectMilestoneConstraintId |
UUID | The project milestone constraint's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
move |
string | Which end of the constraint moves, the PREDECESSOR or the SUCCESSOR (mandatory) | ✔️ | matches 'PREDECESSOR\|SUCCESSOR' (The value must be either "PREDECESSOR" or "SUCCESSOR".) |
|
resourceId |
UUID | The resource ID for workdays | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
fivedaysweek |
GET /API/V3/PM/ProjectMilestoneConstraints/:projectMilestoneConstraintIds
Returns some constraints between milestones specified by their IDs; requires permission READ on the project scenario behind each one
HTTP syntax
GET /API/V3/PM/ProjectMilestoneConstraints/:projectMilestoneConstraintIds
<- application/json JavaScript syntax
Pqf.pm.getProjectMilestoneConstraints(projectMilestoneConstraintIds) // returns ProjectMilestoneConstraint[] Required permission
Requires permission READ on parent with type Scenarioobject of type ProjectMilestoneConstraint and ID in specified in parameter projectMilestoneConstraintIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectMilestoneConstraintIds |
array of UUID | The IDs of the project milestone constraints | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectMilestoneConstraint
GET /API/V3/PM/ProjectMilestones/:milestoneIds
returns some project milestones (a real milestone's position or a task's start or end)
HTTP syntax
GET /API/V3/PM/ProjectMilestones/:milestoneIds
<- application/json JavaScript syntax
Pqf.pm.getProjectMilestones(milestoneIds) // returns ProjectMilestone[] Required permission
Requires permission READ on parent with type ProjectWorkItemobject of type ProjectMilestone and ID in specified in parameter milestoneIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
milestoneIds |
array of UUID | The project milestones' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectMilestone
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId
Get a project portfolio
HTTP syntax
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId
<- application/json : ProjectPortfolio JavaScript syntax
Pqf.pm.getProjectPortfolio(projectPortfolioId) // returns ProjectPortfolio Other endpoints for objects of type project portfolio
This endpoint is part of a group of endpoints manipulating objects of type project portfolio. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple project portfoliosPM/ ProjectPortfolios/ :projectPortfolioIds - PUT /API/
V3/ : Update an existing project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - DELETE /API/
V3/ : Delete a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get a project portfolio identificationPM/ ProjectPortfolio/ :projectPortfolioId/ Identification - GET /API/
V3/ : Get multiple project portfolio identificationsPM/ ProjectPortfolios/ :projectPortfolioIds/ Identification - GET /API/
V3/ : Get a project portfolio's version timelinePM/ ProjectPortfolio/ :projectPortfolioId/ Timeline - GET /API/
V3/ : Get a project portfolio's specific (historic) versionPM/ ProjectPortfolio/ :projectPortfolioId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectPortfolio
PUT /API/V3/PM/ProjectPortfolio/:projectPortfolioId
Update an existing project portfolio
HTTP syntax
PUT /API/V3/PM/ProjectPortfolio/:projectPortfolioId
-> application/json : ProjectPortfolio JavaScript syntax
Pqf.pm.putProjectPortfolio(projectPortfolioId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project portfolio
This endpoint is part of a group of endpoints manipulating objects of type project portfolio. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get multiple project portfoliosPM/ ProjectPortfolios/ :projectPortfolioIds - DELETE /API/
V3/ : Delete a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get a project portfolio identificationPM/ ProjectPortfolio/ :projectPortfolioId/ Identification - GET /API/
V3/ : Get multiple project portfolio identificationsPM/ ProjectPortfolios/ :projectPortfolioIds/ Identification - GET /API/
V3/ : Get a project portfolio's version timelinePM/ ProjectPortfolio/ :projectPortfolioId/ Timeline - GET /API/
V3/ : Get a project portfolio's specific (historic) versionPM/ ProjectPortfolio/ :projectPortfolioId/ Version/ :versionId
Required license
This endpoint requires the following licenses:
- portfolios
Required permission
Requires permission UPDATE or CREATE on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectPortfolio | JSON object of type ProjectPortfolio | ✔️ |
DELETE /API/V3/PM/ProjectPortfolio/:projectPortfolioId
Delete a project portfolio
HTTP syntax
DELETE /API/V3/PM/ProjectPortfolio/:projectPortfolioId JavaScript syntax
Pqf.pm.delProjectPortfolio(projectPortfolioId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project portfolio
This endpoint is part of a group of endpoints manipulating objects of type project portfolio. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get multiple project portfoliosPM/ ProjectPortfolios/ :projectPortfolioIds - PUT /API/
V3/ : Update an existing project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get a project portfolio identificationPM/ ProjectPortfolio/ :projectPortfolioId/ Identification - GET /API/
V3/ : Get multiple project portfolio identificationsPM/ ProjectPortfolios/ :projectPortfolioIds/ Identification - GET /API/
V3/ : Get a project portfolio's version timelinePM/ ProjectPortfolio/ :projectPortfolioId/ Timeline - GET /API/
V3/ : Get a project portfolio's specific (historic) versionPM/ ProjectPortfolio/ :projectPortfolioId/ Version/ :versionId
Required license
This endpoint requires the following licenses:
- portfolios
Required permission
Requires permission DELETE on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Dependencies
Returns references to all dependencies that start or end in a given project portfolio, each one with the project scenarios and project portfolios its two ends sit in
HTTP syntax
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Dependencies?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectDependenciesOfProjectPortfolio(projectPortfolioId, sort) // returns PF.ReferenceWithParents[]
// Overloads for optional parameters
Pqf.pm.getAllProjectDependenciesOfProjectPortfolio(projectPortfolioId) // returns PF.ReferenceWithParents[] Required permission
Requires permission READ on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, predecessorType, predecessorId, successorType, successorId, minDistance, maxDistance | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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.ReferenceWithParents
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Identification
Get a project portfolio identification
HTTP syntax
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectPortfolioIdentification(projectPortfolioId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectPortfolioIdentification(projectPortfolioId) // returns PF.IdentificationExtended Other endpoints for objects of type project portfolio
This endpoint is part of a group of endpoints manipulating objects of type project portfolio. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get multiple project portfoliosPM/ ProjectPortfolios/ :projectPortfolioIds - PUT /API/
V3/ : Update an existing project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - DELETE /API/
V3/ : Delete a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get multiple project portfolio identificationsPM/ ProjectPortfolios/ :projectPortfolioIds/ Identification - GET /API/
V3/ : Get a project portfolio's version timelinePM/ ProjectPortfolio/ :projectPortfolioId/ Timeline - GET /API/
V3/ : Get a project portfolio's specific (historic) versionPM/ ProjectPortfolio/ :projectPortfolioId/ Version/ :versionId
Required permission
Requires permission IDENTIFY on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/LatestReport
Returns a reference to the latest report of a project portfolio, optionally only among reports of some types and in some lifecycle states. A report the caller may not identify is reported as not found
HTTP syntax
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/LatestReport?reportTypeFilter=...&stateFilter=...&skip=...
<- application/json : PF.ReferenceWithParent JavaScript syntax
Pqf.pm.getLatestProjectPortfolioReportOfProjectPortfolio(projectPortfolioId, reportTypeFilter, stateFilter, skip) // returns PF.ReferenceWithParent
// Overloads for optional parameters
Pqf.pm.getLatestProjectPortfolioReportOfProjectPortfolio(projectPortfolioId, reportTypeFilter, stateFilter) // returns PF.ReferenceWithParent
Pqf.pm.getLatestProjectPortfolioReportOfProjectPortfolio(projectPortfolioId, reportTypeFilter) // returns PF.ReferenceWithParent
Pqf.pm.getLatestProjectPortfolioReportOfProjectPortfolio(projectPortfolioId) // returns PF.ReferenceWithParent Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
Requires permission READ on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
reportTypeFilter |
array of UUID | Only reports of these types count, all types if omitted | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
stateFilter |
array of UUID | Only reports in one of these lifecycle states count, any state if omitted | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
skip |
int | Skips the latest n matching reports | s >= 0 (The value must be at least 0.) |
0 |
Result
This endpoint returns the following data: PF.ReferenceWithParent
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Milestones
Returns all project portfolio milestones of a given portfolio
HTTP syntax
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Milestones?includeParentPortfolios=...&sort=...
<- application/json JavaScript syntax
Pqf.pm.getProjectPortfolioMilestonesOfProjectPortfolio(projectPortfolioId, includeParentPortfolios, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getProjectPortfolioMilestonesOfProjectPortfolio(projectPortfolioId, includeParentPortfolios) // returns PF.ReferenceWithParent[]
Pqf.pm.getProjectPortfolioMilestonesOfProjectPortfolio(projectPortfolioId) // returns PF.ReferenceWithParent[] Required permission
Requires permission READ on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
includeParentPortfolios |
boolean | Include also the milestones of the parent project portfolios | false |
||
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, projectPortfolioId, position 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 '[ (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/PM/ProjectPortfolio/:projectPortfolioId/Milestones/Add
Adds a new milestone to a project portfolio
HTTP syntax
POST /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Milestones/Add?name=...&code=...&description=...&color=...&iconRef=...&position=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addProjectPortfolioMilestone(projectPortfolioId, name, code, description, color, iconRef, position) // returns PF.Reference Required permission
Requires permission CREATE on object of type ProjectPortfolioMilestone.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
string | The name of the new project portfolio milestone, a localized default name if omitted | ||
code |
string | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
|
description |
string | A descriptive text about the new project portfolio milestone, may contain HTML | ||
color |
color | The color of the new project portfolio milestone | ||
iconRef |
URI | The icon of the new project portfolio milestone, 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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
|
position |
date | The position of the new project portfolio milestone on the time axis (required) | ✔️ |
Result
This endpoint returns the following data: PF.Reference
POST /API/V3/PM/ProjectPortfolio/:projectPortfolioId/MoveTo
Moves a project portfolio into another
HTTP syntax
POST /API/V3/PM/ProjectPortfolio/:projectPortfolioId/MoveTo?parentPortfolioId=... JavaScript syntax
Pqf.pm.moveProjectPortfolio(projectPortfolioId, parentPortfolioId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- subportfolio
Required permission
Requires permission UPDATE on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Requires permission CREATE on object of type ProjectPortfolio.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | the project portfolio ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
parentPortfolioId |
UUID | The destination portfolio (required) | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
POST /API/V3/PM/ProjectPortfolio/:projectPortfolioId/MoveToTop
Moves a project portfolio to the top (the PM module)
HTTP syntax
POST /API/V3/PM/ProjectPortfolio/:projectPortfolioId/MoveToTop JavaScript syntax
Pqf.pm.moveProjectPortfolioToTop(projectPortfolioId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission UPDATE on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Requires permission CREATE on object of type ProjectPortfolio.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | the project portfolio ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Parent
Returns the parent portfolio of a project portfolio
HTTP syntax
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Parent
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.getProjectPortfolioParentPortfolio(projectPortfolioId) // returns PF.Reference Required permission
Requires permission IDENTIFY on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Projects
Returns the references of the projects that are part of a specific project portfolio
HTTP syntax
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Projects?sort=...
<- application/json JavaScript syntax
Pqf.pm.getProjectsOfProjectPortfolio(projectPortfolioId, sort) // returns PF.ReferenceWithParents[]
// Overloads for optional parameters
Pqf.pm.getProjectsOfProjectPortfolio(projectPortfolioId) // returns PF.ReferenceWithParents[] Required permission
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | the project portfolio ID | ✔️ | matches '[ (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 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 '[ (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.ReferenceWithParents
POST /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Projects/Add
Adds a new project to a project portfolio
HTTP syntax
POST /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Projects/Add?copy=...©Relations=...©Classification=...©PlannedCosts=...©DocumentLinks=...©ShiftPlans=...©Dependencies=...©Allocations=...©Logs=...©TodoLinks=...©Todos=...©Risks=...&name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos, copyRisks, name, code, description, color, iconRef) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos, copyRisks, name, code, description, color) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos, copyRisks, name, code, description) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos, copyRisks, name, code) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos, copyRisks, name) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos, copyRisks) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks, copyTodos) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs, copyTodoLinks) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyLogs) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans, copyDependencies) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks, copyShiftPlans) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts, copyDocumentLinks) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification, copyPlannedCosts) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations, copyClassification) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy, copyRelations) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId, copy) // returns PF.Reference
Pqf.pm.addProjectPortfolioProject(projectPortfolioId) // returns PF.Reference Required license
The usage of the parameter copyClassification requires the following licenses:
- classifications
Required permission
Requires permission CREATE on object of type Project.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted | Required license |
|---|---|---|---|---|---|---|
projectPortfolioId |
UUID | the project portfolio ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
copy |
UUID | Creates a copy of an existing project, if set | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|||
copyRelations |
boolean | Copy relations | false |
|||
copyClassification |
boolean | Copy classification | false |
classifications |
||
copyPlannedCosts |
boolean | Copy plannedCosts | false |
|||
copyDocumentLinks |
boolean | Copy document links | false |
|||
copyShiftPlans |
boolean | Copy shift plans | false |
|||
copyDependencies |
boolean | Copy dependencies | false |
|||
copyAllocations |
boolean | Copy allocations | false |
|||
copyLogs |
boolean | Copy logs | false |
|||
copyTodoLinks |
boolean | Copy todo links | false |
|||
copyTodos |
boolean | Copy todos | false |
|||
copyRisks |
boolean | Copy risks | false |
|||
name |
string | The name of the new project, a localized default name if omitted | ||||
code |
string | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
|||
description |
string | A descriptive text about the new project, may contain HTML | ||||
color |
color | The color of the new project | ||||
iconRef |
URI | The icon of the new project, 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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
Result
This endpoint returns the following data: PF.Reference
POST /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Projects/Import
Adds a new project to a project portfolio by uploading a project file (MS Project, MPX, XML, ...)
HTTP syntax
POST /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Projects/Import?format=...
-> application/octet-stream
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.importProjectPortfolioProject(projectPortfolioId, format, requestBinary) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.importProjectPortfolioProject(projectPortfolioId, requestBinary) // returns PF.Reference Required permission
Requires permission CREATE on object of type Project.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | the project portfolio ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
format |
string | The file format of the uploaded project file, auto detected from the file content when omitted. Possible values: MPP (MS Project), MPX (MS Project exchange), MSPDI (MS Project XML), XML (Planner), PM (Primavera P6 XML), XER (Primavera P6 XER), MPXJ (ProjectLibre) | matches '(?i)MPP (The value, if present, must be one of "MPP", "MPX", "MSPDI", "XML", "PM", "XER" or "MPXJ" (case-insensitive).) |
|
requestBinary |
Binary | Raw content of mime type application/octet-stream | ✔️ |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Reports
Returns all project portfolio reports of a given portfolio
HTTP syntax
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Reports?reportTypeFilter=...&sort=...
<- application/json JavaScript syntax
Pqf.pm.getProjectPortfolioReportsOfProjectPortfolio(projectPortfolioId, reportTypeFilter, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getProjectPortfolioReportsOfProjectPortfolio(projectPortfolioId, reportTypeFilter) // returns PF.ReferenceWithParent[]
Pqf.pm.getProjectPortfolioReportsOfProjectPortfolio(projectPortfolioId) // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
Requires permission READ on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
reportTypeFilter |
array of UUID | filter by type, return all types, if not provided | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
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, projectPortfolioId and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/ProjectPortfolio/:projectPortfolioId/Reports/Add/:reportType
Adds a new report of the given type to a project portfolio
HTTP syntax
POST /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Reports/Add/:reportType?copy=...&name=...&code=...&description=...&color=...&iconRef=...&periodStart=...&periodEnd=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addProjectPortfolioReport(projectPortfolioId, reportType, copy, name, code, description, color, iconRef, periodStart, periodEnd) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.addProjectPortfolioReport(projectPortfolioId, reportType, copy, name, code, description, color, iconRef, periodStart) // returns PF.Reference
Pqf.pm.addProjectPortfolioReport(projectPortfolioId, reportType, copy, name, code, description, color, iconRef) // returns PF.Reference
Pqf.pm.addProjectPortfolioReport(projectPortfolioId, reportType, copy, name, code, description, color) // returns PF.Reference
Pqf.pm.addProjectPortfolioReport(projectPortfolioId, reportType, copy, name, code, description) // returns PF.Reference
Pqf.pm.addProjectPortfolioReport(projectPortfolioId, reportType, copy, name, code) // returns PF.Reference
Pqf.pm.addProjectPortfolioReport(projectPortfolioId, reportType, copy, name) // returns PF.Reference
Pqf.pm.addProjectPortfolioReport(projectPortfolioId, reportType, copy) // returns PF.Reference
Pqf.pm.addProjectPortfolioReport(projectPortfolioId, reportType) // returns PF.Reference Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
Requires permission CREATE on object of type specified in parameter reportType.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
reportType |
UUID | The project portfolio report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
copy |
UUID | A report of the same type to be used as template, an empty report if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
name |
string | The name of the new project portfolio report, unnamed if omitted | ||
code |
string | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
|
description |
string | A descriptive text about the new project portfolio report, may contain HTML | ||
color |
color | The color of the new project portfolio report | ||
iconRef |
URI | The icon of the new project portfolio report, 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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
|
periodStart |
date | Start (inclusive) of the reporting period of the new project portfolio report, derived from the report type's schedule if omitted | ||
periodEnd |
date | End (exclusive) of the reporting period of the new project portfolio report, derived from the report type's schedule if omitted |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/SubPortfolios
Returns references to the sub-portfolios of a project portfolio
HTTP syntax
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/SubPortfolios?sort=...
<- application/json JavaScript syntax
Pqf.pm.getSubPortfoliosOfProjectPortfolio(projectPortfolioId, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getSubPortfoliosOfProjectPortfolio(projectPortfolioId) // returns PF.ReferenceWithParent[] Required permission
Requires permission IDENTIFY on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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 '[ (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/PM/ProjectPortfolio/:projectPortfolioId/SubPortfolios/Add
Adds a new project portfolio to a project portfolio
HTTP syntax
POST /API/V3/PM/ProjectPortfolio/:projectPortfolioId/SubPortfolios/Add?copy=...©Relations=...&name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addProjectPortfolioSubPortfolio(projectPortfolioId, copy, copyRelations, name, code, description, color, iconRef) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.addProjectPortfolioSubPortfolio(projectPortfolioId, copy, copyRelations, name, code, description, color) // returns PF.Reference
Pqf.pm.addProjectPortfolioSubPortfolio(projectPortfolioId, copy, copyRelations, name, code, description) // returns PF.Reference
Pqf.pm.addProjectPortfolioSubPortfolio(projectPortfolioId, copy, copyRelations, name, code) // returns PF.Reference
Pqf.pm.addProjectPortfolioSubPortfolio(projectPortfolioId, copy, copyRelations, name) // returns PF.Reference
Pqf.pm.addProjectPortfolioSubPortfolio(projectPortfolioId, copy, copyRelations) // returns PF.Reference
Pqf.pm.addProjectPortfolioSubPortfolio(projectPortfolioId, copy) // returns PF.Reference
Pqf.pm.addProjectPortfolioSubPortfolio(projectPortfolioId) // returns PF.Reference Required license
This endpoint requires the following licenses:
- subportfolio
Required permission
Requires permission CREATE on object of type ProjectPortfolio.
Requires permission READ on object of type ProjectPortfolio and ID specified in parameter copy if it is set.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectPortfolioId |
UUID | the project portfolio ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
copy |
UUID | Project portfolio to copy | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
copyRelations |
boolean | When copying (copy is set), also copy relations | false |
||
name |
string | The name of the new project portfolio, a localized default name if omitted | |||
code |
string | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
||
description |
string | A descriptive text about the new project portfolio, may contain HTML | |||
color |
color | The color of the new project portfolio | |||
iconRef |
URI | The icon of the new project portfolio, 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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Timeline
Get a project portfolio's version timeline
HTTP syntax
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.pm.getProjectPortfolioTimeline(projectPortfolioId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.pm.getProjectPortfolioTimeline(projectPortfolioId, limit, until, from) // returns PF.VersionTimeline
Pqf.pm.getProjectPortfolioTimeline(projectPortfolioId, limit, until) // returns PF.VersionTimeline
Pqf.pm.getProjectPortfolioTimeline(projectPortfolioId, limit) // returns PF.VersionTimeline
Pqf.pm.getProjectPortfolioTimeline(projectPortfolioId) // returns PF.VersionTimeline Other endpoints for objects of type project portfolio
This endpoint is part of a group of endpoints manipulating objects of type project portfolio. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get multiple project portfoliosPM/ ProjectPortfolios/ :projectPortfolioIds - PUT /API/
V3/ : Update an existing project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - DELETE /API/
V3/ : Delete a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get a project portfolio identificationPM/ ProjectPortfolio/ :projectPortfolioId/ Identification - GET /API/
V3/ : Get multiple project portfolio identificationsPM/ ProjectPortfolios/ :projectPortfolioIds/ Identification - GET /API/
V3/ : Get a project portfolio's specific (historic) versionPM/ ProjectPortfolio/ :projectPortfolioId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/PM/ProjectPortfolio/:projectPortfolioId/Version/:versionId
Get a project portfolio's specific (historic) version
HTTP syntax
GET /API/V3/PM/ProjectPortfolio/:projectPortfolioId/Version/:versionId
<- application/json : ProjectPortfolio JavaScript syntax
Pqf.pm.getProjectPortfolioVersion(projectPortfolioId, versionId) // returns ProjectPortfolio Other endpoints for objects of type project portfolio
This endpoint is part of a group of endpoints manipulating objects of type project portfolio. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get multiple project portfoliosPM/ ProjectPortfolios/ :projectPortfolioIds - PUT /API/
V3/ : Update an existing project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - DELETE /API/
V3/ : Delete a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get a project portfolio identificationPM/ ProjectPortfolio/ :projectPortfolioId/ Identification - GET /API/
V3/ : Get multiple project portfolio identificationsPM/ ProjectPortfolios/ :projectPortfolioIds/ Identification - GET /API/
V3/ : Get a project portfolio's version timelinePM/ ProjectPortfolio/ :projectPortfolioId/ Timeline
Required permission
Requires permission READ on object of type ProjectPortfolio and ID specified in parameter projectPortfolioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioId |
UUID | The project portfolio's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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: ProjectPortfolio
GET /API/V3/PM/ProjectPortfolioMilestone/:projectPortfolioMilestoneId
Get a project portfolio milestone
HTTP syntax
GET /API/V3/PM/ProjectPortfolioMilestone/:projectPortfolioMilestoneId
<- application/json : ProjectPortfolioMilestone JavaScript syntax
Pqf.pm.getProjectPortfolioMilestone(projectPortfolioMilestoneId) // returns ProjectPortfolioMilestone Other endpoints for objects of type project portfolio milestone
This endpoint is part of a group of endpoints manipulating objects of type project portfolio milestone. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple project portfolio milestonesPM/ ProjectPortfolioMilestones/ :projectPortfolioMilestoneIds - PUT /API/
V3/ : Update an existing project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - DELETE /API/
V3/ : Delete a project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - GET /API/
V3/ : Get a project portfolio milestone identificationPM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId/ Identification - GET /API/
V3/ : Get multiple project portfolio milestone identificationsPM/ ProjectPortfolioMilestones/ :projectPortfolioMilestoneIds/ Identification
Required permission
Requires permission READ on object of type ProjectPortfolioMilestone and ID specified in parameter projectPortfolioMilestoneId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioMilestoneId |
UUID | The project portfolio milestone's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectPortfolioMilestone
PUT /API/V3/PM/ProjectPortfolioMilestone/:projectPortfolioMilestoneId
Update an existing project portfolio milestone
HTTP syntax
PUT /API/V3/PM/ProjectPortfolioMilestone/:projectPortfolioMilestoneId
-> application/json : ProjectPortfolioMilestone JavaScript syntax
Pqf.pm.putProjectPortfolioMilestone(projectPortfolioMilestoneId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project portfolio milestone
This endpoint is part of a group of endpoints manipulating objects of type project portfolio milestone. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - GET /API/
V3/ : Get multiple project portfolio milestonesPM/ ProjectPortfolioMilestones/ :projectPortfolioMilestoneIds - DELETE /API/
V3/ : Delete a project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - GET /API/
V3/ : Get a project portfolio milestone identificationPM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId/ Identification - GET /API/
V3/ : Get multiple project portfolio milestone identificationsPM/ ProjectPortfolioMilestones/ :projectPortfolioMilestoneIds/ Identification
Required permission
Requires permission UPDATE or CREATE on object of type ProjectPortfolioMilestone and ID specified in parameter projectPortfolioMilestoneId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioMilestoneId |
UUID | The project portfolio milestone's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectPortfolioMilestone | JSON object of type ProjectPortfolioMilestone | ✔️ |
DELETE /API/V3/PM/ProjectPortfolioMilestone/:projectPortfolioMilestoneId
Delete a project portfolio milestone
HTTP syntax
DELETE /API/V3/PM/ProjectPortfolioMilestone/:projectPortfolioMilestoneId JavaScript syntax
Pqf.pm.delProjectPortfolioMilestone(projectPortfolioMilestoneId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project portfolio milestone
This endpoint is part of a group of endpoints manipulating objects of type project portfolio milestone. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - GET /API/
V3/ : Get multiple project portfolio milestonesPM/ ProjectPortfolioMilestones/ :projectPortfolioMilestoneIds - PUT /API/
V3/ : Update an existing project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - GET /API/
V3/ : Get a project portfolio milestone identificationPM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId/ Identification - GET /API/
V3/ : Get multiple project portfolio milestone identificationsPM/ ProjectPortfolioMilestones/ :projectPortfolioMilestoneIds/ Identification
Required permission
Requires permission DELETE on object of type ProjectPortfolioMilestone and ID specified in parameter projectPortfolioMilestoneId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioMilestoneId |
UUID | The project portfolio milestone's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectPortfolioMilestone/:projectPortfolioMilestoneId/Identification
Get a project portfolio milestone identification
HTTP syntax
GET /API/V3/PM/ProjectPortfolioMilestone/:projectPortfolioMilestoneId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectPortfolioMilestoneIdentification(projectPortfolioMilestoneId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectPortfolioMilestoneIdentification(projectPortfolioMilestoneId) // returns PF.IdentificationExtended Other endpoints for objects of type project portfolio milestone
This endpoint is part of a group of endpoints manipulating objects of type project portfolio milestone. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - GET /API/
V3/ : Get multiple project portfolio milestonesPM/ ProjectPortfolioMilestones/ :projectPortfolioMilestoneIds - PUT /API/
V3/ : Update an existing project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - DELETE /API/
V3/ : Delete a project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - GET /API/
V3/ : Get multiple project portfolio milestone identificationsPM/ ProjectPortfolioMilestones/ :projectPortfolioMilestoneIds/ Identification
Required permission
Requires permission IDENTIFY on object of type ProjectPortfolioMilestone and ID specified in parameter projectPortfolioMilestoneId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectPortfolioMilestoneId |
UUID | The project portfolio milestone's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/ProjectPortfolioMilestones
Returns all project portfolio milestones
HTTP syntax
GET /API/V3/PM/ProjectPortfolioMilestones?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectPortfolioMilestones(sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getAllProjectPortfolioMilestones() // returns PF.ReferenceWithParent[] 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, projectPortfolioId, position 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 '[ (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/PM/ProjectPortfolioMilestones/:projectPortfolioMilestoneIds
Get multiple project portfolio milestones
HTTP syntax
GET /API/V3/PM/ProjectPortfolioMilestones/:projectPortfolioMilestoneIds
<- application/json JavaScript syntax
Pqf.pm.getProjectPortfolioMilestones(projectPortfolioMilestoneIds) // returns ProjectPortfolioMilestone[] Other endpoints for objects of type project portfolio milestone
This endpoint is part of a group of endpoints manipulating objects of type project portfolio milestone. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - PUT /API/
V3/ : Update an existing project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - DELETE /API/
V3/ : Delete a project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - GET /API/
V3/ : Get a project portfolio milestone identificationPM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId/ Identification - GET /API/
V3/ : Get multiple project portfolio milestone identificationsPM/ ProjectPortfolioMilestones/ :projectPortfolioMilestoneIds/ Identification
Required permission
Requires permission READ on object of type ProjectPortfolioMilestone and ID in specified in parameter projectPortfolioMilestoneIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioMilestoneIds |
array of UUID | The project portfolio milestone IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectPortfolioMilestone
GET /API/V3/PM/ProjectPortfolioMilestones/:projectPortfolioMilestoneIds/Identification
Get multiple project portfolio milestone identifications
HTTP syntax
GET /API/V3/PM/ProjectPortfolioMilestones/:projectPortfolioMilestoneIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectPortfolioMilestoneIdentifications(projectPortfolioMilestoneIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectPortfolioMilestoneIdentifications(projectPortfolioMilestoneIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project portfolio milestone
This endpoint is part of a group of endpoints manipulating objects of type project portfolio milestone. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - GET /API/
V3/ : Get multiple project portfolio milestonesPM/ ProjectPortfolioMilestones/ :projectPortfolioMilestoneIds - PUT /API/
V3/ : Update an existing project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - DELETE /API/
V3/ : Delete a project portfolio milestonePM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId - GET /API/
V3/ : Get a project portfolio milestone identificationPM/ ProjectPortfolioMilestone/ :projectPortfolioMilestoneId/ Identification
Required permission
Requires permission IDENTIFY on object of type ProjectPortfolioMilestone and ID in specified in parameter projectPortfolioMilestoneIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectPortfolioMilestoneIds |
array of UUID | The project portfolio milestone IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/ProjectPortfolioReport/:reportType/:projectPortfolioReportId
Get a project portfolio report
HTTP syntax
GET /API/V3/PM/ProjectPortfolioReport/:reportType/:projectPortfolioReportId
<- application/json : ProjectPortfolioReport JavaScript syntax
Pqf.pm.getProjectPortfolioReport(reportType, projectPortfolioReportId) // returns ProjectPortfolioReport Other endpoints for objects of type project portfolio report
This endpoint is part of a group of endpoints manipulating objects of type project portfolio report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple project portfolio reportsPM/ ProjectPortfolioReports/ :reportType/ :projectPortfolioReportIds - PUT /API/
V3/ : Update an existing project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - DELETE /API/
V3/ : Delete a project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - GET /API/
V3/ : Get a project portfolio report identificationPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId/ Identification - GET /API/
V3/ : Get multiple project portfolio report identificationsPM/ ProjectPortfolioReports/ :reportType/ :projectPortfolioReportIds/ Identification
Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
Requires permission READ on object of type specified in parameter reportType and ID specified in parameter projectPortfolioReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project portfolio report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectPortfolioReportId |
UUID | The project portfolio report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectPortfolioReport
PUT /API/V3/PM/ProjectPortfolioReport/:reportType/:projectPortfolioReportId
Update an existing project portfolio report
HTTP syntax
PUT /API/V3/PM/ProjectPortfolioReport/:reportType/:projectPortfolioReportId
-> application/json : ProjectPortfolioReport JavaScript syntax
Pqf.pm.putProjectPortfolioReport(reportType, projectPortfolioReportId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project portfolio report
This endpoint is part of a group of endpoints manipulating objects of type project portfolio report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - GET /API/
V3/ : Get multiple project portfolio reportsPM/ ProjectPortfolioReports/ :reportType/ :projectPortfolioReportIds - DELETE /API/
V3/ : Delete a project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - GET /API/
V3/ : Get a project portfolio report identificationPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId/ Identification - GET /API/
V3/ : Get multiple project portfolio report identificationsPM/ ProjectPortfolioReports/ :reportType/ :projectPortfolioReportIds/ Identification
Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
Requires permission UPDATE or CREATE on object of type specified in parameter reportType and ID specified in parameter projectPortfolioReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project portfolio report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectPortfolioReportId |
UUID | The project portfolio report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectPortfolioReport | JSON object of type ProjectPortfolioReport | ✔️ |
DELETE /API/V3/PM/ProjectPortfolioReport/:reportType/:projectPortfolioReportId
Delete a project portfolio report
HTTP syntax
DELETE /API/V3/PM/ProjectPortfolioReport/:reportType/:projectPortfolioReportId JavaScript syntax
Pqf.pm.delProjectPortfolioReport(reportType, projectPortfolioReportId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project portfolio report
This endpoint is part of a group of endpoints manipulating objects of type project portfolio report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - GET /API/
V3/ : Get multiple project portfolio reportsPM/ ProjectPortfolioReports/ :reportType/ :projectPortfolioReportIds - PUT /API/
V3/ : Update an existing project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - GET /API/
V3/ : Get a project portfolio report identificationPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId/ Identification - GET /API/
V3/ : Get multiple project portfolio report identificationsPM/ ProjectPortfolioReports/ :reportType/ :projectPortfolioReportIds/ Identification
Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
Requires permission DELETE on object of type specified in parameter reportType and ID specified in parameter projectPortfolioReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project portfolio report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectPortfolioReportId |
UUID | The project portfolio report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectPortfolioReport/:reportType/:projectPortfolioReportId/Identification
Get a project portfolio report identification
HTTP syntax
GET /API/V3/PM/ProjectPortfolioReport/:reportType/:projectPortfolioReportId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectPortfolioReportIdentification(reportType, projectPortfolioReportId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectPortfolioReportIdentification(reportType, projectPortfolioReportId) // returns PF.IdentificationExtended Other endpoints for objects of type project portfolio report
This endpoint is part of a group of endpoints manipulating objects of type project portfolio report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - GET /API/
V3/ : Get multiple project portfolio reportsPM/ ProjectPortfolioReports/ :reportType/ :projectPortfolioReportIds - PUT /API/
V3/ : Update an existing project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - DELETE /API/
V3/ : Delete a project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - GET /API/
V3/ : Get multiple project portfolio report identificationsPM/ ProjectPortfolioReports/ :reportType/ :projectPortfolioReportIds/ Identification
Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
Requires permission IDENTIFY on object of type specified in parameter reportType and ID specified in parameter projectPortfolioReportId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
reportType |
UUID | The project portfolio report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectPortfolioReportId |
UUID | The project portfolio report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/ProjectPortfolioReports
Returns all project portfolio reports
HTTP syntax
GET /API/V3/PM/ProjectPortfolioReports?reportTypeFilter=...&sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectPortfolioReports(reportTypeFilter, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getAllProjectPortfolioReports(reportTypeFilter) // returns PF.ReferenceWithParent[]
Pqf.pm.getAllProjectPortfolioReports() // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportTypeFilter |
array of UUID | filter by type, return all types, if not provided | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
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, projectPortfolioId and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/ProjectPortfolioReports/:reportType/:projectPortfolioReportIds
Get multiple project portfolio reports
HTTP syntax
GET /API/V3/PM/ProjectPortfolioReports/:reportType/:projectPortfolioReportIds
<- application/json JavaScript syntax
Pqf.pm.getProjectPortfolioReports(reportType, projectPortfolioReportIds) // returns ProjectPortfolioReport[] Other endpoints for objects of type project portfolio report
This endpoint is part of a group of endpoints manipulating objects of type project portfolio report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - PUT /API/
V3/ : Update an existing project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - DELETE /API/
V3/ : Delete a project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - GET /API/
V3/ : Get a project portfolio report identificationPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId/ Identification - GET /API/
V3/ : Get multiple project portfolio report identificationsPM/ ProjectPortfolioReports/ :reportType/ :projectPortfolioReportIds/ Identification
Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
Requires permission READ on object of type specified in parameter reportType and ID in specified in parameter projectPortfolioReportIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project portfolio report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectPortfolioReportIds |
array of UUID | The project portfolio report IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectPortfolioReport
GET /API/V3/PM/ProjectPortfolioReports/:reportType/:projectPortfolioReportIds/Identification
Get multiple project portfolio report identifications
HTTP syntax
GET /API/V3/PM/ProjectPortfolioReports/:reportType/:projectPortfolioReportIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectPortfolioReportIdentifications(reportType, projectPortfolioReportIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectPortfolioReportIdentifications(reportType, projectPortfolioReportIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project portfolio report
This endpoint is part of a group of endpoints manipulating objects of type project portfolio report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - GET /API/
V3/ : Get multiple project portfolio reportsPM/ ProjectPortfolioReports/ :reportType/ :projectPortfolioReportIds - PUT /API/
V3/ : Update an existing project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - DELETE /API/
V3/ : Delete a project portfolio reportPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId - GET /API/
V3/ : Get a project portfolio report identificationPM/ ProjectPortfolioReport/ :reportType/ :projectPortfolioReportId/ Identification
Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
Requires permission IDENTIFY on object of type specified in parameter reportType and ID in specified in parameter projectPortfolioReportIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
reportType |
UUID | The project portfolio report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectPortfolioReportIds |
array of UUID | The project portfolio report IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/ProjectPortfolioReportType/:projectPortfolioReportTypeId
Returns a project portfolio report type
HTTP syntax
GET /API/V3/PM/ProjectPortfolioReportType/:projectPortfolioReportTypeId
<- application/json : ProjectPortfolioReportType JavaScript syntax
Pqf.pm.getProjectPortfolioReportType(projectPortfolioReportTypeId) // returns ProjectPortfolioReportType Required license
This endpoint requires the following licenses:
- portfolioreports
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioReportTypeId |
UUID | The ID of the project portfolio report type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectPortfolioReportType
GET /API/V3/PM/ProjectPortfolioReportType/:projectPortfolioReportTypeId/WithTranslations
Returns a project portfolio report type with translations
HTTP syntax
GET /API/V3/PM/ProjectPortfolioReportType/:projectPortfolioReportTypeId/WithTranslations
<- application/json : ProjectPortfolioReportTypeTranslated JavaScript syntax
Pqf.pm.getProjectPortfolioReportTypeTranslated(projectPortfolioReportTypeId) // returns ProjectPortfolioReportTypeTranslated Required license
This endpoint requires the following licenses:
- portfolioreports
- config-reporttype
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioReportTypeId |
UUID | The ID of the project portfolio report type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectPortfolioReportTypeTranslated
PUT /API/V3/PM/ProjectPortfolioReportType/:projectPortfolioReportTypeId/WithTranslations
Updates a project portfolio report type with translations
HTTP syntax
PUT /API/V3/PM/ProjectPortfolioReportType/:projectPortfolioReportTypeId/WithTranslations
-> application/json : ProjectPortfolioReportTypeTranslated JavaScript syntax
Pqf.pm.putProjectPortfolioReportTypeTranslated(projectPortfolioReportTypeId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- portfolioreports
- config-reporttype
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioReportTypeId |
UUID | The ID of the project portfolio report type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectPortfolioReportTypeTranslated | JSON object of type ProjectPortfolioReportTypeTranslated | ✔️ |
DELETE /API/V3/PM/ProjectPortfolioReportType/:projectPortfolioReportTypeId/WithTranslations
Deletes a project portfolio report type with translations
HTTP syntax
DELETE /API/V3/PM/ProjectPortfolioReportType/:projectPortfolioReportTypeId/WithTranslations JavaScript syntax
Pqf.pm.delProjectPortfolioReportTypeTranslated(projectPortfolioReportTypeId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- portfolioreports
- config-reporttype
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioReportTypeId |
UUID | The ID of the project portfolio report type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectPortfolioReportType/:reportType/Reports
Returns all project portfolio reports of a given type
HTTP syntax
GET /API/V3/PM/ProjectPortfolioReportType/:reportType/Reports?sort=...
<- application/json JavaScript syntax
Pqf.pm.getProjectPortfolioReportsOfType(reportType, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getProjectPortfolioReportsOfType(reportType) // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project portfolio report type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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, projectPortfolioId 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 '[ (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/PM/ProjectPortfolioReportTypes
Returns references to all project portfolio report types
HTTP syntax
GET /API/V3/PM/ProjectPortfolioReportTypes?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectPortfolioReportTypes(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectPortfolioReportTypes() // returns PF.Reference[] Required license
This endpoint requires the following licenses:
- portfolioreports
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, sortIndex | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/ProjectPortfolioReportTypes/:reportTypeIds
Returns some project portfolio report types specified by their IDs
HTTP syntax
GET /API/V3/PM/ProjectPortfolioReportTypes/:reportTypeIds
<- application/json JavaScript syntax
Pqf.pm.getProjectPortfolioReportTypes(reportTypeIds) // returns ProjectPortfolioReportType[] Required license
This endpoint requires the following licenses:
- portfolioreports
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportTypeIds |
array of UUID | The IDs of the project portfolio report types | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectPortfolioReportType
GET /API/V3/PM/ProjectPortfolioReportTypes/:reportTypeIds/WithTranslations
Returns project portfolio report types with translations
HTTP syntax
GET /API/V3/PM/ProjectPortfolioReportTypes/:reportTypeIds/WithTranslations
<- application/json JavaScript syntax
Pqf.pm.getProjectPortfolioReportTypesTranslated(reportTypeIds) // returns ProjectPortfolioReportTypeTranslated[] Required license
This endpoint requires the following licenses:
- portfolioreports
- config-reporttype
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportTypeIds |
array of UUID | The IDs of the project portfolio report types | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectPortfolioReportTypeTranslated
GET /API/V3/PM/ProjectPortfolios
Returns references to all project portfolios
HTTP syntax
GET /API/V3/PM/ProjectPortfolios?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectPortfolios(sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getAllProjectPortfolios() // returns PF.ReferenceWithParent[] 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 '[ (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/PM/ProjectPortfolios/:projectPortfolioIds
Get multiple project portfolios
HTTP syntax
GET /API/V3/PM/ProjectPortfolios/:projectPortfolioIds
<- application/json JavaScript syntax
Pqf.pm.getProjectPortfolios(projectPortfolioIds) // returns ProjectPortfolio[] Other endpoints for objects of type project portfolio
This endpoint is part of a group of endpoints manipulating objects of type project portfolio. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - PUT /API/
V3/ : Update an existing project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - DELETE /API/
V3/ : Delete a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get a project portfolio identificationPM/ ProjectPortfolio/ :projectPortfolioId/ Identification - GET /API/
V3/ : Get multiple project portfolio identificationsPM/ ProjectPortfolios/ :projectPortfolioIds/ Identification - GET /API/
V3/ : Get a project portfolio's version timelinePM/ ProjectPortfolio/ :projectPortfolioId/ Timeline - GET /API/
V3/ : Get a project portfolio's specific (historic) versionPM/ ProjectPortfolio/ :projectPortfolioId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectPortfolio and ID in specified in parameter projectPortfolioIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectPortfolioIds |
array of UUID | The project portfolio IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectPortfolio
GET /API/V3/PM/ProjectPortfolios/:projectPortfolioIds/Identification
Get multiple project portfolio identifications
HTTP syntax
GET /API/V3/PM/ProjectPortfolios/:projectPortfolioIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectPortfolioIdentifications(projectPortfolioIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectPortfolioIdentifications(projectPortfolioIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project portfolio
This endpoint is part of a group of endpoints manipulating objects of type project portfolio. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get multiple project portfoliosPM/ ProjectPortfolios/ :projectPortfolioIds - PUT /API/
V3/ : Update an existing project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - DELETE /API/
V3/ : Delete a project portfolioPM/ ProjectPortfolio/ :projectPortfolioId - GET /API/
V3/ : Get a project portfolio identificationPM/ ProjectPortfolio/ :projectPortfolioId/ Identification - GET /API/
V3/ : Get a project portfolio's version timelinePM/ ProjectPortfolio/ :projectPortfolioId/ Timeline - GET /API/
V3/ : Get a project portfolio's specific (historic) versionPM/ ProjectPortfolio/ :projectPortfolioId/ Version/ :versionId
Required permission
Requires permission IDENTIFY on object of type ProjectPortfolio and ID in specified in parameter projectPortfolioIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectPortfolioIds |
array of UUID | The project portfolio IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/ProjectPortfolios/:projectPortfolioIds/LatestReport
Returns references to the latest reports of some project portfolios, one per portfolio, optionally only among reports of some types and in some lifecycle states. A portfolio without such a report, or whose latest report the caller may not identify, gets a null element, detailed as not found
HTTP syntax
GET /API/V3/PM/ProjectPortfolios/:projectPortfolioIds/LatestReport?reportTypeFilter=...&stateFilter=...&skip=...
<- application/json JavaScript syntax
Pqf.pm.getLatestProjectPortfolioReportOfProjectPortfolios(projectPortfolioIds, reportTypeFilter, stateFilter, skip) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getLatestProjectPortfolioReportOfProjectPortfolios(projectPortfolioIds, reportTypeFilter, stateFilter) // returns PF.ReferenceWithParent[]
Pqf.pm.getLatestProjectPortfolioReportOfProjectPortfolios(projectPortfolioIds, reportTypeFilter) // returns PF.ReferenceWithParent[]
Pqf.pm.getLatestProjectPortfolioReportOfProjectPortfolios(projectPortfolioIds) // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- portfolioreports
Required permission
Requires permission READ on object of type ProjectPortfolio and ID in specified in parameter projectPortfolioIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectPortfolioIds |
array of UUID | The project portfolios' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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.) |
|
reportTypeFilter |
array of UUID | Only reports of these types count, all types if omitted | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
stateFilter |
array of UUID | Only reports in one of these lifecycle states count, any state if omitted | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
skip |
int | Skips the latest n matching reports | s >= 0 (The value must be at least 0.) |
0 |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
POST /API/V3/PM/ProjectPortfolios/Add
Adds a new project portfolio to the PM root
HTTP syntax
POST /API/V3/PM/ProjectPortfolios/Add?copy=...©Relations=...&name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addProjectPortfolio(copy, copyRelations, name, code, description, color, iconRef) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.addProjectPortfolio(copy, copyRelations, name, code, description, color) // returns PF.Reference
Pqf.pm.addProjectPortfolio(copy, copyRelations, name, code, description) // returns PF.Reference
Pqf.pm.addProjectPortfolio(copy, copyRelations, name, code) // returns PF.Reference
Pqf.pm.addProjectPortfolio(copy, copyRelations, name) // returns PF.Reference
Pqf.pm.addProjectPortfolio(copy, copyRelations) // returns PF.Reference
Pqf.pm.addProjectPortfolio(copy) // returns PF.Reference
Pqf.pm.addProjectPortfolio() // returns PF.Reference Required license
This endpoint requires the following licenses:
- portfolios
Required permission
Requires permission CREATE on object of type ProjectPortfolio.
Requires permission READ on object of type ProjectPortfolio and ID specified in parameter copy if it is set.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
copy |
UUID | Project portfolio to copy | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
copyRelations |
boolean | When copying (copy is set), also copy relations | false |
||
name |
string | The name of the new project portfolio, a localized default name if omitted | |||
code |
string | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
||
description |
string | A descriptive text about the new project portfolio, may contain HTML | |||
color |
color | The color of the new project portfolio | |||
iconRef |
URI | The icon of the new project portfolio, 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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId
Get a project report
HTTP syntax
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId
<- application/json : ProjectReport JavaScript syntax
Pqf.pm.getProjectReport(reportType, projectReportId) // returns ProjectReport Other endpoints for objects of type project report
This endpoint is part of a group of endpoints manipulating objects of type project report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple project reportsPM/ ProjectReports/ :reportType/ :projectReportIds - PUT /API/
V3/ : Update an existing project reportPM/ ProjectReport/ :reportType/ :projectReportId - DELETE /API/
V3/ : Delete a project reportPM/ ProjectReport/ :reportType/ :projectReportId - GET /API/
V3/ : Get a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ Identification - GET /API/
V3/ : Get multiple project report identificationsPM/ ProjectReports/ :reportType/ :projectReportIds/ Identification
Required permission
Requires permission READ on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectReport
PUT /API/V3/PM/ProjectReport/:reportType/:projectReportId
Update an existing project report
HTTP syntax
PUT /API/V3/PM/ProjectReport/:reportType/:projectReportId
-> application/json : ProjectReport JavaScript syntax
Pqf.pm.putProjectReport(reportType, projectReportId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project report
This endpoint is part of a group of endpoints manipulating objects of type project report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project reportPM/ ProjectReport/ :reportType/ :projectReportId - GET /API/
V3/ : Get multiple project reportsPM/ ProjectReports/ :reportType/ :projectReportIds - DELETE /API/
V3/ : Delete a project reportPM/ ProjectReport/ :reportType/ :projectReportId - GET /API/
V3/ : Get a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ Identification - GET /API/
V3/ : Get multiple project report identificationsPM/ ProjectReports/ :reportType/ :projectReportIds/ Identification
Required permission
Requires permission UPDATE or CREATE on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectReport | JSON object of type ProjectReport | ✔️ |
DELETE /API/V3/PM/ProjectReport/:reportType/:projectReportId
Delete a project report
HTTP syntax
DELETE /API/V3/PM/ProjectReport/:reportType/:projectReportId JavaScript syntax
Pqf.pm.delProjectReport(reportType, projectReportId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project report
This endpoint is part of a group of endpoints manipulating objects of type project report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project reportPM/ ProjectReport/ :reportType/ :projectReportId - GET /API/
V3/ : Get multiple project reportsPM/ ProjectReports/ :reportType/ :projectReportIds - PUT /API/
V3/ : Update an existing project reportPM/ ProjectReport/ :reportType/ :projectReportId - GET /API/
V3/ : Get a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ Identification - GET /API/
V3/ : Get multiple project report identificationsPM/ ProjectReports/ :reportType/ :projectReportIds/ Identification
Required permission
Requires permission DELETE on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/Identification
Get a project report identification
HTTP syntax
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectReportIdentification(reportType, projectReportId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectReportIdentification(reportType, projectReportId) // returns PF.IdentificationExtended Other endpoints for objects of type project report
This endpoint is part of a group of endpoints manipulating objects of type project report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project reportPM/ ProjectReport/ :reportType/ :projectReportId - GET /API/
V3/ : Get multiple project reportsPM/ ProjectReports/ :reportType/ :projectReportIds - PUT /API/
V3/ : Update an existing project reportPM/ ProjectReport/ :reportType/ :projectReportId - DELETE /API/
V3/ : Delete a project reportPM/ ProjectReport/ :reportType/ :projectReportId - GET /API/
V3/ : Get multiple project report identificationsPM/ ProjectReports/ :reportType/ :projectReportIds/ Identification
Required permission
Requires permission IDENTIFY on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetail/:projectReportIndicatorDetailId
Get a one indicator's target/actual comparison on a project report
HTTP syntax
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetail/:projectReportIndicatorDetailId
<- application/json : ProjectReportIndicatorDetail JavaScript syntax
Pqf.pm.getProjectReportIndicatorDetail(reportType, projectReportId, projectReportIndicatorDetailId) // returns ProjectReportIndicatorDetail Other endpoints for objects of type project report indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project report indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple one indicator's target/actual comparison on a project reportsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetails/ :projectReportIndicatorDetailIds - PUT /API/
V3/ : Create or update a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - DELETE /API/
V3/ : Delete a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - GET /API/
V3/ : Get a one indicator's target/actual comparison on a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId/ Identification - GET /API/
V3/ : Get multiple one indicator's target/actual comparison on a project report identificationsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetails/ :projectReportIndicatorDetailIds/ Identification
Required permission
Requires permission READ on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportIndicatorDetailId |
UUID | The one indicator's target/actual comparison on a project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectReportIndicatorDetail
PUT /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetail/:projectReportIndicatorDetailId
Create or update a one indicator's target/actual comparison on a project report
HTTP syntax
PUT /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetail/:projectReportIndicatorDetailId
-> application/json : ProjectReportIndicatorDetail JavaScript syntax
Pqf.pm.putProjectReportIndicatorDetail(reportType, projectReportId, projectReportIndicatorDetailId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project report indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project report indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - GET /API/
V3/ : Get multiple one indicator's target/actual comparison on a project reportsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetails/ :projectReportIndicatorDetailIds - DELETE /API/
V3/ : Delete a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - GET /API/
V3/ : Get a one indicator's target/actual comparison on a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId/ Identification - GET /API/
V3/ : Get multiple one indicator's target/actual comparison on a project report identificationsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetails/ :projectReportIndicatorDetailIds/ Identification
Required permission
Requires permission UPDATE or CREATE on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportIndicatorDetailId |
UUID | The one indicator's target/actual comparison on a project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectReportIndicatorDetail | JSON object of type ProjectReportIndicatorDetail | ✔️ |
DELETE /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetail/:projectReportIndicatorDetailId
Delete a one indicator's target/actual comparison on a project report
HTTP syntax
DELETE /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetail/:projectReportIndicatorDetailId JavaScript syntax
Pqf.pm.delProjectReportIndicatorDetail(reportType, projectReportId, projectReportIndicatorDetailId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project report indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project report indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - GET /API/
V3/ : Get multiple one indicator's target/actual comparison on a project reportsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetails/ :projectReportIndicatorDetailIds - PUT /API/
V3/ : Create or update a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - GET /API/
V3/ : Get a one indicator's target/actual comparison on a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId/ Identification - GET /API/
V3/ : Get multiple one indicator's target/actual comparison on a project report identificationsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetails/ :projectReportIndicatorDetailIds/ Identification
Required permission
Requires permission DELETE on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportIndicatorDetailId |
UUID | The one indicator's target/actual comparison on a project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetail/:projectReportIndicatorDetailId/Identification
Get a one indicator's target/actual comparison on a project report identification
HTTP syntax
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetail/:projectReportIndicatorDetailId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectReportIndicatorDetailIdentification(reportType, projectReportId, projectReportIndicatorDetailId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectReportIndicatorDetailIdentification(reportType, projectReportId, projectReportIndicatorDetailId) // returns PF.IdentificationExtended Other endpoints for objects of type project report indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project report indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - GET /API/
V3/ : Get multiple one indicator's target/actual comparison on a project reportsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetails/ :projectReportIndicatorDetailIds - PUT /API/
V3/ : Create or update a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - DELETE /API/
V3/ : Delete a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - GET /API/
V3/ : Get multiple one indicator's target/actual comparison on a project report identificationsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetails/ :projectReportIndicatorDetailIds/ Identification
Required permission
Requires permission IDENTIFY on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectReportIndicatorDetailId |
UUID | The one indicator's target/actual comparison on a project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetails/:projectReportIndicatorDetailIds
Get multiple one indicator's target/actual comparison on a project reports
HTTP syntax
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetails/:projectReportIndicatorDetailIds
<- application/json JavaScript syntax
Pqf.pm.getProjectReportIndicatorDetails(reportType, projectReportId, projectReportIndicatorDetailIds) // returns ProjectReportIndicatorDetail[] Other endpoints for objects of type project report indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project report indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - PUT /API/
V3/ : Create or update a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - DELETE /API/
V3/ : Delete a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - GET /API/
V3/ : Get a one indicator's target/actual comparison on a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId/ Identification - GET /API/
V3/ : Get multiple one indicator's target/actual comparison on a project report identificationsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetails/ :projectReportIndicatorDetailIds/ Identification
Required permission
Requires permission READ on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportIndicatorDetailIds |
array of UUID | The one indicator's target/actual comparison on a project report IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectReportIndicatorDetail
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetails/:projectReportIndicatorDetailIds/Identification
Get multiple one indicator's target/actual comparison on a project report identifications
HTTP syntax
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDetails/:projectReportIndicatorDetailIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectReportIndicatorDetailIdentifications(reportType, projectReportId, projectReportIndicatorDetailIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectReportIndicatorDetailIdentifications(reportType, projectReportId, projectReportIndicatorDetailIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project report indicator detail
This endpoint is part of a group of endpoints manipulating objects of type project report indicator detail. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - GET /API/
V3/ : Get multiple one indicator's target/actual comparison on a project reportsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetails/ :projectReportIndicatorDetailIds - PUT /API/
V3/ : Create or update a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - DELETE /API/
V3/ : Delete a one indicator's target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId - GET /API/
V3/ : Get a one indicator's target/actual comparison on a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDetail/ :projectReportIndicatorDetailId/ Identification
Required permission
Requires permission IDENTIFY on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectReportIndicatorDetailIds |
array of UUID | The one indicator's target/actual comparison on a project report IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimension/:projectReportIndicatorDimensionId
Get a one indicator dimension's aggregated target/actual comparison on a project report
HTTP syntax
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimension/:projectReportIndicatorDimensionId
<- application/json : ProjectReportIndicatorDimension JavaScript syntax
Pqf.pm.getProjectReportIndicatorDimension(reportType, projectReportId, projectReportIndicatorDimensionId) // returns ProjectReportIndicatorDimension Other endpoints for objects of type project report indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project report indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple one indicator dimension's aggregated target/actual comparison on a project reportsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimensions/ :projectReportIndicatorDimensionIds - PUT /API/
V3/ : Create or update a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - DELETE /API/
V3/ : Delete a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - GET /API/
V3/ : Get a one indicator dimension's aggregated target/actual comparison on a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId/ Identification - GET /API/
V3/ : Get multiple one indicator dimension's aggregated target/actual comparison on a project report identificationsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimensions/ :projectReportIndicatorDimensionIds/ Identification
Required permission
Requires permission READ on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportIndicatorDimensionId |
UUID | The one indicator dimension's aggregated target/actual comparison on a project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectReportIndicatorDimension
PUT /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimension/:projectReportIndicatorDimensionId
Create or update a one indicator dimension's aggregated target/actual comparison on a project report
HTTP syntax
PUT /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimension/:projectReportIndicatorDimensionId
-> application/json : ProjectReportIndicatorDimension JavaScript syntax
Pqf.pm.putProjectReportIndicatorDimension(reportType, projectReportId, projectReportIndicatorDimensionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project report indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project report indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - GET /API/
V3/ : Get multiple one indicator dimension's aggregated target/actual comparison on a project reportsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimensions/ :projectReportIndicatorDimensionIds - DELETE /API/
V3/ : Delete a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - GET /API/
V3/ : Get a one indicator dimension's aggregated target/actual comparison on a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId/ Identification - GET /API/
V3/ : Get multiple one indicator dimension's aggregated target/actual comparison on a project report identificationsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimensions/ :projectReportIndicatorDimensionIds/ Identification
Required permission
Requires permission UPDATE or CREATE on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportIndicatorDimensionId |
UUID | The one indicator dimension's aggregated target/actual comparison on a project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectReportIndicatorDimension | JSON object of type ProjectReportIndicatorDimension | ✔️ |
DELETE /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimension/:projectReportIndicatorDimensionId
Delete a one indicator dimension's aggregated target/actual comparison on a project report
HTTP syntax
DELETE /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimension/:projectReportIndicatorDimensionId JavaScript syntax
Pqf.pm.delProjectReportIndicatorDimension(reportType, projectReportId, projectReportIndicatorDimensionId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project report indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project report indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - GET /API/
V3/ : Get multiple one indicator dimension's aggregated target/actual comparison on a project reportsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimensions/ :projectReportIndicatorDimensionIds - PUT /API/
V3/ : Create or update a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - GET /API/
V3/ : Get a one indicator dimension's aggregated target/actual comparison on a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId/ Identification - GET /API/
V3/ : Get multiple one indicator dimension's aggregated target/actual comparison on a project report identificationsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimensions/ :projectReportIndicatorDimensionIds/ Identification
Required permission
Requires permission DELETE on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportIndicatorDimensionId |
UUID | The one indicator dimension's aggregated target/actual comparison on a project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimension/:projectReportIndicatorDimensionId/Identification
Get a one indicator dimension's aggregated target/actual comparison on a project report identification
HTTP syntax
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimension/:projectReportIndicatorDimensionId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectReportIndicatorDimensionIdentification(reportType, projectReportId, projectReportIndicatorDimensionId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectReportIndicatorDimensionIdentification(reportType, projectReportId, projectReportIndicatorDimensionId) // returns PF.IdentificationExtended Other endpoints for objects of type project report indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project report indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - GET /API/
V3/ : Get multiple one indicator dimension's aggregated target/actual comparison on a project reportsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimensions/ :projectReportIndicatorDimensionIds - PUT /API/
V3/ : Create or update a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - DELETE /API/
V3/ : Delete a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - GET /API/
V3/ : Get multiple one indicator dimension's aggregated target/actual comparison on a project report identificationsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimensions/ :projectReportIndicatorDimensionIds/ Identification
Required permission
Requires permission IDENTIFY on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectReportIndicatorDimensionId |
UUID | The one indicator dimension's aggregated target/actual comparison on a project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimensions/:projectReportIndicatorDimensionIds
Get multiple one indicator dimension's aggregated target/actual comparison on a project reports
HTTP syntax
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimensions/:projectReportIndicatorDimensionIds
<- application/json JavaScript syntax
Pqf.pm.getProjectReportIndicatorDimensions(reportType, projectReportId, projectReportIndicatorDimensionIds) // returns ProjectReportIndicatorDimension[] Other endpoints for objects of type project report indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project report indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - PUT /API/
V3/ : Create or update a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - DELETE /API/
V3/ : Delete a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - GET /API/
V3/ : Get a one indicator dimension's aggregated target/actual comparison on a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId/ Identification - GET /API/
V3/ : Get multiple one indicator dimension's aggregated target/actual comparison on a project report identificationsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimensions/ :projectReportIndicatorDimensionIds/ Identification
Required permission
Requires permission READ on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportIndicatorDimensionIds |
array of UUID | The one indicator dimension's aggregated target/actual comparison on a project report IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectReportIndicatorDimension
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimensions/:projectReportIndicatorDimensionIds/Identification
Get multiple one indicator dimension's aggregated target/actual comparison on a project report identifications
HTTP syntax
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/IndicatorDimensions/:projectReportIndicatorDimensionIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectReportIndicatorDimensionIdentifications(reportType, projectReportId, projectReportIndicatorDimensionIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectReportIndicatorDimensionIdentifications(reportType, projectReportId, projectReportIndicatorDimensionIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project report indicator dimension
This endpoint is part of a group of endpoints manipulating objects of type project report indicator dimension. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - GET /API/
V3/ : Get multiple one indicator dimension's aggregated target/actual comparison on a project reportsPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimensions/ :projectReportIndicatorDimensionIds - PUT /API/
V3/ : Create or update a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - DELETE /API/
V3/ : Delete a one indicator dimension's aggregated target/actual comparison on a project reportPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId - GET /API/
V3/ : Get a one indicator dimension's aggregated target/actual comparison on a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ IndicatorDimension/ :projectReportIndicatorDimensionId/ Identification
Required permission
Requires permission IDENTIFY on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectReportIndicatorDimensionIds |
array of UUID | The one indicator dimension's aggregated target/actual comparison on a project report IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/ProjectReport/:reportType/:projectReportId/Recalculated
Returns the project report with the given ID, recalculated. If the report type has a JavaScript data collector, this endpoint cannot be called from JavaScript and answers with HTTP 400: the recalculation would have to wait for the data collector, which can only run after the calling script has finished.
HTTP syntax
GET /API/V3/PM/ProjectReport/:reportType/:projectReportId/Recalculated?currencyId=...
<- application/json : ProjectReport JavaScript syntax
Pqf.pm.getProjectReportRecalculated(reportType, projectReportId, currencyId) // returns ProjectReport
// Overloads for optional parameters
Pqf.pm.getProjectReportRecalculated(reportType, projectReportId) // returns ProjectReport Required permission
Requires permission READ on object of type specified in parameter reportType and ID specified in parameter projectReportId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportId |
UUID | The project report's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
currencyId |
UUID | Currency that will be used for recalculation (null uses user's default currency) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectReport
GET /API/V3/PM/ProjectReports
Returns references to all project reports
HTTP syntax
GET /API/V3/PM/ProjectReports?reportTypeFilter=...&sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectReports(reportTypeFilter, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getAllProjectReports(reportTypeFilter) // returns PF.ReferenceWithParent[]
Pqf.pm.getAllProjectReports() // returns PF.ReferenceWithParent[] Required permission
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportTypeFilter |
array of UUID | filter by type, return all types, if not provided | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectId, currencyId and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color). Dynamic properties can only be used if the request concerns a single object type, otherwise only the fixed properties are sortable | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/ProjectReports/:reportType/:projectReportIds
Get multiple project reports
HTTP syntax
GET /API/V3/PM/ProjectReports/:reportType/:projectReportIds
<- application/json JavaScript syntax
Pqf.pm.getProjectReports(reportType, projectReportIds) // returns ProjectReport[] Other endpoints for objects of type project report
This endpoint is part of a group of endpoints manipulating objects of type project report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project reportPM/ ProjectReport/ :reportType/ :projectReportId - PUT /API/
V3/ : Update an existing project reportPM/ ProjectReport/ :reportType/ :projectReportId - DELETE /API/
V3/ : Delete a project reportPM/ ProjectReport/ :reportType/ :projectReportId - GET /API/
V3/ : Get a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ Identification - GET /API/
V3/ : Get multiple project report identificationsPM/ ProjectReports/ :reportType/ :projectReportIds/ Identification
Required permission
Requires permission READ on object of type specified in parameter reportType and ID in specified in parameter projectReportIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
projectReportIds |
array of UUID | The project report IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectReport
GET /API/V3/PM/ProjectReports/:reportType/:projectReportIds/Identification
Get multiple project report identifications
HTTP syntax
GET /API/V3/PM/ProjectReports/:reportType/:projectReportIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectReportIdentifications(reportType, projectReportIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectReportIdentifications(reportType, projectReportIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project report
This endpoint is part of a group of endpoints manipulating objects of type project report. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project reportPM/ ProjectReport/ :reportType/ :projectReportId - GET /API/
V3/ : Get multiple project reportsPM/ ProjectReports/ :reportType/ :projectReportIds - PUT /API/
V3/ : Update an existing project reportPM/ ProjectReport/ :reportType/ :projectReportId - DELETE /API/
V3/ : Delete a project reportPM/ ProjectReport/ :reportType/ :projectReportId - GET /API/
V3/ : Get a project report identificationPM/ ProjectReport/ :reportType/ :projectReportId/ Identification
Required permission
Requires permission IDENTIFY on object of type specified in parameter reportType and ID in specified in parameter projectReportIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
reportType |
UUID | The project report's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectReportIds |
array of UUID | The project report IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/ProjectReportType/:projectReportTypeId
Returns a project report type
HTTP syntax
GET /API/V3/PM/ProjectReportType/:projectReportTypeId
<- application/json : ProjectReportType JavaScript syntax
Pqf.pm.getProjectReportType(projectReportTypeId) // returns ProjectReportType Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectReportTypeId |
UUID | The ID of the project report type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectReportType
GET /API/V3/PM/ProjectReportType/:projectReportTypeId/IndicatorDetails
Returns references to the indicator detail definitions of one project report type
HTTP syntax
GET /API/V3/PM/ProjectReportType/:projectReportTypeId/IndicatorDetails?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectReportTypeIndicatorDetails(projectReportTypeId, sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectReportTypeIndicatorDetails(projectReportTypeId) // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectReportTypeId |
UUID | The project report type's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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, projectReportTypeId, indicatorDimensionId, sortIndex. Sorting by createdAt or modifiedAt requires the PM administration permission and is ignored without it | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/ProjectReportType/:projectReportTypeId/IndicatorDimensions
Returns references to the indicator dimension definitions of one project report type
HTTP syntax
GET /API/V3/PM/ProjectReportType/:projectReportTypeId/IndicatorDimensions?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectReportTypeIndicatorDimensions(projectReportTypeId, sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectReportTypeIndicatorDimensions(projectReportTypeId) // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectReportTypeId |
UUID | The project report type's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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, projectReportTypeId, sortIndex. Sorting by createdAt or modifiedAt requires the PM administration permission and is ignored without it | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/ProjectReportType/:projectReportTypeId/WithTranslations
Returns a project report type with translations
HTTP syntax
GET /API/V3/PM/ProjectReportType/:projectReportTypeId/WithTranslations
<- application/json : ProjectReportTypeTranslated JavaScript syntax
Pqf.pm.getProjectReportTypeTranslated(projectReportTypeId) // returns ProjectReportTypeTranslated Required license
This endpoint requires the following licenses:
- config-reporttype
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectReportTypeId |
UUID | The ID of the project report type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectReportTypeTranslated
PUT /API/V3/PM/ProjectReportType/:projectReportTypeId/WithTranslations
Updates a project report type with translations
HTTP syntax
PUT /API/V3/PM/ProjectReportType/:projectReportTypeId/WithTranslations
-> application/json : ProjectReportTypeTranslated JavaScript syntax
Pqf.pm.putProjectReportTypeTranslated(projectReportTypeId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-reporttype
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectReportTypeId |
UUID | The ID of the project report type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectReportTypeTranslated | JSON object of type ProjectReportTypeTranslated | ✔️ |
DELETE /API/V3/PM/ProjectReportType/:projectReportTypeId/WithTranslations
Deletes a project report type with translations
HTTP syntax
DELETE /API/V3/PM/ProjectReportType/:projectReportTypeId/WithTranslations JavaScript syntax
Pqf.pm.delProjectReportTypeTranslated(projectReportTypeId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-reporttype
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectReportTypeId |
UUID | The ID of the project report type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectReportType/:reportType/Reports
Returns all project reports of a given type
HTTP syntax
GET /API/V3/PM/ProjectReportType/:reportType/Reports?sort=...
<- application/json JavaScript syntax
Pqf.pm.getProjectReportsOfType(reportType, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getProjectReportsOfType(reportType) // returns PF.ReferenceWithParent[] Required permission
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportType |
UUID | The project report type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectId, currencyId 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 '[ (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/PM/ProjectReportTypes
Returns references to all project report types
HTTP syntax
GET /API/V3/PM/ProjectReportTypes?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectReportTypes(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectReportTypes() // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, sortIndex | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/ProjectReportTypes/:reportTypeIds
Returns some project report types specified by their IDs
HTTP syntax
GET /API/V3/PM/ProjectReportTypes/:reportTypeIds
<- application/json JavaScript syntax
Pqf.pm.getProjectReportTypes(reportTypeIds) // returns ProjectReportType[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportTypeIds |
array of UUID | The IDs of the project report types | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectReportType
GET /API/V3/PM/ProjectReportTypes/:reportTypeIds/WithTranslations
Returns project report types with translations
HTTP syntax
GET /API/V3/PM/ProjectReportTypes/:reportTypeIds/WithTranslations
<- application/json JavaScript syntax
Pqf.pm.getProjectReportTypesTranslated(reportTypeIds) // returns ProjectReportTypeTranslated[] Required license
This endpoint requires the following licenses:
- config-reporttype
Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
reportTypeIds |
array of UUID | The IDs of the project report types | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectReportTypeTranslated
GET /API/V3/PM/Projects
Returns references to all projects
HTTP syntax
GET /API/V3/PM/Projects?sort=...
<- application/jsonJavaScript syntax
Pqf.pm.getAllProjects(sort) // returns PF.ReferenceWithParents[]
// Overloads for optional parameters
Pqf.pm.getAllProjects() // returns PF.ReferenceWithParents[]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 '[ (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.ReferenceWithParents
GET /API/V3/PM/Projects/:projectIds
Get multiple projects
HTTP syntax
GET /API/V3/PM/Projects/:projectIds
<- application/json JavaScript syntax
Pqf.pm.getProjects(projectIds) // returns Project[]Other endpoints for objects of type project
This endpoint is part of a group of endpoints manipulating objects of type project. The following endpoints belong to the same group:
- GET /API/V3/PM/Project/:projectId: Get a project
- PUT /API/V3/PM/Project/:projectId: Update an existing project
- DELETE /API/V3/PM/Project/:projectId: Delete a project
- GET /API/
V3/ : Get a project identificationPM/ Project/ :projectId/ Identification - GET /API/
V3/ : Get multiple project identificationsPM/ Projects/ :projectIds/ Identification - GET /API/
V3/ : Get a project's version timelinePM/ Project/ :projectId/ Timeline - GET /API/
V3/ : Get a project's specific (historic) versionPM/ Project/ :projectId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted projectsPM/ Projects/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted projectPM/ Project/ :projectId/ Undelete
Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The project IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 Project
GET /API/V3/PM/Projects/:projectIds/AccumulatedValues/Costs
Returns the costs group of the accumulated values (costs budget and costs forecasts), optionally restricted to a day range, of some projects' active scenarios (or of their single scenario if that is not active), accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. One element per project; a project without such a scenario gets a null element, detailed as not found. All money values are converted into the target currency. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/AccumulatedValues/Costs?beg=...&end=...&targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedCostsOfProjects(projectIds, beg, end, targetCurrencyId) // returns AccumulatedCosts[]
// Overloads for optional parameters
Pqf.pm.getAccumulatedCostsOfProjects(projectIds, beg, end) // returns AccumulatedCosts[]
Pqf.pm.getAccumulatedCostsOfProjects(projectIds, beg) // returns AccumulatedCosts[]
Pqf.pm.getAccumulatedCostsOfProjects(projectIds) // returns AccumulatedCosts[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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.) |
beg |
date | The first day of the time span (inclusive) to restrict the costs to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of AccumulatedCosts
GET /API/V3/PM/Projects/:projectIds/AccumulatedValues/Progress
Returns the progress group of the accumulated values (calculated progress and its manual override) of some projects' active scenarios (or of their single scenario if that is not active), accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. One element per project; a project without such a scenario gets a null element, detailed as not found
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/AccumulatedValues/Progress
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedProgressOfProjects(projectIds) // returns AccumulatedProgress[] Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 AccumulatedProgress
GET /API/V3/PM/Projects/:projectIds/AccumulatedValues/Structure
Returns the structure group of the accumulated values (children, planning errors, time budget and planned time) of some projects' active scenarios (or of their single scenario if that is not active), accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. One element per project; a project without such a scenario gets a null element, detailed as not found
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/AccumulatedValues/Structure
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedStructureOfProjects(projectIds) // returns AccumulatedStructure[] Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 AccumulatedStructure
GET /API/V3/PM/Projects/:projectIds/AccumulatedValues/Times
Returns the times group of the accumulated values (allocated, spent, pending and remaining time and the overload), optionally restricted to a day range of some projects' active scenarios (or of their single scenario if that is not active), accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. One element per project; a project without such a scenario gets a null element, detailed as not found. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/AccumulatedValues/Times?beg=...&end=...
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedTimesOfProjects(projectIds, beg, end) // returns AccumulatedTime[]
// Overloads for optional parameters
Pqf.pm.getAccumulatedTimesOfProjects(projectIds, beg) // returns AccumulatedTime[]
Pqf.pm.getAccumulatedTimesOfProjects(projectIds) // returns AccumulatedTime[] Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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.) |
beg |
date | The first day of the time span (inclusive) to restrict the times to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of AccumulatedTime
GET /API/V3/PM/Projects/:projectIds/ActiveScenario
Returns the active scenarios of some projects
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/ActiveScenario?allowSingleInactive=...
<- application/json JavaScript syntax
Pqf.pm.getActiveScenarioOfProjects(projectIds, allowSingleInactive) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getActiveScenarioOfProjects(projectIds) // returns PF.ReferenceWithParent[] Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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.) |
|
allowSingleInactive |
boolean | Return also singleton scenarios that are not in an active state | false |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
GET /API/V3/PM/Projects/:projectIds/Identification
Get multiple project identifications
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectIdentifications(projectIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectIdentifications(projectIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project
This endpoint is part of a group of endpoints manipulating objects of type project. The following endpoints belong to the same group:
- GET /API/V3/PM/Project/:projectId: Get a project
- GET /API/
V3/ : Get multiple projectsPM/ Projects/ :projectIds - PUT /API/V3/PM/Project/:projectId: Update an existing project
- DELETE /API/V3/PM/Project/:projectId: Delete a project
- GET /API/
V3/ : Get a project identificationPM/ Project/ :projectId/ Identification - GET /API/
V3/ : Get a project's version timelinePM/ Project/ :projectId/ Timeline - GET /API/
V3/ : Get a project's specific (historic) versionPM/ Project/ :projectId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted projectsPM/ Projects/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted projectPM/ Project/ :projectId/ Undelete
Required permission
Requires permission IDENTIFY on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectIds |
array of UUID | The project IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/Projects/:projectIds/LatestReport
Returns references to the latest reports of some projects, one per project, optionally only among reports of some types and in some lifecycle states. A project without such a report, or whose latest report the caller may not identify, gets a null element, detailed as not found
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/LatestReport?reportTypeFilter=...&stateFilter=...&skip=...
<- application/json JavaScript syntax
Pqf.pm.getLatestProjectReportOfProjects(projectIds, reportTypeFilter, stateFilter, skip) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getLatestProjectReportOfProjects(projectIds, reportTypeFilter, stateFilter) // returns PF.ReferenceWithParent[]
Pqf.pm.getLatestProjectReportOfProjects(projectIds, reportTypeFilter) // returns PF.ReferenceWithParent[]
Pqf.pm.getLatestProjectReportOfProjects(projectIds) // returns PF.ReferenceWithParent[] Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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.) |
|
reportTypeFilter |
array of UUID | Only reports of these types count, all types if omitted | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
stateFilter |
array of UUID | Only reports in one of these lifecycle states count, any state if omitted | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
||
skip |
int | Skips the latest n matching reports | s >= 0 (The value must be at least 0.) |
0 |
Result
This endpoint returns the following data: array of PF.ReferenceWithParent
GET /API/V3/PM/Projects/:projectIds/Methodology
Returns references to the project management methodologies some projects follow
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/Methodology
<- application/json JavaScript syntax
Pqf.pm.getProjectManagementMethodologyOfProjects(projectIds) // returns PF.Reference[] Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 PF.Reference
GET /API/V3/PM/Projects/:projectIds/MethodologyPhase
Returns references to the project management methodology phases some projects are in, each with its methodology as parent
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/MethodologyPhase
<- application/json JavaScript syntax
Pqf.pm.getProjectManagementMethodologyPhaseOfProjects(projectIds) // returns PF.ReferenceWithParent[] Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 PF.ReferenceWithParent
GET /API/V3/PM/Projects/:projectIds/MethodologyTimeline
Returns the project management methodologies of some projects, their phases and their timing according to the projects' lifecycle history and active scenario planning
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/MethodologyTimeline
<- application/json JavaScript syntax
Pqf.pm.getProjectManagementMethodologyTimelineOfProjects(projectIds) // returns ProjectManagementMethodologyTimeline[] Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectManagementMethodologyTimeline
GET /API/V3/PM/Projects/:projectIds/Parents
Returns references to the parent portfolios of one or more projects, in the same order as getAllProjects reports them
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/Parents
<- application/json JavaScript syntax
Pqf.pm.getProjectsParents(projectIds) // returns PF.Reference[][] Required permission
Requires permission IDENTIFY on object of type Project and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 array of PF.Reference
GET /API/V3/PM/Projects/:projectIds/Scenarios
Returns all scenarios of one or more projects
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/Scenarios?sort=...
<- application/json JavaScript syntax
Pqf.pm.getScenariosOfProjects(projectIds, sort) // returns PF.ReferenceWithParent[][]
// Overloads for optional parameters
Pqf.pm.getScenariosOfProjects(projectIds) // returns PF.ReferenceWithParent[][] Required permission
Requires permission READ on object of type Project and ID in specified in parameter projectIds.
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectId 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 '[ (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 array of PF.ReferenceWithParent
GET /API/V3/PM/Projects/:projectIds/SubObject/:subObjectType
Returns a specific sub object for given projects (that the user is permitted to READ)
HTTP syntax
GET /API/V3/PM/Projects/:projectIds/SubObject/:subObjectType
<- application/json JavaScript syntax
Pqf.pm.getProjectsSubObject(projectIds, subObjectType) // returns PF.SubObject[] Required permission
Requires permission READ on object of type specified in parameter subObjectType and ID in specified in parameter projectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectIds |
array of UUID | The projects' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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.) |
subObjectType |
UUID | The sub object's type | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.SubObject
GET /API/V3/PM/Projects/Deleted/Recently
Get recently deleted projects
HTTP syntax
GET /API/V3/PM/Projects/Deleted/Recently
<- application/json JavaScript syntax
Pqf.pm.getRecentlyDeletedProjects() // returns PF.IdentificationRecentlyDeleted[] Other endpoints for objects of type project
This endpoint is part of a group of endpoints manipulating objects of type project. The following endpoints belong to the same group:
- GET /API/V3/PM/Project/:projectId: Get a project
- GET /API/
V3/ : Get multiple projectsPM/ Projects/ :projectIds - PUT /API/V3/PM/Project/:projectId: Update an existing project
- DELETE /API/V3/PM/Project/:projectId: Delete a project
- GET /API/
V3/ : Get a project identificationPM/ Project/ :projectId/ Identification - GET /API/
V3/ : Get multiple project identificationsPM/ Projects/ :projectIds/ Identification - GET /API/
V3/ : Get a project's version timelinePM/ Project/ :projectId/ Timeline - GET /API/
V3/ : Get a project's specific (historic) versionPM/ Project/ :projectId/ Version/ :versionId - POST /API/
V3/ : Undelete a recently deleted projectPM/ Project/ :projectId/ Undelete
Required license
This endpoint requires the following licenses:
- undelete
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Result
This endpoint returns the following data: array of PF.
GET /API/V3/PM/ProjectScenario/:projectScenarioId
Get a Project scenario
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId
<- application/json : ProjectScenario JavaScript syntax
Pqf.pm.getProjectScenario(projectScenarioId) // returns ProjectScenario Other endpoints for objects of type project scenario
This endpoint is part of a group of endpoints manipulating objects of type project scenario. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple Project scenariosPM/ ProjectScenarios/ :projectScenarioIds - PUT /API/
V3/ : Update an existing Project scenarioPM/ ProjectScenario/ :projectScenarioId - DELETE /API/
V3/ : Delete a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get a Project scenario identificationPM/ ProjectScenario/ :projectScenarioId/ Identification - GET /API/
V3/ : Get multiple Project scenario identificationsPM/ ProjectScenarios/ :projectScenarioIds/ Identification - GET /API/
V3/ : Get a Project scenario's version timelinePM/ ProjectScenario/ :projectScenarioId/ Timeline - GET /API/
V3/ : Get a Project scenario's specific (historic) versionPM/ ProjectScenario/ :projectScenarioId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted Project scenariosPM/ ProjectScenarios/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted Project scenarioPM/ ProjectScenario/ :projectScenarioId/ Undelete
Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The Project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectScenario
PUT /API/V3/PM/ProjectScenario/:projectScenarioId
Update an existing Project scenario
HTTP syntax
PUT /API/V3/PM/ProjectScenario/:projectScenarioId
-> application/json : ProjectScenario JavaScript syntax
Pqf.pm.putProjectScenario(projectScenarioId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project scenario
This endpoint is part of a group of endpoints manipulating objects of type project scenario. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get multiple Project scenariosPM/ ProjectScenarios/ :projectScenarioIds - DELETE /API/
V3/ : Delete a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get a Project scenario identificationPM/ ProjectScenario/ :projectScenarioId/ Identification - GET /API/
V3/ : Get multiple Project scenario identificationsPM/ ProjectScenarios/ :projectScenarioIds/ Identification - GET /API/
V3/ : Get a Project scenario's version timelinePM/ ProjectScenario/ :projectScenarioId/ Timeline - GET /API/
V3/ : Get a Project scenario's specific (historic) versionPM/ ProjectScenario/ :projectScenarioId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted Project scenariosPM/ ProjectScenarios/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted Project scenarioPM/ ProjectScenario/ :projectScenarioId/ Undelete
Required permission
Requires permission UPDATE or CREATE on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The Project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectScenario | JSON object of type ProjectScenario | ✔️ |
DELETE /API/V3/PM/ProjectScenario/:projectScenarioId
Delete a Project scenario
HTTP syntax
DELETE /API/V3/PM/ProjectScenario/:projectScenarioId JavaScript syntax
Pqf.pm.delProjectScenario(projectScenarioId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project scenario
This endpoint is part of a group of endpoints manipulating objects of type project scenario. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get multiple Project scenariosPM/ ProjectScenarios/ :projectScenarioIds - PUT /API/
V3/ : Update an existing Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get a Project scenario identificationPM/ ProjectScenario/ :projectScenarioId/ Identification - GET /API/
V3/ : Get multiple Project scenario identificationsPM/ ProjectScenarios/ :projectScenarioIds/ Identification - GET /API/
V3/ : Get a Project scenario's version timelinePM/ ProjectScenario/ :projectScenarioId/ Timeline - GET /API/
V3/ : Get a Project scenario's specific (historic) versionPM/ ProjectScenario/ :projectScenarioId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted Project scenariosPM/ ProjectScenarios/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted Project scenarioPM/ ProjectScenario/ :projectScenarioId/ Undelete
Required permission
Requires permission DELETE on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The Project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectScenario/:projectScenarioId/AccumulatedValues/Costs
Returns the costs group of the accumulated values (costs budget and costs forecasts), optionally restricted to a day range, of a project scenario, accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. All money values are converted into the target currency. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/AccumulatedValues/Costs?beg=...&end=...&targetCurrencyId=...
<- application/json : AccumulatedCosts JavaScript syntax
Pqf.pm.getAccumulatedCostsOfProjectScenario(projectScenarioId, beg, end, targetCurrencyId) // returns AccumulatedCosts
// Overloads for optional parameters
Pqf.pm.getAccumulatedCostsOfProjectScenario(projectScenarioId, beg, end) // returns AccumulatedCosts
Pqf.pm.getAccumulatedCostsOfProjectScenario(projectScenarioId, beg) // returns AccumulatedCosts
Pqf.pm.getAccumulatedCostsOfProjectScenario(projectScenarioId) // returns AccumulatedCosts Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive) to restrict the costs to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: AccumulatedCosts
GET /API/V3/PM/ProjectScenario/:projectScenarioId/AccumulatedValues/Progress
Returns the progress group of the accumulated values (calculated progress and its manual override) of a project scenario, accumulated over all its top-most work items as if they were its children; the scenario has no values of its own
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/AccumulatedValues/Progress
<- application/json : AccumulatedProgress JavaScript syntax
Pqf.pm.getAccumulatedProgressOfProjectScenario(projectScenarioId) // returns AccumulatedProgress Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: AccumulatedProgress
GET /API/V3/PM/ProjectScenario/:projectScenarioId/AccumulatedValues/Structure
Returns the structure group of the accumulated values (children, planning errors, time budget and planned time) of a project scenario, accumulated over all its top-most work items as if they were its children; the scenario has no values of its own
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/AccumulatedValues/Structure
<- application/json : AccumulatedStructure JavaScript syntax
Pqf.pm.getAccumulatedStructureOfProjectScenario(projectScenarioId) // returns AccumulatedStructure Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: AccumulatedStructure
GET /API/V3/PM/ProjectScenario/:projectScenarioId/AccumulatedValues/Times
Returns the times group of the accumulated values (allocated, spent, pending and remaining time and the overload), optionally restricted to a day range of a project scenario, accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/AccumulatedValues/Times?beg=...&end=...
<- application/json : AccumulatedTime JavaScript syntax
Pqf.pm.getAccumulatedTimesOfProjectScenario(projectScenarioId, beg, end) // returns AccumulatedTime
// Overloads for optional parameters
Pqf.pm.getAccumulatedTimesOfProjectScenario(projectScenarioId, beg) // returns AccumulatedTime
Pqf.pm.getAccumulatedTimesOfProjectScenario(projectScenarioId) // returns AccumulatedTime Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive) to restrict the times to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: AccumulatedTime
GET /API/V3/PM/ProjectScenario/:projectScenarioId/Dependencies
Returns references to all dependencies that start or end in a given project scenario, each one with the project scenarios and project portfolios its two ends sit in
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/Dependencies?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectDependenciesOfProjectScenario(projectScenarioId, sort) // returns PF.ReferenceWithParents[]
// Overloads for optional parameters
Pqf.pm.getAllProjectDependenciesOfProjectScenario(projectScenarioId) // returns PF.ReferenceWithParents[] Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, predecessorType, predecessorId, successorType, successorId, minDistance, maxDistance | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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.ReferenceWithParents
GET /API/V3/PM/ProjectScenario/:projectScenarioId/Export
Exports a specific project scenario into different file formats
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/Export?format=...
<- application/octet-stream JavaScript syntax
Pqf.pm.exportProjectScenario(projectScenarioId, format) // returns Object Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
format |
string | The file format of the exported project file. Possible values: MPX (MS Project exchange), MSPDI (MS Project XML), XML (Planner), PM (Primavera P6 XML) | ✔️ | matches '(?i)MPX\|MSPDI\|XML\|PM' (The value must be one of "MPX", "MSPDI", "XML" or "PM" (case-insensitive).) |
Result
This endpoint returns the following data: Binary
GET /API/V3/PM/ProjectScenario/:projectScenarioId/Identification
Get a Project scenario identification
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectScenarioIdentification(projectScenarioId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectScenarioIdentification(projectScenarioId) // returns PF.IdentificationExtended Other endpoints for objects of type project scenario
This endpoint is part of a group of endpoints manipulating objects of type project scenario. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get multiple Project scenariosPM/ ProjectScenarios/ :projectScenarioIds - PUT /API/
V3/ : Update an existing Project scenarioPM/ ProjectScenario/ :projectScenarioId - DELETE /API/
V3/ : Delete a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get multiple Project scenario identificationsPM/ ProjectScenarios/ :projectScenarioIds/ Identification - GET /API/
V3/ : Get a Project scenario's version timelinePM/ ProjectScenario/ :projectScenarioId/ Timeline - GET /API/
V3/ : Get a Project scenario's specific (historic) versionPM/ ProjectScenario/ :projectScenarioId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted Project scenariosPM/ ProjectScenarios/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted Project scenarioPM/ ProjectScenario/ :projectScenarioId/ Undelete
Required permission
Requires permission IDENTIFY on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectScenarioId |
UUID | The Project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/ProjectScenario/:projectScenarioId/MethodologyTimeline
Returns the project management methodology of a project scenario, its phases and its timing according to the project's lifecycle history and the scenario's planning
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/MethodologyTimeline
<- application/json : ProjectManagementMethodologyTimeline JavaScript syntax
Pqf.pm.getProjectManagementMethodologyTimelineOfProjectScenario(projectScenarioId) // returns ProjectManagementMethodologyTimeline Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectManagementMethodologyTimeline
GET /API/V3/PM/ProjectScenario/:projectScenarioId/MilestoneConstraints
Returns references to all constraints between the milestones of a given project scenario; read them in full with getProjectMilestoneConstraints
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/MilestoneConstraints?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectMilestoneConstraintsOfProjectScenario(projectScenarioId, sort) // returns ProjectMilestoneConstraintReference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectMilestoneConstraintsOfProjectScenario(projectScenarioId) // returns ProjectMilestoneConstraintReference[] Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, constraintType, predecessorMilestoneId, successorMilestoneId, minDistance, maxDistance | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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 ProjectMilestoneConstraintReference
POST /API/V3/PM/ProjectScenario/:projectScenarioId/MilestoneConstraints/Add
Adds a constraint between two milestones of a given project scenario, both of which have to sit in that scenario; requires permission UPDATE on the project scenario
HTTP syntax
POST /API/V3/PM/ProjectScenario/:projectScenarioId/MilestoneConstraints/Add?predecessorMilestoneId=...&successorMilestoneId=...&minDistance=...&maxDistance=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addProjectScenarioMilestoneConstraint(projectScenarioId, predecessorMilestoneId, successorMilestoneId, minDistance, maxDistance) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.addProjectScenarioMilestoneConstraint(projectScenarioId, predecessorMilestoneId, successorMilestoneId, minDistance) // returns PF.Reference
Pqf.pm.addProjectScenarioMilestoneConstraint(projectScenarioId, predecessorMilestoneId, successorMilestoneId) // returns PF.Reference Required license
The usage of the parameter minDistance requires the following licenses:
-
advancedtaskdependencies The usage of the parameter
maxDistancerequires the following licenses: -
advancedtaskdependencies
Required permission
Requires permission UPDATE on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion | Required license |
|---|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
predecessorMilestoneId |
UUID | The ID of the milestone where the constraint starts | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
successorMilestoneId |
UUID | The ID of the milestone where the constraint ends | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
minDistance |
int? | The minimal number of days between the two milestones, 0 if omitted | advancedtaskdependencies |
||
maxDistance |
int? | The maximal number of days between the two milestones (omit it for a constraint without an upper limit) | advancedtaskdependencies |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/ProjectScenario/:projectScenarioId/ProgressCorrections
Returns the progress correction histories of all project work items of a project scenario that have corrections (an empty array if none has)
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/ProgressCorrections
<- application/json JavaScript syntax
Pqf.pm.getProjectScenarioProgressCorrections(projectScenarioId) // returns ProgressCorrectionHistory[] Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ProgressCorrectionHistory
GET /API/V3/PM/ProjectScenario/:projectScenarioId/ProjectWorkItemLogs
Returns references to all logs of all work items of a given project scenario; read them in full with getProjectWorkItemLogs
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/ProjectWorkItemLogs?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectWorkItemLogsOfProjectScenario(projectScenarioId, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getAllProjectWorkItemLogsOfProjectScenario(projectScenarioId) // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- logbook
Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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, projectWorkItemId | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/ProjectScenario/:projectScenarioId/Timeline
Get a Project scenario's version timeline
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.pm.getProjectScenarioTimeline(projectScenarioId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.pm.getProjectScenarioTimeline(projectScenarioId, limit, until, from) // returns PF.VersionTimeline
Pqf.pm.getProjectScenarioTimeline(projectScenarioId, limit, until) // returns PF.VersionTimeline
Pqf.pm.getProjectScenarioTimeline(projectScenarioId, limit) // returns PF.VersionTimeline
Pqf.pm.getProjectScenarioTimeline(projectScenarioId) // returns PF.VersionTimeline Other endpoints for objects of type project scenario
This endpoint is part of a group of endpoints manipulating objects of type project scenario. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get multiple Project scenariosPM/ ProjectScenarios/ :projectScenarioIds - PUT /API/
V3/ : Update an existing Project scenarioPM/ ProjectScenario/ :projectScenarioId - DELETE /API/
V3/ : Delete a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get a Project scenario identificationPM/ ProjectScenario/ :projectScenarioId/ Identification - GET /API/
V3/ : Get multiple Project scenario identificationsPM/ ProjectScenarios/ :projectScenarioIds/ Identification - GET /API/
V3/ : Get a Project scenario's specific (historic) versionPM/ ProjectScenario/ :projectScenarioId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted Project scenariosPM/ ProjectScenarios/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted Project scenarioPM/ ProjectScenario/ :projectScenarioId/ Undelete
Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The Project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/PM/ProjectScenario/:projectScenarioId/Version/:versionId
Get a Project scenario's specific (historic) version
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/Version/:versionId
<- application/json : ProjectScenario JavaScript syntax
Pqf.pm.getProjectScenarioVersion(projectScenarioId, versionId) // returns ProjectScenario Other endpoints for objects of type project scenario
This endpoint is part of a group of endpoints manipulating objects of type project scenario. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get multiple Project scenariosPM/ ProjectScenarios/ :projectScenarioIds - PUT /API/
V3/ : Update an existing Project scenarioPM/ ProjectScenario/ :projectScenarioId - DELETE /API/
V3/ : Delete a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get a Project scenario identificationPM/ ProjectScenario/ :projectScenarioId/ Identification - GET /API/
V3/ : Get multiple Project scenario identificationsPM/ ProjectScenarios/ :projectScenarioIds/ Identification - GET /API/
V3/ : Get a Project scenario's version timelinePM/ ProjectScenario/ :projectScenarioId/ Timeline - GET /API/
V3/ : Get recently deleted Project scenariosPM/ ProjectScenarios/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted Project scenarioPM/ ProjectScenario/ :projectScenarioId/ Undelete
Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The Project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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: ProjectScenario
GET /API/V3/PM/ProjectScenario/:projectScenarioId/WorkItems
Returns the work items (phases) of a scenario
HTTP syntax
GET /API/V3/PM/ProjectScenario/:projectScenarioId/WorkItems?depth=...&sort=...
<- application/json JavaScript syntax
Pqf.pm.getProjectWorkItemsOfProjectScenario(projectScenarioId, depth, sort) // returns ProjectWorkItemReference[]
// Overloads for optional parameters
Pqf.pm.getProjectWorkItemsOfProjectScenario(projectScenarioId, depth) // returns ProjectWorkItemReference[]
Pqf.pm.getProjectWorkItemsOfProjectScenario(projectScenarioId) // returns ProjectWorkItemReference[] Required permission
Requires permission READ on object of type Scenario and ID specified in parameter projectScenarioId.
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioId |
UUID | The project scenario's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
depth |
int? | Limit the tree depth, whole scenario if omitted | d > 0 (The value, if present, must be greater than 0.) |
|
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, colorId, createdAt, modifiedAt, workItemType, sortIndex, start, end 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 '[ (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 ProjectWorkItemReference
GET /API/V3/PM/ProjectScenarios
Returns all scenarios
HTTP syntax
GET /API/V3/PM/ProjectScenarios?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectScenarios(sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getAllProjectScenarios() // returns PF.ReferenceWithParent[] Required permission
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, projectId 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 '[ (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/PM/ProjectScenarios/:projectScenarioIds
Get multiple Project scenarios
HTTP syntax
GET /API/V3/PM/ProjectScenarios/:projectScenarioIds
<- application/json JavaScript syntax
Pqf.pm.getProjectScenarios(projectScenarioIds) // returns ProjectScenario[] Other endpoints for objects of type project scenario
This endpoint is part of a group of endpoints manipulating objects of type project scenario. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Project scenarioPM/ ProjectScenario/ :projectScenarioId - PUT /API/
V3/ : Update an existing Project scenarioPM/ ProjectScenario/ :projectScenarioId - DELETE /API/
V3/ : Delete a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get a Project scenario identificationPM/ ProjectScenario/ :projectScenarioId/ Identification - GET /API/
V3/ : Get multiple Project scenario identificationsPM/ ProjectScenarios/ :projectScenarioIds/ Identification - GET /API/
V3/ : Get a Project scenario's version timelinePM/ ProjectScenario/ :projectScenarioId/ Timeline - GET /API/
V3/ : Get a Project scenario's specific (historic) versionPM/ ProjectScenario/ :projectScenarioId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted Project scenariosPM/ ProjectScenarios/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted Project scenarioPM/ ProjectScenario/ :projectScenarioId/ Undelete
Required permission
Requires permission READ on object of type Scenario and ID in specified in parameter projectScenarioIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectScenarioIds |
array of UUID | The Project scenario IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectScenario
GET /API/V3/PM/ProjectScenarios/:projectScenarioIds/Identification
Get multiple Project scenario identifications
HTTP syntax
GET /API/V3/PM/ProjectScenarios/:projectScenarioIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectScenarioIdentifications(projectScenarioIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectScenarioIdentifications(projectScenarioIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project scenario
This endpoint is part of a group of endpoints manipulating objects of type project scenario. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get multiple Project scenariosPM/ ProjectScenarios/ :projectScenarioIds - PUT /API/
V3/ : Update an existing Project scenarioPM/ ProjectScenario/ :projectScenarioId - DELETE /API/
V3/ : Delete a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get a Project scenario identificationPM/ ProjectScenario/ :projectScenarioId/ Identification - GET /API/
V3/ : Get a Project scenario's version timelinePM/ ProjectScenario/ :projectScenarioId/ Timeline - GET /API/
V3/ : Get a Project scenario's specific (historic) versionPM/ ProjectScenario/ :projectScenarioId/ Version/ :versionId - GET /API/
V3/ : Get recently deleted Project scenariosPM/ ProjectScenarios/ Deleted/ Recently - POST /API/
V3/ : Undelete a recently deleted Project scenarioPM/ ProjectScenario/ :projectScenarioId/ Undelete
Required permission
Requires permission IDENTIFY on object of type Scenario and ID in specified in parameter projectScenarioIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectScenarioIds |
array of UUID | The Project scenario IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/ProjectScenarios/:scenarioIds/AccumulatedValues/Costs
Returns the costs group of the accumulated values (costs budget and costs forecasts), optionally restricted to a day range, of some project scenarios, accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. One element per scenario. All money values are converted into the target currency. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/ProjectScenarios/:scenarioIds/AccumulatedValues/Costs?beg=...&end=...&targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedCostsOfProjectScenarios(scenarioIds, beg, end, targetCurrencyId) // returns AccumulatedCosts[]
// Overloads for optional parameters
Pqf.pm.getAccumulatedCostsOfProjectScenarios(scenarioIds, beg, end) // returns AccumulatedCosts[]
Pqf.pm.getAccumulatedCostsOfProjectScenarios(scenarioIds, beg) // returns AccumulatedCosts[]
Pqf.pm.getAccumulatedCostsOfProjectScenarios(scenarioIds) // returns AccumulatedCosts[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type Scenario and ID in specified in parameter scenarioIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
scenarioIds |
array of UUID | The project scenarios' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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.) |
beg |
date | The first day of the time span (inclusive) to restrict the costs to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of AccumulatedCosts
GET /API/V3/PM/ProjectScenarios/:scenarioIds/AccumulatedValues/Progress
Returns the progress group of the accumulated values (calculated progress and its manual override) of some project scenarios, accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. One element per scenario
HTTP syntax
GET /API/V3/PM/ProjectScenarios/:scenarioIds/AccumulatedValues/Progress
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedProgressOfProjectScenarios(scenarioIds) // returns AccumulatedProgress[] Required permission
Requires permission READ on object of type Scenario and ID in specified in parameter scenarioIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
scenarioIds |
array of UUID | The project scenarios' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 AccumulatedProgress
GET /API/V3/PM/ProjectScenarios/:scenarioIds/AccumulatedValues/Structure
Returns the structure group of the accumulated values (children, planning errors, time budget and planned time) of some project scenarios, accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. One element per scenario
HTTP syntax
GET /API/V3/PM/ProjectScenarios/:scenarioIds/AccumulatedValues/Structure
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedStructureOfProjectScenarios(scenarioIds) // returns AccumulatedStructure[] Required permission
Requires permission READ on object of type Scenario and ID in specified in parameter scenarioIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
scenarioIds |
array of UUID | The project scenarios' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 AccumulatedStructure
GET /API/V3/PM/ProjectScenarios/:scenarioIds/AccumulatedValues/Times
Returns the times group of the accumulated values (allocated, spent, pending and remaining time and the overload), optionally restricted to a day range of some project scenarios, accumulated over all its top-most work items as if they were its children; the scenario has no values of its own. One element per scenario. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/ProjectScenarios/:scenarioIds/AccumulatedValues/Times?beg=...&end=...
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedTimesOfProjectScenarios(scenarioIds, beg, end) // returns AccumulatedTime[]
// Overloads for optional parameters
Pqf.pm.getAccumulatedTimesOfProjectScenarios(scenarioIds, beg) // returns AccumulatedTime[]
Pqf.pm.getAccumulatedTimesOfProjectScenarios(scenarioIds) // returns AccumulatedTime[] Required permission
Requires permission READ on object of type Scenario and ID in specified in parameter scenarioIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
scenarioIds |
array of UUID | The project scenarios' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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.) |
beg |
date | The first day of the time span (inclusive) to restrict the times to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of AccumulatedTime
GET /API/V3/PM/ProjectScenarios/:scenarioIds/MethodologyTimeline
Returns the project management methodologies of some project scenarios, their phases and their timing according to the projects' lifecycle history and the scenarios' planning
HTTP syntax
GET /API/V3/PM/ProjectScenarios/:scenarioIds/MethodologyTimeline
<- application/json JavaScript syntax
Pqf.pm.getProjectManagementMethodologyTimelineOfProjectScenarios(scenarioIds) // returns ProjectManagementMethodologyTimeline[] Required permission
Requires permission READ on object of type Scenario and ID in specified in parameter scenarioIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
scenarioIds |
array of UUID | The project scenarios' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectManagementMethodologyTimeline
GET /API/V3/PM/ProjectScenarios/Deleted/Recently
Get recently deleted Project scenarios
HTTP syntax
GET /API/V3/PM/ProjectScenarios/Deleted/Recently
<- application/json JavaScript syntax
Pqf.pm.getRecentlyDeletedProjectScenarios() // returns PF.IdentificationRecentlyDeleted[] Other endpoints for objects of type project scenario
This endpoint is part of a group of endpoints manipulating objects of type project scenario. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get multiple Project scenariosPM/ ProjectScenarios/ :projectScenarioIds - PUT /API/
V3/ : Update an existing Project scenarioPM/ ProjectScenario/ :projectScenarioId - DELETE /API/
V3/ : Delete a Project scenarioPM/ ProjectScenario/ :projectScenarioId - GET /API/
V3/ : Get a Project scenario identificationPM/ ProjectScenario/ :projectScenarioId/ Identification - GET /API/
V3/ : Get multiple Project scenario identificationsPM/ ProjectScenarios/ :projectScenarioIds/ Identification - GET /API/
V3/ : Get a Project scenario's version timelinePM/ ProjectScenario/ :projectScenarioId/ Timeline - GET /API/
V3/ : Get a Project scenario's specific (historic) versionPM/ ProjectScenario/ :projectScenarioId/ Version/ :versionId - POST /API/
V3/ : Undelete a recently deleted Project scenarioPM/ ProjectScenario/ :projectScenarioId/ Undelete
Required license
This endpoint requires the following licenses:
- undelete
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Result
This endpoint returns the following data: array of PF.
GET /API/V3/PM/ProjectsWithActiveScenario
Returns references to all projects that have an active scenario; read the scenario itself with getActiveScenarioOfProjects
HTTP syntax
GET /API/V3/PM/ProjectsWithActiveScenario?allowSingleInactive=...&sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectsWithActiveScenario(allowSingleInactive, sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectsWithActiveScenario(allowSingleInactive) // returns PF.Reference[]
Pqf.pm.getAllProjectsWithActiveScenario() // returns PF.Reference[] Required permission
The returned array is filtered and contains only objects with permission READ.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
allowSingleInactive |
boolean | Treat a scenario that is the project's only one as active, even when its state is not | false |
||
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 '[ (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/PM/ProjectsWithMissingReport
Returns references to all projects that do not have a report about the latest reporting interval; read the projects with getProjects
HTTP syntax
GET /API/V3/PM/ProjectsWithMissingReport?projectStateIds=...&reportStateIds=...&reportTypeIds=...&sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectsWithMissingReport(projectStateIds, reportStateIds, reportTypeIds, sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectsWithMissingReport(projectStateIds, reportStateIds, reportTypeIds) // returns PF.Reference[]
Pqf.pm.getAllProjectsWithMissingReport(projectStateIds, reportStateIds) // returns PF.Reference[]
Pqf.pm.getAllProjectsWithMissingReport(projectStateIds) // returns PF.Reference[]
Pqf.pm.getAllProjectsWithMissingReport() // returns PF.Reference[] Required permission
The returned array is filtered and contains only objects with permission READ.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectStateIds |
array of UUID | The project states to filter projects by | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
reportStateIds |
array of UUID | Requires the reports to be in a specific state | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
reportTypeIds |
array of UUID | The project report types that should be included (omit to include all) | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
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 '[ (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/PM/ProjectWorkItem/:projectWorkItemId
Get a Returns a project work item
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId
<- application/json : ProjectWorkItem JavaScript syntax
Pqf.pm.getProjectWorkItem(projectWorkItemId) // returns ProjectWorkItem Other endpoints for objects of type project work item
This endpoint is part of a group of endpoints manipulating objects of type project work item. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple Returns a project work itemsPM/ ProjectWorkItems/ :projectWorkItemIds - PUT /API/
V3/ : Update an existing Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - DELETE /API/
V3/ : Delete a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get a Returns a project work item identificationPM/ ProjectWorkItem/ :projectWorkItemId/ Identification - GET /API/
V3/ : Get multiple Returns a project work item identificationsPM/ ProjectWorkItems/ :projectWorkItemIds/ Identification - GET /API/
V3/ : Get a Returns a project work item's version timelinePM/ ProjectWorkItem/ :projectWorkItemId/ Timeline - GET /API/
V3/ : Get a Returns a project work item's specific (historic) versionPM/ ProjectWorkItem/ :projectWorkItemId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The Returns a project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectWorkItem
PUT /API/V3/PM/ProjectWorkItem/:projectWorkItemId
Update an existing Returns a project work item
HTTP syntax
PUT /API/V3/PM/ProjectWorkItem/:projectWorkItemId
-> application/json : ProjectWorkItem JavaScript syntax
Pqf.pm.putProjectWorkItem(projectWorkItemId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project work item
This endpoint is part of a group of endpoints manipulating objects of type project work item. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get multiple Returns a project work itemsPM/ ProjectWorkItems/ :projectWorkItemIds - DELETE /API/
V3/ : Delete a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get a Returns a project work item identificationPM/ ProjectWorkItem/ :projectWorkItemId/ Identification - GET /API/
V3/ : Get multiple Returns a project work item identificationsPM/ ProjectWorkItems/ :projectWorkItemIds/ Identification - GET /API/
V3/ : Get a Returns a project work item's version timelinePM/ ProjectWorkItem/ :projectWorkItemId/ Timeline - GET /API/
V3/ : Get a Returns a project work item's specific (historic) versionPM/ ProjectWorkItem/ :projectWorkItemId/ Version/ :versionId
Required permission
Requires permission UPDATE or CREATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The Returns a project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectWorkItem | JSON object of type ProjectWorkItem | ✔️ |
DELETE /API/V3/PM/ProjectWorkItem/:projectWorkItemId
Delete a Returns a project work item
HTTP syntax
DELETE /API/V3/PM/ProjectWorkItem/:projectWorkItemId JavaScript syntax
Pqf.pm.delProjectWorkItem(projectWorkItemId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project work item
This endpoint is part of a group of endpoints manipulating objects of type project work item. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get multiple Returns a project work itemsPM/ ProjectWorkItems/ :projectWorkItemIds - PUT /API/
V3/ : Update an existing Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get a Returns a project work item identificationPM/ ProjectWorkItem/ :projectWorkItemId/ Identification - GET /API/
V3/ : Get multiple Returns a project work item identificationsPM/ ProjectWorkItems/ :projectWorkItemIds/ Identification - GET /API/
V3/ : Get a Returns a project work item's version timelinePM/ ProjectWorkItem/ :projectWorkItemId/ Timeline - GET /API/
V3/ : Get a Returns a project work item's specific (historic) versionPM/ ProjectWorkItem/ :projectWorkItemId/ Version/ :versionId
Required permission
Requires permission DELETE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The Returns a project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/AccumulatedValues/Costs
Returns the costs group of the accumulated values (costs budget and costs forecasts), optionally restricted to a day range, of a project work item. All money values are converted into the target currency. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/AccumulatedValues/Costs?beg=...&end=...&targetCurrencyId=...
<- application/json : AccumulatedCosts JavaScript syntax
Pqf.pm.getAccumulatedCostsOfProjectWorkItem(projectWorkItemId, beg, end, targetCurrencyId) // returns AccumulatedCosts
// Overloads for optional parameters
Pqf.pm.getAccumulatedCostsOfProjectWorkItem(projectWorkItemId, beg, end) // returns AccumulatedCosts
Pqf.pm.getAccumulatedCostsOfProjectWorkItem(projectWorkItemId, beg) // returns AccumulatedCosts
Pqf.pm.getAccumulatedCostsOfProjectWorkItem(projectWorkItemId) // returns AccumulatedCosts Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive) to restrict the costs to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: AccumulatedCosts
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/AccumulatedValues/Progress
Returns the progress group of the accumulated values (calculated progress and its manual override) of a project work item
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/AccumulatedValues/Progress
<- application/json : AccumulatedProgress JavaScript syntax
Pqf.pm.getAccumulatedProgressOfProjectWorkItem(projectWorkItemId) // returns AccumulatedProgress Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: AccumulatedProgress
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/AccumulatedValues/Structure
Returns the structure group of the accumulated values (children, planning errors, time budget and planned time) of a project work item
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/AccumulatedValues/Structure
<- application/json : AccumulatedStructure JavaScript syntax
Pqf.pm.getAccumulatedStructureOfProjectWorkItem(projectWorkItemId) // returns AccumulatedStructure Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: AccumulatedStructure
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/AccumulatedValues/Times
Returns the times group of the accumulated values (allocated, spent, pending and remaining time and the overload), optionally restricted to a day range of a project work item. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/AccumulatedValues/Times?beg=...&end=...
<- application/json : AccumulatedTime JavaScript syntax
Pqf.pm.getAccumulatedTimesOfProjectWorkItem(projectWorkItemId, beg, end) // returns AccumulatedTime
// Overloads for optional parameters
Pqf.pm.getAccumulatedTimesOfProjectWorkItem(projectWorkItemId, beg) // returns AccumulatedTime
Pqf.pm.getAccumulatedTimesOfProjectWorkItem(projectWorkItemId) // returns AccumulatedTime Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
beg |
date | The first day of the time span (inclusive) to restrict the times to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: AccumulatedTime
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/CopyTo/:targetId
Copies a work item and attaches it to another or the same parent task
HTTP syntax
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/CopyTo/:targetId?sortIndex=...©Logs=...©DocumentLinks=...©ShiftPlans=...©Dependencies=...©Allocations=...©PlannedCosts=...©TodoLinks=...©Todos=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.copyProjectWorkItemTree(projectWorkItemId, targetId, sortIndex, copyLogs, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyPlannedCosts, copyTodoLinks, copyTodos) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.copyProjectWorkItemTree(projectWorkItemId, targetId, sortIndex, copyLogs, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyPlannedCosts, copyTodoLinks) // returns PF.Reference
Pqf.pm.copyProjectWorkItemTree(projectWorkItemId, targetId, sortIndex, copyLogs, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations, copyPlannedCosts) // returns PF.Reference
Pqf.pm.copyProjectWorkItemTree(projectWorkItemId, targetId, sortIndex, copyLogs, copyDocumentLinks, copyShiftPlans, copyDependencies, copyAllocations) // returns PF.Reference
Pqf.pm.copyProjectWorkItemTree(projectWorkItemId, targetId, sortIndex, copyLogs, copyDocumentLinks, copyShiftPlans, copyDependencies) // returns PF.Reference
Pqf.pm.copyProjectWorkItemTree(projectWorkItemId, targetId, sortIndex, copyLogs, copyDocumentLinks, copyShiftPlans) // returns PF.Reference
Pqf.pm.copyProjectWorkItemTree(projectWorkItemId, targetId, sortIndex, copyLogs, copyDocumentLinks) // returns PF.Reference
Pqf.pm.copyProjectWorkItemTree(projectWorkItemId, targetId, sortIndex, copyLogs) // returns PF.Reference
Pqf.pm.copyProjectWorkItemTree(projectWorkItemId, targetId, sortIndex) // returns PF.Reference
Pqf.pm.copyProjectWorkItemTree(projectWorkItemId, targetId) // returns PF.Reference Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Requires permission CREATE on object of type ProjectWorkItem.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
targetId |
UUID | The new parent task (may be the same) | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
sortIndex |
double? | The new position index (stays the same, if omitted) | |||
copyLogs |
boolean | Copy logs | true |
||
copyDocumentLinks |
boolean | Copy document links | true |
||
copyShiftPlans |
boolean | Copy shift plans | true |
||
copyDependencies |
boolean | Copy dependencies | true |
||
copyAllocations |
boolean | Copy allocations | false |
||
copyPlannedCosts |
boolean | Copy planned costs | false |
||
copyTodoLinks |
boolean | Copy todo links | false |
||
copyTodos |
boolean | Copy todos | false |
Result
This endpoint returns the following data: PF.Reference
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/End/Move
Moves a work item end in the timeline
HTTP syntax
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/End/Move?to=...&strategy=...&resourceId=... JavaScript syntax
Pqf.pm.moveProjectWorkItemEnd(projectWorkItemId, to, strategy, resourceId) // returns Number - the return code (HTTP 2xx code) of the call
// Overloads for optional parameters
Pqf.pm.moveProjectWorkItemEnd(projectWorkItemId, to, strategy) // returns Number - the return code (HTTP 2xx code) of the call
Pqf.pm.moveProjectWorkItemEnd(projectWorkItemId, to) // returns Number - the return code (HTTP 2xx code) of the call
Pqf.pm.moveProjectWorkItemEnd(projectWorkItemId) // returns Number - the return code (HTTP 2xx code) of the call Required license
The usage of the parameter resourceId requires the following licenses:
- fivedaysweek
Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Required license |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
to |
date | The day where the work item should end | |||
strategy |
string | Describes how other work items react to the movement | |||
resourceId |
UUID | The resource ID for workdays | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
fivedaysweek |
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/End/MovePattern
Calculates how other work items behave in reaction to a movement of a given work item's end
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/End/MovePattern?strategy=...&resourceId=...
<- application/json JavaScript syntax
Pqf.pm.getProjectWorkItemEndMovePattern(projectWorkItemId, strategy, resourceId) // returns MovePattern[]
// Overloads for optional parameters
Pqf.pm.getProjectWorkItemEndMovePattern(projectWorkItemId, strategy) // returns MovePattern[]
Pqf.pm.getProjectWorkItemEndMovePattern(projectWorkItemId) // returns MovePattern[] Required license
The usage of the parameter resourceId requires the following licenses:
- fivedaysweek
Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Required license |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
strategy |
string | Describes how other work items react to the movement | |||
resourceId |
UUID | The resource ID for workdays | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
fivedaysweek |
Result
This endpoint returns the following data: array of MovePattern
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/End/Proposed
Proposes a day for the end of a work item: the position within maxMove days of the current one at which the workload of the resources allocated to it deviates least from the optimum. A work item that is not a phase, that has no end or that carries no allocation at all has no proposal and is answered with 404
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/End/Proposed?maxMove=...&fewerWorkWeight=...
<- application/json : PositionProposal JavaScript syntax
Pqf.pm.proposeProjectWorkItemEnd(projectWorkItemId, maxMove, fewerWorkWeight) // returns PositionProposal
// Overloads for optional parameters
Pqf.pm.proposeProjectWorkItemEnd(projectWorkItemId, maxMove) // returns PositionProposal
Pqf.pm.proposeProjectWorkItemEnd(projectWorkItemId) // returns PositionProposal Required license
This endpoint requires the following licenses:
- optimizetask
Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
maxMove |
int | The maximal number of days the proposed position may deviate from the current one | 720 >= d > 0 (The value must be greater than 0 and at most 720.) |
30 |
|
fewerWorkWeight |
double | The factor to weight slots with fewer workload with in the deviation from the optimum | 0.25 |
Result
This endpoint returns the following data: PositionProposal
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Identification
Get a Returns a project work item identification
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectWorkItemIdentification(projectWorkItemId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectWorkItemIdentification(projectWorkItemId) // returns PF.IdentificationExtended Other endpoints for objects of type project work item
This endpoint is part of a group of endpoints manipulating objects of type project work item. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get multiple Returns a project work itemsPM/ ProjectWorkItems/ :projectWorkItemIds - PUT /API/
V3/ : Update an existing Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - DELETE /API/
V3/ : Delete a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get multiple Returns a project work item identificationsPM/ ProjectWorkItems/ :projectWorkItemIds/ Identification - GET /API/
V3/ : Get a Returns a project work item's version timelinePM/ ProjectWorkItem/ :projectWorkItemId/ Timeline - GET /API/
V3/ : Get a Returns a project work item's specific (historic) versionPM/ ProjectWorkItem/ :projectWorkItemId/ Version/ :versionId
Required permission
Requires permission IDENTIFY on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The Returns a project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Logs
Returns references to all logs of a given project work item; read them in full with getProjectWorkItemLogs
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Logs?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectWorkItemLogsOfProjectWorkItem(projectWorkItemId, sort) // returns PF.ReferenceWithParent[]
// Overloads for optional parameters
Pqf.pm.getAllProjectWorkItemLogsOfProjectWorkItem(projectWorkItemId) // returns PF.ReferenceWithParent[] Required license
This endpoint requires the following licenses:
- logbook
Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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, projectWorkItemId | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/ProjectWorkItem/:projectWorkItemId/Logs/Add
Adds a new log to a project work item
HTTP syntax
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Logs/Add?name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addProjectWorkItemLog(projectWorkItemId, name, code, description, color, iconRef) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.addProjectWorkItemLog(projectWorkItemId, name, code, description, color) // returns PF.Reference
Pqf.pm.addProjectWorkItemLog(projectWorkItemId, name, code, description) // returns PF.Reference
Pqf.pm.addProjectWorkItemLog(projectWorkItemId, name, code) // returns PF.Reference
Pqf.pm.addProjectWorkItemLog(projectWorkItemId, name) // returns PF.Reference
Pqf.pm.addProjectWorkItemLog(projectWorkItemId) // returns PF.Reference Required license
This endpoint requires the following licenses:
- logbook
Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
string | The name of the new log, 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 log, may contain HTML | ||
color |
color | The color of the new log | ||
iconRef |
URI | The icon of the new log, 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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/MilestoneConstraints
Returns references to the constraints that start or end in one of the two milestones of a given work item
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/MilestoneConstraints?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectMilestoneConstraintsOfProjectWorkItem(projectWorkItemId, sort) // returns ProjectMilestoneConstraintReference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectMilestoneConstraintsOfProjectWorkItem(projectWorkItemId) // returns ProjectMilestoneConstraintReference[] Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, constraintType, predecessorMilestoneId, successorMilestoneId, minDistance, maxDistance | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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 ProjectMilestoneConstraintReference
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Move
Moves a work item in the timeline
HTTP syntax
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Move?to=...&strategy=...&resourceId=... JavaScript syntax
Pqf.pm.moveProjectWorkItem(projectWorkItemId, to, strategy, resourceId) // returns Number - the return code (HTTP 2xx code) of the call
// Overloads for optional parameters
Pqf.pm.moveProjectWorkItem(projectWorkItemId, to, strategy) // returns Number - the return code (HTTP 2xx code) of the call
Pqf.pm.moveProjectWorkItem(projectWorkItemId, to) // returns Number - the return code (HTTP 2xx code) of the call
Pqf.pm.moveProjectWorkItem(projectWorkItemId) // returns Number - the return code (HTTP 2xx code) of the call Required license
The usage of the parameter resourceId requires the following licenses:
- fivedaysweek
Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Required license |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
to |
date | The day where the work item should start | |||
strategy |
string | Describes how other work items react to the movement | |||
resourceId |
UUID | The resource ID for workdays | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
fivedaysweek |
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/MovePattern
Calculates how other work items behave in reaction to a movement of a given work item
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/MovePattern?strategy=...&resourceId=...
<- application/json JavaScript syntax
Pqf.pm.getProjectWorkItemMovePattern(projectWorkItemId, strategy, resourceId) // returns MovePattern[]
// Overloads for optional parameters
Pqf.pm.getProjectWorkItemMovePattern(projectWorkItemId, strategy) // returns MovePattern[]
Pqf.pm.getProjectWorkItemMovePattern(projectWorkItemId) // returns MovePattern[] Required license
The usage of the parameter resourceId requires the following licenses:
- fivedaysweek
Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Required license |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
strategy |
string | Describes how other work items react to the movement | |||
resourceId |
UUID | The resource ID for workdays | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
fivedaysweek |
Result
This endpoint returns the following data: array of MovePattern
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ProgressCorrection/At/:day
Returns the progress correction of a project work item on a specific day (not found if there is none)
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ProgressCorrection/At/:day
<- application/json : ProgressCorrection JavaScript syntax
Pqf.pm.getProjectWorkItemProgressCorrection(projectWorkItemId, day) // returns ProgressCorrection Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
day |
date | The day on which the progress was measured | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: ProgressCorrection
PUT /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ProgressCorrection/At/:day
Writes a progress correction of a project work item on a specific day, given either as remaining effort or as progress in percent. An earlier correction of the same day is kept as overridden
HTTP syntax
PUT /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ProgressCorrection/At/:day?includesTimeBased=...&deleteOverride=...
-> application/json : ProgressCorrectionChange JavaScript syntax
Pqf.pm.putProjectWorkItemProgressCorrection(projectWorkItemId, day, includesTimeBased, deleteOverride, requestJson) // returns Number - the return code (HTTP 2xx code) of the call
// Overloads for optional parameters
Pqf.pm.putProjectWorkItemProgressCorrection(projectWorkItemId, day, includesTimeBased, requestJson) // returns Number - the return code (HTTP 2xx code) of the call
Pqf.pm.putProjectWorkItemProgressCorrection(projectWorkItemId, day, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
day |
date | The day on which the progress was measured | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
includesTimeBased |
boolean | Set to true, if the estimation also includes time based allocations (required for a progress in percent) | true |
||
deleteOverride |
boolean | Set to true, if the manual progress override of the work item should be removed | false |
||
requestJson |
ProgressCorrectionChange | JSON object of type ProgressCorrectionChange | ✔️ |
DELETE /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ProgressCorrection/At/:day
Deletes the latest progress correction of a project work item on a specific day
HTTP syntax
DELETE /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ProgressCorrection/At/:day?deleteOverride=... JavaScript syntax
Pqf.pm.delProjectWorkItemProgressCorrection(projectWorkItemId, day, deleteOverride) // returns Number - the return code (HTTP 2xx code) of the call
// Overloads for optional parameters
Pqf.pm.delProjectWorkItemProgressCorrection(projectWorkItemId, day) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
day |
date | The day on which the progress was measured | ✔️ | '2099-12-31' >= d >= '2000-01-01' (The value must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
deleteOverride |
boolean | Set to true, if the manual progress override of the work item should be removed | false |
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ProgressCorrections
Returns the progress correction history of a project work item, one element per day with a correction (an empty timeline if the work item has none)
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ProgressCorrections
<- application/json : ProgressCorrectionHistory JavaScript syntax
Pqf.pm.getProjectWorkItemProgressCorrections(projectWorkItemId) // returns ProgressCorrectionHistory Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProgressCorrectionHistory
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ShiftPlan
Returns the shift plan of a project work item: one pattern per resource shift telling, day by day from the work item's start onwards, on which days the shift is planned. It is the pattern alc.
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ShiftPlan
<- application/json : ProjectWorkItemShiftPlan JavaScript syntax
Pqf.pm.getProjectWorkItemShiftPlan(projectWorkItemId) // returns ProjectWorkItemShiftPlan Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectWorkItemShiftPlan
PUT /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ShiftPlan
Writes the shift plan of a project work item, replacing the one it holds. Every pattern names the resource shift it plans and must be as long as all the others, since the patterns together form a matrix of days and shifts
HTTP syntax
PUT /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ShiftPlan
-> application/json : ProjectWorkItemShiftPlan JavaScript syntax
Pqf.pm.putProjectWorkItemShiftPlan(projectWorkItemId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectWorkItemShiftPlan | JSON object of type ProjectWorkItemShiftPlan | ✔️ |
DELETE /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ShiftPlan
Deletes the shift plan of a project work item. The reservations an earlier alc.
HTTP syntax
DELETE /API/V3/PM/ProjectWorkItem/:projectWorkItemId/ShiftPlan JavaScript syntax
Pqf.pm.delProjectWorkItemShiftPlan(projectWorkItemId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Split
Splits a work item into two pieces, returning a reference to the new (later) work item.
HTTP syntax
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Split?day=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.splitProjectWorkItem(projectWorkItemId, day) // returns PF.Reference Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
day |
date | The day where the work item should be split (mandatory) | ✔️ |
Result
This endpoint returns the following data: PF.Reference
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Start/Move
Moves a work item start in the timeline
HTTP syntax
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Start/Move?to=...&strategy=...&resourceId=... JavaScript syntax
Pqf.pm.moveProjectWorkItemStart(projectWorkItemId, to, strategy, resourceId) // returns Number - the return code (HTTP 2xx code) of the call
// Overloads for optional parameters
Pqf.pm.moveProjectWorkItemStart(projectWorkItemId, to, strategy) // returns Number - the return code (HTTP 2xx code) of the call
Pqf.pm.moveProjectWorkItemStart(projectWorkItemId, to) // returns Number - the return code (HTTP 2xx code) of the call
Pqf.pm.moveProjectWorkItemStart(projectWorkItemId) // returns Number - the return code (HTTP 2xx code) of the call Required license
The usage of the parameter resourceId requires the following licenses:
- fivedaysweek
Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Required license |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
to |
date | The day where the work item should start | |||
strategy |
string | Describes how other work items react to the movement | |||
resourceId |
UUID | The resource ID for workdays | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
fivedaysweek |
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Start/MovePattern
Calculates how other work items behave in reaction to a movement of a given work item's start
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Start/MovePattern?strategy=...&resourceId=...
<- application/json JavaScript syntax
Pqf.pm.getProjectWorkItemStartMovePattern(projectWorkItemId, strategy, resourceId) // returns MovePattern[]
// Overloads for optional parameters
Pqf.pm.getProjectWorkItemStartMovePattern(projectWorkItemId, strategy) // returns MovePattern[]
Pqf.pm.getProjectWorkItemStartMovePattern(projectWorkItemId) // returns MovePattern[] Required license
The usage of the parameter resourceId requires the following licenses:
- fivedaysweek
Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Required license |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
strategy |
string | Describes how other work items react to the movement | |||
resourceId |
UUID | The resource ID for workdays | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
fivedaysweek |
Result
This endpoint returns the following data: array of MovePattern
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Start/Proposed
Proposes a day for the start of a work item: the position within maxMove days of the current one at which the workload of the resources allocated to it deviates least from the optimum. A work item that is not a phase, that has no start or that carries no allocation at all has no proposal and is answered with 404
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Start/Proposed?maxMove=...&fewerWorkWeight=...
<- application/json : PositionProposal JavaScript syntax
Pqf.pm.proposeProjectWorkItemStart(projectWorkItemId, maxMove, fewerWorkWeight) // returns PositionProposal
// Overloads for optional parameters
Pqf.pm.proposeProjectWorkItemStart(projectWorkItemId, maxMove) // returns PositionProposal
Pqf.pm.proposeProjectWorkItemStart(projectWorkItemId) // returns PositionProposal Required license
This endpoint requires the following licenses:
- optimizetask
Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectWorkItemId |
UUID | The work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
maxMove |
int | The maximal number of days the proposed position may deviate from the current one | 720 >= d > 0 (The value must be greater than 0 and at most 720.) |
30 |
|
fewerWorkWeight |
double | The factor to weight slots with fewer workload with in the deviation from the optimum | 0.25 |
Result
This endpoint returns the following data: PositionProposal
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/SubWorkItems
Returns the child work items of a work item
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/SubWorkItems?depth=...&sort=...
<- application/json JavaScript syntax
Pqf.pm.getSubWorkItemsOfProjectWorkItem(projectWorkItemId, depth, sort) // returns ProjectWorkItemReference[]
// Overloads for optional parameters
Pqf.pm.getSubWorkItemsOfProjectWorkItem(projectWorkItemId, depth) // returns ProjectWorkItemReference[]
Pqf.pm.getSubWorkItemsOfProjectWorkItem(projectWorkItemId) // returns ProjectWorkItemReference[] Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
depth |
int? | Limit the tree depth, whole subtree if omitted | d > 0 (The value, if present, must be greater than 0.) |
|
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, colorId, createdAt, modifiedAt, workItemType, sortIndex, start, end 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 '[ (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 ProjectWorkItemReference
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/SubWorkItems/Add
Adds a new child work item to a work item
HTTP syntax
POST /API/V3/PM/ProjectWorkItem/:projectWorkItemId/SubWorkItems/Add?name=...&code=...&description=...&colorId=...&iconRef=...&start=...&end=...&sortIndex=...
<- application/json : PF.Reference JavaScript syntax
Pqf.pm.addProjectWorkItemSubWorkItem(projectWorkItemId, name, code, description, colorId, iconRef, start, end, sortIndex) // returns PF.Reference
// Overloads for optional parameters
Pqf.pm.addProjectWorkItemSubWorkItem(projectWorkItemId, name, code, description, colorId, iconRef, start, end) // returns PF.Reference
Pqf.pm.addProjectWorkItemSubWorkItem(projectWorkItemId, name, code, description, colorId, iconRef, start) // returns PF.Reference
Pqf.pm.addProjectWorkItemSubWorkItem(projectWorkItemId, name, code, description, colorId, iconRef) // returns PF.Reference
Pqf.pm.addProjectWorkItemSubWorkItem(projectWorkItemId, name, code, description, colorId) // returns PF.Reference
Pqf.pm.addProjectWorkItemSubWorkItem(projectWorkItemId, name, code, description) // returns PF.Reference
Pqf.pm.addProjectWorkItemSubWorkItem(projectWorkItemId, name, code) // returns PF.Reference
Pqf.pm.addProjectWorkItemSubWorkItem(projectWorkItemId, name) // returns PF.Reference
Pqf.pm.addProjectWorkItemSubWorkItem(projectWorkItemId) // returns PF.Reference Required permission
Requires permission CREATE on object of type ProjectWorkItem.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
string | The name of the new work item, 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 work item, may contain HTML | ||
colorId |
UUID | The color of the new work item, an ID pointing to a client's enum containing the color | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
iconRef |
URI | The icon of the new work item, 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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
|
start |
date | The first day of the new work item; a folder without times if both start and end are omitted, a milestone if equal to end | ||
end |
date | The last day of the new work item; a folder without times if both start and end are omitted, a milestone if equal to start | ||
sortIndex |
double? | Index for sorting the new work item among its siblings, appended behind them if omitted |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Timeline
Get a Returns a project work item's version timeline
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.pm.getProjectWorkItemTimeline(projectWorkItemId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.pm.getProjectWorkItemTimeline(projectWorkItemId, limit, until, from) // returns PF.VersionTimeline
Pqf.pm.getProjectWorkItemTimeline(projectWorkItemId, limit, until) // returns PF.VersionTimeline
Pqf.pm.getProjectWorkItemTimeline(projectWorkItemId, limit) // returns PF.VersionTimeline
Pqf.pm.getProjectWorkItemTimeline(projectWorkItemId) // returns PF.VersionTimeline Other endpoints for objects of type project work item
This endpoint is part of a group of endpoints manipulating objects of type project work item. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get multiple Returns a project work itemsPM/ ProjectWorkItems/ :projectWorkItemIds - PUT /API/
V3/ : Update an existing Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - DELETE /API/
V3/ : Delete a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get a Returns a project work item identificationPM/ ProjectWorkItem/ :projectWorkItemId/ Identification - GET /API/
V3/ : Get multiple Returns a project work item identificationsPM/ ProjectWorkItems/ :projectWorkItemIds/ Identification - GET /API/
V3/ : Get a Returns a project work item's specific (historic) versionPM/ ProjectWorkItem/ :projectWorkItemId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The Returns a project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/PM/ProjectWorkItem/:projectWorkItemId/Version/:versionId
Get a Returns a project work item's specific (historic) version
HTTP syntax
GET /API/V3/PM/ProjectWorkItem/:projectWorkItemId/Version/:versionId
<- application/json : ProjectWorkItem JavaScript syntax
Pqf.pm.getProjectWorkItemVersion(projectWorkItemId, versionId) // returns ProjectWorkItem Other endpoints for objects of type project work item
This endpoint is part of a group of endpoints manipulating objects of type project work item. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get multiple Returns a project work itemsPM/ ProjectWorkItems/ :projectWorkItemIds - PUT /API/
V3/ : Update an existing Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - DELETE /API/
V3/ : Delete a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get a Returns a project work item identificationPM/ ProjectWorkItem/ :projectWorkItemId/ Identification - GET /API/
V3/ : Get multiple Returns a project work item identificationsPM/ ProjectWorkItems/ :projectWorkItemIds/ Identification - GET /API/
V3/ : Get a Returns a project work item's version timelinePM/ ProjectWorkItem/ :projectWorkItemId/ Timeline
Required permission
Requires permission READ on object of type ProjectWorkItem and ID specified in parameter projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemId |
UUID | The Returns a project work item's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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: ProjectWorkItem
GET /API/V3/PM/ProjectWorkItemLog/:projectWorkItemLogId
Get a project work item log
HTTP syntax
GET /API/V3/PM/ProjectWorkItemLog/:projectWorkItemLogId
<- application/json : ProjectWorkItemLog JavaScript syntax
Pqf.pm.getProjectWorkItemLog(projectWorkItemLogId) // returns ProjectWorkItemLog Other endpoints for objects of type project work item log
This endpoint is part of a group of endpoints manipulating objects of type project work item log. The following endpoints belong to the same group:
- GET /API/
V3/ : Get multiple project work item logsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds - PUT /API/
V3/ : Create or update a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - DELETE /API/
V3/ : Delete a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get a project work item log identificationPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Identification - GET /API/
V3/ : Get multiple project work item log identificationsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds/ Identification - GET /API/
V3/ : Get a project work item log's version timelinePM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Timeline - GET /API/
V3/ : Get a project work item log's specific (historic) versionPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Version/ :versionId
Required license
This endpoint requires the following licenses:
- logbook
Required permission
Requires permission READ on parent with type ProjectWorkItemobject of type ProjectWorkItemLog and ID specified in parameter projectWorkItemLogId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemLogId |
UUID | The project work item log's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: ProjectWorkItemLog
PUT /API/V3/PM/ProjectWorkItemLog/:projectWorkItemLogId
Create or update a project work item log
HTTP syntax
PUT /API/V3/PM/ProjectWorkItemLog/:projectWorkItemLogId
-> application/json : ProjectWorkItemLog JavaScript syntax
Pqf.pm.putProjectWorkItemLog(projectWorkItemLogId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project work item log
This endpoint is part of a group of endpoints manipulating objects of type project work item log. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get multiple project work item logsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds - DELETE /API/
V3/ : Delete a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get a project work item log identificationPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Identification - GET /API/
V3/ : Get multiple project work item log identificationsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds/ Identification - GET /API/
V3/ : Get a project work item log's version timelinePM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Timeline - GET /API/
V3/ : Get a project work item log's specific (historic) versionPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Version/ :versionId
Required license
This endpoint requires the following licenses:
- logbook
Required permission
Requires permission UPDATE on object of type ProjectWorkItem and ID specified in parameter requestJson.projectWorkItemId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemLogId |
UUID | The project work item log's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
ProjectWorkItemLog | JSON object of type ProjectWorkItemLog | ✔️ |
DELETE /API/V3/PM/ProjectWorkItemLog/:projectWorkItemLogId
Delete a project work item log
HTTP syntax
DELETE /API/V3/PM/ProjectWorkItemLog/:projectWorkItemLogId JavaScript syntax
Pqf.pm.delProjectWorkItemLog(projectWorkItemLogId) // returns Number - the return code (HTTP 2xx code) of the call Other endpoints for objects of type project work item log
This endpoint is part of a group of endpoints manipulating objects of type project work item log. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get multiple project work item logsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds - PUT /API/
V3/ : Create or update a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get a project work item log identificationPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Identification - GET /API/
V3/ : Get multiple project work item log identificationsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds/ Identification - GET /API/
V3/ : Get a project work item log's version timelinePM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Timeline - GET /API/
V3/ : Get a project work item log's specific (historic) versionPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Version/ :versionId
Required license
This endpoint requires the following licenses:
- logbook
Required permission
Requires permission UPDATE on parent with type ProjectWorkItemobject of type ProjectWorkItemLog and ID specified in parameter projectWorkItemLogId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemLogId |
UUID | The project work item log's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/ProjectWorkItemLog/:projectWorkItemLogId/Identification
Get a project work item log identification
HTTP syntax
GET /API/V3/PM/ProjectWorkItemLog/:projectWorkItemLogId/Identification?deleted=...
<- application/json : PF.IdentificationExtended JavaScript syntax
Pqf.pm.getProjectWorkItemLogIdentification(projectWorkItemLogId, deleted) // returns PF.IdentificationExtended
// Overloads for optional parameters
Pqf.pm.getProjectWorkItemLogIdentification(projectWorkItemLogId) // returns PF.IdentificationExtended Other endpoints for objects of type project work item log
This endpoint is part of a group of endpoints manipulating objects of type project work item log. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get multiple project work item logsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds - PUT /API/
V3/ : Create or update a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - DELETE /API/
V3/ : Delete a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get multiple project work item log identificationsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds/ Identification - GET /API/
V3/ : Get a project work item log's version timelinePM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Timeline - GET /API/
V3/ : Get a project work item log's specific (historic) versionPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Version/ :versionId
Required license
This endpoint requires the following licenses:
- logbook
Required permission
Requires permission READ on parent with type ProjectWorkItemobject of type ProjectWorkItemLog and ID specified in parameter projectWorkItemLogId.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectWorkItemLogId |
UUID | The project work item log's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
deleted |
boolean | Allow deleted objects to be returned | false |
Result
This endpoint returns the following data: PF.IdentificationExtended
GET /API/V3/PM/ProjectWorkItemLog/:projectWorkItemLogId/Timeline
Get a project work item log's version timeline
HTTP syntax
GET /API/V3/PM/ProjectWorkItemLog/:projectWorkItemLogId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.pm.getProjectWorkItemLogTimeline(projectWorkItemLogId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.pm.getProjectWorkItemLogTimeline(projectWorkItemLogId, limit, until, from) // returns PF.VersionTimeline
Pqf.pm.getProjectWorkItemLogTimeline(projectWorkItemLogId, limit, until) // returns PF.VersionTimeline
Pqf.pm.getProjectWorkItemLogTimeline(projectWorkItemLogId, limit) // returns PF.VersionTimeline
Pqf.pm.getProjectWorkItemLogTimeline(projectWorkItemLogId) // returns PF.VersionTimeline Other endpoints for objects of type project work item log
This endpoint is part of a group of endpoints manipulating objects of type project work item log. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get multiple project work item logsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds - PUT /API/
V3/ : Create or update a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - DELETE /API/
V3/ : Delete a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get a project work item log identificationPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Identification - GET /API/
V3/ : Get multiple project work item log identificationsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds/ Identification - GET /API/
V3/ : Get a project work item log's specific (historic) versionPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Version/ :versionId
Required license
This endpoint requires the following licenses:
- logbook
Required permission
Requires permission READ on parent with type ProjectWorkItemobject of type ProjectWorkItemLog and ID specified in parameter projectWorkItemLogId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemLogId |
UUID | The project work item log's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/PM/ProjectWorkItemLog/:projectWorkItemLogId/Version/:versionId
Get a project work item log's specific (historic) version
HTTP syntax
GET /API/V3/PM/ProjectWorkItemLog/:projectWorkItemLogId/Version/:versionId
<- application/json : ProjectWorkItemLog JavaScript syntax
Pqf.pm.getProjectWorkItemLogVersion(projectWorkItemLogId, versionId) // returns ProjectWorkItemLog Other endpoints for objects of type project work item log
This endpoint is part of a group of endpoints manipulating objects of type project work item log. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get multiple project work item logsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds - PUT /API/
V3/ : Create or update a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - DELETE /API/
V3/ : Delete a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get a project work item log identificationPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Identification - GET /API/
V3/ : Get multiple project work item log identificationsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds/ Identification - GET /API/
V3/ : Get a project work item log's version timelinePM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Timeline
Required license
This endpoint requires the following licenses:
- logbook
Required permission
Requires permission READ on parent with type ProjectWorkItemobject of type ProjectWorkItemLog and ID specified in parameter projectWorkItemLogId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemLogId |
UUID | The project work item log's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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: ProjectWorkItemLog
GET /API/V3/PM/ProjectWorkItemLogs/:projectWorkItemLogIds
Get multiple project work item logs
HTTP syntax
GET /API/V3/PM/ProjectWorkItemLogs/:projectWorkItemLogIds
<- application/json JavaScript syntax
Pqf.pm.getProjectWorkItemLogs(projectWorkItemLogIds) // returns ProjectWorkItemLog[] Other endpoints for objects of type project work item log
This endpoint is part of a group of endpoints manipulating objects of type project work item log. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - PUT /API/
V3/ : Create or update a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - DELETE /API/
V3/ : Delete a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get a project work item log identificationPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Identification - GET /API/
V3/ : Get multiple project work item log identificationsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds/ Identification - GET /API/
V3/ : Get a project work item log's version timelinePM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Timeline - GET /API/
V3/ : Get a project work item log's specific (historic) versionPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Version/ :versionId
Required license
This endpoint requires the following licenses:
- logbook
Required permission
Requires permission READ on parent with type ProjectWorkItemobject of type ProjectWorkItemLog and ID in specified in parameter projectWorkItemLogIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemLogIds |
array of UUID | The project work item log IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectWorkItemLog
GET /API/V3/PM/ProjectWorkItemLogs/:projectWorkItemLogIds/Identification
Get multiple project work item log identifications
HTTP syntax
GET /API/V3/PM/ProjectWorkItemLogs/:projectWorkItemLogIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectWorkItemLogIdentifications(projectWorkItemLogIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectWorkItemLogIdentifications(projectWorkItemLogIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project work item log
This endpoint is part of a group of endpoints manipulating objects of type project work item log. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get multiple project work item logsPM/ ProjectWorkItemLogs/ :projectWorkItemLogIds - PUT /API/
V3/ : Create or update a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - DELETE /API/
V3/ : Delete a project work item logPM/ ProjectWorkItemLog/ :projectWorkItemLogId - GET /API/
V3/ : Get a project work item log identificationPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Identification - GET /API/
V3/ : Get a project work item log's version timelinePM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Timeline - GET /API/
V3/ : Get a project work item log's specific (historic) versionPM/ ProjectWorkItemLog/ :projectWorkItemLogId/ Version/ :versionId
Required license
This endpoint requires the following licenses:
- logbook
Required permission
Requires permission READ on parent with type ProjectWorkItemobject of type ProjectWorkItemLog and ID in specified in parameter projectWorkItemLogIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectWorkItemLogIds |
array of UUID | The project work item log IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/ProjectWorkItems/:projectWorkItemIds
Get multiple Returns a project work items
HTTP syntax
GET /API/V3/PM/ProjectWorkItems/:projectWorkItemIds
<- application/json JavaScript syntax
Pqf.pm.getProjectWorkItems(projectWorkItemIds) // returns ProjectWorkItem[] Other endpoints for objects of type project work item
This endpoint is part of a group of endpoints manipulating objects of type project work item. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - PUT /API/
V3/ : Update an existing Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - DELETE /API/
V3/ : Delete a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get a Returns a project work item identificationPM/ ProjectWorkItem/ :projectWorkItemId/ Identification - GET /API/
V3/ : Get multiple Returns a project work item identificationsPM/ ProjectWorkItems/ :projectWorkItemIds/ Identification - GET /API/
V3/ : Get a Returns a project work item's version timelinePM/ ProjectWorkItem/ :projectWorkItemId/ Timeline - GET /API/
V3/ : Get a Returns a project work item's specific (historic) versionPM/ ProjectWorkItem/ :projectWorkItemId/ Version/ :versionId
Required permission
Requires permission READ on object of type ProjectWorkItem and ID in specified in parameter projectWorkItemIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemIds |
array of UUID | The Returns a project work item IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 ProjectWorkItem
GET /API/V3/PM/ProjectWorkItems/:projectWorkItemIds/AccumulatedValues/Costs
Returns the costs group of the accumulated values (costs budget and costs forecasts), optionally restricted to a day range, of some project work items, one element per work item. All money values are converted into the target currency. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/ProjectWorkItems/:projectWorkItemIds/AccumulatedValues/Costs?beg=...&end=...&targetCurrencyId=...
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedCostsOfProjectWorkItems(projectWorkItemIds, beg, end, targetCurrencyId) // returns AccumulatedCosts[]
// Overloads for optional parameters
Pqf.pm.getAccumulatedCostsOfProjectWorkItems(projectWorkItemIds, beg, end) // returns AccumulatedCosts[]
Pqf.pm.getAccumulatedCostsOfProjectWorkItems(projectWorkItemIds, beg) // returns AccumulatedCosts[]
Pqf.pm.getAccumulatedCostsOfProjectWorkItems(projectWorkItemIds) // returns AccumulatedCosts[] Required license
This endpoint requires the following licenses:
- costmanagement
Required permission
Requires permission READ on object of type ProjectWorkItem and ID in specified in parameter projectWorkItemIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemIds |
array of UUID | The project work items' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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.) |
beg |
date | The first day of the time span (inclusive) to restrict the costs to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
targetCurrencyId |
UUID | The ID of the currency to convert all money values into; the user's own currency if omitted | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of AccumulatedCosts
GET /API/V3/PM/ProjectWorkItems/:projectWorkItemIds/AccumulatedValues/Progress
Returns the progress group of the accumulated values (calculated progress and its manual override) of some project work items, one element per work item
HTTP syntax
GET /API/V3/PM/ProjectWorkItems/:projectWorkItemIds/AccumulatedValues/Progress
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedProgressOfProjectWorkItems(projectWorkItemIds) // returns AccumulatedProgress[] Required permission
Requires permission READ on object of type ProjectWorkItem and ID in specified in parameter projectWorkItemIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemIds |
array of UUID | The project work items' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 AccumulatedProgress
GET /API/V3/PM/ProjectWorkItems/:projectWorkItemIds/AccumulatedValues/Structure
Returns the structure group of the accumulated values (children, planning errors, time budget and planned time) of some project work items, one element per work item
HTTP syntax
GET /API/V3/PM/ProjectWorkItems/:projectWorkItemIds/AccumulatedValues/Structure
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedStructureOfProjectWorkItems(projectWorkItemIds) // returns AccumulatedStructure[] Required permission
Requires permission READ on object of type ProjectWorkItem and ID in specified in parameter projectWorkItemIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemIds |
array of UUID | The project work items' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 AccumulatedStructure
GET /API/V3/PM/ProjectWorkItems/:projectWorkItemIds/AccumulatedValues/Times
Returns the times group of the accumulated values (allocated, spent, pending and remaining time and the overload), optionally restricted to a day range of some project work items, one element per work item. Either none or both days of the range must be given, and they must lie within the planning range
HTTP syntax
GET /API/V3/PM/ProjectWorkItems/:projectWorkItemIds/AccumulatedValues/Times?beg=...&end=...
<- application/json JavaScript syntax
Pqf.pm.getAccumulatedTimesOfProjectWorkItems(projectWorkItemIds, beg, end) // returns AccumulatedTime[]
// Overloads for optional parameters
Pqf.pm.getAccumulatedTimesOfProjectWorkItems(projectWorkItemIds, beg) // returns AccumulatedTime[]
Pqf.pm.getAccumulatedTimesOfProjectWorkItems(projectWorkItemIds) // returns AccumulatedTime[] Required permission
Requires permission READ on object of type ProjectWorkItem and ID in specified in parameter projectWorkItemIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
projectWorkItemIds |
array of UUID | The project work items' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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.) |
beg |
date | The first day of the time span (inclusive) to restrict the times to; either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
|
end |
date | The day after the last day of the time span (exclusive); either none or both days of the range must be given | '2099-12-31' >= d >= '2000-01-01' (The value, if present, must be between 2000-01-01 and 2099-12-31, both inclusive.) |
Result
This endpoint returns the following data: array of AccumulatedTime
GET /API/V3/PM/ProjectWorkItems/:projectWorkItemIds/Identification
Get multiple Returns a project work item identifications
HTTP syntax
GET /API/V3/PM/ProjectWorkItems/:projectWorkItemIds/Identification?deleted=...
<- application/json JavaScript syntax
Pqf.pm.getProjectWorkItemIdentifications(projectWorkItemIds, deleted) // returns PF.IdentificationExtended[]
// Overloads for optional parameters
Pqf.pm.getProjectWorkItemIdentifications(projectWorkItemIds) // returns PF.IdentificationExtended[] Other endpoints for objects of type project work item
This endpoint is part of a group of endpoints manipulating objects of type project work item. The following endpoints belong to the same group:
- GET /API/
V3/ : Get a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get multiple Returns a project work itemsPM/ ProjectWorkItems/ :projectWorkItemIds - PUT /API/
V3/ : Update an existing Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - DELETE /API/
V3/ : Delete a Returns a project work itemPM/ ProjectWorkItem/ :projectWorkItemId - GET /API/
V3/ : Get a Returns a project work item identificationPM/ ProjectWorkItem/ :projectWorkItemId/ Identification - GET /API/
V3/ : Get a Returns a project work item's version timelinePM/ ProjectWorkItem/ :projectWorkItemId/ Timeline - GET /API/
V3/ : Get a Returns a project work item's specific (historic) versionPM/ ProjectWorkItem/ :projectWorkItemId/ Version/ :versionId
Required permission
Requires permission IDENTIFY on object of type ProjectWorkItem and ID in specified in parameter projectWorkItemIds.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
projectWorkItemIds |
array of UUID | The Returns a project work item IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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/PM/RootProjectPortfolios
Returns references to all root-level project portfolios
HTTP syntax
GET /API/V3/PM/RootProjectPortfolios?sort=...
<- application/json JavaScript syntax
Pqf.pm.getRootProjectPortfolios(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getRootProjectPortfolios() // returns PF.Reference[] 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 '[ (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/PM/SubObjectType/:subObjTypeId
Returns a sub object type
HTTP syntax
GET /API/V3/PM/SubObjectType/:subObjTypeId
<- application/json : PF.Identification JavaScript syntax
Pqf.pm.getProjectSubObjectType(subObjTypeId) // returns PF.Identification Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
subObjTypeId |
UUID | The sub object type's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: PF.Identification
GET /API/V3/PM/SubObjectType/:subObjTypeId/WithTranslations
Returns a sub object type with translations
HTTP syntax
GET /API/V3/PM/SubObjectType/:subObjTypeId/WithTranslations
<- application/json : PF.IdentificationTranslated JavaScript syntax
Pqf.pm.getProjectSubObjectTypeTranslated(subObjTypeId) // returns PF.IdentificationTranslated Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
subObjTypeId |
UUID | The sub object type's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: PF.IdentificationTranslated
PUT /API/V3/PM/SubObjectType/:subObjTypeId/WithTranslations
Updates or creates a sub object type with translations (only name and description are stored)
HTTP syntax
PUT /API/V3/PM/SubObjectType/:subObjTypeId/WithTranslations
-> application/json : PF.IdentificationTranslated JavaScript syntax
Pqf.pm.putProjectSubObjectTypeTranslated(subObjTypeId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
subObjTypeId |
UUID | The sub object type's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
PF.IdentificationTranslated | JSON object of type IdentificationTranslated | ✔️ |
DELETE /API/V3/PM/SubObjectType/:subObjTypeId/WithTranslations
Deletes a sub object type with translations
HTTP syntax
DELETE /API/V3/PM/SubObjectType/:subObjTypeId/WithTranslations JavaScript syntax
Pqf.pm.delProjectSubObjectTypeTranslated(subObjTypeId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
subObjTypeId |
UUID | The sub object type's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/PM/SubObjectTypes
Returns all sub object type references
HTTP syntax
GET /API/V3/PM/SubObjectTypes?sort=...
<- application/json JavaScript syntax
Pqf.pm.getAllProjectSubObjectTypes(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.pm.getAllProjectSubObjectTypes() // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (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/PM/SubObjectTypes/:subObjTypeIds
Returns multiple sub object types
HTTP syntax
GET /API/V3/PM/SubObjectTypes/:subObjTypeIds
<- application/json JavaScript syntax
Pqf.pm.getProjectSubObjectTypes(subObjTypeIds) // returns PF.Identification[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
subObjTypeIds |
array of UUID | The sub object types' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 PF.Identification
GET /API/V3/PM/SubObjectTypes/:subObjTypeIds/WithTranslations
Returns multiple sub object types with translations
HTTP syntax
GET /API/V3/PM/SubObjectTypes/:subObjTypeIds/WithTranslations
<- application/json JavaScript syntax
Pqf.pm.getProjectSubObjectTypesTranslated(subObjTypeIds) // returns PF.IdentificationTranslated[] Required permission
Requires permission 41F1130E0CAE4C22812B9FD455C88846.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
subObjTypeIds |
array of UUID | The sub object types' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (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 PF.IdentificationTranslated
Data types
PM.AccumulatedCosts
This is a structure data contract.
The costs group of the accumulated values of a project work item, or of a whole project scenario accumulated over its top-most work items (for a scenario, its own costs budget is zero and its own costs are null), with all money values converted into one currency
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
ref |
PF.Reference | The object the values were asked for: a project work item, a project scenario or a project | non-null (The value is required.) |
|
costsBudget |
PF.CurrencyAmount | The costs budget of the work item itself | ||
costsBudgetAccumulated |
PF.CurrencyAmount | The costs budget of the work item and its descendants | ||
costs |
FCO.CostsForecastsGroups | The costs (including forecasts) of the work item itself | ||
costsAccumulated |
FCO.CostsForecastsGroups | The costs (including forecasts) of the work item and its descendants |
PM.AccumulatedProgress
This is a structure data contract.
The progress group of the accumulated values of a project work item, or of a whole project scenario accumulated over its top-most work items (for a scenario, progress equals progressAccumulated, and manualProgressOverride is the one of its single top-most work item, null for several)
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
ref |
PF.Reference | The object the values were asked for: a project work item, a project scenario or a project | non-null (The value is required.) |
|
progress |
double | The calculated progress of the work item itself in percent | ||
progressAccumulated |
double | The calculated progress of the work item in percent, respecting the progress of its descendants | ||
manualProgressOverride |
double? | Manual "calculated accumulated progress" override (0-100), null if not overridden | 100 >= x >= 0 (The value, if present, must be between 0 and 100, both inclusive.) |
PM.AccumulatedStructure
This is a structure data contract.
The structure group of the accumulated values of a project work item, or of a whole project scenario accumulated over its top-most work items (for a scenario, childrenCount counts its top-most work items and its own errors are empty)
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
ref |
PF.Reference | The object the values were asked for: a project work item, a project scenario or a project | non-null (The value is required.) |
|
childrenCount |
int | The number of direct children | ||
childrenCountAccumulated |
int | The number of children including all children's children recursively | ||
errors |
array of string | Detected planning errors for this work item in the user's language | non-null;non-null (The array is required. Each element must not be null.) |
|
errorsAccumulated |
array of string | Detected planning errors for this work item or any descendant in the user's language | non-null;non-null (The array is required. Each element must not be null.) |
|
timeBudgetAccumulated |
duration | The time that could be spent for the work item and its descendants | non-null (The value is required.) |
|
timePlannedAccumulated |
duration | The time that is planned to be spent for the work item and its descendants | non-null (The value is required.) |
PM.AccumulatedTime
This is a structure data contract.
The times group of the accumulated values of a project work item, or of a whole project scenario accumulated over its top-most work items (for a scenario, the values of its own are zero)
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
ref |
PF.Reference | The object the values were asked for: a project work item, a project scenario or a project | non-null (The value is required.) |
|
resourceAllocations |
duration | The allocated time for the work item | non-null (The value is required.) |
|
resourceAllocationsAccumulated |
duration | The allocated time for the work item and its descendants | non-null (The value is required.) |
|
resourceActuals |
duration | The time spent for the work item | non-null (The value is required.) |
|
resourceActualsAccumulated |
duration | The time spent for the work item and its descendants | non-null (The value is required.) |
|
timeExpectedPending |
duration | The presence of a resource that has not yet been reported but is expected to be reported for the work item | non-null (The value is required.) |
|
timeExpectedPendingAccumulated |
duration | The presence of a resource that has not yet been reported but is expected to be reported for the work item and its descendants | non-null (The value is required.) |
|
timeRemaining |
duration | The time that is planned to be spent but has not been spent yet for the work item | non-null (The value is required.) |
|
timeRemainingAccumulated |
duration | The time that is planned to be spent but has not been spent yet for the work item and its descendants | non-null (The value is required.) |
|
overloadIndicator |
double | The overload indicator (sum of deviation of all allocated resources) | ||
overloadIndicatorAccumulated |
double | The max overload indicator (sum of deviation of all allocated resources) of the work item and all its descendants |
PM.ExplicitProjectConstraintType
This is an enumeration data contract.
Distinguishes the different ways an explicit constraint between two project milestones came about
Enum values
| ID | Description |
|---|---|
MANUAL |
A constraint a user added |
SPLITTED |
A constraint that is the result of a work item being split |
PM.IndicatorClassification
This is a structure data contract.
A scheme that classifies an indicator's status or trend, for example red / yellow / green. Its steps are addressed on their own, as IndicatorClassificationValues
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
PM.IndicatorClassificationTranslated
This is a structure data contract.
An indicator classification scheme with its texts in every language. Its steps are addressed on their own, as IndicatorClassificationValues
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | null;non-null (The array is optional. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | null;non-null (The array is optional. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
null;non-null (The array is optional. Each element must not be null.) |
PM.IndicatorClassificationValue
This is a structure data contract.
One step of an indicator classification scheme
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
indicatorClassificationId |
UUID | The scheme this step belongs to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
valueStart |
double | The lowest rating that still falls into this step | ||
rating |
double | The rating this step stands for, used to order and to aggregate |
PM.IndicatorClassificationValueTranslated
This is a structure data contract.
One step of an indicator classification scheme, with its texts in every language
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | null;non-null (The array is optional. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | null;non-null (The array is optional. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
null;non-null (The array is optional. Each element must not be null.) |
indicatorClassificationId |
UUID | The scheme this step belongs to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
valueStart |
double | The lowest rating that still falls into this step | ||
rating |
double | The rating this step stands for, used to order and to aggregate |
PM.IndicatorCollection
This is a structure data contract.
The indicators in a project report
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
dimensions |
array of ProjectReportIndicatorDimension | The indicator dimensions | null;non-null (The array is optional. Each element must not be null.) |
|
leadingDimensionId |
UUID | The leading indicator dimension's own ID, if any - address it at /API/ |
matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
riskSum |
double | The sum of all risk ratings (one per dimension) in the report | ||
riskClassSum |
double | The sum of all risk rating classifications (one per dimension) in the report |
PM.IndicatorDetail
This is a structure data contract.
The tenant-wide definition of one measurable indicator, belonging to one dimension of one project report type
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
projectReportTypeId |
UUID | The project report type this definition applies to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
indicatorDimensionId |
UUID | The dimension this indicator belongs to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
statusClassificationId |
UUID | The classification scheme used for this indicator's status | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
trendClassificationId |
UUID | The classification scheme used for this indicator's trend | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
source |
string | How the indicator's values are obtained, for example "EffortWithRemaining()" or "Milestone(...)" | ||
semantics |
IndicatorSemantics | The semantic model the source implies, which decides how values are aggregated and compared | ||
sortIndex |
double | The sortIndex (lowest first) |
PM.IndicatorDetailTranslated
This is a structure data contract.
The tenant-wide definition of one measurable indicator, with translations
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | null;non-null (The array is optional. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | null;non-null (The array is optional. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
null;non-null (The array is optional. Each element must not be null.) |
projectReportTypeId |
UUID | The project report type this definition applies to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
indicatorDimensionId |
UUID | The dimension this indicator belongs to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
statusClassificationId |
UUID | The classification scheme used for this indicator's status | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
trendClassificationId |
UUID | The classification scheme used for this indicator's trend | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
source |
string | How the indicator's values are obtained, for example "EffortWithRemaining()" or "Milestone(...)" | ||
semantics |
IndicatorSemantics | The semantic model the source implies, which decides how values are aggregated and compared | ||
sortIndex |
double | The sortIndex (lowest first) |
PM.IndicatorDimension
This is a structure data contract.
The tenant-wide definition of one indicator dimension of one project report type, for example costs or timeline
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
projectReportTypeId |
UUID | The project report type this definition applies to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
statusClassificationId |
UUID | The classification scheme used for this dimension's status | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
trendClassificationId |
UUID | The classification scheme used for this dimension's trend | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
sortIndex |
double | The sortIndex (lowest first) |
PM.IndicatorDimensionTranslated
This is a structure data contract.
The tenant-wide definition of one indicator dimension of one project report type, with translations
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | null;non-null (The array is optional. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | null;non-null (The array is optional. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
null;non-null (The array is optional. Each element must not be null.) |
projectReportTypeId |
UUID | The project report type this definition applies to | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
statusClassificationId |
UUID | The classification scheme used for this dimension's status | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
trendClassificationId |
UUID | The classification scheme used for this dimension's trend | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
sortIndex |
double | The sortIndex (lowest first) |
PM.IndicatorRiskEstimation
This is a structure data contract.
Contains the manual risk rating of all risks belonging to a certain dimension on a project report
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
occurrenceProbability |
double | ✔️ | The probability of the occurrence of an event | |
occurrenceProbabilityClassificationId |
UUID | ✔️ | The classification of the probability of the occurrence of an event | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
extentOfLoss |
double | ✔️ | The amount of damage in case of an event | |
extentOfLossClassificationId |
UUID | ✔️ | The classification of the amount of damage in case of an event | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
riskRating |
double | ✔️ | The rating of the risk (the product of occurrence probability and extent of loss) | |
riskRatingClassificationId |
UUID | ✔️ | The classification of the rating of the risk | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
remark |
string | A remark why the risk is rated as it is |
PM.IndicatorSemantics
This is an enumeration data contract.
The semantic model that applies to an indicator, which decides how its values are aggregated and compared
Enum values
| ID | Description |
|---|---|
COSTS |
Indicator describes costs |
EFFORT |
Indicator describes effort (working time) |
OUTCOME |
Indicator describes outcome |
TIMELINE |
Indicator describes an event that is measured by its place on the timeline |
PROGRESS |
Indicator describes progress |
PM.IndicatorTotal
This is a structure data contract.
The aggregated values of all indicators of one dimension. A computed value with no object behind it, so unlike an indicator it carries no ID
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
targetValue |
string | The target value the project set for this indicator, converted to the report's currency and point in time | ||
plannedValueCalculated |
string | The calculated planned value, if any | ||
plannedValueManual |
string | The manually entered planned value, if any | ||
actualValueCalculated |
string | The calculated actual value, if any | ||
actualValueManual |
string | The manually entered actual value, if any | ||
supplementaryValueCalculated |
string | The calculated supplementary value, if any | ||
supplementaryValueManual |
string | The manually entered supplementary value, if any | ||
remainingValueCalculated |
string | The calculated remaining value, if any | ||
remainingValueManual |
string | The manually entered remaining value, if any | ||
forecastValueCalculated |
string | The calculated forecast value, if any | ||
forecastValueManual |
string | The manually entered forecast value, if any | ||
statusClassValueCalculatedId |
UUID | The ID of the calculated status classification value | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
statusClassValueId |
UUID | The ID of the manually selected status classification value | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
trendClassValueCalculatedId |
UUID | The ID of the calculated trend classification value | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
trendClassValueId |
UUID | The ID of the manually selected trend classification value | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
PM.MovePattern
This is a structure data contract.
A set of linear functions describing the movement of any gantt object in relation to the movement of another gantt object
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
milestoneId |
UUID | The ID of the milestone whose movement is described | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
defaultMove |
PF.LinearFunction | The movement that applies for values that are lower than the minX of the first segment | non-null (The value is required.) |
|
segments |
array of MovePatternSegment | The different movements that apply from minX to the next higher minX | non-null;non-null (The array is required. Each element must not be null.) |
PM.MovePatternSegment
This is a structure data contract.
A linear function describing the movement of any gantt object in relation to the movement of another gantt object within a certain boundary
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
a |
double | ✔️ | The first constant | |
b |
double | ✔️ | The second constant | |
minX |
double | The lower limit of validity |
PM.PortfolioSimulation
This is a structure data contract.
A generic object that is used by the client to store its own structured data objects like project portfolio scenario simulation data
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (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.) |
PM.PositionProposal
This is a structure data contract.
A proposal for a new position of a project milestone
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
milestoneId |
UUID | The ID of the milestone whose position is proposed | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
proposedPosition |
date | The proposed position | non-null (The value is required.) |
PM.ProgressCorrection
This is a structure data contract.
The progress correction of a project work item on one day: the latest correction written for that day, plus the earlier ones it overrode
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
remainingEffort |
duration | ✔️ | The remaining effort that resulted from the correction | |
remainingEffortSpecified |
duration | ✔️ | The remaining effort that was originally specified, if any | |
progressSpecified |
int? | ✔️ | The progress in percent that was specified, if any | 100 >= x >= 0 (The value, if present, must be between 0 and 100, both inclusive.) |
remark |
string | ✔️ | A remark that describes how the progress or remaining effort was estimated | |
modifiedAt |
datetime | ✔️ | When the correction was written | non-null (The value is required.) |
modifiedBy |
PF.Reference | ✔️ | Who wrote the correction | |
day |
date | The day on which the progress was measured | non-null (The value is required.) |
|
overridden |
array of ProgressCorrectionRevision | The earlier corrections of the same day, overridden by this one |
PM.ProgressCorrectionChange
This is a structure data contract.
A progress correction to write: either the remaining effort or the progress in percent, never both
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
remainingEffort |
duration | The remaining effort; omit if progress is given | ||
progress |
int? | The progress in percent; omit if remainingEffort is given. Requires includesTimeBased | 100 >= x >= 0 (The value, if present, must be between 0 and 100, both inclusive.) |
|
remark |
string | A remark that describes how the progress or remaining effort was estimated |
PM.ProgressCorrectionHistory
This is a structure data contract.
The progress correction history of a project work item, one element per day
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
ref |
PF.Reference | The project work item | non-null (The value is required.) |
|
timeline |
array of ProgressCorrection | The corrections, ordered by day |
PM.ProgressCorrectionRevision
This is a structure data contract.
One progress correction written for a project work item
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
remainingEffort |
duration | The remaining effort that resulted from the correction | ||
remainingEffortSpecified |
duration | The remaining effort that was originally specified, if any | ||
progressSpecified |
int? | The progress in percent that was specified, if any | 100 >= x >= 0 (The value, if present, must be between 0 and 100, both inclusive.) |
|
remark |
string | A remark that describes how the progress or remaining effort was estimated | ||
modifiedAt |
datetime | When the correction was written | non-null (The value is required.) |
|
modifiedBy |
PF.Reference | Who wrote the correction |
PM.Project
This is a structure data contract.
Describes a project
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (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.) |
PM.ProjectDependency
This is a structure data contract.
A dependency between two milestones, each one either a project portfolio milestone or a project milestone (a real milestone, or a task's start or end)
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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 | |
predecessor |
PF.Reference | The milestone where the dependency starts; it cannot be changed once the dependency exists | non-null (The value is required.) |
|
successor |
PF.Reference | The milestone where the dependency ends; it cannot be changed once the dependency exists | non-null (The value is required.) |
|
minDistance |
int? | The minimal number of days between the two milestones (may be null, if not defined) | ||
maxDistance |
int? | The maximal number of days between the two milestones (may be null, if not defined) |
PM.ProjectIndicatorDetail
This is a structure data contract.
A project's selection of one indicator, with the target value it sets for it
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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 | |
indicatorDetailId |
UUID | The tenant-wide indicator definition that is selected | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
targetValue |
string | The target value that should be reached | ||
showValues |
boolean | Specifies whether to show values (quantitative) or only show classifications (qualitative) | ||
projectSpecificName |
string | Contains a name that is specific to the project (i.e. the linked milestone name) | ||
remark |
string | An additional hint for the user that has to estimate the indicator |
PM.ProjectIndicatorDimension
This is a structure data contract.
A project's selection of one indicator dimension, with the guidelines it sets for it
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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 | |
indicatorDimensionId |
UUID | The tenant-wide dimension definition that is selected | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
showValues |
boolean | Defines whether to show values (totals, ...) | ||
showRiskEstimation |
boolean | Defines whether to show risk estimation or not | ||
leading |
boolean | true, if this is the leading dimension | ||
reportExport |
boolean | true, if the dimension is present in the report export | ||
remark |
string | A remark containing some hints for the user that has to estimate the indicators |
PM.ProjectManagementMethodology
This is a structure data contract.
Describes a project management method in the user's language
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
PM.ProjectManagementMethodologyPhase
This is a structure data contract.
Describes a phase of a project management methodology in the user's language
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
sortIndex |
double | An index value that indicates the correct order (higher after lower) |
PM.ProjectManagementMethodologyPhaseLifecycleAssignment
This is a structure data contract.
Describes an assignment between a lifecycle state and a phase of a project management methodology
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
phaseId |
UUID | The ID of the project management methodology phase | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
lifecycleSubStateId |
UUID | The ID of a mapped lifecycle sub-state | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
priority |
double | describes the priority of the assignment, if multiple assignments exist for the same lifecycle substate (lower number means higher priority) |
PM.ProjectManagementMethodologyPhaseTimeline
This is a structure data contract.
Describes a phase with its planned and effective finish related to a project
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
phase |
PF.Reference | A reference to the corresponding phase | ||
plannedFinish |
date | The date on which the phase is planned to be finished (may be null, if not planned) | ||
finished |
datetime | The effective point in time when the phase has been finished (may be null, if not yet finished) |
PM.ProjectManagementMethodologyPhaseTranslated
This is a structure data contract.
Describes a phase of a project management methodology in different languages
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | null;non-null (The array is optional. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | null;non-null (The array is optional. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
null;non-null (The array is optional. Each element must not be null.) |
sortIndex |
double | An index value that indicates the correct order (higher after lower) |
PM.ProjectManagementMethodologyTimeline
This is a structure data contract.
Describes a project management methodology with time information in relation to a project
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
methodology |
PF.Reference | The methodology that is followed by the project according to its lifecycle history (may be null) | ||
plannedStart |
date | The date when the first phase is planned to be started (may be null, if not yet planned) | ||
started |
datetime | The point in time when the first phase has been started (may be null, if no methodology selected) | ||
phases |
array of ProjectManagementMethodologyPhaseTimeline | The phases of the referenced methodology (may be null, if no methodology selected) | ||
currentPhaseId |
UUID | The ID of the phase the project is in (one of the phases, may be null, if no methodology selected or last phase completed) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
PM.ProjectManagementMethodologyTranslated
This is a structure data contract.
Describes a project management methodology in different languages
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | null;non-null (The array is optional. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | null;non-null (The array is optional. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
null;non-null (The array is optional. Each element must not be null.) |
PM.ProjectMilestone
This is a structure data contract.
A projectmilestone which may be the position of a real milestone or the position of a task's start or end
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
workItemId |
UUID | the parent work item | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
position |
date | The position in the timeline of the milestone | non-null (The value is required.) |
|
fixed |
boolean | if true, the milestone's position cannot be modified |
PM.ProjectMilestoneConstraint
This is a structure data contract.
A constraint between two milestones of the same project scenario, each one a real milestone or a task's start or end
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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 | |
constraintType |
ExplicitProjectConstraintType | How the constraint came about; the server sets it and a write leaves it as it is | ||
predecessorMilestoneId |
UUID | The milestone where the constraint starts; it cannot be changed once the constraint exists | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
successorMilestoneId |
UUID | The milestone where the constraint ends; it cannot be changed once the constraint exists | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
minDistance |
int? | The minimal number of days between the two milestones (may be null, if not defined) | ||
maxDistance |
int? | The maximal number of days between the two milestones (may be null, if not defined) |
PM.ProjectMilestoneConstraintReference
This is a structure data contract.
A reference to a constraint between two project milestones, together with the two milestones it connects
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
predecessorMilestoneId |
UUID | The milestone where the constraint starts | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
successorMilestoneId |
UUID | The milestone where the constraint ends | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
PM.ProjectPortfolio
This is a structure data contract.
Contains information about a project portfolio
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (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.) |
PM.ProjectPortfolioMilestone
This is a structure data contract.
A project portfolio milestone that may be referenced by the portfolio's projects
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (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.) |
projectPortfolioId |
UUID | A reference to the project portfolio the milestone belongs to | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
position |
date | The position of the milestone on the time axis | non-null (The value is required.) |
PM.ProjectPortfolioReport
This is a structure data contract.
A project portfolio report
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (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.) |
projectPortfolioId |
UUID | A reference to the project portfolio | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
periodStart |
date | Start (inclusive) of the reporting period | ||
periodEnd |
date | End (exclusive) of the reporting period |
PM.ProjectPortfolioReportType
This is a structure data contract.
A project portfolio report type
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
interval |
ReportInterval | The schedule for the report, optional | ||
autoCreate |
boolean | Flag that indicates whether a report will be created automatically | ||
sortIndex |
double | The sortIndex (lowest first) | ||
hasValidity |
boolean | Flag that indicates whether a report has validity date range |
PM.ProjectPortfolioReportTypeTranslated
This is a structure data contract.
A project portfolio report type with translations
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
interval |
ReportInterval | The schedule for the report, optional | ||
autoCreate |
boolean | Flag that indicates whether a report will be created automatically | ||
sortIndex |
double | The sortIndex (lowest first) | ||
hasValidity |
boolean | Flag that indicates whether a report has validity date range |
PM.ProjectReport
This is a structure data contract.
A project report
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (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.) |
projectId |
UUID | The project this report belongs to (read-only) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
periodStart |
date | Start (inclusive) of the reporting period | ||
periodEnd |
date | End (exclusive) of the reporting period | ||
indicators |
IndicatorCollection | The indicators, if any | non-null (The value is required.) |
|
currencyId |
UUID | The currency in which the report was calculated | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
PM.ProjectReportIndicatorDetail
This is a structure data contract.
A single indicator on a project report: the target/actual comparison for one measurable indicator
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
indicatorDetailId |
UUID | The tenant-wide indicator definition this measures, which carries its name and how it is computed | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectIndicatorDetailId |
UUID | The project's selection of that indicator, which carries the target the project set | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
showValues |
boolean | Specifies whether to show values (quantitative) or only classifications (qualitative) | ||
targetValue |
string | The target value the project set for this indicator, converted to the report's currency and point in time | ||
plannedValueCalculated |
string | The calculated planned value, if any | ||
plannedValueManual |
string | The manually entered planned value, if any | ||
actualValueCalculated |
string | The calculated actual value, if any | ||
actualValueManual |
string | The manually entered actual value, if any | ||
supplementaryValueCalculated |
string | The calculated supplementary value, if any | ||
supplementaryValueManual |
string | The manually entered supplementary value, if any | ||
remainingValueCalculated |
string | The calculated remaining value, if any | ||
remainingValueManual |
string | The manually entered remaining value, if any | ||
forecastValueCalculated |
string | The calculated forecast value, if any | ||
forecastValueManual |
string | The manually entered forecast value, if any | ||
statusClassValueCalculatedId |
UUID | The ID of the calculated status classification value | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
statusClassValueId |
UUID | The ID of the manually selected status classification value | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
trendClassValueCalculatedId |
UUID | The ID of the calculated trend classification value | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
trendClassValueId |
UUID | The ID of the manually selected trend classification value | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
remark |
string | A remark describing the values |
PM.ProjectReportIndicatorDimension
This is a structure data contract.
A group of indicators forming one dimension of a project report (i.e. costs, timeline, ...), with their aggregated target/actual comparison
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
indicatorDimensionId |
UUID | The tenant-wide dimension definition this belongs to, which carries its name | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectIndicatorDimensionId |
UUID | The project's selection of that dimension, which carries the guidelines the project set | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
showValues |
boolean | Defines whether to show values (totals, ...) | ||
leading |
boolean | true, if this is the leading dimension of the report | ||
reportExport |
boolean | true, if the dimension is present in the report export | ||
indicators |
array of ProjectReportIndicatorDetail | The indicators that belong to the dimension (sorted) | null;non-null (The array is optional. Each element must not be null.) |
|
total |
IndicatorTotal | The calculated total of all indicators | ||
targetTotal |
string | The total of all target values | ||
riskEstimation |
IndicatorRiskEstimation | The manual estimation of all the risks belonging to the dimension |
PM.ProjectReportType
This is a structure data contract.
A project report type
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
interval |
ReportInterval | The schedule for the report, optional | ||
autoCreate |
boolean | Flag that indicates whether a report will be created automatically | ||
sortIndex |
double | The sortIndex (lowest first) | ||
hasValidity |
boolean | Flag that indicates whether a report has validity date range | ||
canRefresh |
boolean | Flag that indicates whether a report should have a refresh button | ||
jsDataSourceId |
UUID | Contains the ID of the JavaScript source to be used as data collector for custom JavaScript indicators | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
PM.ProjectReportTypeTranslated
This is a structure data contract.
A project report type with translations
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
length > 0;non-null (The array, if present, must contain at least one element. Each element must not be null.) |
interval |
ReportInterval | The schedule for the report, optional | ||
autoCreate |
boolean | Flag that indicates whether a report will be created automatically | ||
sortIndex |
double | The sortIndex (lowest first) | ||
hasValidity |
boolean | Flag that indicates whether a report has validity date range | ||
canRefresh |
boolean | Flag that indicates whether a report should have a refresh button | ||
jsDataSourceId |
UUID | Contains the ID of the JavaScript source to be used as data collector for custom JavaScript indicators | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
PM.ProjectScenario
This is a structure data contract.
Describes a project scenario
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (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.) |
projectId |
UUID | A reference to the project | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
PM.ProjectWorkItem
This is a structure data contract.
Describes a project work item (phase / milestone / folder)
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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 | ||
colorId |
UUID | An ID pointing to a client's enum containing the color | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
iconRef |
URI | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
|
properties |
array of PF.Property | A collection of dynamic properties belonging to the object | null;non-null (The array is optional. Each element must not be null.) |
|
workItemType |
ProjectWorkItemType | The kind of work item | ||
projectId |
UUID | A reference to the project | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectScenarioId |
UUID | A reference to the scenario | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
startMilestoneId |
UUID | The ID of the starting point (may also be equal to endMilestoneId or null) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
endMilestoneId |
UUID | The ID of the end point (may also be equal to startMilestoneId or null) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
sortIndex |
double? | index for sorting siblings | ||
timeBudget |
duration | top-down planning | ||
costsBudget |
PF.CurrencyAmount | top-down planning | ||
plannedEffort |
duration | bottom-up planning | ||
fixed |
boolean | if true, start and end cannot be modified | ||
owner |
PF.Reference | a resource | ||
requiredSkill |
PF.Reference | a resource (skill) | ||
manualProgressOverride |
double? | Manual "calculated accumulated progress" override (0-100), null if not overridden | 100 >= x >= 0 (The value, if present, must be between 0 and 100, both inclusive.) |
|
projectManagementMethodologyPhaseId |
UUID | Contains a reference to a project management method's phase | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
PM.ProjectWorkItemLog
This is a structure data contract.
A log entry attached to a project work item
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
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/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
projectWorkItemId |
UUID | A reference to the project work item the log belongs to; it cannot be changed once the log exists | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
projectScenarioId |
UUID | A reference to the project scenario the log's work item lives in; read-only, it follows the work item | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
PM.ProjectWorkItemReference
This is a structure data contract.
A reference to a project work item, together with its parent and its start / end milestones
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
parent |
PF.Reference | ✔️ | A reference to a parent (if any) | |
startMilestoneId |
UUID | The ID of the starting point (may also be equal to endMilestoneId or null) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
endMilestoneId |
UUID | The ID of the end point (may also be equal to startMilestoneId or null) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
PM.ProjectWorkItemShiftPattern
This is a structure data contract.
The pattern of one single resource shift within the shift plan of a project work item
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
shiftId |
UUID | The resource shift the pattern plans | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
pattern |
array of boolean | One flag per day, the first one for the day the project work item starts, telling whether the shift is planned on that day | non-null (The value is required.) |
PM.ProjectWorkItemShiftPlan
This is a structure data contract.
The shift plan of a project work item: the pattern of days, counted from the work item's start, a resource is to be reserved on, one pattern per resource shift
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
shifts |
array of ProjectWorkItemShiftPattern | One pattern per resource shift the plan covers, all of them of the same length | non-null (The value is required.) |
PM.ProjectWorkItemType
This is an enumeration data contract.
Describes the kind of phase of a project plan
Enum values
| ID | Description |
|---|---|
PortfolioMilestone |
The object is a milestone from a portfolio |
PortfolioMilestoneFolder |
The object is a folder for portfolio milestones |
ProjectFolder |
The object is a folder for project milestones and phases |
ProjectMilestone |
The object is a project milestone |
ProjectPhase |
The object is a project phase |
PM.ReportInterval
This is a structure data contract.
The schedule / interval for a project report
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
unit |
ReportIntervalUnit | The time interval unit (Days, Weeks, Months, Years) a report must be created | ||
amount |
int | The amount of units that build the interval | n >= 1 (The value must be at least 1.) |
|
offset |
int | The offset in days for the interval | n >= 0 (The value must be at least 0.) |
PM.ReportIntervalUnit
This is an enumeration data contract.
The different units that may apply to a project report's interval
Enum values
| ID | Description |
|---|---|
Days |
Days |
Weeks |
Weeks |
Months |
Months |
Years |
Years |