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": "dbc88047-0827-4195-8fa7-e9421d1e3149",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b787e994-a5be-4669-a0ab-bc7c9ee4aa7b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d6f464fc-2ee5-463f-848f-bbfedf08db47",
"CreateDate": "2026-03-13T13:52:23.0744823-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T13:52:23.0744823-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-13T13:52:23.0744823-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "3e230cf6-2531-442a-9e42-57f0637830e9",
"Section": {
"FormTypeSectionId": "d60e2cfd-f719-4b04-942e-fe2c7b4bee9c",
"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": "231dd670-1b11-47df-8e76-f272f9f2d088",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "63f733eb-420c-4bc3-ad23-082c031ebde8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4df3a145-6e89-431d-b646-b88d0e9bdf7c",
"CreateDate": "2026-03-13T13:52:23.0744823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T13:52:23.0744823-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5e2bfb92-b847-4b2c-8ff5-f95aa5fb5df5",
"FieldId": "abb598b2-08d9-4e37-a9d9-5353572466ad",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5e2bfb92-b847-4b2c-8ff5-f95aa5fb5df5",
"FieldId": "abb598b2-08d9-4e37-a9d9-5353572466ad",
"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": "3e230cf6-2531-442a-9e42-57f0637830e9",
"Section": {
"FormTypeSectionId": "d60e2cfd-f719-4b04-942e-fe2c7b4bee9c",
"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": "231dd670-1b11-47df-8e76-f272f9f2d088",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "63f733eb-420c-4bc3-ad23-082c031ebde8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4df3a145-6e89-431d-b646-b88d0e9bdf7c",
"CreateDate": "2026-03-13T13:52:23.0744823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T13:52:23.0744823-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5e2bfb92-b847-4b2c-8ff5-f95aa5fb5df5",
"FieldId": "abb598b2-08d9-4e37-a9d9-5353572466ad",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5e2bfb92-b847-4b2c-8ff5-f95aa5fb5df5",
"FieldId": "abb598b2-08d9-4e37-a9d9-5353572466ad",
"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": "0f7e02f6-8a77-4bfa-a977-4b406c4e1713",
"CreateDate": "2026-03-13T13:52:23.0744823-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T13:52:23.0744823-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}