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": "7736ec86-6963-4d75-a0b1-8e21d85b3c0c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b9d2f73b-2c9c-4c24-aa9f-144e7748192e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "eb7cee71-8551-4e99-972a-d2f7aef34e2f",
"CreateDate": "2026-10-27T23:44:47.2934377-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T23:44:47.2934377-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-27T23:44:47.2934377-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "720d384b-7816-4de4-b45d-c12cb0be0bb3",
"Section": {
"FormTypeSectionId": "4a801e14-dee6-4ef4-b297-6317af7b827c",
"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": "9b6e6be8-9d84-4878-bfe0-83f0cfc64032",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cc5e9f3a-b88a-44be-a4f3-be3a897f320f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "331f9904-c69f-4aed-af59-dfb85b0f93dc",
"CreateDate": "2026-10-27T23:44:47.2934377-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T23:44:47.2934377-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9cdf4a3e-5aac-48e2-8fe5-10207142db21",
"FieldId": "3eaa7f27-d206-4d0f-a11c-aa6f768249b6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9cdf4a3e-5aac-48e2-8fe5-10207142db21",
"FieldId": "3eaa7f27-d206-4d0f-a11c-aa6f768249b6",
"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": "720d384b-7816-4de4-b45d-c12cb0be0bb3",
"Section": {
"FormTypeSectionId": "4a801e14-dee6-4ef4-b297-6317af7b827c",
"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": "9b6e6be8-9d84-4878-bfe0-83f0cfc64032",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cc5e9f3a-b88a-44be-a4f3-be3a897f320f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "331f9904-c69f-4aed-af59-dfb85b0f93dc",
"CreateDate": "2026-10-27T23:44:47.2934377-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T23:44:47.2934377-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9cdf4a3e-5aac-48e2-8fe5-10207142db21",
"FieldId": "3eaa7f27-d206-4d0f-a11c-aa6f768249b6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9cdf4a3e-5aac-48e2-8fe5-10207142db21",
"FieldId": "3eaa7f27-d206-4d0f-a11c-aa6f768249b6",
"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": "68b8efa3-1960-4b94-b4c2-9f2e3f2d1c26",
"CreateDate": "2026-10-27T23:44:47.2934377-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T23:44:47.2934377-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}