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": "1390f25b-345a-4045-bbd0-dd0cf54b2548",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c68e4e80-ecaf-4750-b707-6e8d986d757a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "38912570-0e92-48e3-85e0-9fc098dafcce",
"CreateDate": "2026-06-28T09:39:11.902825-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T09:39:11.902825-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-28T09:39:11.902825-07:00",
"Fields": [
{
"FormTypeFieldId": "6cb88c42-6657-4666-9395-9cbbed338991",
"Section": {
"FormTypeSectionId": "123a6b83-373f-44eb-ba98-0cc4c3b21c16",
"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": "4320f60f-eaa2-4ef3-9fce-9033cfd73c5b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "26efd1fc-51e1-4c26-9faa-e192c1a536ed",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cf4a919c-023d-44ab-8c85-00bbd0031d43",
"CreateDate": "2026-06-28T09:39:11.902825-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:39:11.902825-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "6cb88c42-6657-4666-9395-9cbbed338991",
"Section": {
"FormTypeSectionId": "123a6b83-373f-44eb-ba98-0cc4c3b21c16",
"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": "4320f60f-eaa2-4ef3-9fce-9033cfd73c5b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "26efd1fc-51e1-4c26-9faa-e192c1a536ed",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cf4a919c-023d-44ab-8c85-00bbd0031d43",
"CreateDate": "2026-06-28T09:39:11.902825-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:39:11.902825-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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 3",
"CompanyId": "f32f0be3-f472-447f-97a1-e6d9ecf2c003",
"CreateDate": "2026-06-28T09:39:11.902825-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:39:11.902825-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}