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": "c7539383-7da8-4fc0-bee2-73d41ee7094a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a5a4e461-1f30-449e-92ac-0c4143daf1e5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b241b79e-8ffb-4f65-86bc-bd1c647c26b8",
"CreateDate": "2026-08-17T13:51:51.4423928-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-17T13:51:51.4423928-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-17T13:51:51.4423928-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "80000431-e242-4634-baf4-de4df22fbb96",
"Section": {
"FormTypeSectionId": "b9c8979f-9065-445b-9708-281d20eb5e69",
"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": "412eb0b6-f619-46a8-90cd-743273d04864",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fe1936c8-8ee4-4910-9925-e2ab8dbf3782",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c1945704-c54f-4ad4-ac77-2d65437f0bd5",
"CreateDate": "2026-08-17T13:51:51.4423928-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-17T13:51:51.4423928-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "93702518-c8c5-4730-aac2-7d89e0b77ed7",
"FieldId": "ec681469-d0c3-4752-a8f9-f289006ab391",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "93702518-c8c5-4730-aac2-7d89e0b77ed7",
"FieldId": "ec681469-d0c3-4752-a8f9-f289006ab391",
"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": "80000431-e242-4634-baf4-de4df22fbb96",
"Section": {
"FormTypeSectionId": "b9c8979f-9065-445b-9708-281d20eb5e69",
"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": "412eb0b6-f619-46a8-90cd-743273d04864",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fe1936c8-8ee4-4910-9925-e2ab8dbf3782",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c1945704-c54f-4ad4-ac77-2d65437f0bd5",
"CreateDate": "2026-08-17T13:51:51.4423928-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-17T13:51:51.4423928-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "93702518-c8c5-4730-aac2-7d89e0b77ed7",
"FieldId": "ec681469-d0c3-4752-a8f9-f289006ab391",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "93702518-c8c5-4730-aac2-7d89e0b77ed7",
"FieldId": "ec681469-d0c3-4752-a8f9-f289006ab391",
"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": "8290fce2-b067-4cb2-aa43-55c751e26bef",
"CreateDate": "2026-08-17T13:51:51.4423928-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-17T13:51:51.4423928-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}