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": "a27b4bf3-5a7b-4555-b245-4dfe5db9eded",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "913dd8cc-a058-4f0b-8a4a-054bd0400d4d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e829edd7-ed88-4832-9009-1b75aefdf13d",
"CreateDate": "2026-06-08T11:30:34.8183585-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-08T11:30:34.8183585-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-08T11:30:34.8183585-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "8ff9556c-8b0f-4716-90d0-9cb8dc59e35d",
"Section": {
"FormTypeSectionId": "9351d3c6-d95a-4f11-8090-6c98eb55414c",
"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": "169a6fe4-3c9a-4a1b-a02a-768f7e11fcdf",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "76b7482c-f430-48c4-9b03-ab4cdea66625",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9eba7ed4-796b-44fe-9059-8a3ac7256b17",
"CreateDate": "2026-06-08T11:30:34.8183585-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-08T11:30:34.8183585-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4b366509-4270-41b5-b0bb-fdcfeffba7d3",
"FieldId": "d66d939c-5288-4b31-8869-c439ecf28d5f",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4b366509-4270-41b5-b0bb-fdcfeffba7d3",
"FieldId": "d66d939c-5288-4b31-8869-c439ecf28d5f",
"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": "8ff9556c-8b0f-4716-90d0-9cb8dc59e35d",
"Section": {
"FormTypeSectionId": "9351d3c6-d95a-4f11-8090-6c98eb55414c",
"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": "169a6fe4-3c9a-4a1b-a02a-768f7e11fcdf",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "76b7482c-f430-48c4-9b03-ab4cdea66625",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9eba7ed4-796b-44fe-9059-8a3ac7256b17",
"CreateDate": "2026-06-08T11:30:34.8183585-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-08T11:30:34.8183585-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4b366509-4270-41b5-b0bb-fdcfeffba7d3",
"FieldId": "d66d939c-5288-4b31-8869-c439ecf28d5f",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4b366509-4270-41b5-b0bb-fdcfeffba7d3",
"FieldId": "d66d939c-5288-4b31-8869-c439ecf28d5f",
"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": "3a51cd91-6890-41f2-b7d1-afcefa320ef6",
"CreateDate": "2026-06-08T11:30:34.8183585-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-08T11:30:34.8183585-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}