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": "a45dbbc2-952c-440e-9c67-a4a17795e5f4", "Asset": { "AssetId": "dcd72abe-c932-4869-b5ae-6c5a974ecced", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "bb7c0c00-2c84-4a5f-972e-0d24902d7ec6", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0a41022d-a48e-4e62-a527-b5100f844830", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "a5dd210d-810f-4bda-8fc6-30f0caf814a6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T12:23:22.4612576-08:00", "MeasurementValueNeededDate": "2023-12-01T12:23:22.4612576-08:00", "SourceSystemId": "sample string 3", "CompanyId": "9fedbbc1-7123-4244-96b1-a5c3f60bc12f", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2023-12-01T12:23:22.4612576-08:00", "MeasurementValueNeededDate": "2023-12-01T12:23:22.4612576-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b9d24d1f-f44a-45bd-ad8f-9f83c8d42ea7", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "d7c17063-e481-42cc-a466-4a5e19d2f78a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bb7c0c00-2c84-4a5f-972e-0d24902d7ec6", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0a41022d-a48e-4e62-a527-b5100f844830", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2023-12-01T12:23:22.4612576-08:00", "Fields": [ { "FormTypeFieldId": "8bab8862-ff4e-430b-9b15-8dd477ac7bd6", "Section": { "FormTypeSectionId": "36e611c5-ff57-497a-8626-6e7b7c076cd7", "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": "4283d446-f1e5-44bb-88e9-1ac96a5da818", "Name": "sample string 1" }, "Unit": { "UnitId": "f8f431c7-75d3-41fc-824d-0ac23a5050dd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "44300a25-caa9-4cca-a6a4-36392186bda3", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08: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": "8bab8862-ff4e-430b-9b15-8dd477ac7bd6", "Section": { "FormTypeSectionId": "36e611c5-ff57-497a-8626-6e7b7c076cd7", "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": "4283d446-f1e5-44bb-88e9-1ac96a5da818", "Name": "sample string 1" }, "Unit": { "UnitId": "f8f431c7-75d3-41fc-824d-0ac23a5050dd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "44300a25-caa9-4cca-a6a4-36392186bda3", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08: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": "612e09ef-1519-469d-9b35-993bf91ca818", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2023-12-01T12:23:22.4612576-08:00", "Location": "sample string 1", "TaskId": "21d3fca6-242c-42ca-a3ab-7818a983fc01", "Values": [ { "FormFieldValueId": "33284537-bd45-4fdd-9a2b-318eca4dcb05", "FormTypeField": { "FormTypeFieldId": "8bab8862-ff4e-430b-9b15-8dd477ac7bd6", "Section": { "FormTypeSectionId": "36e611c5-ff57-497a-8626-6e7b7c076cd7", "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": "4283d446-f1e5-44bb-88e9-1ac96a5da818", "Name": "sample string 1" }, "Unit": { "UnitId": "f8f431c7-75d3-41fc-824d-0ac23a5050dd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "44300a25-caa9-4cca-a6a4-36392186bda3", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08: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": "33284537-bd45-4fdd-9a2b-318eca4dcb05", "FormTypeField": { "FormTypeFieldId": "8bab8862-ff4e-430b-9b15-8dd477ac7bd6", "Section": { "FormTypeSectionId": "36e611c5-ff57-497a-8626-6e7b7c076cd7", "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": "4283d446-f1e5-44bb-88e9-1ac96a5da818", "Name": "sample string 1" }, "Unit": { "UnitId": "f8f431c7-75d3-41fc-824d-0ac23a5050dd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "44300a25-caa9-4cca-a6a4-36392186bda3", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08: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": "2a7d1990-f16a-4932-9282-f1b09a0cdd77", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 5" }, { "FormId": "a45dbbc2-952c-440e-9c67-a4a17795e5f4", "Asset": { "AssetId": "dcd72abe-c932-4869-b5ae-6c5a974ecced", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "bb7c0c00-2c84-4a5f-972e-0d24902d7ec6", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0a41022d-a48e-4e62-a527-b5100f844830", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "a5dd210d-810f-4bda-8fc6-30f0caf814a6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T12:23:22.4612576-08:00", "MeasurementValueNeededDate": "2023-12-01T12:23:22.4612576-08:00", "SourceSystemId": "sample string 3", "CompanyId": "9fedbbc1-7123-4244-96b1-a5c3f60bc12f", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2023-12-01T12:23:22.4612576-08:00", "MeasurementValueNeededDate": "2023-12-01T12:23:22.4612576-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b9d24d1f-f44a-45bd-ad8f-9f83c8d42ea7", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "d7c17063-e481-42cc-a466-4a5e19d2f78a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bb7c0c00-2c84-4a5f-972e-0d24902d7ec6", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0a41022d-a48e-4e62-a527-b5100f844830", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2023-12-01T12:23:22.4612576-08:00", "Fields": [ { "FormTypeFieldId": "8bab8862-ff4e-430b-9b15-8dd477ac7bd6", "Section": { "FormTypeSectionId": "36e611c5-ff57-497a-8626-6e7b7c076cd7", "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": "4283d446-f1e5-44bb-88e9-1ac96a5da818", "Name": "sample string 1" }, "Unit": { "UnitId": "f8f431c7-75d3-41fc-824d-0ac23a5050dd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "44300a25-caa9-4cca-a6a4-36392186bda3", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08: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": "8bab8862-ff4e-430b-9b15-8dd477ac7bd6", "Section": { "FormTypeSectionId": "36e611c5-ff57-497a-8626-6e7b7c076cd7", "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": "4283d446-f1e5-44bb-88e9-1ac96a5da818", "Name": "sample string 1" }, "Unit": { "UnitId": "f8f431c7-75d3-41fc-824d-0ac23a5050dd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "44300a25-caa9-4cca-a6a4-36392186bda3", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08: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": "612e09ef-1519-469d-9b35-993bf91ca818", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2023-12-01T12:23:22.4612576-08:00", "Location": "sample string 1", "TaskId": "21d3fca6-242c-42ca-a3ab-7818a983fc01", "Values": [ { "FormFieldValueId": "33284537-bd45-4fdd-9a2b-318eca4dcb05", "FormTypeField": { "FormTypeFieldId": "8bab8862-ff4e-430b-9b15-8dd477ac7bd6", "Section": { "FormTypeSectionId": "36e611c5-ff57-497a-8626-6e7b7c076cd7", "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": "4283d446-f1e5-44bb-88e9-1ac96a5da818", "Name": "sample string 1" }, "Unit": { "UnitId": "f8f431c7-75d3-41fc-824d-0ac23a5050dd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "44300a25-caa9-4cca-a6a4-36392186bda3", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08: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": "33284537-bd45-4fdd-9a2b-318eca4dcb05", "FormTypeField": { "FormTypeFieldId": "8bab8862-ff4e-430b-9b15-8dd477ac7bd6", "Section": { "FormTypeSectionId": "36e611c5-ff57-497a-8626-6e7b7c076cd7", "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": "4283d446-f1e5-44bb-88e9-1ac96a5da818", "Name": "sample string 1" }, "Unit": { "UnitId": "f8f431c7-75d3-41fc-824d-0ac23a5050dd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "44300a25-caa9-4cca-a6a4-36392186bda3", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08: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": "2a7d1990-f16a-4932-9282-f1b09a0cdd77", "CreateDate": "2023-12-01T12:23:22.4612576-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2023-12-01T12:23:22.4612576-08:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }