@camunda8/sdk
Version:
[](https://www.npmjs.com/package/@camunda8/sdk)
1,780 lines • 429 kB
TypeScript
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
'/topology': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get cluster topology
* @description Obtains the current topology of the cluster the gateway is part of.
*/
get: operations['getTopology'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/license': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get license status
* @description Obtains the status of the current Camunda license.
*/
get: operations['getLicense'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/authentication/me': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get current user
* @description Retrieves the current authenticated user.
*/
get: operations['getAuthentication'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/jobs/activation': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Activate jobs
* @description Iterate through all known partitions and activate jobs up to the requested maximum.
*
*/
post: operations['activateJobs'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/jobs/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search jobs
* @description Search for jobs based on given criteria.
*/
post: operations['searchJobs'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/jobs/{jobKey}/failure': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Fail job
* @description Mark the job as failed
*
*/
post: operations['failJob'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/jobs/{jobKey}/error': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Throw error for job
* @description Reports a business error (i.e. non-technical) that occurs while processing a job.
*
*/
post: operations['throwJobError'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/jobs/{jobKey}/completion': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Complete job
* @description Complete a job with the given payload, which allows completing the associated service task.
*
*/
post: operations['completeJob'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/jobs/{jobKey}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update job
* @description Update a job with the given key.
*/
patch: operations['updateJob'];
trace?: never;
};
'/incidents/{incidentKey}/resolution': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Resolve incident
* @description Marks the incident as resolved; most likely a call to Update job will be necessary to reset the job’s retries, followed by this call.
*
*/
post: operations['resolveIncident'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create tenant
* @description Creates a new tenant.
*/
post: operations['createTenant'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/{tenantId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get tenant
* @description Retrieves a single tenant by tenant ID.
*/
get: operations['getTenant'];
/**
* Update tenant
* @description Updates an existing tenant.
*/
put: operations['updateTenant'];
post?: never;
/**
* Delete tenant
* @description Deletes an existing tenant.
*/
delete: operations['deleteTenant'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/{tenantId}/users/{username}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Assign a user to a tenant
* @description Assign a single user to a specified tenant.
*/
put: operations['assignUserToTenant'];
post?: never;
/**
* Remove a user from a tenant
* @description Removes a single user from a specified tenant without deleting the user.
*/
delete: operations['removeUserFromTenant'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/{tenantId}/users/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search users for tenant
* @description Retrieves a filtered and sorted list of users for a specified tenant.
*/
post: operations['searchUsersForTenant'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/{tenantId}/clients/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search clients for tenant
* @description Retrieves a filtered and sorted list of clients for a specified tenant.
*/
post: operations['searchClientsForTenant'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/{tenantId}/groups/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search groups for tenant
* @description Retrieves a filtered and sorted list of groups for a specified tenant.
*/
post: operations['searchGroupIdsForTenant'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/{tenantId}/roles/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search roles for tenant
* @description Retrieves a filtered and sorted list of roles for a specified tenant.
*/
post: operations['searchRolesForTenant'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/{tenantId}/clients/{clientId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Assign a client to a tenant
* @description Assign a client to a specified tenant.
*/
put: operations['assignClientToTenant'];
post?: never;
/**
* Remove a client from a tenant
* @description Removes a single client from a specified tenant.
*/
delete: operations['removeClientFromTenant'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/{tenantId}/mapping-rules/{mappingRuleId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Assign a mapping rule to a tenant
* @description Assign a single mapping rule to a specified tenant.
*/
put: operations['assignMappingRuleToTenant'];
post?: never;
/**
* Remove a mapping rule from a tenant
* @description Removes a single mapping rule from a specified tenant without deleting the rule.
*/
delete: operations['removeMappingRuleFromTenant'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/{tenantId}/mapping-rules/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search mapping rules for tenant
* @description Retrieves a filtered and sorted list of MappingRules for a specified tenant.
*/
post: operations['searchMappingsForTenant'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/{tenantId}/groups/{groupId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Assign a group to a tenant
* @description Assign a single group to a specified tenant.
*/
put: operations['assignGroupToTenant'];
post?: never;
/**
* Remove a group from a tenant
* @description Removes a single group from a specified tenant without deleting the group.
*/
delete: operations['removeGroupFromTenant'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/{tenantId}/roles/{roleId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Assign a role to a tenant
* @description Assign a single role to a specified tenant.
*/
put: operations['assignRoleToTenant'];
post?: never;
/**
* Remove a role from a tenant
* @description Removes a single role from a specified tenant without deleting the role.
*/
delete: operations['removeRoleFromTenant'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/tenants/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search tenants
* @description Retrieves a filtered and sorted list of tenants.
*/
post: operations['searchTenants'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/user-tasks/{userTaskKey}/completion': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Complete user task
* @description Completes a user task with the given key.
*/
post: operations['completeUserTask'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/user-tasks/{userTaskKey}/assignment': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Assign user task
* @description Assigns a user task with the given key to the given assignee.
*/
post: operations['assignUserTask'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/user-tasks/{userTaskKey}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get user task
* @description Get the user task by the user task key.
*
*/
get: operations['getUserTask'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update user task
* @description Update a user task with the given key.
*/
patch: operations['updateUserTask'];
trace?: never;
};
'/user-tasks/{userTaskKey}/form': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get user task form
* @description Get the form of a user task.
*
* Note that this endpoint will only return linked forms. This endpoint does not support embedded forms.
*
*/
get: operations['getUserTaskForm'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/user-tasks/{userTaskKey}/assignee': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Unassign user task
* @description Removes the assignee of a task with the given key.
*/
delete: operations['unassignUserTask'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/user-tasks/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search user tasks
* @description Search for user tasks based on given criteria.
*
*/
post: operations['searchUserTasks'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/user-tasks/{userTaskKey}/variables/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search user task variables
* @description Search for user task variables based on given criteria.
*
*/
post: operations['searchUserTaskVariables'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/variables/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search variables
* @description Search for process and local variables based on given criteria.
*
*/
post: operations['searchVariables'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/variables/{variableKey}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get variable
* @description Get the variable by the variable key.
*
*/
get: operations['getVariable'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/clock': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Pin internal clock (alpha)
* @description Set a precise, static time for the Zeebe engine’s internal clock.
* When the clock is pinned, it remains at the specified time and does not advance.
* To change the time, the clock must be pinned again with a new timestamp.
*
* This endpoint is an alpha feature and may be subject to change
* in future releases.
*
*/
put: operations['pinClock'];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/clock/reset': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Reset internal clock (alpha)
* @description Resets the Zeebe engine’s internal clock to the current system time, enabling it to tick in real-time.
* This operation is useful for returning the clock to
* normal behavior after it has been pinned to a specific time.
*
* This endpoint is an alpha feature and may be subject to change
* in future releases.
*
*/
post: operations['resetClock'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-definitions/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search process definitions
* @description Search for process definitions based on given criteria.
*
*/
post: operations['searchProcessDefinitions'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-definitions/{processDefinitionKey}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get process definition
* @description Returns process definition as JSON.
*
*/
get: operations['getProcessDefinition'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-definitions/{processDefinitionKey}/xml': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get process definition XML
* @description Returns process definition as XML.
*
*/
get: operations['getProcessDefinitionXML'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-definitions/{processDefinitionKey}/form': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get process start form
* @description Get the start form of a process.
*
* Note that this endpoint will only return linked forms. This endpoint does not support embedded forms.
*
*/
get: operations['getStartProcessForm'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-definitions/{processDefinitionKey}/statistics/element-instances': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Get process definition statistics
* @description Get statistics about elements in currently running process instances by process definition key and search filter.
*
*/
post: operations['getProcessDefinitionStatistics'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create process instance
* @description Creates and starts an instance of the specified process.
* The process definition to use to create the instance can be specified either using its unique key
* (as returned by Deploy resources), or using the BPMN process ID and a version.
*
* Waits for the completion of the process instance before returning a result
* when awaitCompletion is enabled.
*
*/
post: operations['createProcessInstance'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/{processInstanceKey}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get process instance
* @description Get the process instance by the process instance key.
*
*/
get: operations['getProcessInstance'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/{processInstanceKey}/sequence-flows': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get process instance sequence flows
* @description Get sequence flows taken by the process instance.
*
*/
get: operations['getProcessInstanceSequenceFlows'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/{processInstanceKey}/statistics/element-instances': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get process instance statistics
* @description Get statistics about elements by the process instance key.
*
*/
get: operations['getProcessInstanceStatistics'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search process instances
* @description Search for process instances based on given criteria.
*
*/
post: operations['searchProcessInstances'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/{processInstanceKey}/incidents/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search for incidents associated with a process instance
* @description Search for incidents caused by the process instance or any of its called process or decision instances.
*
*/
post: operations['searchProcessInstanceIncidents'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/{processInstanceKey}/cancellation': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cancel process instance
* @description Cancels a running process instance. As a cancelation includes more than just the removal of the process instance resource, the cancelation resource must be posted.
*/
post: operations['cancelProcessInstance'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/cancellation': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create a batch operation to cancel process instances
* @description Cancels multiple running process instances.
* Since only ACTIVE root instances can be cancelled, any given filters for state and
* parentProcessInstanceKey are ignored and overridden during this batch operation.
* This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).
*
*/
post: operations['cancelProcessInstancesBatchOperation'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/incident-resolution': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create a batch operation to resolve incidents of process instances
* @description Resolves multiple instances of process instances.
* Since only process instances with ACTIVE state can have unresolved incidents, any given
* filters for state are ignored and overridden during this batch operation.
* This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).
*
*/
post: operations['resolveIncidentsBatchOperation'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/migration': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create a batch operation to migrate process instances
* @description Migrate multiple instances of process instances.
* Since only process instances with ACTIVE state can be migrated, any given
* filters for state are ignored and overridden during this batch operation.
* This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).
*
*/
post: operations['migrateProcessInstancesBatchOperation'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/modification': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create a batch operation to modify process instances
* @description Modify multiple process instances.
* Since only process instances with ACTIVE state can be modified, any given
* filters for state are ignored and overridden during this batch operation.
* In contrast to single modification operation, it is not possible to add variable instructions or modify by element key.
* It is only possible to use the element id of the source and target.
* This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).
*
*/
post: operations['modifyProcessInstancesBatchOperation'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/{processInstanceKey}/migration': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Migrate process instance
* @description Migrates a process instance to a new process definition.
* This request can contain multiple mapping instructions to define mapping between the active
* process instance's elements and target process definition elements.
*
* Use this to upgrade a process instance to a new version of a process or to
* a different process definition, e.g. to keep your running instances up-to-date with the
* latest process improvements.
*
*/
post: operations['migrateProcessInstance'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/{processInstanceKey}/modification': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Modify process instance
* @description Modifies a running process instance.
* This request can contain multiple instructions to activate an element of the process or
* to terminate an active instance of an element.
*
* Use this to repair a process instance that is stuck on an element or took an unintended path.
* For example, because an external system is not available or doesn't respond as expected.
*
*/
post: operations['modifyProcessInstance'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/process-instances/{processInstanceKey}/call-hierarchy': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get call hierarchy for process instance
* @description Returns the call hierarchy for a given process instance, showing its ancestry up to the root instance.
*
*/
get: operations['getProcessInstanceCallHierarchy'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/element-instances/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search element instances
* @description Search for element instances based on given criteria.
*
*/
post: operations['searchElementInstances'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/element-instances/{elementInstanceKey}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get element instance
* @description Returns element instance as JSON.
*
*/
get: operations['getElementInstance'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/decision-definitions/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search decision definitions
* @description Search for decision definitions based on given criteria.
*
*/
post: operations['searchDecisionDefinitions'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/decision-definitions/{decisionDefinitionKey}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get decision definition
* @description Returns a decision definition by key.
*
*/
get: operations['getDecisionDefinition'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/decision-definitions/{decisionDefinitionKey}/xml': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get decision definition XML
* @description Returns decision definition as XML.
*
*/
get: operations['getDecisionDefinitionXML'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/decision-requirements/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search decision requirements
* @description Search for decision requirements based on given criteria.
*
*/
post: operations['searchDecisionRequirements'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/decision-requirements/{decisionRequirementsKey}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get decision requirements
* @description Returns Decision Requirements as JSON.
*
*/
get: operations['getDecisionRequirements'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/decision-requirements/{decisionRequirementsKey}/xml': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get decision requirements XML
* @description Returns decision requirements as XML.
*
*/
get: operations['getDecisionRequirementsXML'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/decision-instances/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search decision instances
* @description Search for decision instances based on given criteria.
*
*/
post: operations['searchDecisionInstances'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/decision-instances/{decisionInstanceId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get decision instance
* @description Returns a decision instance.
*
*/
get: operations['getDecisionInstance'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/decision-definitions/evaluation': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Evaluate decision
* @description Evaluates a decision.
* You specify the decision to evaluate either by using its unique key (as returned by
* DeployResource), or using the decision ID. When using the decision ID, the latest deployed
* version of the decision is used.
*
*/
post: operations['evaluateDecision'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/authorizations': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create authorization
* @description Create the authorization.
*/
post: operations['createAuthorization'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/authorizations/{authorizationKey}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get authorization
* @description Get authorization by the given key.
*/
get: operations['getAuthorization'];
/**
* Update authorization
* @description Update the authorization with the given key.
*/
put: operations['updateAuthorization'];
post?: never;
/**
* Delete authorization
* @description Deletes the authorization with the given key.
*/
delete: operations['deleteAuthorization'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/authorizations/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search authorizations
* @description Search for authorizations based on given criteria.
*
*/
post: operations['searchAuthorizations'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/roles': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create role
* @description Create a new role.
*
*/
post: operations['createRole'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/roles/{roleId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get role
* @description Get a role by its ID.
*
*/
get: operations['getRole'];
/**
* Update role
* @description Update a role with the given ID.
*
*/
put: operations['updateRole'];
post?: never;
/**
* Delete role
* @description Deletes the role with the given ID.
*
*/
delete: operations['deleteRole'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/roles/{roleId}/users/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search role users
* @description Search users with assigned role.
*
*/
post: operations['searchUsersForRole'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/roles/{roleId}/clients/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search role clients
* @description Search clients with assigned role.
*
*/
post: operations['searchClientsForRole'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/roles/{roleId}/users/{username}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Assign a role to a user
* @description Assigns a role to a user.
*
*/
put: operations['addRoleToUser'];
post?: never;
/**
* Unassign a user from a role
* @description Unassigns a user from a role.
*
*/
delete: operations['removeUserFromRole'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/roles/{roleId}/clients/{clientId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Assign a role to a client
* @description Assigns a role to a client.
*
*/
put: operations['addRoleToClient'];
post?: never;
/**
* Unassign a role from a client
* @description Unassigns a role from a client.
*
*/
delete: operations['removeRoleFromClient'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/roles/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search roles
* @description Search for roles based on given criteria.
*
*/
post: operations['searchRoles'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/roles/{roleId}/groups/{groupId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Assign a role to a group
* @description Assigns a role to a group.
*
*/
put: operations['addRoleToGroup'];
post?: never;
/**
* Unassign a role from a group
* @description Unassigns a role from a group.
*
*/
delete: operations['removeRoleFromGroup'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/roles/{roleId}/groups/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search role groups
* @description Search groups with assigned role.
*
*/
post: operations['searchGroupsForRole'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/roles/{roleId}/mapping-rules/{mappingRuleId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Assign a role to a mapping rule
* @description Assigns a role to a mapping rule.
*
*/
put: operations['addRoleToMappingRule'];
post?: never;
/**
* Unassign a role from a mapping rule
* @description Unassigns a role from a mapping rule.
*
*/
delete: operations['removeRoleFromMappingRule'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/roles/{roleId}/mapping-rules/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search role mapping rules
* @description Search mapping rules with assigned role.
*
*/
post: operations['searchMappingRulesForRole'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/groups': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create group
* @description Create a new group.
*
*/
post: operations['createGroup'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/groups/{groupId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get group
* @description Get a group by its ID.
*
*/
get: operations['getGroup'];
/**
* Update group
* @description Update a group with the given ID.
*
*/
put: operations['updateGroup'];
post?: never;
/**
* Delete group
* @description Deletes the group