For the complete documentation index, see llms.txt. This page is also available as Markdown.

Form

This object contains the following attributes:

Field
Type
Description

id

string, core

A unique identifier for the form.

Example: FRM-1234-4567

revision

unit, core

(Read-only) Represents the revision number (used for platform-level versioning).

name

string, core

A descriptive name for the form.

Example: User report

description

string, core

A description of the form.

Example: Form to support billing issues

status

string, core

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

parameterGroups

object

(Optional) Represents 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 can establish a new Microsoft account or connect an existing one."
    },
    displayOrder: 100
  }
]

account

object, core

The account that owns the form.

audit

object

(Read-only) Represents the audit object.

Last updated

Was this helpful?