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": "c05e9c27-d3e1-4a48-89d7-fa2d930d9110", "Asset": { "AssetId": "e716370d-d0bd-4074-850d-73d8f65789eb", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "3d8f0ab6-e766-48c1-9558-c5b3ccd747e7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9d82962f-f5bf-4dfb-8ac3-64cfd89dd263", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "eb127db6-635a-44c8-8ca8-e1b62d7b1cc4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-25T01:06:25.3291411-07:00", "MeasurementValueNeededDate": "2025-04-25T01:06:25.3291411-07:00", "SourceSystemId": "sample string 3", "CompanyId": "82c58601-2f00-4006-883e-4ded8acddd9f", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-04-25T01:06:25.3291411-07:00", "MeasurementValueNeededDate": "2025-04-25T01:06:25.3291411-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a3eb087a-1fe7-49ab-801e-6a80d69aedd1", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "6724828b-284e-4072-83ac-df7a4072c6f6", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "3d8f0ab6-e766-48c1-9558-c5b3ccd747e7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9d82962f-f5bf-4dfb-8ac3-64cfd89dd263", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-25T01:06:25.3291411-07:00", "Fields": [ { "FormTypeFieldId": "54e95080-b495-4acc-8897-83f428ac76aa", "Section": { "FormTypeSectionId": "b5f47e5c-4277-4b01-a1ac-9127b7965388", "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": "80e43ca9-6372-4d59-b24e-468c64f9c83b", "Name": "sample string 1" }, "Unit": { "UnitId": "4fffee32-6bf8-4f41-aec9-fded64095fec", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "437d9ec2-6d11-4d73-af6c-a22ca5d82bb1", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-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": "54e95080-b495-4acc-8897-83f428ac76aa", "Section": { "FormTypeSectionId": "b5f47e5c-4277-4b01-a1ac-9127b7965388", "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": "80e43ca9-6372-4d59-b24e-468c64f9c83b", "Name": "sample string 1" }, "Unit": { "UnitId": "4fffee32-6bf8-4f41-aec9-fded64095fec", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "437d9ec2-6d11-4d73-af6c-a22ca5d82bb1", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-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": "032deb83-0ce9-47ce-b484-96a657c16513", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-04-25T01:06:25.3291411-07:00", "Location": "sample string 1", "TaskId": "078d1dec-3267-4517-8f5e-60aad6deb3d1", "Values": [ { "FormFieldValueId": "1b8f42ef-5930-4d3b-92ec-9a8f6ac5ed1b", "FormTypeField": { "FormTypeFieldId": "54e95080-b495-4acc-8897-83f428ac76aa", "Section": { "FormTypeSectionId": "b5f47e5c-4277-4b01-a1ac-9127b7965388", "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": "80e43ca9-6372-4d59-b24e-468c64f9c83b", "Name": "sample string 1" }, "Unit": { "UnitId": "4fffee32-6bf8-4f41-aec9-fded64095fec", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "437d9ec2-6d11-4d73-af6c-a22ca5d82bb1", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-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": "1b8f42ef-5930-4d3b-92ec-9a8f6ac5ed1b", "FormTypeField": { "FormTypeFieldId": "54e95080-b495-4acc-8897-83f428ac76aa", "Section": { "FormTypeSectionId": "b5f47e5c-4277-4b01-a1ac-9127b7965388", "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": "80e43ca9-6372-4d59-b24e-468c64f9c83b", "Name": "sample string 1" }, "Unit": { "UnitId": "4fffee32-6bf8-4f41-aec9-fded64095fec", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "437d9ec2-6d11-4d73-af6c-a22ca5d82bb1", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-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": "0c02d37d-b5b6-45ed-a27a-64a96f94d3fb", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 5" }, { "FormId": "c05e9c27-d3e1-4a48-89d7-fa2d930d9110", "Asset": { "AssetId": "e716370d-d0bd-4074-850d-73d8f65789eb", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "3d8f0ab6-e766-48c1-9558-c5b3ccd747e7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9d82962f-f5bf-4dfb-8ac3-64cfd89dd263", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "eb127db6-635a-44c8-8ca8-e1b62d7b1cc4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-25T01:06:25.3291411-07:00", "MeasurementValueNeededDate": "2025-04-25T01:06:25.3291411-07:00", "SourceSystemId": "sample string 3", "CompanyId": "82c58601-2f00-4006-883e-4ded8acddd9f", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-04-25T01:06:25.3291411-07:00", "MeasurementValueNeededDate": "2025-04-25T01:06:25.3291411-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a3eb087a-1fe7-49ab-801e-6a80d69aedd1", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "6724828b-284e-4072-83ac-df7a4072c6f6", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "3d8f0ab6-e766-48c1-9558-c5b3ccd747e7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9d82962f-f5bf-4dfb-8ac3-64cfd89dd263", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-25T01:06:25.3291411-07:00", "Fields": [ { "FormTypeFieldId": "54e95080-b495-4acc-8897-83f428ac76aa", "Section": { "FormTypeSectionId": "b5f47e5c-4277-4b01-a1ac-9127b7965388", "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": "80e43ca9-6372-4d59-b24e-468c64f9c83b", "Name": "sample string 1" }, "Unit": { "UnitId": "4fffee32-6bf8-4f41-aec9-fded64095fec", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "437d9ec2-6d11-4d73-af6c-a22ca5d82bb1", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-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": "54e95080-b495-4acc-8897-83f428ac76aa", "Section": { "FormTypeSectionId": "b5f47e5c-4277-4b01-a1ac-9127b7965388", "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": "80e43ca9-6372-4d59-b24e-468c64f9c83b", "Name": "sample string 1" }, "Unit": { "UnitId": "4fffee32-6bf8-4f41-aec9-fded64095fec", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "437d9ec2-6d11-4d73-af6c-a22ca5d82bb1", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-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": "032deb83-0ce9-47ce-b484-96a657c16513", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-04-25T01:06:25.3291411-07:00", "Location": "sample string 1", "TaskId": "078d1dec-3267-4517-8f5e-60aad6deb3d1", "Values": [ { "FormFieldValueId": "1b8f42ef-5930-4d3b-92ec-9a8f6ac5ed1b", "FormTypeField": { "FormTypeFieldId": "54e95080-b495-4acc-8897-83f428ac76aa", "Section": { "FormTypeSectionId": "b5f47e5c-4277-4b01-a1ac-9127b7965388", "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": "80e43ca9-6372-4d59-b24e-468c64f9c83b", "Name": "sample string 1" }, "Unit": { "UnitId": "4fffee32-6bf8-4f41-aec9-fded64095fec", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "437d9ec2-6d11-4d73-af6c-a22ca5d82bb1", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-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": "1b8f42ef-5930-4d3b-92ec-9a8f6ac5ed1b", "FormTypeField": { "FormTypeFieldId": "54e95080-b495-4acc-8897-83f428ac76aa", "Section": { "FormTypeSectionId": "b5f47e5c-4277-4b01-a1ac-9127b7965388", "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": "80e43ca9-6372-4d59-b24e-468c64f9c83b", "Name": "sample string 1" }, "Unit": { "UnitId": "4fffee32-6bf8-4f41-aec9-fded64095fec", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "437d9ec2-6d11-4d73-af6c-a22ca5d82bb1", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T01:06:25.3291411-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": "0c02d37d-b5b6-45ed-a27a-64a96f94d3fb", "CreateDate": "2025-04-25T01:06:25.3291411-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-25T01:06:25.3291411-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }