GET Forms/ByEffectiveDate?assetId={assetId}&formTypeId={formTypeId}&beginDate={beginDate}&endDate={endDate}&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. |
beginDate |
Beginning effective date of the forms to retrieve |
date |
None. |
endDate |
Ending effective date of the forms to retrieve |
date |
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": "5b41a2da-c43b-4889-8378-dfd19963558c", "Asset": { "AssetId": "be2b12ba-13e5-4823-83b2-9c8cf30d3ac0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b94300cd-4044-4a1f-8bbb-249fadb00df2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4198f397-c78e-4eb1-b6cd-3107f1bd9110", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d8420788-b738-4c9a-84aa-4e71ca1429e6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-25T12:27:30.2372819-07:00", "MeasurementValueNeededDate": "2024-04-25T12:27:30.2372819-07:00", "SourceSystemId": "sample string 3", "CompanyId": "110b51b9-4566-41ff-b13a-d39b5cce371e", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-04-25T12:27:30.2372819-07:00", "MeasurementValueNeededDate": "2024-04-25T12:27:30.2372819-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e9263cfa-82f2-4af7-85c4-6b38be842a4d", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "997a73c7-fb62-49eb-9603-e44fc82b777e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "b94300cd-4044-4a1f-8bbb-249fadb00df2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4198f397-c78e-4eb1-b6cd-3107f1bd9110", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-25T12:27:30.2372819-07:00", "Fields": [ { "FormTypeFieldId": "3afe782d-3b46-4f5b-9caf-e234781957be", "Section": { "FormTypeSectionId": "e22da173-36b6-49ad-8540-2487a43b850f", "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": "19de1fe9-b4d2-43b5-97fa-c3d32682f9f3", "Name": "sample string 1" }, "Unit": { "UnitId": "c14b644f-12cd-4544-b222-4cf06784a661", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "17c03897-8d02-4cb6-b7a9-c59fe86c7e29", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-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": "3afe782d-3b46-4f5b-9caf-e234781957be", "Section": { "FormTypeSectionId": "e22da173-36b6-49ad-8540-2487a43b850f", "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": "19de1fe9-b4d2-43b5-97fa-c3d32682f9f3", "Name": "sample string 1" }, "Unit": { "UnitId": "c14b644f-12cd-4544-b222-4cf06784a661", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "17c03897-8d02-4cb6-b7a9-c59fe86c7e29", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-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": "c63eab04-2103-4b22-b28d-297dc46e99e4", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-04-25T12:27:30.2372819-07:00", "Location": "sample string 1", "TaskId": "a3a0f51a-8cec-40a9-bb1e-5c3b9b10a41a", "Values": [ { "FormFieldValueId": "6fe120f4-2459-4994-bef6-95a2ae0cd3d7", "FormTypeField": { "FormTypeFieldId": "3afe782d-3b46-4f5b-9caf-e234781957be", "Section": { "FormTypeSectionId": "e22da173-36b6-49ad-8540-2487a43b850f", "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": "19de1fe9-b4d2-43b5-97fa-c3d32682f9f3", "Name": "sample string 1" }, "Unit": { "UnitId": "c14b644f-12cd-4544-b222-4cf06784a661", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "17c03897-8d02-4cb6-b7a9-c59fe86c7e29", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-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": "6fe120f4-2459-4994-bef6-95a2ae0cd3d7", "FormTypeField": { "FormTypeFieldId": "3afe782d-3b46-4f5b-9caf-e234781957be", "Section": { "FormTypeSectionId": "e22da173-36b6-49ad-8540-2487a43b850f", "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": "19de1fe9-b4d2-43b5-97fa-c3d32682f9f3", "Name": "sample string 1" }, "Unit": { "UnitId": "c14b644f-12cd-4544-b222-4cf06784a661", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "17c03897-8d02-4cb6-b7a9-c59fe86c7e29", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-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": "7b774ed6-5afc-4bf4-9d89-631f3eafd512", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 5" }, { "FormId": "5b41a2da-c43b-4889-8378-dfd19963558c", "Asset": { "AssetId": "be2b12ba-13e5-4823-83b2-9c8cf30d3ac0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b94300cd-4044-4a1f-8bbb-249fadb00df2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4198f397-c78e-4eb1-b6cd-3107f1bd9110", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d8420788-b738-4c9a-84aa-4e71ca1429e6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-25T12:27:30.2372819-07:00", "MeasurementValueNeededDate": "2024-04-25T12:27:30.2372819-07:00", "SourceSystemId": "sample string 3", "CompanyId": "110b51b9-4566-41ff-b13a-d39b5cce371e", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-04-25T12:27:30.2372819-07:00", "MeasurementValueNeededDate": "2024-04-25T12:27:30.2372819-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e9263cfa-82f2-4af7-85c4-6b38be842a4d", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "997a73c7-fb62-49eb-9603-e44fc82b777e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "b94300cd-4044-4a1f-8bbb-249fadb00df2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4198f397-c78e-4eb1-b6cd-3107f1bd9110", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-25T12:27:30.2372819-07:00", "Fields": [ { "FormTypeFieldId": "3afe782d-3b46-4f5b-9caf-e234781957be", "Section": { "FormTypeSectionId": "e22da173-36b6-49ad-8540-2487a43b850f", "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": "19de1fe9-b4d2-43b5-97fa-c3d32682f9f3", "Name": "sample string 1" }, "Unit": { "UnitId": "c14b644f-12cd-4544-b222-4cf06784a661", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "17c03897-8d02-4cb6-b7a9-c59fe86c7e29", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-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": "3afe782d-3b46-4f5b-9caf-e234781957be", "Section": { "FormTypeSectionId": "e22da173-36b6-49ad-8540-2487a43b850f", "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": "19de1fe9-b4d2-43b5-97fa-c3d32682f9f3", "Name": "sample string 1" }, "Unit": { "UnitId": "c14b644f-12cd-4544-b222-4cf06784a661", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "17c03897-8d02-4cb6-b7a9-c59fe86c7e29", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-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": "c63eab04-2103-4b22-b28d-297dc46e99e4", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-04-25T12:27:30.2372819-07:00", "Location": "sample string 1", "TaskId": "a3a0f51a-8cec-40a9-bb1e-5c3b9b10a41a", "Values": [ { "FormFieldValueId": "6fe120f4-2459-4994-bef6-95a2ae0cd3d7", "FormTypeField": { "FormTypeFieldId": "3afe782d-3b46-4f5b-9caf-e234781957be", "Section": { "FormTypeSectionId": "e22da173-36b6-49ad-8540-2487a43b850f", "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": "19de1fe9-b4d2-43b5-97fa-c3d32682f9f3", "Name": "sample string 1" }, "Unit": { "UnitId": "c14b644f-12cd-4544-b222-4cf06784a661", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "17c03897-8d02-4cb6-b7a9-c59fe86c7e29", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-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": "6fe120f4-2459-4994-bef6-95a2ae0cd3d7", "FormTypeField": { "FormTypeFieldId": "3afe782d-3b46-4f5b-9caf-e234781957be", "Section": { "FormTypeSectionId": "e22da173-36b6-49ad-8540-2487a43b850f", "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": "19de1fe9-b4d2-43b5-97fa-c3d32682f9f3", "Name": "sample string 1" }, "Unit": { "UnitId": "c14b644f-12cd-4544-b222-4cf06784a661", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "17c03897-8d02-4cb6-b7a9-c59fe86c7e29", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T12:27:30.2372819-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": "7b774ed6-5afc-4bf4-9d89-631f3eafd512", "CreateDate": "2024-04-25T12:27:30.2372819-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-25T12:27:30.2372819-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }