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": "82b7a275-bd6e-42ae-8f65-a44dcf6d16b7",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e12315de-dbf8-42fe-9540-808ebaefb392",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8d3042df-892e-48f7-8999-66d998356ee6",
"CreateDate": "2025-12-09T14:55:16.685794-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-09T14:55:16.685794-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-09T14:55:16.685794-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "70b25d2d-77a8-4d5f-ad92-02122b69a712",
"Section": {
"FormTypeSectionId": "aa32b999-06ba-4d5b-a4aa-7f07a50fe4a4",
"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": "057e3053-3ac9-4a63-984d-1fab6bdc13f2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2faf3d87-8fe1-4791-9f5c-d741b1473c55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d9514f0b-203b-40cc-9947-a340f30926c2",
"CreateDate": "2025-12-09T14:55:16.685794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-09T14:55:16.685794-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c3e9d19f-ad95-4756-a066-986c135c4a3f",
"FieldId": "6f76b3c6-d805-4cb6-b42b-ff73ac803ec6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c3e9d19f-ad95-4756-a066-986c135c4a3f",
"FieldId": "6f76b3c6-d805-4cb6-b42b-ff73ac803ec6",
"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": "70b25d2d-77a8-4d5f-ad92-02122b69a712",
"Section": {
"FormTypeSectionId": "aa32b999-06ba-4d5b-a4aa-7f07a50fe4a4",
"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": "057e3053-3ac9-4a63-984d-1fab6bdc13f2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2faf3d87-8fe1-4791-9f5c-d741b1473c55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d9514f0b-203b-40cc-9947-a340f30926c2",
"CreateDate": "2025-12-09T14:55:16.685794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-09T14:55:16.685794-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c3e9d19f-ad95-4756-a066-986c135c4a3f",
"FieldId": "6f76b3c6-d805-4cb6-b42b-ff73ac803ec6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c3e9d19f-ad95-4756-a066-986c135c4a3f",
"FieldId": "6f76b3c6-d805-4cb6-b42b-ff73ac803ec6",
"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": "560b4466-9a9c-4a91-a267-800d9c8917e7",
"CreateDate": "2025-12-09T14:55:16.685794-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-09T14:55:16.685794-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}