GET FormTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves form types for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
take |
Number of form types to retrieve. Default is all form types |
integer |
None. |
skip |
Number of form types to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the form types before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of form types.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of FormType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "FormTypeId": "1339c73c-84ba-42cd-bd5f-85343c13dd1e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "3b1bb32a-1982-4b33-a45f-eb523ef6755c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9d03256d-0bd4-45bc-a388-97073b467710", "CreateDate": "2025-07-18T03:02:32.5282101-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-18T03:02:32.5282101-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-18T03:02:32.5282101-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "f7739a15-14f6-431d-9f30-fa3dd33c30c6", "Section": { "FormTypeSectionId": "725017fb-4185-4c91-986f-db127ffaea07", "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": "858a2853-e5d1-4a61-a19e-5d3cceb6498f", "Name": "sample string 1" }, "Unit": { "UnitId": "f7b504c3-c5a1-411d-81b2-43e214b2da28", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2d4dc880-c73f-40ad-a41c-aa1e347a47a5", "CreateDate": "2025-07-18T03:02:32.5282101-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T03:02:32.5282101-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "45c88917-1543-4ee4-9fd1-7fe256d98fd8", "FieldId": "a77577c3-98fa-4440-8f1b-d225f83f2631", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "45c88917-1543-4ee4-9fd1-7fe256d98fd8", "FieldId": "a77577c3-98fa-4440-8f1b-d225f83f2631", "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": "f7739a15-14f6-431d-9f30-fa3dd33c30c6", "Section": { "FormTypeSectionId": "725017fb-4185-4c91-986f-db127ffaea07", "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": "858a2853-e5d1-4a61-a19e-5d3cceb6498f", "Name": "sample string 1" }, "Unit": { "UnitId": "f7b504c3-c5a1-411d-81b2-43e214b2da28", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2d4dc880-c73f-40ad-a41c-aa1e347a47a5", "CreateDate": "2025-07-18T03:02:32.5282101-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T03:02:32.5282101-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "45c88917-1543-4ee4-9fd1-7fe256d98fd8", "FieldId": "a77577c3-98fa-4440-8f1b-d225f83f2631", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "45c88917-1543-4ee4-9fd1-7fe256d98fd8", "FieldId": "a77577c3-98fa-4440-8f1b-d225f83f2631", "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": "5fe0b081-c648-4eb9-9cf9-38de90722a5c", "CreateDate": "2025-07-18T03:02:32.5282101-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-18T03:02:32.5282101-07:00", "LastModifiedUser": "sample string 7" }, { "FormTypeId": "1339c73c-84ba-42cd-bd5f-85343c13dd1e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "3b1bb32a-1982-4b33-a45f-eb523ef6755c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9d03256d-0bd4-45bc-a388-97073b467710", "CreateDate": "2025-07-18T03:02:32.5282101-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-18T03:02:32.5282101-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-18T03:02:32.5282101-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "f7739a15-14f6-431d-9f30-fa3dd33c30c6", "Section": { "FormTypeSectionId": "725017fb-4185-4c91-986f-db127ffaea07", "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": "858a2853-e5d1-4a61-a19e-5d3cceb6498f", "Name": "sample string 1" }, "Unit": { "UnitId": "f7b504c3-c5a1-411d-81b2-43e214b2da28", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2d4dc880-c73f-40ad-a41c-aa1e347a47a5", "CreateDate": "2025-07-18T03:02:32.5282101-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T03:02:32.5282101-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "45c88917-1543-4ee4-9fd1-7fe256d98fd8", "FieldId": "a77577c3-98fa-4440-8f1b-d225f83f2631", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "45c88917-1543-4ee4-9fd1-7fe256d98fd8", "FieldId": "a77577c3-98fa-4440-8f1b-d225f83f2631", "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": "f7739a15-14f6-431d-9f30-fa3dd33c30c6", "Section": { "FormTypeSectionId": "725017fb-4185-4c91-986f-db127ffaea07", "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": "858a2853-e5d1-4a61-a19e-5d3cceb6498f", "Name": "sample string 1" }, "Unit": { "UnitId": "f7b504c3-c5a1-411d-81b2-43e214b2da28", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2d4dc880-c73f-40ad-a41c-aa1e347a47a5", "CreateDate": "2025-07-18T03:02:32.5282101-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T03:02:32.5282101-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "45c88917-1543-4ee4-9fd1-7fe256d98fd8", "FieldId": "a77577c3-98fa-4440-8f1b-d225f83f2631", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "45c88917-1543-4ee4-9fd1-7fe256d98fd8", "FieldId": "a77577c3-98fa-4440-8f1b-d225f83f2631", "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": "5fe0b081-c648-4eb9-9cf9-38de90722a5c", "CreateDate": "2025-07-18T03:02:32.5282101-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-18T03:02:32.5282101-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }