Create a Custom Form Revision

post/customform.createnewrevision/{typedId}

Creates a new revision of the specified existing Custom Form. The returned object contains attributes, inputs or outputs, and duplicated embedded objects, but does not contain attached documents, actions, notes, and messages.
Note: The revision can only be created from a standalone Custom Form. The status of the form (formStatus) must be APPROVED and the workflow status (workflowStatus) must be either APPROVED or NO_APPROVAL_REQUIRED.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
typedId
required
string

typedId of the Custom Form you want to create a revision from.

Request Body schema: application/json
object
Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects (CustomForm)
Array
Array of objects
createdByName
string <= 255 characters
typedId
string or null
Array of objects
workflowStatus
string <= 255 characters
Possible values: "DRAFT" "SUBMITTED" "DENIED" "APPROVED" "NO_APPROVAL_REQUIRED" "WITHDRAWN" "INVALIDATED"
lastUpdateDate
string
Array of objects
object or null
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
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
integer
Request samples
application/json
{ }
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-8bdb777df-dn9xf",
    • "data": [
      • {
        • "version": 17,
        • "typedId": "406.CFO",
        • "uniqueName": "CFO-390-REV-3",
        • "label": "JJ_02",
        • "parentTypedId": null,
        • "typeId": 41,
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "module": "QUOTING",
        • "results": null,
        • "inputs": [
          ],
        • "outputs": [
          ],
        • "calculationStatus": 0,
        • "submitDate": null,
        • "workflowStatus": "DRAFT",
        • "formStatus": "DRAFT",
        • "submittedByName": null,
        • "approvedByName": null,
        • "deniedByName": null,
        • "createdByName": "ondrej.tesar",
        • "lastUpdateByName": "ondrej.tesar",
        • "approvalRequiredEmailAttachments": [ ],
        • "renderInfo": null,
        • "serverMessagesExtended": [ ],
        • "createDate": "2023-03-02T10:40:50",
        • "createdBy": 2147490187,
        • "lastUpdateDate": "2023-03-02T10:40:50",
        • "lastUpdateBy": 2147490187,
        • "attribute1": "Approved No Approval Required CFO revision",
        • "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,
        • "customFormTypeObject": null,
        • "supersededBy": null,
        • "prevRev": "CFO-390-REV-2",
        • "rootUniqueName": "CFO-390"
        }
      ],
    • "status": 0
    }
}