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": "478dd957-0a04-4ac9-8beb-7c29ecd5d5f5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "eaba6e8d-07a2-44d2-b926-9f088e27aba5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "853b31c5-dd3e-4ce4-8938-0e85333eae46",
"CreateDate": "2026-06-11T05:23:45.6844533-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-11T05:23:45.6844533-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-11T05:23:45.6844533-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "54a0a822-58c8-4f91-9b2a-9ec06c89bf14",
"Section": {
"FormTypeSectionId": "03ff6979-8838-4193-93c0-7e504a9df63d",
"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": "c03cffa4-8e7c-45d7-a488-3899191ec4f0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "811120a9-1364-42f6-97bb-8332e2a60f16",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4c01d462-2c09-4ce8-881f-59b9a0721230",
"CreateDate": "2026-06-11T05:23:45.6844533-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-11T05:23:45.6844533-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6fa4db9b-0e6c-4234-90be-49bb3e9de01d",
"FieldId": "6c6b68b3-4c08-4e8c-83b2-c2f3f25c5ac7",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6fa4db9b-0e6c-4234-90be-49bb3e9de01d",
"FieldId": "6c6b68b3-4c08-4e8c-83b2-c2f3f25c5ac7",
"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": "54a0a822-58c8-4f91-9b2a-9ec06c89bf14",
"Section": {
"FormTypeSectionId": "03ff6979-8838-4193-93c0-7e504a9df63d",
"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": "c03cffa4-8e7c-45d7-a488-3899191ec4f0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "811120a9-1364-42f6-97bb-8332e2a60f16",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4c01d462-2c09-4ce8-881f-59b9a0721230",
"CreateDate": "2026-06-11T05:23:45.6844533-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-11T05:23:45.6844533-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6fa4db9b-0e6c-4234-90be-49bb3e9de01d",
"FieldId": "6c6b68b3-4c08-4e8c-83b2-c2f3f25c5ac7",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6fa4db9b-0e6c-4234-90be-49bb3e9de01d",
"FieldId": "6c6b68b3-4c08-4e8c-83b2-c2f3f25c5ac7",
"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": "861551e4-90de-4f3c-be5b-64896792e936",
"CreateDate": "2026-06-11T05:23:45.6844533-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-11T05:23:45.6844533-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}