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": "7eaeaa7f-6df5-4c5c-8320-6daf776b6b08",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a8baed16-0a2d-4e31-9e6e-c693d2c770d7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cebbabec-e6f4-481f-ab53-41abd91294e8",
"CreateDate": "2026-05-23T23:58:51.3465079-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-23T23:58:51.3465079-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-23T23:58:51.3465079-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "901eb599-5d64-4e84-aa47-ba4a9d0cb090",
"Section": {
"FormTypeSectionId": "0337707c-b0ae-4f50-a47b-ed21c29f5f34",
"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": "8d5acf1b-f3f3-4fb0-aaaa-356069375f1e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bd90d3bd-c95a-411c-b04f-d0172e906fc6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "af724230-0d7d-44e6-b5ee-10233a2c8a73",
"CreateDate": "2026-05-23T23:58:51.3465079-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T23:58:51.3465079-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d8d823a2-8648-4ac6-927a-4c9b531e6bad",
"FieldId": "3488dba6-4a53-420d-b290-96403c50634d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d8d823a2-8648-4ac6-927a-4c9b531e6bad",
"FieldId": "3488dba6-4a53-420d-b290-96403c50634d",
"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": "901eb599-5d64-4e84-aa47-ba4a9d0cb090",
"Section": {
"FormTypeSectionId": "0337707c-b0ae-4f50-a47b-ed21c29f5f34",
"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": "8d5acf1b-f3f3-4fb0-aaaa-356069375f1e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bd90d3bd-c95a-411c-b04f-d0172e906fc6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "af724230-0d7d-44e6-b5ee-10233a2c8a73",
"CreateDate": "2026-05-23T23:58:51.3465079-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T23:58:51.3465079-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d8d823a2-8648-4ac6-927a-4c9b531e6bad",
"FieldId": "3488dba6-4a53-420d-b290-96403c50634d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d8d823a2-8648-4ac6-927a-4c9b531e6bad",
"FieldId": "3488dba6-4a53-420d-b290-96403c50634d",
"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": "57c5589d-8a9a-42c0-992d-9431c574f327",
"CreateDate": "2026-05-23T23:58:51.3465079-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-23T23:58:51.3465079-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}