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": "e4313efc-5ab1-4e18-8bc8-247420df7e4e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "83c9827d-8d53-4691-b809-c53a71e4a458",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4a6a5fbc-abbd-4212-a199-e34fb576665b",
"CreateDate": "2025-11-08T04:59:36.3745299-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-08T04:59:36.3745299-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-08T04:59:36.3745299-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ea0545f8-af65-4067-84eb-90b15e35926a",
"Section": {
"FormTypeSectionId": "5121849b-b02f-4876-9020-7d4814b2dab6",
"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": "769a6bb7-249c-4d2e-84f4-1845a11b8736",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a1970a38-ea4f-49fa-b3d8-1746cbc73da9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "900cfdf3-e700-4041-9639-07f144b7c094",
"CreateDate": "2025-11-08T04:59:36.3745299-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-08T04:59:36.3745299-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "11d2c1d2-f291-4ef3-afb8-a510e422452d",
"FieldId": "ea6a0785-6d1d-473d-9d9a-0a10cfd7b8b6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "11d2c1d2-f291-4ef3-afb8-a510e422452d",
"FieldId": "ea6a0785-6d1d-473d-9d9a-0a10cfd7b8b6",
"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": "ea0545f8-af65-4067-84eb-90b15e35926a",
"Section": {
"FormTypeSectionId": "5121849b-b02f-4876-9020-7d4814b2dab6",
"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": "769a6bb7-249c-4d2e-84f4-1845a11b8736",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a1970a38-ea4f-49fa-b3d8-1746cbc73da9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "900cfdf3-e700-4041-9639-07f144b7c094",
"CreateDate": "2025-11-08T04:59:36.3745299-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-08T04:59:36.3745299-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "11d2c1d2-f291-4ef3-afb8-a510e422452d",
"FieldId": "ea6a0785-6d1d-473d-9d9a-0a10cfd7b8b6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "11d2c1d2-f291-4ef3-afb8-a510e422452d",
"FieldId": "ea6a0785-6d1d-473d-9d9a-0a10cfd7b8b6",
"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": "a5ccb158-f337-44db-94a2-decbc4841593",
"CreateDate": "2025-11-08T04:59:36.3745299-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-08T04:59:36.3745299-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}