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": "9a06049d-d99d-43ce-ae15-d12759630325",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "19317a73-d8fe-4a5e-b56e-a45130a7f4b2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0af707ef-50da-4901-8b21-1478865af824",
"CreateDate": "2025-12-01T15:14:43.9008097-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:14:43.9008097-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-01T15:14:43.9008097-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "cd3465ec-9ee6-4991-b111-c1e4959e4c82",
"Section": {
"FormTypeSectionId": "108f1ac7-c5af-4e08-b707-b4a6bce0cfe2",
"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": "f7c55c69-c344-4edd-a74b-6c7a7f78513a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "07f722fb-8930-40e9-8313-e3547af20e95",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "40681760-69d6-44f5-8550-a54a680faccb",
"CreateDate": "2025-12-01T15:14:43.9008097-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T15:14:43.9008097-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "301aea2f-2309-44df-84b3-29c7130e425a",
"FieldId": "4ff240ac-62e3-4960-af99-99308932a3ec",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "301aea2f-2309-44df-84b3-29c7130e425a",
"FieldId": "4ff240ac-62e3-4960-af99-99308932a3ec",
"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": "cd3465ec-9ee6-4991-b111-c1e4959e4c82",
"Section": {
"FormTypeSectionId": "108f1ac7-c5af-4e08-b707-b4a6bce0cfe2",
"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": "f7c55c69-c344-4edd-a74b-6c7a7f78513a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "07f722fb-8930-40e9-8313-e3547af20e95",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "40681760-69d6-44f5-8550-a54a680faccb",
"CreateDate": "2025-12-01T15:14:43.9008097-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T15:14:43.9008097-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "301aea2f-2309-44df-84b3-29c7130e425a",
"FieldId": "4ff240ac-62e3-4960-af99-99308932a3ec",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "301aea2f-2309-44df-84b3-29c7130e425a",
"FieldId": "4ff240ac-62e3-4960-af99-99308932a3ec",
"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": "2a8bf0fc-1ad9-43ef-8a23-f8ebf79458b5",
"CreateDate": "2025-12-01T15:14:43.9008097-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:14:43.9008097-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}