GET FormTypes?formTypeId={formTypeId}
Retrieves a form type by its Id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| formTypeId |
Id of the form type |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the form type.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | FormType |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"FormTypeId": "cb9543d5-81cb-4e11-b3a7-157ad8a6fbf4",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "dc990501-9689-4d96-a298-d73f0ebdb230",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e622df50-85e3-4017-a6ba-cda13eb938ac",
"CreateDate": "2026-01-21T04:27:52.9342648-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-21T04:27:52.9342648-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-21T04:27:52.9342648-08:00",
"Fields": [
{
"FormTypeFieldId": "e058288f-cdbd-452e-ac34-0f1d34db4b48",
"Section": {
"FormTypeSectionId": "685826a7-42eb-4adf-b7a6-0480d663ad65",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "a65ac192-0bfd-47c8-8259-759ceee81036",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ce23647c-f995-45c9-907f-feb8abc47b9c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3e0bbdc5-a626-49f7-a7df-00490bd2145a",
"CreateDate": "2026-01-21T04:27:52.9342648-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T04:27:52.9342648-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
},
{
"FormTypeFieldId": "e058288f-cdbd-452e-ac34-0f1d34db4b48",
"Section": {
"FormTypeSectionId": "685826a7-42eb-4adf-b7a6-0480d663ad65",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "a65ac192-0bfd-47c8-8259-759ceee81036",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ce23647c-f995-45c9-907f-feb8abc47b9c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3e0bbdc5-a626-49f7-a7df-00490bd2145a",
"CreateDate": "2026-01-21T04:27:52.9342648-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T04:27:52.9342648-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "8bb94433-dc44-48cb-a7fe-bebc6821b601",
"CreateDate": "2026-01-21T04:27:52.9342648-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T04:27:52.9342648-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}