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": "b4f82d1f-153d-4e97-867e-426f6b48df16",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2acb8e52-bcb4-412a-84cb-0f210848dd92",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "97b3d52b-8205-4d81-8b1e-9974d6e9c5d6",
"CreateDate": "2026-10-14T13:09:09.4256955-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-14T13:09:09.4256955-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-14T13:09:09.4256955-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "d76e3526-d322-487a-9ac5-18a13634cfba",
"Section": {
"FormTypeSectionId": "8a879196-71c0-4b6e-8e71-2135dc7598ca",
"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": "4007cf91-c5a9-4e19-ad7f-c205f9b67be9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "693c41a2-3bfc-4ef6-b85e-18a3dee8642f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "10f715dc-dfbb-414c-9811-a448e57fe0bd",
"CreateDate": "2026-10-14T13:09:09.4256955-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-14T13:09:09.4256955-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "14332567-dfc0-4d5b-892c-397cf7b69f1b",
"FieldId": "3bf9a4a4-2b97-4144-a0c4-3e6a4d1479ff",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "14332567-dfc0-4d5b-892c-397cf7b69f1b",
"FieldId": "3bf9a4a4-2b97-4144-a0c4-3e6a4d1479ff",
"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": "d76e3526-d322-487a-9ac5-18a13634cfba",
"Section": {
"FormTypeSectionId": "8a879196-71c0-4b6e-8e71-2135dc7598ca",
"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": "4007cf91-c5a9-4e19-ad7f-c205f9b67be9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "693c41a2-3bfc-4ef6-b85e-18a3dee8642f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "10f715dc-dfbb-414c-9811-a448e57fe0bd",
"CreateDate": "2026-10-14T13:09:09.4256955-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-14T13:09:09.4256955-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "14332567-dfc0-4d5b-892c-397cf7b69f1b",
"FieldId": "3bf9a4a4-2b97-4144-a0c4-3e6a4d1479ff",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "14332567-dfc0-4d5b-892c-397cf7b69f1b",
"FieldId": "3bf9a4a4-2b97-4144-a0c4-3e6a4d1479ff",
"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": "9cadb600-0491-45a1-8e41-c8498ddd658d",
"CreateDate": "2026-10-14T13:09:09.4256955-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-14T13:09:09.4256955-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}