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": "84709ffd-e93e-45b9-986c-7a64b55198d9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e4272426-4198-4b18-950f-3d90cfbb005a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "06f39071-7c1c-4920-bee1-f135c8fe53d7",
"CreateDate": "2025-11-05T11:56:13.6090488-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-05T11:56:13.6090488-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-05T11:56:13.6090488-08:00",
"Fields": [
{
"FormTypeFieldId": "724e60aa-1e28-4452-add5-9b757375a720",
"Section": {
"FormTypeSectionId": "a368aaaf-98f6-4453-ba43-2118a50a57f3",
"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": "0fedcb43-cd85-494a-8bca-f9442962e2dd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b222d544-ddb0-4542-8ea1-22bdc2821e9c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b3648f8e-1a58-48fe-8654-3a2637164986",
"CreateDate": "2025-11-05T11:56:13.6090488-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T11:56:13.6090488-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": "724e60aa-1e28-4452-add5-9b757375a720",
"Section": {
"FormTypeSectionId": "a368aaaf-98f6-4453-ba43-2118a50a57f3",
"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": "0fedcb43-cd85-494a-8bca-f9442962e2dd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b222d544-ddb0-4542-8ea1-22bdc2821e9c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b3648f8e-1a58-48fe-8654-3a2637164986",
"CreateDate": "2025-11-05T11:56:13.6090488-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T11:56:13.6090488-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": "f2b55e87-b74c-46ad-8014-40fa52f8d890",
"CreateDate": "2025-11-05T11:56:13.6090488-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T11:56:13.6090488-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}