Form

This object contains the following attributes:

Field Name
Data Type
Description

id

string

A unique identifier for the form.

Example: FRM-1234-4567

revision

unit

Revision number (used for platform-level versioning).

name

string

A descriptive name for the form.

Example: User report

description

string

A description of the form.

Example: Form to support billing issues

status

string

The current state of the form. Allowed values:published or unpublished.

parameterGroups

object

orderedParameterGroup containing parameters of the form.

Example:

[
   {
     parameterGroup: {
      "id": "PGR-6790-8304-0001",   
      "title": "Parameters",
      "label": "Create agreement",
      "description": "When creating a new agreement with SoftwareOne, you have the option to establish a new Microsoft account or connect it to an existing account you already hold with Microsoft.",
    },
    displayOrder: 100
  }
]

account

object

The account that owns the form.

audit

object

A reference to the audit object.

Last updated

Was this helpful?