Method SetAuditConfiguration
SetAuditConfiguration(String, AuditConfigurationContract)
Set Audit configuration
Declaration
void SetAuditConfiguration(string connectionId, AuditConfigurationContract auditConfiguration)
Parameters
Type | Name | Description |
---|---|---|
System.String | connectionId | The connection id to identify your connection. See also ConnectionId |
AuditConfigurationContract | auditConfiguration | The configuration parameter of Audit. See also AuditConfigurationContract |
Remarks
- You need "Access to scheme" access right (01002060-38a7-11d8-a902-0050bf427e8f). See also GetUserAdminAccessRights(String, String)
Examples
POST http://YourServerName/InfoShare/Json/Common/SetAuditConfiguration
Example for setting the audit configuration.{
"connectionId": "f2178c68-e6c5-46a8-8dc1-d26ac99f287a"
"auditConfiguration": {
"LogAdministrativeChanges": true,
"LogAuthentication": true,
"LogDocumentOperations": false,
"ProtectFromDelete": false,
"CleanUpModeEnum": "Weekly",
"CleanUpDay": 3,
"CleanUpTime": "11:34:00",
"RetentionDaysAdministrationChanges": 3,
"RetentionDaysAuthentication": 2,
"RetentionDaysDocumentOperations": 4,
"ImportTemplateId": "2791B53F-FB6C-4EE6-BDED-AEAA4E068164",
"ProcessTemplateIdOnError": null,
"ProcessTemplateIdOnSuccess": null }
}
Response:
{ }
Exceptions
Type | Condition |
---|---|
ServiceException | The connection id {connectionId} isn't valid or has expired (10008) |
ServiceException | Feature code licence not exists (10112) |
ServiceException | The administrative context {administrativeContext} is already checked out by user {displayLoginName} (10129) |
ServiceException | Verification code is needed: Verification code not yet verified (10152) |
ServiceException | Value {auditConfiguration.CleanUpModeEnum} is not defined in enumeration {CleanUpModeEnum} (10254) |
ServiceException | String was not recognized as a valid Time: {timeValue}. Expected format {expectedFormat} (10398) |