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": "6cb699d3-a96f-412b-991e-7f6fb6fe29f2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "722131d3-eace-4b2c-84d8-7a0f74ed7b99",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f6f20dbf-af49-4e4a-a8f0-9d60d69704e6",
"CreateDate": "2025-11-15T02:19:18.3202463-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-15T02:19:18.3202463-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-15T02:19:18.3202463-08:00",
"Fields": [
{
"FormTypeFieldId": "42121f85-5372-4a33-b16c-b1309f101c5e",
"Section": {
"FormTypeSectionId": "9f383602-d0f4-4254-b7fc-37e8e54c8498",
"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": "8e158c6e-3782-4ba7-8cc0-27932c848506",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "de89bc1b-7f89-4033-acf0-ff7802d3ac6b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c2ace07e-730e-402b-85ad-5ddb598913ea",
"CreateDate": "2025-11-15T02:19:18.3202463-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-15T02:19:18.3202463-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": "42121f85-5372-4a33-b16c-b1309f101c5e",
"Section": {
"FormTypeSectionId": "9f383602-d0f4-4254-b7fc-37e8e54c8498",
"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": "8e158c6e-3782-4ba7-8cc0-27932c848506",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "de89bc1b-7f89-4033-acf0-ff7802d3ac6b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c2ace07e-730e-402b-85ad-5ddb598913ea",
"CreateDate": "2025-11-15T02:19:18.3202463-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-15T02:19:18.3202463-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": "a17e69b8-9b4b-480d-a327-1320a69ea0d7",
"CreateDate": "2025-11-15T02:19:18.3202463-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-15T02:19:18.3202463-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}