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": "91d4fed9-023a-4d24-be38-11bc12a49518",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "42ee86b6-58c1-4245-a228-da8003b4f830",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "08a99601-ddec-4296-9a43-51a46aff6f18",
"CreateDate": "2026-10-05T11:46:53.0448417-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-05T11:46:53.0448417-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-05T11:46:53.0448417-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "0abaa9bc-b1d9-4378-b7c8-5af8176561c6",
"Section": {
"FormTypeSectionId": "8688e04d-9014-4c97-85d8-9c91d998cd6d",
"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": "4e27b4a9-108f-4e8d-9cb5-7d98a25c9df0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ff1f0189-d0d0-4fa1-8a0b-f23b3e90d86c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1e769b48-94c0-4bbc-9c1b-c11ecd351d4d",
"CreateDate": "2026-10-05T11:46:53.0448417-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-05T11:46:53.0448417-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "98b3e1ad-8ada-4596-8e66-8a9e943cacd9",
"FieldId": "76e75359-badd-4466-babe-ca8f8ac60834",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "98b3e1ad-8ada-4596-8e66-8a9e943cacd9",
"FieldId": "76e75359-badd-4466-babe-ca8f8ac60834",
"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": "0abaa9bc-b1d9-4378-b7c8-5af8176561c6",
"Section": {
"FormTypeSectionId": "8688e04d-9014-4c97-85d8-9c91d998cd6d",
"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": "4e27b4a9-108f-4e8d-9cb5-7d98a25c9df0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ff1f0189-d0d0-4fa1-8a0b-f23b3e90d86c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1e769b48-94c0-4bbc-9c1b-c11ecd351d4d",
"CreateDate": "2026-10-05T11:46:53.0448417-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-05T11:46:53.0448417-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "98b3e1ad-8ada-4596-8e66-8a9e943cacd9",
"FieldId": "76e75359-badd-4466-babe-ca8f8ac60834",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "98b3e1ad-8ada-4596-8e66-8a9e943cacd9",
"FieldId": "76e75359-badd-4466-babe-ca8f8ac60834",
"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": "bbc37dd1-4433-4ee2-99ff-2258675ce4ad",
"CreateDate": "2026-10-05T11:46:53.0448417-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-05T11:46:53.0448417-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}