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": "2f954837-1243-4fed-9161-07173fff4a00", "Asset": { "AssetId": "31c47985-ccf6-4aaf-a4a2-3b2c97bc24e3", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "95a20aa9-b913-4207-9d43-af6f9c20c4cd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "31abd220-df0d-47b5-9fcb-05db84997a5c", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "4396b058-4861-4e15-9301-e32deb82de2c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-09-22T12:21:11.6066597-07:00", "MeasurementValueNeededDate": "2023-09-22T12:21:11.6066597-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0b8323fb-d975-454d-9ff4-d6caa20efedb", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2023-09-22T12:21:11.6066597-07:00", "MeasurementValueNeededDate": "2023-09-22T12:21:11.6066597-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d066d1c2-bceb-4232-841e-afd8edee5711", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "48ed2efc-bace-4dc8-ae68-ec7734614a05", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "95a20aa9-b913-4207-9d43-af6f9c20c4cd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "31abd220-df0d-47b5-9fcb-05db84997a5c", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2023-09-22T12:21:11.6066597-07:00", "Fields": [ { "FormTypeFieldId": "47a26e96-0cbb-4c99-8c98-08b2f63ad6dd", "Section": { "FormTypeSectionId": "615f7087-b12d-4693-bee7-86a2e01d2eba", "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": "fb843206-0c1a-49d8-b150-5cad6b7be311", "Name": "sample string 1" }, "Unit": { "UnitId": "5684719a-6ec3-40bb-a5fe-f472eefb6d49", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1c5ed6ef-2f8b-425f-8bbc-61db9c1b5145", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-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": "47a26e96-0cbb-4c99-8c98-08b2f63ad6dd", "Section": { "FormTypeSectionId": "615f7087-b12d-4693-bee7-86a2e01d2eba", "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": "fb843206-0c1a-49d8-b150-5cad6b7be311", "Name": "sample string 1" }, "Unit": { "UnitId": "5684719a-6ec3-40bb-a5fe-f472eefb6d49", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1c5ed6ef-2f8b-425f-8bbc-61db9c1b5145", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-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": "bf34fab9-393d-4aed-8df8-ef58cabe6018", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2023-09-22T12:21:11.6066597-07:00", "Location": "sample string 1", "TaskId": "e3092c98-fa73-44c7-bd6d-39a781daa0f0", "Values": [ { "FormFieldValueId": "60b5d4d7-ec94-427f-8643-a45719d277cf", "FormTypeField": { "FormTypeFieldId": "47a26e96-0cbb-4c99-8c98-08b2f63ad6dd", "Section": { "FormTypeSectionId": "615f7087-b12d-4693-bee7-86a2e01d2eba", "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": "fb843206-0c1a-49d8-b150-5cad6b7be311", "Name": "sample string 1" }, "Unit": { "UnitId": "5684719a-6ec3-40bb-a5fe-f472eefb6d49", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1c5ed6ef-2f8b-425f-8bbc-61db9c1b5145", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-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": "60b5d4d7-ec94-427f-8643-a45719d277cf", "FormTypeField": { "FormTypeFieldId": "47a26e96-0cbb-4c99-8c98-08b2f63ad6dd", "Section": { "FormTypeSectionId": "615f7087-b12d-4693-bee7-86a2e01d2eba", "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": "fb843206-0c1a-49d8-b150-5cad6b7be311", "Name": "sample string 1" }, "Unit": { "UnitId": "5684719a-6ec3-40bb-a5fe-f472eefb6d49", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1c5ed6ef-2f8b-425f-8bbc-61db9c1b5145", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-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": "78d722ee-1f68-4c11-91d8-b8349b6d66d5", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 5" }, { "FormId": "2f954837-1243-4fed-9161-07173fff4a00", "Asset": { "AssetId": "31c47985-ccf6-4aaf-a4a2-3b2c97bc24e3", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "95a20aa9-b913-4207-9d43-af6f9c20c4cd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "31abd220-df0d-47b5-9fcb-05db84997a5c", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "4396b058-4861-4e15-9301-e32deb82de2c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-09-22T12:21:11.6066597-07:00", "MeasurementValueNeededDate": "2023-09-22T12:21:11.6066597-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0b8323fb-d975-454d-9ff4-d6caa20efedb", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2023-09-22T12:21:11.6066597-07:00", "MeasurementValueNeededDate": "2023-09-22T12:21:11.6066597-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d066d1c2-bceb-4232-841e-afd8edee5711", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "48ed2efc-bace-4dc8-ae68-ec7734614a05", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "95a20aa9-b913-4207-9d43-af6f9c20c4cd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "31abd220-df0d-47b5-9fcb-05db84997a5c", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2023-09-22T12:21:11.6066597-07:00", "Fields": [ { "FormTypeFieldId": "47a26e96-0cbb-4c99-8c98-08b2f63ad6dd", "Section": { "FormTypeSectionId": "615f7087-b12d-4693-bee7-86a2e01d2eba", "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": "fb843206-0c1a-49d8-b150-5cad6b7be311", "Name": "sample string 1" }, "Unit": { "UnitId": "5684719a-6ec3-40bb-a5fe-f472eefb6d49", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1c5ed6ef-2f8b-425f-8bbc-61db9c1b5145", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-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": "47a26e96-0cbb-4c99-8c98-08b2f63ad6dd", "Section": { "FormTypeSectionId": "615f7087-b12d-4693-bee7-86a2e01d2eba", "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": "fb843206-0c1a-49d8-b150-5cad6b7be311", "Name": "sample string 1" }, "Unit": { "UnitId": "5684719a-6ec3-40bb-a5fe-f472eefb6d49", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1c5ed6ef-2f8b-425f-8bbc-61db9c1b5145", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-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": "bf34fab9-393d-4aed-8df8-ef58cabe6018", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2023-09-22T12:21:11.6066597-07:00", "Location": "sample string 1", "TaskId": "e3092c98-fa73-44c7-bd6d-39a781daa0f0", "Values": [ { "FormFieldValueId": "60b5d4d7-ec94-427f-8643-a45719d277cf", "FormTypeField": { "FormTypeFieldId": "47a26e96-0cbb-4c99-8c98-08b2f63ad6dd", "Section": { "FormTypeSectionId": "615f7087-b12d-4693-bee7-86a2e01d2eba", "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": "fb843206-0c1a-49d8-b150-5cad6b7be311", "Name": "sample string 1" }, "Unit": { "UnitId": "5684719a-6ec3-40bb-a5fe-f472eefb6d49", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1c5ed6ef-2f8b-425f-8bbc-61db9c1b5145", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-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": "60b5d4d7-ec94-427f-8643-a45719d277cf", "FormTypeField": { "FormTypeFieldId": "47a26e96-0cbb-4c99-8c98-08b2f63ad6dd", "Section": { "FormTypeSectionId": "615f7087-b12d-4693-bee7-86a2e01d2eba", "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": "fb843206-0c1a-49d8-b150-5cad6b7be311", "Name": "sample string 1" }, "Unit": { "UnitId": "5684719a-6ec3-40bb-a5fe-f472eefb6d49", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1c5ed6ef-2f8b-425f-8bbc-61db9c1b5145", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:21:11.6066597-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": "78d722ee-1f68-4c11-91d8-b8349b6d66d5", "CreateDate": "2023-09-22T12:21:11.6066597-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2023-09-22T12:21:11.6066597-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }