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": "4dbef017-5171-479a-bc30-22f3b514055e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2faf9039-347b-4a55-bd17-0a25dbbf463d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c4b3101e-a20d-45ec-bbb2-2e42d7d13fe5",
"CreateDate": "2025-12-14T06:26:36.8312566-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-14T06:26:36.8312566-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-14T06:26:36.8312566-08:00",
"Fields": [
{
"FormTypeFieldId": "abe82bd6-9a77-4847-8128-653a23c04713",
"Section": {
"FormTypeSectionId": "3dc21f8f-4ae3-4989-b305-a535644601eb",
"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": "1ec73dc1-be59-42db-939c-68a2e5809144",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "685f7d76-46c1-4a03-b8ac-22d197746052",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bec22ae3-cdb0-4837-b46f-18baba35b931",
"CreateDate": "2025-12-14T06:26:36.8312566-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-14T06:26:36.8312566-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": "abe82bd6-9a77-4847-8128-653a23c04713",
"Section": {
"FormTypeSectionId": "3dc21f8f-4ae3-4989-b305-a535644601eb",
"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": "1ec73dc1-be59-42db-939c-68a2e5809144",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "685f7d76-46c1-4a03-b8ac-22d197746052",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bec22ae3-cdb0-4837-b46f-18baba35b931",
"CreateDate": "2025-12-14T06:26:36.8312566-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-14T06:26:36.8312566-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": "49ef1321-e219-410c-88f0-84e10dfe6e14",
"CreateDate": "2025-12-14T06:26:36.8312566-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-14T06:26:36.8312566-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}