Update a Custom Form Type

post/update/CFOT

Updates a Custom Form Type.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
object
version
integer
typedId
string
uniqueName
string
label
string
headerFormulaName
string
embedded
boolean
module
string
object
object
icon
string
name
string
object
translationKey
string
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
operationType
string
textMatchStyle
string
object
embedded
boolean
(object or null) or (string or null)
Any of:
object or null
(object or null) or (string or null)
Any of:
object or null
(Array of arrays or null or null) or (string or null)
Any of:
arrays or null or null
typedId
string
(string or null)
Any of:
string or null
Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects (CustomFormType)
Array
typedId
string
object (configuration)

Schema for definition of steps and tabs. This object can contains tabs array with tabs specifications or steps array (categories) with tabs inside.

lastUpdateDate
string <date-time>
module
string or null <= 255 characters

A name of application module, in which the user interface will show the menu item, which opens a page with a list of custom forms of this type. This is meaningful only when embedded is false.

Possible values: "PRICESETTING" "QUOTING" "ANALYTICS" "ADMIN" "WORKFLOW" "REBATES" "AGREEMENTSPROMOTIONS" "OPTIMIZATION" "CHANNELMANAGEMENT" "MASTERDATA" "CONFIGURATION" "DASHBOARDS" "DEALPLANNING" "PROCESSES" "SALESCOMPENSATION" "CUSTOM_FORM"
label
string <= 255 characters

The name of the type, as displayed to the end users.

version
integer
uniqueName
string <= 255 characters

A unique name of the type.

supportedParentTypeCodes
Array of strings or null or null

List of entities, which are allowed to embed this custom form type (Quote, Deal Plan, standalone Custom Form). This is meaningful only when embedded is true.

createdBy
integer
headerFormulaName
string <= 255 characters

A name of the logic which implements the functionality of the Custom Form.

userGroupEdit
string or null <= 255 characters
userGroupViewDetails
string or null <= 255 characters
embedded
boolean

If this custom form type can be embedded - i.e. used inside of another document, like quote.

workflowFormulaName
string or null <= 255 characters

A name of the workflow logic, which will be used to build approval workflow for this Custom Form.

createDate
string <date-time>
lastUpdateBy
integer
status
integer
Request samples
application/json
{
  • "oldValues": {
    • "version": 3,
    • "typedId": "7.CFOT",
    • "uniqueName": "CFOT",
    • "label": "MyCustomFormType",
    • "headerFormulaName": "cflogic",
    • "embedded": false,
    • "module": "QUOTING",
    • "configuration": {
      • "default": {
        • "icon": "compress-arrows",
        • "name": "default",
        • "tabs": {
          },
        • "translationKey": "common_default"
        }
      },
    • "createDate": "2022-05-20T15:02:00",
    • "createdBy": 2147490696,
    • "lastUpdateDate": "2022-05-23T10:18:46",
    • "lastUpdateBy": 2147490696
    },
  • "operationType": "update",
  • "textMatchStyle": "exact",
  • "data": {
    • "embedded": true,
    • "configuration": null,
    • "module": null,
    • "supportedParentTypeCodes": null,
    • "typedId": "7.CFOT",
    • "workflowFormulaName": null
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "node",
    • "data": [
      • {
        • "version": 4,
        • "typedId": "7.CFOT",
        • "uniqueName": "CFOT",
        • "label": "MyCustomFormType",
        • "headerFormulaName": "cflogic",
        • "workflowFormulaName": null,
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "embedded": true,
        • "supportedParentTypeCodes": null,
        • "module": "QUOTING",
        • "configuration": null,
        • "createDate": "2022-05-20T15:02:00",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2022-06-24T08:16:17",
        • "lastUpdateBy": 2147490696
        }
      ],
    • "status": 0
    }
}