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": "fab61336-624c-4012-af2b-830e7b6945a2", "Asset": { "AssetId": "fa002776-6fd8-45ae-8ed4-ab33c26b9a82", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "21a950e4-5efe-4247-9ebf-e6ddbd9de835", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e0e9148e-cde6-4a00-b32a-3dfed403c689", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d90c8519-d9f8-42ed-b06b-4a023d6b8c72", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-01T18:05:19.0825898-07:00", "MeasurementValueNeededDate": "2024-05-01T18:05:19.0825898-07:00", "SourceSystemId": "sample string 3", "CompanyId": "50dd1f21-7bd4-42dc-82ab-5e4d47236d57", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-01T18:05:19.0825898-07:00", "MeasurementValueNeededDate": "2024-05-01T18:05:19.0825898-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e516aa0d-5c4f-45c5-a08e-692726e793e1", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "1ba1060a-a74f-4ce4-bdad-b9001aa0c4c1", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "21a950e4-5efe-4247-9ebf-e6ddbd9de835", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e0e9148e-cde6-4a00-b32a-3dfed403c689", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-01T18:05:19.0825898-07:00", "Fields": [ { "FormTypeFieldId": "d8ed1836-06da-446a-8e4e-48a05b0975bd", "Section": { "FormTypeSectionId": "0c410454-8597-40e7-97c5-e24a9b9f1375", "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": "01cf6c08-853b-4b21-889b-f9c1d3423ab6", "Name": "sample string 1" }, "Unit": { "UnitId": "d9f9aca1-45d7-4b24-a740-71b98240593a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "452a9234-3c33-4d61-8ffb-4bb1085af539", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-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": "d8ed1836-06da-446a-8e4e-48a05b0975bd", "Section": { "FormTypeSectionId": "0c410454-8597-40e7-97c5-e24a9b9f1375", "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": "01cf6c08-853b-4b21-889b-f9c1d3423ab6", "Name": "sample string 1" }, "Unit": { "UnitId": "d9f9aca1-45d7-4b24-a740-71b98240593a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "452a9234-3c33-4d61-8ffb-4bb1085af539", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-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": "b8966bc6-d464-4f11-9e0c-3b11f5bed98f", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-05-01T18:05:19.0825898-07:00", "Location": "sample string 1", "TaskId": "e531c616-59bc-4c3b-8247-63535f36754e", "Values": [ { "FormFieldValueId": "9df56549-3e41-4961-a99b-97acfd087274", "FormTypeField": { "FormTypeFieldId": "d8ed1836-06da-446a-8e4e-48a05b0975bd", "Section": { "FormTypeSectionId": "0c410454-8597-40e7-97c5-e24a9b9f1375", "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": "01cf6c08-853b-4b21-889b-f9c1d3423ab6", "Name": "sample string 1" }, "Unit": { "UnitId": "d9f9aca1-45d7-4b24-a740-71b98240593a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "452a9234-3c33-4d61-8ffb-4bb1085af539", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-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": "9df56549-3e41-4961-a99b-97acfd087274", "FormTypeField": { "FormTypeFieldId": "d8ed1836-06da-446a-8e4e-48a05b0975bd", "Section": { "FormTypeSectionId": "0c410454-8597-40e7-97c5-e24a9b9f1375", "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": "01cf6c08-853b-4b21-889b-f9c1d3423ab6", "Name": "sample string 1" }, "Unit": { "UnitId": "d9f9aca1-45d7-4b24-a740-71b98240593a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "452a9234-3c33-4d61-8ffb-4bb1085af539", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-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": "021f107a-67f0-49fa-bd2c-7a052887eade", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 5" }, { "FormId": "fab61336-624c-4012-af2b-830e7b6945a2", "Asset": { "AssetId": "fa002776-6fd8-45ae-8ed4-ab33c26b9a82", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "21a950e4-5efe-4247-9ebf-e6ddbd9de835", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e0e9148e-cde6-4a00-b32a-3dfed403c689", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d90c8519-d9f8-42ed-b06b-4a023d6b8c72", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-01T18:05:19.0825898-07:00", "MeasurementValueNeededDate": "2024-05-01T18:05:19.0825898-07:00", "SourceSystemId": "sample string 3", "CompanyId": "50dd1f21-7bd4-42dc-82ab-5e4d47236d57", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-01T18:05:19.0825898-07:00", "MeasurementValueNeededDate": "2024-05-01T18:05:19.0825898-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e516aa0d-5c4f-45c5-a08e-692726e793e1", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "1ba1060a-a74f-4ce4-bdad-b9001aa0c4c1", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "21a950e4-5efe-4247-9ebf-e6ddbd9de835", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e0e9148e-cde6-4a00-b32a-3dfed403c689", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-01T18:05:19.0825898-07:00", "Fields": [ { "FormTypeFieldId": "d8ed1836-06da-446a-8e4e-48a05b0975bd", "Section": { "FormTypeSectionId": "0c410454-8597-40e7-97c5-e24a9b9f1375", "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": "01cf6c08-853b-4b21-889b-f9c1d3423ab6", "Name": "sample string 1" }, "Unit": { "UnitId": "d9f9aca1-45d7-4b24-a740-71b98240593a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "452a9234-3c33-4d61-8ffb-4bb1085af539", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-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": "d8ed1836-06da-446a-8e4e-48a05b0975bd", "Section": { "FormTypeSectionId": "0c410454-8597-40e7-97c5-e24a9b9f1375", "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": "01cf6c08-853b-4b21-889b-f9c1d3423ab6", "Name": "sample string 1" }, "Unit": { "UnitId": "d9f9aca1-45d7-4b24-a740-71b98240593a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "452a9234-3c33-4d61-8ffb-4bb1085af539", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-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": "b8966bc6-d464-4f11-9e0c-3b11f5bed98f", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-05-01T18:05:19.0825898-07:00", "Location": "sample string 1", "TaskId": "e531c616-59bc-4c3b-8247-63535f36754e", "Values": [ { "FormFieldValueId": "9df56549-3e41-4961-a99b-97acfd087274", "FormTypeField": { "FormTypeFieldId": "d8ed1836-06da-446a-8e4e-48a05b0975bd", "Section": { "FormTypeSectionId": "0c410454-8597-40e7-97c5-e24a9b9f1375", "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": "01cf6c08-853b-4b21-889b-f9c1d3423ab6", "Name": "sample string 1" }, "Unit": { "UnitId": "d9f9aca1-45d7-4b24-a740-71b98240593a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "452a9234-3c33-4d61-8ffb-4bb1085af539", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-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": "9df56549-3e41-4961-a99b-97acfd087274", "FormTypeField": { "FormTypeFieldId": "d8ed1836-06da-446a-8e4e-48a05b0975bd", "Section": { "FormTypeSectionId": "0c410454-8597-40e7-97c5-e24a9b9f1375", "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": "01cf6c08-853b-4b21-889b-f9c1d3423ab6", "Name": "sample string 1" }, "Unit": { "UnitId": "d9f9aca1-45d7-4b24-a740-71b98240593a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "452a9234-3c33-4d61-8ffb-4bb1085af539", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T18:05:19.0825898-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": "021f107a-67f0-49fa-bd2c-7a052887eade", "CreateDate": "2024-05-01T18:05:19.0825898-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-01T18:05:19.0825898-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }