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": "26948a46-e44c-40d4-bf91-7f828cae44b2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f343f534-671b-42dc-af62-6749e0f11986", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "748acc59-dcbd-4675-a5ef-b2f3df5144f8", "CreateDate": "2025-07-11T19:20:10.2151047-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T19:20:10.2151047-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-11T19:20:10.2151047-07:00", "Fields": [ { "FormTypeFieldId": "7feb8cbf-840f-43fa-b0a5-35e4ba0c8524", "Section": { "FormTypeSectionId": "24033426-0b77-4b83-8f6a-70ecb1ff5295", "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": "cc05bfb1-ad9e-4e79-823e-2069a78b3764", "Name": "sample string 1" }, "Unit": { "UnitId": "fb3fc64b-df11-40b3-8863-273b8d6fce03", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "82804f69-bbb3-4e94-8eb1-36233ce625ea", "CreateDate": "2025-07-11T19:20:10.2151047-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T19:20:10.2151047-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "587df83d-9f3d-44b9-af6c-a3185e3f4c9c", "FieldId": "9b514aeb-d9a9-434d-a676-6d335873478f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "587df83d-9f3d-44b9-af6c-a3185e3f4c9c", "FieldId": "9b514aeb-d9a9-434d-a676-6d335873478f", "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": "7feb8cbf-840f-43fa-b0a5-35e4ba0c8524", "Section": { "FormTypeSectionId": "24033426-0b77-4b83-8f6a-70ecb1ff5295", "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": "cc05bfb1-ad9e-4e79-823e-2069a78b3764", "Name": "sample string 1" }, "Unit": { "UnitId": "fb3fc64b-df11-40b3-8863-273b8d6fce03", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "82804f69-bbb3-4e94-8eb1-36233ce625ea", "CreateDate": "2025-07-11T19:20:10.2151047-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T19:20:10.2151047-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "587df83d-9f3d-44b9-af6c-a3185e3f4c9c", "FieldId": "9b514aeb-d9a9-434d-a676-6d335873478f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "587df83d-9f3d-44b9-af6c-a3185e3f4c9c", "FieldId": "9b514aeb-d9a9-434d-a676-6d335873478f", "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": "11b43031-180e-42c4-9fe9-5e81bb36ef96", "CreateDate": "2025-07-11T19:20:10.2151047-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T19:20:10.2151047-07:00", "LastModifiedUser": "sample string 6" }, { "FormTypeId": "26948a46-e44c-40d4-bf91-7f828cae44b2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f343f534-671b-42dc-af62-6749e0f11986", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "748acc59-dcbd-4675-a5ef-b2f3df5144f8", "CreateDate": "2025-07-11T19:20:10.2151047-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T19:20:10.2151047-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-11T19:20:10.2151047-07:00", "Fields": [ { "FormTypeFieldId": "7feb8cbf-840f-43fa-b0a5-35e4ba0c8524", "Section": { "FormTypeSectionId": "24033426-0b77-4b83-8f6a-70ecb1ff5295", "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": "cc05bfb1-ad9e-4e79-823e-2069a78b3764", "Name": "sample string 1" }, "Unit": { "UnitId": "fb3fc64b-df11-40b3-8863-273b8d6fce03", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "82804f69-bbb3-4e94-8eb1-36233ce625ea", "CreateDate": "2025-07-11T19:20:10.2151047-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T19:20:10.2151047-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "587df83d-9f3d-44b9-af6c-a3185e3f4c9c", "FieldId": "9b514aeb-d9a9-434d-a676-6d335873478f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "587df83d-9f3d-44b9-af6c-a3185e3f4c9c", "FieldId": "9b514aeb-d9a9-434d-a676-6d335873478f", "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": "7feb8cbf-840f-43fa-b0a5-35e4ba0c8524", "Section": { "FormTypeSectionId": "24033426-0b77-4b83-8f6a-70ecb1ff5295", "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": "cc05bfb1-ad9e-4e79-823e-2069a78b3764", "Name": "sample string 1" }, "Unit": { "UnitId": "fb3fc64b-df11-40b3-8863-273b8d6fce03", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "82804f69-bbb3-4e94-8eb1-36233ce625ea", "CreateDate": "2025-07-11T19:20:10.2151047-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T19:20:10.2151047-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "587df83d-9f3d-44b9-af6c-a3185e3f4c9c", "FieldId": "9b514aeb-d9a9-434d-a676-6d335873478f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "587df83d-9f3d-44b9-af6c-a3185e3f4c9c", "FieldId": "9b514aeb-d9a9-434d-a676-6d335873478f", "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": "11b43031-180e-42c4-9fe9-5e81bb36ef96", "CreateDate": "2025-07-11T19:20:10.2151047-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T19:20:10.2151047-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }