Skip to main content
Version: 8.9 (unreleased)

Function: createCamundaClientLoose()

function createCamundaClientLoose(...args): object;

Defined in: loose.ts:43

Create a client where all branded key types are widened to string. Use when integrating with external systems or when dynamic string keys are common and brand friction is unwanted. For maximum type safety prefer the strict createCamundaClient.

Parameters​

args​

...[CamundaOptions]

Returns​

object

config​

config: object;

config.__raw​

readonly __raw: object;
Index Signature​
[key: string]: string | undefined

config.auth​

readonly auth: object;

config.auth.basic?​

optional basic: object;

config.auth.basic.password?​

optional password: string;

config.auth.basic.username?​

optional username: string;

config.auth.strategy​

strategy: AuthStrategy;

config.backpressure​

readonly backpressure: object;

config.backpressure.decayQuietMs​

decayQuietMs: number;

config.backpressure.enabled​

enabled: boolean;

config.backpressure.floor​

floor: number;

config.backpressure.initialMax​

initialMax: number;

config.backpressure.observeOnly​

observeOnly: boolean;

config.backpressure.profile​

profile: string;

config.backpressure.recoveryIntervalMs​

recoveryIntervalMs: number;

config.backpressure.recoveryStep​

recoveryStep: number;

config.backpressure.severeFactor​

severeFactor: number;

config.backpressure.severeThreshold​

severeThreshold: number;

config.backpressure.softFactor​

softFactor: number;

config.defaultTenantId​

readonly defaultTenantId: string;

config.eventual?​

readonly optional eventual: object;

config.eventual.pollDefaultMs​

pollDefaultMs: number;

config.httpRetry​

readonly httpRetry: object;

config.httpRetry.baseDelayMs​

baseDelayMs: number;

config.httpRetry.maxAttempts​

maxAttempts: number;

config.httpRetry.maxDelayMs​

maxDelayMs: number;

config.logLevel​

readonly logLevel: "trace" | "error" | "silent" | "warn" | "info" | "debug";

config.mtls?​

readonly optional mtls: object;

config.mtls.ca?​

optional ca: string;

config.mtls.caPath?​

optional caPath: string;

config.mtls.cert?​

optional cert: string;

config.mtls.certPath?​

optional certPath: string;

config.mtls.key?​

optional key: string;

config.mtls.keyPassphrase?​

optional keyPassphrase: string;

config.mtls.keyPath?​

optional keyPath: string;

config.oauth​

readonly oauth: object;

config.oauth.cacheDir?​

optional cacheDir: string;

config.oauth.clientId?​

optional clientId: string;

config.oauth.clientSecret?​

optional clientSecret: string;

config.oauth.grantType​

grantType: string;

config.oauth.oauthUrl​

oauthUrl: string;

config.oauth.retry​

retry: object;

config.oauth.retry.baseDelayMs​

baseDelayMs: number;

config.oauth.retry.max​

max: number;

config.oauth.scope?​

optional scope: string;

config.oauth.timeoutMs​

timeoutMs: number;

config.restAddress​

readonly restAddress: string;

config.supportLog?​

readonly optional supportLog: object;

config.supportLog.enabled​

enabled: boolean;

config.supportLog.filePath​

filePath: string;

config.telemetry?​

readonly optional telemetry: object;

config.telemetry.correlation​

correlation: boolean;

config.telemetry.log​

log: boolean;

config.tokenAudience​

readonly tokenAudience: string;

config.validation​

readonly validation: object;

config.validation.raw​

raw: string;

config.validation.req​

req: ValidationMode;

config.validation.res​

res: ValidationMode;

_getSupportLogger()​

_getSupportLogger(...a): object;

Parameters​

a​

...[]

Returns​

object

log()​
log(...a): void;
Parameters​
a​

...[string | number | boolean | object, boolean]

Returns​

void

_invokeWithRetry()​

_invokeWithRetry(...a): Promise<unknown>;

Parameters​

a​

...[(...a) => Promise<unknown>, object]

Returns​

Promise<unknown>

activateAdHocSubProcessActivities()​

