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": "cc4971ad-2426-418c-92e0-936ba40b4a59",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c0608283-c748-4e65-b15d-1a2da67d2207",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "914a0583-9118-4de2-bc6a-726458a3ee79",
"CreateDate": "2026-09-17T03:05:46.8748712-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-17T03:05:46.8748712-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-17T03:05:46.8748712-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "99898ace-4513-4753-a6d8-e431a73a65fa",
"Section": {
"FormTypeSectionId": "810fdd3c-c2dc-44e8-873b-3a6b922b696f",
"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": "11f4b8fb-5ff2-4319-8bb3-adcc05772c94",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7e177683-3bca-42ea-bbc1-73d853dfa908",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b4e03397-93b9-4e4d-89c4-8188c39d07b9",
"CreateDate": "2026-09-17T03:05:46.8748712-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-17T03:05:46.8748712-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c73b822a-158c-43f3-abeb-c45d9113e373",
"FieldId": "c6fa2f9d-d8c3-4202-addf-a2fb9de14937",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c73b822a-158c-43f3-abeb-c45d9113e373",
"FieldId": "c6fa2f9d-d8c3-4202-addf-a2fb9de14937",
"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": "99898ace-4513-4753-a6d8-e431a73a65fa",
"Section": {
"FormTypeSectionId": "810fdd3c-c2dc-44e8-873b-3a6b922b696f",
"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": "11f4b8fb-5ff2-4319-8bb3-adcc05772c94",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7e177683-3bca-42ea-bbc1-73d853dfa908",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b4e03397-93b9-4e4d-89c4-8188c39d07b9",
"CreateDate": "2026-09-17T03:05:46.8748712-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-17T03:05:46.8748712-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c73b822a-158c-43f3-abeb-c45d9113e373",
"FieldId": "c6fa2f9d-d8c3-4202-addf-a2fb9de14937",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c73b822a-158c-43f3-abeb-c45d9113e373",
"FieldId": "c6fa2f9d-d8c3-4202-addf-a2fb9de14937",
"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": "b1a33883-c054-40a4-8841-06dd778d376d",
"CreateDate": "2026-09-17T03:05:46.8748712-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-17T03:05:46.8748712-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}