PUT api/rsmPackages

Update a package ModifiedOn, ModifiedBy, and at least 1 report is required

Request Information

URI Parameters

None.

Body Parameters

RSMPackageViewModel
NameDescriptionTypeAdditional 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.

Response Information

Resource Description

RSMPackageViewModel

RSMPackageViewModel
NameDescriptionTypeAdditional 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.