Delete a Custom Form Type

post/delete/CFOT

Deletes a Custom Form Type by typedId.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
required
object
typedId
required
string non-empty
Responses
200

OK

Response Schema: application/json
object
node
string non-empty
object (CustomFormType)

The Type code is CFOT.

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.

name
string

Text to describe the configuration.

layout
string

DynamicTabs can have several types of layout. Default is stepper for config with steps and tabs for only tabs.

Possible values: "auto" "stepper" "tabs" "menu" "wizard"
Array of objects (step)
Array of objects (tab)
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
number
Request samples
application/json
{
  • "data": {
    • "typedId": "10.CFOT"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": {
      • "typedId": "string",
      • "configuration": {
        • "name": "string",
        • "layout": "tabs",
        • "steps": [
          ],
        • "tabs": [
          ]
        },
      • "lastUpdateDate": "2019-08-24T14:15:22Z",
      • "module": "PRICESETTING",
      • "label": "string",
      • "version": 0,
      • "uniqueName": "string",
      • "supportedParentTypeCodes": [
        • "string"
        ],
      • "createdBy": 0,
      • "headerFormulaName": "string",
      • "userGroupEdit": "string",
      • "userGroupViewDetails": "string",
      • "embedded": true,
      • "workflowFormulaName": "string",
      • "createDate": "2019-08-24T14:15:22Z",
      • "lastUpdateBy": 0
      },
    • "status": 0
    }
}