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": "51cc6b64-9466-4d06-870e-aa82486c549c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "70264a37-8679-4607-b8cd-63bd5c4c2f35",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c8909c6a-e2d0-4b55-a244-1d8f641c4c4c",
"CreateDate": "2025-12-31T17:47:59.8307752-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-31T17:47:59.8307752-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-31T17:47:59.8307752-08:00",
"Fields": [
{
"FormTypeFieldId": "1e806f7a-c846-4bfa-bc47-789ad31f39c4",
"Section": {
"FormTypeSectionId": "8272bcd4-8eef-4044-aea7-ead7537af867",
"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": "2a95d599-cecf-4710-9ec9-6acb1571818e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7cdd921c-77b8-44e0-ba8e-9f686e881da5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "edf0371a-c155-453a-a5ea-d6301239ad24",
"CreateDate": "2025-12-31T17:47:59.8307752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-31T17:47:59.8307752-08: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": "1e806f7a-c846-4bfa-bc47-789ad31f39c4",
"Section": {
"FormTypeSectionId": "8272bcd4-8eef-4044-aea7-ead7537af867",
"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": "2a95d599-cecf-4710-9ec9-6acb1571818e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7cdd921c-77b8-44e0-ba8e-9f686e881da5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "edf0371a-c155-453a-a5ea-d6301239ad24",
"CreateDate": "2025-12-31T17:47:59.8307752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-31T17:47:59.8307752-08: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": "0c801253-4647-445e-ab1f-514023b46075",
"CreateDate": "2025-12-31T17:47:59.8307752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-31T17:47:59.8307752-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}