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": "e5d0a342-df44-4fe3-92cf-ed09ad6808cf",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "78aad57f-faa7-459b-b79c-91956d79a551",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "79543ccd-a591-45cf-8f0a-08a25a32ee78",
"CreateDate": "2026-06-23T16:02:42.6285236-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-23T16:02:42.6285236-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-23T16:02:42.6285236-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "43f032a5-4496-4b78-8c58-a84156e46c4d",
"Section": {
"FormTypeSectionId": "3b5774e3-0f79-4296-858e-2c20875f0bd1",
"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": "2ee32aa5-e513-4e75-b7b6-28ae1424a7a4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a75a973a-1c2a-4135-819b-643cf9199838",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c87a2193-6712-4624-8927-ac776401a528",
"CreateDate": "2026-06-23T16:02:42.6285236-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-23T16:02:42.6285236-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "726eb0e2-d2e5-4989-b92e-9a8b044ce513",
"FieldId": "06b871c4-2f14-4a78-a61e-d1e762d37eab",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "726eb0e2-d2e5-4989-b92e-9a8b044ce513",
"FieldId": "06b871c4-2f14-4a78-a61e-d1e762d37eab",
"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": "43f032a5-4496-4b78-8c58-a84156e46c4d",
"Section": {
"FormTypeSectionId": "3b5774e3-0f79-4296-858e-2c20875f0bd1",
"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": "2ee32aa5-e513-4e75-b7b6-28ae1424a7a4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a75a973a-1c2a-4135-819b-643cf9199838",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c87a2193-6712-4624-8927-ac776401a528",
"CreateDate": "2026-06-23T16:02:42.6285236-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-23T16:02:42.6285236-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "726eb0e2-d2e5-4989-b92e-9a8b044ce513",
"FieldId": "06b871c4-2f14-4a78-a61e-d1e762d37eab",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "726eb0e2-d2e5-4989-b92e-9a8b044ce513",
"FieldId": "06b871c4-2f14-4a78-a61e-d1e762d37eab",
"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": "5c5acb7e-873e-45e0-9f10-5205db9d14e9",
"CreateDate": "2026-06-23T16:02:42.6285236-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-23T16:02:42.6285236-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}