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": "d675a5e6-e7a9-4cf0-8225-f1238d40edba",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1a120f72-df7e-404e-8122-f558e0f3b6ba",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4bbda34b-1f67-40fa-9bf4-f456492f8c24",
"CreateDate": "2026-05-29T18:32:43.4201895-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-29T18:32:43.4201895-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-29T18:32:43.4201895-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "91950a0a-7072-4c12-b6ee-7db2a9d814b8",
"Section": {
"FormTypeSectionId": "582cefbc-f871-414a-89a7-08c69a556c69",
"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": "8cd22122-4bfd-4ccd-a946-1ab8fd43b611",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bc2675bf-32bb-4d30-9da7-a708728a3178",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "105d33b7-4026-411e-b498-04555c2e0041",
"CreateDate": "2026-05-29T18:32:43.4201895-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-29T18:32:43.4201895-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4a47bf3b-2efc-45e9-8a8f-4ae13436d9ec",
"FieldId": "15984585-40de-4766-87a0-581a546bd572",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4a47bf3b-2efc-45e9-8a8f-4ae13436d9ec",
"FieldId": "15984585-40de-4766-87a0-581a546bd572",
"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": "91950a0a-7072-4c12-b6ee-7db2a9d814b8",
"Section": {
"FormTypeSectionId": "582cefbc-f871-414a-89a7-08c69a556c69",
"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": "8cd22122-4bfd-4ccd-a946-1ab8fd43b611",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bc2675bf-32bb-4d30-9da7-a708728a3178",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "105d33b7-4026-411e-b498-04555c2e0041",
"CreateDate": "2026-05-29T18:32:43.4201895-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-29T18:32:43.4201895-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4a47bf3b-2efc-45e9-8a8f-4ae13436d9ec",
"FieldId": "15984585-40de-4766-87a0-581a546bd572",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4a47bf3b-2efc-45e9-8a8f-4ae13436d9ec",
"FieldId": "15984585-40de-4766-87a0-581a546bd572",
"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": "10b1b0a1-f872-4731-8243-56e574e6f372",
"CreateDate": "2026-05-29T18:32:43.4201895-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-29T18:32:43.4201895-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}