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": "50d3c27c-24d5-4776-8102-88b27f685840",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "aa4a3e52-8fe5-4308-91d9-6a5885a01ccd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9e046683-8ebf-49f6-af2a-e7050dcf69ae",
"CreateDate": "2026-11-10T15:05:23.5576477-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-10T15:05:23.5576477-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-10T15:05:23.5576477-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "e7d20a58-525d-4b7a-b8fd-8ceafec5a8c2",
"Section": {
"FormTypeSectionId": "316abd9c-ca45-499b-8a60-eadce225a76a",
"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": "096193d5-8e43-4159-93e5-3dd644814873",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0c381801-3837-45f3-85c4-464369e1a040",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1d295875-ddcc-4238-a13b-213e9aa14208",
"CreateDate": "2026-11-10T15:05:23.5576477-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-10T15:05:23.5576477-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b85b64d5-e8b6-418d-8084-da0b1d0d6664",
"FieldId": "242d69fd-d098-4ec9-8e2a-18eb27521fbb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b85b64d5-e8b6-418d-8084-da0b1d0d6664",
"FieldId": "242d69fd-d098-4ec9-8e2a-18eb27521fbb",
"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": "e7d20a58-525d-4b7a-b8fd-8ceafec5a8c2",
"Section": {
"FormTypeSectionId": "316abd9c-ca45-499b-8a60-eadce225a76a",
"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": "096193d5-8e43-4159-93e5-3dd644814873",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0c381801-3837-45f3-85c4-464369e1a040",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1d295875-ddcc-4238-a13b-213e9aa14208",
"CreateDate": "2026-11-10T15:05:23.5576477-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-10T15:05:23.5576477-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b85b64d5-e8b6-418d-8084-da0b1d0d6664",
"FieldId": "242d69fd-d098-4ec9-8e2a-18eb27521fbb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b85b64d5-e8b6-418d-8084-da0b1d0d6664",
"FieldId": "242d69fd-d098-4ec9-8e2a-18eb27521fbb",
"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": "1cd51624-1b74-40c6-9321-24f27ba403f0",
"CreateDate": "2026-11-10T15:05:23.5576477-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-10T15:05:23.5576477-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}