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": "b825dbe9-774e-4f60-a67c-981cff511ca5", "Asset": { "AssetId": "04f7fac5-11de-4d89-8fcf-dd4bf761fead", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d4fb9647-4e69-4e41-8c05-40e46a20696a", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a31c89c9-e98d-4522-8c4b-467e7fc4b14a", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fd7172a9-c0cb-4db7-a974-b8b6bb537471", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-10-10T03:35:12.2037578-07:00", "MeasurementValueNeededDate": "2024-10-10T03:35:12.2037578-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d6b9dbaa-4374-43ed-a079-a3c23974a7de", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-10-10T03:35:12.2037578-07:00", "MeasurementValueNeededDate": "2024-10-10T03:35:12.2037578-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "50b9dbc5-678e-4048-93b7-00e10c8df1a9", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "7c354e57-8869-46a7-90eb-bf75e32e53d7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d4fb9647-4e69-4e41-8c05-40e46a20696a", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a31c89c9-e98d-4522-8c4b-467e7fc4b14a", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-10-10T03:35:12.2037578-07:00", "Fields": [ { "FormTypeFieldId": "1a53269b-7493-4466-807f-65fd5fd16220", "Section": { "FormTypeSectionId": "e9351084-3852-4fa6-b9e2-e4479ba6c55d", "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": "a74a17f9-f90b-4ff7-b189-1e78e528c8e0", "Name": "sample string 1" }, "Unit": { "UnitId": "08ba3a52-696f-47eb-92ad-5c732fffe72c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "32ef5bc1-6d7d-4adc-b57c-7294e52f7fce", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-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": "1a53269b-7493-4466-807f-65fd5fd16220", "Section": { "FormTypeSectionId": "e9351084-3852-4fa6-b9e2-e4479ba6c55d", "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": "a74a17f9-f90b-4ff7-b189-1e78e528c8e0", "Name": "sample string 1" }, "Unit": { "UnitId": "08ba3a52-696f-47eb-92ad-5c732fffe72c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "32ef5bc1-6d7d-4adc-b57c-7294e52f7fce", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-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": "0e2a9e58-7e7d-4e80-8fce-0b0fee2c82e7", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-10-10T03:35:12.2037578-07:00", "Location": "sample string 1", "TaskId": "990f8089-2e8b-45b3-b98f-dc1811b6760f", "Values": [ { "FormFieldValueId": "cfc34743-fe1b-4207-9a9c-2d3224a5eb3f", "FormTypeField": { "FormTypeFieldId": "1a53269b-7493-4466-807f-65fd5fd16220", "Section": { "FormTypeSectionId": "e9351084-3852-4fa6-b9e2-e4479ba6c55d", "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": "a74a17f9-f90b-4ff7-b189-1e78e528c8e0", "Name": "sample string 1" }, "Unit": { "UnitId": "08ba3a52-696f-47eb-92ad-5c732fffe72c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "32ef5bc1-6d7d-4adc-b57c-7294e52f7fce", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-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": "cfc34743-fe1b-4207-9a9c-2d3224a5eb3f", "FormTypeField": { "FormTypeFieldId": "1a53269b-7493-4466-807f-65fd5fd16220", "Section": { "FormTypeSectionId": "e9351084-3852-4fa6-b9e2-e4479ba6c55d", "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": "a74a17f9-f90b-4ff7-b189-1e78e528c8e0", "Name": "sample string 1" }, "Unit": { "UnitId": "08ba3a52-696f-47eb-92ad-5c732fffe72c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "32ef5bc1-6d7d-4adc-b57c-7294e52f7fce", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-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": "856aa412-1e97-48b1-bfc6-9d0a7503fba0", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 5" }, { "FormId": "b825dbe9-774e-4f60-a67c-981cff511ca5", "Asset": { "AssetId": "04f7fac5-11de-4d89-8fcf-dd4bf761fead", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d4fb9647-4e69-4e41-8c05-40e46a20696a", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a31c89c9-e98d-4522-8c4b-467e7fc4b14a", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fd7172a9-c0cb-4db7-a974-b8b6bb537471", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-10-10T03:35:12.2037578-07:00", "MeasurementValueNeededDate": "2024-10-10T03:35:12.2037578-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d6b9dbaa-4374-43ed-a079-a3c23974a7de", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-10-10T03:35:12.2037578-07:00", "MeasurementValueNeededDate": "2024-10-10T03:35:12.2037578-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "50b9dbc5-678e-4048-93b7-00e10c8df1a9", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "7c354e57-8869-46a7-90eb-bf75e32e53d7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d4fb9647-4e69-4e41-8c05-40e46a20696a", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a31c89c9-e98d-4522-8c4b-467e7fc4b14a", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-10-10T03:35:12.2037578-07:00", "Fields": [ { "FormTypeFieldId": "1a53269b-7493-4466-807f-65fd5fd16220", "Section": { "FormTypeSectionId": "e9351084-3852-4fa6-b9e2-e4479ba6c55d", "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": "a74a17f9-f90b-4ff7-b189-1e78e528c8e0", "Name": "sample string 1" }, "Unit": { "UnitId": "08ba3a52-696f-47eb-92ad-5c732fffe72c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "32ef5bc1-6d7d-4adc-b57c-7294e52f7fce", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-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": "1a53269b-7493-4466-807f-65fd5fd16220", "Section": { "FormTypeSectionId": "e9351084-3852-4fa6-b9e2-e4479ba6c55d", "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": "a74a17f9-f90b-4ff7-b189-1e78e528c8e0", "Name": "sample string 1" }, "Unit": { "UnitId": "08ba3a52-696f-47eb-92ad-5c732fffe72c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "32ef5bc1-6d7d-4adc-b57c-7294e52f7fce", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-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": "0e2a9e58-7e7d-4e80-8fce-0b0fee2c82e7", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-10-10T03:35:12.2037578-07:00", "Location": "sample string 1", "TaskId": "990f8089-2e8b-45b3-b98f-dc1811b6760f", "Values": [ { "FormFieldValueId": "cfc34743-fe1b-4207-9a9c-2d3224a5eb3f", "FormTypeField": { "FormTypeFieldId": "1a53269b-7493-4466-807f-65fd5fd16220", "Section": { "FormTypeSectionId": "e9351084-3852-4fa6-b9e2-e4479ba6c55d", "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": "a74a17f9-f90b-4ff7-b189-1e78e528c8e0", "Name": "sample string 1" }, "Unit": { "UnitId": "08ba3a52-696f-47eb-92ad-5c732fffe72c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "32ef5bc1-6d7d-4adc-b57c-7294e52f7fce", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-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": "cfc34743-fe1b-4207-9a9c-2d3224a5eb3f", "FormTypeField": { "FormTypeFieldId": "1a53269b-7493-4466-807f-65fd5fd16220", "Section": { "FormTypeSectionId": "e9351084-3852-4fa6-b9e2-e4479ba6c55d", "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": "a74a17f9-f90b-4ff7-b189-1e78e528c8e0", "Name": "sample string 1" }, "Unit": { "UnitId": "08ba3a52-696f-47eb-92ad-5c732fffe72c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "32ef5bc1-6d7d-4adc-b57c-7294e52f7fce", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:35:12.2037578-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": "856aa412-1e97-48b1-bfc6-9d0a7503fba0", "CreateDate": "2024-10-10T03:35:12.2037578-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-10-10T03:35:12.2037578-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }