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": "0d9b669f-cb36-43a7-a395-f1c4a8701648",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "7ad7ed0e-6d7f-4fc1-bfc5-266f27a5d237",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2ba347a5-aeca-49db-8ee6-935e51e9969c",
"CreateDate": "2026-02-14T19:01:19.8520306-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-14T19:01:19.8520306-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-14T19:01:19.8520306-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "b9962fda-9050-4010-abe1-ae71f0a0ba47",
"Section": {
"FormTypeSectionId": "99297d87-6715-4b92-b48d-55939db2adae",
"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": "af1898c6-7a3d-4f5c-a067-9777b20169c0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b2fd3aea-d84a-43e1-9669-e8fee5730712",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "45328c47-33fa-4863-9e50-5445089c45dc",
"CreateDate": "2026-02-14T19:01:19.8520306-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-14T19:01:19.8520306-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8af3955d-8f97-4e26-8fce-dca357224f11",
"FieldId": "8b94c122-4ec2-47aa-bc16-9032ce564f84",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8af3955d-8f97-4e26-8fce-dca357224f11",
"FieldId": "8b94c122-4ec2-47aa-bc16-9032ce564f84",
"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": "b9962fda-9050-4010-abe1-ae71f0a0ba47",
"Section": {
"FormTypeSectionId": "99297d87-6715-4b92-b48d-55939db2adae",
"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": "af1898c6-7a3d-4f5c-a067-9777b20169c0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b2fd3aea-d84a-43e1-9669-e8fee5730712",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "45328c47-33fa-4863-9e50-5445089c45dc",
"CreateDate": "2026-02-14T19:01:19.8520306-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-14T19:01:19.8520306-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8af3955d-8f97-4e26-8fce-dca357224f11",
"FieldId": "8b94c122-4ec2-47aa-bc16-9032ce564f84",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8af3955d-8f97-4e26-8fce-dca357224f11",
"FieldId": "8b94c122-4ec2-47aa-bc16-9032ce564f84",
"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": "c63c60e0-8dbf-4ccb-b7ee-f93b375cb92b",
"CreateDate": "2026-02-14T19:01:19.8520306-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-14T19:01:19.8520306-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}