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": "421016c0-191b-4f75-ba3d-8cdec311bab1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a952e036-ff93-4803-80a8-108ffac72f4e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0d653bc6-3003-446c-b405-19a05375c83a",
"CreateDate": "2025-12-02T11:28:00.6682573-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-02T11:28:00.6682573-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-02T11:28:00.6682573-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "097a319c-88f6-490a-9684-afee28baffdb",
"Section": {
"FormTypeSectionId": "a4f4265d-7238-4adb-a4c8-f7585a440ebe",
"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": "df89e1d5-cc60-4964-a48e-248c827ed7e3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b9b0f2bd-e74f-4ca9-9a70-24cfbad70aa9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e7acc2a8-619e-47d6-bcf9-bf2d1cf6be42",
"CreateDate": "2025-12-02T11:28:00.6682573-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-02T11:28:00.6682573-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ee5f2ae4-76eb-46a3-baf4-4090668c5120",
"FieldId": "6aafcf0a-0b81-40df-89d3-98a71d6b48cd",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ee5f2ae4-76eb-46a3-baf4-4090668c5120",
"FieldId": "6aafcf0a-0b81-40df-89d3-98a71d6b48cd",
"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": "097a319c-88f6-490a-9684-afee28baffdb",
"Section": {
"FormTypeSectionId": "a4f4265d-7238-4adb-a4c8-f7585a440ebe",
"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": "df89e1d5-cc60-4964-a48e-248c827ed7e3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b9b0f2bd-e74f-4ca9-9a70-24cfbad70aa9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e7acc2a8-619e-47d6-bcf9-bf2d1cf6be42",
"CreateDate": "2025-12-02T11:28:00.6682573-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-02T11:28:00.6682573-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ee5f2ae4-76eb-46a3-baf4-4090668c5120",
"FieldId": "6aafcf0a-0b81-40df-89d3-98a71d6b48cd",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ee5f2ae4-76eb-46a3-baf4-4090668c5120",
"FieldId": "6aafcf0a-0b81-40df-89d3-98a71d6b48cd",
"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": "40f67882-d7cc-4e9b-8be8-0f1f7fe4b99f",
"CreateDate": "2025-12-02T11:28:00.6682573-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-02T11:28:00.6682573-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}