GET api/rsmPackages/search?entityId={entityId}&packageName={packageName}&startTimeFrom={startTimeFrom}&startTimeTo={startTimeTo}&lastRunForFrom={lastRunForFrom}&lastRunForTo={lastRunForTo}&userId={userId}&showOnlyGlobal={showOnlyGlobal}&showOnlyCustom={showOnlyCustom}
Search for packages with list of optional parameters
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
entityId |
Optional |
integer |
None. |
packageName |
Optional - LIKE search by name |
string |
None. |
startTimeFrom |
Optional - Last run date from |
date |
None. |
startTimeTo |
Optional - Last run date to |
date |
None. |
lastRunForFrom |
Optional - Month the report was ran for from |
date |
None. |
lastRunForTo |
Optional - Month the report was ran for to |
date |
None. |
userId |
User Id |
integer |
None. |
showOnlyGlobal |
False by default. If true, show only global packages. No other params should be sent if set to true |
boolean |
Default value is False |
showOnlyCustom |
|
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
RSMPackageViewModel
Collection of RSMPackageViewModelName | Description | Type | Additional information |
---|---|---|---|
Id |
ID |
integer |
None. |
EntityId |
GL Entity ID |
integer |
None. |
Name |
Package Name |
string |
Required |
Description |
Package Description |
string |
None. |
IncludeCover |
Include Cover |
boolean |
Required |
IncludeTOC |
Include TOC |
boolean |
Required |
StyleID |
StyleID |
integer |
Required |
CreatedOn |
Creation Date |
date |
None. |
CreatedBy |
Created by user's ID |
integer |
Required |
ModifiedOn |
Edited on |
date |
None. |
ModifiedBy |
Edited By |
integer |
None. |
IsActive |
Is Actve |
boolean |
None. |
LastRunDate |
Last Time Package was ran |
date |
None. |
IsArchived |
Soft deletion of packages |
boolean |
None. |
LastRunFor |
The Month in which the report was generated for Not when it was generated |
date |
None. |
RSMReports |
|
Collection of RSMReportViewModel |
None. |
Entity |
Entity |
EntityViewModel |
None. |
PackageReports |
List of reports and the order to generate them for the package |
Collection of RSMPackageReportViewModel |
None. |
PackageGlobalDocuments |
List of package global documents |
Collection of RSMPackageGlobalDocumentViewModel |
None. |
PackageExternalDocuments |
List of package external documents |
Collection of RSMPackageExtrenalDocumentViewModel |
None. |
History |
|
RSMPackageHistoryViewModel |
None. |
ReportStyle |
|
RSMReportStyleViewModel |
None. |