MixERP.Net.Api.Audit.LoggedActionController Class Reference

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Logged Actions. More...

Inheritance diagram for MixERP.Net.Api.Audit.LoggedActionController:

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "logged action" entity. More...
 
long Count ()
 Counts the number of logged actions. More...
 
IEnumerable< MixERP.Net.Entities.Audit.LoggedActionGet ()
 Returns collection of logged action for export. More...
 
MixERP.Net.Entities.Audit.LoggedAction Get (long eventId)
 Returns an instance of logged action. More...
 
IEnumerable< MixERP.Net.Entities.Audit.LoggedActionGet ([FromUri] long[] eventIds)
 
IEnumerable< MixERP.Net.Entities.Audit.LoggedActionGetPagedResult ()
 Creates a paginated collection containing 25 logged actions on each page, sorted by the property EventId. More...
 
IEnumerable< MixERP.Net.Entities.Audit.LoggedActionGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 logged actions on each page, sorted by the property EventId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of logged actions using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Audit.LoggedActionGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 logged actions on each page, sorted by the property EventId. More...
 
long CountFiltered (string filterName)
 Counts the number of logged actions using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Audit.LoggedActionGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 logged actions on each page, sorted by the property EventId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of logged actions. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for logged actions. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for logged actions. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of LoggedAction class. More...
 
void Add (MixERP.Net.Entities.Audit.LoggedAction loggedAction)
 Adds your instance of LoggedAction class. More...
 
void Edit (long eventId, [FromBody] MixERP.Net.Entities.Audit.LoggedAction loggedAction)
 Edits existing record with your instance of LoggedAction class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of LoggedAction class. More...
 
void Delete (long eventId)
 Deletes an existing instance of LoggedAction class via EventId. More...
 

Properties

long LoginId [get]
 
int UserId [get]
 
int OfficeId [get]
 
string Catalog [get]
 

Detailed Description

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Logged Actions.

Member Function Documentation

void MixERP.Net.Api.Audit.LoggedActionController.Add ( MixERP.Net.Entities.Audit.LoggedAction  loggedAction)

Adds your instance of LoggedAction class.

Parameters
loggedActionYour instance of logged actions class to add.
void MixERP.Net.Api.Audit.LoggedActionController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of LoggedAction class.

Parameters
loggedActionYour instance of logged actions class to add or edit.
List<object> MixERP.Net.Api.Audit.LoggedActionController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of LoggedAction class.

Parameters
collectionYour collection of LoggedAction class to bulk import.
Returns
Returns list of imported eventIds.
Exceptions
MixERPExceptionThrown when your any LoggedAction class in the collection is invalid or malformed.
long MixERP.Net.Api.Audit.LoggedActionController.Count ( )

Counts the number of logged actions.

Returns
Returns the count of the logged actions.
long MixERP.Net.Api.Audit.LoggedActionController.CountFiltered ( string  filterName)

Counts the number of logged actions using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered logged actions.
long MixERP.Net.Api.Audit.LoggedActionController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of logged actions using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered logged actions.
void MixERP.Net.Api.Audit.LoggedActionController.Delete ( long  eventId)

Deletes an existing instance of LoggedAction class via EventId.

Parameters
eventIdEnter the value for EventId in order to find and delete the existing record.
void MixERP.Net.Api.Audit.LoggedActionController.Edit ( long  eventId,
[FromBody] MixERP.Net.Entities.Audit.LoggedAction  loggedAction 
)

Edits existing record with your instance of LoggedAction class.

Parameters
loggedActionYour instance of LoggedAction class to edit.
eventIdEnter the value for EventId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Audit.LoggedAction> MixERP.Net.Api.Audit.LoggedActionController.Get ( )

Returns collection of logged action for export.

Returns
MixERP.Net.Entities.Audit.LoggedAction MixERP.Net.Api.Audit.LoggedActionController.Get ( long  eventId)

Returns an instance of logged action.

Parameters
eventIdEnter EventId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Audit.LoggedActionController.GetCustomFields ( )

A custom field is a user defined field for logged actions.

Returns
Returns an enumerable custom field collection of logged actions.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Audit.LoggedActionController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for logged actions.

Returns
Returns an enumerable custom field collection of logged actions.
IEnumerable<DisplayField> MixERP.Net.Api.Audit.LoggedActionController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of logged actions.

Returns
Returns an enumerable key/value collection of logged actions.
EntityView MixERP.Net.Api.Audit.LoggedActionController.GetEntityView ( )

Creates meta information of "logged action" entity.

Returns
Returns the "logged action" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Audit.LoggedAction> MixERP.Net.Api.Audit.LoggedActionController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 logged actions on each page, sorted by the property EventId.

Parameters
pageNumberEnter the page number to produce the resultset.
filterNameThe named filter.
Returns
Returns the requested page from the collection using the supplied filters.
IEnumerable<MixERP.Net.Entities.Audit.LoggedAction> MixERP.Net.Api.Audit.LoggedActionController.GetPagedResult ( )

Creates a paginated collection containing 25 logged actions on each page, sorted by the property EventId.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Audit.LoggedAction> MixERP.Net.Api.Audit.LoggedActionController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 logged actions on each page, sorted by the property EventId.

Parameters
pageNumberEnter the page number to produce the resultset.
Returns
Returns the requested page from the collection.
IEnumerable<MixERP.Net.Entities.Audit.LoggedAction> MixERP.Net.Api.Audit.LoggedActionController.GetWhere ( long  pageNumber,
[FromBody] dynamic  filters 
)

Creates a filtered and paginated collection containing 25 logged actions on each page, sorted by the property EventId.

Parameters
pageNumberEnter the page number to produce the resultset.
filtersThe list of filter conditions.
Returns
Returns the requested page from the collection using the supplied filters.

The documentation for this class was generated from the following file: