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": "e74b7175-6ddc-45de-a2e7-c177499c7ba5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a4c54604-a9ee-4dba-a993-f022b6179782",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "81850c66-1df3-481f-b722-712bc247fdff",
"CreateDate": "2026-01-16T08:35:18.7073468-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T08:35:18.7073468-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-16T08:35:18.7073468-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "51d7b72e-9da4-4ed2-ae9d-fbaea12df8b8",
"Section": {
"FormTypeSectionId": "b0b348d9-642f-43d4-9a76-788640c83787",
"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": "a98fa829-aedf-4491-b5de-0a47ae1cd3ec",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a6cedd31-0319-47aa-b615-5ecf57bccc31",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b2bc1463-7680-452a-9fe4-5ca4026b16e0",
"CreateDate": "2026-01-16T08:35:18.7073468-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T08:35:18.7073468-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "1ba42398-3085-4855-bd23-1bdb67c1a972",
"FieldId": "96405102-7aae-4ad9-8d1d-2f2345f2b7ce",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "1ba42398-3085-4855-bd23-1bdb67c1a972",
"FieldId": "96405102-7aae-4ad9-8d1d-2f2345f2b7ce",
"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": "51d7b72e-9da4-4ed2-ae9d-fbaea12df8b8",
"Section": {
"FormTypeSectionId": "b0b348d9-642f-43d4-9a76-788640c83787",
"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": "a98fa829-aedf-4491-b5de-0a47ae1cd3ec",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a6cedd31-0319-47aa-b615-5ecf57bccc31",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b2bc1463-7680-452a-9fe4-5ca4026b16e0",
"CreateDate": "2026-01-16T08:35:18.7073468-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T08:35:18.7073468-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "1ba42398-3085-4855-bd23-1bdb67c1a972",
"FieldId": "96405102-7aae-4ad9-8d1d-2f2345f2b7ce",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "1ba42398-3085-4855-bd23-1bdb67c1a972",
"FieldId": "96405102-7aae-4ad9-8d1d-2f2345f2b7ce",
"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": "760886f6-1f62-4024-882f-0599783f412c",
"CreateDate": "2026-01-16T08:35:18.7073468-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T08:35:18.7073468-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}