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": "dd92a221-7266-4e42-a539-30482df0b181",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f9a92d7b-a355-4387-a6a2-a31617d986bf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2bb129d1-dbbb-49ed-a611-1c7dcefd216e",
"CreateDate": "2026-05-04T20:10:03.3496556-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T20:10:03.3496556-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-04T20:10:03.3496556-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "2e7c0578-c298-4702-8ca5-386399e9a517",
"Section": {
"FormTypeSectionId": "031e6203-41a7-4e7c-8fb7-b0a0e02ffd70",
"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": "b9553fae-51d5-4081-922b-e6e81404d72e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "eaf5ac3d-a9e9-4368-9833-f2badf6d9b0f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "37423757-be80-4239-aecd-511cac494c15",
"CreateDate": "2026-05-04T20:10:03.3496556-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T20:10:03.3496556-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4dc672dc-1a8f-41a1-9d29-3f97914789e1",
"FieldId": "ce39f649-81a4-4716-8473-ab7fa4450ddd",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4dc672dc-1a8f-41a1-9d29-3f97914789e1",
"FieldId": "ce39f649-81a4-4716-8473-ab7fa4450ddd",
"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": "2e7c0578-c298-4702-8ca5-386399e9a517",
"Section": {
"FormTypeSectionId": "031e6203-41a7-4e7c-8fb7-b0a0e02ffd70",
"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": "b9553fae-51d5-4081-922b-e6e81404d72e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "eaf5ac3d-a9e9-4368-9833-f2badf6d9b0f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "37423757-be80-4239-aecd-511cac494c15",
"CreateDate": "2026-05-04T20:10:03.3496556-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T20:10:03.3496556-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4dc672dc-1a8f-41a1-9d29-3f97914789e1",
"FieldId": "ce39f649-81a4-4716-8473-ab7fa4450ddd",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4dc672dc-1a8f-41a1-9d29-3f97914789e1",
"FieldId": "ce39f649-81a4-4716-8473-ab7fa4450ddd",
"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": "fbc9b6b5-7ad3-4792-bd98-dbee5800b3a5",
"CreateDate": "2026-05-04T20:10:03.3496556-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T20:10:03.3496556-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}