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": "dba2650f-3215-4d9e-a206-70c97cdcf44a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1cda9c06-f859-4404-a7c2-2c0ec249e12b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "76428cbe-ebeb-4b08-a3cd-277b4eb9c597",
"CreateDate": "2026-02-11T01:23:17.6614902-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-11T01:23:17.6614902-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-11T01:23:17.6614902-08:00",
"Fields": [
{
"FormTypeFieldId": "c11f786f-1f33-45c8-b637-2a8545751302",
"Section": {
"FormTypeSectionId": "05e0405e-58ed-4503-b3af-a31a5bf25a43",
"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": "e954977e-a3f2-4453-b939-99d11154986c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b5f01aa3-cb04-4ec5-8ed1-78c3ac20f445",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "40aadd61-92f4-4861-b2ee-d5a99f8a81e5",
"CreateDate": "2026-02-11T01:23:17.6614902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-11T01:23:17.6614902-08: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": "c11f786f-1f33-45c8-b637-2a8545751302",
"Section": {
"FormTypeSectionId": "05e0405e-58ed-4503-b3af-a31a5bf25a43",
"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": "e954977e-a3f2-4453-b939-99d11154986c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b5f01aa3-cb04-4ec5-8ed1-78c3ac20f445",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "40aadd61-92f4-4861-b2ee-d5a99f8a81e5",
"CreateDate": "2026-02-11T01:23:17.6614902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-11T01:23:17.6614902-08: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": "375bdc5a-8376-4569-b37c-b6427c6d47e5",
"CreateDate": "2026-02-11T01:23:17.6614902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-11T01:23:17.6614902-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}