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": "dfefdc5c-174d-480b-a0ce-c2f6bc288114", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bbbc6901-1331-475b-8f76-c4577ed6669f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "6be096e9-2ab5-48fd-8cc0-7b9a096d8577", "CreateDate": "2025-08-30T12:52:55.0019023-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-30T12:52:55.0019023-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-30T12:52:55.0019023-07:00", "Fields": [ { "FormTypeFieldId": "2e251111-cadd-4576-b198-6ba05c6e2e18", "Section": { "FormTypeSectionId": "44fe8c0b-f8e6-44ee-ba3e-03d21e926c5f", "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": "14eee958-b83c-4fb4-b325-726750e84174", "Name": "sample string 1" }, "Unit": { "UnitId": "9d1502ac-b6b3-48dd-b6ef-70212370af0f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "aa31aaf4-ff92-48fd-a984-c1005a598c5b", "CreateDate": "2025-08-30T12:52:55.0019023-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:52:55.0019023-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": "2e251111-cadd-4576-b198-6ba05c6e2e18", "Section": { "FormTypeSectionId": "44fe8c0b-f8e6-44ee-ba3e-03d21e926c5f", "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": "14eee958-b83c-4fb4-b325-726750e84174", "Name": "sample string 1" }, "Unit": { "UnitId": "9d1502ac-b6b3-48dd-b6ef-70212370af0f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "aa31aaf4-ff92-48fd-a984-c1005a598c5b", "CreateDate": "2025-08-30T12:52:55.0019023-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:52:55.0019023-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": "359f8690-f762-493e-8f77-37ba4ae68ed3", "CreateDate": "2025-08-30T12:52:55.0019023-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:52:55.0019023-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }