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": "257cb4a0-ecee-4e79-ab1d-6f8156650e8c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b289e7ad-b502-40c9-861b-4f218bf8a20b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "af264638-d4c4-4e48-afb0-49560c001a30",
"CreateDate": "2026-08-23T06:21:19.976378-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-23T06:21:19.976378-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-23T06:21:19.976378-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "6ccbbbc6-1831-40ef-952b-be08eac7594c",
"Section": {
"FormTypeSectionId": "88b5766d-5d1d-4305-a42f-0cce64b88dca",
"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": "ca3fd178-194d-442d-90da-3022d7c1f0d9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "30945f44-a3c1-4873-a1ef-4aeafcd23d44",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2048310a-9a7d-43d6-a9b7-eb144c0b8335",
"CreateDate": "2026-08-23T06:21:19.976378-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T06:21:19.976378-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d73b0c12-9a6a-45b6-a473-dcd8569245f0",
"FieldId": "b20dc653-135c-4655-84a2-a62630e873c5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d73b0c12-9a6a-45b6-a473-dcd8569245f0",
"FieldId": "b20dc653-135c-4655-84a2-a62630e873c5",
"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": "6ccbbbc6-1831-40ef-952b-be08eac7594c",
"Section": {
"FormTypeSectionId": "88b5766d-5d1d-4305-a42f-0cce64b88dca",
"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": "ca3fd178-194d-442d-90da-3022d7c1f0d9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "30945f44-a3c1-4873-a1ef-4aeafcd23d44",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2048310a-9a7d-43d6-a9b7-eb144c0b8335",
"CreateDate": "2026-08-23T06:21:19.976378-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T06:21:19.976378-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d73b0c12-9a6a-45b6-a473-dcd8569245f0",
"FieldId": "b20dc653-135c-4655-84a2-a62630e873c5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d73b0c12-9a6a-45b6-a473-dcd8569245f0",
"FieldId": "b20dc653-135c-4655-84a2-a62630e873c5",
"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": "75d0eb1a-a639-42a7-bba9-2b384767b5bc",
"CreateDate": "2026-08-23T06:21:19.976378-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-23T06:21:19.976378-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}