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": "37226e2d-4621-4744-b98a-0677f92bfab6", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "16d290c3-cce8-4e53-9382-80cfb9da0033", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5dd0f44d-df36-4f6b-bf93-6aa84f7ec92c", "CreateDate": "2025-09-13T21:01:00.7268118-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:01:00.7268118-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T21:01:00.7268118-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "f9255ba3-5252-40d5-9d25-67a6fec6a3e5", "Section": { "FormTypeSectionId": "ffeead07-830a-4526-b017-957dd16de5b1", "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": "35e9b41d-8c10-4d80-a80e-38802a6700bf", "Name": "sample string 1" }, "Unit": { "UnitId": "a1a92024-4301-4fd9-8c52-12fd023b6c13", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "309c04df-677f-42dd-923a-15c6201672ec", "CreateDate": "2025-09-13T21:01:00.7268118-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:01:00.7268118-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7ccc4a77-3119-4118-b004-0ea5fdfe7d81", "FieldId": "12f5a1a2-a670-4909-a146-9e0fa8955e2c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7ccc4a77-3119-4118-b004-0ea5fdfe7d81", "FieldId": "12f5a1a2-a670-4909-a146-9e0fa8955e2c", "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": "f9255ba3-5252-40d5-9d25-67a6fec6a3e5", "Section": { "FormTypeSectionId": "ffeead07-830a-4526-b017-957dd16de5b1", "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": "35e9b41d-8c10-4d80-a80e-38802a6700bf", "Name": "sample string 1" }, "Unit": { "UnitId": "a1a92024-4301-4fd9-8c52-12fd023b6c13", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "309c04df-677f-42dd-923a-15c6201672ec", "CreateDate": "2025-09-13T21:01:00.7268118-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:01:00.7268118-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7ccc4a77-3119-4118-b004-0ea5fdfe7d81", "FieldId": "12f5a1a2-a670-4909-a146-9e0fa8955e2c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7ccc4a77-3119-4118-b004-0ea5fdfe7d81", "FieldId": "12f5a1a2-a670-4909-a146-9e0fa8955e2c", "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": "575a9b98-cd66-4e30-98ad-35e80a4c19bd", "CreateDate": "2025-09-13T21:01:00.7268118-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:01:00.7268118-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }