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": "6f417edb-14ca-407f-8c1f-97fed1e53b3f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "98c91795-1dbe-41d8-ae46-0b7b5200b659",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3349929b-b3d0-44d0-9d1f-748d8de192ec",
"CreateDate": "2026-08-03T02:25:29.2301431-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-03T02:25:29.2301431-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-03T02:25:29.2301431-07:00",
"Fields": [
{
"FormTypeFieldId": "10f1578f-3f75-46e4-8e61-b96deab0e703",
"Section": {
"FormTypeSectionId": "4655530c-5d4b-4d5c-9377-b73f97abf280",
"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": "350d56c0-9cd8-4406-849f-19509fdab072",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "14055c8a-1a67-4a4e-aea8-5c47bffcb935",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7735a2f7-32d3-407e-925d-317c38821642",
"CreateDate": "2026-08-03T02:25:29.2301431-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:25:29.2301431-07: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": "10f1578f-3f75-46e4-8e61-b96deab0e703",
"Section": {
"FormTypeSectionId": "4655530c-5d4b-4d5c-9377-b73f97abf280",
"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": "350d56c0-9cd8-4406-849f-19509fdab072",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "14055c8a-1a67-4a4e-aea8-5c47bffcb935",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7735a2f7-32d3-407e-925d-317c38821642",
"CreateDate": "2026-08-03T02:25:29.2301431-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:25:29.2301431-07: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": "685458cf-6581-4191-96cc-6215fe1e68ac",
"CreateDate": "2026-08-03T02:25:29.2301431-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:25:29.2301431-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}