activateAdHocSubProcessActivities(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

activateJobs()​

activateJobs(...a): CancelablePromise<{
  jobs: object[];
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ jobs: object[]; }>

assignClientToGroup()​

assignClientToGroup(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignClientToTenant()​

assignClientToTenant(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignGroupToTenant()​

assignGroupToTenant(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignMappingRuleToGroup()​

assignMappingRuleToGroup(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignMappingRuleToTenant()​

assignMappingRuleToTenant(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignRoleToClient()​

assignRoleToClient(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignRoleToGroup()​

assignRoleToGroup(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignRoleToMappingRule()​

assignRoleToMappingRule(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignRoleToTenant()​

assignRoleToTenant(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignRoleToUser()​

assignRoleToUser(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignUserTask()​

assignUserTask(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignUserToGroup()​

assignUserToGroup(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

assignUserToTenant()​

assignUserToTenant(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

broadcastSignal()​

broadcastSignal(...a): CancelablePromise<{
  signalKey: string;
  tenantId: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ signalKey: string; tenantId: string; }>

cancelBatchOperation()​

cancelBatchOperation(...a): CancelablePromise<void>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

cancelProcessInstance()​

cancelProcessInstance(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

cancelProcessInstancesBatchOperation()​

cancelProcessInstancesBatchOperation(...a): CancelablePromise<{
  batchOperationKey?: {
   [key: number]: string;
     __brand: "BatchOperationKey";
  };
  batchOperationType?: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey?: { [key: number]: string; __brand: "BatchOperationKey"; }; batchOperationType?: BatchOperationTypeEnum; }>

clearAuthCache()​

clearAuthCache(...a): void;

Parameters​

a​

...[object]

Returns​

void

completeJob()​

completeJob(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

completeUserTask()​

completeUserTask(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

configure()​

configure(...a): void;

Parameters​

a​

...[object]

Returns​

void

correlateMessage()​

correlateMessage(...a): CancelablePromise<{
  messageKey?: {
   [key: number]: string;
     __brand: "MessageKey";
  };
  processInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ messageKey?: { [key: number]: string; __brand: "MessageKey"; }; processInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; tenantId?: { [key: number]: string; __brand: "TenantId"; }; }>

createAdminUser()​

createAdminUser(...a): CancelablePromise<{
  email?: string;
  name?: string;
  username?: {
   [key: number]: string;
     __brand: "Username";
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ email?: string; name?: string; username?: { [key: number]: string; __brand: "Username"; }; }>

createAuthorization()​

createAuthorization(...a): CancelablePromise<{
  authorizationKey?: {
   [key: number]: string;
     __brand: "AuthorizationKey";
  };
}>;

Parameters​

a​

...[ | { ownerId: string; ownerType: OwnerTypeEnum; permissionTypes: PermissionTypeEnum[]; resourceId: string; resourceType: ResourceTypeEnum; } | { ownerId: string; ownerType: OwnerTypeEnum; permissionTypes: PermissionTypeEnum[]; resourcePropertyName: string; resourceType: ResourceTypeEnum; }]

Returns​

CancelablePromise<{ authorizationKey?: { [key: number]: string; __brand: "AuthorizationKey"; }; }>

createDeployment()​

createDeployment(...a): CancelablePromise<{
  decisionRequirements: object[];
  decisions: object[];
  deploymentKey: string;
  deployments: object[];
  forms: object[];
  processes: object[];
  resources: object[];
  tenantId: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ decisionRequirements: object[]; decisions: object[]; deploymentKey: string; deployments: object[]; forms: object[]; processes: object[]; resources: object[]; tenantId: string; }>

createDocument()​

createDocument(...a): CancelablePromise<{
  camunda.document.type?: "camunda";
  contentHash?: string;
  documentId?: {
   [key: number]: string;
     __brand: "DocumentId";
  };
  metadata?: {
     contentType?: string;
     customProperties?: {
      [key: string]: unknown;
     };
     expiresAt?: string;
     fileName?: string;
     processDefinitionId?: {
      [key: number]: string;
        __brand: "ProcessDefinitionId";
     };
     processInstanceKey?: {
      [key: number]: string;
        __brand: "ProcessInstanceKey";
     };
     size?: number;
  };
  storeId?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ camunda.document.type?: "camunda"; contentHash?: string; documentId?: { [key: number]: string; __brand: "DocumentId"; }; metadata?: { contentType?: string; customProperties?: { [key: string]: unknown; }; expiresAt?: string; fileName?: string; processDefinitionId?: { [key: number]: string; __brand: "ProcessDefinitionId"; }; processInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; size?: number; }; storeId?: string; }>

createDocumentLink(...a): CancelablePromise<{
  expiresAt?: string;
  url?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ expiresAt?: string; url?: string; }>

createDocuments()​

createDocuments(...a): CancelablePromise<{
  createdDocuments?: object[];
  failedDocuments?: object[];
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ createdDocuments?: object[]; failedDocuments?: object[]; }>

createElementInstanceVariables()​

createElementInstanceVariables(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

createGlobalClusterVariable()​

createGlobalClusterVariable(...a): CancelablePromise<{
  name: string;
  scope: ClusterVariableScopeEnum;
  tenantId?: string;
  value?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; tenantId?: string; value?: string; }>

createGroup()​

createGroup(...a): CancelablePromise<{
  description?: string;
  groupId?: string;
  name?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ description?: string; groupId?: string; name?: string; }>

createJobWorker()​

createJobWorker(...a): object;

Parameters​

a​

...[object]

Returns​

object

activeJobs​
activeJobs: number;
name​
name: string;
stopped​
stopped: boolean;
start()​
start(...a): void;
Parameters​
a​

...[]

Returns​

void

stop()​
stop(...a): void;
Parameters​
a​

...[]

Returns​

void

stopGracefully()​
stopGracefully(...a): Promise<{
  remainingJobs: number;
  timedOut: boolean;
}>;
Parameters​
a​

...[object]

Returns​

Promise<{ remainingJobs: number; timedOut: boolean; }>

createMappingRule()​

createMappingRule(...a): CancelablePromise<{
  claimName?: string;
  claimValue?: string;
  mappingRuleId?: string;
  name?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ claimName?: string; claimValue?: string; mappingRuleId?: string; name?: string; }>

createProcessInstance()​

createProcessInstance(...a): CancelablePromise<{
  processDefinitionId: string;
  processDefinitionKey: string;
  processDefinitionVersion: number;
  processInstanceKey: string;
  tags?: string[];
  tenantId: string;
  variables: {
   [key: string]: unknown;
  };
}>;

Parameters​

a​

...[ | { awaitCompletion?: boolean; fetchVariables?: string[]; operationReference?: number; processDefinitionId: string; processDefinitionVersion?: number; requestTimeout?: number; runtimeInstructions?: object[]; startInstructions?: object[]; tags?: string[]; tenantId?: { [key: number]: string; __brand: "TenantId"; }; variables?: { [key: string]: unknown; }; } | { awaitCompletion?: boolean; fetchVariables?: string[]; operationReference?: number; processDefinitionKey: string; processDefinitionVersion?: number; requestTimeout?: number; runtimeInstructions?: object[]; startInstructions?: object[]; tags?: string[]; tenantId?: { [key: number]: string; __brand: "TenantId"; }; variables?: { [key: string]: unknown; }; }]

Returns​

CancelablePromise<{ processDefinitionId: string; processDefinitionKey: string; processDefinitionVersion: number; processInstanceKey: string; tags?: string[]; tenantId: string; variables: { [key: string]: unknown; }; }>

createRole()​

createRole(...a): CancelablePromise<{
  description?: string;
  name?: string;
  roleId?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ description?: string; name?: string; roleId?: string; }>

createTenant()​

createTenant(...a): CancelablePromise<{
  description?: string;
  name?: string;
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ description?: string; name?: string; tenantId?: { [key: number]: string; __brand: "TenantId"; }; }>

createTenantClusterVariable()​

createTenantClusterVariable(...a): CancelablePromise<{
  name: string;
  scope: ClusterVariableScopeEnum;
  tenantId?: string;
  value?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; tenantId?: string; value?: string; }>

createUser()​

createUser(...a): CancelablePromise<{
  email?: string;
  name?: string;
  username?: {
   [key: number]: string;
     __brand: "Username";
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ email?: string; name?: string; username?: { [key: number]: string; __brand: "Username"; }; }>

deleteAuthorization()​

deleteAuthorization(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

deleteDecisionInstance()​

deleteDecisionInstance(...a): CancelablePromise<void>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteDecisionInstancesBatchOperation()​

deleteDecisionInstancesBatchOperation(...a): CancelablePromise<{
  batchOperationKey?: {
   [key: number]: string;
     __brand: "BatchOperationKey";
  };
  batchOperationType?: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey?: { [key: number]: string; __brand: "BatchOperationKey"; }; batchOperationType?: BatchOperationTypeEnum; }>

deleteDocument()​

deleteDocument(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

deleteGlobalClusterVariable()​

deleteGlobalClusterVariable(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

deleteGroup()​

deleteGroup(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

deleteMappingRule()​

deleteMappingRule(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

deleteProcessInstance()​

deleteProcessInstance(...a): CancelablePromise<void>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteProcessInstancesBatchOperation()​

deleteProcessInstancesBatchOperation(...a): CancelablePromise<{
  batchOperationKey?: {
   [key: number]: string;
     __brand: "BatchOperationKey";
  };
  batchOperationType?: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey?: { [key: number]: string; __brand: "BatchOperationKey"; }; batchOperationType?: BatchOperationTypeEnum; }>

deleteResource()​

deleteResource(...a): CancelablePromise<{
  batchOperation?: {
     batchOperationKey?: {
      [key: number]: string;
        __brand: "BatchOperationKey";
     };
     batchOperationType?: BatchOperationTypeEnum;
  };
  resourceKey: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ batchOperation?: { batchOperationKey?: { [key: number]: string; __brand: "BatchOperationKey"; }; batchOperationType?: BatchOperationTypeEnum; }; resourceKey: string; }>

deleteRole()​

deleteRole(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

deleteTenant()​

deleteTenant(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

deleteTenantClusterVariable()​

deleteTenantClusterVariable(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

deleteUser()​

deleteUser(...a): CancelablePromise<void>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deployResourcesFromFiles()​

deployResourcesFromFiles(...a): CancelablePromise<{
  decisionRequirements: object[];
  decisions: object[];
  deploymentKey: string;
  deployments: object[];
  forms: object[];
  processes: object[];
  resources: object[];
  tenantId: string;
}>;

Parameters​

a​

...[string[], object]

Returns​

CancelablePromise<{ decisionRequirements: object[]; decisions: object[]; deploymentKey: string; deployments: object[]; forms: object[]; processes: object[]; resources: object[]; tenantId: string; }>

emitSupportLogPreamble()​

emitSupportLogPreamble(...a): void;

Parameters​

a​

...[]

Returns​

void

evaluateConditionals()​

evaluateConditionals(...a): CancelablePromise<{
  conditionalEvaluationKey: string;
  processInstances: object[];
  tenantId: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ conditionalEvaluationKey: string; processInstances: object[]; tenantId: string; }>

evaluateDecision()​

evaluateDecision(...a): CancelablePromise<{
  decisionDefinitionId: string;
  decisionDefinitionKey: string;
  decisionDefinitionName: string;
  decisionDefinitionVersion: number;
  decisionEvaluationKey: string;
  decisionInstanceKey?: {
   [key: number]: string;
     __brand: "DecisionInstanceKey";
  };
  decisionRequirementsId: string;
  decisionRequirementsKey: string;
  evaluatedDecisions: object[];
  failedDecisionDefinitionId: string;
  failureMessage: string;
  output: string;
  tenantId: string;
}>;

Parameters​

a​

...[ | { decisionDefinitionId: string; tenantId?: { [key: number]: string; __brand: "TenantId"; }; variables?: { [key: string]: unknown; }; } | { decisionDefinitionKey: string; tenantId?: { [key: number]: string; __brand: "TenantId"; }; variables?: { [key: string]: unknown; }; }]

Returns​

CancelablePromise<{ decisionDefinitionId: string; decisionDefinitionKey: string; decisionDefinitionName: string; decisionDefinitionVersion: number; decisionEvaluationKey: string; decisionInstanceKey?: { [key: number]: string; __brand: "DecisionInstanceKey"; }; decisionRequirementsId: string; decisionRequirementsKey: string; evaluatedDecisions: object[]; failedDecisionDefinitionId: string; failureMessage: string; output: string; tenantId: string; }>

evaluateExpression()​

evaluateExpression(...a): CancelablePromise<{
  expression: string;
  result: unknown;
  warnings: string[];
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ expression: string; result: unknown; warnings: string[]; }>

failJob()​

failJob(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

forceAuthRefresh()​

forceAuthRefresh(...a): Promise<string | undefined>;

Parameters​

a​

...[]

Returns​

Promise<string | undefined>

getAuditLog()​

getAuditLog(...a): CancelablePromise<{
  actorId?: string;
  actorType?: AuditLogActorTypeEnum;
  annotation?: string;
  auditLogKey?: {
   [key: number]: string;
     __brand: "AuditLogKey";
  };
  batchOperationKey?: {
   [key: number]: string;
     __brand: "BatchOperationKey";
  };
  batchOperationType?: BatchOperationTypeEnum;
  category?: AuditLogCategoryEnum;
  decisionDefinitionId?: {
   [key: number]: string;
     __brand: "DecisionDefinitionId";
  };
  decisionDefinitionKey?: {
   [key: number]: string;
     __brand: "DecisionDefinitionKey";
  };
  decisionEvaluationKey?: {
   [key: number]: string;
     __brand: "DecisionEvaluationKey";
  };
  decisionRequirementsId?: string;
  decisionRequirementsKey?: {
   [key: number]: string;
     __brand: "DecisionRequirementsKey";
  };
  deploymentKey?: {
   [key: number]: string;
     __brand: "DeploymentKey";
  };
  elementInstanceKey?: {
   [key: number]: string;
     __brand: "ElementInstanceKey";
  };
  entityDescription?: string;
  entityKey?: {
   [key: number]: string;
     __brand: "AuditLogEntityKey";
  };
  entityType?: AuditLogEntityTypeEnum;
  formKey?: {
   [key: number]: string;
     __brand: "FormKey";
  };
  jobKey?: {
   [key: number]: string;
     __brand: "JobKey";
  };
  operationType?: AuditLogOperationTypeEnum;
  processDefinitionId?: {
   [key: number]: string;
     __brand: "ProcessDefinitionId";
  };
  processDefinitionKey?: {
   [key: number]: string;
     __brand: "ProcessDefinitionKey";
  };
  processInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  relatedEntityKey?: {
   [key: number]: string;
     __brand: "AuditLogEntityKey";
  };
  relatedEntityType?: AuditLogEntityTypeEnum;
  resourceKey?:   | {
   [key: number]: string;
     __brand: "FormKey";
   }
     | {
   [key: number]: string;
     __brand: "ProcessDefinitionKey";
   }
     | {
   [key: number]: string;
     __brand: "DecisionRequirementsKey";
   }
     | {
   [key: number]: string;
     __brand: "DecisionDefinitionKey";
   };
  result?: AuditLogResultEnum;
  rootProcessInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
  timestamp?: string;
  userTaskKey?: {
   [key: number]: string;
     __brand: "UserTaskKey";
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ actorId?: string; actorType?: AuditLogActorTypeEnum; annotation?: string; auditLogKey?: { [key: number]: string; __brand: "AuditLogKey"; }; batchOperationKey?: { [key: number]: string; __brand: "BatchOperationKey"; }; batchOperationType?: BatchOperationTypeEnum; category?: AuditLogCategoryEnum; decisionDefinitionId?: { [key: number]: string; __brand: "DecisionDefinitionId"; }; decisionDefinitionKey?: { [key: number]: string; __brand: "DecisionDefinitionKey"; }; decisionEvaluationKey?: { [key: number]: string; __brand: "DecisionEvaluationKey"; }; decisionRequirementsId?: string; decisionRequirementsKey?: { [key: number]: string; __brand: "DecisionRequirementsKey"; }; deploymentKey?: { [key: number]: string; __brand: "DeploymentKey"; }; elementInstanceKey?: { [key: number]: string; __brand: "ElementInstanceKey"; }; entityDescription?: string; entityKey?: { [key: number]: string; __brand: "AuditLogEntityKey"; }; entityType?: AuditLogEntityTypeEnum; formKey?: { [key: number]: string; __brand: "FormKey"; }; jobKey?: { [key: number]: string; __brand: "JobKey"; }; operationType?: AuditLogOperationTypeEnum; processDefinitionId?: { [key: number]: string; __brand: "ProcessDefinitionId"; }; processDefinitionKey?: { [key: number]: string; __brand: "ProcessDefinitionKey"; }; processInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; relatedEntityKey?: { [key: number]: string; __brand: "AuditLogEntityKey"; }; relatedEntityType?: AuditLogEntityTypeEnum; resourceKey?: | { [key: number]: string; __brand: "FormKey"; } | { [key: number]: string; __brand: "ProcessDefinitionKey"; } | { [key: number]: string; __brand: "DecisionRequirementsKey"; } | { [key: number]: string; __brand: "DecisionDefinitionKey"; }; result?: AuditLogResultEnum; rootProcessInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; tenantId?: { [key: number]: string; __brand: "TenantId"; }; timestamp?: string; userTaskKey?: { [key: number]: string; __brand: "UserTaskKey"; }; }>

getAuthentication()​

getAuthentication(...a): CancelablePromise<{
  authorizedComponents?: string[];
  c8Links: {
   [key: string]: string;
  };
  canLogout: boolean;
  displayName?: string | null;
  email?: string | null;
  groups: string[];
  roles: string[];
  salesPlanType: string;
  tenants: object[];
  username?:   | {
   [key: number]: string;
     __brand: "Username";
   }
     | null;
}>;

Parameters​

a​

...[]

Returns​

CancelablePromise<{ authorizedComponents?: string[]; c8Links: { [key: string]: string; }; canLogout: boolean; displayName?: string | null; email?: string | null; groups: string[]; roles: string[]; salesPlanType: string; tenants: object[]; username?: | { [key: number]: string; __brand: "Username"; } | null; }>

getAuthHeaders()​

getAuthHeaders(...a): Promise<{
[key: string]: string;
}>;

Parameters​

a​

...[]

Returns​

Promise<{ [key: string]: string; }>

getAuthorization()​

getAuthorization(...a): CancelablePromise<{
  authorizationKey?: {
   [key: number]: string;
     __brand: "AuthorizationKey";
  };
  ownerId?: string;
  ownerType?: OwnerTypeEnum;
  permissionTypes?: PermissionTypeEnum[];
  resourceId?: string;
  resourcePropertyName?: string;
  resourceType?: ResourceTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ authorizationKey?: { [key: number]: string; __brand: "AuthorizationKey"; }; ownerId?: string; ownerType?: OwnerTypeEnum; permissionTypes?: PermissionTypeEnum[]; resourceId?: string; resourcePropertyName?: string; resourceType?: ResourceTypeEnum; }>

getBackpressureState()​

getBackpressureState(...a):
  | {
  consecutive: number;
  permitsCurrent: number;
  permitsMax: number | null;
  severity: BackpressureSeverity;
  waiters: number;
}
  | {
  consecutive: number;
  permitsCurrent: number;
  permitsMax: null;
  severity: string;
  waiters: number;
};

Parameters​

a​

...[]

Returns​

| { consecutive: number; permitsCurrent: number; permitsMax: number | null; severity: BackpressureSeverity; waiters: number; } | { consecutive: number; permitsCurrent: number; permitsMax: null; severity: string; waiters: number; }

getBatchOperation()​

getBatchOperation(...a): CancelablePromise<{
  actorId?: string;
  actorType?: AuditLogActorTypeEnum;
  batchOperationKey?: {
   [key: number]: string;
     __brand: "BatchOperationKey";
  };
  batchOperationType?: BatchOperationTypeEnum;
  endDate?: string;
  errors?: object[];
  operationsCompletedCount?: number;
  operationsFailedCount?: number;
  operationsTotalCount?: number;
  startDate?: string;
  state?: BatchOperationStateEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ actorId?: string; actorType?: AuditLogActorTypeEnum; batchOperationKey?: { [key: number]: string; __brand: "BatchOperationKey"; }; batchOperationType?: BatchOperationTypeEnum; endDate?: string; errors?: object[]; operationsCompletedCount?: number; operationsFailedCount?: number; operationsTotalCount?: number; startDate?: string; state?: BatchOperationStateEnum; }>

getConfig()​

getConfig(...a): object;

Parameters​

a​

...[]

Returns​

object

__raw​
readonly __raw: object;
Index Signature​
[key: string]: string | undefined
auth​
readonly auth: object;
auth.basic?​
optional basic: object;
auth.basic.password?​
optional password: string;
auth.basic.username?​
optional username: string;
auth.strategy​
strategy: AuthStrategy;
backpressure​
readonly backpressure: object;
backpressure.decayQuietMs​
decayQuietMs: number;
backpressure.enabled​
enabled: boolean;
backpressure.floor​
floor: number;
backpressure.initialMax​
initialMax: number;
backpressure.observeOnly​
observeOnly: boolean;
backpressure.profile​
profile: string;
backpressure.recoveryIntervalMs​
recoveryIntervalMs: number;
backpressure.recoveryStep​
recoveryStep: number;
backpressure.severeFactor​
severeFactor: number;
backpressure.severeThreshold​
severeThreshold: number;
backpressure.softFactor​
softFactor: number;
defaultTenantId​
readonly defaultTenantId: string;
eventual?​
readonly optional eventual: object;
eventual.pollDefaultMs​
pollDefaultMs: number;
httpRetry​
readonly httpRetry: object;
httpRetry.baseDelayMs​
baseDelayMs: number;
httpRetry.maxAttempts​
maxAttempts: number;
httpRetry.maxDelayMs​
maxDelayMs: number;
logLevel​
readonly logLevel: "trace" | "error" | "silent" | "warn" | "info" | "debug";
mtls?​
readonly optional mtls: object;
mtls.ca?​
optional ca: string;
mtls.caPath?​
optional caPath: string;
mtls.cert?​
optional cert: string;
mtls.certPath?​
optional certPath: string;
mtls.key?​
optional key: string;
mtls.keyPassphrase?​
optional keyPassphrase: string;
mtls.keyPath?​
optional keyPath: string;
oauth​
readonly oauth: object;
oauth.cacheDir?​
optional cacheDir: string;
oauth.clientId?​
optional clientId: string;
oauth.clientSecret?​
optional clientSecret: string;
oauth.grantType​
grantType: string;
oauth.oauthUrl​
oauthUrl: string;
oauth.retry​
retry: object;
oauth.retry.baseDelayMs​
baseDelayMs: number;
oauth.retry.max​
max: number;
oauth.scope?​
optional scope: string;
oauth.timeoutMs​
timeoutMs: number;
restAddress​
readonly restAddress: string;
supportLog?​
readonly optional supportLog: object;
supportLog.enabled​
enabled: boolean;
supportLog.filePath​
filePath: string;
telemetry?​
readonly optional telemetry: object;
telemetry.correlation​
correlation: boolean;
telemetry.log​
log: boolean;
tokenAudience​
readonly tokenAudience: string;
validation​
readonly validation: object;
validation.raw​
raw: string;
validation.req​
req: ValidationMode;
validation.res​
res: ValidationMode;

getDecisionDefinition()​

getDecisionDefinition(...a): CancelablePromise<{
  decisionDefinitionId?: {
   [key: number]: string;
     __brand: "DecisionDefinitionId";
  };
  decisionDefinitionKey?: {
   [key: number]: string;
     __brand: "DecisionDefinitionKey";
  };
  decisionRequirementsId?: string;
  decisionRequirementsKey?: {
   [key: number]: string;
     __brand: "DecisionRequirementsKey";
  };
  decisionRequirementsName?: string;
  decisionRequirementsVersion?: number;
  name?: string;
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
  version?: number;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ decisionDefinitionId?: { [key: number]: string; __brand: "DecisionDefinitionId"; }; decisionDefinitionKey?: { [key: number]: string; __brand: "DecisionDefinitionKey"; }; decisionRequirementsId?: string; decisionRequirementsKey?: { [key: number]: string; __brand: "DecisionRequirementsKey"; }; decisionRequirementsName?: string; decisionRequirementsVersion?: number; name?: string; tenantId?: { [key: number]: string; __brand: "TenantId"; }; version?: number; }>

getDecisionDefinitionXml()​

getDecisionDefinitionXml(...a): CancelablePromise<string>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<string>

getDecisionInstance()​

getDecisionInstance(...a): CancelablePromise<{
  decisionDefinitionId?: {
   [key: number]: string;
     __brand: "DecisionDefinitionId";
  };
  decisionDefinitionKey?: {
   [key: number]: string;
     __brand: "DecisionDefinitionKey";
  };
  decisionDefinitionName?: string;
  decisionDefinitionType?: DecisionDefinitionTypeEnum;
  decisionDefinitionVersion?: number;
  decisionEvaluationInstanceKey?: {
   [key: number]: string;
     __brand: "DecisionEvaluationInstanceKey";
  };
  decisionEvaluationKey?: {
   [key: number]: string;
     __brand: "DecisionEvaluationKey";
  };
  elementInstanceKey?: {
   [key: number]: string;
     __brand: "ElementInstanceKey";
  };
  evaluatedInputs?: object[];
  evaluationDate?: string;
  evaluationFailure?: string;
  matchedRules?: object[];
  processDefinitionKey?: {
   [key: number]: string;
     __brand: "ProcessDefinitionKey";
  };
  processInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  result?: string;
  rootDecisionDefinitionKey?: {
   [key: number]: string;
     __brand: "DecisionDefinitionKey";
  };
  rootProcessInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  state?: DecisionInstanceStateEnum;
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ decisionDefinitionId?: { [key: number]: string; __brand: "DecisionDefinitionId"; }; decisionDefinitionKey?: { [key: number]: string; __brand: "DecisionDefinitionKey"; }; decisionDefinitionName?: string; decisionDefinitionType?: DecisionDefinitionTypeEnum; decisionDefinitionVersion?: number; decisionEvaluationInstanceKey?: { [key: number]: string; __brand: "DecisionEvaluationInstanceKey"; }; decisionEvaluationKey?: { [key: number]: string; __brand: "DecisionEvaluationKey"; }; elementInstanceKey?: { [key: number]: string; __brand: "ElementInstanceKey"; }; evaluatedInputs?: object[]; evaluationDate?: string; evaluationFailure?: string; matchedRules?: object[]; processDefinitionKey?: { [key: number]: string; __brand: "ProcessDefinitionKey"; }; processInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; result?: string; rootDecisionDefinitionKey?: { [key: number]: string; __brand: "DecisionDefinitionKey"; }; rootProcessInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; state?: DecisionInstanceStateEnum; tenantId?: { [key: number]: string; __brand: "TenantId"; }; }>

getDecisionRequirements()​

getDecisionRequirements(...a): CancelablePromise<{
  decisionRequirementsId?: string;
  decisionRequirementsKey?: {
   [key: number]: string;
     __brand: "DecisionRequirementsKey";
  };
  decisionRequirementsName?: string;
  resourceName?: string;
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
  version?: number;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ decisionRequirementsId?: string; decisionRequirementsKey?: { [key: number]: string; __brand: "DecisionRequirementsKey"; }; decisionRequirementsName?: string; resourceName?: string; tenantId?: { [key: number]: string; __brand: "TenantId"; }; version?: number; }>

getDecisionRequirementsXml()​

getDecisionRequirementsXml(...a): CancelablePromise<string>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<string>

getDocument()​

getDocument(...a): CancelablePromise<{
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ }>

getElementInstance()​

getElementInstance(...a): CancelablePromise<{
  elementId: string;
  elementInstanceKey: string;
  elementName: string;
  endDate?: string;
  hasIncident: boolean;
  incidentKey?: {
   [key: number]: string;
     __brand: "IncidentKey";
  };
  processDefinitionId: string;
  processDefinitionKey: string;
  processInstanceKey: string;
  rootProcessInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  startDate: string;
  state: ElementInstanceStateEnum;
  tenantId: string;
  type:   | "USER_TASK"
     | "UNKNOWN"
     | "UNSPECIFIED"
     | "PROCESS"
     | "SUB_PROCESS"
     | "EVENT_SUB_PROCESS"
     | "AD_HOC_SUB_PROCESS"
     | "AD_HOC_SUB_PROCESS_INNER_INSTANCE"
     | "START_EVENT"
     | "INTERMEDIATE_CATCH_EVENT"
     | "INTERMEDIATE_THROW_EVENT"
     | "BOUNDARY_EVENT"
     | "END_EVENT"
     | "SERVICE_TASK"
     | "RECEIVE_TASK"
     | "MANUAL_TASK"
     | "TASK"
     | "EXCLUSIVE_GATEWAY"
     | "INCLUSIVE_GATEWAY"
     | "PARALLEL_GATEWAY"
     | "EVENT_BASED_GATEWAY"
     | "SEQUENCE_FLOW"
     | "MULTI_INSTANCE_BODY"
     | "CALL_ACTIVITY"
     | "BUSINESS_RULE_TASK"
     | "SCRIPT_TASK"
     | "SEND_TASK";
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ elementId: string; elementInstanceKey: string; elementName: string; endDate?: string; hasIncident: boolean; incidentKey?: { [key: number]: string; __brand: "IncidentKey"; }; processDefinitionId: string; processDefinitionKey: string; processInstanceKey: string; rootProcessInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; startDate: string; state: ElementInstanceStateEnum; tenantId: string; type: | "USER_TASK" | "UNKNOWN" | "UNSPECIFIED" | "PROCESS" | "SUB_PROCESS" | "EVENT_SUB_PROCESS" | "AD_HOC_SUB_PROCESS" | "AD_HOC_SUB_PROCESS_INNER_INSTANCE" | "START_EVENT" | "INTERMEDIATE_CATCH_EVENT" | "INTERMEDIATE_THROW_EVENT" | "BOUNDARY_EVENT" | "END_EVENT" | "SERVICE_TASK" | "RECEIVE_TASK" | "MANUAL_TASK" | "TASK" | "EXCLUSIVE_GATEWAY" | "INCLUSIVE_GATEWAY" | "PARALLEL_GATEWAY" | "EVENT_BASED_GATEWAY" | "SEQUENCE_FLOW" | "MULTI_INSTANCE_BODY" | "CALL_ACTIVITY" | "BUSINESS_RULE_TASK" | "SCRIPT_TASK" | "SEND_TASK"; }>

getErrorMode()​

getErrorMode(...a): "result" | "throw";

Parameters​

a​

...[]

Returns​

"result" | "throw"

getGlobalClusterVariable()​

getGlobalClusterVariable(...a): CancelablePromise<{
  name: string;
  scope: ClusterVariableScopeEnum;
  tenantId?: string;
  value?: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; tenantId?: string; value?: string; }>

getGlobalJobStatistics()​

getGlobalJobStatistics(...a): CancelablePromise<{
  completed: {
     count: number;
     lastUpdatedAt: string;
  };
  created: {
     count: number;
     lastUpdatedAt: string;
  };
  failed: {
     count: number;
     lastUpdatedAt: string;
  };
  isIncomplete: boolean;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ completed: { count: number; lastUpdatedAt: string; }; created: { count: number; lastUpdatedAt: string; }; failed: { count: number; lastUpdatedAt: string; }; isIncomplete: boolean; }>

getGroup()​

getGroup(...a): CancelablePromise<{
  description?: string;
  groupId?: string;
  name?: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ description?: string; groupId?: string; name?: string; }>

getIncident()​

getIncident(...a): CancelablePromise<{
  creationTime?: string;
  elementId?: {
   [key: number]: string;
     __brand: "ElementId";
  };
  elementInstanceKey?: {
   [key: number]: string;
     __brand: "ElementInstanceKey";
  };
  errorMessage?: string;
  errorType?: IncidentErrorTypeEnum;
  incidentKey?: {
   [key: number]: string;
     __brand: "IncidentKey";
  };
  jobKey?: {
   [key: number]: string;
     __brand: "JobKey";
  };
  processDefinitionId?: {
   [key: number]: string;
     __brand: "ProcessDefinitionId";
  };
  processDefinitionKey?: {
   [key: number]: string;
     __brand: "ProcessDefinitionKey";
  };
  processInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  rootProcessInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  state?: IncidentStateEnum;
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ creationTime?: string; elementId?: { [key: number]: string; __brand: "ElementId"; }; elementInstanceKey?: { [key: number]: string; __brand: "ElementInstanceKey"; }; errorMessage?: string; errorType?: IncidentErrorTypeEnum; incidentKey?: { [key: number]: string; __brand: "IncidentKey"; }; jobKey?: { [key: number]: string; __brand: "JobKey"; }; processDefinitionId?: { [key: number]: string; __brand: "ProcessDefinitionId"; }; processDefinitionKey?: { [key: number]: string; __brand: "ProcessDefinitionKey"; }; processInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; rootProcessInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; state?: IncidentStateEnum; tenantId?: { [key: number]: string; __brand: "TenantId"; }; }>

getLicense()​

getLicense(...a): CancelablePromise<{
  expiresAt?: string | null;
  isCommercial: boolean;
  licenseType: string;
  validLicense: boolean;
}>;

Parameters​

a​

...[]

Returns​

CancelablePromise<{ expiresAt?: string | null; isCommercial: boolean; licenseType: string; validLicense: boolean; }>

getMappingRule()​

getMappingRule(...a): CancelablePromise<{
  claimName?: string;
  claimValue?: string;
  mappingRuleId?: string;
  name?: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ claimName?: string; claimValue?: string; mappingRuleId?: string; name?: string; }>

getProcessDefinition()​

getProcessDefinition(...a): CancelablePromise<{
  hasStartForm?: boolean;
  name?: string;
  processDefinitionId?: {
   [key: number]: string;
     __brand: "ProcessDefinitionId";
  };
  processDefinitionKey?: {
   [key: number]: string;
     __brand: "ProcessDefinitionKey";
  };
  resourceName?: string;
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
  version?: number;
  versionTag?: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ hasStartForm?: boolean; name?: string; processDefinitionId?: { [key: number]: string; __brand: "ProcessDefinitionId"; }; processDefinitionKey?: { [key: number]: string; __brand: "ProcessDefinitionKey"; }; resourceName?: string; tenantId?: { [key: number]: string; __brand: "TenantId"; }; version?: number; versionTag?: string; }>

getProcessDefinitionInstanceStatistics()​

getProcessDefinitionInstanceStatistics(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

getProcessDefinitionInstanceVersionStatistics()​

getProcessDefinitionInstanceVersionStatistics(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

getProcessDefinitionMessageSubscriptionStatistics()​

getProcessDefinitionMessageSubscriptionStatistics(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

getProcessDefinitionStatistics()​

getProcessDefinitionStatistics(...a): CancelablePromise<{
  items?: object[];
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; }>

getProcessDefinitionXml()​

getProcessDefinitionXml(...a): CancelablePromise<string>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<string>

getProcessInstance()​

getProcessInstance(...a): CancelablePromise<{
  endDate?: string;
  hasIncident: boolean;
  parentElementInstanceKey?: {
   [key: number]: string;
     __brand: "ElementInstanceKey";
  };
  parentProcessInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  processDefinitionId: string;
  processDefinitionKey: string;
  processDefinitionName: string;
  processDefinitionVersion: number;
  processDefinitionVersionTag?: string;
  processInstanceKey: string;
  rootProcessInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  startDate: string;
  state: ProcessInstanceStateEnum;
  tags?: string[];
  tenantId: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ endDate?: string; hasIncident: boolean; parentElementInstanceKey?: { [key: number]: string; __brand: "ElementInstanceKey"; }; parentProcessInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; processDefinitionId: string; processDefinitionKey: string; processDefinitionName: string; processDefinitionVersion: number; processDefinitionVersionTag?: string; processInstanceKey: string; rootProcessInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; startDate: string; state: ProcessInstanceStateEnum; tags?: string[]; tenantId: string; }>

getProcessInstanceCallHierarchy()​

getProcessInstanceCallHierarchy(...a): CancelablePromise<object[]>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<object[]>

getProcessInstanceSequenceFlows()​

getProcessInstanceSequenceFlows(...a): CancelablePromise<{
  items?: object[];
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; }>

getProcessInstanceStatistics()​

getProcessInstanceStatistics(...a): CancelablePromise<{
  items?: object[];
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; }>

getProcessInstanceStatisticsByDefinition()​

getProcessInstanceStatisticsByDefinition(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

getProcessInstanceStatisticsByError()​

getProcessInstanceStatisticsByError(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

getResource()​

getResource(...a): CancelablePromise<{
  resourceId?: string;
  resourceKey?:   | {
   [key: number]: string;
     __brand: "FormKey";
   }
     | {
   [key: number]: string;
     __brand: "ProcessDefinitionKey";
   }
     | {
   [key: number]: string;
     __brand: "DecisionRequirementsKey";
   }
     | {
   [key: number]: string;
     __brand: "DecisionDefinitionKey";
   };
  resourceName?: string;
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
  version?: number;
  versionTag?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ resourceId?: string; resourceKey?: | { [key: number]: string; __brand: "FormKey"; } | { [key: number]: string; __brand: "ProcessDefinitionKey"; } | { [key: number]: string; __brand: "DecisionRequirementsKey"; } | { [key: number]: string; __brand: "DecisionDefinitionKey"; }; resourceName?: string; tenantId?: { [key: number]: string; __brand: "TenantId"; }; version?: number; versionTag?: string; }>

getResourceContent()​

getResourceContent(...a): CancelablePromise<{
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ }>

getRole()​

getRole(...a): CancelablePromise<{
  description?: string;
  name?: string;
  roleId?: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ description?: string; name?: string; roleId?: string; }>

getStartProcessForm()​

getStartProcessForm(...a): CancelablePromise<
  | void
  | {
  formId?: {
   [key: number]: string;
     __brand: "FormId";
  };
  formKey?: {
   [key: number]: string;
     __brand: "FormKey";
  };
  schema?: {
   [key: string]: unknown;
  };
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
  version?: number;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise< | void | { formId?: { [key: number]: string; __brand: "FormId"; }; formKey?: { [key: number]: string; __brand: "FormKey"; }; schema?: { [key: string]: unknown; }; tenantId?: { [key: number]: string; __brand: "TenantId"; }; version?: number; }>

getStatus()​

getStatus(...a): CancelablePromise<void>;

Parameters​

a​

...[]

Returns​

CancelablePromise<void>

getTenant()​

getTenant(...a): CancelablePromise<{
  description?: string;
  name?: string;
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ description?: string; name?: string; tenantId?: { [key: number]: string; __brand: "TenantId"; }; }>

getTenantClusterVariable()​

getTenantClusterVariable(...a): CancelablePromise<{
  name: string;
  scope: ClusterVariableScopeEnum;
  tenantId?: string;
  value?: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; tenantId?: string; value?: string; }>

getTopology()​

getTopology(...a): CancelablePromise<{
  brokers: object[];
  clusterId?: string | null;
  clusterSize: number;
  gatewayVersion: string;
  lastCompletedChangeId: string;
  partitionsCount: number;
  replicationFactor: number;
}>;

Parameters​

a​

...[]

Returns​

CancelablePromise<{ brokers: object[]; clusterId?: string | null; clusterSize: number; gatewayVersion: string; lastCompletedChangeId: string; partitionsCount: number; replicationFactor: number; }>

getUsageMetrics()​

getUsageMetrics(...a): CancelablePromise<{
  activeTenants?: number;
  assignees?: number;
  decisionInstances?: number;
  processInstances?: number;
  tenants?: {
   [key: string]: object;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ activeTenants?: number; assignees?: number; decisionInstances?: number; processInstances?: number; tenants?: { [key: string]: object; }; }>

getUser()​

getUser(...a): CancelablePromise<{
  email?: string;
  name?: string;
  username?: {
   [key: number]: string;
     __brand: "Username";
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ email?: string; name?: string; username?: { [key: number]: string; __brand: "Username"; }; }>

getUserTask()​

getUserTask(...a): CancelablePromise<{
  assignee?: string;
  candidateGroups?: string[];
  candidateUsers?: string[];
  completionDate?: string;
  creationDate?: string;
  customHeaders?: {
   [key: string]: string;
  };
  dueDate?: string;
  elementId?: {
   [key: number]: string;
     __brand: "ElementId";
  };
  elementInstanceKey?: {
   [key: number]: string;
     __brand: "ElementInstanceKey";
  };
  externalFormReference?: string;
  followUpDate?: string;
  formKey?: {
   [key: number]: string;
     __brand: "FormKey";
  };
  name?: string;
  priority?: number;
  processDefinitionId?: {
   [key: number]: string;
     __brand: "ProcessDefinitionId";
  };
  processDefinitionKey?: {
   [key: number]: string;
     __brand: "ProcessDefinitionKey";
  };
  processDefinitionVersion?: number;
  processInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  processName?: string;
  rootProcessInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  state?: UserTaskStateEnum;
  tags?: string[];
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
  userTaskKey?: {
   [key: number]: string;
     __brand: "UserTaskKey";
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ assignee?: string; candidateGroups?: string[]; candidateUsers?: string[]; completionDate?: string; creationDate?: string; customHeaders?: { [key: string]: string; }; dueDate?: string; elementId?: { [key: number]: string; __brand: "ElementId"; }; elementInstanceKey?: { [key: number]: string; __brand: "ElementInstanceKey"; }; externalFormReference?: string; followUpDate?: string; formKey?: { [key: number]: string; __brand: "FormKey"; }; name?: string; priority?: number; processDefinitionId?: { [key: number]: string; __brand: "ProcessDefinitionId"; }; processDefinitionKey?: { [key: number]: string; __brand: "ProcessDefinitionKey"; }; processDefinitionVersion?: number; processInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; processName?: string; rootProcessInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; state?: UserTaskStateEnum; tags?: string[]; tenantId?: { [key: number]: string; __brand: "TenantId"; }; userTaskKey?: { [key: number]: string; __brand: "UserTaskKey"; }; }>

getUserTaskForm()​

getUserTaskForm(...a): CancelablePromise<
  | void
  | {
  formId?: {
   [key: number]: string;
     __brand: "FormId";
  };
  formKey?: {
   [key: number]: string;
     __brand: "FormKey";
  };
  schema?: {
   [key: string]: unknown;
  };
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
  version?: number;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise< | void | { formId?: { [key: number]: string; __brand: "FormId"; }; formKey?: { [key: number]: string; __brand: "FormKey"; }; schema?: { [key: string]: unknown; }; tenantId?: { [key: number]: string; __brand: "TenantId"; }; version?: number; }>

getVariable()​

getVariable(...a): CancelablePromise<{
  name?: string;
  processInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  rootProcessInstanceKey?: {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
  };
  scopeKey?: {
   [key: number]: string;
     __brand: "ScopeKey";
  };
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
  value?: string;
  variableKey?: {
   [key: number]: string;
     __brand: "VariableKey";
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ name?: string; processInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; rootProcessInstanceKey?: { [key: number]: string; __brand: "ProcessInstanceKey"; }; scopeKey?: { [key: number]: string; __brand: "ScopeKey"; }; tenantId?: { [key: number]: string; __brand: "TenantId"; }; value?: string; variableKey?: { [key: number]: string; __brand: "VariableKey"; }; }>

getWorkers()​

getWorkers(...a): any[];

Parameters​

a​

...[]

Returns​

any[]

logger()​

logger(...a): object;

Parameters​

a​

...[string]

Returns​

object

code()​
code(...a): void;
Parameters​
a​

...[LogLevel, string, string, any]

Returns​

void

debug()​
debug(...a): void;
Parameters​
a​

...any[]

Returns​

void

error()​
error(...a): void;
Parameters​
a​

...any[]

Returns​

void

info()​
info(...a): void;
Parameters​
a​

...any[]

Returns​

void

level()​
level(...a): LogLevel;
Parameters​
a​

...[]

Returns​

LogLevel

scope()​
scope(...a): { level: () => LogLevel; setLevel: (level: LogLevel) => void; setTransport: (t?: ((e: { level: LogLevel; scope: string; ts: number; args: any[]; code?: string | undefined; data?: any; }) => void) | undefined) => void; ... 7 more ...; code: (level: LogLevel, code: string, msg: string, data?: any) => void; };
Parameters​
a​

...[string]

Returns​

{ level: () => LogLevel; setLevel: (level: LogLevel) => void; setTransport: (t?: ((e: { level: LogLevel; scope: string; ts: number; args: any[]; code?: string | undefined; data?: any; }) => void) | undefined) => void; ... 7 more ...; code: (level: LogLevel, code: string, msg: string, data?: any) => void; }

setLevel()​
setLevel(...a): void;
Parameters​
a​

...[LogLevel]

Returns​

void

setTransport()​
setTransport(...a): void;
Parameters​
a​

...[(...a) => void]

Returns​

void

silly()​
silly(...a): void;
Parameters​
a​

...any[]

Returns​

void

trace()​
trace(...a): void;
Parameters​
a​

...any[]

Returns​

void

warn()​
warn(...a): void;
Parameters​
a​

...any[]

Returns​

void

migrateProcessInstance()​

migrateProcessInstance(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

migrateProcessInstancesBatchOperation()​

migrateProcessInstancesBatchOperation(...a): CancelablePromise<{
  batchOperationKey?: {
   [key: number]: string;
     __brand: "BatchOperationKey";
  };
  batchOperationType?: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey?: { [key: number]: string; __brand: "BatchOperationKey"; }; batchOperationType?: BatchOperationTypeEnum; }>

modifyProcessInstance()​

modifyProcessInstance(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

modifyProcessInstancesBatchOperation()​

modifyProcessInstancesBatchOperation(...a): CancelablePromise<{
  batchOperationKey?: {
   [key: number]: string;
     __brand: "BatchOperationKey";
  };
  batchOperationType?: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey?: { [key: number]: string; __brand: "BatchOperationKey"; }; batchOperationType?: BatchOperationTypeEnum; }>

onAuthHeaders()​

onAuthHeaders(...a): void;

Parameters​

a​

...[(...a) => | Promise<{ [key: string]: string; }> | { [key: string]: string; }]

Returns​

void

pinClock()​

pinClock(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

publishMessage()​

publishMessage(...a): CancelablePromise<{
  messageKey?: {
   [key: number]: string;
     __brand: "MessageKey";
  };
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ messageKey?: { [key: number]: string; __brand: "MessageKey"; }; tenantId?: { [key: number]: string; __brand: "TenantId"; }; }>

resetClock()​

resetClock(...a): CancelablePromise<void>;

Parameters​

a​

...[]

Returns​

CancelablePromise<void>

resolveIncident()​

resolveIncident(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

resolveIncidentsBatchOperation()​

resolveIncidentsBatchOperation(...a): CancelablePromise<{
  batchOperationKey?: {
   [key: number]: string;
     __brand: "BatchOperationKey";
  };
  batchOperationType?: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey?: { [key: number]: string; __brand: "BatchOperationKey"; }; batchOperationType?: BatchOperationTypeEnum; }>

resolveProcessInstanceIncidents()​

resolveProcessInstanceIncidents(...a): CancelablePromise<{
  batchOperationKey?: {
   [key: number]: string;
     __brand: "BatchOperationKey";
  };
  batchOperationType?: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey?: { [key: number]: string; __brand: "BatchOperationKey"; }; batchOperationType?: BatchOperationTypeEnum; }>

resumeBatchOperation()​

resumeBatchOperation(...a): CancelablePromise<void>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

searchAuditLogs()​

searchAuditLogs(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchAuthorizations()​

searchAuthorizations(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchBatchOperationItems()​

searchBatchOperationItems(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchBatchOperations()​

searchBatchOperations(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchClientsForGroup()​

searchClientsForGroup(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchClientsForRole()​

searchClientsForRole(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchClientsForTenant()​

searchClientsForTenant(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchClusterVariables()​

searchClusterVariables(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchCorrelatedMessageSubscriptions()​

searchCorrelatedMessageSubscriptions(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchDecisionDefinitions()​

searchDecisionDefinitions(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchDecisionInstances()​

searchDecisionInstances(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchDecisionRequirements()​

searchDecisionRequirements(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchElementInstanceIncidents()​

searchElementInstanceIncidents(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchElementInstances()​

searchElementInstances(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchGroupIdsForTenant()​

searchGroupIdsForTenant(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchGroups()​

searchGroups(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchGroupsForRole()​

searchGroupsForRole(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchIncidents()​

searchIncidents(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchJobs()​

searchJobs(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchMappingRule()​

searchMappingRule(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchMappingRulesForGroup()​

searchMappingRulesForGroup(...a): CancelablePromise<{
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchMappingRulesForRole()​

searchMappingRulesForRole(...a): CancelablePromise<{
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchMappingRulesForTenant()​

searchMappingRulesForTenant(...a): CancelablePromise<{
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchMessageSubscriptions()​

searchMessageSubscriptions(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchProcessDefinitions()​

searchProcessDefinitions(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchProcessInstanceIncidents()​

searchProcessInstanceIncidents(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchProcessInstances()​

searchProcessInstances(...a): CancelablePromise<{
  items: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchRoles()​

searchRoles(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchRolesForGroup()​

searchRolesForGroup(...a): CancelablePromise<{
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchRolesForTenant()​

searchRolesForTenant(...a): CancelablePromise<{
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchTenants()​

searchTenants(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchUsers()​

searchUsers(...a): CancelablePromise<{
  items: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchUsersForGroup()​

searchUsersForGroup(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchUsersForRole()​

searchUsersForRole(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchUsersForTenant()​

searchUsersForTenant(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchUserTaskAuditLogs()​

searchUserTaskAuditLogs(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchUserTasks()​

searchUserTasks(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchUserTaskVariables()​

searchUserTaskVariables(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

searchVariables()​

searchVariables(...a): CancelablePromise<{
  items?: object[];
  page: {
     endCursor?: {
      [key: number]: string;
        __brand: "EndCursor";
     };
     hasMoreTotalItems?: boolean;
     startCursor?: {
      [key: number]: string;
        __brand: "StartCursor";
     };
     totalItems: number;
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ items?: object[]; page: { endCursor?: { [key: number]: string; __brand: "EndCursor"; }; hasMoreTotalItems?: boolean; startCursor?: { [key: number]: string; __brand: "StartCursor"; }; totalItems: number; }; }>

stopAllWorkers()​

stopAllWorkers(...a): void;

Parameters​

a​

...[]

Returns​

void

suspendBatchOperation()​

suspendBatchOperation(...a): CancelablePromise<void>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

throwJobError()​

throwJobError(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignClientFromGroup()​

unassignClientFromGroup(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignClientFromTenant()​

unassignClientFromTenant(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignGroupFromTenant()​

unassignGroupFromTenant(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignMappingRuleFromGroup()​

unassignMappingRuleFromGroup(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignMappingRuleFromTenant()​

unassignMappingRuleFromTenant(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignRoleFromClient()​

unassignRoleFromClient(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignRoleFromGroup()​

unassignRoleFromGroup(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignRoleFromMappingRule()​

unassignRoleFromMappingRule(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignRoleFromTenant()​

unassignRoleFromTenant(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignRoleFromUser()​

unassignRoleFromUser(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignUserFromGroup()​

unassignUserFromGroup(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignUserFromTenant()​

unassignUserFromTenant(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

unassignUserTask()​

unassignUserTask(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

updateAuthorization()​

updateAuthorization(...a): CancelablePromise<void>;

Parameters​

a​

...[ | { authorizationKey: string; ownerId: string; ownerType: OwnerTypeEnum; permissionTypes: PermissionTypeEnum[]; resourceId: string; resourceType: ResourceTypeEnum; } | { authorizationKey: string; ownerId: string; ownerType: OwnerTypeEnum; permissionTypes: PermissionTypeEnum[]; resourcePropertyName: string; resourceType: ResourceTypeEnum; }]

Returns​

CancelablePromise<void>

updateGlobalClusterVariable()​

updateGlobalClusterVariable(...a): CancelablePromise<{
  name: string;
  scope: ClusterVariableScopeEnum;
  tenantId?: string;
  value?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; tenantId?: string; value?: string; }>

updateGroup()​

updateGroup(...a): CancelablePromise<{
  description?: string;
  groupId?: string;
  name?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ description?: string; groupId?: string; name?: string; }>

updateJob()​

updateJob(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

updateMappingRule()​

updateMappingRule(...a): CancelablePromise<{
  claimName?: string;
  claimValue?: string;
  mappingRuleId?: string;
  name?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ claimName?: string; claimValue?: string; mappingRuleId?: string; name?: string; }>

updateRole()​

updateRole(...a): CancelablePromise<{
  description?: string;
  name?: string;
  roleId?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ description?: string; name?: string; roleId?: string; }>

updateTenant()​

updateTenant(...a): CancelablePromise<{
  description?: string;
  name?: string;
  tenantId?: {
   [key: number]: string;
     __brand: "TenantId";
  };
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ description?: string; name?: string; tenantId?: { [key: number]: string; __brand: "TenantId"; }; }>

updateTenantClusterVariable()​

updateTenantClusterVariable(...a): CancelablePromise<{
  name: string;
  scope: ClusterVariableScopeEnum;
  tenantId?: string;
  value?: string;
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; tenantId?: string; value?: string; }>

updateUser()​

updateUser(...a): CancelablePromise<{
  email?: string;
  name?: string;
  username?: {
   [key: number]: string;
     __brand: "Username";
  };
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ email?: string; name?: string; username?: { [key: number]: string; __brand: "Username"; }; }>

updateUserTask()​

updateUserTask(...a): CancelablePromise<void>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

withCorrelation()​

withCorrelation(...a): Promise<unknown>;

Parameters​

a​

...[string, (...a) => unknown]

Returns​

Promise<unknown>