POST api/Reports/EVaultActivityLogSearch

Allows a user to search for eVault activity logs.

Request Information

URI Parameters

None.

Body Parameters

The eVault activity log search criteria

ESignSystems.SmartSAFE.Models.Reports.EVaultActivityLogSearchCriteria
NameDescriptionTypeAdditional information
StartActivityDate

Gets or sets property to search for eVault activity logs created after the given date.

date

Required

EndActivityDate

Gets or sets property to search for eVault activity logs created before the given date.

date

Required

Username

Gets or sets the user's username.

string

None.

OrganizationId

Gets or sets the organization's identifier.

integer

None.

ClientId

Gets or sets the client's identifier.

integer

None.

EVaultActivityTypeId

Gets or sets property to search by eVault activity type identifier.

integer

None.

Name

Gets or sets property to search by document or folder name.

string

None.

PageSize

Gets or sets the number of rows in the page.

integer

Range: inclusive between 1 and 2147483647

PageOffset

Gets or sets the offset page to return.

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "StartActivityDate": "2024-11-26T17:19:31.881841-05:00",
  "EndActivityDate": "2024-11-26T17:19:31.881841-05:00",
  "Username": "sample string 1",
  "OrganizationId": 1,
  "ClientId": 1,
  "EVaultActivityTypeId": 1,
  "Name": "sample string 2",
  "PageSize": 1,
  "PageOffset": 3
}

application/xml, text/xml

Sample:
<EVaultActivityLogSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports">
  <PageOffset xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">3</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <ClientId>1</ClientId>
  <EVaultActivityTypeId>1</EVaultActivityTypeId>
  <EndActivityDate>2024-11-26T17:19:31.881841-05:00</EndActivityDate>
  <Name>sample string 2</Name>
  <OrganizationId>1</OrganizationId>
  <StartActivityDate>2024-11-26T17:19:31.881841-05:00</StartActivityDate>
  <Username>sample string 1</Username>
</EVaultActivityLogSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of eVault activity logs resulting from the search.

Collection of ESignSystems.SmartSAFE.Models.Reports.EVaultActivityLogModel
NameDescriptionTypeAdditional information
EVaultActivityLogId

Gets or sets the eVault activity log identifier.

integer

None.

Username

Gets or sets the user's username.

string

None.

UserFullName

Gets or sets the user's first and last name.

string

None.

EVaultActivityType

Gets or sets eVault activity type lookup value.

string

None.

Name

Gets or sets the document or folder name.

string

None.

IPAddress

Gets or sets the ip address.

string

None.

UpdatedBy

Gets or sets the name of the user that updated the model.

string

None.

UpdatedDate

Gets or sets the date an time that the model was updated.

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "EVaultActivityLogId": 1,
    "Username": "sample string 2",
    "UserFullName": "sample string 3",
    "EVaultActivityType": "sample string 4",
    "Name": "sample string 5",
    "IPAddress": "sample string 6",
    "UpdatedBy": "sample string 7",
    "UpdatedDate": "2024-11-26T17:19:31.8974271-05:00"
  },
  {
    "EVaultActivityLogId": 1,
    "Username": "sample string 2",
    "UserFullName": "sample string 3",
    "EVaultActivityType": "sample string 4",
    "Name": "sample string 5",
    "IPAddress": "sample string 6",
    "UpdatedBy": "sample string 7",
    "UpdatedDate": "2024-11-26T17:19:31.8974271-05:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfEVaultActivityLogModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports">
  <EVaultActivityLogModel>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 7</UpdatedBy>
    <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:19:31.8974271-05:00</UpdatedDate>
    <EVaultActivityLogId>1</EVaultActivityLogId>
    <EVaultActivityType>sample string 4</EVaultActivityType>
    <IPAddress>sample string 6</IPAddress>
    <Name>sample string 5</Name>
    <UserFullName>sample string 3</UserFullName>
    <Username>sample string 2</Username>
  </EVaultActivityLogModel>
  <EVaultActivityLogModel>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 7</UpdatedBy>
    <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:19:31.8974271-05:00</UpdatedDate>
    <EVaultActivityLogId>1</EVaultActivityLogId>
    <EVaultActivityType>sample string 4</EVaultActivityType>
    <IPAddress>sample string 6</IPAddress>
    <Name>sample string 5</Name>
    <UserFullName>sample string 3</UserFullName>
    <Username>sample string 2</Username>
  </EVaultActivityLogModel>
</ArrayOfEVaultActivityLogModel>