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": "31190fad-d941-4ee0-81ea-15e9d4e5e187",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "43325a6b-0a8d-44be-ad75-7ca66cdc01cf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "786323da-399c-4ac2-b626-502aed0d6bef",
"CreateDate": "2026-06-29T20:34:31.136929-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-29T20:34:31.136929-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-29T20:34:31.136929-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "63b7afb5-272d-4177-87ca-16661ca8ed2f",
"Section": {
"FormTypeSectionId": "ad2bc9e0-2f43-4f74-9113-0a6f82bbc938",
"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": "98e16fdf-ba3a-4c1f-a3b2-fe8adaab0ea8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "110fbaaa-2502-4fdb-b7a1-4e9b688185e0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "830b727c-29f5-484c-ad5f-efe0428ffe7e",
"CreateDate": "2026-06-29T20:34:31.136929-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-29T20:34:31.136929-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "07bbf275-bb0f-47d7-86eb-8cbb32bbd26b",
"FieldId": "b843e1a0-07f3-42ec-9929-3f4b0a49183c",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "07bbf275-bb0f-47d7-86eb-8cbb32bbd26b",
"FieldId": "b843e1a0-07f3-42ec-9929-3f4b0a49183c",
"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": "63b7afb5-272d-4177-87ca-16661ca8ed2f",
"Section": {
"FormTypeSectionId": "ad2bc9e0-2f43-4f74-9113-0a6f82bbc938",
"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": "98e16fdf-ba3a-4c1f-a3b2-fe8adaab0ea8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "110fbaaa-2502-4fdb-b7a1-4e9b688185e0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "830b727c-29f5-484c-ad5f-efe0428ffe7e",
"CreateDate": "2026-06-29T20:34:31.136929-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-29T20:34:31.136929-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "07bbf275-bb0f-47d7-86eb-8cbb32bbd26b",
"FieldId": "b843e1a0-07f3-42ec-9929-3f4b0a49183c",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "07bbf275-bb0f-47d7-86eb-8cbb32bbd26b",
"FieldId": "b843e1a0-07f3-42ec-9929-3f4b0a49183c",
"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": "4488f7e9-e92a-4843-80c5-294a8e4f7f8a",
"CreateDate": "2026-06-29T20:34:31.136929-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-29T20:34:31.136929-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}