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": "8776912e-5b9f-42d3-981d-c709cfd0f99d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "78d2ac53-7576-46a9-be1f-fb0978283cf6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ebd2dec6-8c33-4e85-8062-7bb7ab73165a",
"CreateDate": "2026-03-07T23:54:41.2885433-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-07T23:54:41.2885433-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-07T23:54:41.2885433-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ed1011c0-c8cd-4438-8bbc-d0d840d8251f",
"Section": {
"FormTypeSectionId": "0de37ef8-cbfd-4549-91d2-92d624a38dc5",
"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": "e1396c8a-f596-463a-83e6-5fcffacd9b0d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "43178e00-0c1b-4af8-b4b5-48101deedcb3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5941638e-956c-4294-b984-272566078344",
"CreateDate": "2026-03-07T23:54:41.2885433-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T23:54:41.2885433-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ced2a7d4-76ca-45ab-a0e3-02884f11cc5c",
"FieldId": "cb3a595d-56cf-48d6-ad06-644937eba6b1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ced2a7d4-76ca-45ab-a0e3-02884f11cc5c",
"FieldId": "cb3a595d-56cf-48d6-ad06-644937eba6b1",
"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": "ed1011c0-c8cd-4438-8bbc-d0d840d8251f",
"Section": {
"FormTypeSectionId": "0de37ef8-cbfd-4549-91d2-92d624a38dc5",
"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": "e1396c8a-f596-463a-83e6-5fcffacd9b0d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "43178e00-0c1b-4af8-b4b5-48101deedcb3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5941638e-956c-4294-b984-272566078344",
"CreateDate": "2026-03-07T23:54:41.2885433-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T23:54:41.2885433-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ced2a7d4-76ca-45ab-a0e3-02884f11cc5c",
"FieldId": "cb3a595d-56cf-48d6-ad06-644937eba6b1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ced2a7d4-76ca-45ab-a0e3-02884f11cc5c",
"FieldId": "cb3a595d-56cf-48d6-ad06-644937eba6b1",
"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": "fa7eb6c1-92fc-4729-824a-e6da02e79bdd",
"CreateDate": "2026-03-07T23:54:41.2885433-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-07T23:54:41.2885433-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}