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": "506fa3e7-dd83-408e-868d-a5425c678e6b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "4df3a289-4b23-4f72-bf8a-27509246e8a6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b6b651a6-ea21-4ea8-a9d7-156feaf51b69",
"CreateDate": "2026-11-07T14:40:08.293746-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-07T14:40:08.293746-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-07T14:40:08.293746-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "c92b4e61-7a85-41c9-9da8-0ad58bfe6e0f",
"Section": {
"FormTypeSectionId": "b8a5d39a-d788-4cd3-bb81-dc3ac1ad2532",
"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": "0a9ab81e-29ea-4102-9cb4-857c2a4446e2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "970fecbf-1c06-49b1-a57e-f4513df5fcc5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f3ff8254-5c0e-4d54-a1c5-a9afef15f5f6",
"CreateDate": "2026-11-07T14:40:08.293746-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-07T14:40:08.293746-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ce285aec-35cc-411f-b308-ceb90b22c3bd",
"FieldId": "531d9acc-d3db-4d7c-85de-f94943478bbe",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ce285aec-35cc-411f-b308-ceb90b22c3bd",
"FieldId": "531d9acc-d3db-4d7c-85de-f94943478bbe",
"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": "c92b4e61-7a85-41c9-9da8-0ad58bfe6e0f",
"Section": {
"FormTypeSectionId": "b8a5d39a-d788-4cd3-bb81-dc3ac1ad2532",
"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": "0a9ab81e-29ea-4102-9cb4-857c2a4446e2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "970fecbf-1c06-49b1-a57e-f4513df5fcc5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f3ff8254-5c0e-4d54-a1c5-a9afef15f5f6",
"CreateDate": "2026-11-07T14:40:08.293746-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-07T14:40:08.293746-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ce285aec-35cc-411f-b308-ceb90b22c3bd",
"FieldId": "531d9acc-d3db-4d7c-85de-f94943478bbe",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ce285aec-35cc-411f-b308-ceb90b22c3bd",
"FieldId": "531d9acc-d3db-4d7c-85de-f94943478bbe",
"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": "9d1c848e-e004-4808-8c53-296ac572c9b4",
"CreateDate": "2026-11-07T14:40:08.293746-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-07T14:40:08.293746-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}