# Parameter Definition

Extends to base Parameter object introduced in the Catalog.

<table><thead><tr><th width="153">Field Name</th><th width="207">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>A unique identifier for the parameter definition. </p><p>Example: HPD-1234-5678-9012</p></td></tr><tr><td><code>externalId</code></td><td>string</td><td><p>Optional external id. </p><p>Example: customer-address</p></td></tr><tr><td><code>revision</code></td><td>uint</td><td>Included to support new platform entity revisioning.</td></tr><tr><td><code>account</code></td><td>object</td><td>The <a href="../accounts-api/account"><code>account</code></a> that owns the parameter definition.</td></tr><tr><td><code>name</code></td><td>string</td><td><p>A descriptive name for the parameter. </p><p>Example: Customer address</p></td></tr><tr><td><code>type</code></td><td>string</td><td><p>The parameter data type. Allowed values are <code>singleLineText</code>, <code>multiLineText</code>, <code>checkbox</code>, <code>choice</code>, <code>heading</code>, <code>dropDown</code>, <code>email</code>, <code>dataObject</code>, or <code>date</code>. </p><p>Note that the available parameter type might differ depending on the scope of the parameter (Form/Case).</p></td></tr><tr><td><code>scope</code></td><td>string</td><td>Parameter scope. Allowed values are <code>form</code> or <code>case</code>.</td></tr><tr><td><code>phase</code></td><td>string</td><td>Parameter phase. Allowed values are <code>request</code> or <code>response</code>.</td></tr><tr><td><code>constraints</code></td><td>object</td><td>Parameter <a href="../catalog-api/parameter/constraints-object"><code>constraints</code></a>.</td></tr><tr><td><code>displayOrder</code></td><td>integer</td><td><p>Required for parameter of scope case. </p><p>Example: 100</p></td></tr><tr><td><code>statistics</code></td><td>object (<a href="#parameter-statistics-object">parameterStatistics</a>)</td><td><p>Statistics about the parameter. </p><p></p><p>Scope: Form</p><pre class="language-json" data-overflow="wrap" data-line-numbers data-full-width="true"><code class="lang-json">{
  groupsCount: 10,
  formsCount: 5
}
</code></pre><p>Scope: Case</p><pre class="language-json" data-overflow="wrap" data-line-numbers data-full-width="true"><code class="lang-json">{
  casesCount: 5
}
</code></pre></td></tr><tr><td><code>audit</code></td><td>object</td><td>A reference to the <a href="../common-api-objects/audit"><code>audit</code></a> object.</td></tr></tbody></table>

### Parameter Statistics object

<table><thead><tr><th width="180">Field Name</th><th width="148">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>groupsCount</code></td><td>integer</td><td><p>(readonly) The total count of parameter groups this parameter is linked to. Relevant for parameters of scope “form“ only. Won’t be returned for type “case”. </p><p>Example: 29</p></td></tr><tr><td><code>casesCount</code></td><td>integer</td><td><p>(readonly) The total count of cases this parameter is linked to. Relevant for parameters of scope “case“ only. Won’t be returned for type “form”. </p><p>Example: 29</p></td></tr><tr><td><code>formsCount</code></td><td>integer</td><td><p>(readonly) The total count of forms this parameter is indirectly linked to.</p><p>Relevant for parameters of scope “form“ only. Won’t be returned for type “case”.</p><p>Example: 29</p></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.platform.softwareone.com/developer-resources/rest-api/helpdesk-api/parameter-definition.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.