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": "0710b46b-7bd1-4ec3-bb91-470c73d22493",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bcd2d65d-db1d-463d-9f5c-288518500d83",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c1c5355b-9430-4f5d-8502-934bf1743bc8",
"CreateDate": "2026-06-20T11:47:08.3228443-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-20T11:47:08.3228443-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-20T11:47:08.3228443-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "2db53696-4dfa-4a35-a580-2dcfee9a9781",
"Section": {
"FormTypeSectionId": "c036aa3d-6450-4749-8d26-32a9cc610b85",
"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": "1d1f3464-6c2b-4bb9-8c34-001ef7cf4870",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e0f1f9c7-076b-4759-9ef8-f733158d554d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cf584120-4be3-46af-a610-01bc183f1165",
"CreateDate": "2026-06-20T11:47:08.3228443-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T11:47:08.3228443-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c9ae5b57-8e28-459c-b2c5-b17623d63a1b",
"FieldId": "4b4bb627-38da-40e2-85ad-724d63a6db10",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c9ae5b57-8e28-459c-b2c5-b17623d63a1b",
"FieldId": "4b4bb627-38da-40e2-85ad-724d63a6db10",
"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": "2db53696-4dfa-4a35-a580-2dcfee9a9781",
"Section": {
"FormTypeSectionId": "c036aa3d-6450-4749-8d26-32a9cc610b85",
"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": "1d1f3464-6c2b-4bb9-8c34-001ef7cf4870",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e0f1f9c7-076b-4759-9ef8-f733158d554d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cf584120-4be3-46af-a610-01bc183f1165",
"CreateDate": "2026-06-20T11:47:08.3228443-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T11:47:08.3228443-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c9ae5b57-8e28-459c-b2c5-b17623d63a1b",
"FieldId": "4b4bb627-38da-40e2-85ad-724d63a6db10",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c9ae5b57-8e28-459c-b2c5-b17623d63a1b",
"FieldId": "4b4bb627-38da-40e2-85ad-724d63a6db10",
"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": "2dabb8c7-1b7a-4cc9-9cb5-1b43b8885727",
"CreateDate": "2026-06-20T11:47:08.3228443-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-20T11:47:08.3228443-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}