Create a Custom Form

post/customform.add

Creates a new Custom Form.

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

The typedId of the Custom Form Type.

label
required
string non-empty
userGroupEdit
string or null non-empty
operation
string non-empty
Responses
200

OK

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

The Type code is CFO.

Array of objects
Array
resultName
string
resultLabel
string
result
integer or null
excludeFromExport
boolean
warnings
Array of any or null
alertMessage
string or null
alertType
string or null
Possible values: "CRITICAL" "RED" "YELLOW"
displayOptions
integer or null
formatType
string
Possible values: "NUMERIC" "NUMERIC_LONG" "MONEY" "PERCENT" "TEXT" "MONEY_EUR" "MONEY_USD" "MONEY_GBP" "MONEY_JPY" "MONEY_CHF" "MONEY_PLN" "DATETIME" "DATE" "INTEGER" "LINK" "COMPLEX" "SPARKLINE"
suffix
string or null
resultType
string or null
cssProperties
string or null
userGroup
string or null
resultGroup
string or null
overrideValueOptions
Array of any or null
overrideAllowEmpty
boolean
labelTranslations
string or null
overridable
boolean
overridden
boolean
resultDescription
string or null
createdByName
string <= 255 characters
typedId
string or null
Array of objects
Array
name
string
label
string or null
lookupTableId
string or null
url
string or null
type
string
value
integer or null
valueHint
string or null
readOnly
boolean or null
object or null
parameterGroup
string or null
required
boolean or null
labelTranslations
string or null
addUnknownValues
boolean or null
typedId
string or null
alwaysEditable
boolean or null
inputs
Array of objects
object
object
valueOptions
Array of strings or null
workflowStatus
string <= 255 characters
Possible values: "DRAFT" "SUBMITTED" "DENIED" "APPROVED" "NO_APPROVAL_REQUIRED" "WITHDRAWN" "INVALIDATED"
lastUpdateDate
string
Array of objects
Array
key
string
message
string
source
string
object or null
version
integer
typedId
string or null
uniqueName
string
label
string
headerFormulaName
string
workflowFormulaName
string
userGroupEdit
string or null
userGroupViewDetails
string
embedded
boolean
supportedParentTypeCodes
Array of strings
module
string
Possible values: "PRICESETTING" "QUOTING" "ANALYTICS" "ADMIN" "WORKFLOW" "REBATES" "AGREEMENTSPROMOTIONS" "OPTIMIZATION" "CHANNELMANAGEMENT" "MASTERDATA" "CONFIGURATION" "DASHBOARDS" "DEALPLANNING" "PROCESSES" "SALESCOMPENSATION" "CUSTOM_FORM" "ACTIONABLEINSIGHTS"
moduleCategoryUN
string or null
configuration
object
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
deniedByName
string or null <= 255 characters
userGroupViewDetails
string or null <= 255 characters
approvedByName
string or null <= 255 characters
results
any

any type

originUniqueName
string

The unique name of the origin CFO.

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

Indicates the deletion status of the origin CFO.

moduleCategoryUN
string or null
version
integer
originCustomFormId
integer

Stores the identifier of the original CFO from which the current CFO was duplicated.

attribute9
string <= 255 characters

any type or null

attribute8
string <= 255 characters

any type or null

uniqueName
string or null <= 255 characters
attribute5
string <= 255 characters

any type or null

attribute4
string <= 255 characters

any type or null

attribute7
string <= 255 characters

any type or null

attribute6
string <= 255 characters

any type or null

attribute1
string <= 255 characters

any type or null

attribute14
string <= 255 characters

any type or null

formStatus
string <= 255 characters
Possible values: "DRAFT" "APPROVED" "REVOKED" "SUPERSEDED" "INVALIDATED"
attribute13
string <= 255 characters

any type or null

typeId
integer
userGroupEdit
string or null <= 255 characters
attribute3
string <= 255 characters

any type or null

attribute12
string <= 255 characters

any type or null

attribute2
string <= 255 characters

any type or null

