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": "717701a5-d228-45e0-96ff-1279020e9dae",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e545ac48-286a-43e3-8a1c-60db20ed0098",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "332ef931-28b0-4200-9db0-b394dcde0efe",
"CreateDate": "2026-05-04T12:32:00.283825-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T12:32:00.283825-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-04T12:32:00.283825-07:00",
"Fields": [
{
"FormTypeFieldId": "a25fb138-90a8-4fa4-9342-6a83181df807",
"Section": {
"FormTypeSectionId": "b562db7d-7fc6-4924-a3f4-0af21e809dec",
"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": "02841450-9950-4766-a271-a4141e5d91dd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "af7ba459-0ddd-4168-a0e4-37f4df61af56",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4cd55a9d-ef07-4fc4-8de3-530d6859b2b8",
"CreateDate": "2026-05-04T12:32:00.283825-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:32:00.283825-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": "a25fb138-90a8-4fa4-9342-6a83181df807",
"Section": {
"FormTypeSectionId": "b562db7d-7fc6-4924-a3f4-0af21e809dec",
"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": "02841450-9950-4766-a271-a4141e5d91dd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "af7ba459-0ddd-4168-a0e4-37f4df61af56",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4cd55a9d-ef07-4fc4-8de3-530d6859b2b8",
"CreateDate": "2026-05-04T12:32:00.283825-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:32:00.283825-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": "9e22add9-7c81-48b6-abc1-7d8ab1469b85",
"CreateDate": "2026-05-04T12:32:00.283825-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:32:00.283825-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}