Get a Custom Form

post/customform.fetch/{typedId}

Retrieves the Custom Form (specified by typedId), including all details.

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

The typedId of the Custom Form you want to retrieve details for.

Example: 123.CFO
Responses
200

OK

Response Schema: application/json
object
node
string non-empty
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
uniqueName
string non-empty
label
string non-empty
parentTypedId
any
typeId
number
userGroupEdit
any
userGroupViewDetails
any
module
any
results
any
Array of objects non-empty unique
Array of objects non-empty unique
calculationStatus
number
submitDate
any
workflowStatus
string non-empty
formStatus
string non-empty
submittedByName
any
approvedByName
any
deniedByName
any
createdByName
any
lastUpdateByName
any
approvalRequiredEmailAttachments
Array of objects
serverMessagesExtended
any
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
attribute1
any
attribute2
any
attribute3
any
attribute4
any
attribute5
any
attribute6
any
attribute7
any
attribute8
any
attribute9
any
attribute10
any
attribute11
any
attribute12
any
attribute13
any
attribute14
any
attribute15
any
attribute16
any
attribute17
any
attribute18
any
attribute19
any
attribute20
any
attribute21
any
attribute22
any
attribute23
any
attribute24
any
attribute25
any
attribute26
any
attribute27
any
attribute28
any
attribute29
any
attribute30
any
object
status
number
400

Invalid typedId specified in the path param.

404

Custom Form with the specified typedId was not found.

Request samples
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "uniqueName": "string",
        • "label": "string",
        • "parentTypedId": null,
        • "typeId": 0,
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "module": null,
        • "results": null,
        • "inputs": [
          ],
        • "outputs": [
          ],
        • "calculationStatus": 0,
        • "submitDate": null,
        • "workflowStatus": "string",
        • "formStatus": "string",
        • "submittedByName": null,
        • "approvedByName": null,
        • "deniedByName": null,
        • "createdByName": null,
        • "lastUpdateByName": null,
        • "approvalRequiredEmailAttachments": [
          ],
        • "serverMessagesExtended": null,
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateDate": "string",
        • "lastUpdateBy": 0,
        • "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,
        • "customFormTypeObject": {
          }
        }
      ],
    • "status": 0
    }
}