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": "289fe1ef-3b24-4504-85f1-60d4d1771c66",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "cfaed6a1-0cd6-423a-9c71-2f5c53ef8c7e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d1b15921-6fdb-4685-a1d1-dacfd8ebc933",
"CreateDate": "2026-09-20T03:41:43.0613576-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-20T03:41:43.0613576-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-20T03:41:43.0613576-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "a5f7a660-fe4e-4c7e-b423-8c3f3d2091e1",
"Section": {
"FormTypeSectionId": "5822f955-bd92-427d-acd1-6495339d24d4",
"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": "cfd3cf24-fb3f-4d65-852b-6d97b41f1d56",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b9f71dba-bb7a-48b5-a2a6-774e43c72a03",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a6222e4e-b1f7-4447-8946-4bed84b71070",
"CreateDate": "2026-09-20T03:41:43.0613576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-20T03:41:43.0613576-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "72afe07e-e44f-4b5b-98db-e0b3a0b3f5da",
"FieldId": "3e5047da-1053-4123-acff-6f4cfa57b98b",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "72afe07e-e44f-4b5b-98db-e0b3a0b3f5da",
"FieldId": "3e5047da-1053-4123-acff-6f4cfa57b98b",
"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": "a5f7a660-fe4e-4c7e-b423-8c3f3d2091e1",
"Section": {
"FormTypeSectionId": "5822f955-bd92-427d-acd1-6495339d24d4",
"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": "cfd3cf24-fb3f-4d65-852b-6d97b41f1d56",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b9f71dba-bb7a-48b5-a2a6-774e43c72a03",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a6222e4e-b1f7-4447-8946-4bed84b71070",
"CreateDate": "2026-09-20T03:41:43.0613576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-20T03:41:43.0613576-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "72afe07e-e44f-4b5b-98db-e0b3a0b3f5da",
"FieldId": "3e5047da-1053-4123-acff-6f4cfa57b98b",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "72afe07e-e44f-4b5b-98db-e0b3a0b3f5da",
"FieldId": "3e5047da-1053-4123-acff-6f4cfa57b98b",
"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": "ccdc1ad9-6b18-4a9a-9e6f-971ea7ebfd1c",
"CreateDate": "2026-09-20T03:41:43.0613576-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-20T03:41:43.0613576-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}