attribute11
string <= 255 characters

any type or null

attribute10
string <= 255 characters

any type or null

lastUpdateByName
string <= 255 characters
object or null
property name*
additional property
object or null
attribute19
string <= 255 characters

any type or null

attribute18
string <= 255 characters

any type or null

attribute17
string <= 255 characters

any type or null

attribute16
string <= 255 characters

any type or null

attribute15
string <= 255 characters

any type or null

submitDate
string or null
parentTypedId
string or null <= 255 characters
attribute25
string <= 255 characters

any type or null

submittedByName
string or null <= 255 characters
attribute24
string <= 255 characters

any type or null

attribute23
string <= 255 characters

any type or null

attribute22
string <= 255 characters

any type or null

attribute21
string <= 255 characters

any type or null

attribute20
string <= 255 characters

any type or null

createDate
string or null
approvalRequiredEmailAttachments
Array of objects or null
attribute29
string <= 255 characters

any type or null

attribute28
string <= 255 characters

any type or null

originLabel
string
attribute27
string <= 255 characters

any type or null

attribute26
string <= 255 characters

any type or null

label
string <= 255 characters
nextRevUNs
Array of strings
createdBy
integer
prevRev
string or null
calculationStatus
integer
supersededBy
string or null
attribute30
string <= 255 characters

any type or null

lastUpdateBy
integer
status
number
Request samples
application/json
{
  • "data": {
    • "typedId": "7.CFOT",
    • "label": "The Form",
    • "userGroupEdit": "Administrators,PricingManagers"
    },
  • "operation": "add"
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": {
      • "outputs": [
        • {
          }
        ],
      • "createdByName": "string",
      • "typedId": "string",
      • "inputs": [
        • {
          }
        ],
      • "workflowStatus": "DRAFT",
      • "lastUpdateDate": "string",
      • "serverMessagesExtended": [
        • {
          }
        ],
      • "customFormTypeObject": {
        • "version": 0,
        • "typedId": "string",
        • "uniqueName": "string",
        • "label": "string",
        • "headerFormulaName": "string",
        • "workflowFormulaName": "string",
        • "userGroupEdit": "string",
        • "userGroupViewDetails": "string",
        • "embedded": true,
        • "supportedParentTypeCodes": [
          ],
        • "module": "QUOTING",
        • "configuration": { },
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateDate": "string",
        • "lastUpdateBy": 0
        },
      • "deniedByName": "string",
      • "userGroupViewDetails": "string",
      • "approvedByName": "string",
      • "results": { },
      • "module": "QUOTING",
      • "version": 0,
      • "attribute9": "string",
      • "attribute8": "string",
      • "uniqueName": "string",
      • "attribute5": "string",
      • "attribute4": "string",
      • "attribute7": "string",
      • "attribute6": "string",
      • "attribute1": "string",
      • "attribute14": "string",
      • "formStatus": "DRAFT",
      • "attribute13": "string",
      • "typeId": 0,
      • "userGroupEdit": "string",
      • "attribute3": "string",
      • "attribute12": "string",
      • "attribute2": "string",
      • "attribute11": "string",
      • "attribute10": "string",
      • "lastUpdateByName": "string",
      • "attribute19": "string",
      • "attribute18": "string",
      • "attribute17": "string",
      • "attribute16": "string",
      • "attribute15": "string",
      • "submitDate": "string",
      • "parentTypedId": "string",
      • "attribute25": "string",
      • "submittedByName": "string",
      • "attribute24": "string",
      • "attribute23": "string",
      • "attribute22": "string",
      • "attribute21": "string",
      • "attribute20": "string",
      • "createDate": "string",
      • "approvalRequiredEmailAttachments": [
        • { }
        ],
      • "attribute29": "string",
      • "attribute28": "string",
      • "attribute27": "string",
      • "attribute26": "string",
      • "label": "string",
      • "createdBy": 0,
      • "calculationStatus": 0,
      • "attribute30": "string",
      • "lastUpdateBy": 0
      },
    • "status": 0
    }
}