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": "23472b79-09a5-47ba-af67-33dfe0159179",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8c65a2b3-2103-4110-ac3e-246702ed19c4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1660849a-d73d-4a39-93fa-114d05f3d090",
"CreateDate": "2026-03-22T22:13:08.9874602-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-22T22:13:08.9874602-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-22T22:13:08.9874602-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "5e644ada-b161-4298-b4bb-9e5e98c6f9ae",
"Section": {
"FormTypeSectionId": "48d52d03-9e23-4576-998f-0a1631c28f49",
"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": "263ef9c9-964c-43ef-916f-eea0a4dd83d6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "786de498-507d-4c74-943f-5dee0724b574",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9a1bfe69-92c8-4e63-a8cc-04df90743323",
"CreateDate": "2026-03-22T22:13:08.9874602-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T22:13:08.9874602-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "1fecd749-6685-4681-8e0f-c41e66da868b",
"FieldId": "9c372981-394f-42e1-9ffa-0e5a2ad50d76",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "1fecd749-6685-4681-8e0f-c41e66da868b",
"FieldId": "9c372981-394f-42e1-9ffa-0e5a2ad50d76",
"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": "5e644ada-b161-4298-b4bb-9e5e98c6f9ae",
"Section": {
"FormTypeSectionId": "48d52d03-9e23-4576-998f-0a1631c28f49",
"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": "263ef9c9-964c-43ef-916f-eea0a4dd83d6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "786de498-507d-4c74-943f-5dee0724b574",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9a1bfe69-92c8-4e63-a8cc-04df90743323",
"CreateDate": "2026-03-22T22:13:08.9874602-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-22T22:13:08.9874602-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "1fecd749-6685-4681-8e0f-c41e66da868b",
"FieldId": "9c372981-394f-42e1-9ffa-0e5a2ad50d76",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "1fecd749-6685-4681-8e0f-c41e66da868b",
"FieldId": "9c372981-394f-42e1-9ffa-0e5a2ad50d76",
"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": "750cf2b5-4702-46a9-9c1e-ce986349b039",
"CreateDate": "2026-03-22T22:13:08.9874602-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-22T22:13:08.9874602-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}