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": "e723e8d0-8af9-43aa-9fb6-d21e1c0fc8b0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9082f29d-dd8d-42ba-b8a4-af6435453d80",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a184ea93-57f0-450e-af57-dd252f92074c",
"CreateDate": "2025-11-22T11:34:02.7909161-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-22T11:34:02.7909161-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-22T11:34:02.7909161-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "e4b7fa36-a1e7-4918-97a8-a65bd3aa8abb",
"Section": {
"FormTypeSectionId": "4fba805f-44cc-494a-9594-70da24a51c00",
"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": "2ecc14b7-fd9a-4120-995e-3724ededd435",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8bee28eb-614c-4816-8831-bc8c4cc3ca01",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e0d06b51-8368-482d-85d2-37152d96bb1a",
"CreateDate": "2025-11-22T11:34:02.7909161-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-22T11:34:02.7909161-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4f445c88-c764-4f69-809a-331b1e68acde",
"FieldId": "e80e2575-6ccd-4802-99bc-0981c3f27986",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4f445c88-c764-4f69-809a-331b1e68acde",
"FieldId": "e80e2575-6ccd-4802-99bc-0981c3f27986",
"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": "e4b7fa36-a1e7-4918-97a8-a65bd3aa8abb",
"Section": {
"FormTypeSectionId": "4fba805f-44cc-494a-9594-70da24a51c00",
"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": "2ecc14b7-fd9a-4120-995e-3724ededd435",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8bee28eb-614c-4816-8831-bc8c4cc3ca01",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e0d06b51-8368-482d-85d2-37152d96bb1a",
"CreateDate": "2025-11-22T11:34:02.7909161-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-22T11:34:02.7909161-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4f445c88-c764-4f69-809a-331b1e68acde",
"FieldId": "e80e2575-6ccd-4802-99bc-0981c3f27986",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4f445c88-c764-4f69-809a-331b1e68acde",
"FieldId": "e80e2575-6ccd-4802-99bc-0981c3f27986",
"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": "33ed71c0-87a2-43a9-9f63-da3111faa8cb",
"CreateDate": "2025-11-22T11:34:02.7909161-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-22T11:34:02.7909161-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}