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": "5287a3aa-f23f-4d97-98d1-cf3518f83041", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2662283b-3bf6-42f2-974d-143737e88798", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "07300a29-474f-45e9-9fd0-80b2e6538eee", "CreateDate": "2025-06-30T23:23:04.1562934-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T23:23:04.1562934-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-30T23:23:04.1562934-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "46c7ca9a-1cd6-4df9-a3f1-49669e7d10c3", "Section": { "FormTypeSectionId": "93ba6ab1-b877-4658-84b0-a61bb25969b5", "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": "b97e559b-aa32-40fb-869f-92cc660027a3", "Name": "sample string 1" }, "Unit": { "UnitId": "ab573549-c7dd-44c7-9b7d-7614cb67ddf4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "be3b8e4d-6a68-483a-bd22-d82e140fbe34", "CreateDate": "2025-06-30T23:23:04.1562934-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T23:23:04.1562934-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "5310b5e6-44f5-4cd4-850f-de847335615a", "FieldId": "9cd3b82e-5ebe-4267-95a8-47712316df5d", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "5310b5e6-44f5-4cd4-850f-de847335615a", "FieldId": "9cd3b82e-5ebe-4267-95a8-47712316df5d", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "46c7ca9a-1cd6-4df9-a3f1-49669e7d10c3", "Section": { "FormTypeSectionId": "93ba6ab1-b877-4658-84b0-a61bb25969b5", "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": "b97e559b-aa32-40fb-869f-92cc660027a3", "Name": "sample string 1" }, "Unit": { "UnitId": "ab573549-c7dd-44c7-9b7d-7614cb67ddf4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "be3b8e4d-6a68-483a-bd22-d82e140fbe34", "CreateDate": "2025-06-30T23:23:04.1562934-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T23:23:04.1562934-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "5310b5e6-44f5-4cd4-850f-de847335615a", "FieldId": "9cd3b82e-5ebe-4267-95a8-47712316df5d", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "5310b5e6-44f5-4cd4-850f-de847335615a", "FieldId": "9cd3b82e-5ebe-4267-95a8-47712316df5d", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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 4", "CompanyId": "d962822b-80bc-4288-aaae-01cabba855b8", "CreateDate": "2025-06-30T23:23:04.1562934-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T23:23:04.1562934-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }