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": "091f0152-acdf-4b4e-bf92-6685d5c5afb7",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "cb6d6eae-8446-4ef2-adf8-387438560130",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7b3b1c33-cda9-4db2-8b6a-7c2450d79cd5",
"CreateDate": "2026-06-05T11:10:36.2854863-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-05T11:10:36.2854863-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-05T11:10:36.2854863-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ebd12884-4ada-4095-98b4-a3caa8754771",
"Section": {
"FormTypeSectionId": "7fb04955-4601-49c9-9c3c-e4b5ba5d7e0e",
"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": "4c42e4ae-69c1-4c80-9ab9-5e3abe6e345c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6e518513-485c-42e6-9f43-c13542af2e2e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3b57b4de-f3c8-484b-9d68-fc1590bcd458",
"CreateDate": "2026-06-05T11:10:36.2854863-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-05T11:10:36.2854863-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5163c023-9001-46aa-82cc-d7662d776f16",
"FieldId": "d9937a95-5eca-449a-8077-c9e86e1504a7",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5163c023-9001-46aa-82cc-d7662d776f16",
"FieldId": "d9937a95-5eca-449a-8077-c9e86e1504a7",
"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": "ebd12884-4ada-4095-98b4-a3caa8754771",
"Section": {
"FormTypeSectionId": "7fb04955-4601-49c9-9c3c-e4b5ba5d7e0e",
"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": "4c42e4ae-69c1-4c80-9ab9-5e3abe6e345c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6e518513-485c-42e6-9f43-c13542af2e2e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3b57b4de-f3c8-484b-9d68-fc1590bcd458",
"CreateDate": "2026-06-05T11:10:36.2854863-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-05T11:10:36.2854863-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5163c023-9001-46aa-82cc-d7662d776f16",
"FieldId": "d9937a95-5eca-449a-8077-c9e86e1504a7",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5163c023-9001-46aa-82cc-d7662d776f16",
"FieldId": "d9937a95-5eca-449a-8077-c9e86e1504a7",
"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": "5ad4166a-83df-4713-baea-8f8414e78b83",
"CreateDate": "2026-06-05T11:10:36.2854863-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-05T11:10:36.2854863-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}