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": "e7872e04-11f6-4439-8dac-e641dabd7d0d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1562716a-9f0a-47b5-a212-526e4130a95e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "239d017f-08cb-4d16-830c-b9de9694a911",
"CreateDate": "2026-04-14T09:13:32.7883405-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-14T09:13:32.7883405-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-14T09:13:32.7883405-07:00",
"Fields": [
{
"FormTypeFieldId": "3ce6a877-532d-4a1d-b9e9-e89931a61d22",
"Section": {
"FormTypeSectionId": "ea7efe50-faee-4f32-94ac-f173e1650c61",
"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": "4ac5c35a-192e-4bbd-a171-bebcbc2f208b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f3f341a3-9602-494a-8ae3-22877de568c2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "23565e6b-6626-4a72-8c84-0c620d0f1abe",
"CreateDate": "2026-04-14T09:13:32.7883405-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-14T09:13:32.7883405-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "3ce6a877-532d-4a1d-b9e9-e89931a61d22",
"Section": {
"FormTypeSectionId": "ea7efe50-faee-4f32-94ac-f173e1650c61",
"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": "4ac5c35a-192e-4bbd-a171-bebcbc2f208b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f3f341a3-9602-494a-8ae3-22877de568c2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "23565e6b-6626-4a72-8c84-0c620d0f1abe",
"CreateDate": "2026-04-14T09:13:32.7883405-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-14T09:13:32.7883405-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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 3",
"CompanyId": "87e69a3a-6175-4e20-bf68-6fb26e15e413",
"CreateDate": "2026-04-14T09:13:32.7883405-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-14T09:13:32.7883405-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}