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": "81b50a90-2d32-4945-9ba6-36824cb1145c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9ccddb90-b5e6-44a3-a6c0-43e5700aa242",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7d07a5ca-f0f1-4c58-8698-3f23ce78246e",
"CreateDate": "2026-08-09T23:41:34.7778848-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:41:34.7778848-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-09T23:41:34.7778848-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "2f6945e2-cccf-44d1-b3a8-cc8a0d0d17c5",
"Section": {
"FormTypeSectionId": "b371bda5-c9ea-4c80-9d84-b933c1bdd487",
"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": "6285f4f0-6300-4f6b-ac92-bbfcf459aa70",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f839d049-d8bd-48ef-8e04-52ed26fe21fa",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c557958b-7362-4a5f-b182-12264625f3fe",
"CreateDate": "2026-08-09T23:41:34.7778848-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:34.7778848-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9d04bba6-1819-4609-ad65-284fd809fabd",
"FieldId": "272ad192-735b-4819-8f1a-d6b18c53272c",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9d04bba6-1819-4609-ad65-284fd809fabd",
"FieldId": "272ad192-735b-4819-8f1a-d6b18c53272c",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "2f6945e2-cccf-44d1-b3a8-cc8a0d0d17c5",
"Section": {
"FormTypeSectionId": "b371bda5-c9ea-4c80-9d84-b933c1bdd487",
"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": "6285f4f0-6300-4f6b-ac92-bbfcf459aa70",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f839d049-d8bd-48ef-8e04-52ed26fe21fa",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c557958b-7362-4a5f-b182-12264625f3fe",
"CreateDate": "2026-08-09T23:41:34.7778848-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:34.7778848-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9d04bba6-1819-4609-ad65-284fd809fabd",
"FieldId": "272ad192-735b-4819-8f1a-d6b18c53272c",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9d04bba6-1819-4609-ad65-284fd809fabd",
"FieldId": "272ad192-735b-4819-8f1a-d6b18c53272c",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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 4",
"CompanyId": "2b4c9789-5d25-4d6e-baa4-c4e591ed0249",
"CreateDate": "2026-08-09T23:41:34.7778848-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:41:34.7778848-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}