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": "f6c2e30c-505c-493b-a91e-f8162a59a375", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "45be2c28-dbc5-4f9c-b459-8f9ce3d8de82", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f2067561-eb2c-4e9c-a85c-e40d32c959b6", "CreateDate": "2025-04-30T13:44:34.2979036-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-30T13:44:34.2979036-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-30T13:44:34.2979036-07:00", "Fields": [ { "FormTypeFieldId": "40fee593-f8e8-4c76-99d8-bb2039375797", "Section": { "FormTypeSectionId": "8f017fb8-b70d-483e-8f32-6949338a342b", "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": "e5fe41a1-47a3-474f-a63e-84380c0007bc", "Name": "sample string 1" }, "Unit": { "UnitId": "d28c9bb4-c4f4-4698-9173-b557dd1ea676", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8b83dfa0-04a6-46f6-9e7a-6eb83b20e9e5", "CreateDate": "2025-04-30T13:44:34.2979036-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T13:44:34.2979036-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c610e6ba-5f4f-470c-baed-fbd19d31baf2", "FieldId": "3750b5ee-d903-4f97-85d0-fc4292bf0efb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c610e6ba-5f4f-470c-baed-fbd19d31baf2", "FieldId": "3750b5ee-d903-4f97-85d0-fc4292bf0efb", "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": "40fee593-f8e8-4c76-99d8-bb2039375797", "Section": { "FormTypeSectionId": "8f017fb8-b70d-483e-8f32-6949338a342b", "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": "e5fe41a1-47a3-474f-a63e-84380c0007bc", "Name": "sample string 1" }, "Unit": { "UnitId": "d28c9bb4-c4f4-4698-9173-b557dd1ea676", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8b83dfa0-04a6-46f6-9e7a-6eb83b20e9e5", "CreateDate": "2025-04-30T13:44:34.2979036-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T13:44:34.2979036-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c610e6ba-5f4f-470c-baed-fbd19d31baf2", "FieldId": "3750b5ee-d903-4f97-85d0-fc4292bf0efb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c610e6ba-5f4f-470c-baed-fbd19d31baf2", "FieldId": "3750b5ee-d903-4f97-85d0-fc4292bf0efb", "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 3", "CompanyId": "3cf3449f-2d94-4294-9473-6bfbf3a79e48", "CreateDate": "2025-04-30T13:44:34.2979036-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T13:44:34.2979036-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }