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": "3fcd9f00-36d9-4fab-b8ce-ad7b273de6e9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2d89335f-7884-430a-be4a-69248b03a83a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "00b162a9-6775-43c7-a1c6-b3229590a83f",
"CreateDate": "2026-07-02T21:00:18.5073133-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-02T21:00:18.5073133-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-02T21:00:18.5073133-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "9c1a00c2-0d69-4cd4-820b-ae8f9d88d030",
"Section": {
"FormTypeSectionId": "f842481a-43d7-4d02-a99e-feec949caaec",
"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": "c302bc45-0f38-4cdf-b72e-621b0d9073bf",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ad8e79d7-26a8-4164-9e66-6674e63acd90",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3f0c5b8c-dd1a-41e6-a1f0-dd433e742471",
"CreateDate": "2026-07-02T21:00:18.5073133-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-02T21:00:18.5073133-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "af319a23-f804-4728-a3b1-9df94b5060bd",
"FieldId": "29de7e9f-2ee2-45e2-bae0-3564fce292d1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "af319a23-f804-4728-a3b1-9df94b5060bd",
"FieldId": "29de7e9f-2ee2-45e2-bae0-3564fce292d1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "9c1a00c2-0d69-4cd4-820b-ae8f9d88d030",
"Section": {
"FormTypeSectionId": "f842481a-43d7-4d02-a99e-feec949caaec",
"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": "c302bc45-0f38-4cdf-b72e-621b0d9073bf",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ad8e79d7-26a8-4164-9e66-6674e63acd90",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3f0c5b8c-dd1a-41e6-a1f0-dd433e742471",
"CreateDate": "2026-07-02T21:00:18.5073133-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-02T21:00:18.5073133-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "af319a23-f804-4728-a3b1-9df94b5060bd",
"FieldId": "29de7e9f-2ee2-45e2-bae0-3564fce292d1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "af319a23-f804-4728-a3b1-9df94b5060bd",
"FieldId": "29de7e9f-2ee2-45e2-bae0-3564fce292d1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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 4",
"CompanyId": "9d96ca2f-fcf8-4e67-bd0d-4f00bfb3838b",
"CreateDate": "2026-07-02T21:00:18.5229322-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-02T21:00:18.5229322-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}