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": "d1a64527-a974-4723-9479-9cacbdecfee2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0e1d3327-d547-4e9f-9c1b-07bd1052dacd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "eb246c76-7b0b-465c-a8a6-42b39cd6c1a0",
"CreateDate": "2025-12-05T06:13:39.1177376-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-05T06:13:39.1177376-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-05T06:13:39.1177376-08:00",
"Fields": [
{
"FormTypeFieldId": "4020a299-bf6a-4d79-ab14-067696f9762f",
"Section": {
"FormTypeSectionId": "a249f642-d43f-40cd-a7d0-ac713365cf2b",
"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": "ae58f6ed-fe78-4755-a216-8f5347ba969b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f677e8cf-545d-4e40-ac9e-538c21c99abd",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0c918b31-426a-44b4-a780-29e951d44d79",
"CreateDate": "2025-12-05T06:13:39.1177376-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-05T06:13:39.1177376-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": "4020a299-bf6a-4d79-ab14-067696f9762f",
"Section": {
"FormTypeSectionId": "a249f642-d43f-40cd-a7d0-ac713365cf2b",
"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": "ae58f6ed-fe78-4755-a216-8f5347ba969b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f677e8cf-545d-4e40-ac9e-538c21c99abd",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0c918b31-426a-44b4-a780-29e951d44d79",
"CreateDate": "2025-12-05T06:13:39.1177376-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-05T06:13:39.1177376-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": "dba653bd-769d-49ce-bef3-d702d1f9a856",
"CreateDate": "2025-12-05T06:13:39.1177376-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-05T06:13:39.1177376-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}