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": "bc55c718-36d0-4b6c-9563-a9894a622017",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5ec1ace6-08bd-4b1a-b130-d2171af2e568",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6db2eb10-9feb-4575-ab46-84e6f7a11a62",
"CreateDate": "2026-10-24T15:36:19.0542146-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-24T15:36:19.0542146-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-24T15:36:19.0542146-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "e6f9bb11-6eb6-455f-a5dd-f200092c83fc",
"Section": {
"FormTypeSectionId": "ad7ecd17-21f1-4afa-9323-c52b870d92a6",
"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": "783fde0d-2c04-41cd-ae52-ef88e63f6cdb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9b291b35-3ae8-4fb7-8f6f-0aa8d6dc5199",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d6e6826b-3ab0-4e60-beea-d75c244bb025",
"CreateDate": "2026-10-24T15:36:19.0542146-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-24T15:36:19.0542146-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d5365442-2d41-46dd-a8d6-b684b174f961",
"FieldId": "91a7c0a6-5130-4e17-82b1-afc340f1e8ee",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d5365442-2d41-46dd-a8d6-b684b174f961",
"FieldId": "91a7c0a6-5130-4e17-82b1-afc340f1e8ee",
"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": "e6f9bb11-6eb6-455f-a5dd-f200092c83fc",
"Section": {
"FormTypeSectionId": "ad7ecd17-21f1-4afa-9323-c52b870d92a6",
"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": "783fde0d-2c04-41cd-ae52-ef88e63f6cdb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9b291b35-3ae8-4fb7-8f6f-0aa8d6dc5199",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d6e6826b-3ab0-4e60-beea-d75c244bb025",
"CreateDate": "2026-10-24T15:36:19.0542146-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-24T15:36:19.0542146-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d5365442-2d41-46dd-a8d6-b684b174f961",
"FieldId": "91a7c0a6-5130-4e17-82b1-afc340f1e8ee",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d5365442-2d41-46dd-a8d6-b684b174f961",
"FieldId": "91a7c0a6-5130-4e17-82b1-afc340f1e8ee",
"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": "faf6da9e-6881-45f0-b50d-53a90e05508c",
"CreateDate": "2026-10-24T15:36:19.0542146-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-24T15:36:19.0542146-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}