@5minds/processcube_engine_client 4.3.1

package/dist/Types/RestSettings.d.ts

@@ -0,0 +1,674 @@
+export declare const restSettings: {
+    params: {
+        correlationId: string;
+        emptyActivityInstanceId: string;
+        eventId: string;
+        eventName: string;
+        externalTaskId: string;
+        flowNodeId: string;
+        flowNodeInstanceId: string;
+        manualTaskInstanceId: string;
+        processInstanceId: string;
+        processDefinitionId: string;
+        processModelId: string;
+        sessionId: string;
+        userId: string;
+        userTaskInstanceId: string;
+        userMetadataKey: string;
+    };
+    paths: {
+        /**
+         * Gets some basic info about the host application.
+         * @tags ApplicationInfo
+         * @method get
+         * @responseType ApplicationInfo
+         */
+        getApplicationInfo: string;
+        /**
+         * Gets the address of the authority that the host application uses for claim checks.
+         * @tags ApplicationInfo
+         * @method get
+         * @responseType string
+         */
+        getAuthorityAddress: string;
+        /**
+         * Returns the anonymous session with the given ID.
+         * @tags AnonymousSessions
+         * @method get
+         * @responseType AnonymousSession
+         */
+        getAnonymousSessionById: string;
+        /**
+         * Returns all anonymous sessions of the given User ID.
+         * @tags AnonymousSessions
+         * @method get
+         * @responseType Array<AnonymousSession>
+         */
+        getAnonymousSessionsByUserId: string;
+        /**
+         * Creates a new anonymous session and returns its ID.
+         * @tags AnonymousSessions
+         * @method post
+         * @responseType string
+         */
+        createAnonymousSession: string;
+        /**
+         * Gets all Correlations.
+         * @tags Correlations
+         * @method get
+         * @queryParams limit: number, offset: number, includeProcessInstances: boolean
+         * @responseType CorrelationList
+         */
+        getCorrelations: string;
+        /**
+         * Gets a Correlation by its ID.
+         * @tags Correlations
+         * @method get
+         * @queryParams includeProcessInstances: boolean
+         * @responseType Correlation
+         */
+        getCorrelationById: string;
+        /**
+         * Queries a list of deployed Cronjobs.
+         * @tags Cronjobs
+         * @method get
+         * @queryParams limit: number, offset: number, processDefinitionId: string, processModelID: string, startEventId: string, crontab: string, nextExecution: string
+         * @responseType DeployedCronjobList
+         */
+        getDeployedCronjobs: string;
+        /**
+         * Gets all active Cronjobs. DEPRECATED - Use "/cronjobs/query" instead
+         * @tags Cronjobs
+         * @method get
+         * @queryParams limit: number, offset: number
+         * @responseType CronjobList
+         */
+        getActiveCronjobs: string;
+        /**
+         * Queries a list of cronjob history entries that match the given query.
+         * @tags Cronjobs
+         * @method get
+         * @queryParams limit: number, offset: number: string, processDefinitionId: string, processModelId: string, startEventId: string, crontab: string, executedAt: string, createdAt: string, updatedAt: string
+         * @responseType CronjobHistoryList
+         */
+        getCronjobHistory: string;
+        /**
+         * Enables the given Cronjob for the given Process Model.
+         * @tags ProcessModels
+         * @method post
+         */
+        enableCronjob: string;
+        /**
+         * Disables the given Cronjob for the given ProcessModel.
+         * @tags ProcessModels
+         * @method post
+         */
+        disableCronjob: string;
+        /**
+         * Gets the DataObjectInstances that match the given query.
+         * @tags DataObjectInstances
+         * @method get
+         * @queryParams limit: number, offset: number: string, dataObjectId: string, processDefinitionId: string, processModelId: string, processInstanceId: string, flowNodeInstanceId: string, createdAt: string
+         * @responseType DataObjectInstanceList
+         */
+        getDataObjects: string;
+        /**
+         * Gets all FlowNodeInstances that match the given query.
+         * @tags FlowNodeInstances
+         * @method get
+         * @queryParams limit: number, offset: number, flowNodeInstanceId: string, flowNodeId: string, flowNodeName: string, flowNodeLane: string, flowNodeType: string, eventType: string, correlationId: string, processDefinitionId: string, processModelId: string, processInstanceId: string, ownerId: string, state: string, previousFlowNodeInstanceId: string, parentProcessInstanceId: string, createdAt: string, updatedAt: string, triggeredByFlowNodeInstance: Array<string> | string | SearchQuery
+         * @responseType FlowNodeInstanceList
+         */
+        queryFlowNodeInstances: string;
+        /**
+         * Triggers a MessageEvent by its name.
+         * @tags Events
+         * @queryParams processInstanceId: string
+         * @requestBody {"required": false, "bodyType": "application/json", "contentType": {"payload": {"type": "string"}}}
+         * @method post
+         */
+        triggerMessageEvent: string;
+        /**
+         * Triggers a SignalEvent by its name.
+         * @tags Events
+         * @method post
+         * @queryParams process_instance_id: string
+         * @requestBody {"required": false, "bodyType": "application/json", "contentType": {}}
+         */
+        triggerSignalEvent: string;
+        /**
+         * Finishes a specific EmptyActivity by its EmptyActivityInstanceId.
+         * @tags EmptyActivities
+         * @method put
+         */
+        finishEmptyActivity: string;
+        /**
+         * Finishes a specific ManualTask by its ManualTaskInstanceId.
+         * @tags ManualTasks
+         * @method put
+         */
+        finishManualTask: string;
+        /**
+         * Finishes a specific UserTask by its UserTaskInstanceId.
+         * @tags UserTasks
+         * @method put
+         */
+        finishUserTask: string;
+        /**
+         * Reserves a UserTask for a specific User.
+         * @tags UserTasks
+         * @method put
+         * @requestBody {"required": true, "bodyType": "application/json", "contentType": {"actualOwnerId": {"type": "string", "required": true}}}
+         */
+        reserveUserTaskInstance: string;
+        /**
+         * Cancels the reservation of the given UserTask instance.
+         * @tags UserTasks
+         * @method delete
+         */
+        cancelUserTaskInstanceReservation: string;
+        /**
+         * Fetches a list of all ExternalTask topics from all deployed Process Models.
+         * @tags ExternalTasks
+         * @method get
+         * @responseType Array<string>
+         */
+        getAllDeployedTopics: string;
+        /**
+         * Fetches the tasks available for an ExternalTaskWorker and locks them for a defined time.
+         * @tags ExternalTasks
+         * @method post
+         * @requestBody {"required": true, "bodyType": "application/json", "contentType": "FetchAndLockRequestPayload", "example": "{\"workerId\": \"string\", \"topicName\": \"string | Array<string>\", \"maxTasks\": 10, \"longPollingTimeout\": 2000, \"lockDuration\": 10000, \"payloadFilter\": \"string\"}"}
+         * @responseType Array<ExternalTask>
+         */
+        fetchAndLockExternalTasks: string;
+        /**
+         * Extends the lock duration of an ExternalTask by a given amount of time.
+         * @tags ExternalTasks
+         * @method put
+         * @requestBody {"required": true, "bodyType": "application/json", "contentType": "ExtendLockRequestPayload"}
+         */
+        extendExternalTaskLock: string;
+        /**
+         * DEPRECATED - Use `PUT /external_tasks/:external_task_id/error` instead.
+         * @tags ExternalTasks
+         * @method put
+         * @requestBody {"required": true, "bodyType": "application/json", "contentType": "HandleBpmnErrorRequestPayload"}
+         */
+        finishExternalTaskWithBpmnError: string;
+        /**
+         * DEPRECATED - Use `PUT /external_tasks/:external_task_id/error` instead.
+         * @tags ExternalTasks
+         * @method put
+         * @requestBody {"required": true, "bodyType": "application/json", "contentType": "HandleServiceErrorRequestPayload"}
+         */
+        finishExternalTaskWithServiceError: string;
+        /**
+         * Finishes the given External Task with the given Error.
+         * @tags ExternalTasks
+         * @method put
+         * @requestBody {"required": true, "bodyType": "application/json", "contentType": "HandleServiceErrorRequestPayload"}
+         */
+        finishExternalTaskWithError: string;
+        /**
+         * Finishes the ExternalTask with the given ID.
+         * @tags ExternalTasks
+         * @method put
+         * @requestBody {"required": true, "bodyType": "application/json", "contentType": "FinishExternalTaskRequestPayload"}
+         */
+        finishExternalTask: string;
+        /**
+         * Creates or updates a ProcessDefinition or a list of ProcessDefinitions.
+         * @tags ProcessDefinitions
+         * @method post
+         * @requestBody {"required": true, "bodyType": "application/json", "contentType": "PersistProcessDefinitionsPayload", "example": "{\"xml\": \"string | Array<string>\", \"overrideExisting\": true}"}
+         */
+        persistProcessDefinitions: string;
+        /**
+         * Gets all ProcessDefinitions the requesting user is allowed to see.
+         * @tags ProcessDefinitions
+         * @method get
+         * @queryParams offset: number, limit: number
+         * @responseType ProcessDefinitionList
+         */
+        getProcessDefinitions: string;
+        /**
+         * Gets a ProcessDefinition by its id.
+         * @tags ProcessDefinitions
+         * @method get
+         * @responseType ProcessDefinition
+         */
+        getProcessDefinitionById: string;
+        /**
+         * Deletes the ProcessDefinition with the given ID.
+         * Per default, a Process is only flagged as deleted. To actually delete the Process and all related data, set "delete_all_related_data" to "true".
+         * @tags ProcessDefinitions
+         * @method delete
+         * @queryParams delete_all_related_data: boolean
+         */
+        deleteProcessDefinition: string;
+        /**
+         * Gets all currently deployed Process Models.
+         * @tags ProcessModels
+         * @method get
+         * @responseType ProcessModelList
+         */
+        getAllProcessModels: string;
+        /**
+         * Gets a deployed Process Model by its ID.
+         * @tags ProcessModels
+         * @method get
+         * @responseType ProcessModel
+         */
+        getProcessModelById: string;
+        /**
+         * Gets a ProcessDefinition for a given ProcessModel.
+         * @tags ProcessModels
+         * @method get
+         * @responseType ProcessDefinition
+         */
+        getProcessDefinitionForProcessModel: string;
+        /**
+         * Starts a new instance from the given set of parameters.
+         * @tags ProcessModels
+         * @method post
+         * @requestBody {"required": true, "bodyType": "application/json", "contentType": "ProcessStartRequest"}
+         * @responseType ProcessStartResponse
+         */
+        startProcessInstance: string;
+        /**
+         * Deletes the ProcessDefinition that contains the Process Model with the given ID.
+         * Per default, a Process is only flagged as deleted. To actually delete the Process and all related data, set "delete_all_related_data" to "true".
+         * @tags ProcessModels
+         * @method delete
+         * @queryParams delete_all_related_data: boolean
+         */
+        deleteProcessDefinitionByProcessModelId: string;
+        /**
+         * Enables the given Process Model.
+         * @tags ProcessModels
+         * @method post
+         */
+        enableProcessModel: string;
+        /**
+         * Disables the given Process Model.
+         * @tags ProcessModels
+         * @method post
+         */
+        disableProcessModel: string;
+        /**
+         * Gets all ProcessInstances that match the given query.
+         * @tags ProcessInstances
+         * @method get
+         * @queryParams offset: number, limit: number, correlationId: Array<string> | string | SearchQuery, processInstanceId: Array<string> | string | SearchQuery, processDefinitionId: Array<string> | string | SearchQuery, processModelId: Array<string> | string | SearchQuery, processModelName: Array<string> | string | SearchQuery, processModelHash: Array<string> | string | SearchQuery, ownerId: Array<string> | string | SearchQuery, state: Array<string> | string | SearchQuery, parentProcessInstanceId: Array<string> | string | SearchQuery, terminatedByUserId: Array<string> | string | SearchQuery, createdBefore: Date, createdAt: Array<Date> | Date, createdAfter: Date, updatedBefore: Date, updatedAt: Array<Date> | Date, updatedAfter: Date, finishedBefore: Date, finishedAt: Array<Date> | Date, finishedAfter: Date, triggeredByFlowNodeInstance: Array<string> | string | SearchQuery
+         * @responseType ProcessInstanceList
+         */
+        queryProcessInstances: string;
+        /**
+         * Gets the ProcessDefinition for a given ProcessInstance.
+         * @tags ProcessInstances
+         * @method get
+         * @responseType ProcessDefinition
+         */
+        getProcessDefinitionForProcessInstance: string;
+        /**
+         * Gets the ProcessModel for a given ProcessInstance.
+         * @tags ProcessInstances
+         * @method get
+         * @responseType ProcessModel
+         */
+        getProcessModelForProcessInstance: string;
+        /**
+         * Changes the owner of the ProcessInstance with the given ID.
+         * @tags ProcessInstances
+         * @method post
+         * @requestBody {"required": true, "bodyType": "application/json", "contentType": {"newOwner": {"type": "Identity"}}}
+         */
+        changeProcessInstanceOwner: string;
+        /**
+         * Terminates the ProcessInstance with the given ID.
+         * @tags ProcessInstances
+         * @method put
+         */
+        terminateProcessInstances: string;
+        /**
+         * Retries a failed or terminated Process Instance from the original point of failure.
+         * Alternatively, the Process Instance can be reset to a specific flow Node Instance, provided with the "flow_node_instance_id" Query parameter
+         * @tags ProcessInstances
+         * @method put
+         * @queryParams flow_node_instance_id: string
+         * @requestBody {"required": false, "bodyType": "application/json", "contentType": {"newStartToken": {"type": "object"}}}
+         */
+        retryProcessInstance: string;
+        /**
+         * Deletes the given Set of Process Instances. Multiple ProcessInstanceIds can be provided with ";" as separator.
+         * Per default, a Process Instance is only flagged as deleted. To actually delete the Process Instances and all related data, set "delete_all_related_data" to "true".
+         * @tags ProcessInstances
+         * @method delete
+         * @queryParams process_instance_ids: string | Array<string>, delete_all_related_data: boolean
+         */
+        deleteProcessInstances: string;
+        /**
+         * Queries all values by the given keys
+         * @tags UserMetadata
+         * @method get
+         * @queryParams keys: string | Array<string>
+         */
+        queryUserMetadata: string;
+        /**
+         * Gets a value by the given key
+         * @tags UserMetadata
+         * @method get
+         */
+        getUserMetadata: string;
+        /**
+         * Sets a value for the given key
+         * @tags UserMetadata
+         * @method post
+         */
+        setUserMetadata: string;
+        /**
+         * Removes a value for the given key
+         * @tags UserMetadata
+         * @method delete
+         */
+        removeUserMetadata: string;
+        /**
+         * Wait for a CronjobCreated notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType CronjobEventMessage
+         */
+        onCronjobCreated: string;
+        /**
+         * Wait for a CronjobExecuted notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType CronjobEventMessage
+         */
+        onCronjobExecuted: string;
+        /**
+         * Wait for a CronjobStopped notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType CronjobEventMessage
+         */
+        onCronjobStopped: string;
+        /**
+         * Wait for a CronjobUpdated notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType CronjobEventMessage
+         */
+        onCronjobUpdated: string;
+        /**
+         * Wait for a CronjobRemoved notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType CronjobEventMessage
+         */
+        onCronjobRemoved: string;
+        /**
+         * Wait for a ProcessDeployed notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType ProcessDeploymentMessage
+         */
+        onProcessDeployed: string;
+        /**
+         * Wait for a ProcessIsExecutableChanged notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType ProcessIsExecutableChangedMessage
+         */
+        onProcessIsExecutableChanged: string;
+        /**
+         * Wait for a CronjobEnabledChanged notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType CronjobEnabledChangedMessage
+         */
+        onCronjobEnabledChanged: string;
+        /**
+         * Wait for a ProcessUndeployed notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType ProcessDeploymentMessage
+         */
+        onProcessUndeployed: string;
+        /**
+         * Wait for a ProcessStarting notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onProcessStarting: string;
+        /**
+         * Wait for a ProcessStarted notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onProcessStarted: string;
+        /**
+         * Wait for a ProcessResumed notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onProcessResumed: string;
+        /**
+         * Wait for a ProcessEnded notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onProcessEnded: string;
+        /**
+         * Wait for a ProcessOwnerChanged notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onProcessOwnerChanged: string;
+        /**
+         * Wait for a ProcessTerminated notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onProcessTerminated: string;
+        /**
+         * Wait for a ProcessError notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onProcessError: string;
+        /**
+         * Wait for a ProcessInstancesDeleted notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onProcessInstancesDeleted: string;
+        /**
+         * Wait for an ExternalTaskCreated notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType ExternalTaskCreatedMessage
+         */
+        onExternalTaskCreated: string;
+        /**
+         * Wait for a ExternalTaskLocked notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType ExternalTaskLockedMessage
+         */
+        onExternalTaskLocked: string;
+        /**
+         * Wait for a ExternalTaskUnlocked notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType ExternalTaskUnlockedMessage
+         */
+        onExternalTaskUnlocked: string;
+        /**
+         * Wait for a ExternalTaskExpired notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType ExternalTaskExpiredMessage
+         */
+        onExternalTaskExpired: string;
+        /**
+         * Wait for an ActivityReached notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onActivityReached: string;
+        /**
+         * Wait for an ActivityFinished notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onActivityFinished: string;
+        /**
+         * Wait for an EmptyActivityWaiting notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onEmptyActivityWaiting: string;
+        /**
+         * Wait for an EmptyActivityFinished notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onEmptyActivityFinished: string;
+        /**
+         * Wait for a ManualTaskWaiting notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onManualTaskWaiting: string;
+        /**
+         * Wait for a ManualTaskFinied notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onManualTaskFinished: string;
+        /**
+         * Wait for a UserTaskWaiting notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onUserTaskWaiting: string;
+        /**
+         * Wait for a UserTaskFinished notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onUserTaskFinished: string;
+        /**
+         * Wait for a UserTaskReserved notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onUserTaskReserved: string;
+        /**
+         * Wait for a UserTaskReservationCanceled notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onUserTaskReservationCanceled: string;
+        /**
+         * Wait for a BoundaryEventTriggered notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onBoundaryEventTriggered: string;
+        /**
+         * Wait for an IntermediateThrowEventTriggered notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onIntermediateThrowEventTriggered: string;
+        /**
+         * Wait for an IntermediateCatchEventReached notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onIntermediateCatchEventReached: string;
+        /**
+         *
+         * Wait for a IntermediateCatchEventFinished notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onIntermediateCatchEventFinished: string;
+        /**
+         *
+         * Wait for a FlowNodeEventRetrySending notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onFlowNodeEventRetrySending: string;
+        /**
+         * Wait for an MessageTriggered notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onMessageTriggered: string;
+        /**
+         * Wait for an SignalTriggered notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onSignalTriggered: string;
+        /**
+         * Wait for an EndEventFinished notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onEndEventFinished: string;
+        /**
+         * Wait for an StartEventFinished notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onStartEventFinished: string;
+        /**
+         * Wait for a ProcessInstanceMetadataChanged notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType MetadataChangedMessage
+         */
+        onProcessInstanceMetadataChanged: string;
+        /**
+         * Wait for a CorrelationMetadataChanged notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType MetadataChangedMessage
+         */
+        onCorrelationMetadataChanged: string;
+    };
+    baseRoute: string;
+};