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": "c059fe56-4e73-4113-b48d-845dacd51b20",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5faf8456-0bd9-44a4-b7a9-cb3878a0f13c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1f0e0eeb-9982-4e96-b6fd-745562606bfb",
"CreateDate": "2026-09-01T22:16:26.706898-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-01T22:16:26.706898-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-01T22:16:26.706898-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "08f7715d-5b32-4a2d-9ea1-52595306484a",
"Section": {
"FormTypeSectionId": "239c1e8f-1fb8-4c64-b679-388212bea7a1",
"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": "0988b87b-c562-403c-94df-8bd8ae890f64",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "114abbb3-4229-4a95-9033-8710a00a3fc4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4561b984-9d25-41bd-a7d0-c01174b85789",
"CreateDate": "2026-09-01T22:16:26.706898-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-01T22:16:26.706898-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ad8e1bbc-b7e3-4648-9476-1b4d3e54b420",
"FieldId": "311f97cf-8815-4092-bce6-77777bc04bd8",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ad8e1bbc-b7e3-4648-9476-1b4d3e54b420",
"FieldId": "311f97cf-8815-4092-bce6-77777bc04bd8",
"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": "08f7715d-5b32-4a2d-9ea1-52595306484a",
"Section": {
"FormTypeSectionId": "239c1e8f-1fb8-4c64-b679-388212bea7a1",
"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": "0988b87b-c562-403c-94df-8bd8ae890f64",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "114abbb3-4229-4a95-9033-8710a00a3fc4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4561b984-9d25-41bd-a7d0-c01174b85789",
"CreateDate": "2026-09-01T22:16:26.706898-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-01T22:16:26.706898-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ad8e1bbc-b7e3-4648-9476-1b4d3e54b420",
"FieldId": "311f97cf-8815-4092-bce6-77777bc04bd8",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ad8e1bbc-b7e3-4648-9476-1b4d3e54b420",
"FieldId": "311f97cf-8815-4092-bce6-77777bc04bd8",
"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": "2d3daa92-beb4-4f16-8d60-f1caa07553c8",
"CreateDate": "2026-09-01T22:16:26.706898-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-01T22:16:26.706898-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}