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": "4107f2f0-bd22-4b83-94e8-98718fd1e8cc", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "c8c688d7-38f6-41ce-89ac-fb6a0a8e3ffc", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "59f7feef-449e-4066-a935-f23cbf37e5d7", "CreateDate": "2025-06-02T06:26:10.9657948-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T06:26:10.9657948-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T06:26:10.9657948-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "91b8bcb1-bcde-4862-a716-6b7029fb798b", "Section": { "FormTypeSectionId": "bf0fe5e0-0e0e-4888-86e8-3c7b38714b84", "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": "2641df09-c6ec-4b3a-bd8f-3b09b660ccd4", "Name": "sample string 1" }, "Unit": { "UnitId": "8cda5f6d-d93f-49fe-beed-2ea778acf4b6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1c2cb329-a576-41b1-b98d-0b6c2e05166b", "CreateDate": "2025-06-02T06:26:10.9657948-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T06:26:10.9657948-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "46739627-d605-4be4-af74-12999a424cf2", "FieldId": "697a699e-d2d1-46f2-9c10-0aef64ac0a38", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "46739627-d605-4be4-af74-12999a424cf2", "FieldId": "697a699e-d2d1-46f2-9c10-0aef64ac0a38", "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": "91b8bcb1-bcde-4862-a716-6b7029fb798b", "Section": { "FormTypeSectionId": "bf0fe5e0-0e0e-4888-86e8-3c7b38714b84", "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": "2641df09-c6ec-4b3a-bd8f-3b09b660ccd4", "Name": "sample string 1" }, "Unit": { "UnitId": "8cda5f6d-d93f-49fe-beed-2ea778acf4b6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1c2cb329-a576-41b1-b98d-0b6c2e05166b", "CreateDate": "2025-06-02T06:26:10.9657948-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T06:26:10.9657948-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "46739627-d605-4be4-af74-12999a424cf2", "FieldId": "697a699e-d2d1-46f2-9c10-0aef64ac0a38", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "46739627-d605-4be4-af74-12999a424cf2", "FieldId": "697a699e-d2d1-46f2-9c10-0aef64ac0a38", "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": "700f325e-877e-4a38-86b4-7024e81ac121", "CreateDate": "2025-06-02T06:26:10.9657948-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T06:26:10.9657948-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }