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": "d9451f05-711a-4a19-b581-7779929e704b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e50e0cb0-52bd-4291-af52-3705fe9a0d9d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e8585461-c42d-4465-aa0a-67149a15bb8e",
"CreateDate": "2026-11-04T14:36:22.304175-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-04T14:36:22.304175-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-04T14:36:22.304175-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "d8fced56-886b-4879-acce-4db9c9403845",
"Section": {
"FormTypeSectionId": "30754988-b21c-41db-87a2-6bef085b036b",
"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": "eef26fe5-3b2f-4e10-9a5a-66103d3a7c01",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4848be30-7354-43a8-8e80-664e565f5daa",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "81229f9b-71a1-4511-8537-a822c7663c04",
"CreateDate": "2026-11-04T14:36:22.304175-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T14:36:22.304175-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6235ff41-7843-49f1-b22c-4b9dd91adf30",
"FieldId": "dfe729ea-4215-4a44-bd9f-960eba645c37",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6235ff41-7843-49f1-b22c-4b9dd91adf30",
"FieldId": "dfe729ea-4215-4a44-bd9f-960eba645c37",
"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": "d8fced56-886b-4879-acce-4db9c9403845",
"Section": {
"FormTypeSectionId": "30754988-b21c-41db-87a2-6bef085b036b",
"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": "eef26fe5-3b2f-4e10-9a5a-66103d3a7c01",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4848be30-7354-43a8-8e80-664e565f5daa",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "81229f9b-71a1-4511-8537-a822c7663c04",
"CreateDate": "2026-11-04T14:36:22.304175-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T14:36:22.304175-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6235ff41-7843-49f1-b22c-4b9dd91adf30",
"FieldId": "dfe729ea-4215-4a44-bd9f-960eba645c37",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6235ff41-7843-49f1-b22c-4b9dd91adf30",
"FieldId": "dfe729ea-4215-4a44-bd9f-960eba645c37",
"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": "be71d87e-e518-4c8d-8bae-42cc05b998c5",
"CreateDate": "2026-11-04T14:36:22.304175-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-04T14:36:22.304175-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}