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": "57d2fdfe-099f-46e1-a87c-eb591802c5aa",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6411448f-22f4-4f99-b2d3-dd1c0b63ce49",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "242953a8-32f0-47c0-b2f6-684657ee2431",
"CreateDate": "2026-09-08T00:42:11.1447793-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-08T00:42:11.1447793-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-08T00:42:11.1447793-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "807f1afb-4a7a-4533-9ab7-11a954391842",
"Section": {
"FormTypeSectionId": "b5c54a5c-9f64-430f-a0e7-c25ba3d71799",
"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": "204d05bb-a168-4b95-8d12-832079165bf9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "34da8d88-67a6-4114-be65-78b08022c9cf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "469a02a0-d33b-4807-91b0-8c9e99584f3b",
"CreateDate": "2026-09-08T00:42:11.1447793-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-08T00:42:11.1447793-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "df1f831f-ba1d-4c0a-b261-4658a756adcb",
"FieldId": "f5ff2968-442f-4653-8cdf-439ec7d76fe8",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "df1f831f-ba1d-4c0a-b261-4658a756adcb",
"FieldId": "f5ff2968-442f-4653-8cdf-439ec7d76fe8",
"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": "807f1afb-4a7a-4533-9ab7-11a954391842",
"Section": {
"FormTypeSectionId": "b5c54a5c-9f64-430f-a0e7-c25ba3d71799",
"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": "204d05bb-a168-4b95-8d12-832079165bf9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "34da8d88-67a6-4114-be65-78b08022c9cf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "469a02a0-d33b-4807-91b0-8c9e99584f3b",
"CreateDate": "2026-09-08T00:42:11.1447793-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-08T00:42:11.1447793-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "df1f831f-ba1d-4c0a-b261-4658a756adcb",
"FieldId": "f5ff2968-442f-4653-8cdf-439ec7d76fe8",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "df1f831f-ba1d-4c0a-b261-4658a756adcb",
"FieldId": "f5ff2968-442f-4653-8cdf-439ec7d76fe8",
"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": "08031e71-adcd-4c45-adb3-0e85a0734d97",
"CreateDate": "2026-09-08T00:42:11.1447793-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-08T00:42:11.1447793-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}