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": "8cc6713b-220b-4f51-aba5-13ea4db19ab7",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e8ee8e9c-8e07-4abe-ae37-afc41c0ec463",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c001d1c4-aa2b-44ea-9ec1-e819a1cfe0c6",
"CreateDate": "2026-04-12T18:54:04.8989421-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-12T18:54:04.8989421-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-12T18:54:04.8989421-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "00f8bbe2-c0bc-4f1e-b1ae-0832c47ab4c7",
"Section": {
"FormTypeSectionId": "df03a8fd-0995-44f3-9ea7-56dc8093d7fa",
"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": "355a7c6f-bd18-44a0-86de-e75476b46534",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "51227a10-fb00-4a7d-a4b7-979a98f5beda",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d8d15e01-d8a4-47fd-a24d-8a15f57b3132",
"CreateDate": "2026-04-12T18:54:04.8989421-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-12T18:54:04.8989421-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6e5d7d67-0e4c-4764-8c50-9e61033aec81",
"FieldId": "887ecfe6-cad9-4166-bef4-8fc827326157",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6e5d7d67-0e4c-4764-8c50-9e61033aec81",
"FieldId": "887ecfe6-cad9-4166-bef4-8fc827326157",
"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": "00f8bbe2-c0bc-4f1e-b1ae-0832c47ab4c7",
"Section": {
"FormTypeSectionId": "df03a8fd-0995-44f3-9ea7-56dc8093d7fa",
"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": "355a7c6f-bd18-44a0-86de-e75476b46534",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "51227a10-fb00-4a7d-a4b7-979a98f5beda",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d8d15e01-d8a4-47fd-a24d-8a15f57b3132",
"CreateDate": "2026-04-12T18:54:04.8989421-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-12T18:54:04.8989421-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6e5d7d67-0e4c-4764-8c50-9e61033aec81",
"FieldId": "887ecfe6-cad9-4166-bef4-8fc827326157",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6e5d7d67-0e4c-4764-8c50-9e61033aec81",
"FieldId": "887ecfe6-cad9-4166-bef4-8fc827326157",
"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": "a3d618e8-b3ff-419a-9e6d-3ebb3280567d",
"CreateDate": "2026-04-12T18:54:04.8989421-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-12T18:54:04.8989421-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}