@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias AuditLogResult

    Audit log item.

    type AuditLogResult = {
        actorId?: string;
        actorType?: AuditLogActorTypeEnum;
        agentElementId?: string;
        annotation?: string;
        auditLogKey?: AuditLogKey;
        batchOperationKey?: BatchOperationKey;
        batchOperationType?: BatchOperationTypeEnum;
        category?: AuditLogCategoryEnum;
        decisionDefinitionId?: DecisionDefinitionId;
        decisionDefinitionKey?: DecisionDefinitionKey;
        decisionEvaluationKey?: DecisionEvaluationKey;
        decisionRequirementsId?: string;
        decisionRequirementsKey?: DecisionRequirementsKey;
        deploymentKey?: DeploymentKey;
        elementInstanceKey?: ElementInstanceKey;
        entityDescription?: string;
        entityKey?: AuditLogEntityKey;
        entityType?: AuditLogEntityTypeEnum;
        formKey?: FormKey;
        jobKey?: JobKey;
        operationType?: AuditLogOperationTypeEnum;
        processDefinitionId?: ProcessDefinitionId;
        processDefinitionKey?: ProcessDefinitionKey;
        processInstanceKey?: ProcessInstanceKey;
        relatedEntityKey?: AuditLogEntityKey;
        relatedEntityType?: AuditLogEntityTypeEnum;
        resourceKey?: ResourceKey;
        result?: AuditLogResultEnum;
        rootProcessInstanceKey?: RootProcessInstanceKey;
        tenantId?: TenantId;
        timestamp?: string;
        userTaskKey?: UserTaskKey;
    }
    Index

    Properties

    actorId? actorType? agentElementId? annotation? auditLogKey? batchOperationKey? batchOperationType? category? decisionDefinitionId? decisionDefinitionKey? decisionEvaluationKey? decisionRequirementsId? decisionRequirementsKey? deploymentKey? elementInstanceKey? entityDescription? entityKey? entityType? formKey? jobKey? operationType? processDefinitionId? processDefinitionKey? processInstanceKey? relatedEntityKey? relatedEntityType? resourceKey? result? rootProcessInstanceKey? tenantId? timestamp? userTaskKey?

    Properties

    actorId?: string

    The ID of the actor who performed the operation.

    actorType?: AuditLogActorTypeEnum
    agentElementId?: string

    The element ID of the agent that performed the operation (e.g. ad-hoc subprocess element ID).

    annotation?: string

    Additional notes about the operation.

    auditLogKey?: AuditLogKey

    The unique key of the audit log entry.

    batchOperationKey?: BatchOperationKey

    Key of the batch operation.

    batchOperationType?: BatchOperationTypeEnum

    The type of batch operation performed, if this is part of a batch.

    category?: AuditLogCategoryEnum
    decisionDefinitionId?: DecisionDefinitionId

    The decision definition ID.

    decisionDefinitionKey?: DecisionDefinitionKey

    The key of the decision definition.

    decisionEvaluationKey?: DecisionEvaluationKey

    The key of the decision evaluation.

    decisionRequirementsId?: string

    The decision requirements ID.

    decisionRequirementsKey?: DecisionRequirementsKey

    The assigned key of the decision requirements.

    deploymentKey?: DeploymentKey

    The key of the deployment.

    elementInstanceKey?: ElementInstanceKey

    The key of the element instance.

    entityDescription?: string

    Additional description of the entity affected by the operation. For example, for variable operations, this will contain the variable name.

    entityKey?: AuditLogEntityKey
    entityType?: AuditLogEntityTypeEnum
    formKey?: FormKey

    The key of the form.

    jobKey?: JobKey

    The key of the job.

    operationType?: AuditLogOperationTypeEnum
    processDefinitionId?: ProcessDefinitionId

    The process definition ID.

    processDefinitionKey?: ProcessDefinitionKey

    The key of the process definition.

    processInstanceKey?: ProcessInstanceKey

    The key of the process instance.

    relatedEntityKey?: AuditLogEntityKey

    The key of the related entity. The content depends on the operation type and entity type. For example, for authorization operations, this will contain the ID of the owner (e.g., user or group) the authorization belongs to.

    relatedEntityType?: AuditLogEntityTypeEnum

    The type of the related entity. The content depends on the operation type and entity type. For example, for authorization operations, this will contain the type of the owner (e.g., USER or GROUP) the authorization belongs to.

    resourceKey?: ResourceKey

    The system-assigned key for this resource.

    result?: AuditLogResultEnum
    rootProcessInstanceKey?: RootProcessInstanceKey
    tenantId?: TenantId

    The tenant ID of the audit log.

    timestamp?: string

    The timestamp when the operation occurred.

    userTaskKey?: UserTaskKey

    The key of the user task.

    Settings

    Member Visibility

    On This Page

    Properties