API V3 Documentation – LCY
Preview: this documents PQFORCE 4.26.6, which has not been released yet.
Endpoints
GET /API/V3/LCY/InitialStates
Returns all initial states that have been set for new objects of all types
HTTP syntax
GET /API/V3/LCY/InitialStates
<- application/jsonJavaScript syntax
Pqf.lcy.getInitialStates() // returns LifecycleInitialStateWithSubStateReference[]Result
This endpoint returns the following data: array of LifecycleInitialStateWithSubStateReference
GET /API/V3/LCY/Object/:objectType/:objectId/History
Returns the lifecycle history (newest entry first) of a given object
HTTP syntax
GET /API/V3/LCY/Object/:objectType/:objectId/History
<- application/json JavaScript syntax
Pqf.lcy.getObjectHistory(objectType, objectId) // returns LifecycleHistory[] Required permission
Requires permission READ on object of type specified in parameter objectType and ID specified in parameter objectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectId |
UUID | The ID of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of LifecycleHistory
GET /API/V3/LCY/Object/:objectType/:objectId/ReachableStates
Returns the states that are reachable by a given object
HTTP syntax
GET /API/V3/LCY/Object/:objectType/:objectId/ReachableStates
<- application/json JavaScript syntax
Pqf.lcy.getObjectReachableStates(objectType, objectId) // returns PF.Reference[] Required permission
Requires permission IDENTIFY on object of type specified in parameter objectType and ID specified in parameter objectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectId |
UUID | The ID of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/LCY/Object/:objectType/:objectId/State
Returns the state of a given object
HTTP syntax
GET /API/V3/LCY/Object/:objectType/:objectId/State
<- application/json : LifecycleStateWithSubStateReference JavaScript syntax
Pqf.lcy.getObjectState(objectType, objectId) // returns LifecycleStateWithSubStateReference Required permission
Requires permission IDENTIFY on object of type specified in parameter objectType and ID specified in parameter objectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectId |
UUID | The ID of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: LifecycleStateWithSubStateReference
GET /API/V3/LCY/Object/:objectType/:objectId/Transitions
Returns the transitions that are allowed for the current user to apply to a given object
HTTP syntax
GET /API/V3/LCY/Object/:objectType/:objectId/Transitions
<- application/json JavaScript syntax
Pqf.lcy.getObjectTransitions(objectType, objectId) // returns PF.Reference[] Required permission
Requires permission IDENTIFY on object of type specified in parameter objectType and ID specified in parameter objectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectId |
UUID | The ID of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.Reference
POST /API/V3/LCY/Object/:objectType/:objectId/Upgrade/:transitionId/WithRemark
Applies a lifecycle transition to a given object
HTTP syntax
POST /API/V3/LCY/Object/:objectType/:objectId/Upgrade/:transitionId/WithRemark
-> application/json : LifecycleUpgradeRemark
<- application/json : LifecycleStateWithSubStateReference JavaScript syntax
Pqf.lcy.upgradeObject(objectType, objectId, transitionId, requestJson) // returns LifecycleStateWithSubStateReference Required permission
Requires permission for transition specified in parameter transitionId on object of type specified in parameter objectType and ID specified in parameter objectId.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectId |
UUID | The ID of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
transitionId |
UUID | transition to apply | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
LifecycleUpgradeRemark | JSON object of type LifecycleUpgradeRemark | ✔️ |
Result
This endpoint returns the following data: LifecycleStateWithSubStateReference
GET /API/V3/LCY/Objects/:objectType/:objectIds/Histories
Returns the lifecycle history (newest entry first) of given objects
HTTP syntax
GET /API/V3/LCY/Objects/:objectType/:objectIds/Histories
<- application/json JavaScript syntax
Pqf.lcy.getObjectsHistories(objectType, objectIds) // returns LifecycleHistoryArrayWithObjectId[] Required permission
Requires permission READ on object of type specified in parameter objectType and ID in specified in parameter objectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectIds |
array of UUID | The IDs of the objects | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of LifecycleHistoryArrayWithObjectId
GET /API/V3/LCY/Objects/:objectType/:objectIds/ReachableStates
Returns the states that are reachable by given objects
HTTP syntax
GET /API/V3/LCY/Objects/:objectType/:objectIds/ReachableStates
<- application/json JavaScript syntax
Pqf.lcy.getObjectsReachableStates(objectType, objectIds) // returns ReferenceArrayWithObjectId[] Required permission
Requires permission IDENTIFY on object of type specified in parameter objectType and ID in specified in parameter objectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectIds |
array of UUID | The IDs of the objects | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ReferenceArrayWithObjectId
GET /API/V3/LCY/Objects/:objectType/:objectIds/States
Returns the states of given objects
HTTP syntax
GET /API/V3/LCY/Objects/:objectType/:objectIds/States
<- application/json JavaScript syntax
Pqf.lcy.getObjectsStates(objectType, objectIds) // returns LifecycleStateWithSubStateReferenceAndObjectId[] Required permission
Requires permission IDENTIFY on object of type specified in parameter objectType and ID in specified in parameter objectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectIds |
array of UUID | The IDs of the objects | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of LifecycleStateWithSubStateReferenceAndObjectId
GET /API/V3/LCY/Objects/:objectType/:objectIds/Transitions
Returns the transitions that are allowed for the current user to apply to given objects
HTTP syntax
GET /API/V3/LCY/Objects/:objectType/:objectIds/Transitions
<- application/json JavaScript syntax
Pqf.lcy.getObjectsTransitions(objectType, objectIds) // returns ReferenceArrayWithObjectId[] Required permission
Requires permission IDENTIFY on object of type specified in parameter objectType and ID in specified in parameter objectIds.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectIds |
array of UUID | The IDs of the objects | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ReferenceArrayWithObjectId
POST /API/V3/LCY/Objects/:objectType/Migrate/:sourceStateId/:sourceSubStateId/To/:targetStateId/:targetSubStateId
Moves objects (that may be stuck in an illegal state due to lifecycle changes) into a new, legal state
HTTP syntax
POST /API/V3/LCY/Objects/:objectType/Migrate/:sourceStateId/:sourceSubStateId/To/:targetStateId/:targetSubStateId
-> application/json : LifecycleUpgradeRemark
<- application/json JavaScript syntax
Pqf.lcy.migrateObjects(objectType, sourceStateId, sourceSubStateId, targetStateId, targetSubStateId, requestJson) // returns PF.Reference[] Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sourceStateId |
UUID | The legal or illegal state to move objects from | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sourceSubStateId |
UUID | The legal or illegal sub state to move objects from | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
targetStateId |
UUID | The legal state to move objects to | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
targetSubStateId |
UUID | The legal sub state to move objects to | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
LifecycleUpgradeRemark | JSON object of type LifecycleUpgradeRemark | ✔️ |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/LCY/Objects/:objectType/Stuck
Returns objects that are stuck in an illegal state due to lifecycle changes
HTTP syntax
GET /API/V3/LCY/Objects/:objectType/Stuck
<- application/json JavaScript syntax
Pqf.lcy.getStuckObjects(objectType) // returns ObjectReferencesInLifecycleState[] Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of ObjectReferencesInLifecycleState
GET /API/V3/LCY/State/:stateId
Returns information about a specific lifecycle state
HTTP syntax
GET /API/V3/LCY/State/:stateId
<- application/json : LifecycleStateJavaScript syntax
Pqf.lcy.getState(stateId) // returns LifecycleStateParameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: LifecycleState
GET /API/V3/LCY/State/:stateId/Objects/:objectType
Returns all objects of a given type in a given state
HTTP syntax
GET /API/V3/LCY/State/:stateId/Objects/:objectType?reachedAtOrAfter=...&reachedBefore=...
<- application/json JavaScript syntax
Pqf.lcy.getObjectsByState(stateId, objectType, reachedAtOrAfter, reachedBefore) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.lcy.getObjectsByState(stateId, objectType, reachedAtOrAfter) // returns PF.Reference[]
Pqf.lcy.getObjectsByState(stateId, objectType) // returns PF.Reference[] Required permission
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectType |
UUID | The type of objects | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
reachedAtOrAfter |
datetime | filter out objects that reached their state before the given timestamp | ||
reachedBefore |
datetime | filter out objects that reached their state at or after the given timestamp |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/LCY/State/:stateId/ReachableStates
Returns all states that can be reached starting from a specific lifecycle state
HTTP syntax
GET /API/V3/LCY/State/:stateId/ReachableStates
<- application/json JavaScript syntax
Pqf.lcy.getStateReachableStates(stateId) // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/LCY/State/:stateId/SubState/:subStateId/WithTranslations
Returns information about a specific lifecycle sub-state and its translations
HTTP syntax
GET /API/V3/LCY/State/:stateId/SubState/:subStateId/WithTranslations
<- application/json : LifecycleSubStateTranslated JavaScript syntax
Pqf.lcy.getSubStateTranslated(stateId, subStateId) // returns LifecycleSubStateTranslated Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subStateId |
UUID | The ID of the lifecycle sub state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: LifecycleSubStateTranslated
PUT /API/V3/LCY/State/:stateId/SubState/:subStateId/WithTranslations
Updates or creates a specific lifecycle sub-state and its translations
HTTP syntax
PUT /API/V3/LCY/State/:stateId/SubState/:subStateId/WithTranslations
-> application/json : LifecycleSubStateTranslated JavaScript syntax
Pqf.lcy.putSubStateTranslated(stateId, subStateId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subStateId |
UUID | The ID of the lifecycle sub state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
LifecycleSubStateTranslated | JSON object of type LifecycleSubStateTranslated | ✔️ |
DELETE /API/V3/LCY/State/:stateId/SubState/:subStateId/WithTranslations
Deletes a specific lifecycle sub-state
HTTP syntax
DELETE /API/V3/LCY/State/:stateId/SubState/:subStateId/WithTranslations JavaScript syntax
Pqf.lcy.delSubStateTranslated(stateId, subStateId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subStateId |
UUID | The ID of the lifecycle sub state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/LCY/State/:stateId/SubStates
Returns references to a lifecycle state's substates
HTTP syntax
GET /API/V3/LCY/State/:stateId/SubStates
<- application/json JavaScript syntax
Pqf.lcy.getStateAllSubStates(stateId) // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/LCY/State/:stateId/SubStates/:subStateIds
Returns information about some sub-states of a lifecycle state
HTTP syntax
GET /API/V3/LCY/State/:stateId/SubStates/:subStateIds
<- application/json JavaScript syntax
Pqf.lcy.getStateSubStates(stateId, subStateIds) // returns LifecycleSubState[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subStateIds |
array of UUID | The IDs of the sub-states to retrieve | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of LifecycleSubState
GET /API/V3/LCY/State/:stateId/SubStates/:subStateIds/WithTranslations
Returns information about some sub-states of a specific lifecycle state and their translations
HTTP syntax
GET /API/V3/LCY/State/:stateId/SubStates/:subStateIds/WithTranslations
<- application/json JavaScript syntax
Pqf.lcy.getSubStatesTranslated(stateId, subStateIds) // returns LifecycleSubStateTranslated[] Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subStateIds |
array of UUID | The IDs of the sub-states to retrieve | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of LifecycleSubStateTranslated
GET /API/V3/LCY/State/:stateId/Transitions
Returns a specific lifecycle state's possible transitions
HTTP syntax
GET /API/V3/LCY/State/:stateId/Transitions
<- application/json JavaScript syntax
Pqf.lcy.getStateTransitions(stateId) // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/LCY/State/:stateId/WithTranslations
Returns information about a specific lifecycle state and its translations
HTTP syntax
GET /API/V3/LCY/State/:stateId/WithTranslations
<- application/json : LifecycleStateTranslated JavaScript syntax
Pqf.lcy.getStateTranslated(stateId) // returns LifecycleStateTranslated Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: LifecycleStateTranslated
PUT /API/V3/LCY/State/:stateId/WithTranslations
Updates or creates a specific lifecycle state and its translations
HTTP syntax
PUT /API/V3/LCY/State/:stateId/WithTranslations
-> application/json : LifecycleStateTranslated JavaScript syntax
Pqf.lcy.putStateTranslated(stateId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
LifecycleStateTranslated | JSON object of type LifecycleStateTranslated | ✔️ |
DELETE /API/V3/LCY/State/:stateId/WithTranslations
Deletes a specific lifecycle state
HTTP syntax
DELETE /API/V3/LCY/State/:stateId/WithTranslations JavaScript syntax
Pqf.lcy.delStateTranslated(stateId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateId |
UUID | The ID of the lifecycle state | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/LCY/States
Returns references to all lifecycle states
HTTP syntax
GET /API/V3/LCY/States?sort=...
<- application/jsonJavaScript syntax
Pqf.lcy.getAllStates(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.lcy.getAllStates() // returns PF.Reference[]Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, name, code, description, color, category, sortIndex. Sorting by createdAt or modifiedAt requires the administration permission and is ignored without it | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/LCY/States/:stateIds
Returns information about some lifecycle states
HTTP syntax
GET /API/V3/LCY/States/:stateIds
<- application/jsonJavaScript syntax
Pqf.lcy.getStates(stateIds) // returns LifecycleState[]Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateIds |
array of UUID | The IDs of the states to retrieve | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of LifecycleState
GET /API/V3/LCY/States/:stateIds/Objects/:objectType
Returns all objects of a given type in one of the given states
HTTP syntax
GET /API/V3/LCY/States/:stateIds/Objects/:objectType?reachedAtOrAfter=...&reachedBefore=...
<- application/json JavaScript syntax
Pqf.lcy.getObjectsByStates(stateIds, objectType, reachedAtOrAfter, reachedBefore) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.lcy.getObjectsByStates(stateIds, objectType, reachedAtOrAfter) // returns PF.Reference[]
Pqf.lcy.getObjectsByStates(stateIds, objectType) // returns PF.Reference[] Required permission
The returned array is filtered and contains only objects with permission IDENTIFY.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateIds |
array of UUID | The ID of the lifecycle state | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectType |
UUID | The type of objects | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
reachedAtOrAfter |
datetime | filter out objects that reached their state before the given timestamp | ||
reachedBefore |
datetime | filter out objects that reached their state at or after the given timestamp |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/LCY/States/:stateIds/WithTranslations
Returns information about all lifecycle states and their translations
HTTP syntax
GET /API/V3/LCY/States/:stateIds/WithTranslations
<- application/json JavaScript syntax
Pqf.lcy.getStatesTranslated(stateIds) // returns LifecycleStateTranslated[] Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
stateIds |
array of UUID | The IDs of the states to retrieve | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of LifecycleStateTranslated
GET /API/V3/LCY/Transition/:transitionId
Returns a specific transition
HTTP syntax
GET /API/V3/LCY/Transition/:transitionId
<- application/json : LifecycleTransition JavaScript syntax
Pqf.lcy.getTransition(transitionId) // returns LifecycleTransition Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
transitionId |
UUID | The ID of the transition | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: LifecycleTransition
GET /API/V3/LCY/Transition/:transitionId/WithTranslations
Returns a specific transition and its translations
HTTP syntax
GET /API/V3/LCY/Transition/:transitionId/WithTranslations
<- application/json : LifecycleTransitionTranslated JavaScript syntax
Pqf.lcy.getTransitionTranslated(transitionId) // returns LifecycleTransitionTranslated Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
transitionId |
UUID | The ID of the transition | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: LifecycleTransitionTranslated
PUT /API/V3/LCY/Transition/:transitionId/WithTranslations
Updates or creates a specific lifecycle transition and its translations
HTTP syntax
PUT /API/V3/LCY/Transition/:transitionId/WithTranslations
-> application/json : LifecycleTransitionTranslated JavaScript syntax
Pqf.lcy.putTransitionTranslated(transitionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
transitionId |
UUID | The ID of the transition | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
LifecycleTransitionTranslated | JSON object of type LifecycleTransitionTranslated | ✔️ |
DELETE /API/V3/LCY/Transition/:transitionId/WithTranslations
Deletes a specific lifecycle transition
HTTP syntax
DELETE /API/V3/LCY/Transition/:transitionId/WithTranslations JavaScript syntax
Pqf.lcy.delTransitionTranslated(transitionId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
transitionId |
UUID | The ID of the transition | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/LCY/Transitions
Returns all transitions
HTTP syntax
GET /API/V3/LCY/Transitions?sort=...
<- application/json JavaScript syntax
Pqf.lcy.getAllTransitions(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.lcy.getAllTransitions() // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, name, code, description, color, from, to. Sorting by createdAt or modifiedAt requires the administration permission and is ignored without it | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/LCY/Transitions/:transitionIds
Returns some transitions
HTTP syntax
GET /API/V3/LCY/Transitions/:transitionIds
<- application/json JavaScript syntax
Pqf.lcy.getTransitions(transitionIds) // returns LifecycleTransition[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
transitionIds |
array of UUID | The IDs of the transitions to retrieve | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of LifecycleTransition
GET /API/V3/LCY/Transitions/:transitionIds/WithTranslations
Returns some specific transitions and their translations
HTTP syntax
GET /API/V3/LCY/Transitions/:transitionIds/WithTranslations
<- application/json JavaScript syntax
Pqf.lcy.getTransitionsTranslated(transitionIds) // returns LifecycleTransitionTranslated[] Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
transitionIds |
array of UUID | The IDs of the transitions | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of LifecycleTransitionTranslated
GET /API/V3/LCY/Type/:objectType/InitialState
Returns the state that will be set for new objects of a given type
HTTP syntax
GET /API/V3/LCY/Type/:objectType/InitialState
<- application/json : LifecycleStateWithSubStateReference JavaScript syntax
Pqf.lcy.getTypeInitialState(objectType) // returns LifecycleStateWithSubStateReference Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: LifecycleStateWithSubStateReference
PUT /API/V3/LCY/Type/:objectType/InitialState
Sets the initial state that will be set for new objects of a given type
HTTP syntax
PUT /API/V3/LCY/Type/:objectType/InitialState
-> application/json : LifecycleStateWithSubStateReference JavaScript syntax
Pqf.lcy.putTypeInitialState(objectType, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
LifecycleStateWithSubStateReference | JSON object of type LifecycleStateWithSubStateReference | ✔️ |
DELETE /API/V3/LCY/Type/:objectType/InitialState
Deletes an initial state assigned for new objects of a given type
HTTP syntax
DELETE /API/V3/LCY/Type/:objectType/InitialState JavaScript syntax
Pqf.lcy.delTypeInitialState(objectType) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- config-lifecycle
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/LCY/Type/:objectType/ReachableStates
Returns all states that can be reached by objects of a given type
HTTP syntax
GET /API/V3/LCY/Type/:objectType/ReachableStates
<- application/json JavaScript syntax
Pqf.lcy.getTypeReachableStates(objectType) // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of object | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of PF.Reference
Data types
LCY.LifecycleCategory
This is an enumeration data contract.
A category for a lifecycle state adding some semantics
Enum values
| ID | Description |
|---|---|
NEW |
Normally the category for initial states of an object |
PLANNING |
Category for states that indicate that an object may change and is not fixed yet |
ACTIVE |
Category for states that indicate that the object is currently active or running |
CLOSED |
States with this category indicate that the object is not in use anymore and will not change significantly anymore |
LCY.LifecycleHistory
This is a structure data contract.
Contains an entry of history of states and transitions of a specific object
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | The version ID of the lifecycle entry | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
|
state |
LifecycleStateWithSubStateReference | The state that was reached | non-null (The value is required.) |
|
transition |
PF.Reference | The transition that was used to reach the state (may be null for initial state) | ||
timestamp |
datetime | The point in time when state was reached | non-null (The value is required.) |
|
initiatedBy |
PF.Reference | A reference to the user that initiated the lifecycle change (may be null in rare cases) | ||
remark |
string | A remark that describes the reason of or any other information about the change |
LCY.LifecycleHistoryArrayWithObjectId
This is a structure data contract.
Contains the history of states and transitions of a specific object with object ID reference
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
objectId |
UUID | The reference to the object ID | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
history |
array of LifecycleHistory | The history of states and transitions | null;non-null (The array is optional. Each element must not be null.) |
LCY.LifecycleInitialStateWithSubStateReference
This is a structure data contract.
Describes a state with one specific sub-state which will init a certain object type's lifecycle
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subState |
PF.Reference | ✔️ | The specific sub-state | non-null (The value is required.) |
objectType |
UUID | The type of object | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
LCY.LifecycleState
This is a structure data contract.
Describes a state in an object's lifecycle with all sub-states
Based on
- PF.Reference
- PF.VersionReference
- PF.VersionedReference
- PF.BasicObject
- PF.CustomizedObject
- LifecycleStateBase
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
properties |
array of PF.Property | ✔️ | A collection of dynamic properties belonging to the object | non-null;non-null (The array is required. Each element must not be null.) |
category |
LifecycleCategory | ✔️ | The category of state | |
decision |
boolean | ✔️ | true, if from workflow point of view, someone needs to decide which state comes next | |
sortIndex |
double | ✔️ | The index that defines the sorting of states | |
posX |
double? | ✔️ | The x position on the canvas for drawing the lifecycle | |
posY |
double? | ✔️ | The y position on the canvas for drawing the lifecycle | |
radius |
double? | ✔️ | The radius for drawing the lifecycle | |
subStates |
array of LifecycleSubState | The sub-states of the state | null;non-null (The array is optional. Each element must not be null.) |
LCY.LifecycleStateBase
This is a structure data contract.
Describes a state in an object's lifecycle
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
properties |
array of PF.Property | ✔️ | A collection of dynamic properties belonging to the object | non-null;non-null (The array is required. Each element must not be null.) |
category |
LifecycleCategory | The category of state | ||
decision |
boolean | true, if from workflow point of view, someone needs to decide which state comes next | ||
sortIndex |
double | The index that defines the sorting of states | ||
posX |
double? | The x position on the canvas for drawing the lifecycle | ||
posY |
double? | The y position on the canvas for drawing the lifecycle | ||
radius |
double? | The radius for drawing the lifecycle |
LCY.LifecycleStateTranslated
This is a structure data contract.
Describes a state in an object's lifecycle with translations
Based on
- PF.Reference
- PF.VersionReference
- PF.VersionedReference
- PF.BasicObjectTranslated
- PF.CustomizedObjectTranslated
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | null;non-null (The array is optional. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | null;non-null (The array is optional. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
null;non-null (The array is optional. Each element must not be null.) |
properties |
array of PF.Property | ✔️ | A collection of dynamic properties belonging to the object | non-null;non-null (The array is required. Each element must not be null.) |
category |
LifecycleCategory | The category of state | ||
decision |
boolean | true, if from workflow point of view, someone needs to decide which state comes next | ||
sortIndex |
double | The index that defines the sorting of states | ||
posX |
double? | The x position on the canvas for drawing the lifecycle | ||
posY |
double? | The y position on the canvas for drawing the lifecycle | ||
radius |
double? | The radius for drawing the lifecycle |
LCY.LifecycleStateWithSubStateReference
This is a structure data contract.
A reference to a state with one specific sub-state in an object's lifecycle
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subState |
PF.Reference | The specific sub-state | non-null (The value is required.) |
LCY.LifecycleStateWithSubStateReferenceAndObjectId
This is a structure data contract.
Describes a state with one specific sub-state in an object's lifecycle with object ID reference
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subState |
PF.Reference | ✔️ | The specific sub-state | non-null (The value is required.) |
objectId |
UUID | The reference to the object ID | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
LCY.LifecycleSubState
This is a structure data contract.
Describes a sub-state in an object's lifecycle
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
LCY.LifecycleSubStateTranslated
This is a structure data contract.
Describes a sub-state in an object's lifecycle with translations
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | null;non-null (The array is optional. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | null;non-null (The array is optional. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
null;non-null (The array is optional. Each element must not be null.) |
sortIndex |
double | the sortIndex (lowest first) |
LCY.LifecycleTransition
This is a structure data contract.
Describes a transition in an object's lifecycle
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
properties |
array of PF.Property | ✔️ | A collection of dynamic properties belonging to the object | non-null;non-null (The array is required. Each element must not be null.) |
from |
LifecycleStateWithSubStateReference | The preceding lifecycle state | ||
to |
LifecycleStateWithSubStateReference | The succeeding lifecycle state |
LCY.LifecycleTransitionTranslated
This is a structure data contract.
Describes a transition in an object's lifecycle with translations
Based on
- PF.Reference
- PF.VersionReference
- PF.VersionedReference
- PF.BasicObjectTranslated
- PF.CustomizedObjectTranslated
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | null;non-null (The array is optional. Each element must not be null.) |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | null;non-null (The array is optional. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | value for HTML attribute image/@src, Examples: "/images/.../....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
null;non-null (The array is optional. Each element must not be null.) |
properties |
array of PF.Property | ✔️ | A collection of dynamic properties belonging to the object | non-null;non-null (The array is required. Each element must not be null.) |
from |
LifecycleStateWithSubStateReference | The preceding lifecycle state | non-null (The value is required.) |
|
to |
LifecycleStateWithSubStateReference | The succeeding lifecycle state | non-null (The value is required.) |
LCY.LifecycleUpgradeRemark
This is a structure data contract.
A remark to be stored with a lifecycle upgrade
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
remark |
string | A remark to be stored together with the upgrade entry |
LCY.ObjectReferencesInLifecycleState
This is a structure data contract.
Lifecycle states with corresponding objects
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subState |
PF.Reference | ✔️ | The specific sub-state | non-null (The value is required.) |
objects |
array of PF.Reference | The objects in the specific sub state | non-null;non-null (The array is required. Each element must not be null.) |
LCY.ReferenceArrayWithObjectId
This is a structure data contract.
An array of references with an object ID reference
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
objectId |
UUID | The reference to the object ID | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
refs |
array of PF.Reference | References array | null;non-null (The array is optional. Each element must not be null.) |