GET Forms?assetId={assetId}&formTypeId={formTypeId}&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}&includeAttachmentContent={includeAttachmentContent}
Retrieves forms for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
formTypeId |
Id of the form type |
globally unique identifier |
None. |
take |
Number of forms to retrieve. Default is all forms |
integer |
None. |
skip |
Number of forms to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the forms before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
|
includeAttachmentContent |
Include the file contents of the form field values if applicable |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
On success, a list of forms.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Form |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "FormId": "2d1a4f1d-f915-498b-a6d2-167ff79fe2f9", "Asset": { "AssetId": "3c326f10-a646-4644-87d0-57a4ecaf1546", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7685f2e0-ad4d-4876-98e9-c6a7ce3712be", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "92b4b70b-547f-47e4-9c67-53840fa18e75", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:17:52.5543246-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "c6a0c9aa-a5a3-4424-9280-c14e096d8980", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-18T17:17:52.5543246-07:00", "MeasurementValueNeededDate": "2025-03-18T17:17:52.5543246-07:00", "SourceSystemId": "sample string 3", "CompanyId": "427bb375-af27-49a3-a76b-90448c0aef07", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-03-18T17:17:52.5543246-07:00", "MeasurementValueNeededDate": "2025-03-18T17:17:52.5543246-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "50320b47-8f90-4023-8297-767f37b6e050", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-18T17:17:52.5543246-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "45123d0a-caf9-4e53-988c-6f3b4c61ff97", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7685f2e0-ad4d-4876-98e9-c6a7ce3712be", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "92b4b70b-547f-47e4-9c67-53840fa18e75", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:17:52.5543246-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-03-18T17:17:52.5543246-07:00", "Fields": [ { "FormTypeFieldId": "9374a647-d2b2-498d-a52c-01fc8d8907fc", "Section": { "FormTypeSectionId": "8cdfada7-2997-4414-b264-9081371c52db", "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": "22635d21-f7ea-4515-82f3-7ae73e29adc4", "Name": "sample string 1" }, "Unit": { "UnitId": "f273adad-982d-40ed-b877-0a040ff26919", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c18173cf-c75b-476e-91bf-0b05260a8d1b", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-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": "9374a647-d2b2-498d-a52c-01fc8d8907fc", "Section": { "FormTypeSectionId": "8cdfada7-2997-4414-b264-9081371c52db", "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": "22635d21-f7ea-4515-82f3-7ae73e29adc4", "Name": "sample string 1" }, "Unit": { "UnitId": "f273adad-982d-40ed-b877-0a040ff26919", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c18173cf-c75b-476e-91bf-0b05260a8d1b", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-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": "622c7c52-708a-44e7-b93e-74b704ab55f1", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-03-18T17:17:52.5543246-07:00", "Location": "sample string 1", "TaskId": "103bee2d-ea42-407c-ac01-a9e3e2a90c85", "Values": [ { "FormFieldValueId": "77e9150d-b175-44ab-8bd1-7d7d169492e3", "FormTypeField": { "FormTypeFieldId": "9374a647-d2b2-498d-a52c-01fc8d8907fc", "Section": { "FormTypeSectionId": "8cdfada7-2997-4414-b264-9081371c52db", "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": "22635d21-f7ea-4515-82f3-7ae73e29adc4", "Name": "sample string 1" }, "Unit": { "UnitId": "f273adad-982d-40ed-b877-0a040ff26919", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c18173cf-c75b-476e-91bf-0b05260a8d1b", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "77e9150d-b175-44ab-8bd1-7d7d169492e3", "FormTypeField": { "FormTypeFieldId": "9374a647-d2b2-498d-a52c-01fc8d8907fc", "Section": { "FormTypeSectionId": "8cdfada7-2997-4414-b264-9081371c52db", "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": "22635d21-f7ea-4515-82f3-7ae73e29adc4", "Name": "sample string 1" }, "Unit": { "UnitId": "f273adad-982d-40ed-b877-0a040ff26919", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c18173cf-c75b-476e-91bf-0b05260a8d1b", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "87b090ca-c048-44be-9bd7-6fb935ba5844", "CreateDate": "2025-03-18T17:17:52.5699421-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-03-18T17:17:52.5699421-07:00", "LastModifiedUser": "sample string 5" }, { "FormId": "2d1a4f1d-f915-498b-a6d2-167ff79fe2f9", "Asset": { "AssetId": "3c326f10-a646-4644-87d0-57a4ecaf1546", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7685f2e0-ad4d-4876-98e9-c6a7ce3712be", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "92b4b70b-547f-47e4-9c67-53840fa18e75", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:17:52.5543246-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "c6a0c9aa-a5a3-4424-9280-c14e096d8980", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-18T17:17:52.5543246-07:00", "MeasurementValueNeededDate": "2025-03-18T17:17:52.5543246-07:00", "SourceSystemId": "sample string 3", "CompanyId": "427bb375-af27-49a3-a76b-90448c0aef07", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-03-18T17:17:52.5543246-07:00", "MeasurementValueNeededDate": "2025-03-18T17:17:52.5543246-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "50320b47-8f90-4023-8297-767f37b6e050", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-18T17:17:52.5543246-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "45123d0a-caf9-4e53-988c-6f3b4c61ff97", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7685f2e0-ad4d-4876-98e9-c6a7ce3712be", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "92b4b70b-547f-47e4-9c67-53840fa18e75", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:17:52.5543246-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-03-18T17:17:52.5543246-07:00", "Fields": [ { "FormTypeFieldId": "9374a647-d2b2-498d-a52c-01fc8d8907fc", "Section": { "FormTypeSectionId": "8cdfada7-2997-4414-b264-9081371c52db", "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": "22635d21-f7ea-4515-82f3-7ae73e29adc4", "Name": "sample string 1" }, "Unit": { "UnitId": "f273adad-982d-40ed-b877-0a040ff26919", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c18173cf-c75b-476e-91bf-0b05260a8d1b", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-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": "9374a647-d2b2-498d-a52c-01fc8d8907fc", "Section": { "FormTypeSectionId": "8cdfada7-2997-4414-b264-9081371c52db", "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": "22635d21-f7ea-4515-82f3-7ae73e29adc4", "Name": "sample string 1" }, "Unit": { "UnitId": "f273adad-982d-40ed-b877-0a040ff26919", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c18173cf-c75b-476e-91bf-0b05260a8d1b", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-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": "622c7c52-708a-44e7-b93e-74b704ab55f1", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-03-18T17:17:52.5543246-07:00", "Location": "sample string 1", "TaskId": "103bee2d-ea42-407c-ac01-a9e3e2a90c85", "Values": [ { "FormFieldValueId": "77e9150d-b175-44ab-8bd1-7d7d169492e3", "FormTypeField": { "FormTypeFieldId": "9374a647-d2b2-498d-a52c-01fc8d8907fc", "Section": { "FormTypeSectionId": "8cdfada7-2997-4414-b264-9081371c52db", "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": "22635d21-f7ea-4515-82f3-7ae73e29adc4", "Name": "sample string 1" }, "Unit": { "UnitId": "f273adad-982d-40ed-b877-0a040ff26919", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c18173cf-c75b-476e-91bf-0b05260a8d1b", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "77e9150d-b175-44ab-8bd1-7d7d169492e3", "FormTypeField": { "FormTypeFieldId": "9374a647-d2b2-498d-a52c-01fc8d8907fc", "Section": { "FormTypeSectionId": "8cdfada7-2997-4414-b264-9081371c52db", "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": "22635d21-f7ea-4515-82f3-7ae73e29adc4", "Name": "sample string 1" }, "Unit": { "UnitId": "f273adad-982d-40ed-b877-0a040ff26919", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c18173cf-c75b-476e-91bf-0b05260a8d1b", "CreateDate": "2025-03-18T17:17:52.5543246-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:17:52.5543246-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "87b090ca-c048-44be-9bd7-6fb935ba5844", "CreateDate": "2025-03-18T17:17:52.5699421-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-03-18T17:17:52.5699421-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }