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": "a71e440c-e268-4143-bb9c-a0aa6ff152c3", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e8630d55-adce-420b-8c1f-30b7e868aa91", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2fdbd2f7-c573-41dc-adba-2c3c07be706a", "CreateDate": "2025-06-22T23:40:35.640592-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:40:35.640592-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-22T23:40:35.640592-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "9d5b05f9-835c-4be1-8b4b-91637d7dad4a", "Section": { "FormTypeSectionId": "218a27f2-be18-4154-a131-3848e19a43d8", "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": "604921f0-f4d3-460f-aa15-b282d3ea1dee", "Name": "sample string 1" }, "Unit": { "UnitId": "254a314b-938c-42bd-bd6a-7d4b5d6793ec", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "74a3fca9-b2b9-4e5f-a257-c2e7900c1234", "CreateDate": "2025-06-22T23:40:35.640592-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:40:35.640592-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "9a5a73d6-f0ed-4152-9b1f-d85a03a0deb2", "FieldId": "4bb17977-55e6-4554-ab23-161b06084817", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "9a5a73d6-f0ed-4152-9b1f-d85a03a0deb2", "FieldId": "4bb17977-55e6-4554-ab23-161b06084817", "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": "9d5b05f9-835c-4be1-8b4b-91637d7dad4a", "Section": { "FormTypeSectionId": "218a27f2-be18-4154-a131-3848e19a43d8", "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": "604921f0-f4d3-460f-aa15-b282d3ea1dee", "Name": "sample string 1" }, "Unit": { "UnitId": "254a314b-938c-42bd-bd6a-7d4b5d6793ec", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "74a3fca9-b2b9-4e5f-a257-c2e7900c1234", "CreateDate": "2025-06-22T23:40:35.640592-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:40:35.640592-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "9a5a73d6-f0ed-4152-9b1f-d85a03a0deb2", "FieldId": "4bb17977-55e6-4554-ab23-161b06084817", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "9a5a73d6-f0ed-4152-9b1f-d85a03a0deb2", "FieldId": "4bb17977-55e6-4554-ab23-161b06084817", "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": "ef0a542d-5964-4630-a865-43594c64b302", "CreateDate": "2025-06-22T23:40:35.640592-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:40:35.640592-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }