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": "fd5c623d-f64c-4524-92d7-d8afe5ad24b6",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "24560634-2453-4842-ad44-ad0696450f9a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c058fbcf-37e5-4eac-9c05-87256671d5fb",
"CreateDate": "2026-08-08T11:32:53.3844616-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-08T11:32:53.3844616-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-08T11:32:53.3844616-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "648db1f0-365d-4883-bcc6-e54f6e37cd87",
"Section": {
"FormTypeSectionId": "f9c641b4-15c9-4b11-9c38-fbf095b9669b",
"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": "c5cf365d-c5c4-4378-891c-22ebdd0f3ff1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bf3979ee-b2f8-4b0f-88a6-546439e90961",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bd732569-abd7-40cb-9800-38e63b78ec4f",
"CreateDate": "2026-08-08T11:32:53.3844616-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T11:32:53.3844616-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "249dca9b-ca0b-4af1-87e3-d52ee5d6e9ce",
"FieldId": "03d2be2c-1fd7-4fb3-8854-61d062afffdf",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "249dca9b-ca0b-4af1-87e3-d52ee5d6e9ce",
"FieldId": "03d2be2c-1fd7-4fb3-8854-61d062afffdf",
"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": "648db1f0-365d-4883-bcc6-e54f6e37cd87",
"Section": {
"FormTypeSectionId": "f9c641b4-15c9-4b11-9c38-fbf095b9669b",
"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": "c5cf365d-c5c4-4378-891c-22ebdd0f3ff1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bf3979ee-b2f8-4b0f-88a6-546439e90961",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bd732569-abd7-40cb-9800-38e63b78ec4f",
"CreateDate": "2026-08-08T11:32:53.3844616-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T11:32:53.3844616-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "249dca9b-ca0b-4af1-87e3-d52ee5d6e9ce",
"FieldId": "03d2be2c-1fd7-4fb3-8854-61d062afffdf",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "249dca9b-ca0b-4af1-87e3-d52ee5d6e9ce",
"FieldId": "03d2be2c-1fd7-4fb3-8854-61d062afffdf",
"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": "4f87e139-fc25-4c75-bdaf-647e82c9f5a1",
"CreateDate": "2026-08-08T11:32:53.3844616-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-08T11:32:53.3844616-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}