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": "bcfacb30-fb8f-41c3-9f84-289c7b6771c8", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "1d7eb453-d9ff-4589-804e-f67001b703ba", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "07d71485-3737-4d08-8cec-e686c6000d4f", "CreateDate": "2025-07-02T19:07:10.407482-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T19:07:10.407482-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-02T19:07:10.407482-07:00", "Fields": [ { "FormTypeFieldId": "f2b97ca4-7746-48fc-a5ec-2760eac01a5e", "Section": { "FormTypeSectionId": "ed3c05ce-701c-41cf-84ba-0c2b2665bfd7", "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": "78e1a0a0-8663-4ffc-98ef-628c23dee1f2", "Name": "sample string 1" }, "Unit": { "UnitId": "49717797-f2af-45cc-bba8-ada9682b7e79", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "52411247-6ba2-4e1e-b094-b2f4aaaefc95", "CreateDate": "2025-07-02T19:07:10.407482-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T19:07:10.407482-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "f2b97ca4-7746-48fc-a5ec-2760eac01a5e", "Section": { "FormTypeSectionId": "ed3c05ce-701c-41cf-84ba-0c2b2665bfd7", "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": "78e1a0a0-8663-4ffc-98ef-628c23dee1f2", "Name": "sample string 1" }, "Unit": { "UnitId": "49717797-f2af-45cc-bba8-ada9682b7e79", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "52411247-6ba2-4e1e-b094-b2f4aaaefc95", "CreateDate": "2025-07-02T19:07:10.407482-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T19:07:10.407482-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "b20bee82-67fe-40a0-90d7-55b2c2115261", "CreateDate": "2025-07-02T19:07:10.407482-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T19:07:10.407482-07:00", "LastModifiedUser": "sample string 6" }, { "FormTypeId": "bcfacb30-fb8f-41c3-9f84-289c7b6771c8", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "1d7eb453-d9ff-4589-804e-f67001b703ba", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "07d71485-3737-4d08-8cec-e686c6000d4f", "CreateDate": "2025-07-02T19:07:10.407482-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T19:07:10.407482-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-02T19:07:10.407482-07:00", "Fields": [ { "FormTypeFieldId": "f2b97ca4-7746-48fc-a5ec-2760eac01a5e", "Section": { "FormTypeSectionId": "ed3c05ce-701c-41cf-84ba-0c2b2665bfd7", "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": "78e1a0a0-8663-4ffc-98ef-628c23dee1f2", "Name": "sample string 1" }, "Unit": { "UnitId": "49717797-f2af-45cc-bba8-ada9682b7e79", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "52411247-6ba2-4e1e-b094-b2f4aaaefc95", "CreateDate": "2025-07-02T19:07:10.407482-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T19:07:10.407482-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "f2b97ca4-7746-48fc-a5ec-2760eac01a5e", "Section": { "FormTypeSectionId": "ed3c05ce-701c-41cf-84ba-0c2b2665bfd7", "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": "78e1a0a0-8663-4ffc-98ef-628c23dee1f2", "Name": "sample string 1" }, "Unit": { "UnitId": "49717797-f2af-45cc-bba8-ada9682b7e79", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "52411247-6ba2-4e1e-b094-b2f4aaaefc95", "CreateDate": "2025-07-02T19:07:10.407482-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T19:07:10.407482-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "b20bee82-67fe-40a0-90d7-55b2c2115261", "CreateDate": "2025-07-02T19:07:10.407482-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T19:07:10.407482-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }