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": "880615eb-9953-4056-9063-150ff84c0916",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c4a99669-15b3-4b75-89ae-6500e699aecd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f24db809-3c70-4507-8521-2cca401339d2",
"CreateDate": "2026-04-28T22:49:18.5136654-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T22:49:18.5136654-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-28T22:49:18.5136654-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "11699ce3-10e7-4c2e-acb5-e0ab0d91153a",
"Section": {
"FormTypeSectionId": "f9ce3d30-9445-48f2-ad4d-1ba6751df22b",
"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": "09fa3236-ca3f-4fea-ba98-482ce36181b1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "63294b9e-7548-40d9-a12b-76dafb66aaf2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cbf07c48-cc8e-4886-8eb1-8d94771a756b",
"CreateDate": "2026-04-28T22:49:18.5136654-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T22:49:18.5136654-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "77ea48f4-2d1d-4761-9e17-f3d4b6eccdee",
"FieldId": "81f0f44b-35fb-4a08-9d1d-3a95a1b2e8ea",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "77ea48f4-2d1d-4761-9e17-f3d4b6eccdee",
"FieldId": "81f0f44b-35fb-4a08-9d1d-3a95a1b2e8ea",
"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": "11699ce3-10e7-4c2e-acb5-e0ab0d91153a",
"Section": {
"FormTypeSectionId": "f9ce3d30-9445-48f2-ad4d-1ba6751df22b",
"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": "09fa3236-ca3f-4fea-ba98-482ce36181b1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "63294b9e-7548-40d9-a12b-76dafb66aaf2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cbf07c48-cc8e-4886-8eb1-8d94771a756b",
"CreateDate": "2026-04-28T22:49:18.5136654-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T22:49:18.5136654-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "77ea48f4-2d1d-4761-9e17-f3d4b6eccdee",
"FieldId": "81f0f44b-35fb-4a08-9d1d-3a95a1b2e8ea",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "77ea48f4-2d1d-4761-9e17-f3d4b6eccdee",
"FieldId": "81f0f44b-35fb-4a08-9d1d-3a95a1b2e8ea",
"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": "142696fd-230e-4e38-93d3-4477e153ac52",
"CreateDate": "2026-04-28T22:49:18.5136654-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T22:49:18.5136654-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}