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": "fa8100a0-8cf8-41ea-8733-5ece0f7b3e3b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "c2483e69-8d44-4c4b-bffb-4b05561b6d7f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8ae90102-fd7e-43a7-9cf6-cccf3f3c998b", "CreateDate": "2025-08-24T10:00:12.4821332-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:00:12.4821332-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-24T10:00:12.4821332-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "40235f17-03cc-438d-b0a5-7a9fd1cc255a", "Section": { "FormTypeSectionId": "d019d7f4-22a2-491e-b054-19c7990a2cbb", "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": "e63d6825-1377-4838-ad6c-29273c7b414e", "Name": "sample string 1" }, "Unit": { "UnitId": "d70ec221-0784-4f8a-a5e9-7d2da69138c4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c97d454c-2b93-418b-8f39-75cdd0480fcc", "CreateDate": "2025-08-24T10:00:12.4821332-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:00:12.4821332-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "919be72e-acec-4be7-b7b3-8a06fc2c0a1b", "FieldId": "645f01a6-cecf-411e-a47b-33c4cb0dda30", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "919be72e-acec-4be7-b7b3-8a06fc2c0a1b", "FieldId": "645f01a6-cecf-411e-a47b-33c4cb0dda30", "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": "40235f17-03cc-438d-b0a5-7a9fd1cc255a", "Section": { "FormTypeSectionId": "d019d7f4-22a2-491e-b054-19c7990a2cbb", "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": "e63d6825-1377-4838-ad6c-29273c7b414e", "Name": "sample string 1" }, "Unit": { "UnitId": "d70ec221-0784-4f8a-a5e9-7d2da69138c4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c97d454c-2b93-418b-8f39-75cdd0480fcc", "CreateDate": "2025-08-24T10:00:12.4821332-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:00:12.4821332-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "919be72e-acec-4be7-b7b3-8a06fc2c0a1b", "FieldId": "645f01a6-cecf-411e-a47b-33c4cb0dda30", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "919be72e-acec-4be7-b7b3-8a06fc2c0a1b", "FieldId": "645f01a6-cecf-411e-a47b-33c4cb0dda30", "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": "615637c8-3e34-423a-bdca-f2916828cd18", "CreateDate": "2025-08-24T10:00:12.4821332-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:00:12.4821332-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }