Skip to main content
Version: 8.10 (unreleased)

Function: createCamundaClientLoose()

function createCamundaClientLoose(...args): object;

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.healthyRecoveryMultiplier​

healthyRecoveryMultiplier: number;

config.backpressure.initialMax​

initialMax: number;

config.backpressure.maxWaiters​

maxWaiters: 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.backpressure.unlimitedAfterHealthyMs​

unlimitedAfterHealthyMs: 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;

config.workerDefaults?​

readonly optional workerDefaults?: object;

config.workerDefaults.jobTimeoutMs?​

optional jobTimeoutMs?: number;

config.workerDefaults.maxParallelJobs?​

optional maxParallelJobs?: number;

config.workerDefaults.pollTimeoutMs?​

optional pollTimeoutMs?: number;

config.workerDefaults.startupJitterMaxSeconds?​

optional startupJitterMaxSeconds?: number;

config.workerDefaults.workerName?​

optional workerName?: string;

_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, object]

Returns​

CancelablePromise<void>

activateJobs()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ jobs: object[]; }>

assignClientToGroup()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignClientToTenant()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignGroupToTenant()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignMappingRuleToGroup()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignMappingRuleToTenant()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignRoleToClient()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignRoleToGroup()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignRoleToMappingRule()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignRoleToTenant()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignRoleToUser()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignUserTask()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignUserToGroup()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

assignUserToTenant()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

broadcastSignal()​

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

Parameters​

a​

...[object, 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, object]

Returns​

CancelablePromise<void>

cancelProcessInstancesBatchOperation()​

cancelProcessInstancesBatchOperation(...a): CancelablePromise<{
  batchOperationKey: string;
  batchOperationType: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey: string; batchOperationType: BatchOperationTypeEnum; }>

clearAuthCache()​

clearAuthCache(...a): void;

Parameters​

a​

...[object]

Returns​

void

completeJob()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

completeUserTask()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

configure()​

configure(...a): void;

Parameters​

a​

...[object]

Returns​

void

correlateMessage()​

correlateMessage(...a): CancelablePromise<{
  messageKey: string;
  processInstanceKey: string;
  tenantId: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ messageKey: string; processInstanceKey: string; tenantId: string; }>

createAdminUser()​

createAdminUser(...a): CancelablePromise<{
  email: string | null;
  name: string | null;
  username: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ email: string | null; name: string | null; username: string; }>

createAgentInstance()​

createAgentInstance(...a): CancelablePromise<{
  agentInstanceKey: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ agentInstanceKey: string; }>

createAuthorization()​

createAuthorization(...a): CancelablePromise<{
  authorizationKey: string;
}>;

Parameters​

a​

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

Returns​

CancelablePromise<{ authorizationKey: string; }>

createDeployment()​

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

Parameters​

a​

...[object, 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 | null;
  documentId: string;
  metadata: {
     contentType: string;
     customProperties: {
      [key: string]: unknown;
     };
     expiresAt: string | null;
     fileName: string;
     processDefinitionId:   | {
      [key: number]: string;
        __brand: "ProcessDefinitionId";
      }
        | null;
     processInstanceKey:   | {
      [key: number]: string;
        __brand: "ProcessInstanceKey";
      }
        | null;
     size: number;
  };
  storeId: string;
}>;

Parameters​

a​

...[object, object]

Returns​

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

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

Parameters​

a​

...[object, object]

Returns​

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

createDocuments()​

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

Parameters​

a​

...[object, object]

Returns​

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

createElementInstanceVariables()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

createGlobalClusterVariable()​

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

Parameters​

a​

...[object, object]

Returns​

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

createGlobalTaskListener()​

createGlobalTaskListener(...a): CancelablePromise<{
  afterNonGlobal?: boolean;
  eventTypes: GlobalTaskListenerEventTypeEnum[];
  id: string;
  priority?: number;
  retries?: number;
  source: GlobalListenerSourceEnum;
  type?: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ afterNonGlobal?: boolean; eventTypes: GlobalTaskListenerEventTypeEnum[]; id: string; priority?: number; retries?: number; source: GlobalListenerSourceEnum; type?: string; }>

createGroup()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ description: string | null; 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, object]

Returns​

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

createProcessInstance()​

createProcessInstance(...a): CancelablePromise<{
  businessId:   | {
   [key: number]: string;
     __brand: "BusinessId";
   }
     | null;
  processDefinitionId: string;
  processDefinitionKey: string;
  processDefinitionVersion: number;
  processInstanceKey: string;
  tags: string[];
  tenantId: string;
  variables: {
   [key: string]: unknown;
  };
}>;

Parameters​

a​

...[ | { awaitCompletion?: boolean; businessId?: { [key: number]: string; __brand: "BusinessId"; }; 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; }; } | { awaitCompletion?: boolean; businessId?: { [key: number]: string; __brand: "BusinessId"; }; 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; }; }, object]

Returns​

CancelablePromise<{ businessId: | { [key: number]: string; __brand: "BusinessId"; } | null; processDefinitionId: string; processDefinitionKey: string; processDefinitionVersion: number; processInstanceKey: string; tags: string[]; tenantId: string; variables: { [key: string]: unknown; }; }>

createRole()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ description: string | null; name: string; roleId: string; }>

createTenant()​

createTenant(...a): CancelablePromise<{
  description: string | null;
  name: string;
  tenantId: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ description: string | null; name: string; tenantId: string; }>

createTenantClusterVariable()​

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

Parameters​

a​

...[object, object]

Returns​

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

createThreadedJobWorker()​

createThreadedJobWorker(...a): object;

Parameters​

a​

...[object]

Returns​

object

activeJobs​
activeJobs: number;
busyThreads​
busyThreads: number;
name​
name: string;
poolSize​
poolSize: number;
ready​
ready: Promise<void>;
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; }>

createUser()​

createUser(...a): CancelablePromise<{
  email: string | null;
  name: string | null;
  username: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ email: string | null; name: string | null; username: string; }>

deleteAuthorization()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteDecisionInstance()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteDecisionInstancesBatchOperation()​

deleteDecisionInstancesBatchOperation(...a): CancelablePromise<{
  batchOperationKey: string;
  batchOperationType: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey: string; batchOperationType: BatchOperationTypeEnum; }>

deleteDocument()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteGlobalClusterVariable()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteGlobalTaskListener()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteGroup()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteMappingRule()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteProcessInstance()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteProcessInstancesBatchOperation()​

deleteProcessInstancesBatchOperation(...a): CancelablePromise<{
  batchOperationKey: string;
  batchOperationType: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey: string; batchOperationType: BatchOperationTypeEnum; }>

deleteResource()​

deleteResource(...a): CancelablePromise<{
  batchOperation:   | {
     batchOperationKey: string;
     batchOperationType: BatchOperationTypeEnum;
   }
     | null;
  resourceKey: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperation: | { batchOperationKey: string; batchOperationType: BatchOperationTypeEnum; } | null; resourceKey: string; }>

deleteRole()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteTenant()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

deleteTenantClusterVariable()​

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

Parameters​

a​

...[object, 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, object]

Returns​

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

evaluateDecision()​

evaluateDecision(...a): CancelablePromise<{
  decisionDefinitionId: string;
  decisionDefinitionKey: string;
  decisionDefinitionName: string;
  decisionDefinitionVersion: number;
  decisionEvaluationKey: string;
  decisionInstanceKey: string;
  decisionRequirementsId: string;
  decisionRequirementsKey: string;
  evaluatedDecisions: object[];
  failedDecisionDefinitionId:   | {
   [key: number]: string;
     __brand: "DecisionDefinitionId";
   }
     | null;
  failureMessage: string | null;
  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; }; }, object]

Returns​

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

evaluateExpression()​

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

Parameters​

a​

...[object, object]

Returns​

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

failJob()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

forceAuthRefresh()​

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

Parameters​

a​

...[]

Returns​

Promise<string | undefined>

getAgentInstance()​

getAgentInstance(...a): CancelablePromise<{
  agentInstanceKey: string;
  completionDate: string | null;
  creationDate: string;
  definition: {
     model: string;
     provider: string;
     systemPrompt: string;
  };
  elementId: string;
  elementInstanceKeys: string[];
  lastUpdatedDate: string;
  limits: {
     maxModelCalls: number;
     maxTokens: number;
     maxToolCalls: number;
  };
  metrics: {
     inputTokens: number;
     modelCalls: number;
     outputTokens: number;
     toolCalls: number;
  };
  processDefinitionKey: string;
  processInstanceKey: string;
  status: AgentInstanceStatusEnum;
  tenantId: string;
  tools: object[];
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ agentInstanceKey: string; completionDate: string | null; creationDate: string; definition: { model: string; provider: string; systemPrompt: string; }; elementId: string; elementInstanceKeys: string[]; lastUpdatedDate: string; limits: { maxModelCalls: number; maxTokens: number; maxToolCalls: number; }; metrics: { inputTokens: number; modelCalls: number; outputTokens: number; toolCalls: number; }; processDefinitionKey: string; processInstanceKey: string; status: AgentInstanceStatusEnum; tenantId: string; tools: object[]; }>

getAuditLog()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getAuthentication()​

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

Parameters​

a​

...[object]

Returns​

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

getAuthHeaders()​

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

Parameters​

a​

...[]

Returns​

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

getAuthorization()​

getAuthorization(...a): CancelablePromise<{
  authorizationKey: string;
  ownerId: string;
  ownerType: OwnerTypeEnum;
  permissionTypes: PermissionTypeEnum[];
  resourceId: string | null;
  resourcePropertyName: string | null;
  resourceType: ResourceTypeEnum;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ authorizationKey: string; ownerId: string; ownerType: OwnerTypeEnum; permissionTypes: PermissionTypeEnum[]; resourceId: string | null; resourcePropertyName: string | null; resourceType: ResourceTypeEnum; }>

getBackpressureState()​

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

Parameters​

a​

...[]

Returns​

| { backoffMs: number; 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 | null;
  actorType:   | AuditLogActorTypeEnum
     | null;
  batchOperationKey: string;
  batchOperationType: BatchOperationTypeEnum;
  endDate: string | null;
  errors: object[];
  operationsCompletedCount: number;
  operationsFailedCount: number;
  operationsTotalCount: number;
  startDate: string | null;
  state: BatchOperationStateEnum;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ actorId: string | null; actorType: | AuditLogActorTypeEnum | null; batchOperationKey: string; batchOperationType: BatchOperationTypeEnum; endDate: string | null; errors: object[]; operationsCompletedCount: number; operationsFailedCount: number; operationsTotalCount: number; startDate: string | null; 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.healthyRecoveryMultiplier​
healthyRecoveryMultiplier: number;
backpressure.initialMax​
initialMax: number;
backpressure.maxWaiters​
maxWaiters: 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;
backpressure.unlimitedAfterHealthyMs​
unlimitedAfterHealthyMs: 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;
workerDefaults?​
readonly optional workerDefaults?: object;
workerDefaults.jobTimeoutMs?​
optional jobTimeoutMs?: number;
workerDefaults.maxParallelJobs?​
optional maxParallelJobs?: number;
workerDefaults.pollTimeoutMs?​
optional pollTimeoutMs?: number;
workerDefaults.startupJitterMaxSeconds?​
optional startupJitterMaxSeconds?: number;
workerDefaults.workerName?​
optional workerName?: string;

getDecisionDefinition()​

getDecisionDefinition(...a): CancelablePromise<{
  decisionDefinitionId: string;
  decisionDefinitionKey: string;
  decisionRequirementsId: string;
  decisionRequirementsKey: string;
  decisionRequirementsName: string;
  decisionRequirementsVersion: number;
  name: string;
  tenantId: string;
  version: number;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ decisionDefinitionId: string; decisionDefinitionKey: string; decisionRequirementsId: string; decisionRequirementsKey: string; decisionRequirementsName: string; decisionRequirementsVersion: number; name: string; tenantId: string; version: number; }>

getDecisionDefinitionXml()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<string>

getDecisionInstance()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getDecisionRequirements()​

getDecisionRequirements(...a): CancelablePromise<{
  decisionRequirementsId: string;
  decisionRequirementsKey: string;
  decisionRequirementsName: string;
  resourceName: string;
  tenantId: string;
  version: number;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ decisionRequirementsId: string; decisionRequirementsKey: string; decisionRequirementsName: string; resourceName: string; tenantId: string; version: number; }>

getDecisionRequirementsXml()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<string>

getDocument()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ }>

getElementInstance()​

getElementInstance(...a): CancelablePromise<{
  elementId: string;
  elementInstanceKey: string;
  elementName: string;
  endDate: string | null;
  hasIncident: boolean;
  incidentKey:   | {
   [key: number]: string;
     __brand: "IncidentKey";
   }
     | null;
  processDefinitionId: string;
  processDefinitionKey: string;
  processInstanceKey: string;
  rootProcessInstanceKey:   | {
   [key: number]: string;
     __brand: "ProcessInstanceKey";
   }
     | null;
  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, object]

Returns​

CancelablePromise<{ elementId: string; elementInstanceKey: string; elementName: string; endDate: string | null; hasIncident: boolean; incidentKey: | { [key: number]: string; __brand: "IncidentKey"; } | null; processDefinitionId: string; processDefinitionKey: string; processInstanceKey: string; rootProcessInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; } | null; 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): "throw" | "result";

Parameters​

a​

...[]

Returns​

"throw" | "result"

getFormByKey()​

getFormByKey(...a): CancelablePromise<{
  formId: string;
  formKey: string;
  schema: string;
  tenantId: string;
  version: number;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ formId: string; formKey: string; schema: string; tenantId: string; version: number; }>

getGlobalClusterVariable()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getGlobalJobStatistics()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getGlobalTaskListener()​

getGlobalTaskListener(...a): CancelablePromise<{
  afterNonGlobal?: boolean;
  eventTypes: GlobalTaskListenerEventTypeEnum[];
  id: string;
  priority?: number;
  retries?: number;
  source: GlobalListenerSourceEnum;
  type?: string;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ afterNonGlobal?: boolean; eventTypes: GlobalTaskListenerEventTypeEnum[]; id: string; priority?: number; retries?: number; source: GlobalListenerSourceEnum; type?: string; }>

getGroup()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ description: string | null; groupId: string; name: string; }>

getIncident()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ creationTime: string; elementId: string; elementInstanceKey: string; errorMessage: string; errorType: IncidentErrorTypeEnum; incidentKey: string; jobKey: | { [key: number]: string; __brand: "JobKey"; } | null; processDefinitionId: string; processDefinitionKey: string; processInstanceKey: string; rootProcessInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; } | null; state: IncidentStateEnum; tenantId: string; }>

getJobErrorStatistics()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getJobTimeSeriesStatistics()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getJobTypeStatistics()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getJobWorkerStatistics()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getLicense()​

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

Parameters​

a​

...[object]

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, object]

Returns​

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

getProcessDefinition()​

getProcessDefinition(...a): CancelablePromise<{
  hasStartForm: boolean;
  name: string | null;
  processDefinitionId: string;
  processDefinitionKey: string;
  resourceName: string;
  tenantId: string;
  version: number;
  versionTag: string | null;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ hasStartForm: boolean; name: string | null; processDefinitionId: string; processDefinitionKey: string; resourceName: string; tenantId: string; version: number; versionTag: string | null; }>

getProcessDefinitionInstanceStatistics()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getProcessDefinitionInstanceVersionStatistics()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getProcessDefinitionMessageSubscriptionStatistics()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getProcessDefinitionStatistics()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ items: object[]; }>

getProcessDefinitionXml()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<string>

getProcessInstance()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getProcessInstanceCallHierarchy()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<object[]>

getProcessInstanceSequenceFlows()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ items: object[]; }>

getProcessInstanceStatistics()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ items: object[]; }>

getProcessInstanceStatisticsByDefinition()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getProcessInstanceStatisticsByError()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getResource()​

getResource(...a): CancelablePromise<{
  resourceId: string;
  resourceKey: string;
  resourceName: string;
  tenantId: string;
  version: number;
  versionTag: string | null;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ resourceId: string; resourceKey: string; resourceName: string; tenantId: string; version: number; versionTag: string | null; }>

getResourceContent()​

getResourceContent(...a): CancelablePromise<{
[key: string]: unknown;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ [key: string]: unknown; }>

getResourceContentBinary()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ }>

getRole()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ description: string | null; name: string; roleId: string; }>

getStartProcessForm()​

getStartProcessForm(...a): CancelablePromise<
  | void
  | {
  formId: string;
  formKey: string;
  schema: string;
  tenantId: string;
  version: number;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise< | void | { formId: string; formKey: string; schema: string; tenantId: string; version: number; }>

getStatus()​

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

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

getSystemConfiguration()​

getSystemConfiguration(...a): CancelablePromise<{
  authentication: {
     canLogout: boolean;
     isLoginDelegated: boolean;
  };
  cloud: {
     clusterId: string | null;
     mixpanelAPIHost: string | null;
     mixpanelToken: string | null;
     organizationId: string | null;
     stage: CloudStage | null;
  };
  components: {
     active: WebappComponent[];
  };
  deployment: {
     contextPath: string;
     isEnterprise: boolean;
     isMultiTenancyEnabled: boolean;
     maxRequestSize: number;
  };
  jobMetrics: {
     enabled: boolean;
     exportInterval: string;
     maxJobTypeLength: number;
     maxTenantIdLength: number;
     maxUniqueKeys: number;
     maxWorkerNameLength: number;
  };
}>;

Parameters​

a​

...[object]

Returns​

CancelablePromise<{ authentication: { canLogout: boolean; isLoginDelegated: boolean; }; cloud: { clusterId: string | null; mixpanelAPIHost: string | null; mixpanelToken: string | null; organizationId: string | null; stage: CloudStage | null; }; components: { active: WebappComponent[]; }; deployment: { contextPath: string; isEnterprise: boolean; isMultiTenancyEnabled: boolean; maxRequestSize: number; }; jobMetrics: { enabled: boolean; exportInterval: string; maxJobTypeLength: number; maxTenantIdLength: number; maxUniqueKeys: number; maxWorkerNameLength: number; }; }>

getTenant()​

getTenant(...a): CancelablePromise<{
  description: string | null;
  name: string;
  tenantId: string;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ description: string | null; name: string; tenantId: string; }>

getTenantClusterVariable()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getTopology()​

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

Parameters​

a​

...[object]

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, object]

Returns​

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

getUser()​

getUser(...a): CancelablePromise<{
  email: string | null;
  name: string | null;
  username: string;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ email: string | null; name: string | null; username: string; }>

getUserTask()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

getUserTaskForm()​

getUserTaskForm(...a): CancelablePromise<
  | void
  | {
  formId: string;
  formKey: string;
  schema: string;
  tenantId: string;
  version: number;
}>;

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise< | void | { formId: string; formKey: string; schema: string; tenantId: string; version: number; }>

getVariable()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ name: string; processInstanceKey: string; rootProcessInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; } | null; scopeKey: string; tenantId: string; value: string; variableKey: string; }>

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, object]

Returns​

CancelablePromise<void>

migrateProcessInstancesBatchOperation()​

migrateProcessInstancesBatchOperation(...a): CancelablePromise<{
  batchOperationKey: string;
  batchOperationType: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey: string; batchOperationType: BatchOperationTypeEnum; }>

modifyProcessInstance()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

modifyProcessInstancesBatchOperation()​

modifyProcessInstancesBatchOperation(...a): CancelablePromise<{
  batchOperationKey: string;
  batchOperationType: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey: string; 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, object]

Returns​

CancelablePromise<void>

publishMessage()​

publishMessage(...a): CancelablePromise<{
  messageKey: string;
  tenantId: string;
}>;

Parameters​

a​

...[object, object]

Returns​

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

resetClock()​

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

Parameters​

a​

...[object]

Returns​

CancelablePromise<void>

resolveIncident()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

resolveIncidentsBatchOperation()​

resolveIncidentsBatchOperation(...a): CancelablePromise<{
  batchOperationKey: string;
  batchOperationType: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey: string; batchOperationType: BatchOperationTypeEnum; }>

resolveProcessInstanceIncidents()​

resolveProcessInstanceIncidents(...a): CancelablePromise<{
  batchOperationKey: string;
  batchOperationType: BatchOperationTypeEnum;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ batchOperationKey: string; batchOperationType: BatchOperationTypeEnum; }>

resumeBatchOperation()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

searchAgentInstances()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchAuditLogs()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchAuthorizations()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchBatchOperationItems()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchBatchOperations()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchClientsForGroup()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchClientsForRole()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchClientsForTenant()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchClusterVariables()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchCorrelatedMessageSubscriptions()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchDecisionDefinitions()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchDecisionInstances()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchDecisionRequirements()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchElementInstanceIncidents()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchElementInstances()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchGlobalTaskListeners()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchGroupIdsForTenant()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchGroups()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchGroupsForRole()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchIncidents()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchJobs()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchMappingRule()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchMappingRulesForGroup()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchMappingRulesForRole()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchMappingRulesForTenant()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchMessageSubscriptions()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchProcessDefinitions()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchProcessInstanceIncidents()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchProcessInstances()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchResources()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchRoles()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchRolesForGroup()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchRolesForTenant()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchTenants()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchUsers()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchUsersForGroup()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchUsersForRole()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchUsersForTenant()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchUserTaskAuditLogs()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchUserTaskEffectiveVariables()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchUserTasks()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchUserTaskVariables()​

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

Parameters​

a​

...[object, object, object]

Returns​

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

searchVariables()​

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

Parameters​

a​

...[object, object, object]

Returns​

CancelablePromise<{ items: object[]; page: { endCursor: | { [key: number]: string; __brand: "EndCursor"; } | null; hasMoreTotalItems: boolean; startCursor: | { [key: number]: string; __brand: "StartCursor"; } | null; 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, object]

Returns​

CancelablePromise<void>

unassignClientFromGroup()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignClientFromTenant()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignGroupFromTenant()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignMappingRuleFromGroup()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignMappingRuleFromTenant()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignRoleFromClient()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignRoleFromGroup()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignRoleFromMappingRule()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignRoleFromTenant()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignRoleFromUser()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignUserFromGroup()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignUserFromTenant()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

unassignUserTask()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

updateAgentInstance()​

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

Parameters​

a​

...[object, 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; }, object]

Returns​

CancelablePromise<void>

updateGlobalClusterVariable()​

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

Parameters​

a​

...[object, object]

Returns​

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

updateGlobalTaskListener()​

updateGlobalTaskListener(...a): CancelablePromise<{
  afterNonGlobal?: boolean;
  eventTypes: GlobalTaskListenerEventTypeEnum[];
  id: string;
  priority?: number;
  retries?: number;
  source: GlobalListenerSourceEnum;
  type?: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ afterNonGlobal?: boolean; eventTypes: GlobalTaskListenerEventTypeEnum[]; id: string; priority?: number; retries?: number; source: GlobalListenerSourceEnum; type?: string; }>

updateGroup()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ description: string | null; groupId: string; name: string; }>

updateJob()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

updateMappingRule()​

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

Parameters​

a​

...[object, object]

Returns​

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

updateRole()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ description: string | null; name: string; roleId: string; }>

updateTenant()​

updateTenant(...a): CancelablePromise<{
  description: string | null;
  name: string;
  tenantId: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ description: string | null; name: string; tenantId: string; }>

updateTenantClusterVariable()​

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

Parameters​

a​

...[object, object]

Returns​

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

updateUser()​

updateUser(...a): CancelablePromise<{
  email: string | null;
  name: string | null;
  username: string;
}>;

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<{ email: string | null; name: string | null; username: string; }>

updateUserTask()​

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

Parameters​

a​

...[object, object]

Returns​

CancelablePromise<void>

withCorrelation()​

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

Parameters​

a​

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

Returns​

Promise<unknown>