adTempus API
ArcanaDevelopment.adTempus.Client Namespace / JobServices Class / DeleteInstances Method
The OID(s) of the instance(s) to delete.

In This Topic
    DeleteInstances Method
    In This Topic
    Deletes the specified instances from the job history
    Syntax
    'Declaration
     
    
    <RequiredVersionAttribute(5, 
       1, 
       272, 
       0)>
    Public Sub DeleteInstances( _
       ByVal instanceOIDs() As OID _
    ) 
    [RequiredVersion(5, 
       1, 
       272, 
       0)]
    public void DeleteInstances( 
       OID[] instanceOIDs
    )

    Parameters

    instanceOIDs
    The OID(s) of the instance(s) to delete.
    Remarks

    Requires ServerVersion 5.1.272 or later.

    This method queues the specified instance(s) for deletion and returns immediately. Deletion may take several seconds or longer to complete. No feedback is provided about the status of the request.

    This functionality is disabled by default. To enable it, you must set the "InstanceDeletion:Allow" server option to True. By default only members of the adTempus Administrators group are allowed to delete instances. If the "InstanceDeletion:RequireAdminPermission" server option is False, any user with Modify permission for a job is allowed to delete instances for that job.

    If instances are submitted for multiple jobs and the user does not have permission to delete instances for any of those jobs, the method fails with a ArcanaDevelopment.adTempus.Shared.PermissionDeniedException and no instances are deleted (including those the caller has permission for).

    Deleting instances using this method does not recalculate statistics stored in the JobStatus.

    See Also