Update a Condition Type

post/update/COCT

Updates a Condition Type in the Compensation Condition Types table. The version property must be provided within the oldValues.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
required
object
uniqueName
string
label
string
userGroupEdit
string
userGroupViewDetails
string
typedId
string
object
version
required
integer
typedId
string
uniqueName
string
label
string
userGroupEdit
string or null
userGroupViewDetails
string or null
formulaName
string or null
waterfallElement
string or null
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
operationType
string
textMatchStyle
string
Responses
200

OK

Response Schema: application/json
object (updateConditionTypeResponse)
node
string
Array of objects (CompensationConditionType)
Array
uniqueName
string <= 255 characters

A unique identifier name, given by an implementation engineer.

typedId
string
label
string <= 255 characters

A name of the Compensation Condition Type, visible to business users when selecting a type of new line on a Compensation Plan.

formulaName
string or null <= 255 characters

A compensation condition logic. This logic is used to calculate all following:

  • COLI – compensation line item – for draft / editable document

  • COLI – compensation line item – for approved/read-only document

  • COR – Compensation Record

waterfallElement
string or null <= 255 characters

Stands for a name of a waterfall element which will contain the compensation money amount calculated by this compensation condition type.

The actual usage of this setting is up to the implementation engineer who has to use this value then in another logic (e.g. in the Quote Line Item logic).

createDate
string <date-time>
createdBy
integer
lastUpdateDate
string <date-time>
lastUpdateBy
integer
userGroupEdit
string or null <= 255 characters
userGroupViewDetails
string or null <= 255 characters
version
integer
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
status
integer
Request samples
application/json
{
  • "data": {
    • "uniqueName": "test_updated",
    • "label": "test - updated",
    • "userGroupEdit": "Administrators",
    • "userGroupViewDetails": "PricingManagers",
    • "typedId": "18.COCT"
    },
  • "oldValues": {
    • "version": 2,
    • "typedId": "18.COCT",
    • "uniqueName": "test",
    • "label": "test",
    • "userGroupEdit": null,
    • "userGroupViewDetails": null,
    • "formulaName": null,
    • "waterfallElement": null,
    • "createDate": "2022-06-20T09:46:41",
    • "createdBy": 2147490696,
    • "lastUpdateDate": "2022-06-21T09:31:35",
    • "lastUpdateBy": 2147490696,
    • "attribute1": null,
    • "attribute2": null,
    • "attribute3": null,
    • "attribute4": null,
    • "attribute5": null,
    • "attribute6": null,
    • "attribute7": null,
    • "attribute8": null,
    • "attribute9": null,
    • "attribute10": null,
    • "attribute11": null,
    • "attribute12": null,
    • "attribute13": null,
    • "attribute14": null,
    • "attribute15": null,
    • "attribute16": null,
    • "attribute17": null,
    • "attribute18": null,
    • "attribute19": null,
    • "attribute20": null,
    • "attribute21": null,
    • "attribute22": null,
    • "attribute23": null,
    • "attribute24": null,
    • "attribute25": null,
    • "attribute26": null,
    • "attribute27": null,
    • "attribute28": null,
    • "attribute29": null,
    • "attribute30": null
    },
  • "operationType": "update",
  • "textMatchStyle": "exact"
}
Response samples
application/json
{
  • "response": {
    • "node": "node",
    • "data": [
      • {
        • "version": 3,
        • "typedId": "18.COCT",
        • "uniqueName": "test_updated",
        • "label": "test - updated",
        • "userGroupEdit": "Administrators",
        • "userGroupViewDetails": "PricingManagers",
        • "formulaName": null,
        • "waterfallElement": null,
        • "createDate": "2022-06-20T09:46:41",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2022-06-21T12:01:38",
        • "lastUpdateBy": 2147490696,
        • "attribute1": 2022,
        • "attribute2": null,
        • "attribute3": null,
        • "attribute4": null,
        • "attribute5": null,
        • "attribute6": null,
        • "attribute7": null,
        • "attribute8": null,
        • "attribute9": null,
        • "attribute10": null,
        • "attribute11": null,
        • "attribute12": null,
        • "attribute13": null,
        • "attribute14": null,
        • "attribute15": null,
        • "attribute16": null,
        • "attribute17": null,
        • "attribute18": null,
        • "attribute19": null,
        • "attribute20": null,
        • "attribute21": null,
        • "attribute22": null,
        • "attribute23": null,
        • "attribute24": null,
        • "attribute25": null,
        • "attribute26": null,
        • "attribute27": null,
        • "attribute28": null,
        • "attribute29": null,
        • "attribute30": null
        }
      ],
    • "status": 0
    }
}