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": "c1c61f1d-e138-4221-a68a-7d03b181a091", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "416738d0-0753-4bd0-b30c-a5849ce211ab", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "55add611-bd98-4ff2-b0f6-231dd98404b5", "CreateDate": "2025-07-20T02:57:33.3699364-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-20T02:57:33.3699364-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-20T02:57:33.3699364-07:00", "Fields": [ { "FormTypeFieldId": "42847b7f-1150-4dd4-a398-da1f8bc54d12", "Section": { "FormTypeSectionId": "bb7abfb0-2333-42a4-8999-34bbc0c3a4bf", "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": "c38fe69b-506a-4848-b58c-76bf018b587d", "Name": "sample string 1" }, "Unit": { "UnitId": "c9b83a64-784e-4b07-8d29-7fe87ad304c0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2892e7ae-b44c-4fdf-8029-7a3541f158d6", "CreateDate": "2025-07-20T02:57:33.3699364-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-20T02:57:33.3699364-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "711e2896-acd0-4abc-b7c5-bcbcc3df1314", "FieldId": "46962f81-8c8d-44a9-b8ba-a1af29585f9d", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "711e2896-acd0-4abc-b7c5-bcbcc3df1314", "FieldId": "46962f81-8c8d-44a9-b8ba-a1af29585f9d", "FieldName": "sample string 1", "FieldLable": "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": "42847b7f-1150-4dd4-a398-da1f8bc54d12", "Section": { "FormTypeSectionId": "bb7abfb0-2333-42a4-8999-34bbc0c3a4bf", "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": "c38fe69b-506a-4848-b58c-76bf018b587d", "Name": "sample string 1" }, "Unit": { "UnitId": "c9b83a64-784e-4b07-8d29-7fe87ad304c0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2892e7ae-b44c-4fdf-8029-7a3541f158d6", "CreateDate": "2025-07-20T02:57:33.3699364-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-20T02:57:33.3699364-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "711e2896-acd0-4abc-b7c5-bcbcc3df1314", "FieldId": "46962f81-8c8d-44a9-b8ba-a1af29585f9d", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "711e2896-acd0-4abc-b7c5-bcbcc3df1314", "FieldId": "46962f81-8c8d-44a9-b8ba-a1af29585f9d", "FieldName": "sample string 1", "FieldLable": "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": "95f418b1-e471-43b0-bf47-c102d276319d", "CreateDate": "2025-07-20T02:57:33.3699364-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-20T02:57:33.3699364-07:00", "LastModifiedUser": "sample string 6" }, { "FormTypeId": "c1c61f1d-e138-4221-a68a-7d03b181a091", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "416738d0-0753-4bd0-b30c-a5849ce211ab", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "55add611-bd98-4ff2-b0f6-231dd98404b5", "CreateDate": "2025-07-20T02:57:33.3699364-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-20T02:57:33.3699364-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-20T02:57:33.3699364-07:00", "Fields": [ { "FormTypeFieldId": "42847b7f-1150-4dd4-a398-da1f8bc54d12", "Section": { "FormTypeSectionId": "bb7abfb0-2333-42a4-8999-34bbc0c3a4bf", "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": "c38fe69b-506a-4848-b58c-76bf018b587d", "Name": "sample string 1" }, "Unit": { "UnitId": "c9b83a64-784e-4b07-8d29-7fe87ad304c0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2892e7ae-b44c-4fdf-8029-7a3541f158d6", "CreateDate": "2025-07-20T02:57:33.3699364-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-20T02:57:33.3699364-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "711e2896-acd0-4abc-b7c5-bcbcc3df1314", "FieldId": "46962f81-8c8d-44a9-b8ba-a1af29585f9d", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "711e2896-acd0-4abc-b7c5-bcbcc3df1314", "FieldId": "46962f81-8c8d-44a9-b8ba-a1af29585f9d", "FieldName": "sample string 1", "FieldLable": "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": "42847b7f-1150-4dd4-a398-da1f8bc54d12", "Section": { "FormTypeSectionId": "bb7abfb0-2333-42a4-8999-34bbc0c3a4bf", "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": "c38fe69b-506a-4848-b58c-76bf018b587d", "Name": "sample string 1" }, "Unit": { "UnitId": "c9b83a64-784e-4b07-8d29-7fe87ad304c0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2892e7ae-b44c-4fdf-8029-7a3541f158d6", "CreateDate": "2025-07-20T02:57:33.3699364-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-20T02:57:33.3699364-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "711e2896-acd0-4abc-b7c5-bcbcc3df1314", "FieldId": "46962f81-8c8d-44a9-b8ba-a1af29585f9d", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "711e2896-acd0-4abc-b7c5-bcbcc3df1314", "FieldId": "46962f81-8c8d-44a9-b8ba-a1af29585f9d", "FieldName": "sample string 1", "FieldLable": "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": "95f418b1-e471-43b0-bf47-c102d276319d", "CreateDate": "2025-07-20T02:57:33.3699364-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-20T02:57:33.3699364-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }