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": "f2bdf9d3-9b55-49f8-bc0c-11c1cb582b03",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "68711b23-3053-49c5-bbd3-cbd380041926",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e86ef934-a483-41e6-a27b-3eb841bc86e3",
"CreateDate": "2026-03-03T08:06:05.9746421-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-03T08:06:05.9746421-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-03T08:06:05.9746421-08:00",
"Fields": [
{
"FormTypeFieldId": "5532da24-5d8b-4bc4-87ba-169c08a00731",
"Section": {
"FormTypeSectionId": "d1ea843d-60a0-4277-a6d4-cc045779bcdc",
"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": "e1ac4c48-b6ed-4727-a2ae-dce40d90e33c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "239fa639-89a0-4477-9e3a-0dbabc4f1fa4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "84a569de-9d11-49ac-adc5-eba8acf4a059",
"CreateDate": "2026-03-03T08:06:05.9746421-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T08:06:05.9746421-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": "5532da24-5d8b-4bc4-87ba-169c08a00731",
"Section": {
"FormTypeSectionId": "d1ea843d-60a0-4277-a6d4-cc045779bcdc",
"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": "e1ac4c48-b6ed-4727-a2ae-dce40d90e33c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "239fa639-89a0-4477-9e3a-0dbabc4f1fa4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "84a569de-9d11-49ac-adc5-eba8acf4a059",
"CreateDate": "2026-03-03T08:06:05.9746421-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T08:06:05.9746421-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": "53242f79-b6ef-4417-92d9-5d9c23625cbf",
"CreateDate": "2026-03-03T08:06:05.9746421-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T08:06:05.9746421-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}