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": "46936822-412c-4e64-9372-ae74ede146d8", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bbef9d4a-26c0-4523-891b-e6f67b9b2047", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2106b69e-0f9a-4ffc-bf11-fbf9ea8978ef", "CreateDate": "2025-04-25T15:08:51.017043-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:08:51.017043-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-25T15:08:51.017043-07:00", "Fields": [ { "FormTypeFieldId": "3d90dd18-39e2-4883-b655-1f5e0940de2a", "Section": { "FormTypeSectionId": "355b3a12-44d8-4380-a7fa-dcf5b4134e42", "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": "d564b65d-0790-43b9-9f55-f862bf8ef579", "Name": "sample string 1" }, "Unit": { "UnitId": "3677f822-049c-44b7-9679-f6d758ebffab", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3215529a-51d7-4a0e-aced-b4091f85bbda", "CreateDate": "2025-04-25T15:08:51.017043-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:08:51.017043-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "6cea8ba6-7027-4162-85ec-c0cdb45d5d5d", "FieldId": "8a36075f-7fe1-48f6-a36f-e04f06fa6a56", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "6cea8ba6-7027-4162-85ec-c0cdb45d5d5d", "FieldId": "8a36075f-7fe1-48f6-a36f-e04f06fa6a56", "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": "3d90dd18-39e2-4883-b655-1f5e0940de2a", "Section": { "FormTypeSectionId": "355b3a12-44d8-4380-a7fa-dcf5b4134e42", "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": "d564b65d-0790-43b9-9f55-f862bf8ef579", "Name": "sample string 1" }, "Unit": { "UnitId": "3677f822-049c-44b7-9679-f6d758ebffab", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3215529a-51d7-4a0e-aced-b4091f85bbda", "CreateDate": "2025-04-25T15:08:51.017043-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:08:51.017043-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "6cea8ba6-7027-4162-85ec-c0cdb45d5d5d", "FieldId": "8a36075f-7fe1-48f6-a36f-e04f06fa6a56", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "6cea8ba6-7027-4162-85ec-c0cdb45d5d5d", "FieldId": "8a36075f-7fe1-48f6-a36f-e04f06fa6a56", "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": "5cb4cabf-3248-4ebe-b317-d7c3261d47f6", "CreateDate": "2025-04-25T15:08:51.017043-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:08:51.017043-07:00", "LastModifiedUser": "sample string 6" }, { "FormTypeId": "46936822-412c-4e64-9372-ae74ede146d8", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bbef9d4a-26c0-4523-891b-e6f67b9b2047", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2106b69e-0f9a-4ffc-bf11-fbf9ea8978ef", "CreateDate": "2025-04-25T15:08:51.017043-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:08:51.017043-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-25T15:08:51.017043-07:00", "Fields": [ { "FormTypeFieldId": "3d90dd18-39e2-4883-b655-1f5e0940de2a", "Section": { "FormTypeSectionId": "355b3a12-44d8-4380-a7fa-dcf5b4134e42", "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": "d564b65d-0790-43b9-9f55-f862bf8ef579", "Name": "sample string 1" }, "Unit": { "UnitId": "3677f822-049c-44b7-9679-f6d758ebffab", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3215529a-51d7-4a0e-aced-b4091f85bbda", "CreateDate": "2025-04-25T15:08:51.017043-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:08:51.017043-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "6cea8ba6-7027-4162-85ec-c0cdb45d5d5d", "FieldId": "8a36075f-7fe1-48f6-a36f-e04f06fa6a56", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "6cea8ba6-7027-4162-85ec-c0cdb45d5d5d", "FieldId": "8a36075f-7fe1-48f6-a36f-e04f06fa6a56", "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": "3d90dd18-39e2-4883-b655-1f5e0940de2a", "Section": { "FormTypeSectionId": "355b3a12-44d8-4380-a7fa-dcf5b4134e42", "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": "d564b65d-0790-43b9-9f55-f862bf8ef579", "Name": "sample string 1" }, "Unit": { "UnitId": "3677f822-049c-44b7-9679-f6d758ebffab", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3215529a-51d7-4a0e-aced-b4091f85bbda", "CreateDate": "2025-04-25T15:08:51.017043-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:08:51.017043-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "6cea8ba6-7027-4162-85ec-c0cdb45d5d5d", "FieldId": "8a36075f-7fe1-48f6-a36f-e04f06fa6a56", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "6cea8ba6-7027-4162-85ec-c0cdb45d5d5d", "FieldId": "8a36075f-7fe1-48f6-a36f-e04f06fa6a56", "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": "5cb4cabf-3248-4ebe-b317-d7c3261d47f6", "CreateDate": "2025-04-25T15:08:51.017043-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:08:51.017043-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }