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": "abd24463-b3b3-421d-a76a-cec4c1bee0c6",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "84005aa3-5895-4ac0-a270-11a3b4dacade",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8b28b1f4-7e07-4a10-8c18-08f87de0bf6c",
"CreateDate": "2026-06-25T14:25:51.0390543-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T14:25:51.0390543-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-25T14:25:51.0390543-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "29694e11-a0d1-4553-aa6e-5c9d1e55e718",
"Section": {
"FormTypeSectionId": "f543eadc-7303-4e56-b46f-3b57942aebe2",
"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": "cd4183e7-492f-4108-833b-35fd5cfc5932",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "10adcfcf-89d9-4a25-8a2f-acc28f1670fe",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0b78938e-64c3-4ce3-8fc5-22052eb372f6",
"CreateDate": "2026-06-25T14:25:51.0390543-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:25:51.0390543-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ed98695d-4386-45fd-9a98-0b222572d467",
"FieldId": "cafbd06f-8653-412b-9170-1c7b3fc8e1bc",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ed98695d-4386-45fd-9a98-0b222572d467",
"FieldId": "cafbd06f-8653-412b-9170-1c7b3fc8e1bc",
"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": "29694e11-a0d1-4553-aa6e-5c9d1e55e718",
"Section": {
"FormTypeSectionId": "f543eadc-7303-4e56-b46f-3b57942aebe2",
"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": "cd4183e7-492f-4108-833b-35fd5cfc5932",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "10adcfcf-89d9-4a25-8a2f-acc28f1670fe",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0b78938e-64c3-4ce3-8fc5-22052eb372f6",
"CreateDate": "2026-06-25T14:25:51.0390543-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:25:51.0390543-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ed98695d-4386-45fd-9a98-0b222572d467",
"FieldId": "cafbd06f-8653-412b-9170-1c7b3fc8e1bc",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ed98695d-4386-45fd-9a98-0b222572d467",
"FieldId": "cafbd06f-8653-412b-9170-1c7b3fc8e1bc",
"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": "b2f56e80-7ab6-44fc-ae5b-a411ab298937",
"CreateDate": "2026-06-25T14:25:51.0390543-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T14:25:51.0390543-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}