JavaScript API Documentation

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "nameForward": "Owners",
  "nameBackward": "Own projects",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "explicit": "true",
  "sourceTypes": [
    "text 1",
    "text 2"
  ],
  "targetTypes": [
    "text 1",
    "text 2"
  ],
  "sourcesUrl": "/API/V2/RES/ResourceKind/Person/All",
  "targetsUrl": "/API/V2/PM/Projects",
  "sortIndexForward": 11.5,
  "sortIndexBackward": 11.5
 },...
]

Pqf.pf.getAllRelationTypesForType(objectType)

Returns all relation types of relations that may start or end on a given type of object

• {objectType} : The type of objects

Send : None

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "nameForward": "Owners",
  "nameBackward": "Own projects",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "explicit": "true",
  "sourceTypes": [
    "text 1",
    "text 2"
  ],
  "targetTypes": [
    "text 1",
    "text 2"
  ],
  "sourcesUrl": "/API/V2/RES/ResourceKind/Person/All",
  "targetsUrl": "/API/V2/PM/Projects",
  "sortIndexForward": 11.5,
  "sortIndexBackward": 11.5
 },...
]

Pqf.pf.getForwardRelationTypesForType(objectType)

Returns all relation types of relations that may start on a given type of object

• {objectType} : The type of objects

Send : None

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "nameForward": "Owners",
  "nameBackward": "Own projects",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "explicit": "true",
  "sourceTypes": [
    "text 1",
    "text 2"
  ],
  "targetTypes": [
    "text 1",
    "text 2"
  ],
  "sourcesUrl": "/API/V2/RES/ResourceKind/Person/All",
  "targetsUrl": "/API/V2/PM/Projects",
  "sortIndexForward": 11.5,
  "sortIndexBackward": 11.5
 },...
]

Pqf.pf.getBackwardRelationTypesForType(objectType)

Returns all relation types of relations that may end on a given type of object

• {objectType} : The type of objects

Send : None

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "nameForward": "Owners",
  "nameBackward": "Own projects",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "explicit": "true",
  "sourceTypes": [
    "text 1",
    "text 2"
  ],
  "targetTypes": [
    "text 1",
    "text 2"
  ],
  "sourcesUrl": "/API/V2/RES/ResourceKind/Person/All",
  "targetsUrl": "/API/V2/PM/Projects",
  "sortIndexForward": 11.5,
  "sortIndexBackward": 11.5
 },...
]

Pqf.pf.getAllRelations(objectType, objectId, desttype, destid, type, includeimplicit)

Returns all relations that start or end on a given object

• {objectType} : The type of objects

• {objectId} : The ID of the objects

• {desttype}? : Filter by source or target object type

• {destid}? : Filter by source or target object ID

• {type}? : Filter by relation type

• {includeimplicit}? : Include also implicit relations

Send : None

Receive : Relation[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "relationType": "4511728B45CE4E3E963F6B6CE5090883",
  "explicit": "true",
  "name": "Owner of project",
  "source": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "target": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  }
 },...
]

Pqf.pf.getForwardRelations(sourceType, sourceId, targettype, targetid, type, includeimplicit)

Returns all relations that start on a given object

• {sourceType} : The type of objects

• {sourceId} : The ID of the objects

• {targettype}? : Filter by target object type

• {targetid}? : Filter by target object ID

• {type}? : Filter by relation type

• {includeimplicit}? : Include also implicit relations

Send : None

Receive : Relation[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "relationType": "4511728B45CE4E3E963F6B6CE5090883",
  "explicit": "true",
  "name": "Owner of project",
  "source": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "target": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  }
 },...
]

Pqf.pf.getBackwardRelations(targetType, targetId, sourcetype, sourceid, type, includeimplicit)

Returns all relations that end on a given object

• {targetType} : The type of objects

• {targetId} : The ID of the objects

• {sourcetype}? : Filter by source object type

• {sourceid}? : Filter by source object ID

• {type}? : Filter by relation type

• {includeimplicit}? : Include also implicit relations

Send : None

Receive : Relation[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "relationType": "4511728B45CE4E3E963F6B6CE5090883",
  "explicit": "true",
  "name": "Owner of project",
  "source": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "target": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  }
 },...
]

Pqf.pf.getCurrentUserAllRelations(desttype, destid, type, includeimplicit)

Returns all relations that start or end on the current user's resource

• {desttype}? : Filter by source or target object type

• {destid}? : Filter by source or target object ID

• {type}? : Filter by relation type

• {includeimplicit}? : Include also implicit relations

Send : None

Receive : Relation[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "relationType": "4511728B45CE4E3E963F6B6CE5090883",
  "explicit": "true",
  "name": "Owner of project",
  "source": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "target": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  }
 },...
]

Pqf.pf.getCurrentUserForwardRelations(targettype, targetid, type, includeimplicit)

Returns all relations that start on the current user's resource

• {targettype}? : Filter by target object type

• {targetid}? : Filter by target object ID

• {type}? : Filter by relation type

• {includeimplicit}? : Include also implicit relations

Send : None

Receive : Relation[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "relationType": "4511728B45CE4E3E963F6B6CE5090883",
  "explicit": "true",
  "name": "Owner of project",
  "source": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "target": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  }
 },...
]

Pqf.pf.getCurrentUserBackwardRelations(sourcetype, sourceid, type, includeimplicit)

Returns all relations that end on the current user's resource

• {sourcetype}? : Filter by source object type

• {sourceid}? : Filter by source object ID

• {type}? : Filter by relation type

• {includeimplicit}? : Include also implicit relations

Send : None

Receive : Relation[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "relationType": "4511728B45CE4E3E963F6B6CE5090883",
  "explicit": "true",
  "name": "Owner of project",
  "source": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "target": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  }
 },...
]

Pqf.pf.getUndeleteLimit()

Returns the amount of time an object stays in the waste bin for undeletion

Send : None

Receive : UndeleteLimit

{
  "days": 11
}

Pqf.pf.getUniqueReadableCodeDefs()

Returns all unique readable code definitions

Send : None

Receive : UniqueReadableCodeDef[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "pattern": "P-(\\d+)",
  "readOnly": "true"
 },...
]

Pqf.pf.getUniqueReadableCodeDef(typeId)

Returns a unique readable code definition

• {typeId} : The type of the object

Send : None

Receive : UniqueReadableCodeDef

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "pattern": "P-(\\d+)",
  "readOnly": "true"
}

Pqf.pf.putUniqueReadableCodeDef(typeId, obj)

Sets a unique readable code definition

• {typeId} : The type of the object

Send : UniqueReadableCodeDef

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "pattern": "P-(\\d+)",
  "readOnly": "true"
}

Reiceive : None

Pqf.pf.delUniqueReadableCodeDef(typeId)

Deletes a unique readable code definition

• {typeId} : The type of the object

Send : None

Receive : None

Pqf.pf.convertUnit(systemId, source, dest, value)

Converts a value into a specific unit

• {systemId} : The type of unit

• {source}? : The sourceunit identifier

• {dest}? : The sourceunit identifier

• {value}? : The value

Send : None

Receive : ValueWithUnit

{
  "value": 11.5,
  "unit": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "abbr": "h",
    "name": "Stunden"
  }
}

Pqf.pf.getUnit(systemId, unitId)

Returns a specific unit

• {systemId} : The type of unit

• {unitId} : The unit identifier

Send : None

Receive : Unit

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "abbr": "h",
  "name": "Stunden"
}

Pqf.pf.getUnits(systemId)

Returns all units of a unit system

• {systemId} : The type of unit

Send : None

Receive : Unit[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "abbr": "h",
  "name": "Stunden"
 },...
]

Pqf.pf.getUnitsFactors(systemId, ref)

Returns the factors that apply to all units of a unit system

• {systemId} : The type of unit

• {ref}? : The reference unit (optional)

Send : None

Receive : UnitFactor[ ]

[
 {
  "unit": "H",
  "factor": "⅐"
 },...
]

Pqf.pf.putUnitsFactors(systemId, obj)

Manipulates the factors of a unit system

• {systemId} : The type of unit

Send : UnitFactor[ ]

[
 {
  "unit": "H",
  "factor": "⅐"
 },...
]

Reiceive : None

Pqf.pf.getUnitsPreference(systemId)

Returns the preference of unit in a unit system

• {systemId} : The type of unit

Send : None

Receive : UnitPreference

{
  "preferredUnits": "H"
}

Pqf.pf.putUnitsPreference(systemId, obj)

Manipulates the preference of unit in a unit system

• {systemId} : The type of unit

Send : UnitPreference

{
  "preferredUnits": "H"
}

Reiceive : None

Pqf.pi.getProjectItemTypes()

Returns all available project item type descriptions

Send : None

Receive : ProjectItemType[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Todo",
  "description": "A TODO is a kind of task that has to be completed by a resource",
  "iconRef": "/images/projectitems/todo.svg",
  "color": "blue",
  "markerEnumType": "ENUM_TODO_MARKER"
 },...
]

Pqf.pi.getProjectItemType(type)

Returns a specific project item type description

• {type} : The ID of the item type

Send : None

Receive : ProjectItemType

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Todo",
  "description": "A TODO is a kind of task that has to be completed by a resource",
  "iconRef": "/images/projectitems/todo.svg",
  "color": "blue",
  "markerEnumType": "ENUM_TODO_MARKER"
}

Pqf.pi.getProjectItems(type, state, lateststatechange)

Returns all project items of a specific project item type

• {type} : The ID of the item type

• {state}? : A status list to filter (optional)

• {lateststatechange}? : A point in time to filter out items that have been in a state for a longer time (optional)

Send : None

Receive : ProjectItem[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "state": {
    "subState": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  },
  "sortIndex": 11.5,
  "color": "CAFD7DE2D0C140B2A9F8746633E67A2E",
  "marker": "ACD3558FCBBA4376A2BFA8D124450463",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.pi.getProjectItem(type, itemId)

Returns a project item

• {type} : The ID of the item type

• {itemId} : The ID of the item

Send : None

Receive : ProjectItem

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "state": {
    "subState": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  },
  "sortIndex": 11.5,
  "color": "CAFD7DE2D0C140B2A9F8746633E67A2E",
  "marker": "ACD3558FCBBA4376A2BFA8D124450463",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.pi.putProjectItem(type, itemId, obj)

Stores a project item

• {type} : The ID of the item type

• {itemId} : The ID of the item

Send : ProjectItem

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "state": {
    "subState": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  },
  "sortIndex": 11.5,
  "color": "CAFD7DE2D0C140B2A9F8746633E67A2E",
  "marker": "ACD3558FCBBA4376A2BFA8D124450463",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Reiceive : None

Pqf.pi.delProjectItem(type, itemId)

Deletes a project item

• {type} : The ID of the item type

• {itemId} : The ID of the item

Send : None

Receive : None

Pqf.pi.addProjectItem(type, copy, name, description, adddocs, addrelations, addbwdrelations)

Adds a new project item

• {type} : The ID of the item type

• {copy}? : The ID of any item to clone

• {name}? : The name of the new item

• {description}? : The description of the new item

• {adddocs}? : Link documents from cloned item or template

• {addrelations}? : Add relations from cloned item or template

• {addbwdrelations}? : Add backward pointing relations to cloned item or template

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pi.getProjectItemsByRef(type, reltype, reftype, refid, state, lateststatechange)

Returns all project items of a specific project item type

• {type} : The ID of the item type

• {reltype} : The type of relation

• {reftype} : The type of the referenced object

• {refid} : The type of the referenced item

• {state}? : A status list to filter (optional)

• {lateststatechange}? : A point in time to filter out items that have been in a state for a longer time (optional)

Send : None

Receive : ProjectItem[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "state": {
    "subState": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  },
  "sortIndex": 11.5,
  "color": "CAFD7DE2D0C140B2A9F8746633E67A2E",
  "marker": "ACD3558FCBBA4376A2BFA8D124450463",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.pi.getProjectItemSummariesByRef(type, reltype, reftype, refid, state, lateststatechange)

Returns all project items of a specific project item type

• {type} : The ID of the item type

• {reltype} : The type of relation

• {reftype} : The type of the referenced object

• {refid} : The type of the referenced item

• {state}? : A status list to filter (optional)

• {lateststatechange}? : A point in time to filter out items that have been in a state for a longer time (optional)

Send : None

Receive : ProjectItemSummary[ ]

[
 {
  "relations": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "relationType": "4511728B45CE4E3E963F6B6CE5090883",
      "explicit": "true",
      "name": "Owner of project",
      "source": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
      },
      "target": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
      }
    }
  ],
  "lifecycleHistory": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "version": "DF23BAFE32A042A3915790B0878DA8EE",
      "state": {
        "subState": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        }
      },
      "transition": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11",
        "properties": [
          {
            "key": "prj-type",
            "value": "PRJ-TYPE-DEV"
          }
        ],
        "from": {
          "subState": null
        },
        "to": {
          "subState": null
        }
      },
      "timestamp": "2020-03-11T10:25:01:13Z",
      "initiatedBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11",
        "isDeleted": "true"
      },
      "remark": "All planning is done and verified"
    }
  ],
  "possibleLifecycleTransitions": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11",
      "properties": [
        {
          "key": "prj-type",
          "value": "PRJ-TYPE-DEV"
        }
      ],
      "from": {
        "subState": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        }
      },
      "to": {
        "subState": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        }
      }
    }
  ]
 },...
]

Pqf.pi.addProjectItemByRef(type, reltype, reftype, refid, copy, name, description, forward, adddocs, addrelations, addbwdrelations)

Adds a new project item linked to a specific object

• {type} : The ID of the item type

• {reltype} : The type of relation

• {reftype} : The type of the referenced object

• {refid} : The type of the referenced item

• {copy}? : The ID of any item to clone

• {name}? : The name of the new item

• {description}? : The description of the new item

• {forward}? : Specifies the direction of the relation (necessary if ambiguous)

• {adddocs}? : Link documents from cloned item or template

• {addrelations}? : Add relations from cloned item or template

• {addbwdrelations}? : Add backward pointing relations to cloned item or template

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.copyWorkItemTree(workItemId, targetId, sortIndex, includeLogs, includeDocumentLinks, includeShiftPlans, includeDependencies, includeAllocations, includePlannedCosts, includeTodoLinks, includeTodos)

Copies a work item and attaches it to another or the same parent task

• {workItemId} : The work item's ID

• {targetId}? : The new parent task (or the same if omitted)

• {sortIndex}? : The new position index (stays the same, if omitted)

• {includeLogs}? : Copy logs

• {includeDocumentLinks}? : Copy document links

• {includeShiftPlans}? : Copy shift plans

• {includeDependencies}? : Copy dependencies

• {includeAllocations}? : Copy allocations

• {includePlannedCosts}? : Copy planned costs

• {includeTodoLinks}? : Copy todo links

• {includeTodos}? : Copy todos

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.getMacroAllocation(macroAllocationId, currency, version)

Returns a macro allocation with given ID

• {macroAllocationId} : The macro allocation's ID

• {currency}? : The currency for costs conversion

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : ResourceAllocation

Pqf.pm.putMacroAllocation(macroAllocationId, obj)

Updates a macro allocation with given ID

• {macroAllocationId} : The macro allocation's ID

Send : ResourceAllocation

Reiceive : None

Pqf.pm.delMacroAllocation(macroAllocationId)

Deletes a macro allocation with given ID

• {macroAllocationId} : The macro allocation's ID

Send : None

Receive : None

Pqf.pm.moveWorkItem(workItemId, to, strategy, resourceid)

Moves a work item in the timeline

• {workItemId} : The work item's ID

• {to}? : The day where the work item should start

• {strategy}? : Describes how other work items react to the movement

• {resourceid}? : The resource ID for workdays

Send : None

Receive : None

Pqf.pm.moveWorkItemEnd(workItemId, to, strategy, resourceid)

Moves a work item end in the timeline

• {workItemId} : The work item's ID

• {to}? : The day where the work item should end

• {strategy}? : Describes how other work items react to the movement

• {resourceid}? : The resource ID for workdays

Send : None

Receive : None

Pqf.pm.proposeWorkItemEnd(workItemId, maxmove, fewerWorkWeight)

Proposes movement of work item end in the timeline

• {workItemId} : The work item's ID

• {maxmove}? : Defines the maximal delta in days for the proposed movement

• {fewerWorkWeight}? : The factor to weight slots with fewer workload in deviation from optimum calculation

Send : None

Receive : PositionProposal

{
  "objectId": "F9CEE4C267F242B790349B4BF0D37AC3",
  "proposedPosition": "2020-03-11"
}

Pqf.pm.moveWorkItemStart(workItemId, to, strategy, resourceid)

Moves a work item start in the timeline

• {workItemId} : The work item's ID

• {to}? : The day where the work item should start

• {strategy}? : Describes how other work items react to the movement

• {resourceid}? : The resource ID for workdays

Send : None

Receive : None

Pqf.pm.proposeWorkItemStart(workItemId, maxmove, fewerWorkWeight)

Proposes movement of work item start in the timeline

• {workItemId} : The work item's ID

• {maxmove}? : Defines the maximal delta in days for the proposed movement

• {fewerWorkWeight}? : The factor to weight slots with fewer workload in deviation from optimum calculation

Send : None

Receive : PositionProposal

{
  "objectId": "F9CEE4C267F242B790349B4BF0D37AC3",
  "proposedPosition": "2020-03-11"
}

Pqf.pm.getMovePatternByWorkItem(workItemId, strategy, resourceid)

Calculates how other work items behave in reaction to a movement of a given work item

• {workItemId} : The work item's ID

• {strategy}? : Describes how other work items react to the movement

• {resourceid}? : The resource ID for workdays

Send : None

Receive : MovePattern[ ]

[
 {
  "objectId": "F9CEE4C267F242B790349B4BF0D37AC3",
  "defaultMove": {
    "a": 11.5,
    "b": 11.5
  },
  "segments": [
    {
      "a": 11.5,
      "b": 11.5,
      "minX": 11.5
    }
  ]
 },...
]

Pqf.pm.getMovePatternByWorkItemEnd(workItemId, strategy, resourceid)

Calculates how other work items behave in reaction to a movement of a given work item' end

• {workItemId} : The work item's ID

• {strategy}? : Describes how other work items react to the movement

• {resourceid}? : The resource ID for workdays

Send : None

Receive : MovePattern[ ]

[
 {
  "objectId": "F9CEE4C267F242B790349B4BF0D37AC3",
  "defaultMove": {
    "a": 11.5,
    "b": 11.5
  },
  "segments": [
    {
      "a": 11.5,
      "b": 11.5,
      "minX": 11.5
    }
  ]
 },...
]

Pqf.pm.getMovePatternByWorkItemStart(workItemId, strategy, resourceid)

Calculates how other work items behave in reaction to a movement of a given work item's start

• {workItemId} : The work item's ID

• {strategy}? : Describes how other work items react to the movement

• {resourceid}? : The resource ID for workdays

Send : None

Receive : MovePattern[ ]

[
 {
  "objectId": "F9CEE4C267F242B790349B4BF0D37AC3",
  "defaultMove": {
    "a": 11.5,
    "b": 11.5
  },
  "segments": [
    {
      "a": 11.5,
      "b": 11.5,
      "minX": 11.5
    }
  ]
 },...
]

Pqf.pm.getPmMethods()

Returns all available project management methods

Send : None

Receive : ProjectManagementMethod[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
 },...
]

Pqf.pm.getPmMethod(methodId)

Returns a project management method

• {methodId} : The ID of the project management method

Send : None

Receive : ProjectManagementMethod

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
}

Pqf.pm.getPmMethodTranslated(methodId)

Returns a project management method

• {methodId} : The ID of the project management method

Send : None

Receive : ProjectManagementMethodTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJ-X",
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
}

Pqf.pm.putPmMethodTranslated(methodId, obj)

Writes a project management method

• {methodId} : The ID of the project management method

Send : ProjectManagementMethodTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJ-X",
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
}

Reiceive : None

Pqf.pm.delPmMethodTranslated(methodId)

Deletes a project management method

• {methodId} : The ID of the project management method

Send : None

Receive : None

Pqf.pm.getPmMethodPhases(methodId)

Returns all available phases of a project management method

• {methodId} : The ID of the project management method

Send : None

Receive : ProjectManagementMethodPhase[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "sortIndex": 11.5
 },...
]

Pqf.pm.getPmMethodPhase(methodId, phaseId)

Returns a project management method phase

• {methodId} : The ID of the project management method

• {phaseId} : The ID of the project management method phase

Send : None

Receive : ProjectManagementMethodPhase

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "sortIndex": 11.5
}

Pqf.pm.getPmMethodPhaseTranslated(methodId, phaseId)

Returns a project management method phase

• {methodId} : The ID of the project management method

• {phaseId} : The ID of the project management method phase

Send : None

Receive : ProjectManagementMethodPhaseTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJ-X",
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "sortIndex": 11.5
}

Pqf.pm.putPmMethodPhaseTranslated(methodId, phaseId, obj)

Writes a project management method phase

• {methodId} : The ID of the project management method

• {phaseId} : The ID of the project management method phase

Send : ProjectManagementMethodPhaseTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJ-X",
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "sortIndex": 11.5
}

Reiceive : None

Pqf.pm.delPmMethodPhaseTranslated(methodId, phaseId)

Deletes a project management method phase

• {methodId} : The ID of the project management method

• {phaseId} : The ID of the project management method phase

Send : None

Receive : None

Pqf.pm.getPmMethodPhaseLifecycleAssignment(methodId)

Returns the lifecycle states for all phases of a given project management method

• {methodId} : The ID of the project management method

Send : None

Receive : ProjectManagementMethodPhaseLifecycleAssignment[ ]

[
 {
  "phaseId": "8907DA7649D14E2D99F6144E74E99314",
  "lifecycleSubStateId": "FB551CD4065941CA93F377ACB3D17194",
  "priority": 11.5
 },...
]

Pqf.pm.getPmMethodsPhaseLifecycleAssignment()

Returns the lifecycle states for all phases of all project management method

Send : None

Receive : ProjectManagementMethodPhaseLifecycleAssignment[ ]

[
 {
  "phaseId": "8907DA7649D14E2D99F6144E74E99314",
  "lifecycleSubStateId": "FB551CD4065941CA93F377ACB3D17194",
  "priority": 11.5
 },...
]

Pqf.pm.putPmMethodsPhaseLifecycleAssignment(obj)

Writes all project management method phase lifecycle assignments

Send : ProjectManagementMethodPhaseLifecycleAssignment[ ]

[
 {
  "phaseId": "8907DA7649D14E2D99F6144E74E99314",
  "lifecycleSubStateId": "FB551CD4065941CA93F377ACB3D17194",
  "priority": 11.5
 },...
]

Reiceive : None

Pqf.pm.getPortfolioScenarios()

Returns all available portfolio scenarios (simulations)

Send : None

Receive : GenericObject[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.pm.addPortfolioScenario()

Adds a new portfolio scenario (simulation)

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.getPortfolioScenario(pfScenarioId)

Returns a specific portfolio scenario

• {pfScenarioId} : The portfolio scenario's ID

Send : None

Receive : GenericObject

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.pm.putPortfolioScenario(pfScenarioId, obj)

Updates a specific portfolio scenario

• {pfScenarioId} : The portfolio scenario's ID

Send : GenericObject

Reiceive : None

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.pm.delPortfolioScenario(pfScenarioId)

Deletes a specific portfolio scenario

• {pfScenarioId} : The portfolio scenario's ID

Send : None

Receive : None

Pqf.pm.getProject(projectId, version)

Returns a project

• {projectId} : The project's ID

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : Project

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "status": "5F9B9831C7704DDFAABF7580129AB8F2",
  "portfolios": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  ],
  "classification": [
    {
      "classificationSchemaId": "291ABC133A554A9F9CC7E5EF7654FDD7",
      "data": [
        {
          "attributeId": "41A649C11AF54F89A87A084E932A3D8D",
          "valueId": "EA2BEA4D58D44AE08D4674399F25E299",
          "description": "As we have realized similar projects in the near past quite a few times, the costs are estimated quite accurate."
        }
      ],
      "classificationId": "41D3A3705A4749038F2154B757ED3577",
      "score": [
        11.2,
        22.3,
        null
      ]
    }
  ]
}

Pqf.pm.putProject(projectId, obj)

Updates or creates a project

• {projectId} : The project's ID

Send : Project

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "status": "5F9B9831C7704DDFAABF7580129AB8F2",
  "portfolios": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  ],
  "classification": [
    {
      "classificationSchemaId": "291ABC133A554A9F9CC7E5EF7654FDD7",
      "data": [
        {
          "attributeId": "41A649C11AF54F89A87A084E932A3D8D",
          "valueId": "EA2BEA4D58D44AE08D4674399F25E299",
          "description": "As we have realized similar projects in the near past quite a few times, the costs are estimated quite accurate."
        }
      ],
      "classificationId": "41D3A3705A4749038F2154B757ED3577",
      "score": [
        11.2,
        22.3,
        null
      ]
    }
  ]
}

Reiceive : None

Pqf.pm.delProject(projectId)

Deletes a project

• {projectId} : The project's ID

Send : None

Receive : None

Pqf.pm.getProjectTimeline(projectId, beg, end, granularity)

Returns a project

• {projectId} : The project's ID

• {beg}? : Begin date of the request

• {end}? : End date of the request

• {granularity}? : The granularity of the request

Send : None

Receive : Timeline

{
  "slots": [
    {
      "at": "2020-03-11T10:25:01:13Z",
      "count": 1111111111
    }
  ]
}

Pqf.pm.moveProject(projectId, fromPortfolio, toPortfolio)

Moves a project from one portfolio to another

• {projectId} : The project's ID

• {fromPortfolio}? : The portfolio ID from which to move (required)

• {toPortfolio}? : The portfolio ID to move to (required)

Send : None

Receive : None

Pqf.pm.linkProject(projectId, portfolio)

Links a project to a portfolio

• {projectId} : The project's ID

• {portfolio}? : The portfolio ID to which the project should be linked (required)

Send : None

Receive : None

Pqf.pm.unlinkProject(projectId, portfolio)

Unlinks a project from a portfolio

• {projectId} : The project's ID

• {portfolio}? : The portfolio ID to which the project should be linked (required)

Send : None

Receive : None

Pqf.pm.getProjects()

Returns all projects

Send : None

Receive : Project[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "status": "5F9B9831C7704DDFAABF7580129AB8F2",
  "portfolios": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  ],
  "classification": [
    {
      "classificationSchemaId": "291ABC133A554A9F9CC7E5EF7654FDD7",
      "data": [
        {
          "attributeId": "41A649C11AF54F89A87A084E932A3D8D",
          "valueId": "EA2BEA4D58D44AE08D4674399F25E299",
          "description": "As we have realized similar projects in the near past quite a few times, the costs are estimated quite accurate."
        }
      ],
      "classificationId": "41D3A3705A4749038F2154B757ED3577",
      "score": [
        11.2,
        22.3,
        null
      ]
    }
  ]
 },...
]

Pqf.pm.getRecentlyDeletedProjects()

Returns all projects that are in the waste bin

Send : None

Receive : ItemWithDeletedFlagAndModifiedAt[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "isDeleted": "true",
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  }
 },...
]

Pqf.pm.getProjectClassification(projectId)

Returns the classification of a project (including calculated values)

• {projectId} : The project's ID

Send : None

Receive : Classification[ ]

Pqf.pm.putProjectClassification(projectId, obj)

Sets all classification values of a project (except calculated values)

• {projectId} : The project's ID

Send : Classification[ ]

Reiceive : None

Pqf.pm.getProjectConstraint(scenarioId, constraintId)

Returns a certain project constraint by its ID

• {scenarioId} : The project scenario's ID

• {constraintId} : The project constraint's ID

Send : None

Receive : ProjectConstraint

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "constraintType": "MANUAL",
  "predecessorMilestoneId": "822958FC27A94F6BA23ECCF2B74360A1",
  "successorMilestoneId": "671B83C761AB45C1AA2379C5EF5C83A3",
  "minDistance": "0",
  "maxDistance": "31"
}

Pqf.pm.putProjectConstraint(scenarioId, constraintId, movetarget, movesource, resourceid, obj)

Stores a certain project constraint by its ID

• {scenarioId} : The project scenario's ID

• {constraintId} : The project constraint's ID

• {movetarget}? : Moves the target task to fulfill the constraint, if necessary

• {movesource}? : Moves the target task to fulfill the constraint, if necessary

• {resourceid}? : Uses the work times of a given resource (only if movetarget or movesource is set)

Send : ProjectConstraint

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "constraintType": "MANUAL",
  "predecessorMilestoneId": "822958FC27A94F6BA23ECCF2B74360A1",
  "successorMilestoneId": "671B83C761AB45C1AA2379C5EF5C83A3",
  "minDistance": "0",
  "maxDistance": "31"
}

Reiceive : None

Pqf.pm.delProjectConstraint(scenarioId, constraintId)

Deletes a certain project constraint by its ID

• {scenarioId} : The project scenario's ID

• {constraintId} : The project constraint's ID

Send : None

Receive : None

Pqf.pm.getProjectConstraints(scenarioId, predecessorId, successorId, milestoneId, workItemId)

Returns a certain project constraint by its ID

• {scenarioId} : The project scenario's ID

• {predecessorId}? : The ID of the milestone on source side

• {successorId}? : The ID of the milestone on target side

• {milestoneId}? : The ID of the milestone on any side

• {workItemId}? : The ID of a work item involved

Send : None

Receive : ProjectConstraint[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "constraintType": "MANUAL",
  "predecessorMilestoneId": "822958FC27A94F6BA23ECCF2B74360A1",
  "successorMilestoneId": "671B83C761AB45C1AA2379C5EF5C83A3",
  "minDistance": "0",
  "maxDistance": "31"
 },...
]

Pqf.pm.getAllProjectDependencies(version)

Returns all dependencies between projects or portfolio milestones

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : ProjectDependency[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "constraintType": "MANUAL",
  "predecessorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "predecessorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "successorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "successorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "minDistance": "0",
  "maxDistance": "31"
 },...
]

Pqf.pm.getProjectDependency(dependencyId, version)

Returns a specific dependency between projects or portfolio milestones

• {dependencyId} : The project dependency's ID

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : ProjectDependency

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "constraintType": "MANUAL",
  "predecessorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "predecessorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "successorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "successorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "minDistance": "0",
  "maxDistance": "31"
}

Pqf.pm.putProjectDependency(dependencyId, obj)

Creates or updates a dependency between projects or portfolio milestones

• {dependencyId} : The project dependency's ID

Send : ProjectDependency

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "constraintType": "MANUAL",
  "predecessorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "predecessorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "successorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "successorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "minDistance": "0",
  "maxDistance": "31"
}

Reiceive : None

Pqf.pm.delProjectDependency(dependencyId)

Deletes a specific dependency between projects or portfolio milestones

• {dependencyId} : The project dependency's ID

Send : None

Receive : None

Pqf.pm.addProjectDependency(predecessortype, predecessorid, successortype, successorid)

Creates or updates a dependency between projects or portfolio milestones

• {predecessortype}? : The milestone type where the dependency starts

• {predecessorid}? : The milestone ID where the dependency starts

• {successortype}? : The milestone type where the dependency ends

• {successorid}? : The milestone ID where the dependency ends

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.getProjectDependencies(projectId, version)

Returns the dependencies of a project

• {projectId} : The project's ID

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : ProjectDependency[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "constraintType": "MANUAL",
  "predecessorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "predecessorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "successorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "successorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "minDistance": "0",
  "maxDistance": "31"
 },...
]

Pqf.pm.getProjectDetails(projectId)

Returns a project (details interface)

• {projectId} : The project's ID

Send : None

Receive : VersionedDetails

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.pm.putProjectDetails(projectId, obj)

Updates a project (details interface)

• {projectId} : The project's ID

Send : VersionedDetails

Reiceive : None

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.pm.getProjectIdentification(projectId)

Returns identifying members (name, description, icon) of a project

• {projectId} : The project's ID

Send : None

Receive : ItemWithLifecycle

Pqf.pm.getProjectIdentifications()

Returns identifying members (name, description, icon) of a project

Send : None

Receive : ItemWithLifecycle[ ]

Pqf.pm.getProjectsWithMissingReport(projectstate, reportstate, reporttype)

Returns all projects that do not have a report about the latest reporting interval

• {projectstate}? : A project state to filter projects

• {reportstate}? : Requires the reports to be in a specific state

• {reporttype}? : The project report types that should be included (omit to include all)

Send : None

Receive : Project[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "status": "5F9B9831C7704DDFAABF7580129AB8F2",
  "portfolios": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  ],
  "classification": [
    {
      "classificationSchemaId": "291ABC133A554A9F9CC7E5EF7654FDD7",
      "data": [
        {
          "attributeId": "41A649C11AF54F89A87A084E932A3D8D",
          "valueId": "EA2BEA4D58D44AE08D4674399F25E299",
          "description": "As we have realized similar projects in the near past quite a few times, the costs are estimated quite accurate."
        }
      ],
      "classificationId": "41D3A3705A4749038F2154B757ED3577",
      "score": [
        11.2,
        22.3,
        null
      ]
    }
  ]
 },...
]

Pqf.pm.getProjectManagementMethod(projectId)

Returns information about the project management method, its phases and its timing according to the project's lifecycle history

• {projectId} : The project's ID

Send : None

Receive : ProjectManagementMethod

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
}

Pqf.pm.getProjectManagementMethodPhase(projectId)

Returns information about the project management method, its phases and its timing according to the project's lifecycle history

• {projectId} : The project's ID

Send : None

Receive : ProjectManagementMethodPhase

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "sortIndex": 11.5
}

Pqf.pm.getProjectManagementMethodTimeline(projectId)

Returns information about the project management method, its phases and its timing according to the project's lifecycle history and active scenario planning

• {projectId} : The project's ID

Send : None

Receive : ProjectManagementMethodTimeline

{
  "managementMethod": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "plannedStart": "2020-03-11",
  "started": "2020-03-11T10:25:01:13Z",
  "phases": [
    {
      "managementMethodPhase": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "plannedFinish": "2020-03-11",
      "finished": "2020-03-11T10:25:01:13Z"
    }
  ],
  "currentPhase": "74BB193FFE354BA88B8BA736551B27C6"
}

Pqf.pm.getProjectScenarioManagementMethodTimeline(scenarioId)

Returns information about the project management method of a scenario, its phases and its timing according to the project's lifecycle history and scenario planning

• {scenarioId} : The project scenario's ID

Send : None

Receive : ProjectManagementMethodTimeline

{
  "managementMethod": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "plannedStart": "2020-03-11",
  "started": "2020-03-11T10:25:01:13Z",
  "phases": [
    {
      "managementMethodPhase": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "plannedFinish": "2020-03-11",
      "finished": "2020-03-11T10:25:01:13Z"
    }
  ],
  "currentPhase": "74BB193FFE354BA88B8BA736551B27C6"
}

Pqf.pm.getProjectPortfolios()

Returns all project portfolios

Send : None

Receive : ProjectPortfolio[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "parentPortfolioId": "D123018C3DD4497285255C65BA547EE1"
 },...
]

Pqf.pm.getRootProjectPortfolios()

Returns all root project portfolios

Send : None

Receive : ProjectPortfolio[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "parentPortfolioId": "D123018C3DD4497285255C65BA547EE1"
 },...
]

Pqf.pm.addProjectPortfolio()

Adds a new project portfolio to the PM root

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.getProjectPortfolio(portfolioId)

Returns a specific project portfolio

• {portfolioId} : the project portfolio ID

Send : None

Receive : ProjectPortfolio

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "parentPortfolioId": "D123018C3DD4497285255C65BA547EE1"
}

Pqf.pm.putProjectPortfolio(portfolioId, obj)

Updates a specific project portfolio

• {portfolioId} : the project portfolio ID

Send : ProjectPortfolio

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "parentPortfolioId": "D123018C3DD4497285255C65BA547EE1"
}

Reiceive : None

Pqf.pm.delProjectPortfolio(portfolioId)

Deletes a specific project portfolio

• {portfolioId} : the project portfolio ID

Send : None

Receive : None

Pqf.pm.getProjectPortfolioDependencies(portfolioId)

Returns all dependencies of a specific project portfolio

• {portfolioId} : the project portfolio ID

Send : None

Receive : ProjectDependency[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "constraintType": "MANUAL",
  "predecessorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "predecessorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "successorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "successorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "minDistance": "0",
  "maxDistance": "31"
 },...
]

Pqf.pm.getProjectPortfolioSubPortfolios(portfolioId)

Returns all project portfolios that are part of a specific project portfolio

• {portfolioId} : the project portfolio ID

Send : None

Receive : ProjectPortfolio[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "parentPortfolioId": "D123018C3DD4497285255C65BA547EE1"
 },...
]

Pqf.pm.addProjectPortfolioSubPortfolio(portfolioId)

Adds a new project portfolio to a project portfolio

• {portfolioId} : the project portfolio ID

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.getProjectPortfolioProjects(portfolioId)

Returns all projects that are part of a specific project portfolio

• {portfolioId} : the project portfolio ID

Send : None

Receive : Project[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "status": "5F9B9831C7704DDFAABF7580129AB8F2",
  "portfolios": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  ],
  "classification": [
    {
      "classificationSchemaId": "291ABC133A554A9F9CC7E5EF7654FDD7",
      "data": [
        {
          "attributeId": "41A649C11AF54F89A87A084E932A3D8D",
          "valueId": "EA2BEA4D58D44AE08D4674399F25E299",
          "description": "As we have realized similar projects in the near past quite a few times, the costs are estimated quite accurate."
        }
      ],
      "classificationId": "41D3A3705A4749038F2154B757ED3577",
      "score": [
        11.2,
        22.3,
        null
      ]
    }
  ]
 },...
]

Pqf.pm.addProjectPortfolioProject(portfolioId, copy, includeLogs, includeDocumentLinks, includeShiftPlans, includeDependencies, includeAllocations, includeTodoLinks, includeTodos)

Adds a new project to a project portfolio

• {portfolioId} : the project portfolio ID

• {copy}? : Creates a copy of an existing project, if set

• {includeLogs}? : Copy logs

• {includeDocumentLinks}? : Copy document links

• {includeShiftPlans}? : Copy shift plans

• {includeDependencies}? : Copy dependencies

• {includeAllocations}? : Copy allocations

• {includeTodoLinks}? : Copy todo links

• {includeTodos}? : Copy todos

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.uploadProjectPortfolioProject(portfolioId, format)

Adds a new project scenario to a project portfolio by uploading a project file (MS Project, MPX, XML, ...)

• {portfolioId} : the project portfolio ID

• {format}? : The file format to bypass auto detection

Send : Arbitrary Content

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.moveProjectPortfolio(portfolioId, portfolio)

Moves a project portfolio into another

• {portfolioId} : the project portfolio ID

• {portfolio}? : The destination portfolio (required)

Send : None

Receive : None

Pqf.pm.moveProjectPortfolioToTop(portfolioId)

Moves a project portfolio to the top (the PM module)

• {portfolioId} : the project portfolio ID

Send : None

Receive : None

Pqf.pm.getProjectPortfolioMilestones(portfolioId, includeparent)

Returns all milestones of a portfolio

• {portfolioId} : the project portfolio ID

• {includeparent}? : Include also milestones of parent project portfolios

Send : None

Receive : ProjectPortfolioMilestone[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectPortfolioId": "85D4903147B84688991D9CB26B0FF511",
  "position": "2020-03-11"
 },...
]

Pqf.pm.addProjectPortfolioMilestone(portfolioId, at)

Adds a new milestone to a portfolio

• {portfolioId} : the project portfolio ID

• {at}? : The point in time the new milestone should be placed

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.getProjectPortfolioMilestone(portfolioId, milestoneId)

Returns a specific project portfolio milestone

• {portfolioId} : the project portfolio ID

• {milestoneId} : the project portfolio milestone ID

Send : None

Receive : ProjectPortfolioMilestone

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectPortfolioId": "85D4903147B84688991D9CB26B0FF511",
  "position": "2020-03-11"
}

Pqf.pm.putProjectPortfolioMilestone(portfolioId, milestoneId, obj)

Updates a specific project portfolio milestone

• {portfolioId} : the project portfolio ID

• {milestoneId} : the project portfolio milestone ID

Send : ProjectPortfolioMilestone

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectPortfolioId": "85D4903147B84688991D9CB26B0FF511",
  "position": "2020-03-11"
}

Reiceive : None

Pqf.pm.delProjectPortfolioMilestone(portfolioId, milestoneId)

Deletes a specific project portfolio milestone

• {portfolioId} : the project portfolio ID

• {milestoneId} : the project portfolio milestone ID

Send : None

Receive : None

Pqf.pm.getProjectReportsByType(projectId, reportType)

Returns all project reports of a given project

• {projectId} : The project's ID

• {reportType} : The project report's type

Send : None

Receive : ProjectReport[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project X",
  "code": "RP-PRJ-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectId": "430CEFBE2A634F5FB4E833244B42C928",
  "indicators": {
    "dimensions": [
      {
        "selection": {
          "dimension": "FD030594F78D4DA88DDF8EE573650C00",
          "showValues": "true",
          "showRiskEstimation": "true",
          "isLeading": "true",
          "remark": "Do not spend too much time on these indicators as they're not so important",
          "details": [
            {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            }
          ],
          "isReportExport": "true"
        },
        "indicators": [
          {
            "selection": {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            },
            "actualValueCalculated": "45",
            "actualValueManual": "40",
            "remainingValueCalculated": "15",
            "remainingValueManual": "30",
            "forecastValueCalculated": "60",
            "forecastValueManual": "70",
            "statusClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "statusClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "remark": "We can do better!"
          }
        ],
        "total": {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        },
        "targetTotal": "500",
        "riskEstimation": {
          "occurrenceProbability": 11.5,
          "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
          "extentOfLoss": 11.5,
          "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
          "riskRating": 11.5,
          "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
          "remark": "The estimation was made using 10 dices 😉"
        }
      }
    ],
    "leading": {
      "selection": {
        "dimension": "FD030594F78D4DA88DDF8EE573650C00",
        "showValues": "true",
        "showRiskEstimation": "true",
        "isLeading": "true",
        "remark": "Do not spend too much time on these indicators as they're not so important",
        "details": [
          {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          }
        ],
        "isReportExport": "true"
      },
      "indicators": [
        {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        }
      ],
      "total": {
        "selection": {
          "typeId": "66BE84A8A5624CEBB8316C284E754C38",
          "targetValue": "55",
          "showValues": "true",
          "projectSpecificName": "Concept done",
          "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
          "createdAt": "2020-03-11T10:25:01:13Z",
          "createdBy": null,
          "modifiedAt": "2020-03-11T10:25:01:13Z",
          "modifiedBy": null,
          "version": "029335F8E37A45758C3B6235863F4BA8",
          "historic": "true"
        },
        "actualValueCalculated": "45",
        "actualValueManual": "40",
        "remainingValueCalculated": "15",
        "remainingValueManual": "30",
        "forecastValueCalculated": "60",
        "forecastValueManual": "70",
        "statusClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "statusClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "remark": "We can do better!"
      },
      "targetTotal": "500",
      "riskEstimation": {
        "occurrenceProbability": 11.5,
        "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
        "extentOfLoss": 11.5,
        "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
        "riskRating": 11.5,
        "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
        "remark": "The estimation was made using 10 dices 😉"
      }
    },
    "riskSum": 11.5,
    "riskClassSum": 11.5
  },
  "risks": [
    {
      "projectId": "87F5235D6B2E49168DA41EF3781F539E",
      "dimension": "4784F638450845AC981DB2FC5F00D2D7"
    }
  ],
  "currency": "CURRENCY-EUR"
 },...
]

Pqf.pm.getProjectReports(projectId, reporttype)

Returns all project reports of a given project

• {projectId} : The project's ID

• {reporttype}? : The project report types that should be included (omit to include all)

Send : None

Receive : ProjectReport[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project X",
  "code": "RP-PRJ-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectId": "430CEFBE2A634F5FB4E833244B42C928",
  "indicators": {
    "dimensions": [
      {
        "selection": {
          "dimension": "FD030594F78D4DA88DDF8EE573650C00",
          "showValues": "true",
          "showRiskEstimation": "true",
          "isLeading": "true",
          "remark": "Do not spend too much time on these indicators as they're not so important",
          "details": [
            {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            }
          ],
          "isReportExport": "true"
        },
        "indicators": [
          {
            "selection": {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            },
            "actualValueCalculated": "45",
            "actualValueManual": "40",
            "remainingValueCalculated": "15",
            "remainingValueManual": "30",
            "forecastValueCalculated": "60",
            "forecastValueManual": "70",
            "statusClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "statusClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "remark": "We can do better!"
          }
        ],
        "total": {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        },
        "targetTotal": "500",
        "riskEstimation": {
          "occurrenceProbability": 11.5,
          "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
          "extentOfLoss": 11.5,
          "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
          "riskRating": 11.5,
          "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
          "remark": "The estimation was made using 10 dices 😉"
        }
      }
    ],
    "leading": {
      "selection": {
        "dimension": "FD030594F78D4DA88DDF8EE573650C00",
        "showValues": "true",
        "showRiskEstimation": "true",
        "isLeading": "true",
        "remark": "Do not spend too much time on these indicators as they're not so important",
        "details": [
          {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          }
        ],
        "isReportExport": "true"
      },
      "indicators": [
        {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        }
      ],
      "total": {
        "selection": {
          "typeId": "66BE84A8A5624CEBB8316C284E754C38",
          "targetValue": "55",
          "showValues": "true",
          "projectSpecificName": "Concept done",
          "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
          "createdAt": "2020-03-11T10:25:01:13Z",
          "createdBy": null,
          "modifiedAt": "2020-03-11T10:25:01:13Z",
          "modifiedBy": null,
          "version": "029335F8E37A45758C3B6235863F4BA8",
          "historic": "true"
        },
        "actualValueCalculated": "45",
        "actualValueManual": "40",
        "remainingValueCalculated": "15",
        "remainingValueManual": "30",
        "forecastValueCalculated": "60",
        "forecastValueManual": "70",
        "statusClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "statusClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "remark": "We can do better!"
      },
      "targetTotal": "500",
      "riskEstimation": {
        "occurrenceProbability": 11.5,
        "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
        "extentOfLoss": 11.5,
        "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
        "riskRating": 11.5,
        "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
        "remark": "The estimation was made using 10 dices 😉"
      }
    },
    "riskSum": 11.5,
    "riskClassSum": 11.5
  },
  "risks": [
    {
      "projectId": "87F5235D6B2E49168DA41EF3781F539E",
      "dimension": "4784F638450845AC981DB2FC5F00D2D7"
    }
  ],
  "currency": "CURRENCY-EUR"
 },...
]

Pqf.pm.addProjectReport(projectId, reportType, copy, currency)

Adds a new project report to a project

• {projectId} : The project's ID

• {reportType} : The project report's type

• {copy}? : The ID of a report to be used as template

• {currency}? : Currency that will be used to calculate and store report (null uses user's default currency)

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.getLatestProjectReport(projectId, reportType, state, skip)

Returns the latest report of a project (with one of the given states, if desired)

• {projectId} : The project's ID

• {reportType} : The project report's type

• {state}? : The states that should be considered to identify the latest report

• {skip}? : Skips the latest n reports

Send : None

Receive : ProjectReport

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project X",
  "code": "RP-PRJ-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectId": "430CEFBE2A634F5FB4E833244B42C928",
  "indicators": {
    "dimensions": [
      {
        "selection": {
          "dimension": "FD030594F78D4DA88DDF8EE573650C00",
          "showValues": "true",
          "showRiskEstimation": "true",
          "isLeading": "true",
          "remark": "Do not spend too much time on these indicators as they're not so important",
          "details": [
            {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            }
          ],
          "isReportExport": "true"
        },
        "indicators": [
          {
            "selection": {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            },
            "actualValueCalculated": "45",
            "actualValueManual": "40",
            "remainingValueCalculated": "15",
            "remainingValueManual": "30",
            "forecastValueCalculated": "60",
            "forecastValueManual": "70",
            "statusClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "statusClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "remark": "We can do better!"
          }
        ],
        "total": {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        },
        "targetTotal": "500",
        "riskEstimation": {
          "occurrenceProbability": 11.5,
          "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
          "extentOfLoss": 11.5,
          "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
          "riskRating": 11.5,
          "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
          "remark": "The estimation was made using 10 dices 😉"
        }
      }
    ],
    "leading": {
      "selection": {
        "dimension": "FD030594F78D4DA88DDF8EE573650C00",
        "showValues": "true",
        "showRiskEstimation": "true",
        "isLeading": "true",
        "remark": "Do not spend too much time on these indicators as they're not so important",
        "details": [
          {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          }
        ],
        "isReportExport": "true"
      },
      "indicators": [
        {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        }
      ],
      "total": {
        "selection": {
          "typeId": "66BE84A8A5624CEBB8316C284E754C38",
          "targetValue": "55",
          "showValues": "true",
          "projectSpecificName": "Concept done",
          "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
          "createdAt": "2020-03-11T10:25:01:13Z",
          "createdBy": null,
          "modifiedAt": "2020-03-11T10:25:01:13Z",
          "modifiedBy": null,
          "version": "029335F8E37A45758C3B6235863F4BA8",
          "historic": "true"
        },
        "actualValueCalculated": "45",
        "actualValueManual": "40",
        "remainingValueCalculated": "15",
        "remainingValueManual": "30",
        "forecastValueCalculated": "60",
        "forecastValueManual": "70",
        "statusClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "statusClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "remark": "We can do better!"
      },
      "targetTotal": "500",
      "riskEstimation": {
        "occurrenceProbability": 11.5,
        "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
        "extentOfLoss": 11.5,
        "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
        "riskRating": 11.5,
        "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
        "remark": "The estimation was made using 10 dices 😉"
      }
    },
    "riskSum": 11.5,
    "riskClassSum": 11.5
  },
  "risks": [
    {
      "projectId": "87F5235D6B2E49168DA41EF3781F539E",
      "dimension": "4784F638450845AC981DB2FC5F00D2D7"
    }
  ],
  "currency": "CURRENCY-EUR"
}

Pqf.pm.getProjectReport(reportType, reportId, recalculate, currency)

Returns the project report with the given ID

• {reportType} : The project report's type

• {reportId} : The project report's ID

• {recalculate}? : Flag to trigger recalculation while loading (will not be stored automatically)

• {currency}? : Currency that will be used for recalculation (only used, if recalculate=1; null uses user's default currency)

Send : None

Receive : ProjectReport

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project X",
  "code": "RP-PRJ-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectId": "430CEFBE2A634F5FB4E833244B42C928",
  "indicators": {
    "dimensions": [
      {
        "selection": {
          "dimension": "FD030594F78D4DA88DDF8EE573650C00",
          "showValues": "true",
          "showRiskEstimation": "true",
          "isLeading": "true",
          "remark": "Do not spend too much time on these indicators as they're not so important",
          "details": [
            {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            }
          ],
          "isReportExport": "true"
        },
        "indicators": [
          {
            "selection": {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            },
            "actualValueCalculated": "45",
            "actualValueManual": "40",
            "remainingValueCalculated": "15",
            "remainingValueManual": "30",
            "forecastValueCalculated": "60",
            "forecastValueManual": "70",
            "statusClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "statusClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "remark": "We can do better!"
          }
        ],
        "total": {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        },
        "targetTotal": "500",
        "riskEstimation": {
          "occurrenceProbability": 11.5,
          "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
          "extentOfLoss": 11.5,
          "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
          "riskRating": 11.5,
          "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
          "remark": "The estimation was made using 10 dices 😉"
        }
      }
    ],
    "leading": {
      "selection": {
        "dimension": "FD030594F78D4DA88DDF8EE573650C00",
        "showValues": "true",
        "showRiskEstimation": "true",
        "isLeading": "true",
        "remark": "Do not spend too much time on these indicators as they're not so important",
        "details": [
          {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          }
        ],
        "isReportExport": "true"
      },
      "indicators": [
        {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        }
      ],
      "total": {
        "selection": {
          "typeId": "66BE84A8A5624CEBB8316C284E754C38",
          "targetValue": "55",
          "showValues": "true",
          "projectSpecificName": "Concept done",
          "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
          "createdAt": "2020-03-11T10:25:01:13Z",
          "createdBy": null,
          "modifiedAt": "2020-03-11T10:25:01:13Z",
          "modifiedBy": null,
          "version": "029335F8E37A45758C3B6235863F4BA8",
          "historic": "true"
        },
        "actualValueCalculated": "45",
        "actualValueManual": "40",
        "remainingValueCalculated": "15",
        "remainingValueManual": "30",
        "forecastValueCalculated": "60",
        "forecastValueManual": "70",
        "statusClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "statusClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "remark": "We can do better!"
      },
      "targetTotal": "500",
      "riskEstimation": {
        "occurrenceProbability": 11.5,
        "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
        "extentOfLoss": 11.5,
        "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
        "riskRating": 11.5,
        "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
        "remark": "The estimation was made using 10 dices 😉"
      }
    },
    "riskSum": 11.5,
    "riskClassSum": 11.5
  },
  "risks": [
    {
      "projectId": "87F5235D6B2E49168DA41EF3781F539E",
      "dimension": "4784F638450845AC981DB2FC5F00D2D7"
    }
  ],
  "currency": "CURRENCY-EUR"
}

Pqf.pm.putProjectReport(reportType, reportId, currency, obj)

Updates or creates the project report with the given ID

• {reportType} : The project report's type

• {reportId} : The project report's ID

• {currency}? : Currency that will be used to calculate and store report (null uses user's default currency)

Send : ProjectReport

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project X",
  "code": "RP-PRJ-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectId": "430CEFBE2A634F5FB4E833244B42C928",
  "indicators": {
    "dimensions": [
      {
        "selection": {
          "dimension": "FD030594F78D4DA88DDF8EE573650C00",
          "showValues": "true",
          "showRiskEstimation": "true",
          "isLeading": "true",
          "remark": "Do not spend too much time on these indicators as they're not so important",
          "details": [
            {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            }
          ],
          "isReportExport": "true"
        },
        "indicators": [
          {
            "selection": {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            },
            "actualValueCalculated": "45",
            "actualValueManual": "40",
            "remainingValueCalculated": "15",
            "remainingValueManual": "30",
            "forecastValueCalculated": "60",
            "forecastValueManual": "70",
            "statusClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "statusClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "remark": "We can do better!"
          }
        ],
        "total": {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        },
        "targetTotal": "500",
        "riskEstimation": {
          "occurrenceProbability": 11.5,
          "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
          "extentOfLoss": 11.5,
          "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
          "riskRating": 11.5,
          "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
          "remark": "The estimation was made using 10 dices 😉"
        }
      }
    ],
    "leading": {
      "selection": {
        "dimension": "FD030594F78D4DA88DDF8EE573650C00",
        "showValues": "true",
        "showRiskEstimation": "true",
        "isLeading": "true",
        "remark": "Do not spend too much time on these indicators as they're not so important",
        "details": [
          {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          }
        ],
        "isReportExport": "true"
      },
      "indicators": [
        {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        }
      ],
      "total": {
        "selection": {
          "typeId": "66BE84A8A5624CEBB8316C284E754C38",
          "targetValue": "55",
          "showValues": "true",
          "projectSpecificName": "Concept done",
          "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
          "createdAt": "2020-03-11T10:25:01:13Z",
          "createdBy": null,
          "modifiedAt": "2020-03-11T10:25:01:13Z",
          "modifiedBy": null,
          "version": "029335F8E37A45758C3B6235863F4BA8",
          "historic": "true"
        },
        "actualValueCalculated": "45",
        "actualValueManual": "40",
        "remainingValueCalculated": "15",
        "remainingValueManual": "30",
        "forecastValueCalculated": "60",
        "forecastValueManual": "70",
        "statusClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "statusClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "remark": "We can do better!"
      },
      "targetTotal": "500",
      "riskEstimation": {
        "occurrenceProbability": 11.5,
        "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
        "extentOfLoss": 11.5,
        "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
        "riskRating": 11.5,
        "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
        "remark": "The estimation was made using 10 dices 😉"
      }
    },
    "riskSum": 11.5,
    "riskClassSum": 11.5
  },
  "risks": [
    {
      "projectId": "87F5235D6B2E49168DA41EF3781F539E",
      "dimension": "4784F638450845AC981DB2FC5F00D2D7"
    }
  ],
  "currency": "CURRENCY-EUR"
}

Reiceive : None

Pqf.pm.delProjectReport(reportType, reportId)

Deletes the project report with the given ID

• {reportType} : The project report's type

• {reportId} : The project report's ID

Send : None

Receive : None

Pqf.pm.getAllProjectReports(reportType, state)

Returns all project reports

• {reportType} : The project report's type

• {state}? : The states to filter the reports

Send : None

Receive : ProjectReport[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project X",
  "code": "RP-PRJ-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectId": "430CEFBE2A634F5FB4E833244B42C928",
  "indicators": {
    "dimensions": [
      {
        "selection": {
          "dimension": "FD030594F78D4DA88DDF8EE573650C00",
          "showValues": "true",
          "showRiskEstimation": "true",
          "isLeading": "true",
          "remark": "Do not spend too much time on these indicators as they're not so important",
          "details": [
            {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            }
          ],
          "isReportExport": "true"
        },
        "indicators": [
          {
            "selection": {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            },
            "actualValueCalculated": "45",
            "actualValueManual": "40",
            "remainingValueCalculated": "15",
            "remainingValueManual": "30",
            "forecastValueCalculated": "60",
            "forecastValueManual": "70",
            "statusClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "statusClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClassCalculated": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "trendClass": {
              "type": "AnyTypeOfObj",
              "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
              "name": "Project X",
              "code": "PRJ-X",
              "description": "<p>This was the development name of <b>PQFORCE</b></p>",
              "iconRef": "/images/lifecycle/planning.png",
              "color": "blue",
              "validityStart": "2020-03-11",
              "validityUntil": "2020-03-11"
            },
            "remark": "We can do better!"
          }
        ],
        "total": {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        },
        "targetTotal": "500",
        "riskEstimation": {
          "occurrenceProbability": 11.5,
          "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
          "extentOfLoss": 11.5,
          "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
          "riskRating": 11.5,
          "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
          "remark": "The estimation was made using 10 dices 😉"
        }
      }
    ],
    "leading": {
      "selection": {
        "dimension": "FD030594F78D4DA88DDF8EE573650C00",
        "showValues": "true",
        "showRiskEstimation": "true",
        "isLeading": "true",
        "remark": "Do not spend too much time on these indicators as they're not so important",
        "details": [
          {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          }
        ],
        "isReportExport": "true"
      },
      "indicators": [
        {
          "selection": {
            "typeId": "66BE84A8A5624CEBB8316C284E754C38",
            "targetValue": "55",
            "showValues": "true",
            "projectSpecificName": "Concept done",
            "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
            "createdAt": "2020-03-11T10:25:01:13Z",
            "createdBy": null,
            "modifiedAt": "2020-03-11T10:25:01:13Z",
            "modifiedBy": null,
            "version": "029335F8E37A45758C3B6235863F4BA8",
            "historic": "true"
          },
          "actualValueCalculated": "45",
          "actualValueManual": "40",
          "remainingValueCalculated": "15",
          "remainingValueManual": "30",
          "forecastValueCalculated": "60",
          "forecastValueManual": "70",
          "statusClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "statusClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClassCalculated": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "trendClass": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "remark": "We can do better!"
        }
      ],
      "total": {
        "selection": {
          "typeId": "66BE84A8A5624CEBB8316C284E754C38",
          "targetValue": "55",
          "showValues": "true",
          "projectSpecificName": "Concept done",
          "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
          "createdAt": "2020-03-11T10:25:01:13Z",
          "createdBy": null,
          "modifiedAt": "2020-03-11T10:25:01:13Z",
          "modifiedBy": null,
          "version": "029335F8E37A45758C3B6235863F4BA8",
          "historic": "true"
        },
        "actualValueCalculated": "45",
        "actualValueManual": "40",
        "remainingValueCalculated": "15",
        "remainingValueManual": "30",
        "forecastValueCalculated": "60",
        "forecastValueManual": "70",
        "statusClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "statusClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClassCalculated": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "trendClass": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "remark": "We can do better!"
      },
      "targetTotal": "500",
      "riskEstimation": {
        "occurrenceProbability": 11.5,
        "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
        "extentOfLoss": 11.5,
        "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
        "riskRating": 11.5,
        "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
        "remark": "The estimation was made using 10 dices 😉"
      }
    },
    "riskSum": 11.5,
    "riskClassSum": 11.5
  },
  "risks": [
    {
      "projectId": "87F5235D6B2E49168DA41EF3781F539E",
      "dimension": "4784F638450845AC981DB2FC5F00D2D7"
    }
  ],
  "currency": "CURRENCY-EUR"
 },...
]

Pqf.pm.getAllProjectPortfoliosWithLatestReports(state, reporttype)

Returns all project portfolios with their latest report (with one of the given states, if desired)

• {state}? : The states that should be considered to identify the latest report

• {reporttype}? : The project portfolio report types that should be included (omit to include all)

Send : None

Receive : ProjectPortfolioWithReports[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "reports": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "createdAt": "2020-03-11T10:25:01:13Z",
      "createdBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "modifiedAt": "2020-03-11T10:25:01:13Z",
      "modifiedBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "version": "029335F8E37A45758C3B6235863F4BA8",
      "historic": "true",
      "name": "Report for Project Portfolio X",
      "code": "RP-PPF-X",
      "description": "<p>This is a report for <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/final.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityEnd": "2020-03-11",
      "properties": [
        {
          "key": "prj-type",
          "value": "PRJ-TYPE-DEV"
        }
      ],
      "projectPortfolioId": "430CEFBE2A634F5FB4E833244B42C928"
    }
  ]
 },...
]

Pqf.pm.getProjectPortfolioReportsByType(projectPortfolioId, reportType)

Returns all project reports of a given project

• {projectPortfolioId} : The project portfolio's ID

• {reportType} : The project portfolio report's type

Send : None

Receive : ProjectPortfolioReport[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project Portfolio X",
  "code": "RP-PPF-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectPortfolioId": "430CEFBE2A634F5FB4E833244B42C928"
 },...
]

Pqf.pm.getProjectPortfolioReports(projectPortfolioId, reporttype)

Returns all project reports of a given project

• {projectPortfolioId} : The project portfolio's ID

• {reporttype}? : The project portfolio report types that should be included (omit to include all)

Send : None

Receive : ProjectPortfolioReport[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project Portfolio X",
  "code": "RP-PPF-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectPortfolioId": "430CEFBE2A634F5FB4E833244B42C928"
 },...
]

Pqf.pm.addProjectPortfolioReport(projectPortfolioId, reportType, copy)

Adds a new project portfolio report to a project

• {projectPortfolioId} : The project portfolio's ID

• {reportType} : The project portfolio report's type

• {copy}? : The ID of a report to be used as template

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.getLatestProjectPortfolioReport(projectPortfolioId, reportType, state, skip)

Returns the latest report of a project (with one of the given states, if desired)

• {projectPortfolioId} : The project portfolio's ID

• {reportType} : The project portfolio report's type

• {state}? : The states that should be considered to identify the latest report

• {skip}? : Skips the latest n reports

Send : None

Receive : ProjectPortfolioReport

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project Portfolio X",
  "code": "RP-PPF-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectPortfolioId": "430CEFBE2A634F5FB4E833244B42C928"
}

Pqf.pm.getProjectPortfolioReport(reportType, reportId)

Returns the project portfolio report with the given ID

• {reportType} : The project portfolio report's type

• {reportId} : The project portfolio report's ID

Send : None

Receive : ProjectPortfolioReport

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project Portfolio X",
  "code": "RP-PPF-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectPortfolioId": "430CEFBE2A634F5FB4E833244B42C928"
}

Pqf.pm.putProjectPortfolioReport(reportType, reportId, obj)

Updates or creates the project portfolio report with the given ID

• {reportType} : The project portfolio report's type

• {reportId} : The project portfolio report's ID

Send : ProjectPortfolioReport

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project Portfolio X",
  "code": "RP-PPF-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectPortfolioId": "430CEFBE2A634F5FB4E833244B42C928"
}

Reiceive : None

Pqf.pm.delProjectPortfolioReport(reportType, reportId)

Deletes the project portfolio report with the given ID

• {reportType} : The project portfolio report's type

• {reportId} : The project portfolio report's ID

Send : None

Receive : None

Pqf.pm.getAllProjectPortfolioReports(reportType, state)

Returns all project reports

• {reportType} : The project portfolio report's type

• {state}? : The states to filter the reports

Send : None

Receive : ProjectPortfolioReport[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Report for Project Portfolio X",
  "code": "RP-PPF-X",
  "description": "<p>This is a report for <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/final.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectPortfolioId": "430CEFBE2A634F5FB4E833244B42C928"
 },...
]

Pqf.pm.getAllProjectsWithLatestReports(state, reporttype)

Returns all projects with their latest report (with one of the given states, if desired)

• {state}? : The states that should be considered to identify the latest report

• {reporttype}? : The project portfolio report types that should be included (omit to include all)

Send : None

Receive : ProjectWithReports[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "reports": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "createdAt": "2020-03-11T10:25:01:13Z",
      "createdBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "modifiedAt": "2020-03-11T10:25:01:13Z",
      "modifiedBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "version": "029335F8E37A45758C3B6235863F4BA8",
      "historic": "true",
      "name": "Report for Project X",
      "code": "RP-PRJ-X",
      "description": "<p>This is a report for <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/final.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityEnd": "2020-03-11",
      "properties": [
        {
          "key": "prj-type",
          "value": "PRJ-TYPE-DEV"
        }
      ],
      "projectId": "430CEFBE2A634F5FB4E833244B42C928",
      "indicators": {
        "dimensions": [
          {
            "selection": {
              "dimension": "FD030594F78D4DA88DDF8EE573650C00",
              "showValues": "true",
              "showRiskEstimation": "true",
              "isLeading": "true",
              "remark": "Do not spend too much time on these indicators as they're not so important",
              "details": [
                {
                  "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                  "targetValue": "55",
                  "showValues": "true",
                  "projectSpecificName": "Concept done",
                  "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                  "createdAt": "2020-03-11T10:25:01:13Z",
                  "createdBy": null,
                  "modifiedAt": "2020-03-11T10:25:01:13Z",
                  "modifiedBy": null,
                  "version": "029335F8E37A45758C3B6235863F4BA8",
                  "historic": "true"
                }
              ],
              "isReportExport": "true"
            },
            "indicators": [
              {
                "selection": {
                  "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                  "targetValue": "55",
                  "showValues": "true",
                  "projectSpecificName": "Concept done",
                  "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                  "createdAt": "2020-03-11T10:25:01:13Z",
                  "createdBy": null,
                  "modifiedAt": "2020-03-11T10:25:01:13Z",
                  "modifiedBy": null,
                  "version": "029335F8E37A45758C3B6235863F4BA8",
                  "historic": "true"
                },
                "actualValueCalculated": "45",
                "actualValueManual": "40",
                "remainingValueCalculated": "15",
                "remainingValueManual": "30",
                "forecastValueCalculated": "60",
                "forecastValueManual": "70",
                "statusClassCalculated": null,
                "statusClass": null,
                "trendClassCalculated": null,
                "trendClass": null,
                "remark": "We can do better!"
              }
            ],
            "total": {
              "selection": {
                "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                "targetValue": "55",
                "showValues": "true",
                "projectSpecificName": "Concept done",
                "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                "createdAt": "2020-03-11T10:25:01:13Z",
                "createdBy": null,
                "modifiedAt": "2020-03-11T10:25:01:13Z",
                "modifiedBy": null,
                "version": "029335F8E37A45758C3B6235863F4BA8",
                "historic": "true"
              },
              "actualValueCalculated": "45",
              "actualValueManual": "40",
              "remainingValueCalculated": "15",
              "remainingValueManual": "30",
              "forecastValueCalculated": "60",
              "forecastValueManual": "70",
              "statusClassCalculated": null,
              "statusClass": null,
              "trendClassCalculated": null,
              "trendClass": null,
              "remark": "We can do better!"
            },
            "targetTotal": "500",
            "riskEstimation": {
              "occurrenceProbability": 11.5,
              "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
              "extentOfLoss": 11.5,
              "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
              "riskRating": 11.5,
              "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
              "remark": "The estimation was made using 10 dices 😉"
            }
          }
        ],
        "leading": {
          "selection": {
            "dimension": "FD030594F78D4DA88DDF8EE573650C00",
            "showValues": "true",
            "showRiskEstimation": "true",
            "isLeading": "true",
            "remark": "Do not spend too much time on these indicators as they're not so important",
            "details": [
              {
                "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                "targetValue": "55",
                "showValues": "true",
                "projectSpecificName": "Concept done",
                "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                "createdAt": "2020-03-11T10:25:01:13Z",
                "createdBy": null,
                "modifiedAt": "2020-03-11T10:25:01:13Z",
                "modifiedBy": null,
                "version": "029335F8E37A45758C3B6235863F4BA8",
                "historic": "true"
              }
            ],
            "isReportExport": "true"
          },
          "indicators": [
            {
              "selection": {
                "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                "targetValue": "55",
                "showValues": "true",
                "projectSpecificName": "Concept done",
                "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                "createdAt": "2020-03-11T10:25:01:13Z",
                "createdBy": null,
                "modifiedAt": "2020-03-11T10:25:01:13Z",
                "modifiedBy": null,
                "version": "029335F8E37A45758C3B6235863F4BA8",
                "historic": "true"
              },
              "actualValueCalculated": "45",
              "actualValueManual": "40",
              "remainingValueCalculated": "15",
              "remainingValueManual": "30",
              "forecastValueCalculated": "60",
              "forecastValueManual": "70",
              "statusClassCalculated": null,
              "statusClass": null,
              "trendClassCalculated": null,
              "trendClass": null,
              "remark": "We can do better!"
            }
          ],
          "total": {
            "selection": {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            },
            "actualValueCalculated": "45",
            "actualValueManual": "40",
            "remainingValueCalculated": "15",
            "remainingValueManual": "30",
            "forecastValueCalculated": "60",
            "forecastValueManual": "70",
            "statusClassCalculated": null,
            "statusClass": null,
            "trendClassCalculated": null,
            "trendClass": null,
            "remark": "We can do better!"
          },
          "targetTotal": "500",
          "riskEstimation": {
            "occurrenceProbability": 11.5,
            "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
            "extentOfLoss": 11.5,
            "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
            "riskRating": 11.5,
            "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
            "remark": "The estimation was made using 10 dices 😉"
          }
        },
        "riskSum": 11.5,
        "riskClassSum": 11.5
      },
      "risks": [
        {
          "projectId": "87F5235D6B2E49168DA41EF3781F539E",
          "dimension": "4784F638450845AC981DB2FC5F00D2D7"
        }
      ],
      "currency": "CURRENCY-EUR"
    }
  ]
 },...
]

Pqf.pm.getProjectPortfolioReportType(reportTypeId)

Returns a project report type

• {reportTypeId} : The ID of the project report type

Send : None

Receive : ProjectPortfolioReportType

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "interval": {
    "unit": "DAYS",
    "amount": 11,
    "offset": 11
  },
  "autoCreate": "true",
  "sortIndex": 11.5,
  "hasValidity": "true"
}

Pqf.pm.getProjectPortfolioReportTypeTranslated(reportTypeId)

Returns a project report type with translations

• {reportTypeId} : The ID of the project report type

Send : None

Receive : ProjectPortfolioReportTypeTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJ-X",
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "interval": {
    "unit": "DAYS",
    "amount": 11,
    "offset": 11
  },
  "autoCreate": "true",
  "sortIndex": 11.5,
  "hasValidity": "true"
}

Pqf.pm.putProjectPortfolioReportTypeTranslated(reportTypeId, obj)

Updates a project report type with translations

• {reportTypeId} : The ID of the project report type

Send : ProjectPortfolioReportTypeTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJ-X",
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "interval": {
    "unit": "DAYS",
    "amount": 11,
    "offset": 11
  },
  "autoCreate": "true",
  "sortIndex": 11.5,
  "hasValidity": "true"
}

Reiceive : None

Pqf.pm.delProjectPortfolioReportTypeTranslated(reportTypeId)

Deletes a project report type with translations

• {reportTypeId} : The ID of the project report type

Send : None

Receive : None

Pqf.pm.getProjectPortfolioReportTypes()

Returns a project report type by its ID

Send : None

Receive : ProjectPortfolioReportType[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "interval": {
    "unit": "DAYS",
    "amount": 11,
    "offset": 11
  },
  "autoCreate": "true",
  "sortIndex": 11.5,
  "hasValidity": "true"
 },...
]

Pqf.pm.getProjectReportType(reportTypeId)

Returns a project report type

• {reportTypeId} : The ID of the project report type

Send : None

Receive : ProjectReportType

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "interval": {
    "unit": "DAYS",
    "amount": 11,
    "offset": 11
  },
  "autoCreate": "true",
  "sortIndex": 11.5,
  "hasValidity": "true",
  "canRefresh": "true",
  "jsDataSourceId": "EEAFD16CF25B44D8A131201C79BCA8DA"
}

Pqf.pm.getProjectReportTypeTranslated(reportTypeId)

Returns a project report type with translations

• {reportTypeId} : The ID of the project report type

Send : None

Receive : ProjectReportTypeTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJ-X",
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "interval": {
    "unit": "DAYS",
    "amount": 11,
    "offset": 11
  },
  "autoCreate": "true",
  "sortIndex": 11.5,
  "hasValidity": "true",
  "canRefresh": "true",
  "jsDataSourceId": "EEAFD16CF25B44D8A131201C79BCA8DA"
}

Pqf.pm.putProjectReportTypeTranslated(reportTypeId, obj)

Updates a project report type with translations

• {reportTypeId} : The ID of the project report type

Send : ProjectReportTypeTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJ-X",
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "interval": {
    "unit": "DAYS",
    "amount": 11,
    "offset": 11
  },
  "autoCreate": "true",
  "sortIndex": 11.5,
  "hasValidity": "true",
  "canRefresh": "true",
  "jsDataSourceId": "EEAFD16CF25B44D8A131201C79BCA8DA"
}

Reiceive : None

Pqf.pm.delProjectReportTypeTranslated(reportTypeId)

Deletes a project report type with translations

• {reportTypeId} : The ID of the project report type

Send : None

Receive : None

Pqf.pm.getProjectReportTypes()

Returns a project report type by its ID

Send : None

Receive : ProjectReportType[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "interval": {
    "unit": "DAYS",
    "amount": 11,
    "offset": 11
  },
  "autoCreate": "true",
  "sortIndex": 11.5,
  "hasValidity": "true",
  "canRefresh": "true",
  "jsDataSourceId": "EEAFD16CF25B44D8A131201C79BCA8DA"
 },...
]

Pqf.pm.getProjectActiveScenario(projectId, singleinactive)

Returns the current active scenario for a given project

• {projectId} : The project's ID

• {singleinactive}? : Handle a single inactive scenario as active, too

Send : None

Receive : ProjectScenario

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectId": "3D4579592B404430A93D7504EE7B0A55",
  "status": "3687790A73CC42AE94DDB75B2AD65AD3",
  "owner": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  }
}

Pqf.pm.getProjectActiveScenarioHistory(projectId, singleinactive, until)

Returns the historic active scenario IDs for a given project

• {projectId} : The project's ID

• {singleinactive}? : Handle a single inactive scenario as active, too

• {until}? : Limit for the history to be returned

Send : None

Receive : ItemTimeline

{
  "items": [
    {
      "obj": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "pointInTime": "2020-03-11T10:25:01:13Z",
      "user": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      }
    }
  ]
}

Pqf.pm.getProjectsWithActiveScenario(singleinactive)

Returns all projects together with their active scenario

• {singleinactive}? : Handle a single inactive scenario as active, too

Send : None

Receive : Project[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "status": "5F9B9831C7704DDFAABF7580129AB8F2",
  "portfolios": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  ],
  "classification": [
    {
      "classificationSchemaId": "291ABC133A554A9F9CC7E5EF7654FDD7",
      "data": [
        {
          "attributeId": "41A649C11AF54F89A87A084E932A3D8D",
          "valueId": "EA2BEA4D58D44AE08D4674399F25E299",
          "description": "As we have realized similar projects in the near past quite a few times, the costs are estimated quite accurate."
        }
      ],
      "classificationId": "41D3A3705A4749038F2154B757ED3577",
      "score": [
        11.2,
        22.3,
        null
      ]
    }
  ]
 },...
]

Pqf.pm.getProjectSummary(projectId, currency, state, reporttype)

Returns the latest report of a project (with one of the given states, if desired)

• {projectId} : The project's ID

• {currency}? : The desired currency to have all money values converted into (except the report which is not recalculated)

• {state}? : The states that should be considered to identify the latest report

• {reporttype}? : The project report types that should be included (omit to include all)

Send : None

Receive : ProjectSummary

{
  "project": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "createdAt": "2020-03-11T10:25:01:13Z",
    "createdBy": null,
    "modifiedAt": "2020-03-11T10:25:01:13Z",
    "modifiedBy": null,
    "version": "029335F8E37A45758C3B6235863F4BA8",
    "historic": "true",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "properties": [
      {
        "key": "prj-type",
        "value": "PRJ-TYPE-DEV"
      }
    ],
    "status": "5F9B9831C7704DDFAABF7580129AB8F2",
    "portfolios": [
      {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      }
    ],
    "classification": [
      {
        "classificationSchemaId": "291ABC133A554A9F9CC7E5EF7654FDD7",
        "data": [
          {
            "attributeId": "41A649C11AF54F89A87A084E932A3D8D",
            "valueId": "EA2BEA4D58D44AE08D4674399F25E299",
            "description": "As we have realized similar projects in the near past quite a few times, the costs are estimated quite accurate."
          }
        ],
        "classificationId": "41D3A3705A4749038F2154B757ED3577",
        "score": [
          11.2,
          22.3,
          null
        ]
      }
    ]
  },
  "subObjects": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "createdAt": "2020-03-11T10:25:01:13Z",
      "createdBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "modifiedAt": "2020-03-11T10:25:01:13Z",
      "modifiedBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "version": "029335F8E37A45758C3B6235863F4BA8",
      "historic": "true",
      "properties": [
        {
          "key": "prj-type",
          "value": "PRJ-TYPE-DEV"
        }
      ]
    }
  ],
  "activeScenario": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "createdAt": "2020-03-11T10:25:01:13Z",
    "createdBy": null,
    "modifiedAt": "2020-03-11T10:25:01:13Z",
    "modifiedBy": null,
    "version": "029335F8E37A45758C3B6235863F4BA8",
    "historic": "true",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "properties": [
      {
        "key": "prj-type",
        "value": "PRJ-TYPE-DEV"
      }
    ],
    "projectId": "3D4579592B404430A93D7504EE7B0A55",
    "status": "3687790A73CC42AE94DDB75B2AD65AD3",
    "owner": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  },
  "mainPhase": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "createdAt": "2020-03-11T10:25:01:13Z",
    "createdBy": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    },
    "modifiedAt": "2020-03-11T10:25:01:13Z",
    "modifiedBy": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    },
    "version": "029335F8E37A45758C3B6235863F4BA8",
    "historic": "true",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "properties": [
      {
        "key": "prj-type",
        "value": "PRJ-TYPE-DEV"
      }
    ],
    "phaseType": "PORTFOLIO_MILESTONE",
    "projectId": "A2EC8F59A62D4E77A43A6A924A82C37A",
    "scenarioId": "C51070CF01CC490F831F3D419D6358BD",
    "parentPhaseId": "9E91C2B21678493592299D8766A7429D",
    "startId": "04ADAEF76C8D49DDBDAC1940BC99F940",
    "endId": "A20C093779BF4FE69A7823953BE840B6",
    "sortIndex": [
      11.2,
      22.3,
      null
    ],
    "timeBudget": "PT10D25H01M13S",
    "costsBudget": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    },
    "planned": "PT10D25H01M13S",
    "beg": "2020-03-11T10:25:01:13Z",
    "end": "2020-03-11T10:25:01:13Z",
    "fixed": "true",
    "projectCostsPositions": [
      {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Sven Müller"
      }
    ],
    "owner": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11",
      "isDeleted": "true"
    },
    "requiredSkill": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11",
      "isDeleted": "true"
    },
    "color": "B9E497A80D5A404EAED56E0759F9422E",
    "manualProgressOverride": [
      11.2,
      22.3,
      null
    ],
    "projectManagementMethodPhaseId": "D30CD7BA6C5E44EB9EBB31E4860CB544",
    "dependencies": [
      {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "fromPhaseId": "9D45E520ECFB4FE2AF5F74351ECDD96E",
        "toPhaseId": "ABEA7AC2855E4D5D943BAC08DF7AB90C",
        "dependencyType": "START_START",
        "minDistance": [
          11,
          12,
          17
        ],
        "maxDistance": [
          11,
          12,
          17
        ]
      }
    ]
  },
  "accumulatedValues": {
    "projectWorkItemId": "A7825BDD23E0414D9F337D19F70D0A81",
    "childrenCount": 11,
    "childrenCountAccumulated": 11,
    "costsBudget": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    },
    "costsBudgetAccumulated": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    },
    "costs": {
      "forecasts": [
        {
          "typeGroup": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Sven Müller"
          }
        }
      ],
      "forecastTotal": {
        "planned": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "actual": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "expectedPending": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "remaining": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        }
      },
      "forecast": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      }
    },
    "costsAccumulated": {
      "forecasts": [
        {
          "typeGroup": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Sven Müller"
          }
        }
      ],
      "forecastTotal": {
        "planned": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "actual": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "expectedPending": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "remaining": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        }
      },
      "forecast": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      }
    },
    "resourceAllocations": "PT10D25H01M13S",
    "resourceAllocationsAccumulated": "PT10D25H01M13S",
    "resourceActuals": "PT10D25H01M13S",
    "resourceActualsAccumulated": "PT10D25H01M13S",
    "timeBudgetAccumulated": "PT10D25H01M13S",
    "timePlannedAccumulated": "PT10D25H01M13S",
    "timeExpectedPending": "PT10D25H01M13S",
    "timeExpectedPendingAccumulated": "PT10D25H01M13S",
    "timeRemaining": "PT10D25H01M13S",
    "timeRemainingAccumulated": "PT10D25H01M13S",
    "errors": "[\"Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen.\"]",
    "errorsAccumulated": "[\"Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen.\"]",
    "progress": 11.5,
    "progressAccumulated": 11.5,
    "manualProgressOverride": [
      11.2,
      22.3,
      null
    ],
    "overloadIndicator": 11.5,
    "overloadIndicatorAccumulated": 11.5
  },
  "costsActual": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsExpectedPending": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsRemaining": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsBudget": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsPlanned": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsForecast": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "relations": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "relationType": "4511728B45CE4E3E963F6B6CE5090883",
      "explicit": "true",
      "name": "Owner of project",
      "source": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
      },
      "target": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
      }
    }
  ],
  "managementMethod": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "managementMethodPhase": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "thirdPartyReferences": [
    {
      "foreignName": "Project XYZ",
      "foreignCode": "1234567890-XYZ",
      "foreignDescription": "Project XYZ",
      "foreignImageUrl": "https://myerp.com/icons/1234567890-XYZ"
    }
  ],
  "latestReports": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "createdAt": "2020-03-11T10:25:01:13Z",
      "createdBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "modifiedAt": "2020-03-11T10:25:01:13Z",
      "modifiedBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "version": "029335F8E37A45758C3B6235863F4BA8",
      "historic": "true",
      "name": "Report for Project X",
      "code": "RP-PRJ-X",
      "description": "<p>This is a report for <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/final.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityEnd": "2020-03-11",
      "properties": [
        {
          "key": "prj-type",
          "value": "PRJ-TYPE-DEV"
        }
      ],
      "projectId": "430CEFBE2A634F5FB4E833244B42C928",
      "indicators": {
        "dimensions": [
          {
            "selection": {
              "dimension": "FD030594F78D4DA88DDF8EE573650C00",
              "showValues": "true",
              "showRiskEstimation": "true",
              "isLeading": "true",
              "remark": "Do not spend too much time on these indicators as they're not so important",
              "details": [
                {
                  "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                  "targetValue": "55",
                  "showValues": "true",
                  "projectSpecificName": "Concept done",
                  "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                  "createdAt": "2020-03-11T10:25:01:13Z",
                  "createdBy": null,
                  "modifiedAt": "2020-03-11T10:25:01:13Z",
                  "modifiedBy": null,
                  "version": "029335F8E37A45758C3B6235863F4BA8",
                  "historic": "true"
                }
              ],
              "isReportExport": "true"
            },
            "indicators": [
              {
                "selection": {
                  "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                  "targetValue": "55",
                  "showValues": "true",
                  "projectSpecificName": "Concept done",
                  "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                  "createdAt": "2020-03-11T10:25:01:13Z",
                  "createdBy": null,
                  "modifiedAt": "2020-03-11T10:25:01:13Z",
                  "modifiedBy": null,
                  "version": "029335F8E37A45758C3B6235863F4BA8",
                  "historic": "true"
                },
                "actualValueCalculated": "45",
                "actualValueManual": "40",
                "remainingValueCalculated": "15",
                "remainingValueManual": "30",
                "forecastValueCalculated": "60",
                "forecastValueManual": "70",
                "statusClassCalculated": null,
                "statusClass": null,
                "trendClassCalculated": null,
                "trendClass": null,
                "remark": "We can do better!"
              }
            ],
            "total": {
              "selection": {
                "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                "targetValue": "55",
                "showValues": "true",
                "projectSpecificName": "Concept done",
                "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                "createdAt": "2020-03-11T10:25:01:13Z",
                "createdBy": null,
                "modifiedAt": "2020-03-11T10:25:01:13Z",
                "modifiedBy": null,
                "version": "029335F8E37A45758C3B6235863F4BA8",
                "historic": "true"
              },
              "actualValueCalculated": "45",
              "actualValueManual": "40",
              "remainingValueCalculated": "15",
              "remainingValueManual": "30",
              "forecastValueCalculated": "60",
              "forecastValueManual": "70",
              "statusClassCalculated": null,
              "statusClass": null,
              "trendClassCalculated": null,
              "trendClass": null,
              "remark": "We can do better!"
            },
            "targetTotal": "500",
            "riskEstimation": {
              "occurrenceProbability": 11.5,
              "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
              "extentOfLoss": 11.5,
              "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
              "riskRating": 11.5,
              "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
              "remark": "The estimation was made using 10 dices 😉"
            }
          }
        ],
        "leading": {
          "selection": {
            "dimension": "FD030594F78D4DA88DDF8EE573650C00",
            "showValues": "true",
            "showRiskEstimation": "true",
            "isLeading": "true",
            "remark": "Do not spend too much time on these indicators as they're not so important",
            "details": [
              {
                "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                "targetValue": "55",
                "showValues": "true",
                "projectSpecificName": "Concept done",
                "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                "createdAt": "2020-03-11T10:25:01:13Z",
                "createdBy": null,
                "modifiedAt": "2020-03-11T10:25:01:13Z",
                "modifiedBy": null,
                "version": "029335F8E37A45758C3B6235863F4BA8",
                "historic": "true"
              }
            ],
            "isReportExport": "true"
          },
          "indicators": [
            {
              "selection": {
                "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                "targetValue": "55",
                "showValues": "true",
                "projectSpecificName": "Concept done",
                "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                "createdAt": "2020-03-11T10:25:01:13Z",
                "createdBy": null,
                "modifiedAt": "2020-03-11T10:25:01:13Z",
                "modifiedBy": null,
                "version": "029335F8E37A45758C3B6235863F4BA8",
                "historic": "true"
              },
              "actualValueCalculated": "45",
              "actualValueManual": "40",
              "remainingValueCalculated": "15",
              "remainingValueManual": "30",
              "forecastValueCalculated": "60",
              "forecastValueManual": "70",
              "statusClassCalculated": null,
              "statusClass": null,
              "trendClassCalculated": null,
              "trendClass": null,
              "remark": "We can do better!"
            }
          ],
          "total": {
            "selection": {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            },
            "actualValueCalculated": "45",
            "actualValueManual": "40",
            "remainingValueCalculated": "15",
            "remainingValueManual": "30",
            "forecastValueCalculated": "60",
            "forecastValueManual": "70",
            "statusClassCalculated": null,
            "statusClass": null,
            "trendClassCalculated": null,
            "trendClass": null,
            "remark": "We can do better!"
          },
          "targetTotal": "500",
          "riskEstimation": {
            "occurrenceProbability": 11.5,
            "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
            "extentOfLoss": 11.5,
            "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
            "riskRating": 11.5,
            "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
            "remark": "The estimation was made using 10 dices 😉"
          }
        },
        "riskSum": 11.5,
        "riskClassSum": 11.5
      },
      "risks": [
        {
          "projectId": "87F5235D6B2E49168DA41EF3781F539E",
          "dimension": "4784F638450845AC981DB2FC5F00D2D7"
        }
      ],
      "currency": "CURRENCY-EUR"
    }
  ],
  "confidentiality": "NORMAL",
  "lastStateTransition": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "version": "DF23BAFE32A042A3915790B0878DA8EE",
    "state": {
      "subState": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      }
    },
    "transition": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11",
      "properties": [
        {
          "key": "prj-type",
          "value": "PRJ-TYPE-DEV"
        }
      ],
      "from": {
        "subState": null
      },
      "to": {
        "subState": null
      }
    },
    "timestamp": "2020-03-11T10:25:01:13Z",
    "initiatedBy": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11",
      "isDeleted": "true"
    },
    "remark": "All planning is done and verified"
  }
}

Pqf.pm.getProjectSummaries(projectid, currency, state, reporttype)

Returns the latest report of a project (with one of the given states, if desired)

• {projectid}? : The projects' IDs

• {currency}? : The desired currency to have all money values converted into (except the report which is not recalculated)

• {state}? : The states that should be considered to identify the latest report

• {reporttype}? : The project report types that should be included (omit to include all)

Send : None

Receive : ProjectSummary[ ]

[
 {
  "project": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "createdAt": "2020-03-11T10:25:01:13Z",
    "createdBy": null,
    "modifiedAt": "2020-03-11T10:25:01:13Z",
    "modifiedBy": null,
    "version": "029335F8E37A45758C3B6235863F4BA8",
    "historic": "true",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "properties": [
      {
        "key": "prj-type",
        "value": "PRJ-TYPE-DEV"
      }
    ],
    "status": "5F9B9831C7704DDFAABF7580129AB8F2",
    "portfolios": [
      {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      }
    ],
    "classification": [
      {
        "classificationSchemaId": "291ABC133A554A9F9CC7E5EF7654FDD7",
        "data": [
          {
            "attributeId": "41A649C11AF54F89A87A084E932A3D8D",
            "valueId": "EA2BEA4D58D44AE08D4674399F25E299",
            "description": "As we have realized similar projects in the near past quite a few times, the costs are estimated quite accurate."
          }
        ],
        "classificationId": "41D3A3705A4749038F2154B757ED3577",
        "score": [
          11.2,
          22.3,
          null
        ]
      }
    ]
  },
  "subObjects": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "createdAt": "2020-03-11T10:25:01:13Z",
      "createdBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "modifiedAt": "2020-03-11T10:25:01:13Z",
      "modifiedBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "version": "029335F8E37A45758C3B6235863F4BA8",
      "historic": "true",
      "properties": [
        {
          "key": "prj-type",
          "value": "PRJ-TYPE-DEV"
        }
      ]
    }
  ],
  "activeScenario": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "createdAt": "2020-03-11T10:25:01:13Z",
    "createdBy": null,
    "modifiedAt": "2020-03-11T10:25:01:13Z",
    "modifiedBy": null,
    "version": "029335F8E37A45758C3B6235863F4BA8",
    "historic": "true",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "properties": [
      {
        "key": "prj-type",
        "value": "PRJ-TYPE-DEV"
      }
    ],
    "projectId": "3D4579592B404430A93D7504EE7B0A55",
    "status": "3687790A73CC42AE94DDB75B2AD65AD3",
    "owner": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  },
  "mainPhase": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "createdAt": "2020-03-11T10:25:01:13Z",
    "createdBy": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    },
    "modifiedAt": "2020-03-11T10:25:01:13Z",
    "modifiedBy": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    },
    "version": "029335F8E37A45758C3B6235863F4BA8",
    "historic": "true",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "properties": [
      {
        "key": "prj-type",
        "value": "PRJ-TYPE-DEV"
      }
    ],
    "phaseType": "PORTFOLIO_MILESTONE",
    "projectId": "A2EC8F59A62D4E77A43A6A924A82C37A",
    "scenarioId": "C51070CF01CC490F831F3D419D6358BD",
    "parentPhaseId": "9E91C2B21678493592299D8766A7429D",
    "startId": "04ADAEF76C8D49DDBDAC1940BC99F940",
    "endId": "A20C093779BF4FE69A7823953BE840B6",
    "sortIndex": [
      11.2,
      22.3,
      null
    ],
    "timeBudget": "PT10D25H01M13S",
    "costsBudget": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    },
    "planned": "PT10D25H01M13S",
    "beg": "2020-03-11T10:25:01:13Z",
    "end": "2020-03-11T10:25:01:13Z",
    "fixed": "true",
    "projectCostsPositions": [
      {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Sven Müller"
      }
    ],
    "owner": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11",
      "isDeleted": "true"
    },
    "requiredSkill": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11",
      "isDeleted": "true"
    },
    "color": "B9E497A80D5A404EAED56E0759F9422E",
    "manualProgressOverride": [
      11.2,
      22.3,
      null
    ],
    "projectManagementMethodPhaseId": "D30CD7BA6C5E44EB9EBB31E4860CB544",
    "dependencies": [
      {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "fromPhaseId": "9D45E520ECFB4FE2AF5F74351ECDD96E",
        "toPhaseId": "ABEA7AC2855E4D5D943BAC08DF7AB90C",
        "dependencyType": "START_START",
        "minDistance": [
          11,
          12,
          17
        ],
        "maxDistance": [
          11,
          12,
          17
        ]
      }
    ]
  },
  "accumulatedValues": {
    "projectWorkItemId": "A7825BDD23E0414D9F337D19F70D0A81",
    "childrenCount": 11,
    "childrenCountAccumulated": 11,
    "costsBudget": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    },
    "costsBudgetAccumulated": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    },
    "costs": {
      "forecasts": [
        {
          "typeGroup": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Sven Müller"
          }
        }
      ],
      "forecastTotal": {
        "planned": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "actual": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "expectedPending": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "remaining": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        }
      },
      "forecast": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      }
    },
    "costsAccumulated": {
      "forecasts": [
        {
          "typeGroup": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Sven Müller"
          }
        }
      ],
      "forecastTotal": {
        "planned": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "actual": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "expectedPending": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        },
        "remaining": {
          "amount": 11.5,
          "currency": "CURRENCY-CHF"
        }
      },
      "forecast": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      }
    },
    "resourceAllocations": "PT10D25H01M13S",
    "resourceAllocationsAccumulated": "PT10D25H01M13S",
    "resourceActuals": "PT10D25H01M13S",
    "resourceActualsAccumulated": "PT10D25H01M13S",
    "timeBudgetAccumulated": "PT10D25H01M13S",
    "timePlannedAccumulated": "PT10D25H01M13S",
    "timeExpectedPending": "PT10D25H01M13S",
    "timeExpectedPendingAccumulated": "PT10D25H01M13S",
    "timeRemaining": "PT10D25H01M13S",
    "timeRemainingAccumulated": "PT10D25H01M13S",
    "errors": "[\"Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen.\"]",
    "errorsAccumulated": "[\"Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen.\"]",
    "progress": 11.5,
    "progressAccumulated": 11.5,
    "manualProgressOverride": [
      11.2,
      22.3,
      null
    ],
    "overloadIndicator": 11.5,
    "overloadIndicatorAccumulated": 11.5
  },
  "costsActual": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsExpectedPending": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsRemaining": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsBudget": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsPlanned": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsForecast": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "relations": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "relationType": "4511728B45CE4E3E963F6B6CE5090883",
      "explicit": "true",
      "name": "Owner of project",
      "source": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
      },
      "target": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
      }
    }
  ],
  "managementMethod": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "managementMethodPhase": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "thirdPartyReferences": [
    {
      "foreignName": "Project XYZ",
      "foreignCode": "1234567890-XYZ",
      "foreignDescription": "Project XYZ",
      "foreignImageUrl": "https://myerp.com/icons/1234567890-XYZ"
    }
  ],
  "latestReports": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "createdAt": "2020-03-11T10:25:01:13Z",
      "createdBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "modifiedAt": "2020-03-11T10:25:01:13Z",
      "modifiedBy": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      },
      "version": "029335F8E37A45758C3B6235863F4BA8",
      "historic": "true",
      "name": "Report for Project X",
      "code": "RP-PRJ-X",
      "description": "<p>This is a report for <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/final.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityEnd": "2020-03-11",
      "properties": [
        {
          "key": "prj-type",
          "value": "PRJ-TYPE-DEV"
        }
      ],
      "projectId": "430CEFBE2A634F5FB4E833244B42C928",
      "indicators": {
        "dimensions": [
          {
            "selection": {
              "dimension": "FD030594F78D4DA88DDF8EE573650C00",
              "showValues": "true",
              "showRiskEstimation": "true",
              "isLeading": "true",
              "remark": "Do not spend too much time on these indicators as they're not so important",
              "details": [
                {
                  "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                  "targetValue": "55",
                  "showValues": "true",
                  "projectSpecificName": "Concept done",
                  "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                  "createdAt": "2020-03-11T10:25:01:13Z",
                  "createdBy": null,
                  "modifiedAt": "2020-03-11T10:25:01:13Z",
                  "modifiedBy": null,
                  "version": "029335F8E37A45758C3B6235863F4BA8",
                  "historic": "true"
                }
              ],
              "isReportExport": "true"
            },
            "indicators": [
              {
                "selection": {
                  "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                  "targetValue": "55",
                  "showValues": "true",
                  "projectSpecificName": "Concept done",
                  "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                  "createdAt": "2020-03-11T10:25:01:13Z",
                  "createdBy": null,
                  "modifiedAt": "2020-03-11T10:25:01:13Z",
                  "modifiedBy": null,
                  "version": "029335F8E37A45758C3B6235863F4BA8",
                  "historic": "true"
                },
                "actualValueCalculated": "45",
                "actualValueManual": "40",
                "remainingValueCalculated": "15",
                "remainingValueManual": "30",
                "forecastValueCalculated": "60",
                "forecastValueManual": "70",
                "statusClassCalculated": null,
                "statusClass": null,
                "trendClassCalculated": null,
                "trendClass": null,
                "remark": "We can do better!"
              }
            ],
            "total": {
              "selection": {
                "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                "targetValue": "55",
                "showValues": "true",
                "projectSpecificName": "Concept done",
                "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                "createdAt": "2020-03-11T10:25:01:13Z",
                "createdBy": null,
                "modifiedAt": "2020-03-11T10:25:01:13Z",
                "modifiedBy": null,
                "version": "029335F8E37A45758C3B6235863F4BA8",
                "historic": "true"
              },
              "actualValueCalculated": "45",
              "actualValueManual": "40",
              "remainingValueCalculated": "15",
              "remainingValueManual": "30",
              "forecastValueCalculated": "60",
              "forecastValueManual": "70",
              "statusClassCalculated": null,
              "statusClass": null,
              "trendClassCalculated": null,
              "trendClass": null,
              "remark": "We can do better!"
            },
            "targetTotal": "500",
            "riskEstimation": {
              "occurrenceProbability": 11.5,
              "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
              "extentOfLoss": 11.5,
              "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
              "riskRating": 11.5,
              "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
              "remark": "The estimation was made using 10 dices 😉"
            }
          }
        ],
        "leading": {
          "selection": {
            "dimension": "FD030594F78D4DA88DDF8EE573650C00",
            "showValues": "true",
            "showRiskEstimation": "true",
            "isLeading": "true",
            "remark": "Do not spend too much time on these indicators as they're not so important",
            "details": [
              {
                "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                "targetValue": "55",
                "showValues": "true",
                "projectSpecificName": "Concept done",
                "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                "createdAt": "2020-03-11T10:25:01:13Z",
                "createdBy": null,
                "modifiedAt": "2020-03-11T10:25:01:13Z",
                "modifiedBy": null,
                "version": "029335F8E37A45758C3B6235863F4BA8",
                "historic": "true"
              }
            ],
            "isReportExport": "true"
          },
          "indicators": [
            {
              "selection": {
                "typeId": "66BE84A8A5624CEBB8316C284E754C38",
                "targetValue": "55",
                "showValues": "true",
                "projectSpecificName": "Concept done",
                "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
                "createdAt": "2020-03-11T10:25:01:13Z",
                "createdBy": null,
                "modifiedAt": "2020-03-11T10:25:01:13Z",
                "modifiedBy": null,
                "version": "029335F8E37A45758C3B6235863F4BA8",
                "historic": "true"
              },
              "actualValueCalculated": "45",
              "actualValueManual": "40",
              "remainingValueCalculated": "15",
              "remainingValueManual": "30",
              "forecastValueCalculated": "60",
              "forecastValueManual": "70",
              "statusClassCalculated": null,
              "statusClass": null,
              "trendClassCalculated": null,
              "trendClass": null,
              "remark": "We can do better!"
            }
          ],
          "total": {
            "selection": {
              "typeId": "66BE84A8A5624CEBB8316C284E754C38",
              "targetValue": "55",
              "showValues": "true",
              "projectSpecificName": "Concept done",
              "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
              "createdAt": "2020-03-11T10:25:01:13Z",
              "createdBy": null,
              "modifiedAt": "2020-03-11T10:25:01:13Z",
              "modifiedBy": null,
              "version": "029335F8E37A45758C3B6235863F4BA8",
              "historic": "true"
            },
            "actualValueCalculated": "45",
            "actualValueManual": "40",
            "remainingValueCalculated": "15",
            "remainingValueManual": "30",
            "forecastValueCalculated": "60",
            "forecastValueManual": "70",
            "statusClassCalculated": null,
            "statusClass": null,
            "trendClassCalculated": null,
            "trendClass": null,
            "remark": "We can do better!"
          },
          "targetTotal": "500",
          "riskEstimation": {
            "occurrenceProbability": 11.5,
            "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
            "extentOfLoss": 11.5,
            "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
            "riskRating": 11.5,
            "riskRatingClassification": "F71376233416402885209C3AEA0C4760",
            "remark": "The estimation was made using 10 dices 😉"
          }
        },
        "riskSum": 11.5,
        "riskClassSum": 11.5
      },
      "risks": [
        {
          "projectId": "87F5235D6B2E49168DA41EF3781F539E",
          "dimension": "4784F638450845AC981DB2FC5F00D2D7"
        }
      ],
      "currency": "CURRENCY-EUR"
    }
  ],
  "confidentiality": "NORMAL",
  "lastStateTransition": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "version": "DF23BAFE32A042A3915790B0878DA8EE",
    "state": {
      "subState": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Project X",
        "code": "PRJ-X",
        "description": "<p>This was the development name of <b>PQFORCE</b></p>",
        "iconRef": "/images/lifecycle/planning.png",
        "color": "blue",
        "validityStart": "2020-03-11",
        "validityUntil": "2020-03-11"
      }
    },
    "transition": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11",
      "properties": [
        {
          "key": "prj-type",
          "value": "PRJ-TYPE-DEV"
        }
      ],
      "from": {
        "subState": null
      },
      "to": {
        "subState": null
      }
    },
    "timestamp": "2020-03-11T10:25:01:13Z",
    "initiatedBy": {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11",
      "isDeleted": "true"
    },
    "remark": "All planning is done and verified"
  }
 },...
]

Pqf.pm.getProjectAccumulatedValues(projectId, beg, end, currency)

Returns the accumulated values for each phase of a scenario

• {projectId} : The project's ID

• {beg}? : A time range (begin, inclusive) to filter costs and allocations

• {end}? : A time range (end, exclusive) to filter costs and allocations

• {currency}? : The desired currency to have all money values converted into

Send : None

Receive : ProjectWorkItemAccumulatedValues[ ]

[
 {
  "projectWorkItemId": "A7825BDD23E0414D9F337D19F70D0A81",
  "childrenCount": 11,
  "childrenCountAccumulated": 11,
  "costsBudget": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsBudgetAccumulated": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costs": {
    "forecasts": [
      {
        "typeGroup": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Sven Müller"
        }
      }
    ],
    "forecastTotal": {
      "planned": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "actual": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "expectedPending": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "remaining": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      }
    },
    "forecast": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    }
  },
  "costsAccumulated": {
    "forecasts": [
      {
        "typeGroup": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Sven Müller"
        }
      }
    ],
    "forecastTotal": {
      "planned": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "actual": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "expectedPending": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "remaining": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      }
    },
    "forecast": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    }
  },
  "resourceAllocations": "PT10D25H01M13S",
  "resourceAllocationsAccumulated": "PT10D25H01M13S",
  "resourceActuals": "PT10D25H01M13S",
  "resourceActualsAccumulated": "PT10D25H01M13S",
  "timeBudgetAccumulated": "PT10D25H01M13S",
  "timePlannedAccumulated": "PT10D25H01M13S",
  "timeExpectedPending": "PT10D25H01M13S",
  "timeExpectedPendingAccumulated": "PT10D25H01M13S",
  "timeRemaining": "PT10D25H01M13S",
  "timeRemainingAccumulated": "PT10D25H01M13S",
  "errors": "[\"Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen.\"]",
  "errorsAccumulated": "[\"Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen.\"]",
  "progress": 11.5,
  "progressAccumulated": 11.5,
  "manualProgressOverride": [
    11.2,
    22.3,
    null
  ],
  "overloadIndicator": 11.5,
  "overloadIndicatorAccumulated": 11.5
 },...
]

Pqf.pm.getProjectWorkItemProgressCorrections(workItemId)

Returns the correction history of project work item

• {workItemId} : The work item's ID

Send : None

Receive : ProjectWorkItemRemainingEfforts

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "timeline": [
    {
      "at": "2020-03-11",
      "overidden": [
        {
          "remainingEffort": "PT10D25H01M13S",
          "remainingEffortSpecified": "PT10D25H01M13S",
          "progressSpecified": [
            11,
            12,
            17
          ],
          "remark": "Although we have no clue, it seems that we've made progress",
          "modifiedAt": "2020-03-11T10:25:01:13Z",
          "modifiedBy": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          }
        }
      ]
    }
  ]
}

Pqf.pm.getProjectWorkItemProgressCorrection(workItemId, at)

Gets either earned value or remaining effort on a project work item at a specific day

• {workItemId} : The work item's ID

• {at}? : The day on which the progress was measured (optional)

Send : None

Receive : ProjectWorkItemRemainingEfforts

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "timeline": [
    {
      "at": "2020-03-11",
      "overidden": [
        {
          "remainingEffort": "PT10D25H01M13S",
          "remainingEffortSpecified": "PT10D25H01M13S",
          "progressSpecified": [
            11,
            12,
            17
          ],
          "remark": "Although we have no clue, it seems that we've made progress",
          "modifiedAt": "2020-03-11T10:25:01:13Z",
          "modifiedBy": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          }
        }
      ]
    }
  ]
}

Pqf.pm.delProjectWorkItemProgressCorrection(workItemId, at, deleteoverride)

Deletes either earned value or remaining effort on a project work item at a specific day

• {workItemId} : The work item's ID

• {at}? : The day on which the progress was measured (optional)

• {deleteoverride}? : Set to true, if progress override should be removed

Send : None

Receive : None

Pqf.pm.updateProjectWorkItemProgressCorrection(workItemId, at, progress, remainingeffort, remark, includestimebased, deleteoverride)

Sets either earned value or remaining effort on a project work item

• {workItemId} : The work item's ID

• {at}? : The day on which the progress was measured (optional)

• {progress}? : The progress in percent

• {remainingeffort}? : The remaining effort

• {remark}? : A remark that can be stored along with the correction

• {includestimebased}? : Set to true, if estimation is also including time based allocations

• {deleteoverride}? : Set to true, if progress override should be removed

Send : None

Receive : None

Pqf.pm.getProjectScenarioProgressCorrections(scenarioId)

Returns all the correction histories of a project scenario

• {scenarioId} : The project scenario's ID

Send : None

Receive : ProjectWorkItemRemainingEfforts[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "timeline": [
    {
      "at": "2020-03-11",
      "overidden": [
        {
          "remainingEffort": "PT10D25H01M13S",
          "remainingEffortSpecified": "PT10D25H01M13S",
          "progressSpecified": [
            11,
            12,
            17
          ],
          "remark": "Although we have no clue, it seems that we've made progress",
          "modifiedAt": "2020-03-11T10:25:01:13Z",
          "modifiedBy": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          }
        }
      ]
    }
  ]
 },...
]

Pqf.pm.getScenarioAccumulatedValues(scenarioId, beg, end, currency)

Returns the accumulated values for each phase of a scenario

• {scenarioId} : The project scenario's ID

• {beg}? : A time range (begin, inclusive) to filter costs and allocations

• {end}? : A time range (end, exclusive) to filter costs and allocations

• {currency}? : The desired currency to have all money values converted into

Send : None

Receive : ProjectWorkItemAccumulatedValues[ ]

[
 {
  "projectWorkItemId": "A7825BDD23E0414D9F337D19F70D0A81",
  "childrenCount": 11,
  "childrenCountAccumulated": 11,
  "costsBudget": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsBudgetAccumulated": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costs": {
    "forecasts": [
      {
        "typeGroup": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Sven Müller"
        }
      }
    ],
    "forecastTotal": {
      "planned": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "actual": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "expectedPending": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "remaining": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      }
    },
    "forecast": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    }
  },
  "costsAccumulated": {
    "forecasts": [
      {
        "typeGroup": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Sven Müller"
        }
      }
    ],
    "forecastTotal": {
      "planned": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "actual": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "expectedPending": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "remaining": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      }
    },
    "forecast": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    }
  },
  "resourceAllocations": "PT10D25H01M13S",
  "resourceAllocationsAccumulated": "PT10D25H01M13S",
  "resourceActuals": "PT10D25H01M13S",
  "resourceActualsAccumulated": "PT10D25H01M13S",
  "timeBudgetAccumulated": "PT10D25H01M13S",
  "timePlannedAccumulated": "PT10D25H01M13S",
  "timeExpectedPending": "PT10D25H01M13S",
  "timeExpectedPendingAccumulated": "PT10D25H01M13S",
  "timeRemaining": "PT10D25H01M13S",
  "timeRemainingAccumulated": "PT10D25H01M13S",
  "errors": "[\"Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen.\"]",
  "errorsAccumulated": "[\"Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen.\"]",
  "progress": 11.5,
  "progressAccumulated": 11.5,
  "manualProgressOverride": [
    11.2,
    22.3,
    null
  ],
  "overloadIndicator": 11.5,
  "overloadIndicatorAccumulated": 11.5
 },...
]

Pqf.pm.getWorkItemAccumulatedValues(workItemId, beg, end, currency)

Returns the accumulated values for a phase of a scenario

• {workItemId} : The work item's ID

• {beg}? : A time range (begin, inclusive) to filter costs and allocations

• {end}? : A time range (end, exclusive) to filter costs and allocations

• {currency}? : The desired currency to have all money values converted into

Send : None

Receive : ProjectWorkItemAccumulatedValues

{
  "projectWorkItemId": "A7825BDD23E0414D9F337D19F70D0A81",
  "childrenCount": 11,
  "childrenCountAccumulated": 11,
  "costsBudget": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costsBudgetAccumulated": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "costs": {
    "forecasts": [
      {
        "typeGroup": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Sven Müller"
        }
      }
    ],
    "forecastTotal": {
      "planned": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "actual": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "expectedPending": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "remaining": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      }
    },
    "forecast": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    }
  },
  "costsAccumulated": {
    "forecasts": [
      {
        "typeGroup": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Sven Müller"
        }
      }
    ],
    "forecastTotal": {
      "planned": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "actual": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "expectedPending": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      },
      "remaining": {
        "amount": 11.5,
        "currency": "CURRENCY-CHF"
      }
    },
    "forecast": {
      "amount": 11.5,
      "currency": "CURRENCY-CHF"
    }
  },
  "resourceAllocations": "PT10D25H01M13S",
  "resourceAllocationsAccumulated": "PT10D25H01M13S",
  "resourceActuals": "PT10D25H01M13S",
  "resourceActualsAccumulated": "PT10D25H01M13S",
  "timeBudgetAccumulated": "PT10D25H01M13S",
  "timePlannedAccumulated": "PT10D25H01M13S",
  "timeExpectedPending": "PT10D25H01M13S",
  "timeExpectedPendingAccumulated": "PT10D25H01M13S",
  "timeRemaining": "PT10D25H01M13S",
  "timeRemainingAccumulated": "PT10D25H01M13S",
  "errors": "[\"Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen.\"]",
  "errorsAccumulated": "[\"Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen.\"]",
  "progress": 11.5,
  "progressAccumulated": 11.5,
  "manualProgressOverride": [
    11.2,
    22.3,
    null
  ],
  "overloadIndicator": 11.5,
  "overloadIndicatorAccumulated": 11.5
}

Pqf.pm.getScenarioWorkItems(scenarioId, tree, version)

Returns the work items (phases) of a scenario

• {scenarioId} : The project scenario's ID

• {tree}? : Get all recursively (only top-level items, otherwise)

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : ProjectWorkItem[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "phaseType": "PORTFOLIO_MILESTONE",
  "projectId": "A2EC8F59A62D4E77A43A6A924A82C37A",
  "scenarioId": "C51070CF01CC490F831F3D419D6358BD",
  "parentPhaseId": "9E91C2B21678493592299D8766A7429D",
  "startId": "04ADAEF76C8D49DDBDAC1940BC99F940",
  "endId": "A20C093779BF4FE69A7823953BE840B6",
  "sortIndex": [
    11.2,
    22.3,
    null
  ],
  "timeBudget": "PT10D25H01M13S",
  "costsBudget": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "planned": "PT10D25H01M13S",
  "beg": "2020-03-11T10:25:01:13Z",
  "end": "2020-03-11T10:25:01:13Z",
  "fixed": "true",
  "projectCostsPositions": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Sven Müller"
    }
  ],
  "owner": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "isDeleted": "true"
  },
  "requiredSkill": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "isDeleted": "true"
  },
  "color": "B9E497A80D5A404EAED56E0759F9422E",
  "manualProgressOverride": [
    11.2,
    22.3,
    null
  ],
  "projectManagementMethodPhaseId": "D30CD7BA6C5E44EB9EBB31E4860CB544",
  "dependencies": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "fromPhaseId": "9D45E520ECFB4FE2AF5F74351ECDD96E",
      "toPhaseId": "ABEA7AC2855E4D5D943BAC08DF7AB90C",
      "dependencyType": "START_START",
      "minDistance": [
        11,
        12,
        17
      ],
      "maxDistance": [
        11,
        12,
        17
      ]
    }
  ]
 },...
]

Pqf.pm.getProjectScenario(scenarioId, version)

Returns a specific project scenario

• {scenarioId} : The project scenario's ID

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : ProjectScenario

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectId": "3D4579592B404430A93D7504EE7B0A55",
  "status": "3687790A73CC42AE94DDB75B2AD65AD3",
  "owner": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  }
}

Pqf.pm.getProjectScenarioChangesTimeline(scenarioId, beg, end, granularity)

Returns the timeline of changes of a project scenario

• {scenarioId} : The project scenario's ID

• {beg}? : Begin date of the request

• {end}? : End date of the request

• {granularity}? : The granularity of the request

Send : None

Receive : Timeline

{
  "slots": [
    {
      "at": "2020-03-11T10:25:01:13Z",
      "count": 1111111111
    }
  ]
}

Pqf.pm.putProjectScenario(scenarioId, obj)

Updates or creates a project scenario

• {scenarioId} : The project scenario's ID

Send : ProjectScenario

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectId": "3D4579592B404430A93D7504EE7B0A55",
  "status": "3687790A73CC42AE94DDB75B2AD65AD3",
  "owner": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  }
}

Reiceive : None

Pqf.pm.delProjectScenario(scenarioId)

Deletes a project scenario

• {scenarioId} : The project scenario's ID

Send : None

Receive : None

Pqf.pm.getProjectScenarioDependencies(scenarioId, version)

Returns all dependencies belonging to a specific project scenario

• {scenarioId} : The project scenario's ID

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : ProjectDependency[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "constraintType": "MANUAL",
  "predecessorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "predecessorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "successorMilestone": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "position": "2020-03-11",
    "name": "My portfolio milestone",
    "color": "#COFFEE",
    "milestoneType": "MILESTONE"
  },
  "successorMilestoneParents": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "lifecycleState": "0D2F77718EE94E94AC6E64D97E16BEA1"
    }
  ],
  "minDistance": "0",
  "maxDistance": "31"
 },...
]

Pqf.pm.getProjectScenarioMacroAllocations(scenarioId, version)

Returns all macro allocations of a specific project scenario

• {scenarioId} : The project scenario's ID

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : ResourceAllocation[ ]

Pqf.pm.downloadProjectScenario(scenarioId, format)

Exports a specific project scenario into different file formats

• {scenarioId} : The project scenario's ID

• {format}? : The desired file format (required), Possible values: mpx, mspdi, xml, pm

Send : None

Receive : Arbitrary Content

Pqf.pm.getProjectScenarios(projectId)

Returns all scenarios of a project

• {projectId} : The project's ID

Send : None

Receive : ProjectScenario[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "projectId": "3D4579592B404430A93D7504EE7B0A55",
  "status": "3687790A73CC42AE94DDB75B2AD65AD3",
  "owner": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  }
 },...
]

Pqf.pm.getRecentlyDeletedProjectScenarios()

Returns all project scenarios that are in the waste bin

Send : None

Receive : ItemWithDeletedFlagModifiedAtAndParent[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "isDeleted": "true",
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "parent": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  }
 },...
]

Pqf.pm.addProjectScenario(projectId, copy, includeLogs, includeDocumentLinks, includeShiftPlans, includeDependencies, includeAllocations, includePlannedCosts, includeTodoLinks, includeTodos)

Adds a new scenario to a project

• {projectId} : The project's ID

• {copy}? : Specifies a source scenario to be copied, otherwise the template scenario is used

• {includeLogs}? : Copy logs

• {includeDocumentLinks}? : Copy document links

• {includeShiftPlans}? : Copy shift plans

• {includeDependencies}? : Copy dependencies

• {includeAllocations}? : Copy allocations

• {includePlannedCosts}? : Copy planned costs

• {includeTodoLinks}? : Copy todo links

• {includeTodos}? : Copy todos

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.uploadProjectScenario(projectId, format)

Adds a new scenario to a project by uploading a project file (MS Project, MPX, XML, ...)

• {projectId} : The project's ID

• {format}? : The file format to bypass auto detection

Send : Arbitrary Content

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.getProjectSubObjTypes()

Returns all sub object types

Send : None

Receive : Item[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
 },...
]

Pqf.pm.getProjectSubObjs(projectId)

Returns all sub objects for a given project (that the user is permitted to READ)

• {projectId} : The project's ID

Send : None

Receive : SubObject[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.pm.getProjectSubObj(projectId, subObjectType, version)

Returns a specific sub object for a given project (that the user is permitted to READ)

• {projectId} : The project's ID

• {subObjectType} : The sub object's type

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : SubObject

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.pm.putProjectSubObj(projectId, subObjectType, obj)

Updates a specific sub object for a given project (that the user is permitted to READ)

• {projectId} : The project's ID

• {subObjectType} : The sub object's type

Send : SubObject

Reiceive : None

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.pm.getProjectSubObjTimeline(projectId, subObjectType, beg, end, granularity)

Returns a specific sub object for a given project (that the user is permitted to READ)

• {projectId} : The project's ID

• {subObjectType} : The sub object's type

• {beg}? : Begin date of the request

• {end}? : End date of the request

• {granularity}? : The granularity of the request

Send : None

Receive : Timeline

{
  "slots": [
    {
      "at": "2020-03-11T10:25:01:13Z",
      "count": 1111111111
    }
  ]
}

Pqf.pm.getWorkItemSubWorkItems(workItemId, version)

Returns the child work items of a work item

• {workItemId} : The project work item's ID

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : ProjectWorkItem[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "phaseType": "PORTFOLIO_MILESTONE",
  "projectId": "A2EC8F59A62D4E77A43A6A924A82C37A",
  "scenarioId": "C51070CF01CC490F831F3D419D6358BD",
  "parentPhaseId": "9E91C2B21678493592299D8766A7429D",
  "startId": "04ADAEF76C8D49DDBDAC1940BC99F940",
  "endId": "A20C093779BF4FE69A7823953BE840B6",
  "sortIndex": [
    11.2,
    22.3,
    null
  ],
  "timeBudget": "PT10D25H01M13S",
  "costsBudget": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "planned": "PT10D25H01M13S",
  "beg": "2020-03-11T10:25:01:13Z",
  "end": "2020-03-11T10:25:01:13Z",
  "fixed": "true",
  "projectCostsPositions": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Sven Müller"
    }
  ],
  "owner": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "isDeleted": "true"
  },
  "requiredSkill": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "isDeleted": "true"
  },
  "color": "B9E497A80D5A404EAED56E0759F9422E",
  "manualProgressOverride": [
    11.2,
    22.3,
    null
  ],
  "projectManagementMethodPhaseId": "D30CD7BA6C5E44EB9EBB31E4860CB544",
  "dependencies": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "fromPhaseId": "9D45E520ECFB4FE2AF5F74351ECDD96E",
      "toPhaseId": "ABEA7AC2855E4D5D943BAC08DF7AB90C",
      "dependencyType": "START_START",
      "minDistance": [
        11,
        12,
        17
      ],
      "maxDistance": [
        11,
        12,
        17
      ]
    }
  ]
 },...
]

Pqf.pm.addWorkItemSubWorkItem(workItemId)

Adds a new child work item to a work item (providing a template)

• {workItemId} : The project work item's ID

Send : ProjectWorkItem

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "phaseType": "PORTFOLIO_MILESTONE",
  "projectId": "A2EC8F59A62D4E77A43A6A924A82C37A",
  "scenarioId": "C51070CF01CC490F831F3D419D6358BD",
  "parentPhaseId": "9E91C2B21678493592299D8766A7429D",
  "startId": "04ADAEF76C8D49DDBDAC1940BC99F940",
  "endId": "A20C093779BF4FE69A7823953BE840B6",
  "sortIndex": [
    11.2,
    22.3,
    null
  ],
  "timeBudget": "PT10D25H01M13S",
  "costsBudget": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "planned": "PT10D25H01M13S",
  "beg": "2020-03-11T10:25:01:13Z",
  "end": "2020-03-11T10:25:01:13Z",
  "fixed": "true",
  "projectCostsPositions": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Sven Müller"
    }
  ],
  "owner": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "isDeleted": "true"
  },
  "requiredSkill": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "isDeleted": "true"
  },
  "color": "B9E497A80D5A404EAED56E0759F9422E",
  "manualProgressOverride": [
    11.2,
    22.3,
    null
  ],
  "projectManagementMethodPhaseId": "D30CD7BA6C5E44EB9EBB31E4860CB544",
  "dependencies": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "fromPhaseId": "9D45E520ECFB4FE2AF5F74351ECDD96E",
      "toPhaseId": "ABEA7AC2855E4D5D943BAC08DF7AB90C",
      "dependencyType": "START_START",
      "minDistance": [
        11,
        12,
        17
      ],
      "maxDistance": [
        11,
        12,
        17
      ]
    }
  ]
}

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.getWorkItem(workItemId, version)

Returns a project work item

• {workItemId} : The project work item's ID

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : ProjectWorkItem

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "phaseType": "PORTFOLIO_MILESTONE",
  "projectId": "A2EC8F59A62D4E77A43A6A924A82C37A",
  "scenarioId": "C51070CF01CC490F831F3D419D6358BD",
  "parentPhaseId": "9E91C2B21678493592299D8766A7429D",
  "startId": "04ADAEF76C8D49DDBDAC1940BC99F940",
  "endId": "A20C093779BF4FE69A7823953BE840B6",
  "sortIndex": [
    11.2,
    22.3,
    null
  ],
  "timeBudget": "PT10D25H01M13S",
  "costsBudget": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "planned": "PT10D25H01M13S",
  "beg": "2020-03-11T10:25:01:13Z",
  "end": "2020-03-11T10:25:01:13Z",
  "fixed": "true",
  "projectCostsPositions": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Sven Müller"
    }
  ],
  "owner": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "isDeleted": "true"
  },
  "requiredSkill": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "isDeleted": "true"
  },
  "color": "B9E497A80D5A404EAED56E0759F9422E",
  "manualProgressOverride": [
    11.2,
    22.3,
    null
  ],
  "projectManagementMethodPhaseId": "D30CD7BA6C5E44EB9EBB31E4860CB544",
  "dependencies": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "fromPhaseId": "9D45E520ECFB4FE2AF5F74351ECDD96E",
      "toPhaseId": "ABEA7AC2855E4D5D943BAC08DF7AB90C",
      "dependencyType": "START_START",
      "minDistance": [
        11,
        12,
        17
      ],
      "maxDistance": [
        11,
        12,
        17
      ]
    }
  ]
}

Pqf.pm.putWorkItem(workItemId, updateDependencies, obj)

Updates a project work item

• {workItemId} : The project work item's ID

• {updateDependencies}? : Update dependencies to other work items

Send : ProjectWorkItem

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "phaseType": "PORTFOLIO_MILESTONE",
  "projectId": "A2EC8F59A62D4E77A43A6A924A82C37A",
  "scenarioId": "C51070CF01CC490F831F3D419D6358BD",
  "parentPhaseId": "9E91C2B21678493592299D8766A7429D",
  "startId": "04ADAEF76C8D49DDBDAC1940BC99F940",
  "endId": "A20C093779BF4FE69A7823953BE840B6",
  "sortIndex": [
    11.2,
    22.3,
    null
  ],
  "timeBudget": "PT10D25H01M13S",
  "costsBudget": {
    "amount": 11.5,
    "currency": "CURRENCY-CHF"
  },
  "planned": "PT10D25H01M13S",
  "beg": "2020-03-11T10:25:01:13Z",
  "end": "2020-03-11T10:25:01:13Z",
  "fixed": "true",
  "projectCostsPositions": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Sven Müller"
    }
  ],
  "owner": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "isDeleted": "true"
  },
  "requiredSkill": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11",
    "isDeleted": "true"
  },
  "color": "B9E497A80D5A404EAED56E0759F9422E",
  "manualProgressOverride": [
    11.2,
    22.3,
    null
  ],
  "projectManagementMethodPhaseId": "D30CD7BA6C5E44EB9EBB31E4860CB544",
  "dependencies": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "fromPhaseId": "9D45E520ECFB4FE2AF5F74351ECDD96E",
      "toPhaseId": "ABEA7AC2855E4D5D943BAC08DF7AB90C",
      "dependencyType": "START_START",
      "minDistance": [
        11,
        12,
        17
      ],
      "maxDistance": [
        11,
        12,
        17
      ]
    }
  ]
}

Reiceive : None

Pqf.pm.delWorkItem(workItemId)

Deletes a project work item

• {workItemId} : The project work item's ID

Send : None

Receive : None

Pqf.pm.getWorkItemLogs(workItemId)

Returns all logs for a specific work item

• {workItemId} : The project work item's ID

Send : None

Receive : Log[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  }
 },...
]

Pqf.pm.getWorkItemLog(workItemId, logId)

Returns a specific log for a specific work item

• {workItemId} : The project work item's ID

• {logId} : The log's ID

Send : None

Receive : Log

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  }
}

Pqf.pm.getWorkItemLogParent(logId)

Returns a reference to the parent of a specific work item log

• {logId} : The log's ID

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.putWorkItemLog(workItemId, logId, obj)

Updates or creates a specific log for a specific work item

• {workItemId} : The project work item's ID

• {logId} : The log's ID

Send : Log

Reiceive : None

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  }
}

Pqf.pm.delWorkItemLog(workItemId, logId)

Deletes a specific log for a specific work item

• {workItemId} : The project work item's ID

• {logId} : The log's ID

Send : None

Receive : None

Pqf.pm.addWorkItemMacroAllocation(workItemId, argid, amount, amountUnit, amountType)

Adds a new macro allocation to a work item

• {workItemId} : The project work item's ID

• {argid}? : The resource ID the macro allocation should be linked to (required)

• {amount}? : The amount

• {amountUnit}? : The unit of the amount

• {amountType}? : What the amount is related to (ABSOLUTE, OF_CAPACITY, OF_AVAILABILITY, OF_FTE, OF_PHASE)

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.pm.delWorkItemMacroAllocation(workItemId, refid)

Deletes a macro allocation from a work item

• {workItemId} : The project work item's ID

• {refid}? : The resource ID whose macro allocation should be deleted (required)

Send : None

Receive : None

Pqf.pm.getWorkItemMacroAllocations(workItemId, version)

Returns the macro allocations of a specific work item

• {workItemId} : The project work item's ID

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : ResourceAllocation[ ]

Pqf.pm.getWorkItemProject(workItemId)

Returns the project a specific work item belongs to

• {workItemId} : The project work item's ID

Send : None

Receive : Project

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "status": "5F9B9831C7704DDFAABF7580129AB8F2",
  "portfolios": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Project X",
      "code": "PRJ-X",
      "description": "<p>This was the development name of <b>PQFORCE</b></p>",
      "iconRef": "/images/lifecycle/planning.png",
      "color": "blue",
      "validityStart": "2020-03-11",
      "validityUntil": "2020-03-11"
    }
  ],
  "classification": [
    {
      "classificationSchemaId": "291ABC133A554A9F9CC7E5EF7654FDD7",
      "data": [
        {
          "attributeId": "41A649C11AF54F89A87A084E932A3D8D",
          "valueId": "EA2BEA4D58D44AE08D4674399F25E299",
          "description": "As we have realized similar projects in the near past quite a few times, the costs are estimated quite accurate."
        }
      ],
      "classificationId": "41D3A3705A4749038F2154B757ED3577",
      "score": [
        11.2,
        22.3,
        null
      ]
    }
  ]
}

Pqf.pm.splitWorkItem(workItemId, at)

Splits a work item into two pieces

• {workItemId} : The project work item's ID

• {at}? : The point in time where the phase should be split (required, will be rounded to nex midnight)

Send : None

Receive : None

Pqf.pm.getWorkItemShiftPlan(workItemId)

Returns the planned shifts for a specific work item

• {workItemId} : The project work item's ID

Send : None

Receive : ShiftPlan

{
  "shifts": [
    {
      "shift": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Name of this resource shift.",
        "description": "Description..",
        "imageUrl": "example.svg",
        "color": "blue",
        "duration": "PT10D25H01M13S",
        "begTime": "PT10D25H01M13S",
        "endTime": "PT10D25H01M13S"
      },
      "pattern": "true"
    }
  ]
}

Pqf.pm.putWorkItemShiftPlan(workItemId, obj)

Updates the planned shifts for a specific work item

• {workItemId} : The project work item's ID

Send : ShiftPlan

{
  "shifts": [
    {
      "shift": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Name of this resource shift.",
        "description": "Description..",
        "imageUrl": "example.svg",
        "color": "blue",
        "duration": "PT10D25H01M13S",
        "begTime": "PT10D25H01M13S",
        "endTime": "PT10D25H01M13S"
      },
      "pattern": "true"
    }
  ]
}

Reiceive : None

Pqf.pm.delWorkItemShiftPlan(workItemId)

Deletes the planned shifts for a specific work item

• {workItemId} : The project work item's ID

Send : None

Receive : None

Pqf.pm.assignWorkItemShiftPlan(workItemId, res, force)

Assigns the planned shifts of a specific work item to a resource

• {workItemId} : The project work item's ID

• {res}? : The resource's ID (required)

• {force}? : Forces the assignment and overwrites existing reservations

Send : None

Receive : None

Pqf.pm.delMicroAllocations(workItemId, res)

Deletes all micro allocations of a specific work item on a specific resource

• {workItemId} : The project work item's ID

• {res}? : The resource's ID (required)

Send : None

Receive : None

Pqf.pm.getIndicatorDetailDefs(projectReportTypeId)

Returns the definitions of the indicator details (single position) in the user's language

• {projectReportTypeId} : The project report type

Send : None

Receive : IndicatorDetailDef[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "projectReportTypeId": "ProjectReport",
  "name": "Indicator detail name..",
  "description": "Indicator detail description..",
  "iconRef": "icon.svg",
  "code": "ABC",
  "color": "red",
  "valueType": {
    "basetype": "number",
    "properties": [
      {
        "key": "digits",
        "value": "2"
      }
    ]
  },
  "inputActual": "HIDDEN",
  "inputRemaining": "HIDDEN",
  "inputForecast": "HIDDEN",
  "statusClassId": "PM-IND-STATUS-GENERIC",
  "trendClassId": "PM-IND-TREND-GENERIC",
  "dimension": "958F8441DCE9434BBA1800E279FDE18B",
  "semantics": "COSTS",
  "accumulation": "SUM",
  "projectManagementMethodPhase": "C238C0B76AA2479E86EAA3A98A21383A",
  "sortIndex": 11.5
 },...
]

Pqf.pm.getIndicatorDetailDef(projectReportTypeId, detailId)

Returns a specific definition of an indicator detail (single position) in the user's language

• {projectReportTypeId} : The project report type

• {detailId} : The indicator detail's ID

Send : None

Receive : IndicatorDetailDef

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "projectReportTypeId": "ProjectReport",
  "name": "Indicator detail name..",
  "description": "Indicator detail description..",
  "iconRef": "icon.svg",
  "code": "ABC",
  "color": "red",
  "valueType": {
    "basetype": "number",
    "properties": [
      {
        "key": "digits",
        "value": "2"
      }
    ]
  },
  "inputActual": "HIDDEN",
  "inputRemaining": "HIDDEN",
  "inputForecast": "HIDDEN",
  "statusClassId": "PM-IND-STATUS-GENERIC",
  "trendClassId": "PM-IND-TREND-GENERIC",
  "dimension": "958F8441DCE9434BBA1800E279FDE18B",
  "semantics": "COSTS",
  "accumulation": "SUM",
  "projectManagementMethodPhase": "C238C0B76AA2479E86EAA3A98A21383A",
  "sortIndex": 11.5
}

Pqf.pm.getIndicatorIntlDetailDef(projectReportTypeId, detailId)

Returns a specific definition of an indicator detail (single position) with translations

• {projectReportTypeId} : The project report type

• {detailId} : The indicator detail's ID

Send : None

Receive : IndicatorDetailDefTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "projectReportTypeId": "ProjectReport",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJX",
  "color": "red",
  "aggregationRule": "Milestone(M1)",
  "statusClassId": "PM-IND-STATUS-GENERIC",
  "trendClassId": "PM-IND-TREND-GENERIC",
  "dimension": "DIM1",
  "sortIndex": 11.5
}

Pqf.pm.putIndicatorIntlDetailDef(projectReportTypeId, detailId, obj)

Updates a specific definition of an indicator detail (single position) with translations

• {projectReportTypeId} : The project report type

• {detailId} : The indicator detail's ID

Send : IndicatorDetailDefTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "projectReportTypeId": "ProjectReport",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJX",
  "color": "red",
  "aggregationRule": "Milestone(M1)",
  "statusClassId": "PM-IND-STATUS-GENERIC",
  "trendClassId": "PM-IND-TREND-GENERIC",
  "dimension": "DIM1",
  "sortIndex": 11.5
}

Reiceive : None

Pqf.pm.delIndicatorIntlDetailDef(projectReportTypeId, detailId)

Deletes a specific definition of an indicator detail (single position)

• {projectReportTypeId} : The project report type

• {detailId} : The indicator detail's ID

Send : None

Receive : None

Pqf.pm.getIndicatorDimensionDefs(projectReportTypeId)

Returns the definitions of the indicator dimensions (position summaries) in the user's language

• {projectReportTypeId} : The project report type

Send : None

Receive : IndicatorDimensionDef[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "projectReportTypeId": "ProjectReport",
  "name": "Indicator dimension name..",
  "description": "Indicator dimension description..",
  "iconRef": "icon.svg",
  "code": "ABC",
  "color": "red",
  "statusClassId": "PM-IND-STATUS-GENERIC",
  "trendClassId": "PM-IND-TREND-GENERIC",
  "sortIndex": 11.5
 },...
]

Pqf.pm.getIndicatorDimensionDef(projectReportTypeId, dimensionId)

Returns a specific definition of an indicator dimension (position summaries) in the user's language

• {projectReportTypeId} : The project report type

• {dimensionId} : The indicator dimension's ID

Send : None

Receive : IndicatorDimensionDef

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "projectReportTypeId": "ProjectReport",
  "name": "Indicator dimension name..",
  "description": "Indicator dimension description..",
  "iconRef": "icon.svg",
  "code": "ABC",
  "color": "red",
  "statusClassId": "PM-IND-STATUS-GENERIC",
  "trendClassId": "PM-IND-TREND-GENERIC",
  "sortIndex": 11.5
}

Pqf.pm.getIndicatorIntlDimensionDef(projectReportTypeId, dimensionId)

Returns a specific definition of an indicator dimension (position summaries) with translations

• {projectReportTypeId} : The project report type

• {dimensionId} : The indicator dimension's ID

Send : None

Receive : IndicatorDimensionDefTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "projectReportTypeId": "ProjectReport",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "ABC",
  "color": "red",
  "statusClassId": "PM-IND-STATUS-GENERIC",
  "trendClassId": "PM-IND-TREND-GENERIC",
  "sortIndex": 11.5
}

Pqf.pm.putIndicatorIntlDimensionDef(projectReportTypeId, dimensionId, obj)

Updates a specific definition of an indicator dimension (position summaries) with translations

• {projectReportTypeId} : The project report type

• {dimensionId} : The indicator dimension's ID

Send : IndicatorDimensionDefTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "projectReportTypeId": "ProjectReport",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "ABC",
  "color": "red",
  "statusClassId": "PM-IND-STATUS-GENERIC",
  "trendClassId": "PM-IND-TREND-GENERIC",
  "sortIndex": 11.5
}

Reiceive : None

Pqf.pm.delIndicatorIntlDimensionDef(projectReportTypeId, dimensionId)

Deletes a specific definition of an indicator dimension (position summaries)

• {projectReportTypeId} : The project report type

• {dimensionId} : The indicator dimension's ID

Send : None

Receive : None

Pqf.pm.getIndicatorClassifications()

Returns all indicator classification schemes

Send : None

Receive : IndicatorClassificationScheme[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Traffic lights",
  "description": "Indicator classification with RED / YELLOW / GREEN",
  "iconRef": "icon.svg",
  "code": "XYZ",
  "color": "red",
  "values": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "OK",
      "description": "Everything as it should 😉",
      "iconRef": "icon.svg",
      "code": "PRJY",
      "color": "red",
      "valueStart": 11.5,
      "rating": 11.5
    }
  ]
 },...
]

Pqf.pm.getIndicatorClassification(classificationId)

Returns a specific indicator classification scheme

• {classificationId} : The indicator classification's ID

Send : None

Receive : IndicatorClassificationScheme

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Traffic lights",
  "description": "Indicator classification with RED / YELLOW / GREEN",
  "iconRef": "icon.svg",
  "code": "XYZ",
  "color": "red",
  "values": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "OK",
      "description": "Everything as it should 😉",
      "iconRef": "icon.svg",
      "code": "PRJY",
      "color": "red",
      "valueStart": 11.5,
      "rating": 11.5
    }
  ]
}

Pqf.pm.getIndicatorClassificationValue(classificationId)

Returns a specific indicator classification value in the user's language

• {classificationId} : The indicator classification value's ID

Send : None

Receive : IndicatorClassificationSchemeValue

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "OK",
  "description": "Everything as it should 😉",
  "iconRef": "icon.svg",
  "code": "PRJY",
  "color": "red",
  "valueStart": 11.5,
  "rating": 11.5
}

Pqf.pm.getIndicatorIntlClassification(classificationId)

Returns a specific indicator classification with translations

• {classificationId} : The indicator classification value's ID

Send : None

Receive : IndicatorClassificationSchemeTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "ASDF",
  "color": "red",
  "values": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "description": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "iconRef": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "code": "ABC",
      "color": "red",
      "valueStart": 11.5,
      "rating": 11.5
    }
  ]
}

Pqf.pm.putIndicatorIntlClassification(classificationId, obj)

Updates a specific indicator classification with translations

• {classificationId} : The indicator classification value's ID

Send : IndicatorClassificationSchemeTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "ASDF",
  "color": "red",
  "values": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "description": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "iconRef": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "code": "ABC",
      "color": "red",
      "valueStart": 11.5,
      "rating": 11.5
    }
  ]
}

Reiceive : None

Pqf.pm.delIndicatorIntlClassification(classificationId)

Deletes a specific indicator classification

• {classificationId} : The indicator classification value's ID

Send : None

Receive : None

Pqf.pm.getIndicatorSelections(projectId, projectReportTypeId)

Returns the currently selected indicators for a given project

• {projectId} : The project's ID

• {projectReportTypeId} : The project report type

Send : None

Receive : IndicatorSelections

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "dimensions": [
    {
      "dimension": "FD030594F78D4DA88DDF8EE573650C00",
      "showValues": "true",
      "showRiskEstimation": "true",
      "isLeading": "true",
      "remark": "Do not spend too much time on these indicators as they're not so important",
      "details": [
        {
          "typeId": "66BE84A8A5624CEBB8316C284E754C38",
          "targetValue": "55",
          "showValues": "true",
          "projectSpecificName": "Concept done",
          "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
          "createdAt": "2020-03-11T10:25:01:13Z",
          "createdBy": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "modifiedAt": "2020-03-11T10:25:01:13Z",
          "modifiedBy": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "version": "029335F8E37A45758C3B6235863F4BA8",
          "historic": "true"
        }
      ],
      "isReportExport": "true"
    }
  ]
}

Pqf.pm.putIndicatorSelections(projectId, projectReportTypeId, obj)

Updates the currently selected indicators for a given project

• {projectId} : The project's ID

• {projectReportTypeId} : The project report type

Send : IndicatorSelections

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "dimensions": [
    {
      "dimension": "FD030594F78D4DA88DDF8EE573650C00",
      "showValues": "true",
      "showRiskEstimation": "true",
      "isLeading": "true",
      "remark": "Do not spend too much time on these indicators as they're not so important",
      "details": [
        {
          "typeId": "66BE84A8A5624CEBB8316C284E754C38",
          "targetValue": "55",
          "showValues": "true",
          "projectSpecificName": "Concept done",
          "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
          "createdAt": "2020-03-11T10:25:01:13Z",
          "createdBy": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "modifiedAt": "2020-03-11T10:25:01:13Z",
          "modifiedBy": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Project X",
            "code": "PRJ-X",
            "description": "<p>This was the development name of <b>PQFORCE</b></p>",
            "iconRef": "/images/lifecycle/planning.png",
            "color": "blue",
            "validityStart": "2020-03-11",
            "validityUntil": "2020-03-11"
          },
          "version": "029335F8E37A45758C3B6235863F4BA8",
          "historic": "true"
        }
      ],
      "isReportExport": "true"
    }
  ]
}

Reiceive : None

Pqf.pm.getIndicatorSelectionDetail(projectId, projectReportTypeId, detid)

Returns details about a specific, currently selected indicator for a given project

• {projectId} : The project's ID

• {projectReportTypeId} : The project report type

• {detid} : The indicator detail's ID

Send : None

Receive : IndicatorDetailSelection

{
  "typeId": "66BE84A8A5624CEBB8316C284E754C38",
  "targetValue": "55",
  "showValues": "true",
  "projectSpecificName": "Concept done",
  "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true"
}

Pqf.pm.getIndicatorSelectionDetailTimeline(projectId, projectReportTypeId, detid, beg, end, granularity)

Returns the timeline (timestamps of changes) of details about a specific, currently selected indicator for a given project

• {projectId} : The project's ID

• {projectReportTypeId} : The project report type

• {detid} : The indicator detail's ID

• {beg}? : Begin date of the request

• {end}? : End date of the request

• {granularity}? : The granularity of the request

Send : None

Receive : Timeline

{
  "slots": [
    {
      "at": "2020-03-11T10:25:01:13Z",
      "count": 1111111111
    }
  ]
}

Pqf.pm.getIndicatorSelectionDetailHistory(projectId, projectReportTypeId, detid, beg, end, granularity)

Returns the historic details about a specific, currently selected indicator for a given project

• {projectId} : The project's ID

• {projectReportTypeId} : The project report type

• {detid} : The indicator detail's ID

• {beg}? : Begin date of the request

• {end}? : End date of the request

• {granularity}? : The granularity of the request

Send : None

Receive : IndicatorDetailSelectionHistory

{
  "history": [
    {
      "at": "2020-03-11T10:25:01:13Z",
      "obj": {
        "typeId": "66BE84A8A5624CEBB8316C284E754C38",
        "targetValue": "55",
        "showValues": "true",
        "projectSpecificName": "Concept done",
        "remark": "This indicator should be estimated by using the scheme in the project guideline book, page 198",
        "createdAt": "2020-03-11T10:25:01:13Z",
        "createdBy": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "modifiedAt": "2020-03-11T10:25:01:13Z",
        "modifiedBy": {
          "type": "AnyTypeOfObj",
          "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
          "name": "Project X",
          "code": "PRJ-X",
          "description": "<p>This was the development name of <b>PQFORCE</b></p>",
          "iconRef": "/images/lifecycle/planning.png",
          "color": "blue",
          "validityStart": "2020-03-11",
          "validityUntil": "2020-03-11"
        },
        "version": "029335F8E37A45758C3B6235863F4BA8",
        "historic": "true"
      }
    }
  ]
}

Pqf.res.addResourceChild(parentResourceId, linkType)

Adds a new resource to the given parent link type

• {parentResourceId} : The parent resource's ID

• {linkType}? : The link type to use to add a child

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.res.getResource(resourceId, version)

Read and return a resource by its ID

• {resourceId} : The resource's ID

• {version}? : Retrieve a historic version (current version, if not specified)

Send : None

Receive : Resource

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "eMail": "a.b@c.d"
}

Pqf.res.putResource(resourceId, obj)

Update/create a resource

• {resourceId} : The resource's ID

Send : Resource

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "eMail": "a.b@c.d"
}

Reiceive : None

Pqf.res.delResource(resourceId, recursive)

Delete a resource

• {resourceId} : The resource's ID

• {recursive}? : allow recursive deletion of sub resources

Send : None

Receive : None

Pqf.res.getRecentlyDeletedResources()

Returns all resources that are in the waste bin

Send : None

Receive : ItemWithDeletedFlagModifiedAtAndParent[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "isDeleted": "true",
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "parent": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  }
 },...
]

Pqf.res.getResourceIdentification(resourceId)

Read resource identification by its ID

• {resourceId} : The resource's ID

Send : None

Receive : ItemWithAncestors

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "ancestors": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "linkType": "",
      "linkId": "13C54F8BBFD84C17B6F863A3F17035B1",
      "linkValidityStart": "2020-03-11",
      "linkValidityUntil": "2020-03-11"
    }
  ]
}

Pqf.res.getResourceChildren(resourceId)

Read resource's children

• {resourceId} : The resource's ID

Send : None

Receive : Resource[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "eMail": "a.b@c.d"
 },...
]

Pqf.res.getResourceChildrenIdentification(resourceId)

Read resource's children's identification

• {resourceId} : The resource's ID

Send : None

Receive : ItemWithAncestors[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "ancestors": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "linkType": "",
      "linkId": "13C54F8BBFD84C17B6F863A3F17035B1",
      "linkValidityStart": "2020-03-11",
      "linkValidityUntil": "2020-03-11"
    }
  ]
 },...
]

Pqf.res.getResourceAncestors(resourceId, deleted)

Read resource's ancestors

• {resourceId} : The resource's ID

• {deleted}? : Allow the referenced resource to be deleted

Send : None

Receive : Resource[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "eMail": "a.b@c.d"
 },...
]

Pqf.res.getResourceTimeline(resourceId, beg, end, granularity)

Returns the timeline of a resource

• {resourceId} : The resource's ID

• {beg}? : Begin date of the request

• {end}? : End date of the request

• {granularity}? : The granularity of the request

Send : None

Receive : Timeline

{
  "slots": [
    {
      "at": "2020-03-11T10:25:01:13Z",
      "count": 1111111111
    }
  ]
}

Pqf.res.getAvailabilities(resourceId)

Read resource's availabilities

• {resourceId} : The resource's ID

Send : None

Receive : Availability[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "definedOn": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "inheritFromParent": "true",
  "inheritedFrom": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "validAfter": "2020-03-11",
  "holidayLocaleId": "3AB82153158E457C909D0DFE67CB4EE2",
  "models": [
    {
      "shift": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Name of this resource shift.",
        "description": "Description..",
        "imageUrl": "example.svg",
        "color": "blue",
        "duration": "PT10D25H01M13S",
        "begTime": "PT10D25H01M13S",
        "endTime": "PT10D25H01M13S"
      },
      "presencePerDay": [
        {
          "presence": "true",
          "duration": "PT10D25H01M13S"
        }
      ]
    }
  ],
  "basicLoadPercent": 11,
  "costPerHour": 11.5,
  "costCurrency": "CHF",
  "description": "",
  "ftePercent": 11,
  "standardAvails": "PT10D25H01M13S"
 },...
]

Pqf.res.getAvailabilitiesByResource(resourceIds)

Read resource's availabilities

• {resourceIds} : The resource's IDs

Send : None

Receive : AvailabilitiesByResource[ ]

[
 {
  "resource": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "availabilities": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "definedOn": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
      },
      "inheritFromParent": "true",
      "inheritedFrom": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
      },
      "validAfter": "2020-03-11",
      "holidayLocaleId": "3AB82153158E457C909D0DFE67CB4EE2",
      "models": [
        {
          "shift": {
            "type": "AnyTypeOfObj",
            "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
            "name": "Name of this resource shift.",
            "description": "Description..",
            "imageUrl": "example.svg",
            "color": "blue",
            "duration": "PT10D25H01M13S",
            "begTime": "PT10D25H01M13S",
            "endTime": "PT10D25H01M13S"
          },
          "presencePerDay": [
            {
              "presence": "true",
              "duration": "PT10D25H01M13S"
            }
          ]
        }
      ],
      "basicLoadPercent": 11,
      "costPerHour": 11.5,
      "costCurrency": "CHF",
      "description": "",
      "ftePercent": 11,
      "standardAvails": "PT10D25H01M13S"
    }
  ]
 },...
]

Pqf.res.getAvailability(resourceId, availabilityId)

Read resource's availability by ID

• {resourceId} : The resource's ID

• {availabilityId} : The availability's ID

Send : None

Receive : Availability

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "definedOn": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "inheritFromParent": "true",
  "inheritedFrom": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "validAfter": "2020-03-11",
  "holidayLocaleId": "3AB82153158E457C909D0DFE67CB4EE2",
  "models": [
    {
      "shift": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Name of this resource shift.",
        "description": "Description..",
        "imageUrl": "example.svg",
        "color": "blue",
        "duration": "PT10D25H01M13S",
        "begTime": "PT10D25H01M13S",
        "endTime": "PT10D25H01M13S"
      },
      "presencePerDay": [
        {
          "presence": "true",
          "duration": "PT10D25H01M13S"
        }
      ]
    }
  ],
  "basicLoadPercent": 11,
  "costPerHour": 11.5,
  "costCurrency": "CHF",
  "description": "",
  "ftePercent": 11,
  "standardAvails": "PT10D25H01M13S"
}

Pqf.res.putAvailability(resourceId, availabilityId, obj)

Update/create a resource's availability by ID

• {resourceId} : The resource's ID

• {availabilityId} : The availability's ID

Send : Availability

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "definedOn": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "inheritFromParent": "true",
  "inheritedFrom": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "validAfter": "2020-03-11",
  "holidayLocaleId": "3AB82153158E457C909D0DFE67CB4EE2",
  "models": [
    {
      "shift": {
        "type": "AnyTypeOfObj",
        "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
        "name": "Name of this resource shift.",
        "description": "Description..",
        "imageUrl": "example.svg",
        "color": "blue",
        "duration": "PT10D25H01M13S",
        "begTime": "PT10D25H01M13S",
        "endTime": "PT10D25H01M13S"
      },
      "presencePerDay": [
        {
          "presence": "true",
          "duration": "PT10D25H01M13S"
        }
      ]
    }
  ],
  "basicLoadPercent": 11,
  "costPerHour": 11.5,
  "costCurrency": "CHF",
  "description": "",
  "ftePercent": 11,
  "standardAvails": "PT10D25H01M13S"
}

Reiceive : None

Pqf.res.delAvailability(resourceId, availabilityId)

Delete a resource's availability by ID

• {resourceId} : The resource's ID

• {availabilityId} : The availability's ID

Send : None

Receive : None

Pqf.res.getResources()

Read all resources of any resource type

Send : None

Receive : Resource[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "eMail": "a.b@c.d"
 },...
]

Pqf.res.getResourceHierarchy()

Read all resources of any resource type

Send : None

Receive : ItemWithAncestors[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "ancestors": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "linkType": "",
      "linkId": "13C54F8BBFD84C17B6F863A3F17035B1",
      "linkValidityStart": "2020-03-11",
      "linkValidityUntil": "2020-03-11"
    }
  ]
 },...
]

Pqf.res.addResourceLink(fromId, linkType, toId)

Add link to the given resource

• {fromId} : The from resource's ID

• {linkType}? : The link type ID

• {toId}? : The to resource's ID

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.res.getResourceLink(linkType, linkId)

Returns a link between two resources (i.e. membership of an employee in an organization unit)

• {linkType} : The link type ID

• {linkId} : The linked resource ID

Send : None

Receive : VersionedDetails

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.res.putResourceLink(linkType, linkId, obj)

Updates a link between two resources (i.e. membership of an employee in an organization unit)

• {linkType} : The link type ID

• {linkId} : The linked resource ID

Send : VersionedDetails

Reiceive : None

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.res.delResourceLink(linkType, linkId)

Deletes a link between two resources (i.e. membership of an employee in an organization unit)

• {linkType} : The link type ID

• {linkId} : The linked resource ID

Send : None

Receive : None

Pqf.res.getResourceLinkTypes()

Returns all types of resource links that are available

Send : None

Receive : ResourceLinkType[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "fromResourceTypeId": "C2238C5A51364E4FAADDFB97F8165EE0",
  "toResourceTypeId": "42007EE0E00C4C079934E8C06D3C285A",
  "name": "Name of this resource link type.",
  "nameReverse": "Backwards name of this resource link type.",
  "description": "<p>This is a description</p>",
  "iconRef": "/images/type_emp.png",
  "color": "blue",
  "isHard": "true",
  "targetObjectNeedsParentPermission": "true",
  "targetObjectInheritRelations": "true",
  "implicitRelationId": "92405555E8325390AE0D355E58A83DEF"
 },...
]

Pqf.res.getResourceLinkType(linkTypeId)

Returns a specific type of resource link

• {linkTypeId} : The resource's type ID

Send : None

Receive : ResourceLinkType

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "fromResourceTypeId": "C2238C5A51364E4FAADDFB97F8165EE0",
  "toResourceTypeId": "42007EE0E00C4C079934E8C06D3C285A",
  "name": "Name of this resource link type.",
  "nameReverse": "Backwards name of this resource link type.",
  "description": "<p>This is a description</p>",
  "iconRef": "/images/type_emp.png",
  "color": "blue",
  "isHard": "true",
  "targetObjectNeedsParentPermission": "true",
  "targetObjectInheritRelations": "true",
  "implicitRelationId": "92405555E8325390AE0D355E58A83DEF"
}

Pqf.res.getResourceTypes()

Returns all types of resource that are available

Send : None

Receive : ResourceType[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Name of this resource type.",
  "resourceGroupeId": "8692805B95184F6B82FF1E35AB8DE680",
  "costsTypeId": "B629E733280D45DEB0E807E09DD399D6",
  "resourceKind": "RES-KIND-ABSTRACT"
 },...
]

Pqf.res.getResourceType(typeId)

Returns a specific type of resource

• {typeId} : The resource's type ID

Send : None

Receive : ResourceType

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Name of this resource type.",
  "resourceGroupeId": "8692805B95184F6B82FF1E35AB8DE680",
  "costsTypeId": "B629E733280D45DEB0E807E09DD399D6",
  "resourceKind": "RES-KIND-ABSTRACT"
}

Pqf.res.getResourcesByType(typeId)

Returns all resources of a given type

• {typeId} : The resource's type ID

Send : None

Receive : Resource[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "eMail": "a.b@c.d"
 },...
]

Pqf.res.getResourcesByTypes(typeIds)

Returns all resources of a given type

• {typeIds} : The resource's type IDs

Send : None

Receive : Resource[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "eMail": "a.b@c.d"
 },...
]

Pqf.res.getResourceHierarchyByType(typeId)

Returns all resources of a given type with ancestor information

• {typeId} : The resource's type ID

Send : None

Receive : ItemWithAncestors[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "ancestors": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "linkType": "",
      "linkId": "13C54F8BBFD84C17B6F863A3F17035B1",
      "linkValidityStart": "2020-03-11",
      "linkValidityUntil": "2020-03-11"
    }
  ]
 },...
]

Pqf.res.getResourceGroups()

Returns all resource groups

Send : None

Receive : ResourceGroup[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "HRM",
  "description": "Human Resource Management",
  "imageUrl": "../images/ResourceGroup1.jpg",
  "rootResource": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  }
 },...
]

Pqf.res.getResourceGroup(groupId)

Returns a specific resource group

• {groupId} : The resource group's ID

Send : None

Receive : ResourceGroup

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "HRM",
  "description": "Human Resource Management",
  "imageUrl": "../images/ResourceGroup1.jpg",
  "rootResource": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  }
}

Pqf.res.getResourcesByGroup(groupId)

Returns all resources of a given group

• {groupId} : The resource group's ID

Send : None

Receive : Item[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
 },...
]

Pqf.res.getResourceGroupWorktimeUnits(groupId)

Returns all worktime units that apply for a certain group of resources

• {groupId} : The resource group's ID

Send : None

Receive : Unit[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "abbr": "h",
  "name": "Stunden"
 },...
]

Pqf.res.getResourceGroupWorktimeUnitFactors(groupId)

Returns the individual factors for worktime conversions for a given resource group (infrastructure works 24h a day, humans don't)

• {groupId} : The resource group's ID

Send : None

Receive : UnitFactor[ ]

[
 {
  "unit": "H",
  "factor": "⅐"
 },...
]

Pqf.res.getResourceKinds()

Returns the different kinds of resources that may have been configured

Send : None

Receive : NamedReference[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Sven Müller"
 },...
]

Pqf.res.getResourceKind(kindId)

Returns a given resource kind

• {kindId} : The resource kind's ID

Send : None

Receive : NamedReference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Sven Müller"
}

Pqf.res.getResourcesByKind(kindId)

Returns all resources of a given kind

• {kindId} : The resource kind's ID

Send : None

Receive : Item[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
 },...
]

Pqf.res.getResourcesByKinds(kindIds)

Returns all resources of multiple kinds given

• {kindIds} : The resource kind's IDs

Send : None

Receive : Item[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
 },...
]

Pqf.res.getHolidayLocales()

Returns all holiday locales

Send : None

Receive : VersionedItem[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
 },...
]

Pqf.res.addHolidayLocale(copyFromId)

Adds a new holiday locale

• {copyFromId}? : Locale ID to create a copy from

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.res.getHolidayLocale(locid)

Returns a single holiday locale

• {locid} : The holiday locale

Send : None

Receive : VersionedItem

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
}

Pqf.res.putHolidayLocale(locid, obj)

Updates or creates a holiday locale

• {locid} : The holiday locale

Send : VersionedItem

Reiceive : None

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
}

Pqf.res.delHolidayLocale(locid)

Deletes a holiday locale

• {locid} : The holiday locale

Send : None

Receive : None

Pqf.res.getHolidayLocaleObj(locid)

Returns a single holiday locale

• {locid} : The holiday locale

Send : None

Receive : VersionedItem

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
}

Pqf.res.putHolidayLocaleObj(locid, obj)

Updates or creates a holiday locale

• {locid} : The holiday locale

Send : VersionedItem

Reiceive : None

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
}

Pqf.res.getHolidayLocaleDetails(locid)

Returns a holiday locale in "Details" format

• {locid} : The holiday locale

Send : None

Receive : Details

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.res.putHolidayLocaleDetails(locid, obj)

Updates or creates a holiday locale in "Details" format

• {locid} : The holiday locale

Send : Details

Reiceive : None

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.res.getHolidays(locid, beg, end)

Returns all holidays of a holiday locale

• {locid} : The holiday locale

• {beg}? : The first day of the range that should be retrieved

• {end}? : The day after the last day of the range that should be retrieved

Send : None

Receive : Holiday[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "date": "2020-03-11",
  "shiftId": "4953B2416F6C471CB89EA86B3514F502",
  "name": "Ostermontag"
 },...
]

Pqf.res.getHoliday(locid, holid)

Returns a single holiday of a holiday locale

• {locid} : The holiday locale ID

• {holid} : The holiday ID

Send : None

Receive : Holiday

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "date": "2020-03-11",
  "shiftId": "4953B2416F6C471CB89EA86B3514F502",
  "name": "Ostermontag"
}

Pqf.res.putHoliday(locid, holid, obj)

Updates a single holiday of a holiday locale

• {locid} : The holiday locale ID

• {holid} : The holiday ID

Send : Holiday

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "date": "2020-03-11",
  "shiftId": "4953B2416F6C471CB89EA86B3514F502",
  "name": "Ostermontag"
}

Reiceive : None

Pqf.res.delHoliday(locid, holid)

Deletes a single holiday of a holiday locale

• {locid} : The holiday locale ID

• {holid} : The holiday ID

Send : None

Receive : None

Pqf.res.getHolidaysBulk(locid, holids)

Returns a single holiday of a holiday locale

• {locid} : The holiday locale ID

• {holids} : The holiday ID

Send : None

Receive : Holiday[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "date": "2020-03-11",
  "shiftId": "4953B2416F6C471CB89EA86B3514F502",
  "name": "Ostermontag"
 },...
]

Pqf.res.putHolidaysBulk(locid, holids, obj)

Updates a single holiday of a holiday locale

• {locid} : The holiday locale ID

• {holids} : The holiday ID

Send : Holiday[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "date": "2020-03-11",
  "shiftId": "4953B2416F6C471CB89EA86B3514F502",
  "name": "Ostermontag"
 },...
]

Reiceive : None

Pqf.res.delHolidaysBulk(locid, holids)

Deletes multiple holidays of a holiday locale

• {locid} : The holiday locale ID

• {holids} : The holiday ID

Send : None

Receive : None

Pqf.res.importHolidays(locid, format, filter)

Imports holidays from a file

• {locid} : The holiday locale ID

• {format}? : the file format

• {filter}? : the dates that should be imported, all if not specified

Send : Arbitrary Content

Receive : None

Pqf.res.previewHolidays(format)

Imports holidays from a file

• {format}? : the file format

Send : Arbitrary Content

Receive : Holiday[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "date": "2020-03-11",
  "shiftId": "4953B2416F6C471CB89EA86B3514F502",
  "name": "Ostermontag"
 },...
]

Pqf.res.getResourceGroupStandardWorktimes()

Returns standard worktimes for all resource groups

Send : None

Receive : ResourceGroupStandardWorktime[ ]

[
 {
  "id": "3687790A73CC42AE94DDB75B2AD65AD3",
  "timePerWeek": "PT10D25H01M13S",
  "daysPerWeek": 11
 },...
]

Pqf.res.putResourceGroupStandardWorktime(resgrpid, obj)

Updates the standard worktime for a given resource group

• {resgrpid} : The resource group ID

Send : ResourceGroupStandardWorktime

{
  "id": "3687790A73CC42AE94DDB75B2AD65AD3",
  "timePerWeek": "PT10D25H01M13S",
  "daysPerWeek": 11
}

Reiceive : None

Pqf.res.getResourceShifts()

Returns all available shifts in resource planning

Send : None

Receive : ResourceShift[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Name of this resource shift.",
  "description": "Description..",
  "imageUrl": "example.svg",
  "color": "blue",
  "duration": "PT10D25H01M13S",
  "begTime": "PT10D25H01M13S",
  "endTime": "PT10D25H01M13S"
 },...
]

Pqf.res.getResourceShift(shiftid)

Returns a single shift in resource planning

• {shiftid} : The resource shift's ID

Send : None

Receive : ResourceShift

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Name of this resource shift.",
  "description": "Description..",
  "imageUrl": "example.svg",
  "color": "blue",
  "duration": "PT10D25H01M13S",
  "begTime": "PT10D25H01M13S",
  "endTime": "PT10D25H01M13S"
}

Pqf.res.getWeekDaysToWorkDaysMapping(resourceId, beg, end)

Returns the weekdays (7 days week) to workdays (~5 days week) mapping

• {resourceId} : the resource ID

• {beg}? : the first day to be included (serves as 0-reference, required)

• {end}? : the first day to be included (required)

Send : None

Receive : WorkdayMapping

{
  "resource": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "referenceDay": "2020-03-11",
  "mapping": 11
}

Pqf.res.getWorkDaysToWeekDaysMapping(resourceId, beg, end)

Returns the workdays (~5 days week) to weekdays (7 days week) mapping

• {resourceId} : the resource ID

• {beg}? : the first day to be included (serves as 0-reference, required)

• {end}? : the first day to be included (required)

Send : None

Receive : WorkdayMapping

{
  "resource": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
  },
  "referenceDay": "2020-03-11",
  "mapping": 11
}

Pqf.rsk.getProjectPortfolioRisks(ppfid, version, currency)

Retrieves project risks of projects of a portfolio

• {ppfid} : The project portfolio ID

• {version}? : Retrieve a historic version (current version, if not specified)

• {currency}? : The desired currency to have all money values converted into (except the report which is not recalculated)

Send : None

Receive : ProjectRisk[ ]

[
 {
  "projectId": "87F5235D6B2E49168DA41EF3781F539E",
  "dimension": "4784F638450845AC981DB2FC5F00D2D7"
 },...
]

Pqf.rsk.getProjectPortfolioRisksWithHistory(ppfid, history, version, simplify, currency)

Retrieves project risks (with history) of projects of a portfolio

• {ppfid} : The project portfolio ID

• {history} : The size of the history that should be retrieved

• {version}? : Retrieve a historic version (current version, if not specified)

• {simplify}? : Reduces the history entries by combining entries that are close to each other

• {currency}? : The desired currency to have all money values converted into (except the report which is not recalculated)

Send : None

Receive : ProjectRiskWithHistory[ ]

[
 {
  "projectId": "87F5235D6B2E49168DA41EF3781F539E",
  "dimension": "4784F638450845AC981DB2FC5F00D2D7"
 },...
]

Pqf.rsk.getProjectRisks(prjid, version, currency)

Retrieves project risks of a project

• {prjid} : The project's ID

• {version}? : Retrieve a historic version (current version, if not specified)

• {currency}? : The desired currency to have all money values converted into (except the report which is not recalculated)

Send : None

Receive : ProjectRisk[ ]

[
 {
  "projectId": "87F5235D6B2E49168DA41EF3781F539E",
  "dimension": "4784F638450845AC981DB2FC5F00D2D7"
 },...
]

Pqf.rsk.getProjectRisksWithHistory(prjid, history, version, simplify, currency)

Retrieves project risks (with history) of a project

• {prjid} : The project's ID

• {history} : The size of the history that should be retrieved

• {version}? : Retrieve a historic version (current version, if not specified)

• {simplify}? : Reduces the history entries by combining entries that are close to each other

• {currency}? : The desired currency to have all money values converted into (except the report which is not recalculated)

Send : None

Receive : ProjectRiskWithHistory[ ]

[
 {
  "projectId": "87F5235D6B2E49168DA41EF3781F539E",
  "dimension": "4784F638450845AC981DB2FC5F00D2D7"
 },...
]

Pqf.rsk.addProjectRisk(prjid)

Adds a project risk to a project

• {prjid} : The project's ID

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.rsk.getProjectRisk(prjid, riskId, version, currency)

Retrieves a project risk of a project

• {prjid} : The project's ID

• {riskId} : The project risk ID

• {version}? : Retrieve a historic version (current version, if not specified)

• {currency}? : The desired currency to have all money values converted into (except the report which is not recalculated)

Send : None

Receive : ProjectRisk

{
  "projectId": "87F5235D6B2E49168DA41EF3781F539E",
  "dimension": "4784F638450845AC981DB2FC5F00D2D7"
}

Pqf.rsk.getProjectRiskWithHistory(prjid, riskId, history, version, simplify, currency)

Retrieves a project risk (with history) of a project

• {prjid} : The project's ID

• {riskId} : The project risk ID

• {history} : The size of the history that should be retrieved

• {version}? : Retrieve a historic version (current version, if not specified)

• {simplify}? : Reduces the history entries by combining entries that are close to each other

• {currency}? : The desired currency to have all money values converted into (except the report which is not recalculated)

Send : None

Receive : ProjectRiskWithHistory

{
  "projectId": "87F5235D6B2E49168DA41EF3781F539E",
  "dimension": "4784F638450845AC981DB2FC5F00D2D7"
}

Pqf.rsk.putProjectRisk(prjid, riskId, obj)

Stores a project risk of a project

• {prjid} : The project's ID

• {riskId} : The project risk ID

Send : ProjectRisk

{
  "projectId": "87F5235D6B2E49168DA41EF3781F539E",
  "dimension": "4784F638450845AC981DB2FC5F00D2D7"
}

Reiceive : None

Pqf.rsk.delProjectRisk(prjid, riskId)

Deletes a project risk of a project

• {prjid} : The project's ID

• {riskId} : The project risk ID

Send : None

Receive : None

Pqf.rsk.getAllProjectRisks(currency)

Retrieves all project risks

• {currency}? : The desired currency to have all money values converted into (except the report which is not recalculated)

Send : None

Receive : ProjectRisk[ ]

[
 {
  "projectId": "87F5235D6B2E49168DA41EF3781F539E",
  "dimension": "4784F638450845AC981DB2FC5F00D2D7"
 },...
]

Pqf.rsk.getProjectRiskById(riskId, currency)

Retrieves a project risk by its ID

• {riskId} : The project risk ID

• {currency}? : The desired currency to have all money values converted into (except the report which is not recalculated)

Send : None

Receive : ProjectRisk

{
  "projectId": "87F5235D6B2E49168DA41EF3781F539E",
  "dimension": "4784F638450845AC981DB2FC5F00D2D7"
}

Pqf.rsk.getRiskMatrixDefinition()

Retrieves the risk matrix definition

Send : None

Receive : RiskMatrixDefinition

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "occurrenceProbabilityClassifications": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Klasse A",
      "description": "<p>Dies ist eines der wichtigsten Risiken, die immer im Auge behalten werden müssen</p>",
      "imageUrl": "../images/bigrisk.svg",
      "color": "blue",
      "limit": 11.5
    }
  ],
  "extentOfLossClassifications": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Klasse A",
      "description": "<p>Dies ist eines der wichtigsten Risiken, die immer im Auge behalten werden müssen</p>",
      "imageUrl": "../images/bigrisk.svg",
      "color": "blue",
      "limit": 11.5
    }
  ],
  "riskRatingClassifications": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": "Klasse A",
      "description": "<p>Dies ist eines der wichtigsten Risiken, die immer im Auge behalten werden müssen</p>",
      "imageUrl": "../images/bigrisk.svg",
      "color": "blue",
      "limit": 11.5
    }
  ],
  "fields": [
    {
      "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
      "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
      "riskRatingClassification": "F71376233416402885209C3AEA0C4760"
    }
  ],
  "customCalculationRule": "occurrenceProbability * extentOfLoss"
}

Pqf.rsk.getRiskMatrixDefinitionTranslated()

Retrieves the risk matrix definition in all available languages

Send : None

Receive : RiskMatrixDefinitionTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJ-X",
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "occurrenceProbabilityClassifications": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "description": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "imageUrl": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "color": "blue",
      "limit": 11.5
    }
  ],
  "extentOfLossClassifications": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "description": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "imageUrl": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "color": "blue",
      "limit": 11.5
    }
  ],
  "riskRatingClassifications": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "description": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "imageUrl": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "color": "blue",
      "limit": 11.5
    }
  ],
  "fields": [
    {
      "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
      "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
      "riskRatingClassification": "F71376233416402885209C3AEA0C4760"
    }
  ],
  "customCalculationRule": "occurrenceProbability * extentOfLoss"
}

Pqf.rsk.putRiskMatrixDefinitionTranslated(obj)

Sets the risk matrix

Send : RiskMatrixDefinitionTranslated

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "code": "PRJ-X",
  "description": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "iconRef": [
    {
      "code": "de-ch",
      "text": "Chuchichäschtli"
    }
  ],
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "occurrenceProbabilityClassifications": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "description": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "imageUrl": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "color": "blue",
      "limit": 11.5
    }
  ],
  "extentOfLossClassifications": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "description": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "imageUrl": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "color": "blue",
      "limit": 11.5
    }
  ],
  "riskRatingClassifications": [
    {
      "type": "AnyTypeOfObj",
      "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
      "name": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "description": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "imageUrl": [
        {
          "code": "de-ch",
          "text": "Chuchichäschtli"
        }
      ],
      "color": "blue",
      "limit": 11.5
    }
  ],
  "fields": [
    {
      "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
      "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
      "riskRatingClassification": "F71376233416402885209C3AEA0C4760"
    }
  ],
  "customCalculationRule": "occurrenceProbability * extentOfLoss"
}

Reiceive : None

Pqf.rsk.calculateRisk()

Calculates a risk

Send : RiskRating

{
  "occurrenceProbability": 11.5,
  "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
  "extentOfLoss": 11.5,
  "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
  "riskRating": 11.5,
  "riskRatingClassification": "F71376233416402885209C3AEA0C4760"
}

Receive : RiskRating

{
  "occurrenceProbability": 11.5,
  "occurrenceProbabilityClassification": "F25B505C9E0C42ADBEF3D9D24539DF18",
  "extentOfLoss": 11.5,
  "extentOfLossClassification": "42C18259199A41DB929DAE8326B50C5A",
  "riskRating": 11.5,
  "riskRatingClassification": "F71376233416402885209C3AEA0C4760"
}

Pqf.stg.addStrategy(copy, copyrels)

Adds a new strategy

• {copy}? : use an existing strategy as template

• {copyrels}? : When copying (copy is set), also copy relations

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.stg.getStrategies()

Returns all strategies present

Send : None

Receive : Strategy[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.stg.getStrategy(strategyId)

Returns a strategy

• {strategyId} : the strategy's ID

Send : None

Receive : Strategy

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.stg.putStrategy(strategyId, obj)

Creates or updates a strategy

• {strategyId} : the strategy's ID

Send : Strategy

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Reiceive : None

Pqf.stg.delStrategy(strategyId)

deletes a strategy

• {strategyId} : the strategy's ID

Send : None

Receive : None

Pqf.stg.getStrategyHistory(strategyId, until)

Returns a specific strategy's history

• {strategyId} : the strategy's ID

• {until}? : Limit for the history to be returned

Send : None

Receive : Strategy[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.stg.getVisions(strategyId)

Returns all visions of a strategy

• {strategyId} : the strategy's ID

Send : None

Receive : Vision[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "strategyId": "926A5099885D4EDBB1B6F5FB75392489",
  "sortIndex": 11.5
 },...
]

Pqf.stg.getAllVisions()

Returns all visions present in the system

Send : None

Receive : Vision[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "strategyId": "926A5099885D4EDBB1B6F5FB75392489",
  "sortIndex": 11.5
 },...
]

Pqf.stg.addVision(strategyId, copy, copyrels, sortindex)

Adds a new vision

• {strategyId} : the strategy's ID

• {copy}? : use an existing vision as template

• {copyrels}? : When copying (copy is set), also copy relations

• {sortindex}? : The sort index to use

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.stg.getVision(visionId)

Returns a specific vision

• {visionId} : the vision's ID

Send : None

Receive : Vision

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "strategyId": "926A5099885D4EDBB1B6F5FB75392489",
  "sortIndex": 11.5
}

Pqf.stg.getVisionHistory(visionId, until)

Returns a specific vision's history

• {visionId} : the vision's ID

• {until}? : Limit for the history to be returned

Send : None

Receive : Vision[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "strategyId": "926A5099885D4EDBB1B6F5FB75392489",
  "sortIndex": 11.5
 },...
]

Pqf.stg.putVision(visionId, obj)

Creates or updates a specific vision

• {visionId} : the vision's ID

Send : Vision

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "strategyId": "926A5099885D4EDBB1B6F5FB75392489",
  "sortIndex": 11.5
}

Reiceive : None

Pqf.stg.delVision(visionId)

Deletes a specific vision

• {visionId} : the vision's ID

Send : None

Receive : None

Pqf.stg.getAllFieldsOfAction()

Returns all fields of action

Send : None

Receive : FieldOfAction[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "visionId": "97BC2BB37F474CC7AB8FE76237FEDCF3",
  "achievementRate": [
    11.2,
    22.3,
    null
  ],
  "progressByContributionState": [
    {
      "stateId": "CC89642923CC4E9083D4F9983A502549",
      "weight": 11,
      "progress": 11.5
    }
  ],
  "progress": [
    11.2,
    22.3,
    null
  ],
  "indicatorStatuses": [
    {
      "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
      "accumulatedWeights": 11
    }
  ],
  "sortIndex": 11.5
 },...
]

Pqf.stg.getFieldsOfAction(visionId)

Returns all fields of action belonging to a specific vision

• {visionId} : the vision's ID

Send : None

Receive : FieldOfAction[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "visionId": "97BC2BB37F474CC7AB8FE76237FEDCF3",
  "achievementRate": [
    11.2,
    22.3,
    null
  ],
  "progressByContributionState": [
    {
      "stateId": "CC89642923CC4E9083D4F9983A502549",
      "weight": 11,
      "progress": 11.5
    }
  ],
  "progress": [
    11.2,
    22.3,
    null
  ],
  "indicatorStatuses": [
    {
      "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
      "accumulatedWeights": 11
    }
  ],
  "sortIndex": 11.5
 },...
]

Pqf.stg.addFieldOfAction(visionId, copy, copyrels, sortindex)

Adds a new field of action

• {visionId} : the vision's ID

• {copy}? : use an existing field of action as template

• {copyrels}? : When copying (copy is set), also copy relations

• {sortindex}? : The sort index to use

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.stg.getFieldOfAction(foaId)

Returns a specific field of action

• {foaId} : the field of action's ID

Send : None

Receive : FieldOfAction

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "visionId": "97BC2BB37F474CC7AB8FE76237FEDCF3",
  "achievementRate": [
    11.2,
    22.3,
    null
  ],
  "progressByContributionState": [
    {
      "stateId": "CC89642923CC4E9083D4F9983A502549",
      "weight": 11,
      "progress": 11.5
    }
  ],
  "progress": [
    11.2,
    22.3,
    null
  ],
  "indicatorStatuses": [
    {
      "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
      "accumulatedWeights": 11
    }
  ],
  "sortIndex": 11.5
}

Pqf.stg.getFieldOfActionHistory(foaId, until)

Returns a specific field of action's history

• {foaId} : the field of action's ID

• {until}? : Limit for the history to be returned

Send : None

Receive : FieldOfAction[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "visionId": "97BC2BB37F474CC7AB8FE76237FEDCF3",
  "achievementRate": [
    11.2,
    22.3,
    null
  ],
  "progressByContributionState": [
    {
      "stateId": "CC89642923CC4E9083D4F9983A502549",
      "weight": 11,
      "progress": 11.5
    }
  ],
  "progress": [
    11.2,
    22.3,
    null
  ],
  "indicatorStatuses": [
    {
      "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
      "accumulatedWeights": 11
    }
  ],
  "sortIndex": 11.5
 },...
]

Pqf.stg.putFieldOfAction(foaId, obj)

Creates or updates a specific field of action

• {foaId} : the field of action's ID

Send : FieldOfAction

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "visionId": "97BC2BB37F474CC7AB8FE76237FEDCF3",
  "achievementRate": [
    11.2,
    22.3,
    null
  ],
  "progressByContributionState": [
    {
      "stateId": "CC89642923CC4E9083D4F9983A502549",
      "weight": 11,
      "progress": 11.5
    }
  ],
  "progress": [
    11.2,
    22.3,
    null
  ],
  "indicatorStatuses": [
    {
      "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
      "accumulatedWeights": 11
    }
  ],
  "sortIndex": 11.5
}

Reiceive : None

Pqf.stg.delFieldOfAction(foaId)

Deletes a specific field of action

• {foaId} : the field of action's ID

Send : None

Receive : None

Pqf.stg.getAllObjectives()

Returns all objectives

Send : None

Receive : Objective[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "foaId": "5C756AD7EF904F568DB462A961174023",
  "weight": 11,
  "achievementRate": {
    "target": [
      11.2,
      22.3,
      null
    ],
    "actual": [
      11.2,
      22.3,
      null
    ],
    "metric": "The number of cows on our farm that look happy",
    "rate": [
      11.2,
      22.3,
      null
    ]
  },
  "progressByContributionState": [
    {
      "stateId": "CC89642923CC4E9083D4F9983A502549",
      "weight": 11,
      "progress": 11.5
    }
  ],
  "progress": [
    11.2,
    22.3,
    null
  ],
  "indicatorStatuses": [
    {
      "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
      "accumulatedWeights": 11
    }
  ],
  "sortIndex": 11.5
 },...
]

Pqf.stg.getObjectives(foaId)

Returns all objectives belonging to a specific field of action

• {foaId} : the field of action's ID

Send : None

Receive : Objective[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "foaId": "5C756AD7EF904F568DB462A961174023",
  "weight": 11,
  "achievementRate": {
    "target": [
      11.2,
      22.3,
      null
    ],
    "actual": [
      11.2,
      22.3,
      null
    ],
    "metric": "The number of cows on our farm that look happy",
    "rate": [
      11.2,
      22.3,
      null
    ]
  },
  "progressByContributionState": [
    {
      "stateId": "CC89642923CC4E9083D4F9983A502549",
      "weight": 11,
      "progress": 11.5
    }
  ],
  "progress": [
    11.2,
    22.3,
    null
  ],
  "indicatorStatuses": [
    {
      "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
      "accumulatedWeights": 11
    }
  ],
  "sortIndex": 11.5
 },...
]

Pqf.stg.addObjective(foaId, copy, copyrels, sortindex)

Adds an objective

• {foaId} : the field of action's ID

• {copy}? : use an existing objective as template

• {copyrels}? : When copying (copy is set), also copy relations

• {sortindex}? : The sort index to use

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.stg.getObjective(objectiveId)

Returns a specific objective

• {objectiveId} : the objective's ID

Send : None

Receive : Objective

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "foaId": "5C756AD7EF904F568DB462A961174023",
  "weight": 11,
  "achievementRate": {
    "target": [
      11.2,
      22.3,
      null
    ],
    "actual": [
      11.2,
      22.3,
      null
    ],
    "metric": "The number of cows on our farm that look happy",
    "rate": [
      11.2,
      22.3,
      null
    ]
  },
  "progressByContributionState": [
    {
      "stateId": "CC89642923CC4E9083D4F9983A502549",
      "weight": 11,
      "progress": 11.5
    }
  ],
  "progress": [
    11.2,
    22.3,
    null
  ],
  "indicatorStatuses": [
    {
      "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
      "accumulatedWeights": 11
    }
  ],
  "sortIndex": 11.5
}

Pqf.stg.getObjectiveHistory(objectiveId, until)

Returns a specific objective's history

• {objectiveId} : the objective's ID

• {until}? : Limit for the history to be returned

Send : None

Receive : Objective[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "foaId": "5C756AD7EF904F568DB462A961174023",
  "weight": 11,
  "achievementRate": {
    "target": [
      11.2,
      22.3,
      null
    ],
    "actual": [
      11.2,
      22.3,
      null
    ],
    "metric": "The number of cows on our farm that look happy",
    "rate": [
      11.2,
      22.3,
      null
    ]
  },
  "progressByContributionState": [
    {
      "stateId": "CC89642923CC4E9083D4F9983A502549",
      "weight": 11,
      "progress": 11.5
    }
  ],
  "progress": [
    11.2,
    22.3,
    null
  ],
  "indicatorStatuses": [
    {
      "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
      "accumulatedWeights": 11
    }
  ],
  "sortIndex": 11.5
 },...
]

Pqf.stg.putObjective(objectiveId, obj)

Creates or updates a specific objective

• {objectiveId} : the objective's ID

Send : Objective

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "color": "blue",
  "iconRef": "/images/lifecycle/planning.png",
  "validityStart": "2020-03-11",
  "validityEnd": "2020-03-11",
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ],
  "foaId": "5C756AD7EF904F568DB462A961174023",
  "weight": 11,
  "achievementRate": {
    "target": [
      11.2,
      22.3,
      null
    ],
    "actual": [
      11.2,
      22.3,
      null
    ],
    "metric": "The number of cows on our farm that look happy",
    "rate": [
      11.2,
      22.3,
      null
    ]
  },
  "progressByContributionState": [
    {
      "stateId": "CC89642923CC4E9083D4F9983A502549",
      "weight": 11,
      "progress": 11.5
    }
  ],
  "progress": [
    11.2,
    22.3,
    null
  ],
  "indicatorStatuses": [
    {
      "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
      "accumulatedWeights": 11
    }
  ],
  "sortIndex": 11.5
}

Reiceive : None

Pqf.stg.delObjective(objectiveId)

Deletes a specific objective

• {objectiveId} : the objective's ID

Send : None

Receive : None

Pqf.stg.getAllObjectiveIndicators()

Get all objective indicators in the system

Send : None

Receive : ObjectiveIndicator[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "objectiveId": "EE3A59726B97413AB3F53468D2DA9BB8",
  "targetType": "NUMERIC",
  "target": "1.234",
  "actual": "1.432",
  "unit": "Average children per family",
  "remark": "Values from statistical bulletin of our town",
  "weight": 11,
  "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
  "sortIndex": 11.5,
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.stg.getObjectiveIndicators(objectiveId)

Get objective indicators of an objective

• {objectiveId} : the objective's ID

Send : None

Receive : ObjectiveIndicator[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "objectiveId": "EE3A59726B97413AB3F53468D2DA9BB8",
  "targetType": "NUMERIC",
  "target": "1.234",
  "actual": "1.432",
  "unit": "Average children per family",
  "remark": "Values from statistical bulletin of our town",
  "weight": 11,
  "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
  "sortIndex": 11.5,
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.stg.addObjectiveIndicator(objectiveId, sortindex)

Adds a new objective indicator

• {objectiveId} : the objective's ID

• {sortindex}? : The sort index to use

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.stg.getObjectiveIndicator(indicatorId)

Returns a specific objective indicator

• {indicatorId} : the indicator's ID

Send : None

Receive : ObjectiveIndicator

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "objectiveId": "EE3A59726B97413AB3F53468D2DA9BB8",
  "targetType": "NUMERIC",
  "target": "1.234",
  "actual": "1.432",
  "unit": "Average children per family",
  "remark": "Values from statistical bulletin of our town",
  "weight": 11,
  "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
  "sortIndex": 11.5,
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.stg.getObjectiveIndicatorHistory(indicatorId)

Returns a specific objective indicator's history

• {indicatorId} : the indicator's ID

Send : None

Receive : ObjectiveIndicator[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "objectiveId": "EE3A59726B97413AB3F53468D2DA9BB8",
  "targetType": "NUMERIC",
  "target": "1.234",
  "actual": "1.432",
  "unit": "Average children per family",
  "remark": "Values from statistical bulletin of our town",
  "weight": 11,
  "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
  "sortIndex": 11.5,
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.stg.putObjectiveIndicator(indicatorId, obj)

Creates or updates a specific objective indicator

• {indicatorId} : the indicator's ID

Send : ObjectiveIndicator

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11",
  "objectiveId": "EE3A59726B97413AB3F53468D2DA9BB8",
  "targetType": "NUMERIC",
  "target": "1.234",
  "actual": "1.432",
  "unit": "Average children per family",
  "remark": "Values from statistical bulletin of our town",
  "weight": 11,
  "statusClass": "STG-OBJECTIVE-INDICATOR-OK",
  "sortIndex": 11.5,
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Reiceive : None

Pqf.stg.delObjectiveIndicator(indicatorId)

Deletes a specific objective indicator

• {indicatorId} : the indicator's ID

Send : None

Receive : None

Pqf.stg.getAllProjectContributions()

Returns all contributions

Send : None

Receive : ProjectContribution[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "objectiveId": "BEEC457E222C4F16A0D229D37D40743F",
  "projectId": "AEFBF483F1AB484FB85561CCDFC11915",
  "weight": 11,
  "remark": "THis is a simple, but effective way to support our objective",
  "progress": [
    11.2,
    22.3,
    null
  ],
  "progressOverride": [
    11.2,
    22.3,
    null
  ],
  "sortIndex": 11.5,
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.stg.getProjectContributions(objectiveId)

Returns all contributions belonging to a specific objective

• {objectiveId} : the objective's ID

Send : None

Receive : ProjectContribution[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "objectiveId": "BEEC457E222C4F16A0D229D37D40743F",
  "projectId": "AEFBF483F1AB484FB85561CCDFC11915",
  "weight": 11,
  "remark": "THis is a simple, but effective way to support our objective",
  "progress": [
    11.2,
    22.3,
    null
  ],
  "progressOverride": [
    11.2,
    22.3,
    null
  ],
  "sortIndex": 11.5,
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.stg.getContributionsByProject(projectId)

Returns all contributions belonging to a specific project

• {projectId} : the project's ID

Send : None

Receive : ProjectContribution[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "objectiveId": "BEEC457E222C4F16A0D229D37D40743F",
  "projectId": "AEFBF483F1AB484FB85561CCDFC11915",
  "weight": 11,
  "remark": "THis is a simple, but effective way to support our objective",
  "progress": [
    11.2,
    22.3,
    null
  ],
  "progressOverride": [
    11.2,
    22.3,
    null
  ],
  "sortIndex": 11.5,
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.stg.addProjectContribution(objectiveId, projectId, sortindex)

Adds a new project contribution

• {objectiveId} : the objective's ID

• {projectId}? : the project's ID (required)

• {sortindex}? : The sort index to use

Send : None

Receive : Reference

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05"
}

Pqf.stg.getProjectContribution(contributionId)

Returns a specific project contribution

• {contributionId} : the contribution's ID

Send : None

Receive : ProjectContribution

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "objectiveId": "BEEC457E222C4F16A0D229D37D40743F",
  "projectId": "AEFBF483F1AB484FB85561CCDFC11915",
  "weight": 11,
  "remark": "THis is a simple, but effective way to support our objective",
  "progress": [
    11.2,
    22.3,
    null
  ],
  "progressOverride": [
    11.2,
    22.3,
    null
  ],
  "sortIndex": 11.5,
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Pqf.stg.getProjectContributionHistory(contributionId, until)

Returns a specific project contribution's history

• {contributionId} : the contribution's ID

• {until}? : Limit for the history to be returned

Send : None

Receive : ProjectContribution[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "objectiveId": "BEEC457E222C4F16A0D229D37D40743F",
  "projectId": "AEFBF483F1AB484FB85561CCDFC11915",
  "weight": 11,
  "remark": "THis is a simple, but effective way to support our objective",
  "progress": [
    11.2,
    22.3,
    null
  ],
  "progressOverride": [
    11.2,
    22.3,
    null
  ],
  "sortIndex": 11.5,
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
 },...
]

Pqf.stg.putProjectContribution(contributionId, obj)

Creates or updates a specific project contribution

• {contributionId} : the contribution's ID

Send : ProjectContribution

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "createdAt": "2020-03-11T10:25:01:13Z",
  "createdBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "modifiedAt": "2020-03-11T10:25:01:13Z",
  "modifiedBy": {
    "type": "AnyTypeOfObj",
    "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
    "name": "Project X",
    "code": "PRJ-X",
    "description": "<p>This was the development name of <b>PQFORCE</b></p>",
    "iconRef": "/images/lifecycle/planning.png",
    "color": "blue",
    "validityStart": "2020-03-11",
    "validityUntil": "2020-03-11"
  },
  "version": "029335F8E37A45758C3B6235863F4BA8",
  "historic": "true",
  "objectiveId": "BEEC457E222C4F16A0D229D37D40743F",
  "projectId": "AEFBF483F1AB484FB85561CCDFC11915",
  "weight": 11,
  "remark": "THis is a simple, but effective way to support our objective",
  "progress": [
    11.2,
    22.3,
    null
  ],
  "progressOverride": [
    11.2,
    22.3,
    null
  ],
  "sortIndex": 11.5,
  "properties": [
    {
      "key": "prj-type",
      "value": "PRJ-TYPE-DEV"
    }
  ]
}

Reiceive : None

Pqf.stg.delProjectContribution(contributionId)

Deletes a specific project contribution

• {contributionId} : the contribution's ID

Send : None

Receive : None

Pqf.tdp.getForeignKeyAssignments(type, id)

Gets all third party references a PQFORCE object has

• {type} : The type of PQFORCE object

• {id} : The ID of PQFORCE's object

Send : None

Receive : ThirdPartyReferenceAssignment[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "foreignKey": "1234567890-XYZ",
  "pqforceId": "597B3E830C6B4E38AF6F792CA645B7ED"
 },...
]

Pqf.tdp.putForeignKeyAssignments(type, id, obj)

Puts all third party references a PQFORCE object has

• {type} : The type of PQFORCE object

• {id} : The ID of PQFORCE's object

Send : ThirdPartyReferenceAssignment[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "foreignKey": "1234567890-XYZ",
  "pqforceId": "597B3E830C6B4E38AF6F792CA645B7ED"
 },...
]

Reiceive : None

Pqf.tdp.getForeignKeyReference(type, foreignkey)

Gets a reference between a PQFORCE object and a third party object

• {type} : The type of PQFORCE object

• {foreignkey} : The third party object's ID

Send : None

Receive : ThirdPartyReferenceWithOwnData

{
  "pqforceName": "XYZ",
  "pqforceCode": "P-123",
  "pqforceDescription": "This is a demonstration project",
  "pqforceImageUrl": "XYZ",
  "additionalData": "hQgzu1YBO0NUsrb+5WAl0Lkax1DNsm7vhXEi3mExqWQ="
}

Pqf.tdp.putForeignKeyReference(type, foreignkey, obj)

Puts a reference between a PQFORCE object and a third party object

• {type} : The type of PQFORCE object

• {foreignkey} : The third party object's ID

Send : ThirdPartyReferenceWithOwnData

{
  "pqforceName": "XYZ",
  "pqforceCode": "P-123",
  "pqforceDescription": "This is a demonstration project",
  "pqforceImageUrl": "XYZ",
  "additionalData": "hQgzu1YBO0NUsrb+5WAl0Lkax1DNsm7vhXEi3mExqWQ="
}

Reiceive : None

Pqf.tdp.delForeignKeyReference(type, foreignkey)

Deletes a reference between a PQFORCE object and a third party object

• {type} : The type of PQFORCE object

• {foreignkey} : The third party object's ID

Send : None

Receive : None

Pqf.tdp.getReference(type, internalId)

Gets references between PQFORCE objects and third party objects

• {type} : The type of PQFORCE objects

• {internalId} : The Reference ID

Send : None

Receive : ThirdPartyReferenceWithOwnData

{
  "pqforceName": "XYZ",
  "pqforceCode": "P-123",
  "pqforceDescription": "This is a demonstration project",
  "pqforceImageUrl": "XYZ",
  "additionalData": "hQgzu1YBO0NUsrb+5WAl0Lkax1DNsm7vhXEi3mExqWQ="
}

Pqf.tdp.getReferences(type, assigned, unassigned)

Gets references between PQFORCE objects and third party objects

• {type} : The type of PQFORCE objects

• {assigned}? : Return objects with assignments

• {unassigned}? : Return objects without assignments

Send : None

Receive : ThirdPartyReferenceWithOwnData[ ]

[
 {
  "pqforceName": "XYZ",
  "pqforceCode": "P-123",
  "pqforceDescription": "This is a demonstration project",
  "pqforceImageUrl": "XYZ",
  "additionalData": "hQgzu1YBO0NUsrb+5WAl0Lkax1DNsm7vhXEi3mExqWQ="
 },...
]

Pqf.tdp.getReferenceTypes()

Returns information about all types of PQFORCE objects which have third party references

Send : None

Receive : ThirdPartyReferenceType[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "typeId": "Project",
  "maxCount": [
    11,
    12,
    17
  ]
 },...
]

Pqf.tdp.getForeignItem(type, foreignKey)

Gets references between PQFORCE objects and third party objects

• {type} : The type of object

• {foreignKey} : The Reference ID

Send : None

Receive : Item

{
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
}

Pqf.tdp.getForeignItems(type)

Gets references between PQFORCE objects and third party objects

• {type} : The type of object

Send : None

Receive : Item[ ]

[
 {
  "type": "AnyTypeOfObj",
  "id": "C9B2C6F28EDF46F68EA15BCDE2252D05",
  "name": "Project X",
  "code": "PRJ-X",
  "description": "<p>This was the development name of <b>PQFORCE</b></p>",
  "iconRef": "/images/lifecycle/planning.png",
  "color": "blue",
  "validityStart": "2020-03-11",
  "validityUntil": "2020-03-11"
 },...
]

ApiClientInfo

Describes an API client

Member	Description	Type	Example
application	The name of the application that wants to access PQFORCE	string	PQFORCE Tray Worktime
appVersion	The version of the application that wants to access PQFORCE	string	1.0.7550.23055
appCompany	The company that is responsible for the development of the application	string	INTRASOFT AG

ApiTokenAuthorizationRequest

Contains information about an API token that is requested to be authorized

Member	Description	Type	Example
tokenId	The ID of the token that was created	string	B0B0D51862D847729E90CD7EFD218422
clientInfoProvided	The information about the software that was provided	ApiClientInfo	None
requestedFromAddress	The address of the machine that requested a new API token	string	46.14.212.22
yourAddress	The address of the machine that is doing the current request as seen by the server for comparison	string	46.14.212.22
requestedAt	The point in time when the token was requested	datetime	None

ApiTokenLog

Contains information about an API token that is authorized

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
clientInfoProvided	The information about the software that was provided	ApiClientInfo	None
authorizedAt	The point in time when the token was authorized	datetime	None
lastAccessAddress	The address from which the token was last used	string	46.14.212.22
lastAccessAt	The last time the token was used	datetime	None
expiry	The point in time when the token expires	datetime	None

ApiTokenWithAuthUrl

Contains the secret token and the URL to be called with the browser to authorize the API client for PQFORCE access

Member	Description	Type	Example
apiToken	The secret token to access the PQFORCE API	string	#qF@^6){`QMj$N`tHQ@!wYK0oxJ*\|UEB1=Jf!btE~O8be-{vkWDHyRyaOuz
authorizationUrl	This URL must be shown in the browser to follow the steps to authorize the API client for PQFORCE access	string	https://cloud.pqforce.com/intrasoft?type=ApiTokenAuthorization&id=6144F1C07F034E77897E393DE0909706
authorizationDeadline	The point in time when the authorization process must be finished	datetime	None

AuthenticationState

Contains information about the authentication state of the current session

Member	Description	Type	Example
tenant	true, if tenant is known	boolean	None
preAuthenticated	true, if user was specified, but not yet authenticated	boolean	None
fullyAuthenticated	true, if user was specified and fully authenticated	boolean	None

Challenge

Describes a challenge that has to be fulfilled by user logging in

Member	Description	Type	Example
challengeText	Contains the task to perform for solving the challenge in the user's language	string	Please scan the barcode with the second factor app and enter the code
challengeImageUrl	An image (i.e.) a barcode to be shown	string	../Barcode/Generate?text=1234
challengeType	The type of challenge	ChallengeType	None
challengeRegex	Describes the rules for the answer to be entered	string	\d{6}
challengeHint	A hint that describes the format of the answer (corresponding to the Regex)	string	Please enter 6 digits

ChallengeAnswer

The answer to a challenge

Member	Description	Type	Example
answer	The answer that was entered by the user	string	169187

ChangePassword

A change password request

Member	Description	Type	Example
oldpassword	The old password	string	Thiswasmyoldpassword.
newpassword	The new password	string	Thisismynewpassword!

Confidentiality

Describes confidentiality of an object and some metadata

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
confidentiality	The confidentiality level	ConfidentialityLevel	None

CubeMappingForType

Contains the relations between actions, lifecycle transitions, states, relations and the resulting permissions for a given object type

Member	Description	Type	Example
relations	Contains relations between objects and a user's resource	RelationType[ ]	None
states	The possible states of an object of given type	LifecycleState[ ]	None
actions	The different actions that may be performed on the given type of object	string[ ]	None
byRelationState	The 2-dimensional array containing the different states by relation and by state	CubeMappingItem[ [ ] ]	None

CubeMappingItem

Contains the relations between actions, lifecycle transitions, relations and the resulting permissions for a given object type and a given lifecycle state

Member	Description	Type	Example
byAction	The different permission IDs for the given actions (specified in outer object)	string[ ]	None
transitions	The different mappings for transitions that are possible starting from given state	TransitionPermission[ ]	None

CubeViewForId

Contains the authorizations between a given object and the users who have access depending on different possible lifecycle states

Member	Description	Type	Example
users	The different users that have access	User[ ]	None
states	The different lifecycle states the given object may be in	LifecycleState[ ]	None
actions	The different actions that may be performed on the given object	string[ ]	None
byUserState	The 2-dimensional array containing the different states by user and by state	CubeViewForIdItem[ [ ] ]	None

CubeViewForType

Contains the authorizations between a given object type and the user roles who have access depending on different possible lifecycle states and their relations to that object

Member	Description	Type	Example
userRoles	The different user roles	UserRole[ ]	None
relations	Contains relations between objects and a user's resource	RelationType[ ]	None
states	The possible states of an object of given type	LifecycleState[ ]	None
actions	The different actions that may be performed on the given type of object	string[ ]	None
byRoleRelationState	The 3-dimensional array containing the different states by user role, by relation and by state	CubeViewForTypeItem[ [ [ ] ] ]	None

CubeViewForIdItem

Contains the relations between actions, lifecycle transitions, relations and the resulting authorizations for a given object or object type, a given lifecycle state and a given user or user role

Member	Description	Type	Example
byAction	The different permission IDs for the given actions (specified in outer object)	Grant[ ]	None
transitions	The different mappings for transitions that are possible starting from given state	TransitionGrant[ ]	None

CubeViewForTypeItem

Contains the relations between actions, lifecycle transitions, relations and the resulting authorizations for a given object or object type, a given lifecycle state and a given user or user role

Member	Description	Type	Example
byAction	The different permission IDs for the given actions (specified in outer object)	GrantLevel[ ]	None
transitions	The different mappings for transitions that are possible starting from given state	TransitionGrantLevel[ ]	None

FirstFactorAuthority

An instance that identifies and authorizes users

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
loginRedirectUrl	If not null, the client must redirect the browser to an external login page instead of the internal login page	string	/ACM/V1/Saml2/Idp/4828427B6FAC4B1ABB3663B79B252F88/Start?lang=de&timezone=Europe%2FZurich

LoginLog

Contains the description of a login attempt event

Member	Description	Type	Example
timestamp	The point in time when the attempt happened	datetime	None
loginLogType	The type of log	LoginLogType	None
message	Describes to the system administrator what has happened	string	Login with outdated SSO protocol

InteractiveLoginRequest

The request for interactive login

Member	Description	Type	Example
username	The username for the login	string	svmu
password	The password for the login	string	ThisIsMyVerySecretPassword!
language	The language code, according to ISO 639-1	string	de
timezone	The time zone of the user according to tz database name	string	Europe/Zurich

LogoutResponse

The response of the server after logout

Member	Description	Type	Example
redirectUrl	The URL to which the client should be redirected (SAML 2.0), if not null	string	https://myidp.com/saml20/logout

Permission

Describes a permission with its ID

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
description	A description of the permission in the user's language	string	Systemadministrator

PermissionWithParents

Describes a permission with its ID and parent permissions

↳ (Permission)

Member	Description	Type	Example
description (Permission)	A description of the permission in the user's language	string	Systemadministrator
parents	The IDs of the parent permissions	string	8D0E4E558E704D319C22FCC460379DB3

Saml2IdentityProvider

Contains all necessary information for using an external identity provider (IDP) with SAML protocol

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
primaryCertificateFingerprint	The fingerprint (SHA 256 hash in hex format) of the customer's identity provider's primary certificate (spaces between groups are optional)	string	EB 68 08 71 39 CE 24 50 D1 AA 9F 0D 1C 3B 57 94 50 7B 5B 6A 74 D6 7D 38 B5 27 E5 32 D6 12 A3 23
secondaryCertificateFingerprint	A secondary (spare) fingerprint (SHA 256 hash in hex format) of an optional customer's identity provider's secondary/spare certificate (spaces between groups are optional)	string	EB 68 08 71 39 CE 24 50 D1 AA 9F 0D 1C 3B 57 94 50 7B 5B 6A 74 D6 7D 38 B5 27 E5 32 D6 12 A3 23
signInUrl	The URL that is used by the customer's identity provider to sign in	string	https://login.intrasoft.ch/adfs/ls/
signOutUrl	The URL that is used by the customer's identity provider to sign out (not yet in use)	string
eMailField	Where to find eMail in the customer's identity provider's response	string	email
userIdField	Where to find the user ID in the customer's identity provider's response	string	username
realNameField	Where to find real name in the customer's identity provider's response (not yet in use)	string	realname
mobileNumberField	Where to find the mobile number in the customer's identity provider's response	string	mobilenumber
groupsField	Where to find group information in the customer's identity provider's response	string	groups
userRoleMapping	The mappings of user roles: user role --> required group.	Saml2UserRoleMapping[ ]	None
issuerUrl	Informational (read-only) for the admin: The issuer URL to be configured in the customer's identity provider	string	https://test.pqforce.com/ACM/V1/Saml2/Issuer
assertionConsumerServiceUrl	Informational (read-only) for the admin: The ACS URL to be configured in the customer's identity provider	string	https://test.pqforce.com/ACM/V1/Saml2/Acs
directLoginUrl	Informational (read-only) for the admin: The direct login URL	string	https://test.pqforce.com/ACM/V1/Saml2/Idp/71089527EC034F69930A6FC7777F6D2A/Start?lang=de
secondAuthorityDefault	The default second authority (2nd factor) for new users that are created automatically	string	7D6A9C3104614D6B959144E4AA697664
receiveNotificationsDefault	The default notification setting for new users that are created automatically	boolean	None
logAssertions	Enables or disables the logging of assertions for debug / config purpose	boolean	None
allowInsecureSignatureAlgorithm	Maintains compatibility to some outdated, insecure SAML2 identity providers. Make sure to update or reconfigure your identity provider for the usage of a secure algorithm.	boolean	None
logs	Contains logs about the last few login attempts with the customer's identity provider for the system admin (read-only)	LoginLog[ ]	None
signRequest	Specifies whether to sign the requests	boolean	None
sendAcsUrl	Specifies whether to send the ACS URL with the request (request needs also to be signed, if true)	boolean	None
tenantSpecificIssuer	Uses a tenant specific issuer URL to distinguish different tenants on the same system	boolean	None
requestPersistentId	Whether to explicitly request a persistent ID (recommended, disable only for compatibility reasons)	boolean	None
certificateInfo	Contains information about the signing certificate, if signing is enabled (read-only)	CertificateInfo	None

Saml2UserRoleMapping

Describes a mapping between a PQFORCE user role and any required external group (i.e. AD group). If group is null, all users will be assigned to that user role

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
userRoleId	The ID of the user role in PQFORCE	string	3528CE0059584FB5866772133B5A498E
mode	Describes the way PQFORCE assigns the mentioned user role to a user with given IdP groups	Saml2UserRoleMappingMode	None
group	The name of the external group (i.e. AD group)	string	A2816EAC3DA343F8868446D152F35E5C

TransitionGrant

Describes whether a lifecycle transition is allowed to be performed by a given user

Member	Description	Type	Example
transition	The lifecycle transition	LifecycleTransition	None
grant	Whether it is granted	Grant	None

TransitionGrantLevel

Describes whether a lifecycle transition is allowed to be performed by a given user

Member	Description	Type	Example
transition	The lifecycle transition	LifecycleTransition	None
grant	Whether it is granted	GrantLevel	None

TransitionPermission

Describes a permission that is required for performing a lifecycle transition

Member	Description	Type	Example
transition	The lifecycle transition	LifecycleTransition	None
permission	The permission ID	string	90CDF95989F3461B9CB855CF5EF5AD5F

User

A PQFORCE user

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
firstAuthority	The ID of the first user authority that identified the user	string	EDFC52454D44578590326F44F27653E5
secondAuthority	The ID of the second user authority that identified the user	string	BBFC5A60CA414572BA4E06A89E0904BF
name	Name of the user	string	Max Muster
resource	Resource tied to the user	Item	None
email	Email of the user	string	max.muster@pqforce.com
mobile	Mobile phone number of the user	string	0791234567
receiveNotifications	Determines if the user should receive email notifications	boolean	None
language	Contains the language that is set for a given user, overrides browser / login language if set	string	de
timezone	Contains the timezone that is set for a given user, overrides browser timezone if set	string	Europe/Zurich
lastLogin	Last login of user	datetime	None
passwordExpiry	Expiry of password	datetime	None
accountExpiry	Expiry of user account	datetime	None
autoLogout	Determines if the user should be automatically logged out after a period of inactivity	boolean	None
active	A flag indicating whether the user is active (read-only)	boolean	None

UserAuthorization

Describes the different authorizations a given PQFORCE user has

Member	Description	Type	Example
id	The permission ID	string	A21A40A70FA0486EA61EB8DCDFE59788
description	The description in the user's language	string	System administration
grantLevel	Whether it is allowed or not	GrantLevel	None

UserCertificate

Contains a user certificate whose raw part may be used to sign in to other systems

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
raw	Contains the certificate string that may be used to sign in to other systems	string	LV-aCK>+}{+?-K4m{c~57%eL{1Hvp5ZnkDvb5Bn%KK3)hNMw\|7Zg?7aOG8=`80=V!XA#atX}nZsyl8xW`517WR=@gr?}*cX6
server	The PQFORCE server on which this user is logged in	string	https://cloud.pqforce.com
tenant	The tenant this user belongs to	string	ED0A62E07B5F4EFEB4BEE940853DED14
edition	The edition the tenant runs on	string	STARTER
authority	The user authority that identified the user	string	EDFC52454D44578590326F44F27653E5
userId	The user's ID	string	A98BFC24646C4E88B3300622DFF908F9
userName	The user's name	string	Markus Dolder
eMail	The user's e-Mail	string	m.dolder@pqforce.com
logonUrl	The URL that is used for logon (may be used to direct the user back to PQFORCE)	string	https://cloud.pqforce.com/intrasoft
validity	The validity of the certificate	datetime	None
fingerprint	The fingerprint of this certificate	string	XHSL7WJW3XIP7CP3J35BM2PYL35ZAEJQY53FTZJBMWAEIWAPKGYQ

UserPreferences

Stores user preferences in a structured way

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
language	Contains the language that is set for a given user, overrides browser / login language if set	string	de
timezone	Contains the timezone that is set for a given user, overrides browser timezone if set	string	Europe/Zurich
currency	Contains the preferred home currency that is set for a given user, overrides tenant home currency if set	string	CURRENCY-EUR

UserRole

Describes a user role

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
parentId	A reference to another user role if the current role should be shown as child of the other	string	C78B23663F79470F82BCA4082E294029

UserRoleTranslated

Describes a user role with translations

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
parentId	A reference to another user role if the current role should be shown as child of the other	string	C78B23663F79470F82BCA4082E294029

UserRoleAuthorization

Describes the different authorizations (grants / denies) for a given user role

Member	Description	Type	Example
id	The user role ID	string	C78B23663F79470F82BCA4082E294029
grant	Whether it is allowed or not with different confidentiality levels	GrantLevel	None

WelcomeMessage

Contains a welcome message which may inform the user about special things

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
sticky	true, if message must be discarded manually	boolean	None
subject	The subject in the user's language	string	Bitte Passwort ändern
message	The message in the user's language	string	Ihr Passwort läuft in 2 Tagen ab

ActualsPeriod

Describes a period of actuals reporting which is the base unit to control whether reporting or modifying is possible or not.

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
beg	Contains the start day of the period (inclusive)	date	None
end	Contains the end day of the period (exclusive)	date	None

ProjectTime

Describes how much time a resource spent for a project (optional with a task) on a certain day

Member	Description	Type	Example
day	Specifies the date this effort was done	date	None
projectId	Specifies the project ID this effort was spent for	string	8E1A9776193F4638A5ED3B604B44F2CC
workItemId	Specifies the work item ID (corresponding to project ID) this effort was spent for (may be null)	string	C06A3DF9C76343F3B7EB1DB37DD76678
duration	Specifies the amount of time that was spent	duration	None
comment	Contains a comment describing what the resource did or if further actions are required	string	Fixed JUNIT tests
combined	A flag (read-only) that indicates a combined project time report (composed of multiple entries)	boolean?	None

ProjectTimeActual

Describes how much time a resource spent for a project (optional with a task) on a certain day

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
day	Specifies the date this effort was done	date	None
resourceId	Specifies the resource ID (corresponding to period ID) this effort was spent by	string	FE77016011BE4764ACDCB5521C0B2F77
projectId	Specifies the project ID this effort was spent for	string	8E1A9776193F4638A5ED3B604B44F2CC
workItemId	Specifies the work item ID (corresponding to project ID) this effort was spent for (may be null)	string	C06A3DF9C76343F3B7EB1DB37DD76678
duration	Specifies the amount of time that was spent	duration	None
comment	Contains a comment describing what the resource did or if further actions are required	string	Fixed JUNIT tests

ResourceActualsPeriod

Describes a period of actuals reporting of resource times which is the base unit to control whether reporting or modifying is possible or not.

↳ (ActualsPeriod)

Member	Description	Type	Example
end (ActualsPeriod)	Contains the end day of the period (exclusive)	date	None
beg (ActualsPeriod)	Contains the start day of the period (inclusive)	date	None
resourceId	Contains the ID of the resource that has been working	string	2BCD01BA489B4E549F27007C57913AB5

ResourcePresence

Describes the presence of a resource

Member	Description	Type	Example
id	The ID of the presence of a resource, UUID	string	FFB03F16119D4E57BD008A3AA2B970FF
start	Specifies the start of the presence	datetime	None
end	Specifies the end of the presence	datetime	None
startClocked	Specifies the start of the presence, set from clocking in	datetime	None
endClocked	Specifies the end of the presence, set from clocking out	datetime	None
overrideStart	Specifies if the clocked value for start is overridden	boolean	None
overrideEnd	Specifies if the clocked value for end is overridden	boolean	None
comment	Contains a comment describing what the resource worked on during the presence or why presence was needed	string	Reading up on emails

ResourceAbsence

Describes the absence of a resource

Member	Description	Type	Example
duration	Duration of the absence	duration	None
absenceType	Type of the absence	string	815BCBABEA3C4C47B7080CC98EB9A638

ResourceTimeCorrection

Describes a time correction of a resource on a certain day

Member	Description	Type	Example
date	Specifies the date of the time correction	date	None
duration	Specifies the amount of time for the time correction	duration	None
comment	Contains a comment describing why the time correction was done	string	Payout of overtime
type	Type of the time correction	string	ResourcePresenceTimeCorrection

TimeBalance

Describes the time balance of resource up to and including a certain year

Member	Description	Type	Example
duration	Specifies the amount for the time balance	duration	None
year	Specifies the year including which the time balance is calculated	int	2020

ResourceDaySummary

Summarizes the target, presence and absence times of a resource on a given day

Member	Description	Type	Example
target	Specifies the target time	duration	None
sumAbsences	Specifies the total amount of absences	duration	None
sumPresences	Specifies the total amount of presences	duration	None
absences	The absences of the resource	ResourceAbsence[ ]	None

ProjectEfforts

Describes the total efforts for a project

Member	Description	Type	Example
id	The ID of the project, UUID	string	D7C5C07BA0AB438B975676E8392DB2C5
planned	Specifies the total planned effort	duration	None
actual	Specifies the total actual effort	duration	None
remaining	Specifies the total remaining effort	duration	None

PhaseEfforts

Describes the total efforts for a phase

Member	Description	Type	Example
id	The ID of the phase, UUID	string	FFB03F16119D4E57BD008A3AA2B970FF
planned	Specifies the total planned effort	duration	None
actual	Specifies the total actual effort	duration	None
remaining	Specifies the total remaining effort	duration	None

ProjectWithPhasesEfforts

Describes the total efforts for a project, detailed down to phases

Member	Description	Type	Example
id	The ID of the project, UUID	string	22E3DB1611634175B285F02DFE3698FD
planned	Specifies the total planned effort	duration	None
actual	Specifies the total actual effort	duration	None
remaining	Specifies the total remaining effort	duration	None
phaseEfforts	The efforts on the phases	PhaseEfforts[ ]	None

UserPrompt

Info provided by user to AI-generate a project.

Member	Description	Type	Example
prompt	The user prompt, used as input by the LLM.	string	This is an example of the description used to generate the project.

LLMProjectResponse

Response generated from the LLM.

Member	Description	Type	Example
result	Project generated from the LLM.	GeneratedProject	None
message	Translated message sent to the user along with the output.	string	I've generated your project based upon your description. Please let me know if you want to adjust it.

LLMProjectFeedback

Feedback sent by user to adjust a generated project.

Member	Description	Type	Example
project	Project generated from an LLM in a previous step.	GeneratedProject	None
prompt	User prompt that contains the feedback required to change the generated project.	string	Add more dependencies between all subtasks in sequence and make sure that they do not last more than 3 days. Adjust start and end dates of the tasks.

GeneratedProject

Structure of a project generated by the LLM.

Member	Description	Type	Example
name	The name of the generated project.	string	Generated Name
tasks	The tasks of the generated project, as a tree structure.	GeneratedPhase	None
dependencies	The list of dependencies connecting the tasks and milestone of the generated project.	GeneratedDependency[ ]	None

GeneratedPhase

Phase (task/milestone) of a project generated by the LLM.

Member	Description	Type	Example
id	The temporary ID of the phase.	int	None
type	The type of phase.	string	task
name	The name of the phase.	string	Concept
description	The description of the phase.	string	Concept phase to define the model and how to implement it.
start	The starting date of the phase.	date	None
end	The ending date of the phase.	date	None
duration	Duration of the phase.	duration	None
children	Subphases of the phase.	GeneratedPhase[ ]	None

GeneratedDependency

Dependency of a project generated by the LLM.

Member	Description	Type	Example
minDistance	Minimum acceptable distance for the dependency.	int	None
maxDistance	Maximum acceptable distance for the dependency (null if no upper limit).	int?	None
predId	Temporary ID of the phase from which the dependency starts.	int	None
succId	Temporary ID of the phase to which the dependency ends.	int	None
fromStart	Defines if dependency starts from left of starting dependency	boolean	None
toStart	Defines if dependency ends to left of ending dependency	boolean	None

Planning

Planning for a date and shifts.

Member	Description	Type	Example
begin	The date this planning is defined for.	date	None
shifts	Array of planning shifts.	ShiftPlanning[ ]	None

ShiftPlanning

Defines planning slots for a resource shift.

Member	Description	Type	Example
shift	The resource shift.	ResourceShift	None
slots	The planning slots.	PlanningSlot[ ]	None

PlanningSlot

JSON serializable class for allocations of resources to phases in micro planning.

Member	Description	Type	Example
absence	Contains an absence, if any	AbsenceSlot	None
allocation	Contains a reservation (microallocation)	MicroAllocationSlot	None
presence	Flag that indicates whether resource is present (true) or not (false)	boolean	None
model	Contains information about the slot in the worktime model that may be overridden by the resource's plan	ModelSlot	None
presenceDesc	A short description of the type of presence	string	Describe the planning slot..

ModelSlot

Defines a worktime model slot.

Member	Description	Type	Example
presence	Flag if for presence or not.	boolean	None
duration	Time duration of this slot.	duration	None
holiday	Description of the slot.	string	Christmas

MicroAllocationStatistics

JSON serializable class for allocations of resources to phases in micro planning.

Member	Description	Type	Example
absences	Field that contains all absences by ID.	MicroAllocationSlotCount[ ]	None
projects	Field that contains all projects by ID.	MicroAllocationSlotCount[ ]	None
available	Field that contains all days with availability > 0.	MicroAllocationSlotCount	None
unavailable	Field that contains all days with availability = 0.	MicroAllocationSlotCount	None

MicroAllocationSlotCount

JSON serializable class for allocations of resources to phases in micro planning.

Member	Description	Type	Example
id	Depending on type, either a phaseId or an absenceId	string	0C961A5AC3B6492DBB7D1418D6B9E85C
hint	Field that contains a short hint (i.e. for a tooltip)	string	Short hint..
slotcount	Field that contains the number of slots with this ID	int	None

MicroAllocationSlot

Contains information about a resource reservation (micro allocation)

Member	Description	Type	Example
projectId	Project id this allocation references.	string	1305E2DCC2D74E58ABA7F776F895021D
projectName	Project's name.	string	New project..
scenarioId	Scenario id this allocation references.	string	73D09C2A234643EB87B46EBCEF3F2749
scenarioName	The scenario's name.	string	New scenario..
phaseId	Phase id this allocation references.	string	9E42BB2E370A4E7B8653A07CA44789A0
phaseName	The phase' name.	string	New phase..

ProjectWithPhases

JSON serializable class for information about a resource and the projects allocated to it.

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
phases	Array of phases of a project.	GanttItem[ ]	None

MacroAllocationStructure

JSON serializable class for information about a resource and the projects allocated to it.

Member	Description	Type	Example
projects	Array of projects with phases.	ProjectWithPhases[ ]	None

AbsenceSlot

Defines an absence slot by type, name, color and remark.

Member	Description	Type	Example
absenceType	ID of the absence type.	string	RES-ABSENCE-TYPE-01
absenceName	Name for this absence.	string	Holiday
absenceColor	Color for the absence.	string	red
remark	Comment for the absence.	string	Around the world trip!

AllocationHistory

Contains information about changes that lead to changes in work load of a resource

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
activeScenarioTimeline	The different active scenario changes that lead to a change in work load	ItemTimelineWithReference[ ]	None
absencesTimeline	The different absence changes that lead to a change in work load	MicroAllocationTimeline	None
reservationsTimeline	The different reservation changes that lead to a change in work load	MicroAllocationTimeline	None
workItemTimeline	The different changes that were applied to project work items	WorkItemTimeline[ ]	None
allocationTimeline	The different changes that were applied to project work item allocations	MacroAllocationTimeline[ ]	None

AvailabilitySlot

Contains macro allocations and availability information for a resource during a time span

Member	Description	Type	Example
availability	The availability of a resource (working time without absences)	duration	None
capacity	The maximum amount of time that may be referenced (used by client for y-axis scaling)	duration	None
fte	The amount of time a full time equivalent (FTE) represents	duration	None
ftePercent	The amount of full time equivalents (FTE) this resource contains in percent	int	None

WorkItemTimeline

The timeline of changes on a micro planning of a resource

Member	Description	Type	Example
items	The references	WorkItemTimelineEntry[ ]	None
ref	A reference to an object the timeline is corresponding to	Reference	None

WorkItemTimelineEntry

A timeline entry containing a macro allocation with the previous one

Member	Description	Type	Example
current	The current macro allocation	WorkItem	None
previous	The current macro allocation	WorkItem	None
pointInTime	The point in time from which this item is referenced	datetime	None
user	The user who contributed to this entry	Item	None

MacroAllocationTimeline

The timeline of changes on a micro planning of a resource

Member	Description	Type	Example
items	The references	MacroAllocationTimelineEntry[ ]	None
ref	A reference to an object the timeline is corresponding to	Reference	None

MacroAllocationTimelineEntry

A timeline entry containing a macro allocation with the previous one

Member	Description	Type	Example
current	The current macro allocation	ResourceAllocation	None
previous	The current macro allocation	ResourceAllocation	None
workItem	The basic information about the work item	Item	None
workItemStart	The start of the work item	datetime	None
workItemEnd	The end of the work item	datetime	None
pointInTime	The point in time from which this item is referenced	datetime	None
user	The user who contributed to this entry	Item	None

MicroAllocationTimeline

The timeline of changes on a micro planning of a resource

Member	Description	Type	Example
items	The references	MicroAllocationTimelineEntry[ ]	None

MicroAllocationTimelineEntry

A timeline entry containing an item

↳ (ItemTimelineEntry)

Member	Description	Type	Example
user (ItemTimelineEntry)	The user who contributed to this entry	Item	None
obj (ItemTimelineEntry)	The historic item, if not deleted	Item	None
pointInTime (ItemTimelineEntry)	The point in time from which this item is referenced	datetime	None
date	The date of the slot	date	None
shift	The shift of the slot	string	RES_SHIFT_AM

MacroAllocationSlot

Contains macro allocations and availability information for a resource during a time span

↳ (AvailabilitySlot)

Member	Description	Type	Example
ftePercent (AvailabilitySlot)	The amount of full time equivalents (FTE) this resource contains in percent	int	None
capacity (AvailabilitySlot)	The maximum amount of time that may be referenced (used by client for y-axis scaling)	duration	None
availability (AvailabilitySlot)	The availability of a resource (working time without absences)	duration	None
fte (AvailabilitySlot)	The amount of time a full time equivalent (FTE) represents	duration	None
presence	The presence of a resource (as reported in time recording)	duration	None
expectedPresence	The presence of a resource that has not yet been reported but is expected to be reported	duration	None
deviationFromOptimum	The deviation from optimum (100% of availability allocated) calculated on each day	double	None
forecasts	The individual forecasts per group	TimeForecast[ ]	None

ProjectAllocation

Contains information about a project allocation of a resource

Member	Description	Type	Example
project	Information about the allocated project	ItemWithDeletedFlag	None
projectStatus	Information about the project status	Item	None
isActive	true, if project and scenario are active	boolean	None
planned	Total planned effort	duration	None
actual	Total actual effort reported	duration	None
expectedPending	Total expected actual effort not yet reported	duration	None
remaining	Total effort remaining	duration	None

ProjectAllocations

Information about all project allocations of a resource

Member	Description	Type	Example
availability	The availability of the resource in the given time range	duration	None
projects	Contains information about the projects	ProjectAllocation[ ]	None

ProjectWorkItemAllocation

Information about effort (planned vs. actual) on a project work item

Member	Description	Type	Example
workItem	The project work item	Item	None
planned	Sum of planned effort	duration	None
actual	Sum of actual effort	duration	None
expectedPending	Sum of expected pending effort	duration	None
remaining	Sum of remaining effort	duration	None

ProjectWorkItemAllocations

Information about effort of a resource on different project work items

Member	Description	Type	Example
resource	A reference to the resource	ItemWithDeletedFlag	None
availability	The total availability of the resource in a time range	duration	None
workItems	The efforts on the different project work items	ProjectWorkItemAllocation[ ]	None

ResourceAllocation

Describes a resource allocation

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
projectId	The project's ID the work item is part of	string	1A3689826EED499C84479D3934A6490D
scenarioId	The scenario's ID the work item is part of	string	93DF0B43734A457F86C3BE8B9B417CCD
workItemId	The work item's ID	string	D1B31789316B4A48AA60BB1BBE05F871
resourceType	The assigned resource's type	string	RES-TYP-EMPL
resourceId	The assigned resource's ID	string	9C7A2E3065E54793AAF58D9DCB1A88C7
state	The state in the allocation workflow (read-only)	AllocationWorkflowState	None
amount	The amount that is assigned	double	None
amountMin	The minimal assigned amount that is requested / approved (depending on the state)	double?	None
amountMax	The maximal assigned amount that is requested / approved (depending on the state)	double?	None
amountUnit	The unit of the amount (hours, days, ...)	string	H
amountType	The type amount (how it is measured)	ResourceAllocationAmountType	None
startEarliest	The earliest start that is requested / approved (depending on the state)	date	None
startLatest	The latest start that is requested / approved (depending on the state)	date	None
endEarliest	The earliest end that is requested / approved (depending on the state)	date	None
endLatest	The latest end that is requested / approved (depending on the state)	date	None
remark	The remark that was set at change of state	string	If not possible, someone else would also be ok
effectiveDuration	The effective duration, should be equal amount if absolute	duration	None

ResourceAllocationWorkflowHistory

Contains the history of states and transitions of a specific allocation

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
state	The state that was reached	AllocationWorkflowState	None
timestamp	The point in time when state was reached	datetime	None
initiatedBy	A reference to the user that initiated the lifecycle change (may be null in rare cases)	ItemWithDeletedFlag	None
remark	A remark that describes the reason of or any other information about the change	string	All planning is done and verified

TimeForecast

The forecast of an allocation comparing planning, done and still to be done

Member	Description	Type	Example
planned	The planned (allocated) amount of time	duration	None
actual	The time that has already been spent and reported	duration	None
expectedActual	The time that has already been spent (reported or planned)	duration	None
remaining	The estimated time that still needs to be spent	duration	None

Workload

A workload histogram over a certain time

Member	Description	Type	Example
maxFtePercent	The maximum amount of full time equivalents (FTE) this resource contains in percent (as it may change over time)	int	None
maxCapacity	the maximum amount of time that may be referenced (used by client for y-axis scaling)	duration	None
grouping	The definition of the forecast groups	string[ ]	None
slots	The allocation slots, one for each time unit	MacroAllocationSlot[ ]	None
actualsReportedUntil	Contains the last day with valid project actuals reporting, if any	date	None
presenceReportedUntil	Contains the last day with valid presence reporting, if any	date	None

WorkloadByResource

Workload by resource (for bulk requests)

Member	Description	Type	Example
resource	A reference to a resource	Reference	None
workload	The workload of the resource	Workload	None

CompileError

Information about a compilation error of programming code

Member	Description	Type	Example
source	The source file or ID	string	A728CF99A2D941BBAE6EE5A7612233AC
line	The line on which the error occurred	int?	None
message	A descriptive text about the error	string	Missing '}'

JavaScriptChangeTrigger

Describes when to trigger a JavaScript program automatically

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
objectType	The object type to listen for changes	string	Project
objectId	The object ID to listen for changes (null for all objects of given type)	string	7A59182176FA450195A8854FEA214622
action	The action that triggers the program (null for all actions)	Action	None

JavaScriptConsole

Contains lines with JavaScript console logs

Member	Description	Type	Example
logs	The lines ordered by timestamp	JavaScriptConsoleLog[ ]	None

JavaScriptConsoleLog

A line of JavaScript console log

Member	Description	Type	Example
timestamp	The time when the log was done	datetime	None
sandboxId	The ID of the sandbox / script	string	ACFC91B6963A458F8CE4CDAA749BEFDD
type	The type of log	JavaScriptConsoleLogType	None
text	The text that was logged	string	Hello world!

JavaScriptLibrary

Describes a JavaScript library

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	The name of the library	string	moment.js
version	The version of the library	string	2.29.3
authors	The authors of the library	string	Tim Wood, Iskren Chernev, Moment.js contributors
license	The license of the library	string	MIT license
url	The url to the homepage with further information	string	https://momentjs.com

JavaScriptPerformanceStats

Contains JavaScript performance statistics

Member	Description	Type	Example
successful	Contains the number of successful completions	int	None
failed	Contains the number of failed attempts to complete	int	None
totalRunTimeMs	Contains the total run time in milliseconds (over all attempts)	long	None
totalApiStats	Contains the total run time in milliseconds for each API that was called (over all attempts)	JavaScriptApiPerformanceStats[ ]	None
totalJavaScriptRunTimeMs	Contains the total JavaScript run time in milliseconds (over all attempts)	long	None

JavaScriptApiPerformanceStats

Contains JavaScript performance statistics for a specific API call

Member	Description	Type	Example
endpoint	The name of the API endpoint	string	Pqf.atm.getJavaScriptSandboxPerformance
count	Contains the number of calls	int	None
totalRunTimeMs	Contains the total run time in milliseconds (over all calls)	long	None

JavaScriptQuota

Contains information about the JavaScript quota

Member	Description	Type	Example
max	The maximum running time per hour	duration	None
used	The running time during the last hour	duration	None

JavaScriptSource

A JavaScript program

↳ (VersionedItem)

↳ (Reference)

Member	Description	Type	Example
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
libraries	The libraries in use	string	MOMENT
shareAsLibrary	Set this flag, if source can be included by others as library	boolean	None
permissionOverride	Set this flag, if source should be executed with same permissions as last modifying user, even if ran or triggered by someone else	boolean	None
sourceCode	The JavaScript source code	string	console.log('Hello world!');

Baseline

A chart baseline (x-axis definition and values)

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
values	The values of the x axis	string[ ]	None
refs	References to objects that are bound to the values in the x-axis (may be null, if no objects are bound)	Item[ ]	None
scale	The definition of the scale that will be placed on the x axis	ScalePoint[ ]	None

BaselineDayDef

A baseline definition with calendar entries

Member	Description	Type	Example
from	The leftmost day on the x axis	date	None
to	The day after the rightmost day on the x axis	date	None
unit	The unit which defines the granularity	string	DAYS

BaselineModel

Defines the metamodel of a baseline and its compatibility to different datasets

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
baselineType	The baseline type	string	Projects
filterType	The type of filter that may be applied	string	ProjectsFilter
datasetGroups	The different datasets (grouped) that are compatible with the baseline	DatasetModelGroup[ ]	None

BaselineLifecycleDef

Defines a baseline containing different lifecycle states

Member	Description	Type	Example
stateIds	Restrict to objects that are in a given lifecycle state	string[ ]	None

BaselineProjectDef

Defines a baseline containing different projects

Member	Description	Type	Example
portfolioId	Restrict to projects that are part of a given portfolio	string	3124A9D12F67494486F02E271E037481
portfolioIds	Restrict to projects that are part of a portfolio in the list	string	None
managementMethodId	The id of the management Method	string	F00A8684C4A5464F88A60201238B7709
properties	Restrict to projects matching the given property values.	KeyValuePair[ ]	None
classifications	Restrict to projects matching the given classification values.	KeyValuePair[ ]	None
projectIds	Restrict to given projects	string[ ]	None
stateIds	Restrict to projects that are in a given lifecycle state	string[ ]	None
indicators	The indicators to filter for	IndicatorFiltersDef	None

BaselineProjectPortfolioDef

Defines a baseline containing different projects

Member	Description	Type	Example
portfolioId	Restrict to projects that are part of a given portfolio	string	3124A9D12F67494486F02E271E037481
portfolioIds	Restrict to projects that are part of a portfolio in the list	string	None
properties	Restrict to projects matching the given property values.	KeyValuePair[ ]	None

IndicatorFiltersDef

Defines filters which are related to indicators

Member	Description	Type	Example
reportType	Filter for the given report type	string	None
leading	Filter for the given leading indicator	IndicatorSelectorDef	None
dimensions	Filter for the given indicator dimension	IndicatorSelectorDef[ ]	None
details	Filter for the given indicator detail	IndicatorSelectorDef[ ]	None

IndicatorSelectorDef

Defines an indicator dimension or detail filter.

Member	Description	Type	Example
compare	What should be compared (one of status, trend, actual, target, forecast, remaining, planned, supplementary)	string	None
id	The indicator dimension or detail to check	string	None
values	The acceped values	string	None

KeyValuePair

Contains a simple pair of key and value

Member	Description	Type	Example
key	The key to a value	string	None
value	The value of the key	string	None

Chart

A chart's values

Member	Description	Type	Example
baseline	The x axis	Baseline	None
datasets	The different datasets that are plotted according to the values on the x axis	Dataset[ ]	None

ChartModel

The metamodel that describes all possible chart contents and their compatibility for a given kind of chart

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
baselines	The different baselines that are possible	BaselineModel[ ]	None

Dataset

A chart baseline (x-axis definition and values)

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
semantics	The semantics of the values.	string	None
unit	The unit of the elements.	string	None
values	The values that will be mapped onto the y axis	string[ ]	None
scale	The definition of the scale that will be placed on the y axis	ScalePoint[ ]	None

DatasetAggregationDef

Defines an aggregation of datasets (sum, average, ...)

Member	Description	Type	Example
aggregation	The aggregation function	Aggregation	None

DatasetDayDef

A dataset to group days according to a calendar unit

Member	Description	Type	Example
unit	The unit	string	MONTHS

DatasetLifecycleStateDef

A dataset that uses the lifecycle state of the baseline objects

Member	Description	Type	Example
stateIds	All possible state IDs	string[ ]	None
aggregation	Apply a given aggregation	Aggregation	None

DatasetModel

Defines the metamodel of a dataset

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
datasetType	The dataset type	string	Lifecycle
filterType	The type of filter that may be applied	string	LifecycleFilter

DatasetModelGroup

A group of dataset models to make it easier to navigate through the dataset models

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
datasets	The dataset models that belong to that group	DatasetModel[ ]	None

DatasetProjectsDef

A dataset that contains projects for given aspects

Member	Description	Type	Example
portfolioId	Restrict to projects that are part of a given portfolio	string	3124A9D12F67494486F02E271E037481
portfolioIds	Restrict to projects that are part of a portfolio in the list	string	None
projectIds	Restrict to given projects	string[ ]	None
stateIds	Restrict to projects that are in a given lifecycle state	string[ ]	None
aggregation	Apply a given aggregation	Aggregation	None

DatasetProjectPortfoliosDef

A dataset that contains projects for given aspects

Member	Description	Type	Example
portfolioId	Restrict to projects that are part of a given portfolio	string	3124A9D12F67494486F02E271E037481
portfolioIds	Restrict to projects that are part of a portfolio in the list	string	None
aggregation	Apply a given aggregation	Aggregation	None

DatasetProjectAndCostsDef

A dataset that contains costs of projects for given aspects

Member	Description	Type	Example
portfolioId	Restrict to projects that are part of a given portfolio	string	3124A9D12F67494486F02E271E037481
portfolioIds	Restrict to projects that are part of a given portfolios	string	None
projectIds	Restrict to given projects	string[ ]	None
stateIds	Restrict to projects that are in a given lifecycle state	string[ ]	None
costsContainerIds	Restrict to costs from a given costs container	string[ ]	None
costsTypeIds	Restrict to costs of a given costs type	string[ ]	None
aggregation	Apply a given aggregation	Aggregation	None

ScalePoint

Defines a point of the scale of a value on an axis

Member	Description	Type	Example
value	the value	string	01BB854F58B2401B96BC60EAC1BD2B42
label	The label that is shown	Item	None

CockpitWidget

Structure that contains information about cockpit widget

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
objectType	Type classification of the object	string	Portfolio
widgetType	Type classification of the widget	string	projectsOverview
definition	Contains information about the widget	string	'cols': {'prj:name':{}, 'prj:status':{}}, 'filters': []
sortIndex	An index value that indicates the correct order	double	None
tags	Strings assigned to widgets to mark them	string[ ]	None
category	Group classification of the widget	string	ProjectStatus

CockpitWidgetTranslated

Structure that contains information about cockpit widget with translation

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
objectType	Type classification of the object	string	Portfolio
widgetType	Type classification of the widget	string	projectsOverview
definition	Contains information about the widget	string	'cols': {'prj:name':{}, 'prj:status':{}}, 'filters': []
sortIndex	An index value that indicates the correct order	double	None
tags	Strings assigned to widgets to mark them with translation	Translation[ [ ] ]	None
category	Group classification of the widget with translation	Translation[ ]	None
sandboxId	A reference to JavaScript code returning JTF data	string	4F024DAEDAF649BBADC6A9DD9D2D6B7B

ObjectStoreReference

A reference to an objects store

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
storeId	The object store ID	string	F3056EDB2CA648359D716695210C0808

SharedDataReference

A reference to shared data, identified by type and ID

Member	Description	Type	Example
type	The type of the object (used for change notifications)	string	SharedData
id	The ID of the object (base 32 or base62 encoded hash)	string	5XwzKGiGApp4c3dfjlp19IVDyDxcHCoMQIBjJt5PIcJ

ThirdPartyError

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

Member	Description	Type	Example
type	The type of error that happened	string	Promise(Error)
method	The HTTP method of the call that was involved	string	GET
url	The URL of the call that was involved	string	https://test.pqforce.com/API/V2/XY/Abc/Def
statusCode	The status code of the call that was involved	string	200
message	Describes the error that happened	string	Cannot read property 'id' of null
clientVersion	The exact version number of the client	string	3.24.0.0
details	More details about the error, i.e. a stack trace	string	at https://test.pqforce.com/DF75A26246DF5E2C9C70E48E2553A35B/imports/pqf.html.js:319:118

NewUuidArray

Array of new Universally Unique Identifiers (UUIDs)

Member	Description	Type	Example
newUuids	Generated, unique, random UUIDs	string	65A90C6B30EC401C83F5F6766D45CBFE

UuidArray

Array of Universally Unique Identifiers (UUIDs)

Member	Description	Type	Example
uuids	UUIDs	string	3DB9382EB29248C7AE2CF5CF02DF7E00

Classification

Contains a classification of a specific object including the ratings

Member	Description	Type	Example
classificationSchemaId	A reference to the classification scheme	string	291ABC133A554A9F9CC7E5EF7654FDD7
data	The different ratings for each attribute	ClassificationData[ ]	None
classificationId	A reference to the resulting classification depending on the ratings	string	41D3A3705A4749038F2154B757ED3577
score	A numeric value containing the score	double?	None

ClassificationAttribute

Describes an attribute which will be rated. Multiple attribute ratings result in an overall rating which will be represented by the classification

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
weight	The weight that will be applied to calculate the weighted average which will be used to determine the resulting classification	double	None
values	The possible values that may be selected to rate this attribute	ClassificationAttributeValue[ ]	None

ClassificationAttributeTranslated

Describes an attribute which will be rated. Multiple attribute ratings result in an overall rating which will be represented by the classification

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
weight	The weight that will be applied to calculate the weighted average which will be used to determine the resulting classification	double	None
values	The possible values that may be selected to rate this attribute	ClassificationAttributeValueTranslated[ ]	None

ClassificationAttributeValue

A value that might be selected to rate a classification attribute

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
points	The amount of points that will be used to calculate the weighted average which will be used to determine the resulting classification	double	None

ClassificationAttributeValueTranslated

A value that might be selected to rate a classification attribute

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
points	The amount of points that will be used to calculate the weighted average which will be used to determine the resulting classification	double	None

ClassificationClass

A resulting classification that is determined by categorizing the weighted average of all attribute's ratings

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
minPoints	The minimum points of weighted average that is needed to be categorized as this classification	double	None

ClassificationClassTranslated

A resulting classification that is determined by categorizing the weighted average of all attribute's ratings

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
minPoints	The minimum points of weighted average that is needed to be categorized as this classification	double	None

ClassificationData

Contains a rating of any attribute estimated by the user

Member	Description	Type	Example
attributeId	The referenced attribute	string	41A649C11AF54F89A87A084E932A3D8D
valueId	The estimated value	string	EA2BEA4D58D44AE08D4674399F25E299
description	A descriptive text where the user may explain his/her estimation	string	As we have realized similar projects in the near past quite a few times, the costs are estimated quite accurate.

ClassificationSchema

Describes how a classification is determined

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
objectType	The type of object for which the classification schema is defined	string	PROJECT
classes	The different classifications that may result	ClassificationClass[ ]	None
attributes	The different attributes that must be rated to receive a classification	ClassificationAttribute[ ]	None
sortIndex	An index value that indicates the correct order	double	None
presentation	Different options that define how the results are presented	ClassificationPresentation[ ]	None
precision	Defines the number of digits after the decimal point to be shown	int	None
customCalculationRule	Contains a JavaScript snippet for calculating the score of the classification. The attribute values are provided as object "attributes", containing objects with value information (id and points). Set to null for weighted standard calculation	string	2 * attributes['ID1'].points - attributes['ID2'].points

ClassificationSchemaTranslated

Describes how a classification is determined

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
objectType	The type of object for which the classification schema is defined	string	PROJECT
classes	The different classifications that may result	ClassificationClassTranslated[ ]	None
attributes	The different attributes that must be rated to receive a classification	ClassificationAttributeTranslated[ ]	None
sortIndex	An index value that indicates the correct order	double	None
presentation	Different options that define how the results are presented	ClassificationPresentation[ ]	None
precision	Defines the number of digits after the decimal point to be shown	int	None
customCalculationRule	Contains a JavaScript snippet for calculating the score of the classification. The attribute values are provided as object "attributes", containing objects with value information (id and points). Set to null for weighted standard calculation	string	2 * attributes['ID1'].points - attributes['ID2'].points

ClusterState

Diagnostic information about cluster state

↳ (State)

Member	Description	Type	Example
load (State)	An indicator about load, ranging from 0-100	int1	None
state (State)	An enum defining current state	States	None
responseTime (State)	The (average) response time in ms	long1	None
totalNodes	The total number of nodes in cluster	int	None
runningNodes	The number of nodes running	int	None
nodes	Information about cluster	NodeState[ ]	None

NodeState

State information about a node

↳ (State)

Member	Description	Type	Example
load (State)	An indicator about load, ranging from 0-100	int1	None
state (State)	An enum defining current state	States	None
responseTime (State)	The (average) response time in ms	long1	None

State

Generic state information about a cluster or a node

Member	Description	Type	Example
state	An enum defining current state	States	None
responseTime	The (average) response time in ms	long?	None
load	An indicator about load, ranging from 0-100	int?	None

ServerEnvironment

Describes the server environment PQFORCE is running on

Member	Description	Type	Example
snapshot	Contains the timestamp when this environment snapshot was created	datetime	None
osName	Contains the name of the operating system	string	Windows Server 2016
osArch	Contains the architecture of the system	string	amd64
osVersion	Contains the version string as provided by the operating system	string	10.0
processorCount	Contains the number of logical processors present	int	None
memorySize	Contains the memory size in bytes	long	None
java	Contains the java version string	string	11.0.14+9 (Eclipse Adoptium)
time	Contains the current time	datetime	None
datastore	Contains information about the datastore	ServerEnvironmentDataStore	None

ServerEnvironmentDataStore

Contains information about the datastore

Member	Description	Type	Example
productName	The name of the database product	string	Microsoft SQL Server
productVersion	The version of the data store product	string	13.00.7000
host	The host name of the data store	string	my-db-server
location	The name of the data store	string	instance/dbname
settings	Different settings that apply, if any	KeyValuePair[ ]	None

KeyValuePair

A simple key value pair combination

Member	Description	Type	Example
key	A key	string	Key
value	A value	string	Value

ErrorLog

Contains an error log with full failure information, suitable for developers

Member	Description	Type	Example
tenant	Contains the tenant ID where this error happened	string	091B73F1F2DF40FDB36FB7483EEB8B75
alias	Contains the tenant's alias (used for starting PQFORCE)	string	intrasoft
id	Contains the ID of the error log (hashed, so that the same error results in the same ID)	string	3EE76EB294D65AA8A49582E97711857E
subsystem	The subsystem of PQFORCE that reported this error	string	SRV
type	The type of error that happened (subsystem- and environment-specific)	string	java.lang.IllegalArgumentException
method	The HTTP method of the call that was involved (if applicable)	string	GET
url	The URL of the call that was involved (if applicable)	string	https://test.pqforce.com/API/V2/DOC/ExportViewConfiguration/ActivityRecording
statusCode	The status code of the call that was involved (if applicable)	string	400
message	The error message that describes the error	string	Parameter view not valid
details	Additional details like a stack trace that may help developers to reproduce, identify and fix the issue	string	java.lang.IllegalArgumentException: Parameter view not valid at doc.application.v2.DocApiImpl.getExportConfiguration(DocApiImpl.java:138) at doc.api.DocController ...
serverVersion	The server version string	string	3.28.1 Stable Release Build 271
clientVersion	The client version string (if applicable)	string	3.28.1.0
browser	The user agent string that has been sent by the browser (if applicable)	string	Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36
clientIp	The IP address of the client that invoked the request (if applicable)	string	46.14.212.22
firstOccurrence	The timestamp when this error first occurred	datetime	None
lastOccurrence	The timestamp when this error last occurred	datetime	None

PerformanceIndicators

Contains information about the performance of PQFORCE

Member	Description	Type	Example
snapshot	The point in time when the performance snapshot was acquired	datetime	None
memorySize	The memory size in bytes	long	None
heapSize	The java heap size in bytes	long	None
processorLoad	The processor load (0 - 1)	double	None
memoryLoad	The memory load (0 - 1)	double	None
heapLoad	The heap load (0 - 1)	double	None
startUp	The point in time when PQFORCE was started	datetime	None
counters1h	Performance counters for different processes and events	PerformanceCounter[ ]	None
counters24h	Performance counters for different processes and events	PerformanceCounter[ ]	None
events24h	Counter history for different events over the last 24h	EventHistory[ ]	None
queues24h	Queue size history for different queues over the last 24h	QueueHistory[ ]	None
gcInfo	Contains information about the garbage collection process	PerformanceGcInfo	None

PerformanceCounter

Describes the performance of a process or event

Member	Description	Type	Example
func	The process or event	string	GET /PM/V1/Projects
count	Counts how many times the process was executed or event occurred	long	None
avg	The average time in milliseconds that it took to process	int	None
min	The minimal time in milliseconds that it took to process	int	None
max	The maximal time in milliseconds that it took to process	int	None

EventHistory

Describes the historic counters of an event

Member	Description	Type	Example
func	The event	string	HTTP REST API call
timeline	Counts how many times per second the event occurred (the oldest value first)	double	None

QueueHistory

Describes the historic sizes of a queue

Member	Description	Type	Example
func	The event	string	HTTP REST API call
timeline	Contains the queue sizes over time (the oldest value first)	MinMax[ ]	None

MinMax

Describes a range of values

Member	Description	Type	Example
min	Minimal value, inclusive	long	None
max	Maximal value, inclusive	long	None

PerformanceGcInfo

Contains information about the garbage collection process

Member	Description	Type	Example
lastRun	Contains information about the last run, if any	PerformanceGcLastRun	None
stats1h	Contains GC stats over the last hour	PerformanceCounter	None
stats24h	Contains GC stats over the last 24 hours	PerformanceCounter	None

PerformanceGcLastRun

Contains information about the last garbage collection process

Member	Description	Type	Example
name	The name of the garbage collector	string	G1
cause	Contains the cause that lead to garbage collection	string	Allocate failed
action	Contains the action that was performed	string	Collect
usedBefore	Contains the number of bytes that were used before collection	long	None
usedAfter	Contains the number of bytes that were used after collection	long	None
at	The point in time of the run	datetime	None

ExportViewConfiguration

Defines the export configuration for the specific view

Member	Description	Type	Example
id	ID of the export configuration according to view received	string	C39B4BC021F64BB19DC6782A89D02AA3
name	Name of the configuration	string	testNewConfiguration
description	Description for the configuration	string	Configuration test
options	JSON describes the configuration	string	{appendixTemplate:,onePagerConfiguration:{verticalLine:{positionX:,thickness:},headerFontSize:0,sections:[]},viewOptions:{}}
exportTemplates	List of available template ids	string	{"id": ["382ED332D5E045038322378924615F7A"]}
objectTypes	List of enabled object type ids	string	{"id": ["ProjectReport"]}

ExportRequestView

Describe the view of the export

Member	Description	Type	Example
exportViewType	Name of the view	ExportViewType	None
options	JSON describes the configuration	string	None
configurationViewId	Id of the configuration related to specific view	string	None
appendixTemplateId	Id of the template used for appendix in the report export	string	None

ExportTemplate

Describe the export template

Member	Description	Type	Example
id	ID of the template	string	None
name	Name of the template	string	None
description	Description of the template	string	None
view	Client view name	string	None
type	The type of the output document	string	None
fileType	The format type of the output file	string	None
template	Template data	string	None

ExportConfigurationRequest

Describe the export template

Member	Description	Type	Example
name	Export view configuration name	string	None
description	Export view configuration description	string	None
view	Client view name	string	None
options	Actual configuration described by a Json	string	None
exportTemplates	filter of available templates	string	None
objectTypes	List of enabled object type ids	string	{"id": ["ProjectReport"]}

ExportRequest

Describe the export template

Member	Description	Type	Example
type	Export type enum	string	None
format	Export file type enum	string	None
templateId	ID of the template	string	None
view	Export view data	ExportRequestView	None

AvailableExport

Describe the available export

Member	Description	Type	Example
exportType	The type of export corresponding to enum doc.business.ExportType	string	None
exportFileType	The type of file corresponding to enum doc.business.ExportFileType	string	None

DispoAuthorization

Special structure that contains authorization information that lets clients show or hide some interactive UI controls

↳ (Authorizations)

Member	Description	Type	Example
delete (Authorizations)	true, if deleting is allowed	boolean	None
view (Authorizations)	true, if viewing is allowed	boolean	None
change (Authorizations)	true, if changing is allowed	boolean	None
changeMacroPlanning	Whether macro planning may be changed or not	boolean	None

DispoPhase

Special work item or absence structure for resource disposition

↳ (PaletteColorItem)

↳ (Reference)

↳ (GanttItem)

Member	Description	Type	Example
fixed (GanttItem)	if true, beg and end cannot be modified	boolean	None
beg (GanttItem)	start if interval, or point of milestone, never null	datetime	None
validityUntil (PaletteColorItem)	End (exclusive) of the validity period of the object (often null)	date	None
color (PaletteColorItem)	An identifier of a color	string	CF9A70F432064EE7910DC857DFC4173D
description (PaletteColorItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (PaletteColorItem)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (PaletteColorItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (PaletteColorItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (PaletteColorItem)	Start (inclusive) of the validity period of the object (often null)	date	None
ganttId (GanttItem)	Special ID for GANTT to distinguish	string	2C38CEE968C84A5BB49BB0D68E8EF648
end (GanttItem)	end of interval, or null for milestones	datetime	None
progress	the progress in percent	double	None
budget	the time budget for the work item	duration	None
planned	the planned time	duration	None
assigned	the assigned time for the resource (by allocation)	duration	None
assignedActual	the actual time reported by the resource	duration	None
assignedExpectedPending	the time that is expected to have been worked by the resource, but has not yet been reported	duration	None
assignedRemaining	the time that still needs to be spent by the resource for the work item	duration	None
phaseAssigned	the total time assigned to all resource	duration	None
phaseActual	the total time reported by all resources	duration	None
phaseExpectedPending	the time that is expected to have been worked by all resources, but has not yet been reported	duration	None
phaseRemaining	the time that still needs to be spent by all resources for the work item	duration	None
state	The state in the allocation workflow (read-only)	AllocationWorkflowState	None
shared	indicates that there are multiple resources assigned to the work item	boolean	None
parentPhaseId	the parent work item ID	string	60115D90E3EF4A12BA390B717614FA3A
authorizations	Contains special authorization information for the disposition UI	DispoAuthorization	None

ProjectWithPhases

Contains information about a project and its phases that is assigned to a resource

↳ (PaletteColorItem)

↳ (Reference)

↳ (GanttItem)

Member	Description	Type	Example
fixed (GanttItem)	if true, beg and end cannot be modified	boolean	None
beg (GanttItem)	start if interval, or point of milestone, never null	datetime	None
validityUntil (PaletteColorItem)	End (exclusive) of the validity period of the object (often null)	date	None
color (PaletteColorItem)	An identifier of a color	string	CF9A70F432064EE7910DC857DFC4173D
description (PaletteColorItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (PaletteColorItem)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (PaletteColorItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (PaletteColorItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (PaletteColorItem)	Start (inclusive) of the validity period of the object (often null)	date	None
ganttId (GanttItem)	Special ID for GANTT to distinguish	string	2C38CEE968C84A5BB49BB0D68E8EF648
end (GanttItem)	end of interval, or null for milestones	datetime	None
stateId	The lifecycle state of the project	string	3362E868AACD404CA1E758E91F367D28
phases	Contains all phases that are assigned to a resource	DispoPhase[ ]	None

ResourceAllocationWithPhasesAndAbsences

information about the projects and absences of a resource

Member	Description	Type	Example
projects	the projects and their work items that are assigned	ProjectWithPhases[ ]	None
absences	the absences	GanttItem[ ]	None

JavaScriptExportDefinition

Information about a JavaScript export definition

↳ (VersionedItem)

↳ (Reference)

Member	Description	Type	Example
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
attachmentId	Attachment file ID	string	C5SQWCK4WSR2U2TYFSTR3HQ73MPIBD3DCNENYRNSZV4KB7CYVR3Q
sandboxId	JavaScript source code ID	string	5D781DF3A8D347B6A446E45C90067AE9
objectTypes	Type of object for which the definition exist	string	"Project","ProjectPortfolio"
features	the features (tabs) this export should be available in (null for all)	string	"details","costs"
includeInBackup	Flag to indicate that an export should be included into backup files	boolean	None

Currency

Information about a currency

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
sortIndex	An index value that indicates the correct order (higher after lower)	double	None

CurrencyAmount

An amount of money

Member	Description	Type	Example
amount	exact amount	double	None
currency	ID of the currency	string	CURRENCY-CHF

ConvertedCurrencyAmount

An amount of money that might have been converted into another currency

Member	Description	Type	Example
original	exact amount as it was entered	CurrencyAmount	None
converted	amount converted into destination currency	CurrencyAmount	None

CurrencyExchangeRate

Defines the exchange rate between a currency and a (virtual) currency starting from a given date

Member	Description	Type	Example
validityStart	The first date this rate applies	date	None
rate	The rate that applies starting from the given date	double	None

CurrencyExchangeRates

Defines the exchange rate between a currency and a (virtual) currency over time

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
rates	The different rates, ordered by starting date	CurrencyExchangeRate[ ]	None

BudgetCalculated

A calculated budget like a sum

Member	Description	Type	Example
budgetAmount	The amount of budget to spend	CurrencyAmount	None
assignedAmount	The amount of budget that has been assigned to sub objects	CurrencyAmount	None
bufferAmount	The amount of budget that has not yet been assigned to sub objects	CurrencyAmount	None

BudgetPosition

A budget position

↳ (Reference)

↳ (VersionedItem)

Member	Description	Type	Example
properties (VersionedItemWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
budgetAmount	The amount of budget to spend	CurrencyAmount	None
assignedAmount	The amount of budget that has been assigned to sub objects (calculated, read-only)	CurrencyAmount	None
bufferAmount	The amount of budget that has not yet been assigned to sub objects (calculated, read-only)	CurrencyAmount	None
costsType	The costs type that is assigned to this budget	NamedReference	None
sortIndex	A value indicating the custom sort order (the lowest first)	double	None
source	The budget source (read-only)	BudgetSource	None

BudgetPositionsByReference

Budget positions grouped by reference (for bulk requests)

Member	Description	Type	Example
ref	The reference to the parent object	Reference	None
positions	The budget positions	BudgetPosition[ ]	None

BudgetSource

Describes a source for budgets (root budget position and assigning project portfolio)

Member	Description	Type	Example
projectPortfolioId	A reference to the project portfolio that provides the budget	string	8722D287B57E4CFC8885BBF030547FC6
originId	A reference to the root budget position	string	4AA4D9B7A2734E238442AB99FC7E3005

CostsActual

A disbursement that was made

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name	The name of the object (in the user's language, if translations are available)	string	Project X
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
color	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityEnd	End (exclusive) of the validity period of the object (often null)	date	None
properties	A collection of dynamic properties belonging to the object	Property[ ]	None
timeOfPayment	The day when payment was done or will be done	date	None
plannedAmount	The amount that will be paid or was paid	ConvertedCurrencyAmount	None
sortIndex	The index that can be used to define the order of the costs actual (the lowest first)	double	None

CostsActualGroup

Costs actuals grouped by costs position

Member	Description	Type	Example
group	The reference to a costs position	NamedReference	None
actuals	The costs actuals in that group	CostsActual[ ]	None

CostsForecast

A costs forecast for a given type of costs

↳ (CostsForecastCalculated)

Member	Description	Type	Example
remaining (CostsForecastCalculated)	The remaining amount	CurrencyAmount	None
actual (CostsForecastCalculated)	The actual amount	CurrencyAmount	None
planned (CostsForecastCalculated)	The planned amount	CurrencyAmount	None
expectedPending (CostsForecastCalculated)	The expected pending amount	CurrencyAmount	None
type	The costs type that applies to the forecast	NamedReference	None

CostsForecastCalculated

A calculated costs forecast like a sum

Member	Description	Type	Example
planned	The planned amount	CurrencyAmount	None
actual	The actual amount	CurrencyAmount	None
expectedPending	The expected pending amount	CurrencyAmount	None
remaining	The remaining amount	CurrencyAmount	None

CostsForecasts

Summed costs forecasts

Member	Description	Type	Example
forecasts	The individual forecasts	CostsForecast[ ]	None
forecastTotal	The total of all forecasts	CostsForecastCalculated	None
forecast	The effective forecast as single currency amount (actual + remaining)	CurrencyAmount	None

CostsForecastGroup

A costs forecast for a given type of costs

↳ (CostsForecasts)

Member	Description	Type	Example
forecast (CostsForecasts)	The effective forecast as single currency amount (actual + remaining)	CurrencyAmount	None
forecasts (CostsForecasts)	The individual forecasts	CostsForecast	None
forecastTotal (CostsForecasts)	The total of all forecasts	CostsForecastCalculated	None
typeGroup	The costs type group that applies to the forecast	NamedReference	None

CostsForecastsGroups

Summed costs forecasts by costs type group

Member	Description	Type	Example
forecasts	The individual forecasts	CostsForecastGroup[ ]	None
forecastTotal	The total of all forecasts	CostsForecastCalculated	None
forecast	The effective forecast as single currency amount (actual + remaining)	CurrencyAmount	None

CostsMatrix

A costs matrix with cascaded grouping of costs timelines with hierarchic calendar

↳ (CostsMatrixGroup)

Member	Description	Type	Example
total (CostsMatrixGroup)	The total over all	CurrencyAmount	None
layers (CostsMatrixGroup)	The timeline layers according to calendar definition in the matrix	CostsMatrixLayer	None
groups (CostsMatrixGroup)	Subgroups of this group	CostsMatrixGroup	None
calendar	The hierarchic calendar	Calendar	None
hierarchy	The hierarchic matrix	CostsMatrixHierarchy[ ]	None

CostsMatrixGroup

A group within the costs matrix with timeline according to calendar definition in the matrix and total

Member	Description	Type	Example
layers	The timeline layers according to calendar definition in the matrix	CostsMatrixLayer[ ]	None
groups	Subgroups of this group	CostsMatrixGroup[ ]	None
total	The total over all	CurrencyAmount	None

CostsMatrixHierarchy

A hierarchical element within the matrix

Member	Description	Type	Example
dimension	The dimension that is used to separate the different groups	CostsDimension	None
label	The label that is used to describe the hierarchy (according to the dimension) in the user's language	string	Kostenfluss
items	The different items that the costs are grouped into. They all belong to the dimension specified	Item[ ]	None

CostsMatrixLayer

A costs timeline corresponding to a calendar layer with explicit values for the range that is split in two parts by today

Member	Description	Type	Example
rangeToToday	The amount from the start of the range until today	CurrencyAmount	None
rangeFromToday	The amount from today until the end of the range	CurrencyAmount	None
ranges	The different amounts for each range within the calendar layer	CurrencyAmount[ ]	None

CostsOverview

A costs overview providing the status of budget vs. forecast at a glance

Member	Description	Type	Example
reference	The reference to the object (for bulk requests)	Reference	None
budgets	All budget positions providing budget to that object (some may be inherited from another object)	BudgetPosition[ ]	None
budgetsInForeignObjs	Sum of all Budgets that are used in sub objects, but are managed in foreign objects (not in children)	BudgetCalculated	None
budgetsInSubObjs	Sum of all Budgets that are used in sub objects, but are managed in objects being a child of the current object	BudgetCalculated	None
managedBudgetTotal	Sum of all budgets being managed by this object	BudgetCalculated	None
budgetsInExternalObjsTotal	Sum of all Budgets that are used in sub objects, but are managed by another object (budgetsInForeignObjs + budgetsInSubObjs)	BudgetCalculated	None
managedBudgetWithSubObjsTotal	Sum of all budgets being managed by this object or any child	BudgetCalculated	None
budgetTotal	Sum of all budgets	BudgetCalculated	None
forecasts	Costs forecasts by costs type	CostsForecastGroup[ ]	None
forecastTotal	The sum of all forecasts	CostsForecastCalculated	None
forecast	The foreseen total amount of costs of all sub objects	CurrencyAmount	None
plannedDiffBudget	Planned costs versus budget	CurrencyAmount	None
plannedDiffAssignedBudget	Planned costs versus assigned budget	CurrencyAmount	None
actualDiffPlanned	Actual costs versus planned	CurrencyAmount	None
forecastDiffPlanned	Foreseen costs versus planned costs	CurrencyAmount	None
forecastDiffBudget	Foreseen costs versus budget	CurrencyAmount	None
forecastDiffAssignedBudget	Foreseen costs versus assigned budget	CurrencyAmount	None

CostsPosition

A costs position of a project or similar object

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name	The name of the object (in the user's language, if translations are available)	string	Project X
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
color	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityEnd	End (exclusive) of the validity period of the object (often null)	date	None
properties	A collection of dynamic properties belonging to the object	Property[ ]	None
costsType	The type of costs that this position belongs to	NamedReference	None
costsCenter	The costs center which is responsible for payment and budget	NamedReference	None
payPlan	This defines how payment has to be done (in advance, continuous, ...)	NamedReference	None
plannedAmount	The amount that is planned to spend	ConvertedCurrencyAmount	None
supplementaryAmount	Additional amount that has not initially been planned but is now planned	ConvertedCurrencyAmount	None
remainingAmount	The amount that still needs to be paid	ConvertedCurrencyAmount	None
provisionalAmount	The amount that must, but still needs to be paid	CurrencyAmount	None
actualAmount	The amount that has been paid (calculated, read-only)	CurrencyAmount	None
availableAmount	The amount that is available (initial plan - actual)	CurrencyAmount	None
obligo	true, if this is an obligo costs position (meaning fixed by contract)	boolean	None
sortIndex	The index that can be used to define the order of the costs positions (the lowest first)	double	None
forecastScheme	Defines whether remaining or supplementary was provided. Forecast = actual + remaining or forecast = planned + supplementary	ForecastSchema	None

CostsType

Type of costs (personnel costs, material costs, ...)

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
group	The group this costs type belongs to	CostsTypeGroup	None
payPlan	This defines how payment has to be done (in advance, continuous, ...)	string	FCO-TFP-CONTINUOUS
sortIndex	The index that defines default sorting of objects, lowest first	double	None

CostsTypeTranslated

Type of costs (personnel costs, material costs, ...)

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
groupId	The group this costs type belongs to	string	812AE64212DE4123988002D0494CA93F
payPlan	This defines how payment has to be done (in advance, continuous, ...)	string	FCO-TFP-CONTINUOUS
sortIndex	The index that defines default sorting of objects, lowest first	double	None

CostsTypeGroup

Group for types of costs (personnel costs, material costs, ...)

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
sortIndex	The index that defines default sorting of objects, lowest first	double	None

CostsTypeGroupTranslated

Group for types of costs (personnel costs, material costs, ...)

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
sortIndex	The index that defines default sorting of objects, lowest first	double	None

ExternalBudget

Contains an external budget source

Member	Description	Type	Example
budget	The description of the budget	NamedReference	None
portfolio	The description of the portfolio	NamedReference	None
amount	The amount of budget that was granted	CurrencyAmount	None

ProjectCostsPosition

A costs position of a project

↳ (CostsPosition)

Member	Description	Type	Example
forecastScheme (CostsPosition)	Defines whether remaining or supplementary was provided. Forecast = actual + remaining or forecast = planned + supplementary	ForecastSchema	None
obligo (CostsPosition)	true, if this is an obligo costs position (meaning fixed by contract)	boolean	None
actualAmount (CostsPosition)	The amount that has been paid (calculated, read-only)	CurrencyAmount	None
remainingAmount (CostsPosition)	The amount that still needs to be paid	ConvertedCurrencyAmount	None
plannedAmount (CostsPosition)	The amount that is planned to spend	ConvertedCurrencyAmount	None
costsCenter (CostsPosition)	The costs center which is responsible for payment and budget	NamedReference	None
properties (CostsPosition)	A collection of dynamic properties belonging to the object	Property	None
validityStart (CostsPosition)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (CostsPosition)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (CostsPosition)	A short code which may be unique over all objects of the same type	string	PRJ-X
name (CostsPosition)	The name of the object (in the user's language, if translations are available)	string	Project X
description (CostsPosition)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (CostsPosition)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityEnd (CostsPosition)	End (exclusive) of the validity period of the object (often null)	date	None
costsType (CostsPosition)	The type of costs that this position belongs to	NamedReference	None
payPlan (CostsPosition)	This defines how payment has to be done (in advance, continuous, ...)	NamedReference	None
supplementaryAmount (CostsPosition)	Additional amount that has not initially been planned but is now planned	ConvertedCurrencyAmount	None
provisionalAmount (CostsPosition)	The amount that must, but still needs to be paid	CurrencyAmount	None
availableAmount (CostsPosition)	The amount that is available (initial plan - actual)	CurrencyAmount	None
sortIndex (CostsPosition)	The index that can be used to define the order of the costs positions (the lowest first)	double	None
assignedWorkItems	The work items that refer to this costs position, read-only	Item[ ]	None

ProjectCostsPositionWithActuals

A costs position of a project with its actuals

↳ (ProjectCostsPosition)

↳ (CostsPosition)

Member	Description	Type	Example
assignedWorkItems (ProjectCostsPosition)	The work items that refer to this costs position, read-only	Item	None
sortIndex (CostsPosition)	The index that can be used to define the order of the costs positions (the lowest first)	double	None
availableAmount (CostsPosition)	The amount that is available (initial plan - actual)	CurrencyAmount	None
provisionalAmount (CostsPosition)	The amount that must, but still needs to be paid	CurrencyAmount	None
supplementaryAmount (CostsPosition)	Additional amount that has not initially been planned but is now planned	ConvertedCurrencyAmount	None
payPlan (CostsPosition)	This defines how payment has to be done (in advance, continuous, ...)	NamedReference	None
costsType (CostsPosition)	The type of costs that this position belongs to	NamedReference	None
validityEnd (CostsPosition)	End (exclusive) of the validity period of the object (often null)	date	None
color (CostsPosition)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (CostsPosition)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (CostsPosition)	The name of the object (in the user's language, if translations are available)	string	Project X
code (CostsPosition)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (CostsPosition)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (CostsPosition)	Start (inclusive) of the validity period of the object (often null)	date	None
properties (CostsPosition)	A collection of dynamic properties belonging to the object	Property	None
costsCenter (CostsPosition)	The costs center which is responsible for payment and budget	NamedReference	None
plannedAmount (CostsPosition)	The amount that is planned to spend	ConvertedCurrencyAmount	None
remainingAmount (CostsPosition)	The amount that still needs to be paid	ConvertedCurrencyAmount	None
actualAmount (CostsPosition)	The amount that has been paid (calculated, read-only)	CurrencyAmount	None
obligo (CostsPosition)	true, if this is an obligo costs position (meaning fixed by contract)	boolean	None
forecastScheme (CostsPosition)	Defines whether remaining or supplementary was provided. Forecast = actual + remaining or forecast = planned + supplementary	ForecastSchema	None
actuals	The actuals for this project costs position	CostsActual[ ]	None

ItemWithLifecycle

A generic item with basic identifying information, validity and current lifecycle state

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
lifecycleState	The current lifecycle state	LifecycleStateWithSubState	None

LifecycleHistory

Contains an entry of history of states and transitions of a specific object

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
version	The version ID of the lifecycle entry	string	DF23BAFE32A042A3915790B0878DA8EE
state	The state that was reached	LifecycleStateWithSubState	None
transition	The transition that was used to reach the state (may be null for initial state)	LifecycleTransition	None
timestamp	The point in time when state was reached	datetime	None
initiatedBy	A reference to the user that initiated the lifecycle change (may be null in rare cases)	ItemWithDeletedFlag	None
remark	A remark that describes the reason of or any other information about the change	string	All planning is done and verified

LifecycleHistoryArrayWithObjId

Contains the history of states and transitions of a specific object with object ID reference

Member	Description	Type	Example
objectId	The reference to the object ID	string	9DF2414C9D80434ABB79B29C7889B17C
history	The history of states and transitions	LifecycleHistory[ ]	None

LifecycleState

Describes a state in an object's lifecycle with all sub-states

↳ (LifecycleStateBase)

Member	Description	Type	Example
radius (LifecycleStateBase)	The radius for drawing the lifecycle	double1	None
posX (LifecycleStateBase)	The x position on the canvas for drawing the lifecycle	double1	None
isDecision (LifecycleStateBase)	true, if from workflow point of view, someone needs to decide which state comes next	boolean	None
category (LifecycleStateBase)	The category of state	LifecycleCategory	None
sortIndex (LifecycleStateBase)	The index that defines the sorting of states	double	None
posY (LifecycleStateBase)	The y position on the canvas for drawing the lifecycle	double1	None
subStates	The specific sub-state	LifecycleSubState[ ]	None

LifecycleStateArrayWithObjId

Describes a state in an object's lifecycle with all sub-states and with object ID reference

Member	Description	Type	Example
objectId	The reference to the object ID	string	9DF2414C9D80434ABB79B29C7889B17C
states	States in an object's lifecycle with all sub-states	LifecycleState[ ]	None

LifecycleStateBase

Describes a state in an object's lifecycle

↳ (ItemWithProperties)

↳ (Reference)

↳ (Item)

Member	Description	Type	Example
properties (ItemWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (Item)	A color or any identifier of a color	color	None
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
category	The category of state	LifecycleCategory	None
isDecision	true, if from workflow point of view, someone needs to decide which state comes next	boolean	None
sortIndex	The index that defines the sorting of states	double	None
posX	The x position on the canvas for drawing the lifecycle	double?	None
posY	The y position on the canvas for drawing the lifecycle	double?	None
radius	The radius for drawing the lifecycle	double?	None

LifecycleStateTranslated

Describes a state in an object's lifecycle

↳ (ItemTranslatedWithProperties)

↳ (Reference)

↳ (ItemTranslated)

Member	Description	Type	Example
properties (ItemTranslatedWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name (ItemTranslated)	The name of the object in different languages	Translation	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
category	The category of state	LifecycleCategory	None
isDecision	true, if from workflow point of view, someone needs to decide which state comes next	boolean	None
sortIndex	The index that defines the sorting of states	double	None
posX	The x position on the canvas for drawing the lifecycle	double?	None
posY	The y position on the canvas for drawing the lifecycle	double?	None
radius	The radius for drawing the lifecycle	double?	None

LifecycleStateWithSubState

Describes a state with one specific sub-state in an object's lifecycle

↳ (LifecycleStateBase)

Member	Description	Type	Example
radius (LifecycleStateBase)	The radius for drawing the lifecycle	double1	None
posX (LifecycleStateBase)	The x position on the canvas for drawing the lifecycle	double1	None
isDecision (LifecycleStateBase)	true, if from workflow point of view, someone needs to decide which state comes next	boolean	None
category (LifecycleStateBase)	The category of state	LifecycleCategory	None
sortIndex (LifecycleStateBase)	The index that defines the sorting of states	double	None
posY (LifecycleStateBase)	The y position on the canvas for drawing the lifecycle	double1	None
subState	The specific sub-state	LifecycleSubState	None

LifecycleStateWithSubStateReference

Describes a state with one specific sub-state in an object's lifecycle

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
subState	The specific sub-state	Reference	None

LifecycleStateWithSubStateAndObjId

Describes a state with one specific sub-state in an object's lifecycle with object ID reference

↳ (LifecycleStateWithSubState)

↳ (LifecycleStateBase)

Member	Description	Type	Example
subState (LifecycleStateWithSubState)	The specific sub-state	LifecycleSubState	None
posY (LifecycleStateBase)	The y position on the canvas for drawing the lifecycle	double1	None
sortIndex (LifecycleStateBase)	The index that defines the sorting of states	double	None
category (LifecycleStateBase)	The category of state	LifecycleCategory	None
isDecision (LifecycleStateBase)	true, if from workflow point of view, someone needs to decide which state comes next	boolean	None
posX (LifecycleStateBase)	The x position on the canvas for drawing the lifecycle	double1	None
radius (LifecycleStateBase)	The radius for drawing the lifecycle	double1	None
objectId	The reference to the object ID	string	9DF2414C9D80434ABB79B29C7889B17C

LifecycleSubState

Describes a sub-state in an object's lifecycle

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None

LifecycleSubStateTranslated

Describes a sub-state in an object's lifecycle with translations

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
sortIndex	the sortIndex (lowest first)	double	None

LifecycleTransition

Describes a transition in an object's lifecycle

↳ (ItemWithProperties)

↳ (Reference)

↳ (Item)

Member	Description	Type	Example
properties (ItemWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (Item)	A color or any identifier of a color	color	None
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
from	The preceding lifecycle state	LifecycleStateWithSubState	None
to	The succeeding lifecycle state	LifecycleStateWithSubState	None

LifecycleTransitionTranslated

Describes a transition in an object's lifecycle with translations

↳ (ItemTranslatedWithProperties)

↳ (Reference)

↳ (ItemTranslated)

Member	Description	Type	Example
properties (ItemTranslatedWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name (ItemTranslated)	The name of the object in different languages	Translation	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
from	The preceding lifecycle state	LifecycleStateWithSubStateReference	None
to	The succeeding lifecycle state	LifecycleStateWithSubStateReference	None

LifecycleTransitionArrayWithObjId

Describes transitions in an object's lifecycle with reference to an object ID

Member	Description	Type	Example
objectId	The reference to the object ID	string	9DF2414C9D80434ABB79B29C7889B17C
transitions	Transitions in an object's lifecycle with all sub-states	LifecycleTransition[ ]	None

ObjectReferencesInLifecycleState

Lifecycle states with corresponding objects

↳ (LifecycleStateWithSubStateReference)

Member	Description	Type	Example
subState (LifecycleStateWithSubStateReference)	The specific sub-state	Reference	None
objects	The objects in the specific sub state	Reference[ ]	None

ReferenceWithLifecycle

A generic item with basic identifying information, validity and current lifecycle state

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
lifecycleState	The current lifecycle state	string	0D2F77718EE94E94AC6E64D97E16BEA1

License

Contains license information

Member	Description	Type	Example
tenant	The tenant's ID	string	D219F33291B043C79B892892FEAF69F8
license	The license string	string	:f0]#EarZ'/Kdl+@;]ssDJ((`DKKH+Ch[NnDI[6#3\;c

LicenseQuota

Describes the usage of a licensed quota

Member	Description	Type	Example
type	The type of object	NamedReference	None
usage	The number of objects in use	int	None
limit	The number of objects licensed (null if unlimited)	int?	None

LicenseStatus

Contains information about the current license

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
company	Contains the name of the company this license is assigned to	string	Bottstone
admin	Contains the administrator's e Mail	string	info@bottstone.com
edition	Contains the name of the edition of PQFORCE that is licensed	string	ULTIMATE
validUntil	Contains the point in time when this license will expire	datetime	None
usage	Contains the number of used vs. number of licensed objects	LicenseQuota[ ]	None

LicenseUsage

The effective usage of a license

Member	Description	Type	Example
tenant	The tenant's ID	string	D219F33291B043C79B892892FEAF69F8
objects	The usage of objects (projects, resources, ...)	LicenseUsageAmount[ ]	None
authorisations	The usage of authorizations (users with special rights)	LicenseUsageAmount[ ]	None

LicenseUsageAmount

An amount of objects of a license that are in use by the tenant

Member	Description	Type	Example
id	The object's identification (object type or access right)	string	Project
count	The number of objects that are in use	int	None

ServerStatus

Describes the current status of the application and connections

Member	Description	Type	Example
application	describes the status of the application server	StatusItem	None
database	describes the status of the database	StatusItem	None
mail	describes the status of the mail service (SMTP)	StatusItem	None

Versions

Version information about this PQFORCE instance

Member	Description	Type	Example
productName	The name of the product	string	PQFORCE Server
productVersion	The version of the product	string	3.22.1 Stable Release Build 200
apiGeneration	The generation of API	string	V2
apiVersion	The version of the API (three numbers divided by dots)	string	3.23.0
apiFingerprint	The fingerprint of the API (32 alphanumeric chars with dashes)	string	XOI3-AKGX-6253-KFOS-MCIM-RJUC-7PCZ-7DIK

MessageForwardRule

Describes a message forwarding rule

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
subjectRegEx	The RegEx pattern to match the subject	string	.*
bodyRegEx	The RegEx pattern to match the body	string	.*
sourceTypeRegEx	The RegEx pattern to match the source type	string	.*
sourceIdRegEx	The RegEx pattern to match the source ID	string	.*
addresseesShownRegEx	The RegEx pattern to match the addressees shown	string	.*
triggerRegEx	The RegEx pattern to match the trigger	string	.*
sortIndex	The sort index for the rule (lowest first)	double	None

Message

Describes a message in the PQFORCE messaging system

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
subject	The subject of the message	string	I need your help in an important project
body	The body (content) of a message	string	I have a very critical project that is going to be too expensive. Could you please give me some hints how to save money?
source	The source of the message. This may be a sender (resource) or any other object	Reference	None
addresseesShown	The addressees (there may be more recipients which are hidden)	Item[ ]	None
trigger	The trigger that created this message (if any, null otherwise)	string	8141E55CF7D44703A2FC8DF48EACDDFF
urgency	Describes a level how urgent this message is	MessageUrgency	None
privacy	Describes a privacy level	MessagePrivacy	None
validityStart	the start of validity (may be null)	date	None
validityUntil	the end of validity (may be null)	date	None
createdAt	The timestamp when this message was created	datetime	None
createdBy	A text to the creator of the message	Item	None
readAt	The timestamp when this message was read	datetime	None
forwardedAt	The timestamp when this message was forwarded	datetime	None

MessageContent

Describes the message content that should be sent

Member	Description	Type	Example
subject	The subject of the message	string	I need your help in an important project
body	The body (content) of a message	string	I have a very critical project that is going to be too expensive. Could you please give me some hints how to save money?
addressees	The persons (resources) that should receive the message	string[ ]	None
urgency	Describes a level how urgent this message is	MessageUrgency	None
privacy	Describes a privacy level	MessagePrivacy	None
validityStart	the start of validity (may be null)	date	None
validityUntil	the end of validity (may be null)	date	None

Meeting

Describe a meeting

↳ (Reference)

↳ (VersionedItem)

Member	Description	Type	Example
properties (VersionedItemWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
groupId	groupId	string	XYZ
location	Location of the meeting	string	Milan office
timeStart	Start time of the meeting	datetime	None
timeEnd	End time of the meeting	datetime	None

MeetingGroup

Describe a meeting group

↳ (Reference)

↳ (VersionedItem)

Member	Description	Type	Example
properties (VersionedItemWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
parentGroupId	groupId	string	id

AddUrlArg

Meta information about POST URLs in navigation for adding or linking

Member	Description	Type	Example
url	URL for POST to add a new item, format as in routes file, always starts with '/'. May contain the following placeholders: - :type and :id of current item - :linktype and :forward of this link - :argtype and :argid of dropped or selected object - :origintype and :originid of dropped or selected object	string	/API/V2/Project/Copy?pf=:id&src=:argid
behaviour	specifies the behaviour of ADD URL with ARG	AddUrlArgBehaviour	None
argumentTypes	list of item types allowed as arguments	string[ ]	None
argumentUrl	URL for GET to query arguments, format as in routes file, always starts with '/'. May contain the following placeholders: - :type and :id of current item - :linktype and :forward of this link - :argtype (a value from argumentTypes)	string	/API/V2/PM/Projects
dropPriority	If dropping onto an item with multiple link types matching criteria: Choose the one with highest prio (the lowest number)	double	None
allowOriginObject	true, if dropping into same object is allowed	boolean	None
allowOriginLinkType	true, if dropping into same link group is allowed	boolean	None

DeleteUrl

Meta information about DELETE URLs in navigation

Member	Description	Type	Example
url	URL for DELETE to delete links or linked item, format as in routes file, always starts with '/'. May contain the following placeholders: - :type and :id of current item - :linktype and :forward of this link - :reftype and :refid of referenced item (from NavigationLink.items[])	string	/API/V2/PM/Project/:reftype
behaviour	Metainformation about the semantics of the delete operation with the given URL	DeleteUrlBehaviour	None

Tab

A feature (tab) above the detail screen in the client

Member	Description	Type	Example
id	ID identifying the tab (descriptive, no UUID)	string	gantt
name	The name of the tab in the user's language that should be displayed by the client	string	Planung
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
color	A color or any identifier of a color	color	None

FindLinkQuery

Describes a relation to another object to be found

↳ (FindQuery)

Member	Description	Type	Example
link (FindQuery)	Tries to match a link	FindLinkQuery	None
memberRegex (FindQuery)	Matches a RegEx on a member	FindMemberRegexQuery	None
regex (FindQuery)	Matches an object if given RegEx matches somewhere (optional)	string	Planning\s+Intelligence
objectType (FindQuery)	Applies only to given type (optional)	string	Project
fulltext (FindQuery)	Matches an object if given text is found somewhere (optional)	string	Planning Intelligence
ranking (FindQuery)	The maximum ranking of members to be included into search (optional, default is 5)	int1	None
memberText (FindQuery)	Matches a text on a member	FindMemberTextQuery	None
linkType	Looks for a given link type	string	BDAD82A3821B420BAC6D9CC03B065C73
forward	Specifies the direction seen from the originating object (optional)	boolean?	None

FindMemberRegexQuery

Describes a RegEx that may match a single member of an object

Member	Description	Type	Example
member	Looks for a given member (required)	string	Description
regex	The RegEx to be matched	string	Planning\s+Intelligence

FindMemberTextQuery

Describes a text that may be found within a single member of an object

Member	Description	Type	Example
member	Looks for a given member (required)	string	Description
text	The RegEx to be matched	string	Planning Intelligence

FindRequest

A generic request to initiate an advanced search

↳ (FindQuery)

Member	Description	Type	Example
link (FindQuery)	Tries to match a link	FindLinkQuery	None
memberRegex (FindQuery)	Matches a RegEx on a member	FindMemberRegexQuery	None
regex (FindQuery)	Matches an object if given RegEx matches somewhere (optional)	string	Planning\s+Intelligence
objectType (FindQuery)	Applies only to given type (optional)	string	Project
fulltext (FindQuery)	Matches an object if given text is found somewhere (optional)	string	Planning Intelligence
ranking (FindQuery)	The maximum ranking of members to be included into search (optional, default is 5)	int1	None
memberText (FindQuery)	Matches a text on a member	FindMemberTextQuery	None
root	Specifies a root object to start search (optional)	Reference	None

FindQuery

A generic query that matches an object with relations

Member	Description	Type	Example
objectType	Applies only to given type (optional)	string	Project
fulltext	Matches an object if given text is found somewhere (optional)	string	Planning Intelligence
regex	Matches an object if given RegEx matches somewhere (optional)	string	Planning\s+Intelligence
ranking	The maximum ranking of members to be included into search (optional, default is 5)	int?	None
memberRegex	Matches a RegEx on a member	FindMemberRegexQuery[ ]	None
memberText	Matches a text on a member	FindMemberTextQuery[ ]	None
link	Tries to match a link	FindLinkQuery[ ]	None

LinkTypeInfo

a type of linked navigation items

Member	Description	Type	Example
linktype	1st part of composite key	string	LNKTYPE-PROJECT-PROJECTSCENARIO
forward	2nd part of composite key	boolean	None
name	The name of the link type in the user's language (displayed as header of the navigator groups)	string	Szenarien
description	A descriptive text about the object	string	Ein Szenario ist eine Planungsvariante
imageUrl	The icon for the link type	string	../images/bigrisk.svg
color	The color for the link type to be visualized	color	None
deleteUrls	URL for DELETE to delete links or linked item, format as in routes file, always starts with '/'. May contain the following placeholders: - :type and :id of current item - :linktype and :forward of this link - :reftype and :refid of referenced item (from NavigationLink.items[])	DeleteUrl[ ]	None
addUrl	URL for POST to add a new item, format as in routes file, always starts with '/'. May contain the following placeholders: - :type and :id of current item - :linktype and :forward of this link	string	/API/V2/PM/Project/Add?pf=:id
addUrlsArg	URLs for POST to add a new item	AddUrlArg[ ]	None
sortIndex	The sortIndex for the client - can be ignored at the moment, because links will be already sorted when coming from the server	double	None
inheritWorkload	Flag for the client whether workload will be taken from children to their parents	boolean	None
navigable	Information whether this link will be shown in the navigator for navigating	boolean	None

MemberInfo

Information about a member / property of an object

Member	Description	Type	Example
name	The name / ID of the object's member / property	string	name
type	The type of the member	string	string
label	The label in the user's language	string	Name

NavigationContext

Navigation information about an object with ancestors and children / links

Member	Description	Type	Example
current	Information about the current navigation object	NavigationItem	None
links	The groups of links available from current object	NavigationLink[ ]	None
ancestors	All ancestors of the current object starting with the nearest	NavigationItem[ ]	None

NavigationItem

A navigable object

↳ (ItemWithDeletedFlag)

↳ (Reference)

↳ (Item)

Member	Description	Type	Example
isDeleted (ItemWithDeletedFlag)	This flag indicates that an item was deleted and cannot be used anymore	boolean	None
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (Item)	A color or any identifier of a color	color	None
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
readAuth	Contains information whether the user is allowed to view further details about this object	Grant	None

NavigationLink

Contains information about a group of links to items (linked or children)

Member	Description	Type	Example
parent	The parent navigation item	NavigationItem	None
linktype	1st part of composite key, references TypeInfo.links[].linktype	string	LNKTYPE-PROJECT-PROJECTSCENARIO
forward	2nd part of composite key, references TypeInfo.links[].forward	boolean	None
name	The name of the link group according to its direction (forward or not) and the user's language	string	Scenarios
description	The description of the link group according to its direction (forward or not) and the user's language	string	Different planning variants
imageUrl	The icon for the link type	string	../images/bigrisk.svg
color	The color for the link type to be visualized	color	None
items	linked items or children)	NavigationLinkedItem[ ]	None

NavigationLinkedItem

An object that is contained in a group of links

Member	Description	Type	Example
linkId	A unique ID (UUID in most cases) of the link	string	F87AC81332BF434388D6F5E53A6F170A
item	Information about the item	NavigationItem	None

TypeInfo

Provides structural information about types, their properties and URLs

Member	Description	Type	Example
type	The type of object (used for change notifications)	string	Project
module	The PQFORCE module that objects of this type belong to	Item	None
name	The name of the type in the user's language	string	Projet
url	URL for GET, PUT, DELETE to edit details, format as in routes file, always starts with '/'. May contain the following placeholders: - :type and :id of current item	string	/API/V2/PM/Project/:id
members	Information about members / properties (i.e. for search masks)	MemberInfo[ ]	None
links	Information about the network of objects, how they are connected together	LinkTypeInfo[ ]	None
features	The different features (tabs) that are shown in the client when an object of this type is selected	Tab[ ]	None
showParent	Indicates whether the nearest parent should be shown in the navigator	boolean	None
ambiguousParent	For some types, it is ambiguous which parent should be used. In this case, a parent should be provided when getting navigation context	boolean	None

Access

Access information to be provided in the WebSocket by the client to inform about object usage

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
access	The type of access (view / edit)	AccessType	None

AccessConcurrency

Access information to be provided in the WebSocket by the server to inform about object usage of other users

Member	Description	Type	Example
object	The object that is in use	Reference	None
userIds	The user IDs of the users accessing the object references	string[ ]	None

AttachmentDetails

Contains basic information about an attachment, but no data

↳ (AttachmentReference)

Member	Description	Type	Example
id (AttachmentReference)	The ID of the attachment (base 32 encoded hash)	string	3PVYCXUGOAQQDKPAEF6U2BNS7Z3VQSHPNKLBXR4OCG7ETJR7XTTQ
type (AttachmentReference)	The type of the object (used for change notifications)	string	Attachment
mimeType	The MIME type of the attachment (see https://www.iana.org/assignments/media-types/media-types.xhtml)	string	image/png
size	The size of the attachment in bytes	long	None
timestamp	The point in time when the attachment was added	datetime	None

AttachmentLink

A link between an object and an attachment

↳ (DocumentLink)

↳ (VersionedItem)

↳ (Reference)

Member	Description	Type	Example
sortIndex (DocumentLink)	A sort index that may be used by the client to fix a specific order	double	None
mimeType (DocumentLink)	The MIME type of the referenced document (see https://www.iana.org/assignments/media-types/media-types.xhtml, if known)	string	image/png
parentFolder (DocumentLink)	The parent folder's ID (may be null for root)	string	77E64B4803664F279F662638CA2CE7E9
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
properties (VersionedItemWithProperties)	A collection of dynamic properties belonging to the object	Property	None
url (DocumentLink)	The URL to the document (may be on any external system)	string	http://google.com/maps/@47.1493072,8.4386003,14z
size (DocumentLink)	The size of the referenced document in bytes (if known)	long1	None
attachmentId	The ID of the attachment	string	2NRSHHD53PAKJTUQLODYUAC2JC2GUDIWCOIZ4253LR5HRLZ5K75A
timestamp	The point in time when the attachment link was added	datetime	None

AttachmentReference

A reference to shared data, identified by type and ID

Member	Description	Type	Example
type	The type of the object (used for change notifications)	string	Attachment
id	The ID of the attachment (base 32 encoded hash)	string	3PVYCXUGOAQQDKPAEF6U2BNS7Z3VQSHPNKLBXR4OCG7ETJR7XTTQ

Authorization

Describes authorizations that are granted for an object

Member	Description	Type	Example
objectType	The type of object	string	Project
objectId	The ID of the object	string	F7020992D6C74409861CD12B3D70C54A
action	The action that may be performed on that object (null, if transition is set)	string	READ
transition	The ID of the lifecycle transition that may be performed on that object (null, if action is set)	string	5950ABC229F0469A84415E3709388CE1
grant	Indicator whether the action or transition will be granted or not	Grant	None

Authorizations

Contains simple flags, which basic actions may be performed on an object

Member	Description	Type	Example
view	true, if viewing is allowed	boolean	None
change	true, if changing is allowed	boolean	None
delete	true, if deleting is allowed	boolean	None

BackupMetadata

Additional information stored in a backup file

Member	Description	Type	Example
type	The type of object stored within the backup	string	Project
name	The name of the object stored within the backup	string	Secret Project
code	The code of the object stored within the backup	string	PRJ-007
description	The description of the object stored within the backup	string	The least important project
createdAt	The point in time when the backup was created	datetime	None

Calendar

A hierarchical calendar

Member	Description	Type	Example
layers	The different layers (years, months, weeks, ...) that are used	CalendarLayer[ ]	None

CalendarLayer

A calendar layer with the different ranges according to the layer's unit (i.e. January, February, ...)

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
ranges	The ranges belonging to the layer	CalendarRange[ ]	None

CalendarRange

A range of day defining a unit in a calendar layer

Member	Description	Type	Example
label	The label that can be shown in the user's language	string	Januar
first	The first day belonging to the unit	date	None
last	The last day belonging to the unit	date	None

CertificateInfo

Descriptive information about a certificate

Member	Description	Type	Example
serialNumber	Contains the serial number of the certificate	string	12345678
commonName	Contains the common name of the certificate	string	pqforce.com
expiry	Contains the expiry of the certificate	datetime	None
fingerprint	Contains the fingerprint (SHA 256) of the certificate	string	29 A8 1E 52 23 CB A6 67 FA 7F 8A 88 8D E6 71 39 4B 17 8C 80 EF CC CC 55 BF 09 27 D5 D1 F8 96 8F

ConnectionInformationSeenFromClient

Describes the connection as seen from client side

Member	Description	Type	Example
websocketSessionId	The session ID received by websocket, null if no websocket connection or not yet received	string	746C75ADA6214CE8B8BE5789EE34CB86

ConnectionInformationSeenFromServer

Describes the connection as seen from server side

Member	Description	Type	Example
clientPublicIp	The client's IP as seen from server	string	172.217.168.3
proxy	Information about a proxy, if detected, null otherwise	string	Header present: http_x_forwarded
deviceType	The type of device that was detected	string	desktop
operatingSystem	The operating system that was detected	string	Windows NT v. 10.0
browser	The browser that was detected	string	Chrome v. 88.0.4324.104

Details

Legacy details object

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	The name of the object (in the user's language, if translations are available)	string	Project X
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color	The color of an object	color	None
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityEnd	End (exclusive) of the validity period of the object (often null)	date	None
properties	Dynamic properties with metadata	Property[ ]	None

DocumentLink

A link between an object and a document

↳ (Reference)

↳ (VersionedItem)

Member	Description	Type	Example
properties (VersionedItemWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
parentFolder	The parent folder's ID (may be null for root)	string	77E64B4803664F279F662638CA2CE7E9
url	The URL to the document (may be on any external system)	string	http://google.com/maps/@47.1493072,8.4386003,14z
mimeType	The MIME type of the referenced document (see https://www.iana.org/assignments/media-types/media-types.xhtml, if known)	string	image/png
size	The size of the referenced document in bytes (if known)	long?	None
sortIndex	A sort index that may be used by the client to fix a specific order	double	None

DocumentFolder

A folder to organize documents on an object

↳ (Reference)

↳ (VersionedItem)

Member	Description	Type	Example
properties (VersionedItemWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
parentFolder	The parent folder's ID (may be null for root)	string	77E64B4803664F279F662638CA2CE7E9

EnumType

Describes an enum type

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
hardcoded	Specifies whether this is a hardcoded or customizable enum	boolean	None

ErrorInformation

Information about an error that is shown to the client in case of error (HTTP code >= 400)

Member	Description	Type	Example
id	An ID that defines the error (the same ID will be returned, if the same error occurs multiple times)	string	5950ABC229F0569A84415E3709388CE1
message	A detailed or generic message that may be in the user's language or not	string	Client sent invalid request
internalCode	internal code to allow the client to react in a specific manner	string	ERR_NO_IDEA

Feature

Describes a feature view (tab) of any object

Member	Description	Type	Example
type	The type of the object	string	ProjectPortfolio
id	The ID of the object	string	5950ABC229F0469A84415E3709388CE1
feature	The feature ID	string	Detail

FeatureConcurrency

Information about other users viewing the same object

Member	Description	Type	Example
feature	The feature (tab) of the object	string	Detail
userIds	The users that are viewing the feature (tab) of the object	string[ ]	None

Flag

A generic flag with true or false value

Member	Description	Type	Example
enabled	true or false	boolean	None

GanttItem

An object that may be shown within a gantt chart

↳ (PaletteColorItem)

↳ (Reference)

Member	Description	Type	Example
validityUntil (PaletteColorItem)	End (exclusive) of the validity period of the object (often null)	date	None
color (PaletteColorItem)	An identifier of a color	string	CF9A70F432064EE7910DC857DFC4173D
description (PaletteColorItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (PaletteColorItem)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (PaletteColorItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (PaletteColorItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (PaletteColorItem)	Start (inclusive) of the validity period of the object (often null)	date	None
ganttId	Special ID for GANTT to distinguish	string	2C38CEE968C84A5BB49BB0D68E8EF648
beg	start if interval, or point of milestone, never null	datetime	None
end	end of interval, or null for milestones	datetime	None
fixed	if true, beg and end cannot be modified	boolean	None

GenericObject

A generic object that is used by the client to store its own structured data objects like project portfolio scenario simulation data

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	The name of the object (in the user's language, if translations are available)	string	Project X
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
color	A color or any identifier of a color	color	None
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityEnd	End (exclusive) of the validity period of the object (often null)	date	None
properties	Dynamic properties (key-value pairs) that should be stored without further interpretation	Property[ ]	None

Item

A generic item with basic identifying information and validity

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	The name of the object (in the user's language, if translations are available)	string	Project X
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
color	A color or any identifier of a color	color	None
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityUntil	End (exclusive) of the validity period of the object (often null)	date	None

ItemWithDeletedFlag

An item with deleted flag

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
isDeleted	This flag indicates that an item was deleted and cannot be used anymore	boolean	None

ItemWithDeletedFlagAndModifiedAt

An item with deleted flag and last modification info

↳ (ItemWithDeletedFlag)

↳ (Reference)

↳ (Item)

Member	Description	Type	Example
isDeleted (ItemWithDeletedFlag)	This flag indicates that an item was deleted and cannot be used anymore	boolean	None
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (Item)	A color or any identifier of a color	color	None
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
modifiedAt	The point in time when the object was modified	datetime	None
modifiedBy	User ID with full name (if any) of the user that modified this object	Item	None

ItemWithDeletedFlagModifiedAtAndParent

An item with deleted flag and last modification info

↳ (ItemWithDeletedFlag)

↳ (Reference)

↳ (Item)

↳ (ItemWithDeletedFlagAndModifiedAt)

Member	Description	Type	Example
modifiedBy (ItemWithDeletedFlagAndModifiedAt)	User ID with full name (if any) of the user that modified this object	Item	None
isDeleted (ItemWithDeletedFlag)	This flag indicates that an item was deleted and cannot be used anymore	boolean	None
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (Item)	A color or any identifier of a color	color	None
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
modifiedAt (ItemWithDeletedFlagAndModifiedAt)	The point in time when the object was modified	datetime	None
parent	Information about the parent object	Item	None

ItemTranslated

A generic item with basic identifying information in different languages and validity

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	The name of the object in different languages	Translation[ ]	None
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML (in different languages)	Translation[ ]	None
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation[ ]	None
color	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityUntil	End (exclusive) of the validity period of the object (often null)	date	None

ItemTranslatedWithProperties

A generic item with basic identifying information and validity

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
properties	A collection of dynamic properties belonging to the object	Property[ ]	None

ItemWithProperties

A generic item with basic identifying information and validity

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
properties	A collection of dynamic properties belonging to the object	Property[ ]	None

Jtf

The JSON table format defined by Client Team to support dynamic table visualization on client

Member	Description	Type	Example
mimeType	must be "application/x.pqf.table.json"	string	application/x.pqf.table.json
type	Identifier for the table structure defined in the meta section. Documents with identical table structure should have the same type. User settings like sort or filter will be stored per type.	string	JsProjectExport
id	An identification of the document (optional)	string	PF-ABC
color	Color for the document (optional, localized)	color	None
createdAt	Timestamp of the document creation (optional, ISO formatted, UTC)	datetime	2023-11-09T14:28:54Z
createdBy	Name of the creator (optional)	string	Peter Muster
meta	Meta data	JtfMeta	None

JtfWithCharts

The JSON table format defined by Client Team to support dynamic table and chart visualization on client

↳ (Jtf)

Member	Description	Type	Example
hints (Jtf)	Hints is an array of information that can be displayed on top of the grid or charts. The items of the array are either directly html formatted strings (shown as type info and without a label), or objects
meta (Jtf)	Meta data	JtfMeta	None
createdAt (Jtf)	Timestamp of the document creation (optional, ISO formatted, UTC)	datetime	2023-11-09T14:28:54Z
iconRef (Jtf)	Icon for the document (optional, localized)
name (Jtf)	Name of the document (localized)
id (Jtf)	An identification of the document (optional)	string	PF-ABC
mimeType (Jtf)	must be "application/x.pqf.table.json"	string	application/x.pqf.table.json
type (Jtf)	Identifier for the table structure defined in the meta section. Documents with identical table structure should have the same type. User settings like sort or filter will be stored per type.	string	JsProjectExport
code (Jtf)	Visualized type name of the document (optional, localized)
description (Jtf)	Description of the document visualized as hint (optional, localized)
color (Jtf)	Color for the document (optional, localized)	color	None
createdBy (Jtf)	Name of the creator (optional)	string	Peter Muster
data (Jtf)	The table content is based on an array of rows. id: Row ID (optional), style: Object of CSS styling for this column (optional), data; Array of values according to the type in the column definitions. It is possible to reduce the row data to the array of values.
charts	The Json Documents intended for the Table Viewer can be expanded with Charts Definitions. Currently, we support line-, bar-, stackedbar-, pie- and donut-charts.	JtfChart[ ]	None
initialChart	defines the id of the initially shown chart	string	chart1

JtfChart

Chart definition for the JSON table format defined by Client Team

Member	Description	Type	Example
id	An identification of the chart (optional)	string	Profit
color	Color for the chart (optional, localized)	color	None
hidden	Hides the chart	boolean?	None
type	Type of the Chart	JtfChartType	None
baseline	Data represented on the x-axis (in case of "line", "bar" and "stackedbar") or the data for the names/groups of the slices (in case of "pie", "donut")	JtfChartBaseline	None
datasets	Data represented along the y-axis. Multiple Datasets possible for "line","bar" and "stackedbar". Think of it as multiple lines, bars.	JtfChartDataset[ ]	None
axis	Axis options	JtfChartAxis	None
showLegend	Whether to show legend or not	boolean?	None
bubbleSettings	Offers additional control for charts/widgets of type "bubble" (optional)	JtfChartBubbleSettings	None

JtfChartAxis

Chart axis definition for the JSON table format defined by Client Team

Member	Description	Type	Example
showAxisName	Declares whether the names of the axis' are shown. Is ignored for "pie" and "donut" charts	boolean?	None
x	Considers the x-axis	JtfChartAxisOptions	None
y	Considers the y-axis	JtfChartAxisOptions	None

JtfChartAxisOptions

Chart axis options definition for the JSON table format defined by Client Team

Member	Description	Type	Example
format	Renders the tick labels of the axis (optional)	JtfChartDataFormat	None
labels	Fixed tick labels (optional)	JtfChartBubbleAxisLabel[ ]	None
lines	Draws a gridline for every tick of the axis (optional)	boolean?	None

JtfChartBaseline

Chart baseline definition for the JSON table format defined by Client Team

Member	Description	Type	Example
id	An identification of the column. Must match the id of a column defined in the columns section of the document	string	Month
type	Type of the data	JtfChartDataType	None
format	Format data depending on type	JtfChartDataFormat	None

JtfChartBubbleAxisLabel

Data regarding labels on axis

Member	Description	Type	Example
value	Value of the label on the axis	int?	None
line	Draws a gridline for this label	boolean?	None

JtfChartBubbleCategory

Category shown in bubble chart

Member	Description	Type	Example
key	Key the category is applied to	string	P-1
color	Color of the bubbles in this category	color	None

JtfChartBubbleLabel

Labels shown in the bubble chart

Member	Description	Type	Example
key	Value of the baseline the label is applied to	string	P-1

JtfChartBubbleSettings

Options for charts/widgets of type "bubble"

Member	Description	Type	Example
names	Maps a key to the name that is shown in the bubble (optional)	JtfChartBubbleLabel[ ]	None
categories	Maps a key to a color and a name (optional)	JtfChartBubbleCategory[ ]	None
size	Size of the bubbles in percentage (optional)	int?	None

JtfChartDataFormat

Chart format definition for the JSON table format defined by Client Team

Member	Description	Type	Example
format	In case of the type of the data being "date" or "daterange", one can use the attribute "format" (String) to define how the date should be shown. The options from the moment.js library are supported.	string	MMM
decimal	In case of the type of the data being "number", one can use the attribute "decimal" (Number) to declare the number of decimal points that are shown.	int?	2
startAndEnd	This is an unknown member which exists in the sample code	boolean?	None

JtfChartDataset

Chart dataset definition for the JSON table format defined by Client Team

Member	Description	Type	Example
id	An identification of the column. Must match the id of a column defined in the columns section of the document.	string	Profit
type	Type of the data	JtfChartDataType	None
color	Color of a dataset	string	Green
aggregation	Data aggregation	JtfMetaColumnOptionsAggregation	None
format	Format data depending on type	JtfChartDataFormat	None

JtfMeta

Metadata for the JSON table format defined by Client Team

Member	Description	Type	Example
categories	Definition of the categories grouping columns	JtfMetaCategory[ ]	None
columns	Array of column definitions	JtfMetaColumn[ ]	None

JtfMetaCategory

Metadata categories for the JSON table format defined by Client Team

Member	Description	Type	Example
id	Identification of the category	string	C1

JtfMetaColumn

Metadata columns for the JSON table format defined by Client Team

Member	Description	Type	Example
id	Identification of the column (optional)	string	name
catid	ID of the category this column is member of (optional, can be null)	string	C1
type	Data type	JtfMetaColumnDataType	None
options	Additional options (optional)	JtfMetaColumnOptions	None

JtfMetaColumnOptions

Column options for the JSON table format defined by Client Team

Member	Description	Type	Example
width	Width of the column (optional, default 100)	int?	300
fixed	Column attached at the left or right side (default, null not attached)	JtfMetaColumnOptionsFixed	None
resizable	Column resizable (default true)	boolean?	None
sortable	Column sortable (default true)	boolean?	None
groupable	Column groupable (default true)	boolean?	None
filterable	Column filterable (default true)	boolean?	None
aggregation	Data aggregations: null: no aggregation, sum: sum up (default)	JtfMetaColumnOptionsAggregation	None
hidden	Whether column is hidden or not	boolean?	None

LicenseFeatures

Contains all licensed features as string identifiers

Member	Description	Type	Example
features	The different string identifiers	string	sso

LinearFunction

A mathematic linear function defined by y = ax + b

Member	Description	Type	Example
a	The first constant	double	None
b	The second constant	double	None

Log

A log entry with create and modified timestamps

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
createdAt	Created at	datetime	None
createdBy	Created by (user ID with full name, if any)	Item	None
modifiedAt	Modified at	datetime	None
modifiedBy	Modified by (user ID with full name, if any)	Item	None

NamedReference

A reference to a certain object, identified by type and ID with its name (to avoid further requests by client to show the reference)

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	The name of the object that should be displayed in the user's language	string	Sven Müller

ChangeNotification

Structure for WebSocket notification about changed objects

Member	Description	Type	Example
action	The action that was performed on an object (C, U, D, L)	ChangeNotificationAction	None
data	A reference to the object the action was performed on	Reference	None
parent	Parent objects that may be affected (i.e., when creating objects)	Reference[ ]	None

PaletteColorItem

A generic item with basic identifying information and validity (with palette color instead of arbitrary color)

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	The name of the object (in the user's language, if translations are available)	string	Project X
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
color	An identifier of a color	string	CF9A70F432064EE7910DC857DFC4173D
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityUntil	End (exclusive) of the validity period of the object (often null)	date	None

Property

A dynamic property of an object

Member	Description	Type	Example
key	A key identifying the property (unique per object instance)	string	prj-type
value	The value of the dynamic property. It's syntax and semantics depend on the type.	string	PRJ-TYPE-DEV

PropertyConstraint

A specification of a dynamic object property

Member	Description	Type	Example
basetype	The basic data type of the dynamic property	string	number
properties	The different attributes / properties of the constraint	PropertyConstraintAttribute[ ]	None

PropertyConstraintAttribute

An attribute of a property specification

Member	Description	Type	Example
key	The basic data type of the dynamic property	string	digits
value	The value of the attribute	string	2

PropertyDefinition

A definition of dynamic a property that belongs to an object type

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
objectType	The type of object this property belongs to	string	Project
sortIndex	The index to order the properties (the lowest first)	int	None
label	The label to be shown for that property in the user's language	string	Projektnummer
identifier	An identifier that allows the users to identify the property in dropdown lists or similar cases	string	ERP-Projektnummer
hint	The hint (often a tooltip) to be shown for that property in the user's language	string	Dies ist die Projektnummer, wie sie in unserem ERP steht
constraint	The constraints (type, number formats, string lengths, ...) that apply to this property	PropertyConstraint	None

PropertyDefinitionTranslated

A definition of dynamic a property that belongs to an object type (with translations)

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
objectType	The type of object this property belongs to	string	Project
sortIndex	The index to order the properties (the lowest first)	int	None
label	The label to be shown for that property in different languages	Translation[ ]	None
identifier	An identifier that allows the users to identify the property in dropdown lists or similar cases	Translation[ ]	None
hint	A hint that will be shown when hovering the ℹ icon	Translation[ ]	None
constraint	The constraints (in property constraint notation) that apply to this property	string	string(maxlen="50", regex="^\\w+@[a-zA-Z_]+?\\.[a-zA-Z]{2,3}$")

PropertyRef

Version reference for property values

Member	Description	Type	Example
key	A key identifying the property (unique per object instance)	string	prj-type
version	The version of the dynamic property	string	5F5A61E98C7E4ED7A8F90BC751B7EEAD

PropertyRefs

Version references for property values

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
properties	The versions	PropertyRef[ ]	None

Reference

A reference to a certain object, identified by type and ID

Member	Description	Type	Example
type	The type of the object (used for change notifications)	string	AnyTypeOfObj
id	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05

Relation

Describes a relation between two objects

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
relationType	The type of relation (definition)	string	4511728B45CE4E3E963F6B6CE5090883
explicit	true, if this kind of relation must be set explicitly, that means it can not be derived from other data	boolean	None
name	A name describing the relation	string	Owner of project
source	The source part of the (directed) relation	Reference	None
target	The target part of the (directed) relation	Reference	None

RelationType

Describes a relation type which defines the rules of a relation

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
nameForward	Defines the name which describes the relation seen from the source in the user's language	string	Owners
nameBackward	Defines the name which describes the relation seen from the target in the user's language	string	Own projects
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
color	A color or any identifier of a color	color	None

ExplicitRelationTypeTranslated

Describes an explicit (configured) relation with translations

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
nameForward	Defines the name which describes the relation seen from the source in different languages	Translation[ ]	None
nameBackward	Defines the name which describes the relation seen from the target in different languages	Translation[ ]	None
description	A descriptive text about the object, may contain HTML in different languages	Translation[ ]	None
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	Translation[ ]	None
color	A color or any identifier of a color	color	None
sourceTypes	Defines the possible object types for the source part of the (directed) relation	string[ ]	None
sourcesUrl	Defines a URL which may be used to enumerate all possible objects for the source part of the (directed) relation	string	/API/V2/RES/ResourceKind/Person/All
createTargetFromSourceUrl	Url that may be used to create a target and a relation at the same time given a source object (use :type and :id as placeholders for source reference)	string	/API/V2/PI/ItemType/Todo/ByRef/4D893F9419CE4E6C8973170537C2C5CE/:type/:id/Add
targetTypes	Defines the possible object types for the target part of the (directed) relation	string[ ]	None
targetsUrl	Defines a URL which may be used to enumerate all possible objects for the target part of the (directed) relation	string	/API/V2/PM/Projects
createSourceFromTargetUrl	Url that may be used to create a source and a relation at the same time given a target object (use :type and :id as placeholders for target reference)	string	/API/V2/PI/ItemType/Todo/ByRef/68840FDA000D4B3AB5FDCD448C782D49/:type/:id/Add
sortIndexForward	Defines the sort index seen from the source (lowest first)	double	None
sortIndexBackward	Defines the sort index seen from the target (lowest first)	double	None
navigable	Shows the relation in the navigation	boolean	None
autoSet	Automatically create a relation to the user when he/she creates a new object (makes only sense, if relation may be linked to a resource)	boolean	None

RelationTypeWithConstraints

Describes a relation type which defines the rules of a relation including some rules

↳ (RelationType)

↳ (Reference)

Member	Description	Type	Example
color (RelationType)	A color or any identifier of a color	color	None
description (RelationType)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
nameForward (RelationType)	Defines the name which describes the relation seen from the source in the user's language	string	Owners
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
nameBackward (RelationType)	Defines the name which describes the relation seen from the target in the user's language	string	Own projects
iconRef (RelationType)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
explicit	true, if this kind of relation must be set explicitly, that means it can not be derived from other data	boolean	None
sourceTypes	Defines the possible object types for the source part of the (directed) relation	string[ ]	None
targetTypes	Defines the possible object types for the target part of the (directed) relation	string[ ]	None
sourcesUrl	Defines a URL which may be used to enumerate all possible objects for the source part of the (directed) relation	string	/API/V2/RES/ResourceKind/Person/All
targetsUrl	Defines a URL which may be used to enumerate all possible objects for the target part of the (directed) relation	string	/API/V2/PM/Projects
sortIndexForward	Defines the sort index seen from the source (lowest first)	double	None
sortIndexBackward	Defines the sort index seen from the target (lowest first)	double	None

SessionInfo

Information about the current session sent to the client over WebSocket

Member	Description	Type	Example
sessionId	The session ID of the current session (unique for each WebSocket connection)	string	8A048B72ECBA422496165C217D101690

SessionMessageClientToServer

This structure defines all possible messages that may be sent from client to server over WebSocket

Member	Description	Type	Example
feature	This message is sent by client to inform about features (tabs) of objects being displayed	Feature	None
access	This message is sent by client to inform about an object being viewed or edited	Access	None

SessionMessageServerToClient

This structure defines all possible messages that may be sent from server to client over WebSocket

Member	Description	Type	Example
sessionInfo	This message is sent by server once to inform about the current session	SessionInfo	None
dataChange	This message is sent by server to inform about an object that was changed or created	ChangeNotification	None
featureConcurrency	This message is sent by server to inform about other users being on the same feature (tab) of an object	FeatureConcurrency[ ]	None
accessConcurrency	This message is sent by server to inform about other users viewing or editing the same object	AccessConcurrency[ ]	None

Software

Contains basic information about software

Member	Description	Type	Example
name	The name of the Software	string	PQFORCE Server
version	The version string	string	4.04.0 Stable Release Build 335

SubObject

Contains a sub object which is part of any other object but has its own access control rights

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
properties	Dynamic properties following the property definition (customizable)	Property[ ]	None

Timeline

A timeline that contains a number of events per unit

Member	Description	Type	Example
slots	The slots of the timeline	TimelineSlot[ ]	None

TimelineSlot

A slot in a timeline, containing the number of events from the start of this slot until the start of the next slot

Member	Description	Type	Example
at	The start of the slot	datetime	None
count	The number of events during the slot	long	None

ItemTimelineWithReference

A timeline containing references

↳ (ItemTimeline)

Member	Description	Type	Example
items (ItemTimeline)	The references	ItemTimelineEntry	None
ref	A reference to an object the timeline is corresponding to	Reference	None

ItemTimeline

A timeline containing items

Member	Description	Type	Example
items	The references	ItemTimelineEntry[ ]	None

ItemTimelineEntry

A timeline entry containing an item

Member	Description	Type	Example
obj	The historic item, if not deleted	Item	None
pointInTime	The point in time from which this item is referenced	datetime	None
user	The user who contributed to this entry	Item	None

ParallelRequestsLimit

Contains information about the maximum concurrent requests allowed for this interaction

Member	Description	Type	Example
limit	The limit	int	None

RecoveryResult

Contains information about a recovery operation

Member	Description	Type	Example
status	Contains a status	string	Ok
item	Identifies the recovered object	Item	None
elements	contains information on imported elements	RecoveryResultElement[ ]	None

RecoveryResultElement

Contains information on recovered elements

Member	Description	Type	Example
type	defines the element type	string	MacroAllocation
recovered	The recovered elements count	int	None
ignored	The ignored elements count	int	None

Tenant

A short description of the current tenant, only publicly available information that can be shown on login screen

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
alias	The tenant's alias that is part of the starting URL, may be empty	string	intrasoft
company	The tenant's name that will be shown on logon screen	string	INTRASOFT AG
color	The color defined in the license	color	None
iconRef	The icon defined in the license	string	data:image/png;base64,[base64data]
languages	The languages available for this tenant, null means no restriction	string[ ]	["de","en"]

TenantWithAdditionalData

A short description of the current tenant, with information that may only be available after successful authentication

↳ (Tenant)

↳ (Reference)

Member	Description	Type	Example
languages (Tenant)	The languages available for this tenant, null means no restriction	string1	["de","en"]
color (Tenant)	The color defined in the license	color	None
alias (Tenant)	The tenant's alias that is part of the starting URL, may be empty	string	intrasoft
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
company (Tenant)	The tenant's name that will be shown on logon screen	string	INTRASOFT AG
iconRef (Tenant)	The icon defined in the license	string	data:image/png;base64,[base64data]
adminEMail	The administrator's / support's e-mail	string	support@pqforce.com

Translation

Contains a string in a certain language

Member	Description	Type	Example
code	The language code (ISO 639-1 with optional country)	string	de-ch
text	The translated text (may contain HTML, depending on context)	string	Chuchichäschtli

UndeleteLimit

Describes how long an object stays in the waste bin for possible undeletion

Member	Description	Type	Example
days	the amount of days	int	None

UniqueReadableCodeDef

Defines a unique readable code to associate to an object type

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
pattern	Regular expression that defines the code	string	P-(\d+)
readOnly	Read-only flag for the client	boolean	None

Unit

Information about a unit (time, length, volume, ...)

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
abbr	The abbreviation in the user's language	string	h
name	The name in the user's language	string	Stunden

UnitPreference

Describes the preferred units (order) in a system

Member	Description	Type	Example
preferredUnits	The IDs (signs) of the preferred units	string	H

UnitFactor

Describes the factor that can be applied to values to convert them between different units

Member	Description	Type	Example
unit	The ID (sign) of the unit	string	H
factor	The factor that a value with this unit has to be multiplied with to convert it to the base unit (i.e., 0.01 for cm, if base unit is m)	fraction	None

UserAgent

Contains information about a user agent that was detected

Member	Description	Type	Example
browser	Information about the browser	Software	None
os	Information about the operating system the browser runs on	Software	None
device	The kind of device the browser runs on (Unknown, Crawler, Server, Desktop, Tablet, Smartphone)	string	Desktop
languages	The languages that are being requested by the user agent	string[ ]	None
userAgentString	The raw user agent string (if any)	string	Mozilla/5.0 (Windows NT 6.3; rv:36.0) Gecko/20100101 Firefox/36.0

ValueWithUnit

Contains a floating point value with a unit

Member	Description	Type	Example
value	The amount	double	None
unit	The unit	Unit	None

VersionedDetails

Legacy details object with version information

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name	The name of the object (in the user's language, if translations are available)	string	Project X
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color	The color of an object	color	None
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityEnd	End (exclusive) of the validity period of the object (often null)	date	None
properties	Dynamic properties with metadata	Property[ ]	None

VersionedItem

A generic item with basic identifying information and validity

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name	The name of the object (in the user's language, if translations are available)	string	Project X
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
color	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityUntil	End (exclusive) of the validity period of the object (often null)	date	None

VersionedItemTranslated

A generic item with basic identifying information in different languages and validity

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name	The name of the object in different languages	Translation[ ]	None
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML (in different languages)	Translation[ ]	None
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation[ ]	None
color	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityUntil	End (exclusive) of the validity period of the object (often null)	date	None

VersionedItemWithProperties

A generic item with basic identifying information and validity

↳ (VersionedItem)

↳ (Reference)

Member	Description	Type	Example
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
properties	A collection of dynamic properties belonging to the object	Property[ ]	None

VersionedReference

A reference to a certain object, identified by type and ID

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt	The point in time when the object was created	datetime	None
createdBy	User ID with full name (if any) of the user that created this object	Item	None
modifiedAt	The point in time when the object was modified	datetime	None
modifiedBy	User ID with full name (if any) of the user that modified this object	Item	None
version	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
historic	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None

WebSocketInfo

Information about a websocket connection

Member	Description	Type	Example
url	Contains the URL to connect to	string	wss://test.pqforce.com/WS/V2/B3NCE4O47UERFNC7SAPEW26Z57YRVCOQRNBV2EG2JE6GOW5VJARA
validUntil	Contains the validity of the URL	datetime	None

ProjectItem

Describes a project item like a TODO

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name	The name of the object (in the user's language, if translations are available)	string	Project X
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityEnd	End (exclusive) of the validity period of the object (often null)	date	None
state	The current lifecycle state of the item	LifecycleStateWithSubState	None
sortIndex	A sort index that may be used by the client to fix a specific order	double	None
color	An ID to a special color defined by the client	string	CAFD7DE2D0C140B2A9F8746633E67A2E
marker	An ID of the marker enum to be used	string	ACD3558FCBBA4376A2BFA8D124450463
properties	A collection of dynamic properties belonging to the object	Property[ ]	None

ProjectItemSummary

A project item with additional, summarizing information

↳ (ProjectItem)

Member	Description	Type	Example
properties (ProjectItem)	A collection of dynamic properties belonging to the object	Property	None
color (ProjectItem)	An ID to a special color defined by the client	string	CAFD7DE2D0C140B2A9F8746633E67A2E
state (ProjectItem)	The current lifecycle state of the item	LifecycleStateWithSubState	None
validityStart (ProjectItem)	Start (inclusive) of the validity period of the object (often null)	date	None
description (ProjectItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (ProjectItem)	The name of the object (in the user's language, if translations are available)	string	Project X
code (ProjectItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ProjectItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityEnd (ProjectItem)	End (exclusive) of the validity period of the object (often null)	date	None
sortIndex (ProjectItem)	A sort index that may be used by the client to fix a specific order	double	None
marker (ProjectItem)	An ID of the marker enum to be used	string	ACD3558FCBBA4376A2BFA8D124450463
relations	Relations to other objects	Relation[ ]	None
lifecycleHistory	Contains the lifecycle history of the item (the newest first)	LifecycleHistory[ ]	None
possibleLifecycleTransitions	Contains all lifecycle transitions that could be chosen by the current user	LifecycleTransition[ ]	None

ProjectItemType

Describes some type of project items

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	The name of the type in the user's language	string	Todo
description	A text describing the usage of items of the given type	string	A TODO is a kind of task that has to be completed by a resource
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/projectitems/todo.svg
color	The color associated to the type	color	None
markerEnumType	The enum type that can be used as marker	string	ENUM_TODO_MARKER

ShiftPattern

A single shift pattern that may be applied to work items for reservation (micro planning) of resources

Member	Description	Type	Example
shift	the shift ID	ResourceShift	None
pattern	the pattern that may be applied (day by day)	boolean	None

ShiftPlan

A shift pattern that may be applied to work items for reservation (micro planning) of resources

Member	Description	Type	Example
shifts	contains the patterns of each shift	ShiftPattern[ ]	None

ReferenceFactor

Contains a reference to an object with a factor

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
factor	the factor that applies	double	None

ProjectBackup

A backup of the whole project including scenarios, risks, costs and reports

Member	Description	Type	Example
project	The project base data	Project	None
lifecycle	The project's lifecycle transitions	LifecycleHistory[ ]	None
subObjs	The project's sub objects	SubObject[ ]	None
scenarios	The project's scenarios	ProjectScenarioBackup[ ]	None
risks	The project's risks	ProjectRisk[ ]	None
costsPositions	The project's costs actuals	ProjectCostsPositionWithActuals[ ]	None
reports	The project's reports	ProjectReportBackup[ ]	None
properties	Reference values for properties	PropertyRefs[ ]	None

ProjectReportBackup

A backup of a project report

Member	Description	Type	Example
report	The project report base data	ProjectReport	None
lifecycle	The project report's lifecycle transitions	LifecycleHistory[ ]	None

ProjectScenarioBackup

A backup of a project scenario

Member	Description	Type	Example
scenario	The project scenario base data	ProjectScenario	None
lifecycle	The project scenario's lifecycle transitions	LifecycleHistory[ ]	None
workItemTree	The projects tasks and milestones	ProjectWorkItemBackup[ ]	None
resourceAllocations	The allocated resources	ResourceAllocation[ ]	None
costsPositionAssignments	The assigned costs positions	CostsPositionAssignmentBackup[ ]	None
constraints	the constraints between milestones	ProjectConstraint[ ]	None
properties	Reference values for properties	PropertyRefs[ ]	None
timingVersion	Contains a technical reference to the timing version	long	None

CostsPositionAssignmentBackup

Costs positions assigned to a project work item

Member	Description	Type	Example
workItemId	the ID of the work item	string	A0E607B10CE84DD8834DDF8660616B1A
assignedCostsPositions	the assigned costs positions	string[ ]	None

ProjectPortfolio

Contains information about a project portfolio

↳ (Reference)

Member	Description	Type	Example
properties (VersionedDetails)	Dynamic properties with metadata	Property	None
validityStart (VersionedDetails)	Start (inclusive) of the validity period of the object (often null)	date	None
color (VersionedDetails)	The color of an object	color	None
code (VersionedDetails)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedDetails)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedDetails)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef (VersionedDetails)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityEnd (VersionedDetails)	End (exclusive) of the validity period of the object (often null)	date	None
parentPortfolioId	the parent project portfolio (null for top-portfolios)	string	D123018C3DD4497285255C65BA547EE1

ProjectPortfolioMilestone

A project portfolio milestone that may be referenced by the portfolio's projects

↳ (Reference)

Member	Description	Type	Example
properties (VersionedDetails)	Dynamic properties with metadata	Property	None
validityStart (VersionedDetails)	Start (inclusive) of the validity period of the object (often null)	date	None
color (VersionedDetails)	The color of an object	color	None
code (VersionedDetails)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedDetails)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedDetails)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef (VersionedDetails)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityEnd (VersionedDetails)	End (exclusive) of the validity period of the object (often null)	date	None
projectPortfolioId	the ID of the project portfolio the milestone belongs to	string	85D4903147B84688991D9CB26B0FF511
position	The position of the milestone on the time axis	date	None

IndicatorSelections

Information about selected project report indicators in a project

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
dimensions	The dimensions that should be present in a project report	IndicatorDimensionSelection[ ]	None

IndicatorDimensionDef

A definition of a project report indicator dimension in the user's language

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
projectReportTypeId	The type of project report this indicator dimension applies to	string	ProjectReport
name	the name of the dimension in the user's language	string	Indicator dimension name..
description	the description of the dimension in the user's language	string	Indicator dimension description..
iconRef	An icon for the dimension	string	icon.svg
code	the code of the dimension	string	ABC
color	the color of the dimension	string	red
statusClassId	the class (definition) of the status indicator of the dimension	string	PM-IND-STATUS-GENERIC
trendClassId	the class (definition) of the trend indicator of the dimension	string	PM-IND-TREND-GENERIC
sortIndex	a sorting index for the dimension (the lowest first)	double	None

IndicatorDimensionDefTranslated

A definition of a project report indicator dimension with translations

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
projectReportTypeId	The type of project report this indicator dimension applies to	string	ProjectReport
name	the name of the dimension with translations	Translation[ ]	None
description	the description of the dimension with translations	Translation[ ]	None
iconRef	An icon for the dimension	Translation[ ]	None
code	the code of the dimension	string	ABC
color	the color of the dimension	string	red
statusClassId	the class (definition) of the status indicator of the dimension	string	PM-IND-STATUS-GENERIC
trendClassId	the class (definition) of the trend indicator of the dimension	string	PM-IND-TREND-GENERIC
sortIndex	a sorting index for the dimension (the lowest first)	double	None

IndicatorDetailDef

Contains a definition for a project report indicator in the user's language

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
projectReportTypeId	the type of project report this indicator detail applies to	string	ProjectReport
name	the name of the indicator in the user's language	string	Indicator detail name..
description	the description of the indicator in the user's language	string	Indicator detail description..
iconRef	an icon for the indicator	string	icon.svg
code	the code of the indicator	string	ABC
color	the color of the indicator	string	red
valueType	the type of value of the indicator	PropertyConstraint	None
inputActual	the input behaviour for the actual value	InputBehaviour	None
inputRemaining	the input behaviour for the remaining value	InputBehaviour	None
inputForecast	the input behaviour for the forecast value	InputBehaviour	None
statusClassId	the class (definition) of the status indicator of the report indicator	string	PM-IND-STATUS-GENERIC
trendClassId	the class (definition) of the trend indicator of the report indicator	string	PM-IND-TREND-GENERIC
dimension	the dimension this indicator belongs to	string	958F8441DCE9434BBA1800E279FDE18B
semantics	the semantics of the indicator	IndicatorSemantics	None
accumulation	the kind of aggregation that applies to turn many values into one	Aggregation	None
projectManagementMethodPhase	indicates that the indicator is relevant only for a single management method phase (may be null)	string	C238C0B76AA2479E86EAA3A98A21383A
sortIndex	a sorting index for the dimension (the lowest first)	double	None

IndicatorDetailDefTranslated

Contains a definition for a project report indicator with translations

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
projectReportTypeId	The type of project report this indicator detail applies to	string	ProjectReport
name	the name of the indicator with translations	Translation[ ]	None
description	the description of the indicator with translations	Translation[ ]	None
iconRef	an icon for the indicator	Translation[ ]	None
code	the code of the indicator	string	PRJX
color	the color of the indicator	string	red
aggregationRule	The rule how values will be collected in the project	string	Milestone(M1)
statusClassId	the class (definition) of the status indicator of the report indicator	string	PM-IND-STATUS-GENERIC
trendClassId	the class (definition) of the trend indicator of the report indicator	string	PM-IND-TREND-GENERIC
dimension	the dimension this indicator belongs to	string	DIM1
sortIndex	a sorting index for the dimension (the lowest first)	double	None

IndicatorDetailSelectionHistoric

Historic value of a project report indicator selection

Member	Description	Type	Example
at	the point in time of the change	datetime	None
obj	the value at the point in time	IndicatorDetailSelection	None

IndicatorDetailSelectionHistory

Historic value of a project report indicator selection

Member	Description	Type	Example
history	a single historic value	IndicatorDetailSelectionHistoric[ ]	None

IndicatorClassificationSchemeValue

Classification for project report indicators in the user's language

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	the name of the indicator classification in the user's language	string	OK
description	a short description of the indicator classification in the user's language	string	Everything as it should 😉
iconRef	an icon for the indicator classification	string	icon.svg
code	the code for the indicator classification	string	PRJY
color	the color for the indicator classification	string	red
valueStart	the lowest numeric value that maps to this classification	double	None
rating	the rating as numeric for this classification	double	None

IndicatorClassificationScheme

A scheme how to classify project report indicators in the user's language

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	the name for the scheme in the user's language	string	Traffic lights
description	a short description of the classification scheme in the user's language	string	Indicator classification with RED / YELLOW / GREEN
iconRef	an icon for the indicator classification	string	icon.svg
code	the code of the classification scheme	string	XYZ
color	a color	string	red
values	the values that belong to this scheme	IndicatorClassificationSchemeValue[ ]	None

IndicatorClassificationSchemeValueTranslated

Classification for project report indicators with translations

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	the name of the indicator classification with translations	Translation[ ]	None
description	a short description of the indicator classification with translations	Translation[ ]	None
iconRef	an icon for the classification scheme	Translation[ ]	None
code	the code for the indicator classification	string	ABC
color	the color for the indicator classification	string	red
valueStart	the lowest numeric value that maps to this classification	double	None
rating	the rating as numeric for this classification	double	None

IndicatorClassificationSchemeTranslated

A scheme how to classify project report indicators with translations

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	the name for the scheme with translations	Translation[ ]	None
description	a short description of the classification scheme with translations	Translation[ ]	None
iconRef	an icon for the indicator classification	Translation[ ]	None
code	the code of the classification scheme	string	ASDF
color	a color	string	red
values	the values that belong to this scheme	IndicatorClassificationSchemeValueTranslated[ ]	None

IndicatorCollection

The indicators in a project report

Member	Description	Type	Example
dimensions	The indicator dimensions	IndicatorDimension[ ]	None
leading	The leading indicator dimension, if any	IndicatorDimension	None
riskSum	The sum of all risk ratings (one per dimension) in the report	double	None
riskClassSum	The sum of all risk rating classifications (one per dimension) in the report	double	None

IndicatorDetail

A single indicator in a project report

Member	Description	Type	Example
selection	Contains the targets defined in the project itself	IndicatorDetailSelection	None
actualValueCalculated	The calculated actual value, if any	string	45
actualValueManual	The manually entered actual value, if any	string	40
remainingValueCalculated	The calculated remaining value, if any	string	15
remainingValueManual	The manually entered remaining value, if any	string	30
forecastValueCalculated	The calculated forecast value, if any	string	60
forecastValueManual	The manually entered forecast value, if any	string	70
statusClassCalculated	A reference to the calculated status classification	Item	None
statusClass	A reference to the manually selected status classification	Item	None
trendClassCalculated	A reference to the calculated trend classification	Item	None
trendClass	A reference to the manually selected trend classification	Item	None
remark	A remark describing the values	string	We can do better!

IndicatorDetailSelection

Contains the indicator type and the targets defined in the project itself for an indicator on a project report

Member	Description	Type	Example
typeId	A reference to the indicator type	string	66BE84A8A5624CEBB8316C284E754C38
targetValue	The target value that should be reached	string	55
showValues	Specifies whether to show values (quantitative) or only show classifications (qualitative)	boolean	None
projectSpecificName	Contains a name that is specific to the project (i.e. the linked milestone name)	string	Concept done
remark	An additional hint for the user that has to estimate the indicator	string	This indicator should be estimated by using the scheme in the project guideline book, page 198
createdAt	The point in time when the object was created	datetime	None
createdBy	User ID with full name (if any) of the user that created this object	Item	None
modifiedAt	The point in time when the object was modified	datetime	None
modifiedBy	User ID with full name (if any) of the user that modified this object	Item	None
version	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
historic	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None

IndicatorDimension

Describes a group of indicators forming one dimension of a project report (i.e. costs, timeline, ...)

Member	Description	Type	Example
selection	Contains the guidelines defined in the project itself	IndicatorDimensionSelection	None
indicators	The indicators that belong to the dimension (sorted)	IndicatorDetail[ ]	None
total	The calculated total of all indicators	IndicatorDetail	None
targetTotal	The total of all target values	string	500
riskEstimation	The manual estimation of all the risks belonging to the dimension	IndicatorRiskEstimation	None

IndicatorDimensionSelection

Contains the guidelines defined in the project itself for an indicator dimension of a project report

Member	Description	Type	Example
dimension	A reference to the dimension	string	FD030594F78D4DA88DDF8EE573650C00
showValues	Defines whether to show values (totals, ...)	boolean	None
showRiskEstimation	Defines whether to show risk estimation or not	boolean	None
isLeading	true, if this is the leading dimension	boolean	None
remark	A remark containing some hints for the user that has to estimate the indicators	string	Do not spend too much time on these indicators as they're not so important
details	The selected indicators with their targets and guidelines	IndicatorDetailSelection[ ]	None
isReportExport	true, the indicator is present in the report export	boolean	None

IndicatorRiskEstimation

Contains the manual risk rating of all risks belonging to a certain dimension on a project report

↳ (RiskRating)

Member	Description	Type	Example
riskRatingClassification (RiskRating)	The classification of the rating of the risk	string	F71376233416402885209C3AEA0C4760
extentOfLossClassification (RiskRating)	The classification of the amount of damage in case of an event	string	42C18259199A41DB929DAE8326B50C5A
occurrenceProbabilityClassification (RiskRating)	The classification of the probability of the occurrence on an event	string	F25B505C9E0C42ADBEF3D9D24539DF18
occurrenceProbability (RiskRating)	The probability of the occurrence on an event	double	None
extentOfLoss (RiskRating)	The amount of damage in case of an event	double	None
riskRating (RiskRating)	The rating of the risk (the product of occurrence probability and extent of loss)	double	None
remark	A remark why the risk is rated as it is	string	The estimation was made using 10 dices 😉

PositionProposal

A proposal for a new position of a milestone

Member	Description	Type	Example
objectId	The ID of the object which position is proposed	string	F9CEE4C267F242B790349B4BF0D37AC3
proposedPosition	The proposed position	date	None

MovePattern

A set of linear functions describing the movement of any gantt object in relation to the movement of another gantt object

Member	Description	Type	Example
objectId	The ID of the object which movement is described	string	F9CEE4C267F242B790349B4BF0D37AC3
defaultMove	The movement that applies for values that are lower than the minX of the first segment	LinearFunction	None
segments	The different movements that apply from minX to the next higher minX	MovePatternSegment[ ]	None

MovePatternSegment

A linear function describing the movement of any gantt object in relation to the movement of another gantt object within a certain boundary

↳ (LinearFunction)

Member	Description	Type	Example
b (LinearFunction)	The second constant	double	None
a (LinearFunction)	The first constant	double	None
minX	The lower limit of validity	double	None

Project

Describes a project

↳ (Reference)

↳ (VersionedItem)

Member	Description	Type	Example
properties (VersionedItemWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
status	A reference to the current lifecycle state of the project	string	5F9B9831C7704DDFAABF7580129AB8F2
portfolios	References to the direct project portfolios	Item[ ]	None
classification	The classification of this project according to the classification schemes	Classification[ ]	None

ProjectConstraint

Describes a constraint between different milestones in the same scenario

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
constraintType	Describes the type of constraint	ExplicitProjectConstraintType	None
predecessorMilestoneId	Specifies the milestone where the constraint starts	string	822958FC27A94F6BA23ECCF2B74360A1
successorMilestoneId	Specifies the milestone where the constraint ends	string	671B83C761AB45C1AA2379C5EF5C83A3
minDistance	Specifies the minimal distance between the two milestones (may be null, if not defined)	int?	0
maxDistance	Specifies the maximal distance between the two milestones (may be null, if not defined)	int?	31

ProjectDependency

Describes a dependency between different milestones in different contexts (portfolio / scenario)

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
constraintType	Describes the type of dependency	ExplicitProjectConstraintType	None
predecessorMilestone	Specifies the milestone where the dependency starts	ProjectDependencyReference	None
predecessorMilestoneParents	Specifies the parents of the milestone where the dependency starts (read-only)	ReferenceWithLifecycle[ ]	None
successorMilestone	Specifies the milestone where the dependency ends	ProjectDependencyReference	None
successorMilestoneParents	Specifies the parents of the milestone where the dependency ends (read-only)	ReferenceWithLifecycle[ ]	None
minDistance	Specifies the minimal distance between the two milestones (may be null, if not defined)	int?	0
maxDistance	Specifies the maximal distance between the two milestones (may be null, if not defined)	int?	31

ProjectDependencyReference

Describes a reference to a dependency

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
position	the absolute position of the milestone	date	None
name	The name of the milestone / task	string	My portfolio milestone
color	The color of the milestone / task (a color code for portfolio milestone, a color ID for project milestone / task)	string	#COFFEE
milestoneType	Describes the type of milestone	ProjectDependencyReferenceType	None

ProjectManagementMethod

Describes a project management method in the user's language

↳ (VersionedItem)

↳ (Reference)

Member	Description	Type	Example
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None

ProjectManagementMethodTimeline

Describes a project management method with time information in relation to a project

Member	Description	Type	Example
managementMethod	The management method that is followed by the project according to its lifecycle history (may be null)	Item	None
plannedStart	The date when the first phase is planned to be started (may be null, if not yet planned)	date	None
started	The point in time when the first phase has been started (may be null, if no method selected)	datetime	None
phases	The phases of the referenced method (may be null, if no method selected)	ProjectManagementMethodPhaseTimeline[ ]	None
currentPhase	The ID of the phase the project is in (one of the items in phases, may be null, if no method selected or last phase completed)	string	74BB193FFE354BA88B8BA736551B27C6

ProjectManagementMethodTranslated

Describes a project management method in different languages

↳ (VersionedItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (VersionedItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (VersionedItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (VersionedItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (VersionedItemTranslated)	The name of the object in different languages	Translation	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
code (VersionedItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (VersionedItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (VersionedItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None

ProjectManagementMethodPhase

Describes a project management method phase in the user's language

↳ (VersionedItem)

↳ (Reference)

Member	Description	Type	Example
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
sortIndex	An index value that indicates the correct order (higher after lower)	double	None

ProjectManagementMethodPhaseTimeline

Describes a phase with its planned and effective finish related to a project

Member	Description	Type	Example
managementMethodPhase	An item describing the corresponding phase	Item	None
plannedFinish	The date on which the phase is planned to be finished (may be null, if not planned)	date	None
finished	The effective point in time when tha phase has been finished (may be null, if not yet finished)	datetime	None

ProjectManagementMethodPhaseTranslated

Describes a project management method phase in different languages

↳ (VersionedItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (VersionedItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (VersionedItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (VersionedItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (VersionedItemTranslated)	The name of the object in different languages	Translation	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
code (VersionedItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (VersionedItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (VersionedItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
sortIndex	An index value that indicates the correct order (higher after lower)	double	None

ProjectManagementMethodPhaseLifecycleAssignment

Describes an assignment between a lifecycle state and a project management method phase

Member	Description	Type	Example
phaseId	The ID of the project management method phase	string	8907DA7649D14E2D99F6144E74E99314
lifecycleSubStateId	The ID of a mapped lifecycle state	string	FB551CD4065941CA93F377ACB3D17194
priority	describes the priority of the assignment, if multiple assignments exist for the same lifecycle substate (lower number means higher priority)	double	None

ProjectReport

A project report

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name	The name of the object (in the user's language, if translations are available)	string	Report for Project X
code	A short code which may be unique over all objects of the same type	string	RP-PRJ-X
description	A descriptive text about the object, may contain HTML	string	<p>This is a report for <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/final.png
color	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityEnd	End (exclusive) of the validity period of the object (often null)	date	None
properties	A collection of dynamic properties belonging to the object	Property[ ]	None
projectId	A reference to the project	string	430CEFBE2A634F5FB4E833244B42C928
indicators	The indicators, if any	IndicatorCollection	None
risks	The project risks	ProjectRisk[ ]	None
currency	The currency in which the report was calculated	string	CURRENCY-EUR

ProjectPortfolioReport

A project report

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name	The name of the object (in the user's language, if translations are available)	string	Report for Project Portfolio X
code	A short code which may be unique over all objects of the same type	string	RP-PPF-X
description	A descriptive text about the object, may contain HTML	string	<p>This is a report for <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/final.png
color	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityStart	Start (inclusive) of the validity period of the object (often null)	date	None
validityEnd	End (exclusive) of the validity period of the object (often null)	date	None
properties	A collection of dynamic properties belonging to the object	Property[ ]	None
projectPortfolioId	A reference to the project portfolio	string	430CEFBE2A634F5FB4E833244B42C928

ReportInterval

The schedule / interval for a project report

Member	Description	Type	Example
unit	The time interval unit (MONTH, WEEK, DAY) a report must be created	ReportIntervalUnit	None
amount	The amount of units that build the interval	int	None
offset	The offset in days for the interval	int	None

ProjectReportType

A project report type

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
interval	The schedule for the report, optional	ReportInterval	None
autoCreate	Flag that indicates whether a report will be created automatically	boolean	None
sortIndex	The sortIndex (lowest first)	double	None
hasValidity	Flag that indicates whether a report has validity date range	boolean	None
canRefresh	Flag that indicates whether a report should have a refresh button	boolean	None
jsDataSourceId	Contains the ID of the JavaScript source to be used as data collector for custom JavaScript indicators	string	EEAFD16CF25B44D8A131201C79BCA8DA

ProjectReportTypeTranslated

A project report type

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
interval	The schedule for the report, optional	ReportInterval	None
autoCreate	Flag that indicates whether a report will be created automatically	boolean	None
sortIndex	The sortIndex (lowest first)	double	None
hasValidity	Flag that indicates whether a report has validity date range	boolean	None
canRefresh	Flag that indicates whether a report should have a refresh button	boolean	None
jsDataSourceId	Contains the ID of the JavaScript source to be used as data collector for custom JavaScript indicators	string	EEAFD16CF25B44D8A131201C79BCA8DA

ProjectPortfolioReportType

A project report type

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
interval	The schedule for the report, optional	ReportInterval	None
autoCreate	Flag that indicates whether a report will be created automatically	boolean	None
sortIndex	The sortIndex (lowest first)	double	None
hasValidity	Flag that indicates whether a report has validity date range	boolean	None

ProjectPortfolioReportTypeTranslated

A project report type

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
interval	The schedule for the report, optional	ReportInterval	None
autoCreate	Flag that indicates whether a report will be created automatically	boolean	None
sortIndex	The sortIndex (lowest first)	double	None
hasValidity	Flag that indicates whether a report has validity date range	boolean	None

ProjectScenario

Describes a project scenario

↳ (Reference)

↳ (VersionedItem)

Member	Description	Type	Example
properties (VersionedItemWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
projectId	A reference to the project	string	3D4579592B404430A93D7504EE7B0A55
status	a reference to the current lifecycle state	string	3687790A73CC42AE94DDB75B2AD65AD3
owner	A reference to the planner / owner of the scenario	Item	None

ProjectSummary

A summary containing all relevant information belonging to a project

Member	Description	Type	Example
project	The project	Project	None
subObjects	The sub objects belonging to the project	SubObject[ ]	None
activeScenario	The scenario that is in active state, if any	ProjectScenario	None
mainPhase	The main phase of the scenario that is in active state, if any	ProjectWorkItem	None
accumulatedValues	The accumulated values of the scenario that is in active state, if any	ProjectWorkItemAccumulatedValues	None
costsActual	The total costs actual	CurrencyAmount	None
costsExpectedPending	The total costs expected to be pending (not yet reported)	CurrencyAmount	None
costsRemaining	The total remaining costs (not yet reported)	CurrencyAmount	None
costsBudget	The total costs budget	CurrencyAmount	None
costsPlanned	The total costs planned	CurrencyAmount	None
costsForecast	The forecast of costs	CurrencyAmount	None
relations	The explicit relations of the project	Relation[ ]	None
managementMethod	A reference to the management method that the project is following, if any	Item	None
managementMethodPhase	A reference to the current phase of the management method that the project is following, if any	Item	None
thirdPartyReferences	The references to items on third party systems	ThirdPartyReference[ ]	None
latestReports	Contains the latest report	ProjectReport[ ]	None
confidentiality	The confidentiality level	ConfidentialityLevel	None
lastStateTransition	the last state transition of the project's lifecycle	LifecycleHistory	None

ProjectWithReports

Project information in combination with the latest report

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
reports	The latest report (may be the latest report with given state)	ProjectReport[ ]	None

ProjectPortfolioWithReports

Project information in combination with the latest report

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
reports	The latest report (may be the latest report with given state)	ProjectPortfolioReport[ ]	None

ProjectWorkItem

Describes a project work item (phase / milestone / folder)

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name	The name of the object (in the user's language, if translations are available)	string	Project X
code	A short code which may be unique over all objects of the same type	string	PRJ-X
description	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
properties	A collection of dynamic properties belonging to the object	Property[ ]	None
phaseType	The kind of work item	ProjectWorkItemType	None
projectId	A reference to the project	string	A2EC8F59A62D4E77A43A6A924A82C37A
scenarioId	A reference to the scenario	string	C51070CF01CC490F831F3D419D6358BD
parentPhaseId	A reference to the parent work item, null if main phase	string	9E91C2B21678493592299D8766A7429D
startId	The ID of the starting point (may also be equal the endId or null)	string	04ADAEF76C8D49DDBDAC1940BC99F940
endId	The ID of the end point (may also be equal the startId or null)	string	A20C093779BF4FE69A7823953BE840B6
sortIndex	index for sorting siblings	double?	None
timeBudget	top-down planning	duration	None
costsBudget	top-down planning	CurrencyAmount	None
planned	bottom-up planning	duration	None
beg	start of interval, or point of milestone, null for folders	datetime	None
end	end of interval, or null for milestones	datetime	None
fixed	if true, beg and end cannot be modified	boolean	None
projectCostsPositions	References to the project costs positions that are assigned	NamedReference[ ]	None
owner	a resource	ItemWithDeletedFlag	None
requiredSkill	a resource (skill)	ItemWithDeletedFlag	None
color	Used to be in format: "rgb(a,b,c)" where a, b, c are in 0..255, now it may also be an ID pointing to a client's enum containing the color	string	B9E497A80D5A404EAED56E0759F9422E
manualProgressOverride	Manual "calculated accumulated progress" override (0-100), null if not overridden	double?	None
projectManagementMethodPhaseId	Contains a reference to a project management method's phase	string	D30CD7BA6C5E44EB9EBB31E4860CB544
dependencies	contains all PhaseDependency with fromPhase == this	ProjectWorkItemConstraint[ ]	None

ProjectWorkItemBackup

Describes a project work item (phase / milestone / folder) with additional version information

↳ (ProjectWorkItem)

Member	Description	Type	Example
dependencies (ProjectWorkItem)	contains all PhaseDependency with fromPhase == this	ProjectWorkItemConstraint	None
manualProgressOverride (ProjectWorkItem)	Manual "calculated accumulated progress" override (0-100), null if not overridden	double1	None
requiredSkill (ProjectWorkItem)	a resource (skill)	ItemWithDeletedFlag	None
projectCostsPositions (ProjectWorkItem)	References to the project costs positions that are assigned	NamedReference	None
end (ProjectWorkItem)	end of interval, or null for milestones	datetime	None
planned (ProjectWorkItem)	bottom-up planning	duration	None
timeBudget (ProjectWorkItem)	top-down planning	duration	None
endId (ProjectWorkItem)	The ID of the end point (may also be equal the startId or null)	string	A20C093779BF4FE69A7823953BE840B6
parentPhaseId (ProjectWorkItem)	A reference to the parent work item, null if main phase	string	9E91C2B21678493592299D8766A7429D
projectId (ProjectWorkItem)	A reference to the project	string	A2EC8F59A62D4E77A43A6A924A82C37A
properties (ProjectWorkItem)	A collection of dynamic properties belonging to the object	Property	None
description (ProjectWorkItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (ProjectWorkItem)	The name of the object (in the user's language, if translations are available)	string	Project X
code (ProjectWorkItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ProjectWorkItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
phaseType (ProjectWorkItem)	The kind of work item	ProjectWorkItemType	None
scenarioId (ProjectWorkItem)	A reference to the scenario	string	C51070CF01CC490F831F3D419D6358BD
startId (ProjectWorkItem)	The ID of the starting point (may also be equal the endId or null)	string	04ADAEF76C8D49DDBDAC1940BC99F940
sortIndex (ProjectWorkItem)	index for sorting siblings	double1	None
costsBudget (ProjectWorkItem)	top-down planning	CurrencyAmount	None
beg (ProjectWorkItem)	start of interval, or point of milestone, null for folders	datetime	None
fixed (ProjectWorkItem)	if true, beg and end cannot be modified	boolean	None
owner (ProjectWorkItem)	a resource	ItemWithDeletedFlag	None
color (ProjectWorkItem)	Used to be in format: "rgb(a,b,c)" where a, b, c are in 0..255, now it may also be an ID pointing to a client's enum containing the color	string	B9E497A80D5A404EAED56E0759F9422E
projectManagementMethodPhaseId (ProjectWorkItem)	Contains a reference to a project management method's phase	string	D30CD7BA6C5E44EB9EBB31E4860CB544
itemVersion	the item version	string	329C4AE2AD084B37B579796BD71DB9EA
structureVersion	the structure version	string	64AE546AFEA7488D8C2AFBD2EB38A4DB

ProjectWorkItemAccumulatedValues

Contains accumulated values (costs, effort, planning errors) for a project workitem

Member	Description	Type	Example
projectWorkItemId	The ID of the project work item	string	A7825BDD23E0414D9F337D19F70D0A81
childrenCount	The number of direct children	int	None
childrenCountAccumulated	The number of children including all children's children recursively	int	None
costsBudget	The costs budget of the item itself in the desired currency	CurrencyAmount	None
costsBudgetAccumulated	The costs budget of the item and its descendants in the desired currency	CurrencyAmount	None
costs	The costs (including forecasts) of the item itself	CostsForecastsGroups	None
costsAccumulated	The costs (including forecasts) of the item and its descendants	CostsForecastsGroups	None
resourceAllocations	The allocated time for the work item	duration	None
resourceAllocationsAccumulated	The allocated time for this work item and its descendants	duration	None
resourceActuals	The time spent for the work item	duration	None
resourceActualsAccumulated	The time spent for the work item and its descendants	duration	None
timeBudgetAccumulated	The time that could be spent for the work item and its descendants	duration	None
timePlannedAccumulated	The time that is planned to be spent for the work item and its descendants	duration	None
timeExpectedPending	The presence of a resource that has not yet been reported but is expected to be reported for the work item	duration	None
timeExpectedPendingAccumulated	The presence of a resource that has not yet been reported but is expected to be reported for the work item and its descendants	duration	None
timeRemaining	The time that is planned to be spent but has not been spent yet for the work item	duration	None
timeRemainingAccumulated	The time that is planned to be spent but has not been spent yet for the work item and its descendants	duration	None
errors	Detected planning errors for this work item in the user's language	string[ ]	["Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen."]
errorsAccumulated	Detected planning errors for this work item or any descendant in the user's language	string[ ]	["Die Phase 'Konzept' muss innerhalb ihrer übergeordneten Phase 'Hauptphase' liegen."]
progress	The progress of the work item in percent calculated	double	None
progressAccumulated	The progress of the work item in percent calculated respecting the progress of the descendants	double	None
manualProgressOverride	Manual "calculated accumulated progress" override (0-100), null if not overridden	double?	None
overloadIndicator	The overload indicator (sum of deviation of all allocated resources)	double	None
overloadIndicatorAccumulated	The max overload indicator (sum of deviation of all allocated resources) of all descendants and this work item	double	None

WorkItem

Describes a work item with basic information

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
duration	The effort that has to be done, measured in time	duration	None
start	The point in time when work will start	datetime	None
finish	The point in time when work should be done	datetime	None

ProjectWorkItemConstraint

Describes a dependency between two project phases

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
fromPhaseId	The source phase's ID	string	9D45E520ECFB4FE2AF5F74351ECDD96E
toPhaseId	The destination phase's ID	string	ABEA7AC2855E4D5D943BAC08DF7AB90C
dependencyType	The kind of dependency	ProjectWorkItemConstraintType	None
minDistance	The minimal distance between the two connecting points, null if not specified	int?	None
maxDistance	The maximal distance between the two connecting points, null if not specified	int?	None

ProjectWorkItemRemainingEfforts

Describes the progress / earned value history of a project work item

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
timeline	The different corrections on different days	ProjectWorkItemRemainingEffortWithOverrides[ ]	None

ProjectWorkItemRemainingEffort

Describes an element in a progress / earned value history of a project work item

Member	Description	Type	Example
remainingEffort	The remaining effort, if any	duration	None
remainingEffortSpecified	The remaining effort that was originally specified, if any	duration	None
progressSpecified	The progress that was specified (range 0-100), if any	int?	None
remark	A remark that describes how the progress or remaining value was estimated	string	Although we have no clue, it seems that we've made progress
modifiedAt	The point in time when the object was modified	datetime	None
modifiedBy	User ID with full name (if any) of the user that modified this object	Item	None

ProjectWorkItemRemainingEffortWithOverrides

Describes an element in a progress / earned value history of a project work item and contains overridden items

↳ (ProjectWorkItemRemainingEffort)

Member	Description	Type	Example
modifiedBy (ProjectWorkItemRemainingEffort)	User ID with full name (if any) of the user that modified this object	Item	None
remark (ProjectWorkItemRemainingEffort)	A remark that describes how the progress or remaining value was estimated	string	Although we have no clue, it seems that we've made progress
remainingEffortSpecified (ProjectWorkItemRemainingEffort)	The remaining effort that was originally specified, if any	duration	None
remainingEffort (ProjectWorkItemRemainingEffort)	The remaining effort, if any	duration	None
progressSpecified (ProjectWorkItemRemainingEffort)	The progress that was specified (range 0-100), if any	int1	None
modifiedAt (ProjectWorkItemRemainingEffort)	The point in time when the object was modified	datetime	None
at	The day when the earned value or remaining time was set	date	None
overidden	The items that were overridden by later corrections with same "at" value	ProjectWorkItemRemainingEffort[ ]	None

ReferenceWithLinkInfo

Information about a resource and the link to that resource (often used to list ancestors and their relation)

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
linkType	the type of link	string
linkId	the ID of the link	string	13C54F8BBFD84C17B6F863A3F17035B1
linkValidityStart	the first day of validity	date	None
linkValidityUntil	the first day without validity	date	None

ItemWithAncestors

An item with its ancestor references

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
ancestors	the ancestor references	ReferenceWithLinkInfo[ ]	None

AbsenceType

A type of absence for resources

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
availabilityPercentage	The percentage of availability for work (0 for absent, 100 for full availability)	int	None
presencePercentage	The percentage of physical presence at office (0 for absent, 100 for full presence)	int	None
category	Some obscure value affecting the grouping of absences on the client (ask the client team about details)	int	None

AbsenceTypeTranslated

A type of absence for resources

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
availabilityPercentage	The percentage of availability for work (0 for absent, 100 for full availability)	int	None
presencePercentage	The percentage of physical presence at office (0 for absent, 100 for full presence)	int	None
category	Some obscure value affecting the grouping of absences on the client (ask the client team about details)	int	None

Resource

A resource (an entity that may be allocated to projects and work items)

↳ (Reference)

Member	Description	Type	Example
properties (VersionedDetails)	Dynamic properties with metadata	Property	None
validityStart (VersionedDetails)	Start (inclusive) of the validity period of the object (often null)	date	None
color (VersionedDetails)	The color of an object	color	None
code (VersionedDetails)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedDetails)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedDetails)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef (VersionedDetails)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityEnd (VersionedDetails)	End (exclusive) of the validity period of the object (often null)	date	None
eMail	the e-Mail address of a resource (this information may be used for single sign on)	string	a.b@c.d

ResourceGroup

A resource group (HRM, KSM, ...)

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	the name in the user's language	string	HRM
description	a short description in the user's language	string	Human Resource Management
imageUrl	an icon for the resource group	string	../images/ResourceGroup1.jpg
rootResource	the root resource of the group	Reference	None

ResourceLinkType

A resource link type

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
fromResourceTypeId	the ID of the source resource's type	string	C2238C5A51364E4FAADDFB97F8165EE0
toResourceTypeId	the ID of the destination resource's type	string	42007EE0E00C4C079934E8C06D3C285A
name	the name of the resource link type in the user's language	string	Name of this resource link type.
nameReverse	the reverse name of the resource type in the user's language	string	Backwards name of this resource link type.
description	A descriptive text about the object, may contain HTML	string	<p>This is a description</p>
iconRef	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/type_emp.png
color	A color or any identifier of a color	color	None
isHard	flag to indicate a hard link (a link that builds the resource tree structure)	boolean	None
targetObjectNeedsParentPermission	require permission of source resource if trying to access target resource	boolean	None
targetObjectInheritRelations	inherit relations of source resource if trying to access target resource	boolean	None
implicitRelationId	if not null, PQFORCE has created a corresponding relation type	string	92405555E8325390AE0D355E58A83DEF

ResourceType

A resource type

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	the name of the resource type in the user's language	string	Name of this resource type.
resourceGroupeId	the group this resource type belongs to	string	8692805B95184F6B82FF1E35AB8DE680
costsTypeId	the costs type that efforts of such resources will be accounted for	string	B629E733280D45DEB0E807E09DD399D6
resourceKind	the kind of resource (semantics)	ResourceKind	None

ResourceShift

Defines a worktime shift for a resource.

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	the name of the shift in the user's language	string	Name of this resource shift.
description	a short description in the user's language	string	Description..
imageUrl	an icon	string	example.svg
color	a color	color	None
duration	the effective duration of the shift (may not match beg until end)	duration	None
begTime	the time of day the shift starts (duration since midnight)	duration	None
endTime	the time of day the shift ends (duration since midnight)	duration	None

Presence

A resource presence as part of its worktime model

Member	Description	Type	Example
presence	a flag indicating whether a resource is normally present	boolean	None
duration	the duration if present	duration	None

Model

Presences for a specific shift

Member	Description	Type	Example
shift	the shift	ResourceShift	None
presencePerDay	an array containing the presences for each weekday (always 7 elements, mon - sun)	Presence[ ]	None

Availability

Availability model of a resource

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
definedOn	A reference to indicate the place in the resource tree where this object belongs to (read-only)	Reference	None
inheritFromParent	a flag indicating that model has to be inherited from parent (ignored if root resource)	boolean	None
inheritedFrom	A reference to indicate the resource tree where the model has been inherited from (read-only)	Reference	None
validAfter	the first day of validity	date	None
holidayLocaleId	the locale for the holidays (in Switzerland, each Kanton has its own holidays - and yes, Zug has a lot of them)	string	3AB82153158E457C909D0DFE67CB4EE2
models	the standard availabilities for each shift on each weekday	Model[ ]	None
basicLoadPercent	the basic load of resource (the percentage of time that has to be spent for other things than projects, i.e. administrative tasks)	int	None
costPerHour	the costs per hour for a resource (needed to transform efforts into costs)	double	None
costCurrency	the currency for the costs	string	CHF
description	a short description of the availability model	string
ftePercent	the amount of full time equivalents that a resource counts for (0 for groups, 100 for single resources)	int	None
standardAvails	the standard availabilities per day (may differ from the sum of shift availabilities, always 7 elements, mon - sun)	duration	None

AvailabilitiesByResource

Availabilities by resource (for bulk requests)

Member	Description	Type	Example
resource	A reference to a resource	Reference	None
availabilities	The availabilities of the resource	Availability[ ]	None

Holiday

Describes a holiday for resources (assigned to a date and a shift)

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
date	The day of the holiday	date	None
shiftId	The ID of the shift that is affected	string	4953B2416F6C471CB89EA86B3514F502
name	The name of the holiday in the user's language	string	Ostermontag

ResourceGroupStandardWorktime

Describes the standard worktime of a resource group

Member	Description	Type	Example
id	The ID of the resource group	string	3687790A73CC42AE94DDB75B2AD65AD3
timePerWeek	the time per week that resources work	duration	None
daysPerWeek	the days per week that resources work	int	None

WorkdayMapping

Maps a workday scheme to weekdays or vice versa

Member	Description	Type	Example
resource	a reference to the resource	Reference	None
referenceDay	the 0-reference day	date	None
mapping	the mapping (distance to reference date in days)	int	None

ProjectRisk

Describes a project risk without history

↳ (Risk)

Member	Description	Type	Example
rating (Risk)	The rating of the risk	RiskRating	None
projectId	A reference to the project	string	87F5235D6B2E49168DA41EF3781F539E
dimension	The indicator dimension that this risk belongs to	string	4784F638450845AC981DB2FC5F00D2D7

ProjectRiskWithHistory

Describes a project risk with history

↳ (RiskWithHistory)

↳ (Risk)

Member	Description	Type	Example
history (RiskWithHistory)	The history (the newest first)	RiskRatingHistoric	None
rating (Risk)	The rating of the risk	RiskRating	None
projectId	A reference to the project	string	87F5235D6B2E49168DA41EF3781F539E
dimension	The indicator dimension that this risk belongs to	string	4784F638450845AC981DB2FC5F00D2D7

Risk

Describes a risk with rating but without historic data

↳ (Reference)

↳ (VersionedItem)

Member	Description	Type	Example
properties (VersionedItemWithProperties)	A collection of dynamic properties belonging to the object	Property	None
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
rating	The rating of the risk	RiskRating	None

RiskClassification

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

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	The name or label of the classification in the user's language	string	Klasse A
description	A short description in the user's language (may contain HTML)	string	<p>Dies ist eines der wichtigsten Risiken, die immer im Auge behalten werden müssen</p>
imageUrl	The icon for the risk	string	../images/bigrisk.svg
color	The color for the risk to be visualized	color	None
limit	The lowest value for which this classification will be assigned	double	None

RiskClassificationTranslated

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

↳ (Reference)

Member	Description	Type	Example
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
name	The name or label of the classification in all available languages	Translation[ ]	None
description	A short description in all available languages (may contain HTML)	Translation[ ]	None
imageUrl	The icon for the risk	Translation[ ]	None
color	The color for the risk to be visualized	color	None
limit	The lowest value for which this classification will be assigned	double	None

RiskMatrixAssignment

The calculated classifications of a risk according to the matrix definition

Member	Description	Type	Example
occurrenceProbabilityClassification	The classification of the occurrence probability	string	F25B505C9E0C42ADBEF3D9D24539DF18
extentOfLossClassification	The classification of the extent of loss	string	42C18259199A41DB929DAE8326B50C5A
riskRatingClassification	The classification of the risk rating	string	F71376233416402885209C3AEA0C4760

RiskMatrixDefinition

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

↳ (Item)

↳ (Reference)

Member	Description	Type	Example
validityUntil (Item)	End (exclusive) of the validity period of the object (often null)	date	None
color (Item)	A color or any identifier of a color	color	None
description (Item)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (Item)	The name of the object (in the user's language, if translations are available)	string	Project X
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (Item)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (Item)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (Item)	Start (inclusive) of the validity period of the object (often null)	date	None
occurrenceProbabilityClassifications	The possible classifications of the occurrence probability	RiskClassification[ ]	None
extentOfLossClassifications	The possible classifications of the extent of loss	RiskClassification[ ]	None
riskRatingClassifications	The possible classifications of the risk rating	RiskClassification[ ]	None
fields	The fields of the matrix	RiskMatrixAssignment[ ]	None
customCalculationRule	A JavaScript based rule to calculate a risk rating	string	occurrenceProbability * extentOfLoss

RiskMatrixDefinitionTranslated

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

↳ (ItemTranslated)

↳ (Reference)

Member	Description	Type	Example
validityUntil (ItemTranslated)	End (exclusive) of the validity period of the object (often null)	date	None
color (ItemTranslated)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (ItemTranslated)	A descriptive text about the object, may contain HTML (in different languages)	Translation	None
name (ItemTranslated)	The name of the object in different languages	Translation	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
code (ItemTranslated)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (ItemTranslated)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data (in different languages)	Translation	None
validityStart (ItemTranslated)	Start (inclusive) of the validity period of the object (often null)	date	None
occurrenceProbabilityClassifications	The possible classifications of the occurrence probability	RiskClassificationTranslated[ ]	None
extentOfLossClassifications	The possible classifications of the extent of loss	RiskClassificationTranslated[ ]	None
riskRatingClassifications	The possible classifications of the risk rating	RiskClassificationTranslated[ ]	None
fields	The fields of the matrix	RiskMatrixAssignment[ ]	None
customCalculationRule	A JavaScript based rule to calculate a risk rating	string	occurrenceProbability * extentOfLoss

RiskRating

Describes how a risk is rated

Member	Description	Type	Example
occurrenceProbability	The probability of the occurrence on an event	double	None
occurrenceProbabilityClassification	The classification of the probability of the occurrence on an event	string	F25B505C9E0C42ADBEF3D9D24539DF18
extentOfLoss	The amount of damage in case of an event	double	None
extentOfLossClassification	The classification of the amount of damage in case of an event	string	42C18259199A41DB929DAE8326B50C5A
riskRating	The rating of the risk (the product of occurrence probability and extent of loss)	double	None
riskRatingClassification	The classification of the rating of the risk	string	F71376233416402885209C3AEA0C4760

RiskRatingHistoric

A historic value of a risk rating

Member	Description	Type	Example
at	The point in time when this rating was valid	datetime	None
obj	The rating	RiskRating	None

RiskWithHistory

Describes a risk with rating including historic data

↳ (Risk)

Member	Description	Type	Example
rating (Risk)	The rating of the risk	RiskRating	None
history	The history (the newest first)	RiskRatingHistoric[ ]	None

AchievementRate

Describes the degree of achievement measured in a specific numeric metric

Member	Description	Type	Example
target	The target in the defined metric	double?	None
actual	The actual value in the defined metric	double?	None
metric	a metric that can be used to measure the degree of achievement	string	The number of cows on our farm that look happy
rate	The achievement rate in percent (calculated)	double?	None

ProjectContribution

A contribution to an objective

↳ (Reference)

Member	Description	Type	Example
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
objectiveId	A reference to the objective	string	BEEC457E222C4F16A0D229D37D40743F
projectId	A reference to the project	string	AEFBF483F1AB484FB85561CCDFC11915
weight	The weight of the contribution	int	None
remark	A remark describing some facts about the contribution	string	THis is a simple, but effective way to support our objective
progress	The accumulated progress (in percent) of the active scenario's main phase (may be null, read-only)	double?	None
progressOverride	The manual progress override (in percent) of the active scenario's main phase (is null if not overridden, read-only)	double?	None
sortIndex	The index to sort for (lowest first)	double	None
properties	A collection of dynamic properties belonging to the object	Property[ ]	None

FieldOfAction

A field of action

↳ (Reference)

Member	Description	Type	Example
properties (VersionedDetails)	Dynamic properties with metadata	Property	None
validityStart (VersionedDetails)	Start (inclusive) of the validity period of the object (often null)	date	None
color (VersionedDetails)	The color of an object	color	None
code (VersionedDetails)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedDetails)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedDetails)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef (VersionedDetails)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityEnd (VersionedDetails)	End (exclusive) of the validity period of the object (often null)	date	None
visionId	the vision this field of action belongs to	string	97BC2BB37F474CC7AB8FE76237FEDCF3
achievementRate	The achievement rate in percent calculated from the weighted objectives (may be null, read-only)	double?	None
progressByContributionState	The progress in percent calculated from the weighted project contributions by their state	ProgressByState[ ]	None
progress	The progress in percent calculated from the weighted objectives (may be null, read-only)	double?	None
indicatorStatuses	The statistics about indicator statuses	ObjectiveIndicatorStatus[ ]	None
sortIndex	The index to sort for (lowest first)	double	None

Objective

An objective for a field of action

↳ (Reference)

Member	Description	Type	Example
properties (VersionedDetails)	Dynamic properties with metadata	Property	None
validityStart (VersionedDetails)	Start (inclusive) of the validity period of the object (often null)	date	None
color (VersionedDetails)	The color of an object	color	None
code (VersionedDetails)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedDetails)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedDetails)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef (VersionedDetails)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityEnd (VersionedDetails)	End (exclusive) of the validity period of the object (often null)	date	None
foaId	The ID of the field of action this objective belongs to	string	5C756AD7EF904F568DB462A961174023
weight	The weight of the objective	int	None
achievementRate	the degree of achievement measured in a specific numeric metric	AchievementRate	None
progressByContributionState	The progress in percent calculated from the weighted project contributions by their state	ProgressByState[ ]	None
progress	The progress in percent calculated from the weighted project contributions (may be null, read-only)	double?	None
indicatorStatuses	The statistics about indicator statuses	ObjectiveIndicatorStatus[ ]	None
sortIndex	The index to sort for (lowest first)	double	None

ObjectiveIndicator

An indicator for objective achievement measurement

↳ (VersionedItem)

↳ (Reference)

Member	Description	Type	Example
validityUntil (VersionedItem)	End (exclusive) of the validity period of the object (often null)	date	None
color (VersionedItem)	A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)	color	None
description (VersionedItem)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
name (VersionedItem)	The name of the object (in the user's language, if translations are available)	string	Project X
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
code (VersionedItem)	A short code which may be unique over all objects of the same type	string	PRJ-X
iconRef (VersionedItem)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityStart (VersionedItem)	Start (inclusive) of the validity period of the object (often null)	date	None
objectiveId	the objective this indicator belongs to	string	EE3A59726B97413AB3F53468D2DA9BB8
targetType	The type of quantitative target measurement, null to indicate qualitative measurement	ObjectiveIndicatorTargetType	None
target	The target value (dynamic)	string	1.234
actual	The actual value (dynamic)	string	1.432
unit	A unit for measurement, may be also something countable	string	Average children per family
remark	a simple remark about the values	string	Values from statistical bulletin of our town
weight	the weight for statistics on objective object	int	None
statusClass	a reference to enum STG-OBJECTIVE-INDICATOR-STATUS	string	STG-OBJECTIVE-INDICATOR-OK
sortIndex	The index to sort for (lowest first)	double	None
properties	A collection of dynamic properties belonging to the object	Property[ ]	None

ObjectiveIndicatorStatus

Statistics about objective indicator statuses

Member	Description	Type	Example
statusClass	a reference to enum STG-OBJECTIVE-INDICATOR-STATUS	string	STG-OBJECTIVE-INDICATOR-OK
accumulatedWeights	the accumulated weights of all indicators with that status class	int	None

ProgressByState

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

Member	Description	Type	Example
stateId	the ID of the state	string	CC89642923CC4E9083D4F9983A502549
weight	The sum of weights	int	None
progress	The progress in percent calculated from the weighted project contributions (read-only)	double	None

Strategy

A strategy

↳ (Reference)

Member	Description	Type	Example
properties (VersionedDetails)	Dynamic properties with metadata	Property	None
validityStart (VersionedDetails)	Start (inclusive) of the validity period of the object (often null)	date	None
color (VersionedDetails)	The color of an object	color	None
code (VersionedDetails)	A short code which may be unique over all objects of the same type	string	PRJ-X
historic (VersionedReference)	true, if there is a more recent version of this object; false, if this is the most recent version of this object	boolean	None
modifiedBy (VersionedReference)	User ID with full name (if any) of the user that modified this object	Item	None
createdBy (VersionedReference)	User ID with full name (if any) of the user that created this object	Item	None
id (Reference)	The ID of the object (often a UUID, but not necessarily)	string	C9B2C6F28EDF46F68EA15BCDE2252D05
type (Reference)	The type of the object (used for change notifications)	string	AnyTypeOfObj
createdAt (VersionedReference)	The point in time when the object was created	datetime	None
modifiedAt (VersionedReference)	The point in time when the object was modified	datetime	None
version (VersionedReference)	A unique identifier for the version, usually a UUID	string	029335F8E37A45758C3B6235863F4BA8
name (VersionedDetails)	The name of the object (in the user's language, if translations are available)	string	Project X
description (VersionedDetails)	A descriptive text about the object, may contain HTML	string	<p>This was the development name of <b>PQFORCE</b></p>
iconRef (VersionedDetails)	value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "data:image/png;base64,[base64data]" for inline data	string	/images/lifecycle/planning.png
validityEnd (VersionedDetails)	End (exclusive) of the validity period of the object (often null)	date	None

Vision

A vision

↳ (Reference)