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": "cc1f8826-33cd-4be7-9155-b2ac3a18ee89",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b68fa6c1-737c-425a-b462-df0a3d384915",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6a990a1b-15cf-41b1-b65d-1be53bdf55fb",
"CreateDate": "2025-11-29T12:45:02.5294542-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-29T12:45:02.5294542-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-29T12:45:02.5294542-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ea9cdbb4-c294-458f-ac86-cad11e8be9aa",
"Section": {
"FormTypeSectionId": "e4e2f51c-ab9f-413f-86e9-667d738fd9ea",
"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": "09464c73-42c7-4939-83a3-0d62dde4d4c7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6302f497-0160-41a4-88b4-1ddd362f1c73",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "53213e75-5989-4919-a2ee-e8a271c0e93e",
"CreateDate": "2025-11-29T12:45:02.5294542-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-29T12:45:02.5294542-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9e1c48e-4d1b-44aa-9bcf-ce26679565ba",
"FieldId": "82bf8cad-59c4-4a0b-a18c-b6a33676a0c5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9e1c48e-4d1b-44aa-9bcf-ce26679565ba",
"FieldId": "82bf8cad-59c4-4a0b-a18c-b6a33676a0c5",
"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": "ea9cdbb4-c294-458f-ac86-cad11e8be9aa",
"Section": {
"FormTypeSectionId": "e4e2f51c-ab9f-413f-86e9-667d738fd9ea",
"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": "09464c73-42c7-4939-83a3-0d62dde4d4c7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6302f497-0160-41a4-88b4-1ddd362f1c73",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "53213e75-5989-4919-a2ee-e8a271c0e93e",
"CreateDate": "2025-11-29T12:45:02.5294542-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-29T12:45:02.5294542-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9e1c48e-4d1b-44aa-9bcf-ce26679565ba",
"FieldId": "82bf8cad-59c4-4a0b-a18c-b6a33676a0c5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9e1c48e-4d1b-44aa-9bcf-ce26679565ba",
"FieldId": "82bf8cad-59c4-4a0b-a18c-b6a33676a0c5",
"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": "e2147074-6d93-4a3e-97d2-592db07e26fd",
"CreateDate": "2025-11-29T12:45:02.5294542-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-29T12:45:02.5294542-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}