@miragon/pulse-engine-client 0.0.0-bootstrap.0 → 0.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/dist/client.d.ts +65 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +144 -0
- package/dist/client.js.map +1 -0
- package/dist/engine-contract/batches.d.ts +41 -0
- package/dist/engine-contract/batches.d.ts.map +1 -0
- package/dist/engine-contract/batches.js +39 -0
- package/dist/engine-contract/batches.js.map +1 -0
- package/dist/engine-contract/index.d.ts +11 -0
- package/dist/engine-contract/index.d.ts.map +1 -0
- package/dist/engine-contract/index.js +11 -0
- package/dist/engine-contract/index.js.map +1 -0
- package/dist/engine-contract/reads.d.ts +43 -0
- package/dist/engine-contract/reads.d.ts.map +1 -0
- package/dist/engine-contract/reads.js +86 -0
- package/dist/engine-contract/reads.js.map +1 -0
- package/dist/engine-error.d.ts +73 -0
- package/dist/engine-error.d.ts.map +1 -0
- package/dist/engine-error.js +231 -0
- package/dist/engine-error.js.map +1 -0
- package/dist/generated/client/client.gen.d.ts +3 -0
- package/dist/generated/client/client.gen.d.ts.map +1 -0
- package/dist/generated/client/client.gen.js +217 -0
- package/dist/generated/client/client.gen.js.map +1 -0
- package/dist/generated/client/index.d.ts +11 -0
- package/dist/generated/client/index.d.ts.map +1 -0
- package/dist/generated/client/index.js +7 -0
- package/dist/generated/client/index.js.map +1 -0
- package/dist/generated/client/types.gen.d.ts +121 -0
- package/dist/generated/client/types.gen.d.ts.map +1 -0
- package/dist/generated/client/types.gen.js +3 -0
- package/dist/generated/client/types.gen.js.map +1 -0
- package/dist/generated/client/utils.gen.d.ts +38 -0
- package/dist/generated/client/utils.gen.d.ts.map +1 -0
- package/dist/generated/client/utils.gen.js +229 -0
- package/dist/generated/client/utils.gen.js.map +1 -0
- package/dist/generated/client.gen.d.ts +13 -0
- package/dist/generated/client.gen.d.ts.map +1 -0
- package/dist/generated/client.gen.js +5 -0
- package/dist/generated/client.gen.js.map +1 -0
- package/dist/generated/core/auth.gen.d.ts +26 -0
- package/dist/generated/core/auth.gen.d.ts.map +1 -0
- package/dist/generated/core/auth.gen.js +15 -0
- package/dist/generated/core/auth.gen.js.map +1 -0
- package/dist/generated/core/bodySerializer.gen.d.ts +26 -0
- package/dist/generated/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/bodySerializer.gen.js +58 -0
- package/dist/generated/core/bodySerializer.gen.js.map +1 -0
- package/dist/generated/core/params.gen.d.ts +44 -0
- package/dist/generated/core/params.gen.d.ts.map +1 -0
- package/dist/generated/core/params.gen.js +110 -0
- package/dist/generated/core/params.gen.js.map +1 -0
- package/dist/generated/core/pathSerializer.gen.d.ts +34 -0
- package/dist/generated/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/pathSerializer.gen.js +107 -0
- package/dist/generated/core/pathSerializer.gen.js.map +1 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/queryKeySerializer.gen.js +93 -0
- package/dist/generated/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/generated/core/serverSentEvents.gen.js +133 -0
- package/dist/generated/core/serverSentEvents.gen.js.map +1 -0
- package/dist/generated/core/types.gen.d.ts +84 -0
- package/dist/generated/core/types.gen.d.ts.map +1 -0
- package/dist/generated/core/types.gen.js +3 -0
- package/dist/generated/core/types.gen.js.map +1 -0
- package/dist/generated/core/utils.gen.d.ts +20 -0
- package/dist/generated/core/utils.gen.d.ts.map +1 -0
- package/dist/generated/core/utils.gen.js +88 -0
- package/dist/generated/core/utils.gen.js.map +1 -0
- package/dist/generated/index.d.ts +3 -0
- package/dist/generated/index.d.ts.map +1 -0
- package/dist/generated/index.js +3 -0
- package/dist/generated/index.js.map +1 -0
- package/dist/generated/sdk.gen.d.ts +3207 -0
- package/dist/generated/sdk.gen.d.ts.map +1 -0
- package/dist/generated/sdk.gen.js +5794 -0
- package/dist/generated/sdk.gen.js.map +1 -0
- package/dist/generated/types.gen.d.ts +27591 -0
- package/dist/generated/types.gen.d.ts.map +1 -0
- package/dist/generated/types.gen.js +3 -0
- package/dist/generated/types.gen.js.map +1 -0
- package/dist/hey-api.d.ts +10 -0
- package/dist/hey-api.d.ts.map +1 -0
- package/dist/hey-api.js +27 -0
- package/dist/hey-api.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -0
- package/package.json +56 -5
|
@@ -0,0 +1,3207 @@
|
|
|
1
|
+
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from './client/index.js';
|
|
2
|
+
import type { AddAttachmentData, AddAttachmentErrors, AddAttachmentResponses, AddIdentityLinkData, AddIdentityLinkErrors, AddIdentityLinkResponses, AvailableGroupInstanceOperationsData, AvailableGroupInstanceOperationsResponses, AvailableGroupMembersOperationsData, AvailableGroupMembersOperationsResponses, AvailableGroupOperationsData, AvailableGroupOperationsResponses, AvailableOperationsAuthorizationData, AvailableOperationsAuthorizationInstanceData, AvailableOperationsAuthorizationInstanceResponses, AvailableOperationsAuthorizationResponses, AvailableOperationsData, AvailableOperationsResponses, AvailableTenantGroupMembersOperationsData, AvailableTenantGroupMembersOperationsResponses, AvailableTenantInstanceOperationsData, AvailableTenantInstanceOperationsResponses, AvailableTenantResourceOperationsData, AvailableTenantResourceOperationsResponses, AvailableTenantUserMembersOperationsData, AvailableTenantUserMembersOperationsResponses, AvailableUserOperationsData, AvailableUserOperationsResponses, CheckPasswordData, CheckPasswordErrors, CheckPasswordResponses, ClaimData, ClaimErrors, ClaimResponses, CleanupAsyncData, CleanupAsyncErrors, CleanupAsyncResponses, ClearAnnotationUserOperationLogData, ClearAnnotationUserOperationLogErrors, ClearAnnotationUserOperationLogResponses, ClearIncidentAnnotationData, ClearIncidentAnnotationErrors, ClearIncidentAnnotationResponses, CompleteData, CompleteErrors, CompleteExternalTaskResourceData, CompleteExternalTaskResourceErrors, CompleteExternalTaskResourceResponses, CompleteResponses, ConfigureTelemetryData, ConfigureTelemetryErrors, ConfigureTelemetryResponses, CorrelateMessageAsyncOperationData, CorrelateMessageAsyncOperationErrors, CorrelateMessageAsyncOperationResponses, CreateAuthorizationData, CreateAuthorizationErrors, CreateAuthorizationResponses, CreateCommentData, CreateCommentErrors, CreateCommentResponses, CreateDeploymentData, CreateDeploymentErrors, CreateDeploymentResponses, CreateFilterData, CreateFilterErrors, CreateFilterResponses, CreateGroupData, CreateGroupErrors, CreateGroupMemberData, CreateGroupMemberErrors, CreateGroupMemberResponses, CreateGroupMembershipData, CreateGroupMembershipErrors, CreateGroupMembershipResponses, CreateGroupResponses, CreateIncidentData, CreateIncidentErrors, CreateIncidentResponses, CreateTaskData, CreateTaskErrors, CreateTaskResponses, CreateTenantData, CreateTenantErrors, CreateTenantResponses, CreateUserData, CreateUserMembershipData, CreateUserMembershipErrors, CreateUserMembershipResponses, CreateUserResponses, DelegateTaskData, DelegateTaskErrors, DelegateTaskResponses, DeleteAsyncData, DeleteAsyncErrors, DeleteAsyncHistoricQueryBasedData, DeleteAsyncHistoricQueryBasedErrors, DeleteAsyncHistoricQueryBasedResponses, DeleteAsyncResponses, DeleteAttachmentData, DeleteAttachmentErrors, DeleteAttachmentResponses, DeleteAuthorizationData, DeleteAuthorizationErrors, DeleteAuthorizationResponses, DeleteBatchData, DeleteBatchErrors, DeleteBatchResponses, DeleteDeploymentData, DeleteDeploymentErrors, DeleteDeploymentResponses, DeleteFilterData, DeleteFilterErrors, DeleteFilterResponses, DeleteGroupData, DeleteGroupErrors, DeleteGroupMemberData, DeleteGroupMemberErrors, DeleteGroupMemberResponses, DeleteGroupMembershipData, DeleteGroupMembershipErrors, DeleteGroupMembershipResponses, DeleteGroupResponses, DeleteHistoricBatchData, DeleteHistoricBatchErrors, DeleteHistoricBatchResponses, DeleteHistoricProcessInstanceData, DeleteHistoricProcessInstanceErrors, DeleteHistoricProcessInstanceResponses, DeleteHistoricProcessInstancesAsyncData, DeleteHistoricProcessInstancesAsyncErrors, DeleteHistoricProcessInstancesAsyncResponses, DeleteHistoricVariableInstanceData, DeleteHistoricVariableInstanceErrors, DeleteHistoricVariableInstanceResponses, DeleteHistoricVariableInstancesOfHistoricProcessInstanceData, DeleteHistoricVariableInstancesOfHistoricProcessInstanceErrors, DeleteHistoricVariableInstancesOfHistoricProcessInstanceResponses, DeleteIdentityLinkData, DeleteIdentityLinkErrors, DeleteIdentityLinkResponses, DeleteJobData, DeleteJobErrors, DeleteJobResponses, DeleteLocalExecutionVariableData, DeleteLocalExecutionVariableResponses, DeleteProcessDefinitionData, DeleteProcessDefinitionErrors, DeleteProcessDefinitionResponses, DeleteProcessDefinitionsByKeyAndTenantIdData, DeleteProcessDefinitionsByKeyAndTenantIdErrors, DeleteProcessDefinitionsByKeyAndTenantIdResponses, DeleteProcessDefinitionsByKeyData, DeleteProcessDefinitionsByKeyErrors, DeleteProcessDefinitionsByKeyResponses, DeleteProcessInstanceCommentData, DeleteProcessInstanceCommentErrors, DeleteProcessInstanceCommentResponses, DeleteProcessInstanceCommentsData, DeleteProcessInstanceCommentsErrors, DeleteProcessInstanceCommentsResponses, DeleteProcessInstanceData, DeleteProcessInstanceErrors, DeleteProcessInstanceResponses, DeleteProcessInstancesAsyncOperationData, DeleteProcessInstancesAsyncOperationErrors, DeleteProcessInstancesAsyncOperationResponses, DeleteProcessInstanceVariableData, DeleteProcessInstanceVariableResponses, DeleteTaskCommentData, DeleteTaskCommentErrors, DeleteTaskCommentResponses, DeleteTaskCommentsData, DeleteTaskCommentsErrors, DeleteTaskCommentsResponses, DeleteTaskData, DeleteTaskErrors, DeleteTaskLocalVariableData, DeleteTaskLocalVariableErrors, DeleteTaskLocalVariableResponses, DeleteTaskMetricsData, DeleteTaskMetricsErrors, DeleteTaskMetricsResponses, DeleteTaskResponses, DeleteTaskVariableData, DeleteTaskVariableErrors, DeleteTaskVariableResponses, DeleteTenantData, DeleteTenantErrors, DeleteTenantResponses, DeleteUserData, DeleteUserErrors, DeleteUserMembershipData, DeleteUserMembershipErrors, DeleteUserMembershipResponses, DeleteUserResponses, DeliverMessageData, DeliverMessageErrors, DeliverMessageResponses, EvaluateConditionData, EvaluateConditionErrors, EvaluateConditionResponses, EvaluateDecisionByIdData, EvaluateDecisionByIdErrors, EvaluateDecisionByIdResponses, EvaluateDecisionByKeyAndTenantData, EvaluateDecisionByKeyAndTenantErrors, EvaluateDecisionByKeyAndTenantResponses, EvaluateDecisionByKeyData, EvaluateDecisionByKeyErrors, EvaluateDecisionByKeyResponses, ExecuteFilterCountData, ExecuteFilterCountErrors, ExecuteFilterCountResponses, ExecuteFilterListData, ExecuteFilterListErrors, ExecuteFilterListResponses, ExecuteFilterSingleResultData, ExecuteFilterSingleResultErrors, ExecuteFilterSingleResultResponses, ExecuteJobData, ExecuteJobErrors, ExecuteJobResponses, ExecuteMigrationPlanAsyncData, ExecuteMigrationPlanAsyncErrors, ExecuteMigrationPlanAsyncResponses, ExecuteMigrationPlanData, ExecuteMigrationPlanErrors, ExecuteMigrationPlanResponses, ExecuteModificationAsyncData, ExecuteModificationAsyncErrors, ExecuteModificationAsyncResponses, ExecuteModificationData, ExecuteModificationErrors, ExecuteModificationResponses, ExtendLockData, ExtendLockErrors, ExtendLockResponses, FetchAndLockData, FetchAndLockErrors, FetchAndLockResponses, FilterResourceOptionsData, FilterResourceOptionsResponses, FilterResourceOptionsSingleData, FilterResourceOptionsSingleResponses, FindCleanupJobData, FindCleanupJobErrors, FindCleanupJobResponses, FindCleanupJobsData, FindCleanupJobsErrors, FindCleanupJobsResponses, GenerateMigrationPlanData, GenerateMigrationPlanErrors, GenerateMigrationPlanResponses, GetActivityInstanceTreeData, GetActivityInstanceTreeErrors, GetActivityInstanceTreeResponses, GetActivityStatisticsByProcessDefinitionKeyAndTenantIdData, GetActivityStatisticsByProcessDefinitionKeyAndTenantIdErrors, GetActivityStatisticsByProcessDefinitionKeyAndTenantIdResponses, GetActivityStatisticsByProcessDefinitionKeyData, GetActivityStatisticsByProcessDefinitionKeyErrors, GetActivityStatisticsByProcessDefinitionKeyResponses, GetActivityStatisticsData, GetActivityStatisticsErrors, GetActivityStatisticsResponses, GetAttachmentData, GetAttachmentDataData, GetAttachmentDataErrors, GetAttachmentDataResponses, GetAttachmentErrors, GetAttachmentResponses, GetAttachmentsData, GetAttachmentsErrors, GetAttachmentsResponses, GetAuthorizationCountData, GetAuthorizationCountErrors, GetAuthorizationCountResponses, GetAuthorizationData, GetAuthorizationErrors, GetAuthorizationResponses, GetBatchData, GetBatchErrors, GetBatchesCountData, GetBatchesCountErrors, GetBatchesCountResponses, GetBatchesData, GetBatchesErrors, GetBatchesResponses, GetBatchResponses, GetBatchStatisticsCountData, GetBatchStatisticsCountErrors, GetBatchStatisticsCountResponses, GetBatchStatisticsData, GetBatchStatisticsErrors, GetBatchStatisticsResponses, GetCleanableHistoricBatchesReportCountData, GetCleanableHistoricBatchesReportCountErrors, GetCleanableHistoricBatchesReportCountResponses, GetCleanableHistoricBatchesReportData, GetCleanableHistoricBatchesReportErrors, GetCleanableHistoricBatchesReportResponses, GetCleanableHistoricDecisionInstanceReportCountData, GetCleanableHistoricDecisionInstanceReportCountErrors, GetCleanableHistoricDecisionInstanceReportCountResponses, GetCleanableHistoricDecisionInstanceReportData, GetCleanableHistoricDecisionInstanceReportErrors, GetCleanableHistoricDecisionInstanceReportResponses, GetCleanableHistoricProcessInstanceReportCountData, GetCleanableHistoricProcessInstanceReportCountErrors, GetCleanableHistoricProcessInstanceReportCountResponses, GetCleanableHistoricProcessInstanceReportData, GetCleanableHistoricProcessInstanceReportErrors, GetCleanableHistoricProcessInstanceReportResponses, GetCommentData, GetCommentErrors, GetCommentResponses, GetCommentsData, GetCommentsErrors, GetCommentsResponses, GetDecisionDefinitionByIdData, GetDecisionDefinitionByIdErrors, GetDecisionDefinitionByIdResponses, GetDecisionDefinitionByKeyAndTenantIdData, GetDecisionDefinitionByKeyAndTenantIdErrors, GetDecisionDefinitionByKeyAndTenantIdResponses, GetDecisionDefinitionByKeyData, GetDecisionDefinitionByKeyErrors, GetDecisionDefinitionByKeyResponses, GetDecisionDefinitionDiagramByKeyAndTenantData, GetDecisionDefinitionDiagramByKeyAndTenantErrors, GetDecisionDefinitionDiagramByKeyAndTenantResponses, GetDecisionDefinitionDiagramByKeyData, GetDecisionDefinitionDiagramByKeyErrors, GetDecisionDefinitionDiagramByKeyResponses, GetDecisionDefinitionDiagramData, GetDecisionDefinitionDiagramErrors, GetDecisionDefinitionDiagramResponses, GetDecisionDefinitionDmnXmlByIdData, GetDecisionDefinitionDmnXmlByIdErrors, GetDecisionDefinitionDmnXmlByIdResponses, GetDecisionDefinitionDmnXmlByKeyAndTenantData, GetDecisionDefinitionDmnXmlByKeyAndTenantErrors, GetDecisionDefinitionDmnXmlByKeyAndTenantResponses, GetDecisionDefinitionDmnXmlByKeyData, GetDecisionDefinitionDmnXmlByKeyErrors, GetDecisionDefinitionDmnXmlByKeyResponses, GetDecisionDefinitionsCountData, GetDecisionDefinitionsCountErrors, GetDecisionDefinitionsCountResponses, GetDecisionDefinitionsData, GetDecisionDefinitionsErrors, GetDecisionDefinitionsResponses, GetDecisionRequirementsDefinitionByIdData, GetDecisionRequirementsDefinitionByIdErrors, GetDecisionRequirementsDefinitionByIdResponses, GetDecisionRequirementsDefinitionByKeyAndTenantIdData, GetDecisionRequirementsDefinitionByKeyAndTenantIdErrors, GetDecisionRequirementsDefinitionByKeyAndTenantIdResponses, GetDecisionRequirementsDefinitionByKeyData, GetDecisionRequirementsDefinitionByKeyErrors, GetDecisionRequirementsDefinitionByKeyResponses, GetDecisionRequirementsDefinitionDiagramByIdData, GetDecisionRequirementsDefinitionDiagramByIdErrors, GetDecisionRequirementsDefinitionDiagramByIdResponses, GetDecisionRequirementsDefinitionDiagramByKeyAndTenantIdData, GetDecisionRequirementsDefinitionDiagramByKeyAndTenantIdErrors, GetDecisionRequirementsDefinitionDiagramByKeyAndTenantIdResponses, GetDecisionRequirementsDefinitionDiagramByKeyData, GetDecisionRequirementsDefinitionDiagramByKeyErrors, GetDecisionRequirementsDefinitionDiagramByKeyResponses, GetDecisionRequirementsDefinitionDmnXmlByIdData, GetDecisionRequirementsDefinitionDmnXmlByIdErrors, GetDecisionRequirementsDefinitionDmnXmlByIdResponses, GetDecisionRequirementsDefinitionDmnXmlByKeyAndTenantIdData, GetDecisionRequirementsDefinitionDmnXmlByKeyAndTenantIdErrors, GetDecisionRequirementsDefinitionDmnXmlByKeyAndTenantIdResponses, GetDecisionRequirementsDefinitionDmnXmlByKeyData, GetDecisionRequirementsDefinitionDmnXmlByKeyErrors, GetDecisionRequirementsDefinitionDmnXmlByKeyResponses, GetDecisionRequirementsDefinitionsCountData, GetDecisionRequirementsDefinitionsCountErrors, GetDecisionRequirementsDefinitionsCountResponses, GetDecisionRequirementsDefinitionsData, GetDecisionRequirementsDefinitionsErrors, GetDecisionRequirementsDefinitionsResponses, GetDecisionStatisticsData, GetDecisionStatisticsErrors, GetDecisionStatisticsResponses, GetDeployedFormData, GetDeployedFormErrors, GetDeployedFormResponses, GetDeployedStartFormByKeyAndTenantIdData, GetDeployedStartFormByKeyAndTenantIdErrors, GetDeployedStartFormByKeyAndTenantIdResponses, GetDeployedStartFormByKeyData, GetDeployedStartFormByKeyErrors, GetDeployedStartFormByKeyResponses, GetDeployedStartFormData, GetDeployedStartFormErrors, GetDeployedStartFormResponses, GetDeploymentData, GetDeploymentErrors, GetDeploymentResourceData, GetDeploymentResourceDataData, GetDeploymentResourceDataErrors, GetDeploymentResourceDataResponses, GetDeploymentResourceErrors, GetDeploymentResourceResponses, GetDeploymentResourcesData, GetDeploymentResourcesErrors, GetDeploymentResourcesResponses, GetDeploymentResponses, GetDeploymentsCountData, GetDeploymentsCountErrors, GetDeploymentsCountResponses, GetDeploymentsData, GetDeploymentsErrors, GetDeploymentsResponses, GetErrorDetailsHistoricExternalTaskLogData, GetErrorDetailsHistoricExternalTaskLogErrors, GetErrorDetailsHistoricExternalTaskLogResponses, GetEventSubscriptionsCountData, GetEventSubscriptionsCountErrors, GetEventSubscriptionsCountResponses, GetEventSubscriptionsData, GetEventSubscriptionsErrors, GetEventSubscriptionsResponses, GetExecutionData, GetExecutionErrors, GetExecutionResponses, GetExecutionsCountData, GetExecutionsCountErrors, GetExecutionsCountResponses, GetExecutionsData, GetExecutionsErrors, GetExecutionsResponses, GetExternalTaskData, GetExternalTaskErrorDetailsData, GetExternalTaskErrorDetailsErrors, GetExternalTaskErrorDetailsResponses, GetExternalTaskErrors, GetExternalTaskResponses, GetExternalTasksCountData, GetExternalTasksCountErrors, GetExternalTasksCountResponses, GetExternalTasksData, GetExternalTasksErrors, GetExternalTasksResponses, GetFilterCountData, GetFilterCountErrors, GetFilterCountResponses, GetFilterListData, GetFilterListErrors, GetFilterListResponses, GetFormData, GetFormErrors, GetFormResponses, GetFormVariablesData, GetFormVariablesErrors, GetFormVariablesResponses, GetGroupCountData, GetGroupCountErrors, GetGroupCountResponses, GetGroupData, GetGroupErrors, GetGroupInfoData, GetGroupInfoErrors, GetGroupInfoResponses, GetGroupResponses, GetHistoricActivityInstanceData, GetHistoricActivityInstanceErrors, GetHistoricActivityInstanceResponses, GetHistoricActivityInstancesCountData, GetHistoricActivityInstancesCountErrors, GetHistoricActivityInstancesCountResponses, GetHistoricActivityInstancesData, GetHistoricActivityInstancesErrors, GetHistoricActivityInstancesResponses, GetHistoricActivityStatisticsData, GetHistoricActivityStatisticsErrors, GetHistoricActivityStatisticsResponses, GetHistoricBatchData, GetHistoricBatchErrors, GetHistoricBatchesCountData, GetHistoricBatchesCountErrors, GetHistoricBatchesCountResponses, GetHistoricBatchesData, GetHistoricBatchesErrors, GetHistoricBatchesResponses, GetHistoricBatchResponses, GetHistoricDecisionInstanceData, GetHistoricDecisionInstanceErrors, GetHistoricDecisionInstanceResponses, GetHistoricDecisionInstancesCountData, GetHistoricDecisionInstancesCountErrors, GetHistoricDecisionInstancesCountResponses, GetHistoricDecisionInstancesData, GetHistoricDecisionInstancesErrors, GetHistoricDecisionInstancesResponses, GetHistoricDetailsCountData, GetHistoricDetailsCountErrors, GetHistoricDetailsCountResponses, GetHistoricDetailsData, GetHistoricDetailsErrors, GetHistoricDetailsResponses, GetHistoricExternalTaskLogData, GetHistoricExternalTaskLogErrors, GetHistoricExternalTaskLogResponses, GetHistoricExternalTaskLogsCountData, GetHistoricExternalTaskLogsCountErrors, GetHistoricExternalTaskLogsCountResponses, GetHistoricExternalTaskLogsData, GetHistoricExternalTaskLogsErrors, GetHistoricExternalTaskLogsResponses, GetHistoricIdentityLinksCountData, GetHistoricIdentityLinksCountErrors, GetHistoricIdentityLinksCountResponses, GetHistoricIdentityLinksData, GetHistoricIdentityLinksErrors, GetHistoricIdentityLinksResponses, GetHistoricIncidentsCountData, GetHistoricIncidentsCountErrors, GetHistoricIncidentsCountResponses, GetHistoricIncidentsData, GetHistoricIncidentsErrors, GetHistoricIncidentsResponses, GetHistoricJobLogData, GetHistoricJobLogErrors, GetHistoricJobLogResponses, GetHistoricJobLogsCountData, GetHistoricJobLogsCountErrors, GetHistoricJobLogsCountResponses, GetHistoricJobLogsData, GetHistoricJobLogsErrors, GetHistoricJobLogsResponses, GetHistoricProcessInstanceData, GetHistoricProcessInstanceDurationReportData, GetHistoricProcessInstanceDurationReportErrors, GetHistoricProcessInstanceDurationReportResponses, GetHistoricProcessInstanceErrors, GetHistoricProcessInstanceResponses, GetHistoricProcessInstancesCountData, GetHistoricProcessInstancesCountErrors, GetHistoricProcessInstancesCountResponses, GetHistoricProcessInstancesData, GetHistoricProcessInstancesErrors, GetHistoricProcessInstancesResponses, GetHistoricTaskInstanceReportData, GetHistoricTaskInstanceReportErrors, GetHistoricTaskInstanceReportResponses, GetHistoricTaskInstancesCountData, GetHistoricTaskInstancesCountErrors, GetHistoricTaskInstancesCountResponses, GetHistoricTaskInstancesData, GetHistoricTaskInstancesErrors, GetHistoricTaskInstancesResponses, GetHistoricVariableInstanceBinaryData, GetHistoricVariableInstanceBinaryErrors, GetHistoricVariableInstanceBinaryResponses, GetHistoricVariableInstanceData, GetHistoricVariableInstanceErrors, GetHistoricVariableInstanceResponses, GetHistoricVariableInstancesCountData, GetHistoricVariableInstancesCountErrors, GetHistoricVariableInstancesCountResponses, GetHistoricVariableInstancesData, GetHistoricVariableInstancesErrors, GetHistoricVariableInstancesResponses, GetHistoryCleanupConfigurationData, GetHistoryCleanupConfigurationResponses, GetIdentityLinksData, GetIdentityLinksErrors, GetIdentityLinksResponses, GetIncidentData, GetIncidentErrors, GetIncidentResponses, GetIncidentsCountData, GetIncidentsCountErrors, GetIncidentsCountResponses, GetIncidentsData, GetIncidentsErrors, GetIncidentsResponses, GetJobData, GetJobDefinitionData, GetJobDefinitionErrors, GetJobDefinitionResponses, GetJobDefinitionsCountData, GetJobDefinitionsCountErrors, GetJobDefinitionsCountResponses, GetJobDefinitionsData, GetJobDefinitionsErrors, GetJobDefinitionsResponses, GetJobErrors, GetJobResponses, GetJobsCountData, GetJobsCountErrors, GetJobsCountResponses, GetJobsData, GetJobsErrors, GetJobsResponses, GetLatestProcessDefinitionByTenantIdData, GetLatestProcessDefinitionByTenantIdErrors, GetLatestProcessDefinitionByTenantIdResponses, GetLocalExecutionVariableBinaryData, GetLocalExecutionVariableBinaryErrors, GetLocalExecutionVariableBinaryResponses, GetLocalExecutionVariableData, GetLocalExecutionVariableErrors, GetLocalExecutionVariableResponses, GetLocalExecutionVariablesData, GetLocalExecutionVariablesErrors, GetLocalExecutionVariablesResponses, GetMessageEventSubscriptionData, GetMessageEventSubscriptionErrors, GetMessageEventSubscriptionResponses, GetMetricsData, GetMetricsResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetProcessDefinitionBpmn20XmlByKeyAndTenantIdData, GetProcessDefinitionBpmn20XmlByKeyAndTenantIdErrors, GetProcessDefinitionBpmn20XmlByKeyAndTenantIdResponses, GetProcessDefinitionBpmn20XmlByKeyData, GetProcessDefinitionBpmn20XmlByKeyErrors, GetProcessDefinitionBpmn20XmlByKeyResponses, GetProcessDefinitionBpmn20XmlData, GetProcessDefinitionBpmn20XmlErrors, GetProcessDefinitionBpmn20XmlResponses, GetProcessDefinitionByKeyData, GetProcessDefinitionByKeyErrors, GetProcessDefinitionByKeyResponses, GetProcessDefinitionData, GetProcessDefinitionDiagramByKeyAndTenantIdData, GetProcessDefinitionDiagramByKeyAndTenantIdErrors, GetProcessDefinitionDiagramByKeyAndTenantIdResponses, GetProcessDefinitionDiagramByKeyData, GetProcessDefinitionDiagramByKeyErrors, GetProcessDefinitionDiagramByKeyResponses, GetProcessDefinitionDiagramData, GetProcessDefinitionDiagramErrors, GetProcessDefinitionDiagramResponses, GetProcessDefinitionErrors, GetProcessDefinitionResponses, GetProcessDefinitionsCountData, GetProcessDefinitionsCountErrors, GetProcessDefinitionsCountResponses, GetProcessDefinitionsData, GetProcessDefinitionsErrors, GetProcessDefinitionsResponses, GetProcessDefinitionStatisticsData, GetProcessDefinitionStatisticsErrors, GetProcessDefinitionStatisticsResponses, GetProcessEngineNamesData, GetProcessEngineNamesResponses, GetProcessInstanceCommentsData, GetProcessInstanceCommentsErrors, GetProcessInstanceCommentsResponses, GetProcessInstanceData, GetProcessInstanceErrors, GetProcessInstanceResponses, GetProcessInstancesCountData, GetProcessInstancesCountErrors, GetProcessInstancesCountResponses, GetProcessInstancesData, GetProcessInstancesErrors, GetProcessInstancesResponses, GetProcessInstanceVariableBinaryData, GetProcessInstanceVariableBinaryErrors, GetProcessInstanceVariableBinaryResponses, GetProcessInstanceVariableData, GetProcessInstanceVariableErrors, GetProcessInstanceVariableResponses, GetProcessInstanceVariablesData, GetProcessInstanceVariablesErrors, GetProcessInstanceVariablesResponses, GetQueryGroupsData, GetQueryGroupsErrors, GetQueryGroupsResponses, GetRegisteredDeploymentsData, GetRegisteredDeploymentsResponses, GetRenderedFormData, GetRenderedFormErrors, GetRenderedFormResponses, GetRenderedStartFormByKeyAndTenantIdData, GetRenderedStartFormByKeyAndTenantIdErrors, GetRenderedStartFormByKeyAndTenantIdResponses, GetRenderedStartFormByKeyData, GetRenderedStartFormByKeyErrors, GetRenderedStartFormByKeyResponses, GetRenderedStartFormData, GetRenderedStartFormErrors, GetRenderedStartFormResponses, GetRestApiVersionData, GetRestApiVersionResponses, GetSchemaLogData, GetSchemaLogResponses, GetSingleFilterData, GetSingleFilterErrors, GetSingleFilterResponses, GetStacktraceData, GetStacktraceErrors, GetStacktraceHistoricJobLogData, GetStacktraceHistoricJobLogErrors, GetStacktraceHistoricJobLogResponses, GetStacktraceResponses, GetStartFormByKeyAndTenantIdData, GetStartFormByKeyAndTenantIdErrors, GetStartFormByKeyAndTenantIdResponses, GetStartFormByKeyData, GetStartFormByKeyErrors, GetStartFormByKeyResponses, GetStartFormData, GetStartFormErrors, GetStartFormResponses, GetStartFormVariablesByKeyAndTenantIdData, GetStartFormVariablesByKeyAndTenantIdErrors, GetStartFormVariablesByKeyAndTenantIdResponses, GetStartFormVariablesByKeyData, GetStartFormVariablesByKeyErrors, GetStartFormVariablesByKeyResponses, GetStartFormVariablesData, GetStartFormVariablesErrors, GetStartFormVariablesResponses, GetStaticCalledProcessDefinitionsData, GetStaticCalledProcessDefinitionsErrors, GetStaticCalledProcessDefinitionsResponses, GetTaskCountByCandidateGroupData, GetTaskCountByCandidateGroupErrors, GetTaskCountByCandidateGroupResponses, GetTaskData, GetTaskErrors, GetTaskLocalVariableBinaryData, GetTaskLocalVariableBinaryErrors, GetTaskLocalVariableBinaryResponses, GetTaskLocalVariableData, GetTaskLocalVariableErrors, GetTaskLocalVariableResponses, GetTaskLocalVariablesData, GetTaskLocalVariablesErrors, GetTaskLocalVariablesResponses, GetTaskResponses, GetTasksCountData, GetTasksCountErrors, GetTasksCountResponses, GetTasksData, GetTasksErrors, GetTasksResponses, GetTaskVariableBinaryData, GetTaskVariableBinaryErrors, GetTaskVariableBinaryResponses, GetTaskVariableData, GetTaskVariableErrors, GetTaskVariableResponses, GetTaskVariablesData, GetTaskVariablesErrors, GetTaskVariablesResponses, GetTelemetryConfigurationData, GetTelemetryConfigurationErrors, GetTelemetryConfigurationResponses, GetTelemetryDataData, GetTelemetryDataResponses, GetTenantCountData, GetTenantCountErrors, GetTenantCountResponses, GetTenantData, GetTenantErrors, GetTenantResponses, GetTopicNamesData, GetTopicNamesErrors, GetTopicNamesResponses, GetUserCountData, GetUserCountErrors, GetUserCountResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, GetUsersData, GetUsersErrors, GetUsersResponses, GetVariableInstanceBinaryData, GetVariableInstanceBinaryErrors, GetVariableInstanceBinaryResponses, GetVariableInstanceData, GetVariableInstanceErrors, GetVariableInstanceResponses, GetVariableInstancesCountData, GetVariableInstancesCountErrors, GetVariableInstancesCountResponses, GetVariableInstancesData, GetVariableInstancesErrors, GetVariableInstancesResponses, HandleBpmnErrorData, HandleBpmnErrorErrors, HandleBpmnErrorResponses, HandleEscalationData, HandleEscalationErrors, HandleEscalationResponses, HandleExternalTaskBpmnErrorData, HandleExternalTaskBpmnErrorErrors, HandleExternalTaskBpmnErrorResponses, HandleFailureData, HandleFailureErrors, HandleFailureResponses, HistoricDetailBinaryData, HistoricDetailBinaryErrors, HistoricDetailBinaryResponses, HistoricDetailData, HistoricDetailErrors, HistoricDetailResponses, IntervalData, IntervalErrors, IntervalResponses, IsUserAuthorizedData, IsUserAuthorizedErrors, IsUserAuthorizedResponses, LockData, LockErrors, LockResponses, ModifyLocalExecutionVariablesData, ModifyLocalExecutionVariablesErrors, ModifyLocalExecutionVariablesResponses, ModifyProcessInstanceAsyncOperationData, ModifyProcessInstanceAsyncOperationErrors, ModifyProcessInstanceAsyncOperationResponses, ModifyProcessInstanceData, ModifyProcessInstanceErrors, ModifyProcessInstanceResponses, ModifyProcessInstanceVariablesData, ModifyProcessInstanceVariablesErrors, ModifyProcessInstanceVariablesResponses, ModifyTaskLocalVariablesData, ModifyTaskLocalVariablesErrors, ModifyTaskLocalVariablesResponses, ModifyTaskVariablesData, ModifyTaskVariablesErrors, ModifyTaskVariablesResponses, PostExecuteFilterCountData, PostExecuteFilterCountErrors, PostExecuteFilterCountResponses, PostExecuteFilterListData, PostExecuteFilterListErrors, PostExecuteFilterListResponses, PostExecuteFilterSingleResultData, PostExecuteFilterSingleResultErrors, PostExecuteFilterSingleResultResponses, PostQueryGroupsData, PostQueryGroupsErrors, PostQueryGroupsResponses, PutLocalExecutionVariableData, PutLocalExecutionVariableErrors, PutLocalExecutionVariableResponses, PutTaskLocalVariableData, PutTaskLocalVariableErrors, PutTaskLocalVariableResponses, PutTaskVariableData, PutTaskVariableErrors, PutTaskVariableResponses, QueryAuthorizationsData, QueryAuthorizationsErrors, QueryAuthorizationsResponses, QueryExecutionsCountData, QueryExecutionsCountErrors, QueryExecutionsCountResponses, QueryExecutionsData, QueryExecutionsErrors, QueryExecutionsResponses, QueryExternalTasksCountData, QueryExternalTasksCountErrors, QueryExternalTasksCountResponses, QueryExternalTasksData, QueryExternalTasksErrors, QueryExternalTasksResponses, QueryGroupCountData, QueryGroupCountErrors, QueryGroupCountResponses, QueryHistoricActivityInstancesCountData, QueryHistoricActivityInstancesCountErrors, QueryHistoricActivityInstancesCountResponses, QueryHistoricActivityInstancesData, QueryHistoricActivityInstancesErrors, QueryHistoricActivityInstancesResponses, QueryHistoricDetailsData, QueryHistoricDetailsErrors, QueryHistoricDetailsResponses, QueryHistoricExternalTaskLogsCountData, QueryHistoricExternalTaskLogsCountErrors, QueryHistoricExternalTaskLogsCountResponses, QueryHistoricExternalTaskLogsData, QueryHistoricExternalTaskLogsErrors, QueryHistoricExternalTaskLogsResponses, QueryHistoricJobLogsCountData, QueryHistoricJobLogsCountErrors, QueryHistoricJobLogsCountResponses, QueryHistoricJobLogsData, QueryHistoricJobLogsErrors, QueryHistoricJobLogsResponses, QueryHistoricProcessInstancesCountData, QueryHistoricProcessInstancesCountErrors, QueryHistoricProcessInstancesCountResponses, QueryHistoricProcessInstancesData, QueryHistoricProcessInstancesErrors, QueryHistoricProcessInstancesResponses, QueryHistoricTaskInstancesCountData, QueryHistoricTaskInstancesCountErrors, QueryHistoricTaskInstancesCountResponses, QueryHistoricTaskInstancesData, QueryHistoricTaskInstancesErrors, QueryHistoricTaskInstancesResponses, QueryHistoricVariableInstancesCountData, QueryHistoricVariableInstancesCountErrors, QueryHistoricVariableInstancesCountResponses, QueryHistoricVariableInstancesData, QueryHistoricVariableInstancesErrors, QueryHistoricVariableInstancesResponses, QueryJobDefinitionsCountData, QueryJobDefinitionsCountErrors, QueryJobDefinitionsCountResponses, QueryJobDefinitionsData, QueryJobDefinitionsErrors, QueryJobDefinitionsResponses, QueryJobsCountData, QueryJobsCountErrors, QueryJobsCountResponses, QueryJobsData, QueryJobsErrors, QueryJobsResponses, QueryProcessInstancesCountData, QueryProcessInstancesCountErrors, QueryProcessInstancesCountResponses, QueryProcessInstancesData, QueryProcessInstancesErrors, QueryProcessInstancesResponses, QuerySchemaLogData, QuerySchemaLogResponses, QueryTasksCountData, QueryTasksCountErrors, QueryTasksCountResponses, QueryTasksData, QueryTasksErrors, QueryTasksResponses, QueryTenantsData, QueryTenantsErrors, QueryTenantsResponses, QueryUserOperationCountData, QueryUserOperationCountErrors, QueryUserOperationCountResponses, QueryUserOperationEntriesData, QueryUserOperationEntriesErrors, QueryUserOperationEntriesResponses, QueryVariableInstancesCountData, QueryVariableInstancesCountErrors, QueryVariableInstancesCountResponses, QueryVariableInstancesData, QueryVariableInstancesErrors, QueryVariableInstancesResponses, RecalculateDuedateData, RecalculateDuedateErrors, RecalculateDuedateResponses, RedeployData, RedeployErrors, RedeployResponses, ResolveData, ResolveErrors, ResolveIncidentData, ResolveIncidentErrors, ResolveIncidentResponses, ResolveResponses, RestartProcessInstanceAsyncOperationData, RestartProcessInstanceAsyncOperationErrors, RestartProcessInstanceAsyncOperationResponses, RestartProcessInstanceData, RestartProcessInstanceErrors, RestartProcessInstanceResponses, SetAnnotationUserOperationLogData, SetAnnotationUserOperationLogErrors, SetAnnotationUserOperationLogResponses, SetAssigneeData, SetAssigneeErrors, SetAssigneeResponses, SetBinaryTaskLocalVariableData, SetBinaryTaskLocalVariableErrors, SetBinaryTaskLocalVariableResponses, SetBinaryTaskVariableData, SetBinaryTaskVariableErrors, SetBinaryTaskVariableResponses, SetExternalTaskResourcePriorityData, SetExternalTaskResourcePriorityErrors, SetExternalTaskResourcePriorityResponses, SetExternalTaskResourceRetriesData, SetExternalTaskResourceRetriesErrors, SetExternalTaskResourceRetriesResponses, SetExternalTaskRetriesAsyncOperationData, SetExternalTaskRetriesAsyncOperationErrors, SetExternalTaskRetriesAsyncOperationResponses, SetExternalTaskRetriesData, SetExternalTaskRetriesErrors, SetExternalTaskRetriesResponses, SetIncidentAnnotationData, SetIncidentAnnotationErrors, SetIncidentAnnotationResponses, SetJobDuedateData, SetJobDuedateErrors, SetJobDuedateResponses, SetJobPriorityData, SetJobPriorityErrors, SetJobPriorityJobDefinitionData, SetJobPriorityJobDefinitionErrors, SetJobPriorityJobDefinitionResponses, SetJobPriorityResponses, SetJobRetriesAsyncOperationData, SetJobRetriesAsyncOperationErrors, SetJobRetriesAsyncOperationResponses, SetJobRetriesData, SetJobRetriesErrors, SetJobRetriesJobDefinitionData, SetJobRetriesJobDefinitionErrors, SetJobRetriesJobDefinitionResponses, SetJobRetriesResponses, SetLocalExecutionVariableBinaryData, SetLocalExecutionVariableBinaryErrors, SetLocalExecutionVariableBinaryResponses, SetProcessInstanceVariableBinaryData, SetProcessInstanceVariableBinaryErrors, SetProcessInstanceVariableBinaryResponses, SetProcessInstanceVariableData, SetProcessInstanceVariableErrors, SetProcessInstanceVariableResponses, SetRemovalTimeAsyncData, SetRemovalTimeAsyncErrors, SetRemovalTimeAsyncHistoricBatchData, SetRemovalTimeAsyncHistoricBatchErrors, SetRemovalTimeAsyncHistoricBatchResponses, SetRemovalTimeAsyncHistoricDecisionInstanceData, SetRemovalTimeAsyncHistoricDecisionInstanceErrors, SetRemovalTimeAsyncHistoricDecisionInstanceResponses, SetRemovalTimeAsyncResponses, SetRetriesByProcessData, SetRetriesByProcessErrors, SetRetriesByProcessHistoricQueryBasedData, SetRetriesByProcessHistoricQueryBasedErrors, SetRetriesByProcessHistoricQueryBasedResponses, SetRetriesByProcessResponses, SetVariablesAsyncOperationData, SetVariablesAsyncOperationErrors, SetVariablesAsyncOperationResponses, SignalExecutionData, SignalExecutionErrors, SignalExecutionResponses, StartProcessInstanceByKeyAndTenantIdData, StartProcessInstanceByKeyAndTenantIdErrors, StartProcessInstanceByKeyAndTenantIdResponses, StartProcessInstanceByKeyData, StartProcessInstanceByKeyErrors, StartProcessInstanceByKeyResponses, StartProcessInstanceData, StartProcessInstanceErrors, StartProcessInstanceResponses, SubmitData, SubmitErrors, SubmitFormByKeyAndTenantIdData, SubmitFormByKeyAndTenantIdErrors, SubmitFormByKeyAndTenantIdResponses, SubmitFormByKeyData, SubmitFormByKeyErrors, SubmitFormByKeyResponses, SubmitFormData, SubmitFormErrors, SubmitFormResponses, SubmitResponses, ThrowSignalData, ThrowSignalErrors, ThrowSignalResponses, TriggerEventData, TriggerEventErrors, TriggerEventResponses, UnclaimData, UnclaimErrors, UnclaimResponses, UnlockData, UnlockErrors, UnlockResponses, UnlockUserData, UnlockUserErrors, UnlockUserResponses, UpdateAuthorizationData, UpdateAuthorizationErrors, UpdateAuthorizationResponses, UpdateBatchSuspensionStateData, UpdateBatchSuspensionStateErrors, UpdateBatchSuspensionStateResponses, UpdateCredentialsData, UpdateCredentialsErrors, UpdateCredentialsResponses, UpdateFilterData, UpdateFilterErrors, UpdateFilterResponses, UpdateGroupData, UpdateGroupErrors, UpdateGroupResponses, UpdateHistoryTimeToLiveByDecisionDefinitionIdData, UpdateHistoryTimeToLiveByDecisionDefinitionIdErrors, UpdateHistoryTimeToLiveByDecisionDefinitionIdResponses, UpdateHistoryTimeToLiveByDecisionDefinitionKeyAndTenantData, UpdateHistoryTimeToLiveByDecisionDefinitionKeyAndTenantErrors, UpdateHistoryTimeToLiveByDecisionDefinitionKeyAndTenantResponses, UpdateHistoryTimeToLiveByDecisionDefinitionKeyData, UpdateHistoryTimeToLiveByDecisionDefinitionKeyErrors, UpdateHistoryTimeToLiveByDecisionDefinitionKeyResponses, UpdateHistoryTimeToLiveByProcessDefinitionIdData, UpdateHistoryTimeToLiveByProcessDefinitionIdErrors, UpdateHistoryTimeToLiveByProcessDefinitionIdResponses, UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdData, UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdErrors, UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdResponses, UpdateHistoryTimeToLiveByProcessDefinitionKeyData, UpdateHistoryTimeToLiveByProcessDefinitionKeyErrors, UpdateHistoryTimeToLiveByProcessDefinitionKeyResponses, UpdateJobSuspensionStateData, UpdateJobSuspensionStateResponses, UpdateProcessDefinitionSuspensionStateByIdData, UpdateProcessDefinitionSuspensionStateByIdErrors, UpdateProcessDefinitionSuspensionStateByIdResponses, UpdateProcessDefinitionSuspensionStateByKeyAndTenantIdData, UpdateProcessDefinitionSuspensionStateByKeyAndTenantIdErrors, UpdateProcessDefinitionSuspensionStateByKeyAndTenantIdResponses, UpdateProcessDefinitionSuspensionStateByKeyData, UpdateProcessDefinitionSuspensionStateByKeyErrors, UpdateProcessDefinitionSuspensionStateByKeyResponses, UpdateProcessDefinitionSuspensionStateData, UpdateProcessDefinitionSuspensionStateErrors, UpdateProcessDefinitionSuspensionStateResponses, UpdateProcessInstanceCommentData, UpdateProcessInstanceCommentErrors, UpdateProcessInstanceCommentResponses, UpdateProfileData, UpdateProfileErrors, UpdateProfileResponses, UpdateSuspensionStateAsyncOperationData, UpdateSuspensionStateAsyncOperationErrors, UpdateSuspensionStateAsyncOperationResponses, UpdateSuspensionStateByData, UpdateSuspensionStateByErrors, UpdateSuspensionStateByIdData, UpdateSuspensionStateByIdResponses, UpdateSuspensionStateByResponses, UpdateSuspensionStateData, UpdateSuspensionStateErrors, UpdateSuspensionStateJobDefinitionData, UpdateSuspensionStateJobDefinitionErrors, UpdateSuspensionStateJobDefinitionResponses, UpdateSuspensionStateJobDefinitionsData, UpdateSuspensionStateJobDefinitionsErrors, UpdateSuspensionStateJobDefinitionsResponses, UpdateSuspensionStateResponses, UpdateTaskCommentData, UpdateTaskCommentErrors, UpdateTaskCommentResponses, UpdateTaskData, UpdateTaskErrors, UpdateTaskResponses, UpdateTenantData, UpdateTenantErrors, UpdateTenantResponses, ValidateMigrationPlanData, ValidateMigrationPlanErrors, ValidateMigrationPlanResponses, VerifyUserData, VerifyUserErrors, VerifyUserResponses } from './types.gen.js';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
|
+
/**
|
|
5
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
+
* individual options. This might be also useful if you want to implement a
|
|
7
|
+
* custom client.
|
|
8
|
+
*/
|
|
9
|
+
client?: Client;
|
|
10
|
+
/**
|
|
11
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
+
*/
|
|
14
|
+
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Get Authorizations
|
|
18
|
+
*
|
|
19
|
+
* Queries for a list of authorizations using a list of parameters.
|
|
20
|
+
* The size of the result set can be retrieved by using the
|
|
21
|
+
* [Get Authorization Count](https://docs.cibseven.org/manual/2.1/reference/rest/authorization/get-query-count/) method.
|
|
22
|
+
*/
|
|
23
|
+
export declare const queryAuthorizations: <ThrowOnError extends boolean = true>(options?: Options<QueryAuthorizationsData, ThrowOnError>) => RequestResult<QueryAuthorizationsResponses, QueryAuthorizationsErrors, ThrowOnError, "data">;
|
|
24
|
+
/**
|
|
25
|
+
* Authorization Resource Options
|
|
26
|
+
*
|
|
27
|
+
* The OPTIONS request allows you to check for the set of available operations that the currently
|
|
28
|
+
* authenticated user can perform on the `/authorization` resource. Whether the user can perform an operation
|
|
29
|
+
* or not may depend on various factors, including the users authorizations to interact with this
|
|
30
|
+
* resource and the internal configuration of the process engine.
|
|
31
|
+
*/
|
|
32
|
+
export declare const availableOperationsAuthorization: <ThrowOnError extends boolean = true>(options?: Options<AvailableOperationsAuthorizationData, ThrowOnError>) => RequestResult<AvailableOperationsAuthorizationResponses, unknown, ThrowOnError, "data">;
|
|
33
|
+
/**
|
|
34
|
+
* Perform an Authorization Check
|
|
35
|
+
*
|
|
36
|
+
* Performs an authorization check for the currently authenticated user.
|
|
37
|
+
*/
|
|
38
|
+
export declare const isUserAuthorized: <ThrowOnError extends boolean = true>(options: Options<IsUserAuthorizedData, ThrowOnError>) => RequestResult<IsUserAuthorizedResponses, IsUserAuthorizedErrors, ThrowOnError, "data">;
|
|
39
|
+
/**
|
|
40
|
+
* Get Authorization Count
|
|
41
|
+
*
|
|
42
|
+
* Queries for authorizations using a list of parameters and retrieves the count.
|
|
43
|
+
*/
|
|
44
|
+
export declare const getAuthorizationCount: <ThrowOnError extends boolean = true>(options?: Options<GetAuthorizationCountData, ThrowOnError>) => RequestResult<GetAuthorizationCountResponses, GetAuthorizationCountErrors, ThrowOnError, "data">;
|
|
45
|
+
/**
|
|
46
|
+
* Create a New Authorization
|
|
47
|
+
*
|
|
48
|
+
* Creates a new authorization.
|
|
49
|
+
*/
|
|
50
|
+
export declare const createAuthorization: <ThrowOnError extends boolean = true>(options?: Options<CreateAuthorizationData, ThrowOnError>) => RequestResult<CreateAuthorizationResponses, CreateAuthorizationErrors, ThrowOnError, "data">;
|
|
51
|
+
/**
|
|
52
|
+
* Delete Authorization
|
|
53
|
+
*
|
|
54
|
+
* Deletes an authorization by id.
|
|
55
|
+
*/
|
|
56
|
+
export declare const deleteAuthorization: <ThrowOnError extends boolean = true>(options: Options<DeleteAuthorizationData, ThrowOnError>) => RequestResult<DeleteAuthorizationResponses, DeleteAuthorizationErrors, ThrowOnError, "data">;
|
|
57
|
+
/**
|
|
58
|
+
* Get Authorization
|
|
59
|
+
*
|
|
60
|
+
* Retrieves an authorization by id.
|
|
61
|
+
*/
|
|
62
|
+
export declare const getAuthorization: <ThrowOnError extends boolean = true>(options: Options<GetAuthorizationData, ThrowOnError>) => RequestResult<GetAuthorizationResponses, GetAuthorizationErrors, ThrowOnError, "data">;
|
|
63
|
+
/**
|
|
64
|
+
* Authorization Resource Options
|
|
65
|
+
*
|
|
66
|
+
* The OPTIONS request allows you to check for the set of available operations that the currently
|
|
67
|
+
* authenticated user can perform on a given instance of the `/authorization` resource.
|
|
68
|
+
* Whether the user can perform an operation or not may depend on various factors, including the users
|
|
69
|
+
* authorizations to interact with this resource and the internal configuration of the process engine.
|
|
70
|
+
*/
|
|
71
|
+
export declare const availableOperationsAuthorizationInstance: <ThrowOnError extends boolean = true>(options: Options<AvailableOperationsAuthorizationInstanceData, ThrowOnError>) => RequestResult<AvailableOperationsAuthorizationInstanceResponses, unknown, ThrowOnError, "data">;
|
|
72
|
+
/**
|
|
73
|
+
* Update an Authorization
|
|
74
|
+
*
|
|
75
|
+
* Updates an authorization by id.
|
|
76
|
+
*/
|
|
77
|
+
export declare const updateAuthorization: <ThrowOnError extends boolean = true>(options: Options<UpdateAuthorizationData, ThrowOnError>) => RequestResult<UpdateAuthorizationResponses, UpdateAuthorizationErrors, ThrowOnError, "data">;
|
|
78
|
+
/**
|
|
79
|
+
* Get List
|
|
80
|
+
*
|
|
81
|
+
* Queries for batches that fulfill given parameters. Parameters may be the properties of batches, such as the id or type.
|
|
82
|
+
* The size of the result set can be retrieved by using the
|
|
83
|
+
* [Get Batch Count](https://docs.cibseven.org/manual/2.1/reference/rest/batch/get-query-count/) method.
|
|
84
|
+
*/
|
|
85
|
+
export declare const getBatches: <ThrowOnError extends boolean = true>(options?: Options<GetBatchesData, ThrowOnError>) => RequestResult<GetBatchesResponses, GetBatchesErrors, ThrowOnError, "data">;
|
|
86
|
+
/**
|
|
87
|
+
* Get List Count
|
|
88
|
+
*
|
|
89
|
+
* Requests the number of batches that fulfill the query criteria.
|
|
90
|
+
* Takes the same filtering parameters as the [Get Batches](https://docs.cibseven.org/manual/2.1/reference/rest/batch/get-query/) method.
|
|
91
|
+
*/
|
|
92
|
+
export declare const getBatchesCount: <ThrowOnError extends boolean = true>(options?: Options<GetBatchesCountData, ThrowOnError>) => RequestResult<GetBatchesCountResponses, GetBatchesCountErrors, ThrowOnError, "data">;
|
|
93
|
+
/**
|
|
94
|
+
* Get Statistics
|
|
95
|
+
*
|
|
96
|
+
* Queries for batch statistics that fulfill given parameters.
|
|
97
|
+
* Parameters may be the properties of batches, such as the id or type.
|
|
98
|
+
* The size of the result set can be retrieved by using the
|
|
99
|
+
* [Get Batch Statistics Count](https://docs.cibseven.org/manual/2.1/reference/rest/batch/get-statistics-query-count/) method.
|
|
100
|
+
*/
|
|
101
|
+
export declare const getBatchStatistics: <ThrowOnError extends boolean = true>(options?: Options<GetBatchStatisticsData, ThrowOnError>) => RequestResult<GetBatchStatisticsResponses, GetBatchStatisticsErrors, ThrowOnError, "data">;
|
|
102
|
+
/**
|
|
103
|
+
* Get Statistics Count
|
|
104
|
+
*
|
|
105
|
+
* Requests the number of batch statistics that fulfill the query criteria.
|
|
106
|
+
* Takes the same filtering parameters as the
|
|
107
|
+
* [Get Batch Statistics](https://docs.cibseven.org/manual/2.1/reference/rest/batch/get-statistics-query/) method.
|
|
108
|
+
*/
|
|
109
|
+
export declare const getBatchStatisticsCount: <ThrowOnError extends boolean = true>(options?: Options<GetBatchStatisticsCountData, ThrowOnError>) => RequestResult<GetBatchStatisticsCountResponses, GetBatchStatisticsCountErrors, ThrowOnError, "data">;
|
|
110
|
+
/**
|
|
111
|
+
* Delete
|
|
112
|
+
*
|
|
113
|
+
* Deletes a batch by id, including all related jobs and job definitions.
|
|
114
|
+
* Optionally also deletes the batch history.
|
|
115
|
+
*/
|
|
116
|
+
export declare const deleteBatch: <ThrowOnError extends boolean = true>(options: Options<DeleteBatchData, ThrowOnError>) => RequestResult<DeleteBatchResponses, DeleteBatchErrors, ThrowOnError, "data">;
|
|
117
|
+
/**
|
|
118
|
+
* Get
|
|
119
|
+
*
|
|
120
|
+
* Retrieves a batch by id, according to the Batch interface in the engine.
|
|
121
|
+
*/
|
|
122
|
+
export declare const getBatch: <ThrowOnError extends boolean = true>(options: Options<GetBatchData, ThrowOnError>) => RequestResult<GetBatchResponses, GetBatchErrors, ThrowOnError, "data">;
|
|
123
|
+
/**
|
|
124
|
+
* Activate/Suspend
|
|
125
|
+
*
|
|
126
|
+
* Activates or suspends a batch by id.
|
|
127
|
+
*/
|
|
128
|
+
export declare const updateBatchSuspensionState: <ThrowOnError extends boolean = true>(options: Options<UpdateBatchSuspensionStateData, ThrowOnError>) => RequestResult<UpdateBatchSuspensionStateResponses, UpdateBatchSuspensionStateErrors, ThrowOnError, "data">;
|
|
129
|
+
/**
|
|
130
|
+
* Evaluate
|
|
131
|
+
*
|
|
132
|
+
* Triggers evaluation of conditions for conditional start event(s).
|
|
133
|
+
* Internally this maps to the engines condition evaluation builder method ConditionEvaluationBuilder#evaluateStartConditions().
|
|
134
|
+
* For more information see the [Conditional Start Events](https://docs.cibseven.org/manual/2.1/reference/bpmn20/events/conditional-events/#conditional-start-event)
|
|
135
|
+
* section of the [BPMN 2.0 Implementation Reference](https://docs.cibseven.org/manual/2.1/reference/bpmn20/).
|
|
136
|
+
*/
|
|
137
|
+
export declare const evaluateCondition: <ThrowOnError extends boolean = true>(options?: Options<EvaluateConditionData, ThrowOnError>) => RequestResult<EvaluateConditionResponses, EvaluateConditionErrors, ThrowOnError, "data">;
|
|
138
|
+
/**
|
|
139
|
+
* Get List
|
|
140
|
+
*
|
|
141
|
+
* Queries for decision definitions that fulfill given parameters.
|
|
142
|
+
* Parameters may be the properties of decision definitions, such as the name, key or version.
|
|
143
|
+
* The size of the result set can be retrieved by using
|
|
144
|
+
* the [Get Decision Definition Count](https://docs.cibseven.org/manual/2.1/reference/rest/decision-definition/get-query-count/) method.
|
|
145
|
+
*/
|
|
146
|
+
export declare const getDecisionDefinitions: <ThrowOnError extends boolean = true>(options?: Options<GetDecisionDefinitionsData, ThrowOnError>) => RequestResult<GetDecisionDefinitionsResponses, GetDecisionDefinitionsErrors, ThrowOnError, "data">;
|
|
147
|
+
/**
|
|
148
|
+
* Get List Count
|
|
149
|
+
*
|
|
150
|
+
* Requests the number of decision definitions that fulfill the query criteria.
|
|
151
|
+
* Takes the same filtering parameters as the
|
|
152
|
+
* [Get Decision Definition](https://docs.cibseven.org/manual/2.1/reference/rest/decision-definition/get-query/) method.
|
|
153
|
+
*/
|
|
154
|
+
export declare const getDecisionDefinitionsCount: <ThrowOnError extends boolean = true>(options?: Options<GetDecisionDefinitionsCountData, ThrowOnError>) => RequestResult<GetDecisionDefinitionsCountResponses, GetDecisionDefinitionsCountErrors, ThrowOnError, "data">;
|
|
155
|
+
/**
|
|
156
|
+
* Get Decision Definition By Key
|
|
157
|
+
*
|
|
158
|
+
* Retrieves the latest version of the decision definition which belongs to no tenant.
|
|
159
|
+
*/
|
|
160
|
+
export declare const getDecisionDefinitionByKey: <ThrowOnError extends boolean = true>(options: Options<GetDecisionDefinitionByKeyData, ThrowOnError>) => RequestResult<GetDecisionDefinitionByKeyResponses, GetDecisionDefinitionByKeyErrors, ThrowOnError, "data">;
|
|
161
|
+
/**
|
|
162
|
+
* Get Diagram By Key
|
|
163
|
+
*
|
|
164
|
+
* Returns the diagram for the latest version of the decision definition which belongs to no tenant
|
|
165
|
+
*/
|
|
166
|
+
export declare const getDecisionDefinitionDiagramByKey: <ThrowOnError extends boolean = true>(options: Options<GetDecisionDefinitionDiagramByKeyData, ThrowOnError>) => RequestResult<GetDecisionDefinitionDiagramByKeyResponses, GetDecisionDefinitionDiagramByKeyErrors, ThrowOnError, "data">;
|
|
167
|
+
/**
|
|
168
|
+
* Evaluate By Key
|
|
169
|
+
*
|
|
170
|
+
* Evaluates the latest version of the decision definition which belongs to no tenant.
|
|
171
|
+
* The input values of the decision have to be supplied in the request body.
|
|
172
|
+
*/
|
|
173
|
+
export declare const evaluateDecisionByKey: <ThrowOnError extends boolean = true>(options: Options<EvaluateDecisionByKeyData, ThrowOnError>) => RequestResult<EvaluateDecisionByKeyResponses, EvaluateDecisionByKeyErrors, ThrowOnError, "data">;
|
|
174
|
+
/**
|
|
175
|
+
* Update History Time to Live By Key
|
|
176
|
+
*
|
|
177
|
+
* Updates the latest version of the decision definition which belongs to no tenant.
|
|
178
|
+
* The field is used within [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup).
|
|
179
|
+
*/
|
|
180
|
+
export declare const updateHistoryTimeToLiveByDecisionDefinitionKey: <ThrowOnError extends boolean = true>(options: Options<UpdateHistoryTimeToLiveByDecisionDefinitionKeyData, ThrowOnError>) => RequestResult<UpdateHistoryTimeToLiveByDecisionDefinitionKeyResponses, UpdateHistoryTimeToLiveByDecisionDefinitionKeyErrors, ThrowOnError, "data">;
|
|
181
|
+
/**
|
|
182
|
+
* Get Decision Definition By Key And Tenant Id
|
|
183
|
+
*
|
|
184
|
+
* Retrieves the latest version of the decision definition for tenant
|
|
185
|
+
*/
|
|
186
|
+
export declare const getDecisionDefinitionByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<GetDecisionDefinitionByKeyAndTenantIdData, ThrowOnError>) => RequestResult<GetDecisionDefinitionByKeyAndTenantIdResponses, GetDecisionDefinitionByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
187
|
+
/**
|
|
188
|
+
* Get Diagram By Key And Tenant
|
|
189
|
+
*
|
|
190
|
+
* Returns the XML of the latest version of the decision definition for tenant.
|
|
191
|
+
*/
|
|
192
|
+
export declare const getDecisionDefinitionDiagramByKeyAndTenant: <ThrowOnError extends boolean = true>(options: Options<GetDecisionDefinitionDiagramByKeyAndTenantData, ThrowOnError>) => RequestResult<GetDecisionDefinitionDiagramByKeyAndTenantResponses, GetDecisionDefinitionDiagramByKeyAndTenantErrors, ThrowOnError, "data">;
|
|
193
|
+
/**
|
|
194
|
+
* Evaluate By Key And Tenant
|
|
195
|
+
*
|
|
196
|
+
* Evaluates the latest version of the decision definition for tenant.
|
|
197
|
+
* The input values of the decision have to be supplied in the request body.
|
|
198
|
+
*/
|
|
199
|
+
export declare const evaluateDecisionByKeyAndTenant: <ThrowOnError extends boolean = true>(options: Options<EvaluateDecisionByKeyAndTenantData, ThrowOnError>) => RequestResult<EvaluateDecisionByKeyAndTenantResponses, EvaluateDecisionByKeyAndTenantErrors, ThrowOnError, "data">;
|
|
200
|
+
/**
|
|
201
|
+
* Update History Time to Live By Key And Tenant
|
|
202
|
+
*
|
|
203
|
+
* Updates the latest version of the decision definition for tenant.
|
|
204
|
+
* The field is used within [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup).
|
|
205
|
+
* The value of the update is mandatory by default and does not allow `null` values. To enable them, please
|
|
206
|
+
* set the feature flag `enforceHistoryTimeToLive` to `false`. Read more in [Configuration Properties]
|
|
207
|
+
* (https://docs.cibseven.org/manual/2.1/reference/deployment-descriptors/tags/process-engine#configuration-properties)
|
|
208
|
+
*/
|
|
209
|
+
export declare const updateHistoryTimeToLiveByDecisionDefinitionKeyAndTenant: <ThrowOnError extends boolean = true>(options: Options<UpdateHistoryTimeToLiveByDecisionDefinitionKeyAndTenantData, ThrowOnError>) => RequestResult<UpdateHistoryTimeToLiveByDecisionDefinitionKeyAndTenantResponses, UpdateHistoryTimeToLiveByDecisionDefinitionKeyAndTenantErrors, ThrowOnError, "data">;
|
|
210
|
+
/**
|
|
211
|
+
* Get XML By Key and Tenant
|
|
212
|
+
*
|
|
213
|
+
* Retrieves the XML of the latest version of the decision definition for tenant
|
|
214
|
+
*/
|
|
215
|
+
export declare const getDecisionDefinitionDmnXmlByKeyAndTenant: <ThrowOnError extends boolean = true>(options: Options<GetDecisionDefinitionDmnXmlByKeyAndTenantData, ThrowOnError>) => RequestResult<GetDecisionDefinitionDmnXmlByKeyAndTenantResponses, GetDecisionDefinitionDmnXmlByKeyAndTenantErrors, ThrowOnError, "data">;
|
|
216
|
+
/**
|
|
217
|
+
* Get XML By Key
|
|
218
|
+
*
|
|
219
|
+
* Retrieves the XML for the latest version of the decision definition which belongs to no tenant.
|
|
220
|
+
*/
|
|
221
|
+
export declare const getDecisionDefinitionDmnXmlByKey: <ThrowOnError extends boolean = true>(options: Options<GetDecisionDefinitionDmnXmlByKeyData, ThrowOnError>) => RequestResult<GetDecisionDefinitionDmnXmlByKeyResponses, GetDecisionDefinitionDmnXmlByKeyErrors, ThrowOnError, "data">;
|
|
222
|
+
/**
|
|
223
|
+
* Get Decision Definition By Id
|
|
224
|
+
*
|
|
225
|
+
* Retrieves a decision definition by id, according to the `DecisionDefinition` interface in the engine.
|
|
226
|
+
*/
|
|
227
|
+
export declare const getDecisionDefinitionById: <ThrowOnError extends boolean = true>(options: Options<GetDecisionDefinitionByIdData, ThrowOnError>) => RequestResult<GetDecisionDefinitionByIdResponses, GetDecisionDefinitionByIdErrors, ThrowOnError, "data">;
|
|
228
|
+
/**
|
|
229
|
+
* Get Diagram
|
|
230
|
+
*
|
|
231
|
+
* Retrieves the diagram of a decision definition.
|
|
232
|
+
*/
|
|
233
|
+
export declare const getDecisionDefinitionDiagram: <ThrowOnError extends boolean = true>(options: Options<GetDecisionDefinitionDiagramData, ThrowOnError>) => RequestResult<GetDecisionDefinitionDiagramResponses, GetDecisionDefinitionDiagramErrors, ThrowOnError, "data">;
|
|
234
|
+
/**
|
|
235
|
+
* Evaluate By Id
|
|
236
|
+
*
|
|
237
|
+
* Evaluates a given decision and returns the result.
|
|
238
|
+
* The input values of the decision have to be supplied in the request body.
|
|
239
|
+
*/
|
|
240
|
+
export declare const evaluateDecisionById: <ThrowOnError extends boolean = true>(options: Options<EvaluateDecisionByIdData, ThrowOnError>) => RequestResult<EvaluateDecisionByIdResponses, EvaluateDecisionByIdErrors, ThrowOnError, "data">;
|
|
241
|
+
/**
|
|
242
|
+
* Update History Time to Live
|
|
243
|
+
*
|
|
244
|
+
* Updates history time to live for decision definition.
|
|
245
|
+
* The field is used within [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup).
|
|
246
|
+
*/
|
|
247
|
+
export declare const updateHistoryTimeToLiveByDecisionDefinitionId: <ThrowOnError extends boolean = true>(options: Options<UpdateHistoryTimeToLiveByDecisionDefinitionIdData, ThrowOnError>) => RequestResult<UpdateHistoryTimeToLiveByDecisionDefinitionIdResponses, UpdateHistoryTimeToLiveByDecisionDefinitionIdErrors, ThrowOnError, "data">;
|
|
248
|
+
/**
|
|
249
|
+
* Get XML By Id
|
|
250
|
+
*
|
|
251
|
+
* Retrieves the DMN XML of a decision definition.
|
|
252
|
+
*/
|
|
253
|
+
export declare const getDecisionDefinitionDmnXmlById: <ThrowOnError extends boolean = true>(options: Options<GetDecisionDefinitionDmnXmlByIdData, ThrowOnError>) => RequestResult<GetDecisionDefinitionDmnXmlByIdResponses, GetDecisionDefinitionDmnXmlByIdErrors, ThrowOnError, "data">;
|
|
254
|
+
/**
|
|
255
|
+
* Get Decision Requirements Definitions
|
|
256
|
+
*
|
|
257
|
+
* Queries for decision requirements definitions that fulfill given parameters.
|
|
258
|
+
* Parameters may be the properties of decision requirements definitions, such as the name,
|
|
259
|
+
* key or version. The size of the result set can be retrieved by using the
|
|
260
|
+
* [Get Decision Requirements Definition Count](https://docs.cibseven.org/manual/2.1/reference/rest/decision-requirements-definition/get-query-count/)
|
|
261
|
+
* method.
|
|
262
|
+
*/
|
|
263
|
+
export declare const getDecisionRequirementsDefinitions: <ThrowOnError extends boolean = true>(options?: Options<GetDecisionRequirementsDefinitionsData, ThrowOnError>) => RequestResult<GetDecisionRequirementsDefinitionsResponses, GetDecisionRequirementsDefinitionsErrors, ThrowOnError, "data">;
|
|
264
|
+
/**
|
|
265
|
+
* Get Decision Requirements Definition Count
|
|
266
|
+
*
|
|
267
|
+
* Requests the number of decision requirements definitions that fulfill the query
|
|
268
|
+
* criteria.
|
|
269
|
+
* Takes the same filtering parameters as the
|
|
270
|
+
* [Get Decision Requirements Definitions](https://docs.cibseven.org/manual/2.1/reference/rest/decision-requirements-definition/get-query/)
|
|
271
|
+
* method.
|
|
272
|
+
*/
|
|
273
|
+
export declare const getDecisionRequirementsDefinitionsCount: <ThrowOnError extends boolean = true>(options?: Options<GetDecisionRequirementsDefinitionsCountData, ThrowOnError>) => RequestResult<GetDecisionRequirementsDefinitionsCountResponses, GetDecisionRequirementsDefinitionsCountErrors, ThrowOnError, "data">;
|
|
274
|
+
/**
|
|
275
|
+
* Get Decision Requirements Definition by Key
|
|
276
|
+
*
|
|
277
|
+
* Retrieves a decision requirements definition according to the
|
|
278
|
+
* `DecisionRequirementsDefinition` interface in the engine.
|
|
279
|
+
* Returns the latest version of the decision requirements definition
|
|
280
|
+
* which belongs to no tenant.
|
|
281
|
+
*/
|
|
282
|
+
export declare const getDecisionRequirementsDefinitionByKey: <ThrowOnError extends boolean = true>(options: Options<GetDecisionRequirementsDefinitionByKeyData, ThrowOnError>) => RequestResult<GetDecisionRequirementsDefinitionByKeyResponses, GetDecisionRequirementsDefinitionByKeyErrors, ThrowOnError, "data">;
|
|
283
|
+
/**
|
|
284
|
+
* Get Decision Requirements Diagram by Key
|
|
285
|
+
*
|
|
286
|
+
* Retrieves the diagram of a decision requirements definition.
|
|
287
|
+
* Returns the diagram for the latest version of the decision requirements
|
|
288
|
+
* definition which belongs to no tenant.
|
|
289
|
+
*/
|
|
290
|
+
export declare const getDecisionRequirementsDefinitionDiagramByKey: <ThrowOnError extends boolean = true>(options: Options<GetDecisionRequirementsDefinitionDiagramByKeyData, ThrowOnError>) => RequestResult<GetDecisionRequirementsDefinitionDiagramByKeyResponses, GetDecisionRequirementsDefinitionDiagramByKeyErrors, ThrowOnError, "data">;
|
|
291
|
+
/**
|
|
292
|
+
* Get Decision Requirements Definition by Key and Tenant ID
|
|
293
|
+
*
|
|
294
|
+
* Retrieves a decision requirements definition according to the
|
|
295
|
+
* `DecisionRequirementsDefinition` interface in the engine.
|
|
296
|
+
* Returns the latest version of the decision requirements definition
|
|
297
|
+
* for a tenant.
|
|
298
|
+
*/
|
|
299
|
+
export declare const getDecisionRequirementsDefinitionByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<GetDecisionRequirementsDefinitionByKeyAndTenantIdData, ThrowOnError>) => RequestResult<GetDecisionRequirementsDefinitionByKeyAndTenantIdResponses, GetDecisionRequirementsDefinitionByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
300
|
+
/**
|
|
301
|
+
* Get Decision Requirements Diagram by Key and Tenant ID
|
|
302
|
+
*
|
|
303
|
+
* Retrieves the diagram of a decision requirements definition.
|
|
304
|
+
* Returns the diagram of the latest version of the decision requirements
|
|
305
|
+
* definition for a tenant.
|
|
306
|
+
*/
|
|
307
|
+
export declare const getDecisionRequirementsDefinitionDiagramByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<GetDecisionRequirementsDefinitionDiagramByKeyAndTenantIdData, ThrowOnError>) => RequestResult<GetDecisionRequirementsDefinitionDiagramByKeyAndTenantIdResponses, GetDecisionRequirementsDefinitionDiagramByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
308
|
+
/**
|
|
309
|
+
* Get DMN XML by Key and Tenant ID
|
|
310
|
+
*
|
|
311
|
+
* Retrieves the DMN XML of a decision requirements definition.
|
|
312
|
+
* Returns the XML of the latest version of the decision requirements
|
|
313
|
+
* definition for a tenant.
|
|
314
|
+
*/
|
|
315
|
+
export declare const getDecisionRequirementsDefinitionDmnXmlByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<GetDecisionRequirementsDefinitionDmnXmlByKeyAndTenantIdData, ThrowOnError>) => RequestResult<GetDecisionRequirementsDefinitionDmnXmlByKeyAndTenantIdResponses, GetDecisionRequirementsDefinitionDmnXmlByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
316
|
+
/**
|
|
317
|
+
* Get DMN XML by Key
|
|
318
|
+
*
|
|
319
|
+
* Retrieves the DMN XML of a decision requirements definition.
|
|
320
|
+
* Returns the XML for the latest version of the decision requirements
|
|
321
|
+
* definition which belongs to no tenant.
|
|
322
|
+
*/
|
|
323
|
+
export declare const getDecisionRequirementsDefinitionDmnXmlByKey: <ThrowOnError extends boolean = true>(options: Options<GetDecisionRequirementsDefinitionDmnXmlByKeyData, ThrowOnError>) => RequestResult<GetDecisionRequirementsDefinitionDmnXmlByKeyResponses, GetDecisionRequirementsDefinitionDmnXmlByKeyErrors, ThrowOnError, "data">;
|
|
324
|
+
/**
|
|
325
|
+
* Get Decision Requirements Definition by ID
|
|
326
|
+
*
|
|
327
|
+
* Retrieves a decision requirements definition according to the
|
|
328
|
+
* `DecisionRequirementsDefinition` interface in the engine.
|
|
329
|
+
*/
|
|
330
|
+
export declare const getDecisionRequirementsDefinitionById: <ThrowOnError extends boolean = true>(options: Options<GetDecisionRequirementsDefinitionByIdData, ThrowOnError>) => RequestResult<GetDecisionRequirementsDefinitionByIdResponses, GetDecisionRequirementsDefinitionByIdErrors, ThrowOnError, "data">;
|
|
331
|
+
/**
|
|
332
|
+
* Get Decision Requirements Diagram by ID
|
|
333
|
+
*
|
|
334
|
+
* Retrieves the diagram of a decision requirements definition.
|
|
335
|
+
*/
|
|
336
|
+
export declare const getDecisionRequirementsDefinitionDiagramById: <ThrowOnError extends boolean = true>(options: Options<GetDecisionRequirementsDefinitionDiagramByIdData, ThrowOnError>) => RequestResult<GetDecisionRequirementsDefinitionDiagramByIdResponses, GetDecisionRequirementsDefinitionDiagramByIdErrors, ThrowOnError, "data">;
|
|
337
|
+
/**
|
|
338
|
+
* Get DMN XML by ID
|
|
339
|
+
*
|
|
340
|
+
* Retrieves the DMN XML of a decision requirements definition.
|
|
341
|
+
*/
|
|
342
|
+
export declare const getDecisionRequirementsDefinitionDmnXmlById: <ThrowOnError extends boolean = true>(options: Options<GetDecisionRequirementsDefinitionDmnXmlByIdData, ThrowOnError>) => RequestResult<GetDecisionRequirementsDefinitionDmnXmlByIdResponses, GetDecisionRequirementsDefinitionDmnXmlByIdErrors, ThrowOnError, "data">;
|
|
343
|
+
/**
|
|
344
|
+
* Get List
|
|
345
|
+
*
|
|
346
|
+
* Queries for deployments that fulfill given parameters. Parameters may be the properties of deployments,
|
|
347
|
+
* such as the id or name or a range of the deployment time. The size of the result set can be retrieved by
|
|
348
|
+
* using the [Get Deployment count](https://docs.cibseven.org/manual/2.1/reference/rest/deployment/get-query-count/) method.
|
|
349
|
+
*/
|
|
350
|
+
export declare const getDeployments: <ThrowOnError extends boolean = true>(options?: Options<GetDeploymentsData, ThrowOnError>) => RequestResult<GetDeploymentsResponses, GetDeploymentsErrors, ThrowOnError, "data">;
|
|
351
|
+
/**
|
|
352
|
+
* Get List Count
|
|
353
|
+
*
|
|
354
|
+
* Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the
|
|
355
|
+
* [Get Deployments](https://docs.cibseven.org/manual/2.1/reference/rest/deployment/get-query/) method.
|
|
356
|
+
*/
|
|
357
|
+
export declare const getDeploymentsCount: <ThrowOnError extends boolean = true>(options?: Options<GetDeploymentsCountData, ThrowOnError>) => RequestResult<GetDeploymentsCountResponses, GetDeploymentsCountErrors, ThrowOnError, "data">;
|
|
358
|
+
/**
|
|
359
|
+
* Create
|
|
360
|
+
*
|
|
361
|
+
* Creates a deployment.
|
|
362
|
+
*
|
|
363
|
+
* **Security Consideration**
|
|
364
|
+
*
|
|
365
|
+
* Deployments can contain custom code in form of scripts or EL expressions to customize process behavior.
|
|
366
|
+
* This may be abused for remote execution of arbitrary code.
|
|
367
|
+
*/
|
|
368
|
+
export declare const createDeployment: <ThrowOnError extends boolean = true>(options?: Options<CreateDeploymentData, ThrowOnError>) => RequestResult<CreateDeploymentResponses, CreateDeploymentErrors, ThrowOnError, "data">;
|
|
369
|
+
/**
|
|
370
|
+
* Get Registered Deployments
|
|
371
|
+
*
|
|
372
|
+
* Queries the registered deployment IDs for the current application.
|
|
373
|
+
*/
|
|
374
|
+
export declare const getRegisteredDeployments: <ThrowOnError extends boolean = true>(options?: Options<GetRegisteredDeploymentsData, ThrowOnError>) => RequestResult<GetRegisteredDeploymentsResponses, unknown, ThrowOnError, "data">;
|
|
375
|
+
/**
|
|
376
|
+
* Delete
|
|
377
|
+
*
|
|
378
|
+
* Deletes a deployment by id.
|
|
379
|
+
*/
|
|
380
|
+
export declare const deleteDeployment: <ThrowOnError extends boolean = true>(options: Options<DeleteDeploymentData, ThrowOnError>) => RequestResult<DeleteDeploymentResponses, DeleteDeploymentErrors, ThrowOnError, "data">;
|
|
381
|
+
/**
|
|
382
|
+
* Get
|
|
383
|
+
*
|
|
384
|
+
* Retrieves a deployment by id, according to the `Deployment` interface of the engine.
|
|
385
|
+
*/
|
|
386
|
+
export declare const getDeployment: <ThrowOnError extends boolean = true>(options: Options<GetDeploymentData, ThrowOnError>) => RequestResult<GetDeploymentResponses, GetDeploymentErrors, ThrowOnError, "data">;
|
|
387
|
+
/**
|
|
388
|
+
* Redeploy
|
|
389
|
+
*
|
|
390
|
+
* Re-deploys an existing deployment.
|
|
391
|
+
*
|
|
392
|
+
* The deployment resources to re-deploy can be restricted by using the properties `resourceIds` or
|
|
393
|
+
* `resourceNames`. If no deployment resources to re-deploy are passed then all existing resources of the
|
|
394
|
+
* given deployment are re-deployed.
|
|
395
|
+
*
|
|
396
|
+
* **Warning**: Deployments can contain custom code in form of scripts or EL expressions to customize
|
|
397
|
+
* process behavior. This may be abused for remote execution of arbitrary code. See the section on
|
|
398
|
+
* [security considerations for custom code](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/securing-custom-code/) in
|
|
399
|
+
* the user guide for details.
|
|
400
|
+
*/
|
|
401
|
+
export declare const redeploy: <ThrowOnError extends boolean = true>(options: Options<RedeployData, ThrowOnError>) => RequestResult<RedeployResponses, RedeployErrors, ThrowOnError, "data">;
|
|
402
|
+
/**
|
|
403
|
+
* Get Resources
|
|
404
|
+
*
|
|
405
|
+
* Retrieves all deployment resources of a given deployment.
|
|
406
|
+
*/
|
|
407
|
+
export declare const getDeploymentResources: <ThrowOnError extends boolean = true>(options: Options<GetDeploymentResourcesData, ThrowOnError>) => RequestResult<GetDeploymentResourcesResponses, GetDeploymentResourcesErrors, ThrowOnError, "data">;
|
|
408
|
+
/**
|
|
409
|
+
* Get Resource
|
|
410
|
+
*
|
|
411
|
+
* Retrieves a deployment resource by resource id for the given deployment.
|
|
412
|
+
*/
|
|
413
|
+
export declare const getDeploymentResource: <ThrowOnError extends boolean = true>(options: Options<GetDeploymentResourceData, ThrowOnError>) => RequestResult<GetDeploymentResourceResponses, GetDeploymentResourceErrors, ThrowOnError, "data">;
|
|
414
|
+
/**
|
|
415
|
+
* Get Resource (Binary)
|
|
416
|
+
*
|
|
417
|
+
* Retrieves the binary content of a deployment resource for the given deployment by id.
|
|
418
|
+
*/
|
|
419
|
+
export declare const getDeploymentResourceData: <ThrowOnError extends boolean = true>(options: Options<GetDeploymentResourceDataData, ThrowOnError>) => RequestResult<GetDeploymentResourceDataResponses, GetDeploymentResourceDataErrors, ThrowOnError, "data">;
|
|
420
|
+
/**
|
|
421
|
+
* Get List
|
|
422
|
+
*
|
|
423
|
+
* Retrieves the names of all process engines available on your platform.
|
|
424
|
+
* **Note**: You cannot prepend `/engine/{name}` to this method.
|
|
425
|
+
*/
|
|
426
|
+
export declare const getProcessEngineNames: <ThrowOnError extends boolean = true>(options?: Options<GetProcessEngineNamesData, ThrowOnError>) => RequestResult<GetProcessEngineNamesResponses, unknown, ThrowOnError, "data">;
|
|
427
|
+
/**
|
|
428
|
+
* Get List
|
|
429
|
+
*
|
|
430
|
+
* Queries for event subscriptions that fulfill given parameters.
|
|
431
|
+
* The size of the result set can be retrieved by using the
|
|
432
|
+
* [Get Event Subscriptions count](https://docs.cibseven.org/manual/2.1/reference/rest/event-subscription/get-query-count/) method.
|
|
433
|
+
*/
|
|
434
|
+
export declare const getEventSubscriptions: <ThrowOnError extends boolean = true>(options?: Options<GetEventSubscriptionsData, ThrowOnError>) => RequestResult<GetEventSubscriptionsResponses, GetEventSubscriptionsErrors, ThrowOnError, "data">;
|
|
435
|
+
/**
|
|
436
|
+
* Get List Count
|
|
437
|
+
*
|
|
438
|
+
* Queries for the number of event subscriptions that fulfill given parameters.
|
|
439
|
+
* Takes the same parameters as the
|
|
440
|
+
* [Get Event Subscriptions](https://docs.cibseven.org/manual/2.1/reference/rest/event-subscription/get-query/) method.
|
|
441
|
+
*/
|
|
442
|
+
export declare const getEventSubscriptionsCount: <ThrowOnError extends boolean = true>(options?: Options<GetEventSubscriptionsCountData, ThrowOnError>) => RequestResult<GetEventSubscriptionsCountResponses, GetEventSubscriptionsCountErrors, ThrowOnError, "data">;
|
|
443
|
+
/**
|
|
444
|
+
* Get Executions
|
|
445
|
+
*
|
|
446
|
+
* Queries for the executions that fulfill given parameters.
|
|
447
|
+
* Parameters may be static as well as dynamic runtime properties of
|
|
448
|
+
* executions.
|
|
449
|
+
* The size of the result set can be retrieved by using the [Get
|
|
450
|
+
* Execution Count](https://docs.cibseven.org/manual/2.1/reference/rest/execution/get-query-count/)
|
|
451
|
+
* method.
|
|
452
|
+
*/
|
|
453
|
+
export declare const getExecutions: <ThrowOnError extends boolean = true>(options?: Options<GetExecutionsData, ThrowOnError>) => RequestResult<GetExecutionsResponses, GetExecutionsErrors, ThrowOnError, "data">;
|
|
454
|
+
/**
|
|
455
|
+
* Get Executions (POST)
|
|
456
|
+
*
|
|
457
|
+
* Queries for executions that fulfill given parameters through a JSON object.
|
|
458
|
+
* This method is slightly more powerful than the [Get
|
|
459
|
+
* Executions](https://docs.cibseven.org/manual/2.1/reference/rest/execution/get-query/) method
|
|
460
|
+
* because it allows
|
|
461
|
+
* to filter by multiple instance and execution variables of types
|
|
462
|
+
* `String`, `Number` or `Boolean`.
|
|
463
|
+
*/
|
|
464
|
+
export declare const queryExecutions: <ThrowOnError extends boolean = true>(options?: Options<QueryExecutionsData, ThrowOnError>) => RequestResult<QueryExecutionsResponses, QueryExecutionsErrors, ThrowOnError, "data">;
|
|
465
|
+
/**
|
|
466
|
+
* Get Execution Count
|
|
467
|
+
*
|
|
468
|
+
* Queries for the number of executions that fulfill given parameters.
|
|
469
|
+
* Takes the same parameters as the [Get
|
|
470
|
+
* Executions](https://docs.cibseven.org/manual/2.1/reference/rest/execution/get-query/) method.
|
|
471
|
+
*/
|
|
472
|
+
export declare const getExecutionsCount: <ThrowOnError extends boolean = true>(options?: Options<GetExecutionsCountData, ThrowOnError>) => RequestResult<GetExecutionsCountResponses, GetExecutionsCountErrors, ThrowOnError, "data">;
|
|
473
|
+
/**
|
|
474
|
+
* Get Execution Count (POST)
|
|
475
|
+
*
|
|
476
|
+
* Queries for the number of executions that fulfill given parameters. This method
|
|
477
|
+
* takes the same message body as the [Get Executions
|
|
478
|
+
* POST](https://docs.cibseven.org/manual/2.1/reference/rest/execution/post-query/) method and
|
|
479
|
+
* therefore it is slightly more powerful than the [Get Execution
|
|
480
|
+
* Count](https://docs.cibseven.org/manual/2.1/reference/rest/execution/get-query-count/) method.
|
|
481
|
+
*/
|
|
482
|
+
export declare const queryExecutionsCount: <ThrowOnError extends boolean = true>(options?: Options<QueryExecutionsCountData, ThrowOnError>) => RequestResult<QueryExecutionsCountResponses, QueryExecutionsCountErrors, ThrowOnError, "data">;
|
|
483
|
+
/**
|
|
484
|
+
* Get Execution
|
|
485
|
+
*
|
|
486
|
+
* Retrieves an execution by id, according to the `Execution` interface in the
|
|
487
|
+
* engine.
|
|
488
|
+
*/
|
|
489
|
+
export declare const getExecution: <ThrowOnError extends boolean = true>(options: Options<GetExecutionData, ThrowOnError>) => RequestResult<GetExecutionResponses, GetExecutionErrors, ThrowOnError, "data">;
|
|
490
|
+
/**
|
|
491
|
+
* Create Incident
|
|
492
|
+
*
|
|
493
|
+
* Creates a custom incident with given properties.
|
|
494
|
+
*/
|
|
495
|
+
export declare const createIncident: <ThrowOnError extends boolean = true>(options: Options<CreateIncidentData, ThrowOnError>) => RequestResult<CreateIncidentResponses, CreateIncidentErrors, ThrowOnError, "data">;
|
|
496
|
+
/**
|
|
497
|
+
* Get Local Execution Variables
|
|
498
|
+
*
|
|
499
|
+
* Retrieves all variables of a given execution by id.
|
|
500
|
+
*/
|
|
501
|
+
export declare const getLocalExecutionVariables: <ThrowOnError extends boolean = true>(options: Options<GetLocalExecutionVariablesData, ThrowOnError>) => RequestResult<GetLocalExecutionVariablesResponses, GetLocalExecutionVariablesErrors, ThrowOnError, "data">;
|
|
502
|
+
/**
|
|
503
|
+
* Update/Delete Local Execution Variables
|
|
504
|
+
*
|
|
505
|
+
* Updates or deletes the variables in the context of an execution by id. The updates
|
|
506
|
+
* do not propagate upwards in the execution hierarchy.
|
|
507
|
+
* Updates precede deletions. So, if a variable is updated AND deleted,
|
|
508
|
+
* the deletion overrides the update.
|
|
509
|
+
*/
|
|
510
|
+
export declare const modifyLocalExecutionVariables: <ThrowOnError extends boolean = true>(options: Options<ModifyLocalExecutionVariablesData, ThrowOnError>) => RequestResult<ModifyLocalExecutionVariablesResponses, ModifyLocalExecutionVariablesErrors, ThrowOnError, "data">;
|
|
511
|
+
/**
|
|
512
|
+
* Delete Local Execution Variable
|
|
513
|
+
*
|
|
514
|
+
* Deletes a variable in the context of a given execution by id. Deletion does not
|
|
515
|
+
* propagate upwards in the execution hierarchy.
|
|
516
|
+
*/
|
|
517
|
+
export declare const deleteLocalExecutionVariable: <ThrowOnError extends boolean = true>(options: Options<DeleteLocalExecutionVariableData, ThrowOnError>) => RequestResult<DeleteLocalExecutionVariableResponses, unknown, ThrowOnError, "data">;
|
|
518
|
+
/**
|
|
519
|
+
* Get Local Execution Variable
|
|
520
|
+
*
|
|
521
|
+
* Retrieves a variable from the context of a given execution by id. Does not traverse
|
|
522
|
+
* the parent execution hierarchy.
|
|
523
|
+
*/
|
|
524
|
+
export declare const getLocalExecutionVariable: <ThrowOnError extends boolean = true>(options: Options<GetLocalExecutionVariableData, ThrowOnError>) => RequestResult<GetLocalExecutionVariableResponses, GetLocalExecutionVariableErrors, ThrowOnError, "data">;
|
|
525
|
+
/**
|
|
526
|
+
* Put Local Execution Variable
|
|
527
|
+
*
|
|
528
|
+
* Sets a variable in the context of a given execution by id. Update does not
|
|
529
|
+
* propagate upwards in the execution hierarchy.
|
|
530
|
+
*/
|
|
531
|
+
export declare const putLocalExecutionVariable: <ThrowOnError extends boolean = true>(options: Options<PutLocalExecutionVariableData, ThrowOnError>) => RequestResult<PutLocalExecutionVariableResponses, PutLocalExecutionVariableErrors, ThrowOnError, "data">;
|
|
532
|
+
/**
|
|
533
|
+
* Get Local Execution Variable (Binary)
|
|
534
|
+
*
|
|
535
|
+
* Retrieves a binary variable from the context of a given execution by id. Does not
|
|
536
|
+
* traverse the parent execution hierarchy. Applicable for byte array and
|
|
537
|
+
* file variables.
|
|
538
|
+
*/
|
|
539
|
+
export declare const getLocalExecutionVariableBinary: <ThrowOnError extends boolean = true>(options: Options<GetLocalExecutionVariableBinaryData, ThrowOnError>) => RequestResult<GetLocalExecutionVariableBinaryResponses, GetLocalExecutionVariableBinaryErrors, ThrowOnError, "data">;
|
|
540
|
+
/**
|
|
541
|
+
* Post Local Execution Variable (Binary)
|
|
542
|
+
*
|
|
543
|
+
* Sets the serialized value for a binary variable or the binary value for a file
|
|
544
|
+
* variable in the context of a given execution by id.
|
|
545
|
+
*/
|
|
546
|
+
export declare const setLocalExecutionVariableBinary: <ThrowOnError extends boolean = true>(options: Options<SetLocalExecutionVariableBinaryData, ThrowOnError>) => RequestResult<SetLocalExecutionVariableBinaryResponses, SetLocalExecutionVariableBinaryErrors, ThrowOnError, "data">;
|
|
547
|
+
/**
|
|
548
|
+
* Get Message Event Subscription
|
|
549
|
+
*
|
|
550
|
+
* Retrieves a message event subscription for a given execution by id and a message
|
|
551
|
+
* name.
|
|
552
|
+
*/
|
|
553
|
+
export declare const getMessageEventSubscription: <ThrowOnError extends boolean = true>(options: Options<GetMessageEventSubscriptionData, ThrowOnError>) => RequestResult<GetMessageEventSubscriptionResponses, GetMessageEventSubscriptionErrors, ThrowOnError, "data">;
|
|
554
|
+
/**
|
|
555
|
+
* Trigger Message Event Subscription
|
|
556
|
+
*
|
|
557
|
+
* Delivers a message to a specific execution by id, to trigger an existing message
|
|
558
|
+
* event subscription. Inject process variables as the message's
|
|
559
|
+
* payload.
|
|
560
|
+
*/
|
|
561
|
+
export declare const triggerEvent: <ThrowOnError extends boolean = true>(options: Options<TriggerEventData, ThrowOnError>) => RequestResult<TriggerEventResponses, TriggerEventErrors, ThrowOnError, "data">;
|
|
562
|
+
/**
|
|
563
|
+
* Trigger Execution
|
|
564
|
+
*
|
|
565
|
+
* Signals an execution by id. Can for example be used to explicitly skip user tasks
|
|
566
|
+
* or signal asynchronous continuations.
|
|
567
|
+
*/
|
|
568
|
+
export declare const signalExecution: <ThrowOnError extends boolean = true>(options: Options<SignalExecutionData, ThrowOnError>) => RequestResult<SignalExecutionResponses, SignalExecutionErrors, ThrowOnError, "data">;
|
|
569
|
+
/**
|
|
570
|
+
* Get List
|
|
571
|
+
*
|
|
572
|
+
* Queries for the external tasks that fulfill given parameters. Parameters may be static as well as dynamic
|
|
573
|
+
* runtime properties of executions. The size of the result set can be retrieved by using the
|
|
574
|
+
* [Get External Task Count](https://docs.cibseven.org/manual/2.1/reference/rest/external-task/get-query-count/) method.
|
|
575
|
+
*/
|
|
576
|
+
export declare const getExternalTasks: <ThrowOnError extends boolean = true>(options?: Options<GetExternalTasksData, ThrowOnError>) => RequestResult<GetExternalTasksResponses, GetExternalTasksErrors, ThrowOnError, "data">;
|
|
577
|
+
/**
|
|
578
|
+
* Get List (POST)
|
|
579
|
+
*
|
|
580
|
+
* Queries for external tasks that fulfill given parameters in the form of a JSON object.
|
|
581
|
+
*
|
|
582
|
+
* This method is slightly more powerful than the
|
|
583
|
+
* [Get External Tasks](https://docs.cibseven.org/manual/2.1/reference/rest/external-task/get-query/) method because it allows to
|
|
584
|
+
* specify a hierarchical result sorting.
|
|
585
|
+
*/
|
|
586
|
+
export declare const queryExternalTasks: <ThrowOnError extends boolean = true>(options?: Options<QueryExternalTasksData, ThrowOnError>) => RequestResult<QueryExternalTasksResponses, QueryExternalTasksErrors, ThrowOnError, "data">;
|
|
587
|
+
/**
|
|
588
|
+
* Get List Count
|
|
589
|
+
*
|
|
590
|
+
* Queries for the number of external tasks that fulfill given parameters. Takes the same parameters as the
|
|
591
|
+
* [Get External Tasks](https://docs.cibseven.org/manual/2.1/reference/rest/external-task/get-query/) method.
|
|
592
|
+
*/
|
|
593
|
+
export declare const getExternalTasksCount: <ThrowOnError extends boolean = true>(options?: Options<GetExternalTasksCountData, ThrowOnError>) => RequestResult<GetExternalTasksCountResponses, GetExternalTasksCountErrors, ThrowOnError, "data">;
|
|
594
|
+
/**
|
|
595
|
+
* Get List Count (POST)
|
|
596
|
+
*
|
|
597
|
+
* Queries for the number of external tasks that fulfill given parameters. This method takes the same message
|
|
598
|
+
* body as the [Get External Tasks (POST)](https://docs.cibseven.org/manual/2.1/reference/rest/external-task/post-query/) method.
|
|
599
|
+
*/
|
|
600
|
+
export declare const queryExternalTasksCount: <ThrowOnError extends boolean = true>(options?: Options<QueryExternalTasksCountData, ThrowOnError>) => RequestResult<QueryExternalTasksCountResponses, QueryExternalTasksCountErrors, ThrowOnError, "data">;
|
|
601
|
+
/**
|
|
602
|
+
* Fetch and Lock
|
|
603
|
+
*
|
|
604
|
+
* Fetches and locks a specific number of external tasks for execution by a worker. Query can be restricted
|
|
605
|
+
* to specific task topics and for each task topic an individual lock time can be provided.
|
|
606
|
+
*/
|
|
607
|
+
export declare const fetchAndLock: <ThrowOnError extends boolean = true>(options?: Options<FetchAndLockData, ThrowOnError>) => RequestResult<FetchAndLockResponses, FetchAndLockErrors, ThrowOnError, "data">;
|
|
608
|
+
/**
|
|
609
|
+
* Set Retries Sync
|
|
610
|
+
*
|
|
611
|
+
* Sets the number of retries left to execute external tasks by id synchronously. If retries are set to 0,
|
|
612
|
+
* an incident is created.
|
|
613
|
+
*/
|
|
614
|
+
export declare const setExternalTaskRetries: <ThrowOnError extends boolean = true>(options?: Options<SetExternalTaskRetriesData, ThrowOnError>) => RequestResult<SetExternalTaskRetriesResponses, SetExternalTaskRetriesErrors, ThrowOnError, "data">;
|
|
615
|
+
/**
|
|
616
|
+
* Set Retries Async
|
|
617
|
+
*
|
|
618
|
+
* Sets the number of retries left to execute external tasks by id asynchronously. If retries are set to 0,
|
|
619
|
+
* an incident is created.
|
|
620
|
+
*/
|
|
621
|
+
export declare const setExternalTaskRetriesAsyncOperation: <ThrowOnError extends boolean = true>(options?: Options<SetExternalTaskRetriesAsyncOperationData, ThrowOnError>) => RequestResult<SetExternalTaskRetriesAsyncOperationResponses, SetExternalTaskRetriesAsyncOperationErrors, ThrowOnError, "data">;
|
|
622
|
+
/**
|
|
623
|
+
* Get External Task Topic Names
|
|
624
|
+
*
|
|
625
|
+
* Queries for distinct topic names of external tasks that fulfill given parameters.
|
|
626
|
+
* Query can be restricted to only tasks with retries left, tasks that are locked, or tasks
|
|
627
|
+
* that are unlocked. The parameters withLockedTasks and withUnlockedTasks are
|
|
628
|
+
* exclusive. Setting them both to true will return an empty list.
|
|
629
|
+
* Providing no parameters will return a list of all distinct topic names with external tasks.
|
|
630
|
+
*/
|
|
631
|
+
export declare const getTopicNames: <ThrowOnError extends boolean = true>(options?: Options<GetTopicNamesData, ThrowOnError>) => RequestResult<GetTopicNamesResponses, GetTopicNamesErrors, ThrowOnError, "data">;
|
|
632
|
+
/**
|
|
633
|
+
* Get
|
|
634
|
+
*
|
|
635
|
+
* Retrieves an external task by id, corresponding to the `ExternalTask` interface in the engine.
|
|
636
|
+
*/
|
|
637
|
+
export declare const getExternalTask: <ThrowOnError extends boolean = true>(options: Options<GetExternalTaskData, ThrowOnError>) => RequestResult<GetExternalTaskResponses, GetExternalTaskErrors, ThrowOnError, "data">;
|
|
638
|
+
/**
|
|
639
|
+
* Handle BPMN Error
|
|
640
|
+
*
|
|
641
|
+
* Reports a business error in the context of a running external task by id. The error code must be specified
|
|
642
|
+
* to identify the BPMN error handler.
|
|
643
|
+
*/
|
|
644
|
+
export declare const handleExternalTaskBpmnError: <ThrowOnError extends boolean = true>(options: Options<HandleExternalTaskBpmnErrorData, ThrowOnError>) => RequestResult<HandleExternalTaskBpmnErrorResponses, HandleExternalTaskBpmnErrorErrors, ThrowOnError, "data">;
|
|
645
|
+
/**
|
|
646
|
+
* Complete
|
|
647
|
+
*
|
|
648
|
+
* Completes an external task by id and updates process variables.
|
|
649
|
+
*/
|
|
650
|
+
export declare const completeExternalTaskResource: <ThrowOnError extends boolean = true>(options: Options<CompleteExternalTaskResourceData, ThrowOnError>) => RequestResult<CompleteExternalTaskResourceResponses, CompleteExternalTaskResourceErrors, ThrowOnError, "data">;
|
|
651
|
+
/**
|
|
652
|
+
* Get Error Details
|
|
653
|
+
*
|
|
654
|
+
* Retrieves the error details in the context of a running external task by id.
|
|
655
|
+
*/
|
|
656
|
+
export declare const getExternalTaskErrorDetails: <ThrowOnError extends boolean = true>(options: Options<GetExternalTaskErrorDetailsData, ThrowOnError>) => RequestResult<GetExternalTaskErrorDetailsResponses, GetExternalTaskErrorDetailsErrors, ThrowOnError, "data">;
|
|
657
|
+
/**
|
|
658
|
+
* Extend Lock
|
|
659
|
+
*
|
|
660
|
+
* Extends the timeout of the lock by a given amount of time.
|
|
661
|
+
*/
|
|
662
|
+
export declare const extendLock: <ThrowOnError extends boolean = true>(options: Options<ExtendLockData, ThrowOnError>) => RequestResult<ExtendLockResponses, ExtendLockErrors, ThrowOnError, "data">;
|
|
663
|
+
/**
|
|
664
|
+
* Handle Failure
|
|
665
|
+
*
|
|
666
|
+
* Reports a failure to execute an external task by id. A number of retries and a timeout until the task can
|
|
667
|
+
* be retried can be specified. If retries are set to 0, an incident for this task is created.
|
|
668
|
+
*/
|
|
669
|
+
export declare const handleFailure: <ThrowOnError extends boolean = true>(options: Options<HandleFailureData, ThrowOnError>) => RequestResult<HandleFailureResponses, HandleFailureErrors, ThrowOnError, "data">;
|
|
670
|
+
/**
|
|
671
|
+
* Lock an external task by a given id for a specified worker and amount of time.
|
|
672
|
+
*/
|
|
673
|
+
export declare const lock: <ThrowOnError extends boolean = true>(options: Options<LockData, ThrowOnError>) => RequestResult<LockResponses, LockErrors, ThrowOnError, "data">;
|
|
674
|
+
/**
|
|
675
|
+
* Set Priority
|
|
676
|
+
*
|
|
677
|
+
* Sets the priority of an existing external task by id. The default value of a priority is 0.
|
|
678
|
+
*/
|
|
679
|
+
export declare const setExternalTaskResourcePriority: <ThrowOnError extends boolean = true>(options: Options<SetExternalTaskResourcePriorityData, ThrowOnError>) => RequestResult<SetExternalTaskResourcePriorityResponses, SetExternalTaskResourcePriorityErrors, ThrowOnError, "data">;
|
|
680
|
+
/**
|
|
681
|
+
* Set Retries
|
|
682
|
+
*
|
|
683
|
+
* Sets the number of retries left to execute an external task by id. If retries are set to 0, an
|
|
684
|
+
* incident is created.
|
|
685
|
+
*/
|
|
686
|
+
export declare const setExternalTaskResourceRetries: <ThrowOnError extends boolean = true>(options: Options<SetExternalTaskResourceRetriesData, ThrowOnError>) => RequestResult<SetExternalTaskResourceRetriesResponses, SetExternalTaskResourceRetriesErrors, ThrowOnError, "data">;
|
|
687
|
+
/**
|
|
688
|
+
* Unlock
|
|
689
|
+
*
|
|
690
|
+
* Unlocks an external task by id. Clears the task's lock expiration time and worker id.
|
|
691
|
+
*/
|
|
692
|
+
export declare const unlock: <ThrowOnError extends boolean = true>(options: Options<UnlockData, ThrowOnError>) => RequestResult<UnlockResponses, UnlockErrors, ThrowOnError, "data">;
|
|
693
|
+
/**
|
|
694
|
+
* Get Filters
|
|
695
|
+
*
|
|
696
|
+
* Queries for a list of filters using a list of parameters. The size of the result
|
|
697
|
+
* set can be retrieved
|
|
698
|
+
* by using the [Get Filter Count](https://docs.cibseven.org/manual/2.1/reference/rest/filter/get-query-count/) method.
|
|
699
|
+
*/
|
|
700
|
+
export declare const getFilterList: <ThrowOnError extends boolean = true>(options?: Options<GetFilterListData, ThrowOnError>) => RequestResult<GetFilterListResponses, GetFilterListErrors, ThrowOnError, "data">;
|
|
701
|
+
/**
|
|
702
|
+
* Filter Resource Options
|
|
703
|
+
*
|
|
704
|
+
* The OPTIONS request allows you to check for the set of available operations
|
|
705
|
+
* that the currently authenticated user can perform on the `/filter` resource.
|
|
706
|
+
* Whether the user can perform an operation or not may depend on various
|
|
707
|
+
* factors, including the users authorizations to interact with this
|
|
708
|
+
* resource and the internal configuration of the process engine.
|
|
709
|
+
*/
|
|
710
|
+
export declare const filterResourceOptions: <ThrowOnError extends boolean = true>(options?: Options<FilterResourceOptionsData, ThrowOnError>) => RequestResult<FilterResourceOptionsResponses, unknown, ThrowOnError, "data">;
|
|
711
|
+
/**
|
|
712
|
+
* Get Filter Count
|
|
713
|
+
*
|
|
714
|
+
* Retrieves the number of filters that fulfill a provided query. Corresponds to the
|
|
715
|
+
* size of the result set when using the
|
|
716
|
+
* [Get Filters](https://docs.cibseven.org/manual/2.1/reference/rest/filter/get-query/) method.
|
|
717
|
+
*/
|
|
718
|
+
export declare const getFilterCount: <ThrowOnError extends boolean = true>(options?: Options<GetFilterCountData, ThrowOnError>) => RequestResult<GetFilterCountResponses, GetFilterCountErrors, ThrowOnError, "data">;
|
|
719
|
+
/**
|
|
720
|
+
* Create Filter
|
|
721
|
+
*
|
|
722
|
+
* Creates a new filter.
|
|
723
|
+
*/
|
|
724
|
+
export declare const createFilter: <ThrowOnError extends boolean = true>(options?: Options<CreateFilterData, ThrowOnError>) => RequestResult<CreateFilterResponses, CreateFilterErrors, ThrowOnError, "data">;
|
|
725
|
+
/**
|
|
726
|
+
* Delete Filter
|
|
727
|
+
*
|
|
728
|
+
* Deletes a filter by id.
|
|
729
|
+
*/
|
|
730
|
+
export declare const deleteFilter: <ThrowOnError extends boolean = true>(options: Options<DeleteFilterData, ThrowOnError>) => RequestResult<DeleteFilterResponses, DeleteFilterErrors, ThrowOnError, "data">;
|
|
731
|
+
/**
|
|
732
|
+
* Get Single Filter
|
|
733
|
+
*
|
|
734
|
+
* Retrieves a single filter by id, according to the `Filter` interface in the engine.
|
|
735
|
+
*/
|
|
736
|
+
export declare const getSingleFilter: <ThrowOnError extends boolean = true>(options: Options<GetSingleFilterData, ThrowOnError>) => RequestResult<GetSingleFilterResponses, GetSingleFilterErrors, ThrowOnError, "data">;
|
|
737
|
+
/**
|
|
738
|
+
* Filter Resource Options
|
|
739
|
+
*
|
|
740
|
+
* The OPTIONS request allows you to check for the set of available operations
|
|
741
|
+
* that the currently authenticated user can perform on the `/filter` resource.
|
|
742
|
+
* Whether the user can perform an operation or not may depend on various
|
|
743
|
+
* factors, including the users authorizations to interact with this
|
|
744
|
+
* resource and the internal configuration of the process engine.
|
|
745
|
+
*/
|
|
746
|
+
export declare const filterResourceOptionsSingle: <ThrowOnError extends boolean = true>(options: Options<FilterResourceOptionsSingleData, ThrowOnError>) => RequestResult<FilterResourceOptionsSingleResponses, unknown, ThrowOnError, "data">;
|
|
747
|
+
/**
|
|
748
|
+
* Update Filter
|
|
749
|
+
*
|
|
750
|
+
* Updates an existing filter.
|
|
751
|
+
*/
|
|
752
|
+
export declare const updateFilter: <ThrowOnError extends boolean = true>(options: Options<UpdateFilterData, ThrowOnError>) => RequestResult<UpdateFilterResponses, UpdateFilterErrors, ThrowOnError, "data">;
|
|
753
|
+
/**
|
|
754
|
+
* Execute Filter Count
|
|
755
|
+
*
|
|
756
|
+
* Executes the saved query of the filter by id and returns the count.
|
|
757
|
+
*/
|
|
758
|
+
export declare const executeFilterCount: <ThrowOnError extends boolean = true>(options: Options<ExecuteFilterCountData, ThrowOnError>) => RequestResult<ExecuteFilterCountResponses, ExecuteFilterCountErrors, ThrowOnError, "data">;
|
|
759
|
+
/**
|
|
760
|
+
* Execute Filter Count (POST)
|
|
761
|
+
*
|
|
762
|
+
* Executes the saved query of the filter by id and returns the count. This method is
|
|
763
|
+
* slightly more powerful then the [Get Execute Filter Count](https://docs.cibseven.org/manual/2.1/reference/rest/filter/get-execute-count/)
|
|
764
|
+
* method because it allows to extend the saved query of the filter.
|
|
765
|
+
*/
|
|
766
|
+
export declare const postExecuteFilterCount: <ThrowOnError extends boolean = true>(options: Options<PostExecuteFilterCountData, ThrowOnError>) => RequestResult<PostExecuteFilterCountResponses, PostExecuteFilterCountErrors, ThrowOnError, "data">;
|
|
767
|
+
/**
|
|
768
|
+
* Execute Filter List
|
|
769
|
+
*
|
|
770
|
+
* Executes the saved query of the filter by id and returns the result list.
|
|
771
|
+
*/
|
|
772
|
+
export declare const executeFilterList: <ThrowOnError extends boolean = true>(options: Options<ExecuteFilterListData, ThrowOnError>) => RequestResult<ExecuteFilterListResponses, ExecuteFilterListErrors, ThrowOnError, "data">;
|
|
773
|
+
/**
|
|
774
|
+
* Execute Filter List (POST)
|
|
775
|
+
*
|
|
776
|
+
* Executes the saved query of the filter by id and returns the result list. This
|
|
777
|
+
* method is slightly more powerful then the
|
|
778
|
+
* [Get Execute FilterList](https://docs.cibseven.org/manual/2.1/reference/rest/filter/get-execute-list/) method
|
|
779
|
+
* because it allows to extend the saved query of the filter.
|
|
780
|
+
*/
|
|
781
|
+
export declare const postExecuteFilterList: <ThrowOnError extends boolean = true>(options: Options<PostExecuteFilterListData, ThrowOnError>) => RequestResult<PostExecuteFilterListResponses, PostExecuteFilterListErrors, ThrowOnError, "data">;
|
|
782
|
+
/**
|
|
783
|
+
* Execute Filter Single Result
|
|
784
|
+
*
|
|
785
|
+
* Executes the saved query of the filter by id and returns the single result.
|
|
786
|
+
*/
|
|
787
|
+
export declare const executeFilterSingleResult: <ThrowOnError extends boolean = true>(options: Options<ExecuteFilterSingleResultData, ThrowOnError>) => RequestResult<ExecuteFilterSingleResultResponses, ExecuteFilterSingleResultErrors, ThrowOnError, "data">;
|
|
788
|
+
/**
|
|
789
|
+
* Execute Filter Single Result (POST)
|
|
790
|
+
*
|
|
791
|
+
* Executes the saved query of the filter by id and returns the single result. This method is slightly more
|
|
792
|
+
* powerful then the [Get Execute Filter Single Result](https://docs.cibseven.org/manual/2.1/reference/rest/filter/get-execute-single-result/)
|
|
793
|
+
* method because it allows to extend the saved query of the filter.
|
|
794
|
+
*/
|
|
795
|
+
export declare const postExecuteFilterSingleResult: <ThrowOnError extends boolean = true>(options: Options<PostExecuteFilterSingleResultData, ThrowOnError>) => RequestResult<PostExecuteFilterSingleResultResponses, PostExecuteFilterSingleResultErrors, ThrowOnError, "data">;
|
|
796
|
+
/**
|
|
797
|
+
* Get List
|
|
798
|
+
*
|
|
799
|
+
* Queries for a list of groups using a list of parameters. The size of the result set can be retrieved
|
|
800
|
+
* by using the [Get Group Count](https://docs.cibseven.org/manual/2.1/reference/rest/group/get-query-count) method.
|
|
801
|
+
*/
|
|
802
|
+
export declare const getQueryGroups: <ThrowOnError extends boolean = true>(options?: Options<GetQueryGroupsData, ThrowOnError>) => RequestResult<GetQueryGroupsResponses, GetQueryGroupsErrors, ThrowOnError, "data">;
|
|
803
|
+
/**
|
|
804
|
+
* Group Resource Options
|
|
805
|
+
*
|
|
806
|
+
* The `/group` resource supports two custom OPTIONS requests, this one for the resource as such and one for
|
|
807
|
+
* individual group instances. The OPTIONS request allows checking for the set of available operations that
|
|
808
|
+
* the currently authenticated user can perform on the `/group` resource. If the user can perform an operation
|
|
809
|
+
* or not may depend on various things, including the users authorizations to interact with this resource and
|
|
810
|
+
* the internal configuration of the process engine.
|
|
811
|
+
*/
|
|
812
|
+
export declare const availableGroupOperations: <ThrowOnError extends boolean = true>(options?: Options<AvailableGroupOperationsData, ThrowOnError>) => RequestResult<AvailableGroupOperationsResponses, unknown, ThrowOnError, "data">;
|
|
813
|
+
/**
|
|
814
|
+
* Get List (POST)
|
|
815
|
+
*
|
|
816
|
+
* Queries for a list of groups using a list of parameters.
|
|
817
|
+
* The size of the result set can be retrieved by using the
|
|
818
|
+
* [Get Group Count (POST)](https://docs.cibseven.org/manual/2.1/reference/rest/group/post-query-count/) method.
|
|
819
|
+
*/
|
|
820
|
+
export declare const postQueryGroups: <ThrowOnError extends boolean = true>(options?: Options<PostQueryGroupsData, ThrowOnError>) => RequestResult<PostQueryGroupsResponses, PostQueryGroupsErrors, ThrowOnError, "data">;
|
|
821
|
+
/**
|
|
822
|
+
* Get List Count
|
|
823
|
+
*
|
|
824
|
+
* Queries for groups using a list of parameters and retrieves the count.
|
|
825
|
+
*/
|
|
826
|
+
export declare const getGroupCount: <ThrowOnError extends boolean = true>(options?: Options<GetGroupCountData, ThrowOnError>) => RequestResult<GetGroupCountResponses, GetGroupCountErrors, ThrowOnError, "data">;
|
|
827
|
+
/**
|
|
828
|
+
* Get List Count (POST)
|
|
829
|
+
*
|
|
830
|
+
* Queries for groups using a list of parameters and retrieves the count.
|
|
831
|
+
*/
|
|
832
|
+
export declare const queryGroupCount: <ThrowOnError extends boolean = true>(options?: Options<QueryGroupCountData, ThrowOnError>) => RequestResult<QueryGroupCountResponses, QueryGroupCountErrors, ThrowOnError, "data">;
|
|
833
|
+
/**
|
|
834
|
+
* Create Group
|
|
835
|
+
*
|
|
836
|
+
* Creates a new group.
|
|
837
|
+
*/
|
|
838
|
+
export declare const createGroup: <ThrowOnError extends boolean = true>(options?: Options<CreateGroupData, ThrowOnError>) => RequestResult<CreateGroupResponses, CreateGroupErrors, ThrowOnError, "data">;
|
|
839
|
+
/**
|
|
840
|
+
* Delete Group
|
|
841
|
+
*
|
|
842
|
+
* Deletes a group by id.
|
|
843
|
+
*/
|
|
844
|
+
export declare const deleteGroup: <ThrowOnError extends boolean = true>(options: Options<DeleteGroupData, ThrowOnError>) => RequestResult<DeleteGroupResponses, DeleteGroupErrors, ThrowOnError, "data">;
|
|
845
|
+
/**
|
|
846
|
+
* Get Group
|
|
847
|
+
*
|
|
848
|
+
* Retrieves a group by id.
|
|
849
|
+
*/
|
|
850
|
+
export declare const getGroup: <ThrowOnError extends boolean = true>(options: Options<GetGroupData, ThrowOnError>) => RequestResult<GetGroupResponses, GetGroupErrors, ThrowOnError, "data">;
|
|
851
|
+
/**
|
|
852
|
+
* Group Resource Instance Options
|
|
853
|
+
*
|
|
854
|
+
* The `/group` resource supports two custom OPTIONS requests, one for the resource as such and this one for individual group instances.
|
|
855
|
+
* The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the
|
|
856
|
+
* `/group/{id}` resource instance. If the user can perform an operation or not may depend on various things, including the users authorizations
|
|
857
|
+
* to interact with this resource and the internal configuration of the process engine.
|
|
858
|
+
*/
|
|
859
|
+
export declare const availableGroupInstanceOperations: <ThrowOnError extends boolean = true>(options: Options<AvailableGroupInstanceOperationsData, ThrowOnError>) => RequestResult<AvailableGroupInstanceOperationsResponses, unknown, ThrowOnError, "data">;
|
|
860
|
+
/**
|
|
861
|
+
* Update Group
|
|
862
|
+
*
|
|
863
|
+
* Updates a given group by id.
|
|
864
|
+
*/
|
|
865
|
+
export declare const updateGroup: <ThrowOnError extends boolean = true>(options: Options<UpdateGroupData, ThrowOnError>) => RequestResult<UpdateGroupResponses, UpdateGroupErrors, ThrowOnError, "data">;
|
|
866
|
+
/**
|
|
867
|
+
* Group Membership Resource Options
|
|
868
|
+
*
|
|
869
|
+
* The OPTIONS request allows checking for the set of available operations that the currently authenticated
|
|
870
|
+
* user can perform on the resource. If the user can perform an operation or not may depend on various
|
|
871
|
+
* things, including the users authorizations to interact with this resource and the internal configuration
|
|
872
|
+
* of the process engine.
|
|
873
|
+
*/
|
|
874
|
+
export declare const availableGroupMembersOperations: <ThrowOnError extends boolean = true>(options: Options<AvailableGroupMembersOperationsData, ThrowOnError>) => RequestResult<AvailableGroupMembersOperationsResponses, unknown, ThrowOnError, "data">;
|
|
875
|
+
/**
|
|
876
|
+
* Delete a Group Member
|
|
877
|
+
*
|
|
878
|
+
* Removes a member from a group.
|
|
879
|
+
*/
|
|
880
|
+
export declare const deleteGroupMember: <ThrowOnError extends boolean = true>(options: Options<DeleteGroupMemberData, ThrowOnError>) => RequestResult<DeleteGroupMemberResponses, DeleteGroupMemberErrors, ThrowOnError, "data">;
|
|
881
|
+
/**
|
|
882
|
+
* Create Group Member
|
|
883
|
+
*
|
|
884
|
+
* Adds a member to a group.
|
|
885
|
+
*/
|
|
886
|
+
export declare const createGroupMember: <ThrowOnError extends boolean = true>(options: Options<CreateGroupMemberData, ThrowOnError>) => RequestResult<CreateGroupMemberResponses, CreateGroupMemberErrors, ThrowOnError, "data">;
|
|
887
|
+
/**
|
|
888
|
+
* Get List
|
|
889
|
+
*
|
|
890
|
+
* Queries for historic activity instances that fulfill the given parameters.
|
|
891
|
+
* The size of the result set can be retrieved by using the
|
|
892
|
+
* [Get Historic Activity Instance Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/activity-instance/get-activity-instance-query-count/) method.
|
|
893
|
+
*/
|
|
894
|
+
export declare const getHistoricActivityInstances: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricActivityInstancesData, ThrowOnError>) => RequestResult<GetHistoricActivityInstancesResponses, GetHistoricActivityInstancesErrors, ThrowOnError, "data">;
|
|
895
|
+
/**
|
|
896
|
+
* Get List (POST)
|
|
897
|
+
*
|
|
898
|
+
* Queries for historic activity instances that fulfill the given parameters.
|
|
899
|
+
* The size of the result set can be retrieved by using the
|
|
900
|
+
* [Get Historic Activity Instance Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/activity-instance/get-activity-instance-query-count/) method.
|
|
901
|
+
*/
|
|
902
|
+
export declare const queryHistoricActivityInstances: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricActivityInstancesData, ThrowOnError>) => RequestResult<QueryHistoricActivityInstancesResponses, QueryHistoricActivityInstancesErrors, ThrowOnError, "data">;
|
|
903
|
+
/**
|
|
904
|
+
* Get List Count
|
|
905
|
+
*
|
|
906
|
+
* Queries for the number of historic activity instances that fulfill the given parameters.
|
|
907
|
+
* Takes the same parameters as the [Get Historic Activity Instance](https://docs.cibseven.org/manual/2.1/reference/rest/history/activity-instance/get-activity-instance-query/) method.
|
|
908
|
+
*/
|
|
909
|
+
export declare const getHistoricActivityInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricActivityInstancesCountData, ThrowOnError>) => RequestResult<GetHistoricActivityInstancesCountResponses, GetHistoricActivityInstancesCountErrors, ThrowOnError, "data">;
|
|
910
|
+
/**
|
|
911
|
+
* Get List Count (POST)
|
|
912
|
+
*
|
|
913
|
+
* Queries for the number of historic activity instances that fulfill the given parameters.
|
|
914
|
+
*/
|
|
915
|
+
export declare const queryHistoricActivityInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricActivityInstancesCountData, ThrowOnError>) => RequestResult<QueryHistoricActivityInstancesCountResponses, QueryHistoricActivityInstancesCountErrors, ThrowOnError, "data">;
|
|
916
|
+
/**
|
|
917
|
+
* Get
|
|
918
|
+
*
|
|
919
|
+
* Retrieves a historic activity instance by id, according to the `HistoricActivityInstance` interface in the engine.
|
|
920
|
+
*/
|
|
921
|
+
export declare const getHistoricActivityInstance: <ThrowOnError extends boolean = true>(options: Options<GetHistoricActivityInstanceData, ThrowOnError>) => RequestResult<GetHistoricActivityInstanceResponses, GetHistoricActivityInstanceErrors, ThrowOnError, "data">;
|
|
922
|
+
/**
|
|
923
|
+
* Get Historic Batches
|
|
924
|
+
*
|
|
925
|
+
* Queries for historic batches that fulfill given parameters. Parameters may be
|
|
926
|
+
* the properties of batches, such as the id or type. The
|
|
927
|
+
* size of the result set can be retrieved by using the
|
|
928
|
+
* [Get Historic Batch Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/batch/get-query-count/)
|
|
929
|
+
* method.
|
|
930
|
+
*/
|
|
931
|
+
export declare const getHistoricBatches: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricBatchesData, ThrowOnError>) => RequestResult<GetHistoricBatchesResponses, GetHistoricBatchesErrors, ThrowOnError, "data">;
|
|
932
|
+
/**
|
|
933
|
+
* Get Cleanable Batch Report
|
|
934
|
+
*
|
|
935
|
+
* Retrieves a report about a historic batch operations relevant to history cleanup
|
|
936
|
+
* (see
|
|
937
|
+
* [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup)
|
|
938
|
+
* ) so that you can tune the history time to live.
|
|
939
|
+
* These reports include the count of the finished batches, cleanable
|
|
940
|
+
* batches and type of the batch.
|
|
941
|
+
* The size of the result set can be retrieved by using the
|
|
942
|
+
* [Get Cleanable Batch Report Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/batch/get-cleanable-batch-report-count/)
|
|
943
|
+
* method.
|
|
944
|
+
*
|
|
945
|
+
* **Please note:**
|
|
946
|
+
* The history time to live for batch operations does not support [Multi-Tenancy](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/multi-tenancy.md).
|
|
947
|
+
* The report will return an information for all batch operations (for all tenants) if you have permissions
|
|
948
|
+
* to see the history.
|
|
949
|
+
*
|
|
950
|
+
*/
|
|
951
|
+
export declare const getCleanableHistoricBatchesReport: <ThrowOnError extends boolean = true>(options?: Options<GetCleanableHistoricBatchesReportData, ThrowOnError>) => RequestResult<GetCleanableHistoricBatchesReportResponses, GetCleanableHistoricBatchesReportErrors, ThrowOnError, "data">;
|
|
952
|
+
/**
|
|
953
|
+
* Get Cleanable Batch Report Count
|
|
954
|
+
*
|
|
955
|
+
* Queries for the number of report results about a historic batch operations relevant
|
|
956
|
+
* to history cleanup (see
|
|
957
|
+
* [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup)
|
|
958
|
+
* ).
|
|
959
|
+
* Takes the same parameters as the
|
|
960
|
+
* [Get Cleanable Batch Report](https://docs.cibseven.org/manual/2.1/reference/rest/history/batch/get-cleanable-batch-report/)
|
|
961
|
+
* method.
|
|
962
|
+
*/
|
|
963
|
+
export declare const getCleanableHistoricBatchesReportCount: <ThrowOnError extends boolean = true>(options?: Options<GetCleanableHistoricBatchesReportCountData, ThrowOnError>) => RequestResult<GetCleanableHistoricBatchesReportCountResponses, GetCleanableHistoricBatchesReportCountErrors, ThrowOnError, "data">;
|
|
964
|
+
/**
|
|
965
|
+
* Get Historic Batch Count
|
|
966
|
+
*
|
|
967
|
+
* Requests the number of historic batches that fulfill the query criteria.
|
|
968
|
+
* Takes the same filtering parameters as the
|
|
969
|
+
* [Get Historic Batches](https://docs.cibseven.org/manual/2.1/reference/rest/history/batch/get-query/)
|
|
970
|
+
* method.
|
|
971
|
+
*/
|
|
972
|
+
export declare const getHistoricBatchesCount: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricBatchesCountData, ThrowOnError>) => RequestResult<GetHistoricBatchesCountResponses, GetHistoricBatchesCountErrors, ThrowOnError, "data">;
|
|
973
|
+
/**
|
|
974
|
+
* Set Removal Time Async (POST)
|
|
975
|
+
*
|
|
976
|
+
* Sets the removal time to multiple historic batches asynchronously (batch).
|
|
977
|
+
*
|
|
978
|
+
* At least __historicBatchIds__ or __historicBatchQuery__ has to be
|
|
979
|
+
* provided. If both are provided,
|
|
980
|
+
* all instances matching query criterion and instances from the list
|
|
981
|
+
* will be updated with a removal time.
|
|
982
|
+
*/
|
|
983
|
+
export declare const setRemovalTimeAsyncHistoricBatch: <ThrowOnError extends boolean = true>(options?: Options<SetRemovalTimeAsyncHistoricBatchData, ThrowOnError>) => RequestResult<SetRemovalTimeAsyncHistoricBatchResponses, SetRemovalTimeAsyncHistoricBatchErrors, ThrowOnError, "data">;
|
|
984
|
+
/**
|
|
985
|
+
* Delete Historic Batch
|
|
986
|
+
*
|
|
987
|
+
* Deletes a historic batch by id, including related historic job logs.
|
|
988
|
+
*/
|
|
989
|
+
export declare const deleteHistoricBatch: <ThrowOnError extends boolean = true>(options: Options<DeleteHistoricBatchData, ThrowOnError>) => RequestResult<DeleteHistoricBatchResponses, DeleteHistoricBatchErrors, ThrowOnError, "data">;
|
|
990
|
+
/**
|
|
991
|
+
* Get Historic Batch
|
|
992
|
+
*
|
|
993
|
+
* Retrieves a historic batch by id, according to the `HistoricBatch` interface in the
|
|
994
|
+
* engine.
|
|
995
|
+
*/
|
|
996
|
+
export declare const getHistoricBatch: <ThrowOnError extends boolean = true>(options: Options<GetHistoricBatchData, ThrowOnError>) => RequestResult<GetHistoricBatchResponses, GetHistoricBatchErrors, ThrowOnError, "data">;
|
|
997
|
+
/**
|
|
998
|
+
* Clean up history (POST)
|
|
999
|
+
*
|
|
1000
|
+
* Schedules asynchronous history cleanup (See
|
|
1001
|
+
* [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup)).
|
|
1002
|
+
*
|
|
1003
|
+
* **Note:** This endpoint will return at most a single history cleanup job.
|
|
1004
|
+
* Since version `7.9.0` it is possible to configure multiple
|
|
1005
|
+
* [parallel history cleanup jobs](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#parallel-execution). Use
|
|
1006
|
+
* [`GET /history/cleanup/jobs`](https://docs.cibseven.org/manual/2.1/reference/rest/history/history-cleanup/get-history-cleanup-jobs)
|
|
1007
|
+
* to find all the available history cleanup jobs.
|
|
1008
|
+
*/
|
|
1009
|
+
export declare const cleanupAsync: <ThrowOnError extends boolean = true>(options?: Options<CleanupAsyncData, ThrowOnError>) => RequestResult<CleanupAsyncResponses, CleanupAsyncErrors, ThrowOnError, "data">;
|
|
1010
|
+
/**
|
|
1011
|
+
* Get History Cleanup Configuration
|
|
1012
|
+
*
|
|
1013
|
+
* Retrieves history cleanup batch window configuration (See
|
|
1014
|
+
* [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup)).
|
|
1015
|
+
*/
|
|
1016
|
+
export declare const getHistoryCleanupConfiguration: <ThrowOnError extends boolean = true>(options?: Options<GetHistoryCleanupConfigurationData, ThrowOnError>) => RequestResult<GetHistoryCleanupConfigurationResponses, unknown, ThrowOnError, "data">;
|
|
1017
|
+
/**
|
|
1018
|
+
* Find clean up history job (GET)
|
|
1019
|
+
*
|
|
1020
|
+
* **Deprecated!** Use `GET /history/cleanup/jobs` instead.
|
|
1021
|
+
*
|
|
1022
|
+
* Finds history cleanup job (See
|
|
1023
|
+
* [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup)).
|
|
1024
|
+
*
|
|
1025
|
+
* @deprecated
|
|
1026
|
+
*/
|
|
1027
|
+
export declare const findCleanupJob: <ThrowOnError extends boolean = true>(options?: Options<FindCleanupJobData, ThrowOnError>) => RequestResult<FindCleanupJobResponses, FindCleanupJobErrors, ThrowOnError, "data">;
|
|
1028
|
+
/**
|
|
1029
|
+
* Find clean up history jobs (GET)
|
|
1030
|
+
*
|
|
1031
|
+
* Finds history cleanup jobs (See
|
|
1032
|
+
* [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup)).
|
|
1033
|
+
*/
|
|
1034
|
+
export declare const findCleanupJobs: <ThrowOnError extends boolean = true>(options?: Options<FindCleanupJobsData, ThrowOnError>) => RequestResult<FindCleanupJobsResponses, FindCleanupJobsErrors, ThrowOnError, "data">;
|
|
1035
|
+
/**
|
|
1036
|
+
* Get Cleanable Decision Instance Report
|
|
1037
|
+
*
|
|
1038
|
+
* Retrieves a report about a decision definition and finished decision instances
|
|
1039
|
+
* relevant to history cleanup (see
|
|
1040
|
+
* [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup)),
|
|
1041
|
+
* so that you can tune the history time to live.
|
|
1042
|
+
* These reports include the count of the finished historic decision
|
|
1043
|
+
* instances, cleanable decision instances and basic decision definition
|
|
1044
|
+
* data - id, key, name and version.
|
|
1045
|
+
* The size of the result set can be retrieved by using the
|
|
1046
|
+
* [Get Cleanable Decision Instance Report Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/decision-definition/get-cleanable-decision-instance-report-count/) method.
|
|
1047
|
+
*/
|
|
1048
|
+
export declare const getCleanableHistoricDecisionInstanceReport: <ThrowOnError extends boolean = true>(options?: Options<GetCleanableHistoricDecisionInstanceReportData, ThrowOnError>) => RequestResult<GetCleanableHistoricDecisionInstanceReportResponses, GetCleanableHistoricDecisionInstanceReportErrors, ThrowOnError, "data">;
|
|
1049
|
+
/**
|
|
1050
|
+
* Get Cleanable Decision Instance Report Count
|
|
1051
|
+
*
|
|
1052
|
+
* Queries for the number of report results about a decision definition and finished
|
|
1053
|
+
* decision instances relevant to history cleanup (see
|
|
1054
|
+
* [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup)).
|
|
1055
|
+
* Takes the same parameters as the [Get Cleanable Decision Instance Report](https://docs.cibseven.org/manual/2.1/reference/rest/history/decision-definition/get-cleanable-decision-instance-report/)
|
|
1056
|
+
* method.
|
|
1057
|
+
*/
|
|
1058
|
+
export declare const getCleanableHistoricDecisionInstanceReportCount: <ThrowOnError extends boolean = true>(options?: Options<GetCleanableHistoricDecisionInstanceReportCountData, ThrowOnError>) => RequestResult<GetCleanableHistoricDecisionInstanceReportCountResponses, GetCleanableHistoricDecisionInstanceReportCountErrors, ThrowOnError, "data">;
|
|
1059
|
+
/**
|
|
1060
|
+
* Get Historic Decision Instances
|
|
1061
|
+
*
|
|
1062
|
+
* Queries for historic decision instances that fulfill the given parameters.
|
|
1063
|
+
* The size of the result set can be retrieved by using the
|
|
1064
|
+
* [Get Historic Decision Instance Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/decision-instance/get-decision-instance-query-count/)
|
|
1065
|
+
* method.
|
|
1066
|
+
*/
|
|
1067
|
+
export declare const getHistoricDecisionInstances: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricDecisionInstancesData, ThrowOnError>) => RequestResult<GetHistoricDecisionInstancesResponses, GetHistoricDecisionInstancesErrors, ThrowOnError, "data">;
|
|
1068
|
+
/**
|
|
1069
|
+
* Get Historic Decision Instance Count
|
|
1070
|
+
*
|
|
1071
|
+
* Queries for the number of historic decision instances that fulfill the given parameters.
|
|
1072
|
+
* Takes the same parameters as the
|
|
1073
|
+
* [Get Historic Decision Instances](https://docs.cibseven.org/manual/2.1/reference/rest/history/decision-instance/get-decision-instance-query/)
|
|
1074
|
+
* method.
|
|
1075
|
+
*/
|
|
1076
|
+
export declare const getHistoricDecisionInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricDecisionInstancesCountData, ThrowOnError>) => RequestResult<GetHistoricDecisionInstancesCountResponses, GetHistoricDecisionInstancesCountErrors, ThrowOnError, "data">;
|
|
1077
|
+
/**
|
|
1078
|
+
* Delete Async (POST)
|
|
1079
|
+
*
|
|
1080
|
+
* Delete multiple historic decision instances asynchronously (batch).
|
|
1081
|
+
* At least `historicDecisionInstanceIds` or `historicDecisionInstanceQuery`
|
|
1082
|
+
* has to be provided. If both are provided then all instances matching query
|
|
1083
|
+
* criterion and instances from the list will be deleted.
|
|
1084
|
+
*/
|
|
1085
|
+
export declare const deleteAsync: <ThrowOnError extends boolean = true>(options?: Options<DeleteAsyncData, ThrowOnError>) => RequestResult<DeleteAsyncResponses, DeleteAsyncErrors, ThrowOnError, "data">;
|
|
1086
|
+
/**
|
|
1087
|
+
* Set Removal Time Async (POST)
|
|
1088
|
+
*
|
|
1089
|
+
* Sets the removal time to multiple historic decision instances asynchronously
|
|
1090
|
+
* (batch).
|
|
1091
|
+
*
|
|
1092
|
+
* At least `historicDecisionInstanceIds` or
|
|
1093
|
+
* `historicDecisionInstanceQuery` has to be provided. If both are
|
|
1094
|
+
* provided, all instances matching query criterion and instances from the list
|
|
1095
|
+
* will be updated with a removal time.
|
|
1096
|
+
*/
|
|
1097
|
+
export declare const setRemovalTimeAsyncHistoricDecisionInstance: <ThrowOnError extends boolean = true>(options?: Options<SetRemovalTimeAsyncHistoricDecisionInstanceData, ThrowOnError>) => RequestResult<SetRemovalTimeAsyncHistoricDecisionInstanceResponses, SetRemovalTimeAsyncHistoricDecisionInstanceErrors, ThrowOnError, "data">;
|
|
1098
|
+
/**
|
|
1099
|
+
* Get Historic Decision Instance
|
|
1100
|
+
*
|
|
1101
|
+
* Retrieves a historic decision instance by id, according to the
|
|
1102
|
+
* `HistoricDecisionInstance` interface in the engine.
|
|
1103
|
+
*/
|
|
1104
|
+
export declare const getHistoricDecisionInstance: <ThrowOnError extends boolean = true>(options: Options<GetHistoricDecisionInstanceData, ThrowOnError>) => RequestResult<GetHistoricDecisionInstanceResponses, GetHistoricDecisionInstanceErrors, ThrowOnError, "data">;
|
|
1105
|
+
/**
|
|
1106
|
+
* Get DRD Statistics
|
|
1107
|
+
*
|
|
1108
|
+
* Retrieves evaluation statistics of a given decision requirements definition.
|
|
1109
|
+
*/
|
|
1110
|
+
export declare const getDecisionStatistics: <ThrowOnError extends boolean = true>(options: Options<GetDecisionStatisticsData, ThrowOnError>) => RequestResult<GetDecisionStatisticsResponses, GetDecisionStatisticsErrors, ThrowOnError, "data">;
|
|
1111
|
+
/**
|
|
1112
|
+
* Get Historic Details
|
|
1113
|
+
*
|
|
1114
|
+
* Queries for historic details that fulfill the given parameters.
|
|
1115
|
+
* The size of the result set can be retrieved by using the
|
|
1116
|
+
* [Get Historic Detail Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/detail/get-detail-query-count/) method.
|
|
1117
|
+
*/
|
|
1118
|
+
export declare const getHistoricDetails: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricDetailsData, ThrowOnError>) => RequestResult<GetHistoricDetailsResponses, GetHistoricDetailsErrors, ThrowOnError, "data">;
|
|
1119
|
+
/**
|
|
1120
|
+
* Get Historic Details (POST)
|
|
1121
|
+
*
|
|
1122
|
+
* Queries for historic details that fulfill the given parameters. This method is slightly more
|
|
1123
|
+
* powerful than the [Get Historic Details](https://docs.cibseven.org/manual/2.1/reference/rest/history/detail/get-detail-query/)
|
|
1124
|
+
* method because it allows sorting by multiple parameters. The size of the result set can be retrieved by
|
|
1125
|
+
* using the [Get Historic Detail Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/detail/get-detail-query-count/)
|
|
1126
|
+
* method.
|
|
1127
|
+
*/
|
|
1128
|
+
export declare const queryHistoricDetails: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricDetailsData, ThrowOnError>) => RequestResult<QueryHistoricDetailsResponses, QueryHistoricDetailsErrors, ThrowOnError, "data">;
|
|
1129
|
+
/**
|
|
1130
|
+
* Get Historic Detail Count
|
|
1131
|
+
*
|
|
1132
|
+
* Queries for the number of historic details that fulfill the given parameters.
|
|
1133
|
+
* Takes the same parameters as the [Get Historic
|
|
1134
|
+
* Details](https://docs.cibseven.org/manual/2.1/reference/rest/history/detail/get-detail-query/)
|
|
1135
|
+
* method.
|
|
1136
|
+
*/
|
|
1137
|
+
export declare const getHistoricDetailsCount: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricDetailsCountData, ThrowOnError>) => RequestResult<GetHistoricDetailsCountResponses, GetHistoricDetailsCountErrors, ThrowOnError, "data">;
|
|
1138
|
+
/**
|
|
1139
|
+
* Get Historic Detail
|
|
1140
|
+
*
|
|
1141
|
+
* Retrieves a historic detail by id.
|
|
1142
|
+
*/
|
|
1143
|
+
export declare const historicDetail: <ThrowOnError extends boolean = true>(options: Options<HistoricDetailData, ThrowOnError>) => RequestResult<HistoricDetailResponses, HistoricDetailErrors, ThrowOnError, "data">;
|
|
1144
|
+
/**
|
|
1145
|
+
* Get Historic Detail (Binary)
|
|
1146
|
+
*
|
|
1147
|
+
* Retrieves the content of a historic variable update by id. Applicable for byte
|
|
1148
|
+
* array and file variables.
|
|
1149
|
+
*/
|
|
1150
|
+
export declare const historicDetailBinary: <ThrowOnError extends boolean = true>(options: Options<HistoricDetailBinaryData, ThrowOnError>) => RequestResult<HistoricDetailBinaryResponses, HistoricDetailBinaryErrors, ThrowOnError, "data">;
|
|
1151
|
+
/**
|
|
1152
|
+
* Get External Task Logs
|
|
1153
|
+
*
|
|
1154
|
+
* Queries for historic external task logs that fulfill the given parameters.
|
|
1155
|
+
* The size of the result set can be retrieved by using the
|
|
1156
|
+
* [Get External Task Log Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/external-task-log/get-external-task-log-query-count/)
|
|
1157
|
+
* method.
|
|
1158
|
+
*/
|
|
1159
|
+
export declare const getHistoricExternalTaskLogs: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricExternalTaskLogsData, ThrowOnError>) => RequestResult<GetHistoricExternalTaskLogsResponses, GetHistoricExternalTaskLogsErrors, ThrowOnError, "data">;
|
|
1160
|
+
/**
|
|
1161
|
+
* Get External Task Logs (POST)
|
|
1162
|
+
*
|
|
1163
|
+
* Queries for historic external task logs that fulfill the given parameters.
|
|
1164
|
+
* This method is slightly more powerful than the
|
|
1165
|
+
* [Get External Task Logs](https://docs.cibseven.org/manual/2.1/reference/rest/history/external-task-log/get-external-task-log-query/)
|
|
1166
|
+
* method because it allows filtering by historic external task logs
|
|
1167
|
+
* values of the different types `String`, `Number` or `Boolean`.
|
|
1168
|
+
*/
|
|
1169
|
+
export declare const queryHistoricExternalTaskLogs: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricExternalTaskLogsData, ThrowOnError>) => RequestResult<QueryHistoricExternalTaskLogsResponses, QueryHistoricExternalTaskLogsErrors, ThrowOnError, "data">;
|
|
1170
|
+
/**
|
|
1171
|
+
* Get External Task Log Count
|
|
1172
|
+
*
|
|
1173
|
+
* Queries for the number of historic external task logs that fulfill the given
|
|
1174
|
+
* parameters.
|
|
1175
|
+
* Takes the same parameters as the
|
|
1176
|
+
* [Get External Task Logs](https://docs.cibseven.org/manual/2.1/reference/rest/history/external-task-log/get-external-task-log-query/)
|
|
1177
|
+
* method.
|
|
1178
|
+
*/
|
|
1179
|
+
export declare const getHistoricExternalTaskLogsCount: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricExternalTaskLogsCountData, ThrowOnError>) => RequestResult<GetHistoricExternalTaskLogsCountResponses, GetHistoricExternalTaskLogsCountErrors, ThrowOnError, "data">;
|
|
1180
|
+
/**
|
|
1181
|
+
* Get External Task Log Count (POST)
|
|
1182
|
+
*
|
|
1183
|
+
* Queries for the number of historic external task logs that fulfill the given
|
|
1184
|
+
* parameters.
|
|
1185
|
+
* This method takes the same message body as the
|
|
1186
|
+
* [Get External Task Logs (POST)](https://docs.cibseven.org/manual/2.1/reference/rest/history/external-task-log/post-external-task-log-query/)
|
|
1187
|
+
* method and therefore it is slightly more powerful than the
|
|
1188
|
+
* [Get External Task Log Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/external-task-log/get-external-task-log-query-count/)
|
|
1189
|
+
* method.
|
|
1190
|
+
*/
|
|
1191
|
+
export declare const queryHistoricExternalTaskLogsCount: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricExternalTaskLogsCountData, ThrowOnError>) => RequestResult<QueryHistoricExternalTaskLogsCountResponses, QueryHistoricExternalTaskLogsCountErrors, ThrowOnError, "data">;
|
|
1192
|
+
/**
|
|
1193
|
+
* Get External Task Log
|
|
1194
|
+
*
|
|
1195
|
+
* Retrieves a historic external task log by id.
|
|
1196
|
+
*/
|
|
1197
|
+
export declare const getHistoricExternalTaskLog: <ThrowOnError extends boolean = true>(options: Options<GetHistoricExternalTaskLogData, ThrowOnError>) => RequestResult<GetHistoricExternalTaskLogResponses, GetHistoricExternalTaskLogErrors, ThrowOnError, "data">;
|
|
1198
|
+
/**
|
|
1199
|
+
* Get External Task Log Error Details
|
|
1200
|
+
*
|
|
1201
|
+
* Retrieves the corresponding error details of the passed historic external task log
|
|
1202
|
+
* by id.
|
|
1203
|
+
*/
|
|
1204
|
+
export declare const getErrorDetailsHistoricExternalTaskLog: <ThrowOnError extends boolean = true>(options: Options<GetErrorDetailsHistoricExternalTaskLogData, ThrowOnError>) => RequestResult<GetErrorDetailsHistoricExternalTaskLogResponses, GetErrorDetailsHistoricExternalTaskLogErrors, ThrowOnError, "data">;
|
|
1205
|
+
/**
|
|
1206
|
+
* Get Identity Link Logs
|
|
1207
|
+
*
|
|
1208
|
+
* Queries for historic identity link logs that fulfill given parameters.
|
|
1209
|
+
* The size of the result set can be retrieved by using the
|
|
1210
|
+
* [Get Identity-Link-Log Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/identity-links/get-identity-link-query-count/)
|
|
1211
|
+
* method.
|
|
1212
|
+
*/
|
|
1213
|
+
export declare const getHistoricIdentityLinks: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricIdentityLinksData, ThrowOnError>) => RequestResult<GetHistoricIdentityLinksResponses, GetHistoricIdentityLinksErrors, ThrowOnError, "data">;
|
|
1214
|
+
/**
|
|
1215
|
+
* Get Identity Link Log Count
|
|
1216
|
+
*
|
|
1217
|
+
* Queries for the number of historic identity link logs that fulfill the given
|
|
1218
|
+
* parameters. Takes the same parameters as the
|
|
1219
|
+
* [Get Identity-Link-Logs](https://docs.cibseven.org/manual/2.1/reference/rest/history/identity-links/get-identity-link-query/)
|
|
1220
|
+
* method.
|
|
1221
|
+
*/
|
|
1222
|
+
export declare const getHistoricIdentityLinksCount: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricIdentityLinksCountData, ThrowOnError>) => RequestResult<GetHistoricIdentityLinksCountResponses, GetHistoricIdentityLinksCountErrors, ThrowOnError, "data">;
|
|
1223
|
+
/**
|
|
1224
|
+
* Get Incidents
|
|
1225
|
+
*
|
|
1226
|
+
* Queries for historic incidents that fulfill given parameters.
|
|
1227
|
+
* The size of the result set can be retrieved by using the
|
|
1228
|
+
* [Get Incident Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/incident/get-incident-query-count/)
|
|
1229
|
+
* method.
|
|
1230
|
+
*/
|
|
1231
|
+
export declare const getHistoricIncidents: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricIncidentsData, ThrowOnError>) => RequestResult<GetHistoricIncidentsResponses, GetHistoricIncidentsErrors, ThrowOnError, "data">;
|
|
1232
|
+
/**
|
|
1233
|
+
* Get Incident Count
|
|
1234
|
+
*
|
|
1235
|
+
* Queries for the number of historic incidents that fulfill the given parameters.
|
|
1236
|
+
* Takes the same parameters as the
|
|
1237
|
+
* [Get Incidents](https://docs.cibseven.org/manual/2.1/reference/rest/history/incident/get-incident-query/)
|
|
1238
|
+
* method.
|
|
1239
|
+
*/
|
|
1240
|
+
export declare const getHistoricIncidentsCount: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricIncidentsCountData, ThrowOnError>) => RequestResult<GetHistoricIncidentsCountResponses, GetHistoricIncidentsCountErrors, ThrowOnError, "data">;
|
|
1241
|
+
/**
|
|
1242
|
+
* Get Job Logs
|
|
1243
|
+
*
|
|
1244
|
+
* Queries for historic job logs that fulfill the given parameters.
|
|
1245
|
+
* The size of the result set can be retrieved by using the
|
|
1246
|
+
* [Get Job Log Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/job-log/get-job-log-query-count/)
|
|
1247
|
+
* method.
|
|
1248
|
+
*/
|
|
1249
|
+
export declare const getHistoricJobLogs: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricJobLogsData, ThrowOnError>) => RequestResult<GetHistoricJobLogsResponses, GetHistoricJobLogsErrors, ThrowOnError, "data">;
|
|
1250
|
+
/**
|
|
1251
|
+
* Get Job Logs (POST)
|
|
1252
|
+
*
|
|
1253
|
+
* Queries for historic job logs that fulfill the given parameters.
|
|
1254
|
+
* This method is slightly more powerful than the
|
|
1255
|
+
* [Get Job Logs](https://docs.cibseven.org/manual/2.1/reference/rest/history/job-log/get-job-log-query/)
|
|
1256
|
+
* method because it allows filtering by historic job logs values of the
|
|
1257
|
+
* different types `String`, `Number` or `Boolean`.
|
|
1258
|
+
*/
|
|
1259
|
+
export declare const queryHistoricJobLogs: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricJobLogsData, ThrowOnError>) => RequestResult<QueryHistoricJobLogsResponses, QueryHistoricJobLogsErrors, ThrowOnError, "data">;
|
|
1260
|
+
/**
|
|
1261
|
+
* Get Job Log Count
|
|
1262
|
+
*
|
|
1263
|
+
* Queries for the number of historic job logs that fulfill the given parameters.
|
|
1264
|
+
* Takes the same parameters as the
|
|
1265
|
+
* [Get Job Logs](https://docs.cibseven.org/manual/2.1/reference/rest/history/job-log/get-job-log-query/)
|
|
1266
|
+
* method.
|
|
1267
|
+
*/
|
|
1268
|
+
export declare const getHistoricJobLogsCount: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricJobLogsCountData, ThrowOnError>) => RequestResult<GetHistoricJobLogsCountResponses, GetHistoricJobLogsCountErrors, ThrowOnError, "data">;
|
|
1269
|
+
/**
|
|
1270
|
+
* Get Job Log Count (POST)
|
|
1271
|
+
*
|
|
1272
|
+
* Queries for the number of historic job logs that fulfill the given parameters.
|
|
1273
|
+
* This method takes the same message body as the
|
|
1274
|
+
* [Get Job Logs (POST)](https://docs.cibseven.org/manual/2.1/reference/rest/history/job-log/post-job-log-query/)
|
|
1275
|
+
* method and therefore it is slightly more powerful than the
|
|
1276
|
+
* [Get Job Log Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/job-log/get-job-log-query-count/)
|
|
1277
|
+
* method.
|
|
1278
|
+
*/
|
|
1279
|
+
export declare const queryHistoricJobLogsCount: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricJobLogsCountData, ThrowOnError>) => RequestResult<QueryHistoricJobLogsCountResponses, QueryHistoricJobLogsCountErrors, ThrowOnError, "data">;
|
|
1280
|
+
/**
|
|
1281
|
+
* Get Job Log
|
|
1282
|
+
*
|
|
1283
|
+
* Retrieves a historic job log by id.
|
|
1284
|
+
*/
|
|
1285
|
+
export declare const getHistoricJobLog: <ThrowOnError extends boolean = true>(options: Options<GetHistoricJobLogData, ThrowOnError>) => RequestResult<GetHistoricJobLogResponses, GetHistoricJobLogErrors, ThrowOnError, "data">;
|
|
1286
|
+
/**
|
|
1287
|
+
* Get Job Log Exception Stacktrace
|
|
1288
|
+
*
|
|
1289
|
+
* Retrieves the corresponding exception stacktrace to the passed historic job log by
|
|
1290
|
+
* id.
|
|
1291
|
+
*/
|
|
1292
|
+
export declare const getStacktraceHistoricJobLog: <ThrowOnError extends boolean = true>(options: Options<GetStacktraceHistoricJobLogData, ThrowOnError>) => RequestResult<GetStacktraceHistoricJobLogResponses, GetStacktraceHistoricJobLogErrors, ThrowOnError, "data">;
|
|
1293
|
+
/**
|
|
1294
|
+
* Get Cleanable Process Instance Report
|
|
1295
|
+
*
|
|
1296
|
+
* Retrieves a report about a process definition and finished process instances
|
|
1297
|
+
* relevant to history cleanup (see
|
|
1298
|
+
* [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup))
|
|
1299
|
+
* so that you can tune the history time to live.
|
|
1300
|
+
* These reports include the count of the finished historic process
|
|
1301
|
+
* instances, cleanable process instances and basic process definition
|
|
1302
|
+
* data - id, key, name and version.
|
|
1303
|
+
* The size of the result set can be retrieved by using the
|
|
1304
|
+
* [Get Cleanable Process Instance Report Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/process-definition/get-cleanable-process-instance-report-count/)
|
|
1305
|
+
* method.
|
|
1306
|
+
*/
|
|
1307
|
+
export declare const getCleanableHistoricProcessInstanceReport: <ThrowOnError extends boolean = true>(options?: Options<GetCleanableHistoricProcessInstanceReportData, ThrowOnError>) => RequestResult<GetCleanableHistoricProcessInstanceReportResponses, GetCleanableHistoricProcessInstanceReportErrors, ThrowOnError, "data">;
|
|
1308
|
+
/**
|
|
1309
|
+
* Get Cleanable Process Instance Report Count
|
|
1310
|
+
*
|
|
1311
|
+
* Queries for the number of report results about a process definition and finished
|
|
1312
|
+
* process instances relevant to history cleanup (see
|
|
1313
|
+
* [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup)).
|
|
1314
|
+
* Takes the same parameters as the
|
|
1315
|
+
* [Get Cleanable Process Instance Report](https://docs.cibseven.org/manual/2.1/reference/rest/history/process-definition/get-cleanable-process-instance-report/)
|
|
1316
|
+
* method.
|
|
1317
|
+
*/
|
|
1318
|
+
export declare const getCleanableHistoricProcessInstanceReportCount: <ThrowOnError extends boolean = true>(options?: Options<GetCleanableHistoricProcessInstanceReportCountData, ThrowOnError>) => RequestResult<GetCleanableHistoricProcessInstanceReportCountResponses, GetCleanableHistoricProcessInstanceReportCountErrors, ThrowOnError, "data">;
|
|
1319
|
+
/**
|
|
1320
|
+
* Get Historic Activity Statistics
|
|
1321
|
+
*
|
|
1322
|
+
* Retrieves historic statistics of a given process definition, grouped by activities.
|
|
1323
|
+
* These statistics include the number of running activity instances and,
|
|
1324
|
+
* optionally, the number of canceled activity instances, finished
|
|
1325
|
+
* activity instances and activity instances which completed a scope
|
|
1326
|
+
* (i.e., in BPMN 2.0 manner: a scope is completed by an activity
|
|
1327
|
+
* instance when the activity instance consumed a token but did not emit
|
|
1328
|
+
* a new token).
|
|
1329
|
+
* **Note:** This only includes historic data.
|
|
1330
|
+
*/
|
|
1331
|
+
export declare const getHistoricActivityStatistics: <ThrowOnError extends boolean = true>(options: Options<GetHistoricActivityStatisticsData, ThrowOnError>) => RequestResult<GetHistoricActivityStatisticsResponses, GetHistoricActivityStatisticsErrors, ThrowOnError, "data">;
|
|
1332
|
+
/**
|
|
1333
|
+
* Get List
|
|
1334
|
+
*
|
|
1335
|
+
* Queries for historic process instances that fulfill the given parameters.
|
|
1336
|
+
* The size of the result set can be retrieved by using the
|
|
1337
|
+
* [Get Process Instance Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/process-instance/get-process-instance-query-count/) method.
|
|
1338
|
+
*/
|
|
1339
|
+
export declare const getHistoricProcessInstances: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricProcessInstancesData, ThrowOnError>) => RequestResult<GetHistoricProcessInstancesResponses, GetHistoricProcessInstancesErrors, ThrowOnError, "data">;
|
|
1340
|
+
/**
|
|
1341
|
+
* Get List (POST)
|
|
1342
|
+
*
|
|
1343
|
+
* Queries for historic process instances that fulfill the given parameters.
|
|
1344
|
+
* This method is slightly more powerful than the
|
|
1345
|
+
* [Get Process Instance](https://docs.cibseven.org/manual/2.1/reference/rest/history/process-instance/get-process-instance-query/)
|
|
1346
|
+
* because it allows filtering by multiple process variables of types `String`, `Number` or `Boolean`.
|
|
1347
|
+
*/
|
|
1348
|
+
export declare const queryHistoricProcessInstances: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricProcessInstancesData, ThrowOnError>) => RequestResult<QueryHistoricProcessInstancesResponses, QueryHistoricProcessInstancesErrors, ThrowOnError, "data">;
|
|
1349
|
+
/**
|
|
1350
|
+
* Get List Count
|
|
1351
|
+
*
|
|
1352
|
+
* Queries for the number of historic process instances that fulfill the given parameters.
|
|
1353
|
+
* Takes the same parameters as the [Get Process Instances](https://docs.cibseven.org/manual/2.1/reference/rest/history/process-instance/get-process-instance-query/) method.
|
|
1354
|
+
*/
|
|
1355
|
+
export declare const getHistoricProcessInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricProcessInstancesCountData, ThrowOnError>) => RequestResult<GetHistoricProcessInstancesCountResponses, GetHistoricProcessInstancesCountErrors, ThrowOnError, "data">;
|
|
1356
|
+
/**
|
|
1357
|
+
* Get List Count (POST)
|
|
1358
|
+
*
|
|
1359
|
+
* Queries for the number of historic process instances that fulfill the given parameters.
|
|
1360
|
+
* This method takes the same message body as the [Get Process Instances (POST)](https://docs.cibseven.org/manual/2.1/reference/rest/history/process-instance/get-process-instance-query/) method and
|
|
1361
|
+
* therefore it is slightly more powerful than the [Get Process Instance Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/process-instance/post-process-instance-query-count/) method.
|
|
1362
|
+
*/
|
|
1363
|
+
export declare const queryHistoricProcessInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricProcessInstancesCountData, ThrowOnError>) => RequestResult<QueryHistoricProcessInstancesCountResponses, QueryHistoricProcessInstancesCountErrors, ThrowOnError, "data">;
|
|
1364
|
+
/**
|
|
1365
|
+
* Delete Async (POST)
|
|
1366
|
+
*
|
|
1367
|
+
* Delete multiple historic process instances asynchronously (batch).
|
|
1368
|
+
* At least `historicProcessInstanceIds` or `historicProcessInstanceQuery` has to be provided.
|
|
1369
|
+
* If both are provided then all instances matching query criterion and instances from the list will be deleted.
|
|
1370
|
+
*/
|
|
1371
|
+
export declare const deleteHistoricProcessInstancesAsync: <ThrowOnError extends boolean = true>(options?: Options<DeleteHistoricProcessInstancesAsyncData, ThrowOnError>) => RequestResult<DeleteHistoricProcessInstancesAsyncResponses, DeleteHistoricProcessInstancesAsyncErrors, ThrowOnError, "data">;
|
|
1372
|
+
/**
|
|
1373
|
+
* Get Duration Report
|
|
1374
|
+
*
|
|
1375
|
+
* Retrieves a report about the duration of completed process instances, grouped by a period.
|
|
1376
|
+
* These reports include the maximum, minimum and average duration of all completed process instances which were started in a given period.
|
|
1377
|
+
*
|
|
1378
|
+
* **Note:** This only includes historic data.
|
|
1379
|
+
*/
|
|
1380
|
+
export declare const getHistoricProcessInstanceDurationReport: <ThrowOnError extends boolean = true>(options: Options<GetHistoricProcessInstanceDurationReportData, ThrowOnError>) => RequestResult<GetHistoricProcessInstanceDurationReportResponses, GetHistoricProcessInstanceDurationReportErrors, ThrowOnError, "data">;
|
|
1381
|
+
/**
|
|
1382
|
+
* Set Removal Time Async (POST)
|
|
1383
|
+
*
|
|
1384
|
+
* Sets the removal time to multiple historic process instances asynchronously (batch).
|
|
1385
|
+
*
|
|
1386
|
+
* At least `historicProcessInstanceIds` or `historicProcessInstanceQuery` has to be provided.
|
|
1387
|
+
* If both are provided, all instances matching query criterion and instances from the list will be updated with a removal time.
|
|
1388
|
+
*/
|
|
1389
|
+
export declare const setRemovalTimeAsync: <ThrowOnError extends boolean = true>(options?: Options<SetRemovalTimeAsyncData, ThrowOnError>) => RequestResult<SetRemovalTimeAsyncResponses, SetRemovalTimeAsyncErrors, ThrowOnError, "data">;
|
|
1390
|
+
/**
|
|
1391
|
+
* Delete
|
|
1392
|
+
*
|
|
1393
|
+
* Deletes a process instance from the history by id.
|
|
1394
|
+
*/
|
|
1395
|
+
export declare const deleteHistoricProcessInstance: <ThrowOnError extends boolean = true>(options: Options<DeleteHistoricProcessInstanceData, ThrowOnError>) => RequestResult<DeleteHistoricProcessInstanceResponses, DeleteHistoricProcessInstanceErrors, ThrowOnError, "data">;
|
|
1396
|
+
/**
|
|
1397
|
+
* Get
|
|
1398
|
+
*
|
|
1399
|
+
* Retrieves a historic process instance by id, according to the `HistoricProcessInstance` interface in the engine.
|
|
1400
|
+
*/
|
|
1401
|
+
export declare const getHistoricProcessInstance: <ThrowOnError extends boolean = true>(options: Options<GetHistoricProcessInstanceData, ThrowOnError>) => RequestResult<GetHistoricProcessInstanceResponses, GetHistoricProcessInstanceErrors, ThrowOnError, "data">;
|
|
1402
|
+
/**
|
|
1403
|
+
* Delete Variable Instances
|
|
1404
|
+
*
|
|
1405
|
+
* Deletes all variables of a process instance from the history by id.
|
|
1406
|
+
*/
|
|
1407
|
+
export declare const deleteHistoricVariableInstancesOfHistoricProcessInstance: <ThrowOnError extends boolean = true>(options: Options<DeleteHistoricVariableInstancesOfHistoricProcessInstanceData, ThrowOnError>) => RequestResult<DeleteHistoricVariableInstancesOfHistoricProcessInstanceResponses, DeleteHistoricVariableInstancesOfHistoricProcessInstanceErrors, ThrowOnError, "data">;
|
|
1408
|
+
/**
|
|
1409
|
+
* Get Tasks (Historic)
|
|
1410
|
+
*
|
|
1411
|
+
* Queries for historic tasks that fulfill the given parameters. The size of the result
|
|
1412
|
+
* set can be retrieved by using the
|
|
1413
|
+
* [Get Task Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/task/get-task-query-count/)
|
|
1414
|
+
* method.
|
|
1415
|
+
*/
|
|
1416
|
+
export declare const getHistoricTaskInstances: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricTaskInstancesData, ThrowOnError>) => RequestResult<GetHistoricTaskInstancesResponses, GetHistoricTaskInstancesErrors, ThrowOnError, "data">;
|
|
1417
|
+
/**
|
|
1418
|
+
* Get Tasks (Historic) (POST)
|
|
1419
|
+
*
|
|
1420
|
+
* Queries for historic tasks that fulfill the given parameters. This method is slightly more powerful
|
|
1421
|
+
* than the [Get Tasks (Historic)](https://docs.cibseven.org/manual/2.1/reference/rest/history/task/get-task-query/) method because
|
|
1422
|
+
* it allows filtering by multiple process or task variables of types `String`, `Number` or `Boolean`.
|
|
1423
|
+
* The size of the result set can be retrieved by using the
|
|
1424
|
+
* [Get Task Count (POST)](https://docs.cibseven.org/manual/2.1/reference/rest/history/task/post-task-query-count/)
|
|
1425
|
+
* method.
|
|
1426
|
+
*/
|
|
1427
|
+
export declare const queryHistoricTaskInstances: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricTaskInstancesData, ThrowOnError>) => RequestResult<QueryHistoricTaskInstancesResponses, QueryHistoricTaskInstancesErrors, ThrowOnError, "data">;
|
|
1428
|
+
/**
|
|
1429
|
+
* Get Task Count
|
|
1430
|
+
*
|
|
1431
|
+
* Queries for the number of historic tasks that fulfill the given parameters.
|
|
1432
|
+
* Takes the same parameters as the
|
|
1433
|
+
* [Get Tasks (Historic)](https://docs.cibseven.org/manual/2.1/reference/rest/history/task/get-task-query/)
|
|
1434
|
+
* method.
|
|
1435
|
+
*/
|
|
1436
|
+
export declare const getHistoricTaskInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricTaskInstancesCountData, ThrowOnError>) => RequestResult<GetHistoricTaskInstancesCountResponses, GetHistoricTaskInstancesCountErrors, ThrowOnError, "data">;
|
|
1437
|
+
/**
|
|
1438
|
+
* Get Task Count (POST)
|
|
1439
|
+
*
|
|
1440
|
+
* Queries for the number of historic tasks that fulfill the given parameters. Takes the
|
|
1441
|
+
* same parameters as the [Get Tasks (Historic)](https://docs.cibseven.org/manual/2.1/reference/rest/history/task/get-task-query/)
|
|
1442
|
+
* method. Corresponds to the size of the result set of the
|
|
1443
|
+
* [Get Tasks (Historic) (POST)](https://docs.cibseven.org/manual/2.1/reference/rest/history/task/post-task-query/)
|
|
1444
|
+
* method and takes the same parameters.
|
|
1445
|
+
*/
|
|
1446
|
+
export declare const queryHistoricTaskInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricTaskInstancesCountData, ThrowOnError>) => RequestResult<QueryHistoricTaskInstancesCountResponses, QueryHistoricTaskInstancesCountErrors, ThrowOnError, "data">;
|
|
1447
|
+
/**
|
|
1448
|
+
* Get Task Report (Historic)
|
|
1449
|
+
*
|
|
1450
|
+
* Retrieves a report of completed tasks. When the report type is set to `count`, the
|
|
1451
|
+
* report contains a list of completed task counts where an entry contains the task name, the
|
|
1452
|
+
* definition key of the task, the process definition id, the process definition key, the process
|
|
1453
|
+
* definition name and the count of how many tasks were completed for the specified key in a given
|
|
1454
|
+
* period. When the report type is set to `duration`, the report contains a minimum, maximum and
|
|
1455
|
+
* average duration value of all completed task instances in a given period.
|
|
1456
|
+
*/
|
|
1457
|
+
export declare const getHistoricTaskInstanceReport: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricTaskInstanceReportData, ThrowOnError>) => RequestResult<GetHistoricTaskInstanceReportResponses, GetHistoricTaskInstanceReportErrors, ThrowOnError, "data">;
|
|
1458
|
+
/**
|
|
1459
|
+
* Get User Operation Log (Historic)
|
|
1460
|
+
*
|
|
1461
|
+
* Queries for user operation log entries that fulfill the given parameters.
|
|
1462
|
+
* The size of the result set can be retrieved by using the
|
|
1463
|
+
* [Get User Operation Log Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/user-operation-log/get-user-operation-log-query-count/)
|
|
1464
|
+
* method.
|
|
1465
|
+
*
|
|
1466
|
+
* Note that the properties of operation log entries are interpreted as
|
|
1467
|
+
* restrictions on the entities they apply to. That means, if a single
|
|
1468
|
+
* process instance is updated, the field `processInstanceId` is
|
|
1469
|
+
* populated. If a single operation updates all process instances of the
|
|
1470
|
+
* same process definition, the field `processInstanceId` is `null` (a
|
|
1471
|
+
* `null` restriction is viewed as a wildcard, i.e., matches a process
|
|
1472
|
+
* instance with any id) and the field `processDefinitionId` is
|
|
1473
|
+
* populated. This way, which entities were changed by a user operation
|
|
1474
|
+
* can easily be reconstructed.
|
|
1475
|
+
*/
|
|
1476
|
+
export declare const queryUserOperationEntries: <ThrowOnError extends boolean = true>(options?: Options<QueryUserOperationEntriesData, ThrowOnError>) => RequestResult<QueryUserOperationEntriesResponses, QueryUserOperationEntriesErrors, ThrowOnError, "data">;
|
|
1477
|
+
/**
|
|
1478
|
+
* Get User Operation Log Count
|
|
1479
|
+
*
|
|
1480
|
+
* Queries for the number of user operation log entries that fulfill the given parameters.
|
|
1481
|
+
* Takes the same parameters as the
|
|
1482
|
+
* [Get User Operation Log (Historic)](https://docs.cibseven.org/manual/2.1/reference/rest/history/user-operation-log/get-user-operation-log-query/)
|
|
1483
|
+
* method.
|
|
1484
|
+
*/
|
|
1485
|
+
export declare const queryUserOperationCount: <ThrowOnError extends boolean = true>(options?: Options<QueryUserOperationCountData, ThrowOnError>) => RequestResult<QueryUserOperationCountResponses, QueryUserOperationCountErrors, ThrowOnError, "data">;
|
|
1486
|
+
/**
|
|
1487
|
+
* Clear Annotation of an User Operation Log (Historic)
|
|
1488
|
+
*
|
|
1489
|
+
* Clear the annotation which was previously set for auditing reasons.
|
|
1490
|
+
*/
|
|
1491
|
+
export declare const clearAnnotationUserOperationLog: <ThrowOnError extends boolean = true>(options: Options<ClearAnnotationUserOperationLogData, ThrowOnError>) => RequestResult<ClearAnnotationUserOperationLogResponses, ClearAnnotationUserOperationLogErrors, ThrowOnError, "data">;
|
|
1492
|
+
/**
|
|
1493
|
+
* Set Annotation to an User Operation Log (Historic)
|
|
1494
|
+
*
|
|
1495
|
+
* Set an annotation for auditing reasons.
|
|
1496
|
+
*/
|
|
1497
|
+
export declare const setAnnotationUserOperationLog: <ThrowOnError extends boolean = true>(options: Options<SetAnnotationUserOperationLogData, ThrowOnError>) => RequestResult<SetAnnotationUserOperationLogResponses, SetAnnotationUserOperationLogErrors, ThrowOnError, "data">;
|
|
1498
|
+
/**
|
|
1499
|
+
* Get Variable Instances
|
|
1500
|
+
*
|
|
1501
|
+
* Queries for historic variable instances that fulfill the given parameters.
|
|
1502
|
+
* The size of the result set can be retrieved by using the
|
|
1503
|
+
* [Get Variable Instance Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/variable-instance/get-variable-instance-query-count/)
|
|
1504
|
+
* method.
|
|
1505
|
+
*/
|
|
1506
|
+
export declare const getHistoricVariableInstances: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricVariableInstancesData, ThrowOnError>) => RequestResult<GetHistoricVariableInstancesResponses, GetHistoricVariableInstancesErrors, ThrowOnError, "data">;
|
|
1507
|
+
/**
|
|
1508
|
+
* Get Variable Instances (POST)
|
|
1509
|
+
*
|
|
1510
|
+
* Queries for historic variable instances that fulfill the given parameters.
|
|
1511
|
+
* This method is slightly more powerful than the
|
|
1512
|
+
* [Get Variable Instances](https://docs.cibseven.org/manual/2.1/reference/rest/history/variable-instance/get-variable-instance-query/)
|
|
1513
|
+
* method because it allows filtering by variable values of the different
|
|
1514
|
+
* types `String`, `Number` or `Boolean`.
|
|
1515
|
+
*/
|
|
1516
|
+
export declare const queryHistoricVariableInstances: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricVariableInstancesData, ThrowOnError>) => RequestResult<QueryHistoricVariableInstancesResponses, QueryHistoricVariableInstancesErrors, ThrowOnError, "data">;
|
|
1517
|
+
/**
|
|
1518
|
+
* Get Variable Instance Count
|
|
1519
|
+
*
|
|
1520
|
+
* Queries for the number of historic variable instances that fulfill the given
|
|
1521
|
+
* parameters.
|
|
1522
|
+
* Takes the same parameters as the
|
|
1523
|
+
* [Get Variable Instances](https://docs.cibseven.org/manual/2.1/reference/rest/history/variable-instance/get-variable-instance-query/)
|
|
1524
|
+
* method.
|
|
1525
|
+
*/
|
|
1526
|
+
export declare const getHistoricVariableInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<GetHistoricVariableInstancesCountData, ThrowOnError>) => RequestResult<GetHistoricVariableInstancesCountResponses, GetHistoricVariableInstancesCountErrors, ThrowOnError, "data">;
|
|
1527
|
+
/**
|
|
1528
|
+
* Get Variable Instance Count (POST)
|
|
1529
|
+
*
|
|
1530
|
+
* Queries for historic variable instances that fulfill the given parameters.
|
|
1531
|
+
* This method takes the same message body as the
|
|
1532
|
+
* [Get Variable Instances (POST)](https://docs.cibseven.org/manual/2.1/reference/rest/history/variable-instance/post-variable-instance-query/)
|
|
1533
|
+
* method and therefore it is more powerful regarding variable values
|
|
1534
|
+
* than the
|
|
1535
|
+
* [Get Variable Instance Count](https://docs.cibseven.org/manual/2.1/reference/rest/history/variable-instance/get-variable-instance-query-count/)
|
|
1536
|
+
* method.
|
|
1537
|
+
*/
|
|
1538
|
+
export declare const queryHistoricVariableInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<QueryHistoricVariableInstancesCountData, ThrowOnError>) => RequestResult<QueryHistoricVariableInstancesCountResponses, QueryHistoricVariableInstancesCountErrors, ThrowOnError, "data">;
|
|
1539
|
+
/**
|
|
1540
|
+
* Delete Variable Instance
|
|
1541
|
+
*
|
|
1542
|
+
* Deletes a historic variable instance by id.
|
|
1543
|
+
*/
|
|
1544
|
+
export declare const deleteHistoricVariableInstance: <ThrowOnError extends boolean = true>(options: Options<DeleteHistoricVariableInstanceData, ThrowOnError>) => RequestResult<DeleteHistoricVariableInstanceResponses, DeleteHistoricVariableInstanceErrors, ThrowOnError, "data">;
|
|
1545
|
+
/**
|
|
1546
|
+
* Get Variable Instance
|
|
1547
|
+
*
|
|
1548
|
+
* Retrieves a historic variable by id.
|
|
1549
|
+
*/
|
|
1550
|
+
export declare const getHistoricVariableInstance: <ThrowOnError extends boolean = true>(options: Options<GetHistoricVariableInstanceData, ThrowOnError>) => RequestResult<GetHistoricVariableInstanceResponses, GetHistoricVariableInstanceErrors, ThrowOnError, "data">;
|
|
1551
|
+
/**
|
|
1552
|
+
* Get Variable Instance (Binary)
|
|
1553
|
+
*
|
|
1554
|
+
* Retrieves the content of a historic variable by id. Applicable for variables that
|
|
1555
|
+
* are serialized as binary data.
|
|
1556
|
+
*/
|
|
1557
|
+
export declare const getHistoricVariableInstanceBinary: <ThrowOnError extends boolean = true>(options: Options<GetHistoricVariableInstanceBinaryData, ThrowOnError>) => RequestResult<GetHistoricVariableInstanceBinaryResponses, GetHistoricVariableInstanceBinaryErrors, ThrowOnError, "data">;
|
|
1558
|
+
/**
|
|
1559
|
+
* Get a User's Groups
|
|
1560
|
+
*
|
|
1561
|
+
* Gets the groups of a user by id and includes all users that share a group with the
|
|
1562
|
+
* given user.
|
|
1563
|
+
*/
|
|
1564
|
+
export declare const getGroupInfo: <ThrowOnError extends boolean = true>(options: Options<GetGroupInfoData, ThrowOnError>) => RequestResult<GetGroupInfoResponses, GetGroupInfoErrors, ThrowOnError, "data">;
|
|
1565
|
+
/**
|
|
1566
|
+
* Get Password Policy
|
|
1567
|
+
*
|
|
1568
|
+
* A password policy consists of a list of rules that new passwords must follow to be
|
|
1569
|
+
* policy compliant. This end point returns a JSON representation of the
|
|
1570
|
+
* list of policy rules. More information on password policies in Camunda can be found in the password policy
|
|
1571
|
+
* [user guide](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/password-policy/) and in
|
|
1572
|
+
* the [security instructions](https://docs.cibseven.org/manual/2.1/user-guide/security/).
|
|
1573
|
+
*/
|
|
1574
|
+
export declare const getPasswordPolicy: <ThrowOnError extends boolean = true>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => RequestResult<GetPasswordPolicyResponses, GetPasswordPolicyErrors, ThrowOnError, "data">;
|
|
1575
|
+
/**
|
|
1576
|
+
* Validate Password
|
|
1577
|
+
*
|
|
1578
|
+
* A password policy consists of a list of rules that new passwords must follow to be
|
|
1579
|
+
* policy compliant. A password can be checked for compliancy via this
|
|
1580
|
+
* end point. More information on password policies in Camunda can be found in the password policy
|
|
1581
|
+
* [user guide](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/password-policy/) and in
|
|
1582
|
+
* the [security instructions](https://docs.cibseven.org/manual/2.1/user-guide/security/).
|
|
1583
|
+
*/
|
|
1584
|
+
export declare const checkPassword: <ThrowOnError extends boolean = true>(options?: Options<CheckPasswordData, ThrowOnError>) => RequestResult<CheckPasswordResponses, CheckPasswordErrors, ThrowOnError, "data">;
|
|
1585
|
+
/**
|
|
1586
|
+
* Verify User
|
|
1587
|
+
*
|
|
1588
|
+
* Verifies that user credentials are valid.
|
|
1589
|
+
*/
|
|
1590
|
+
export declare const verifyUser: <ThrowOnError extends boolean = true>(options?: Options<VerifyUserData, ThrowOnError>) => RequestResult<VerifyUserResponses, VerifyUserErrors, ThrowOnError, "data">;
|
|
1591
|
+
/**
|
|
1592
|
+
* Get List
|
|
1593
|
+
*
|
|
1594
|
+
* Queries for incidents that fulfill given parameters. The size of the result set can be retrieved by using
|
|
1595
|
+
* the [Get Incident Count](https://docs.cibseven.org/manual/2.1/reference/rest/incident/get-query-count/) method.
|
|
1596
|
+
*/
|
|
1597
|
+
export declare const getIncidents: <ThrowOnError extends boolean = true>(options?: Options<GetIncidentsData, ThrowOnError>) => RequestResult<GetIncidentsResponses, GetIncidentsErrors, ThrowOnError, "data">;
|
|
1598
|
+
/**
|
|
1599
|
+
* Get List Count
|
|
1600
|
+
*
|
|
1601
|
+
* Queries for the number of incidents that fulfill given parameters. Takes the same parameters as the
|
|
1602
|
+
* [Get Incidents](https://docs.cibseven.org/manual/2.1/reference/rest/incident/get-query/) method.
|
|
1603
|
+
*/
|
|
1604
|
+
export declare const getIncidentsCount: <ThrowOnError extends boolean = true>(options?: Options<GetIncidentsCountData, ThrowOnError>) => RequestResult<GetIncidentsCountResponses, GetIncidentsCountErrors, ThrowOnError, "data">;
|
|
1605
|
+
/**
|
|
1606
|
+
* Resolve Incident
|
|
1607
|
+
*
|
|
1608
|
+
* Resolves an incident with given id.
|
|
1609
|
+
*/
|
|
1610
|
+
export declare const resolveIncident: <ThrowOnError extends boolean = true>(options: Options<ResolveIncidentData, ThrowOnError>) => RequestResult<ResolveIncidentResponses, ResolveIncidentErrors, ThrowOnError, "data">;
|
|
1611
|
+
/**
|
|
1612
|
+
* Get Incident
|
|
1613
|
+
*
|
|
1614
|
+
* Retrieves an incident by ID.
|
|
1615
|
+
*/
|
|
1616
|
+
export declare const getIncident: <ThrowOnError extends boolean = true>(options: Options<GetIncidentData, ThrowOnError>) => RequestResult<GetIncidentResponses, GetIncidentErrors, ThrowOnError, "data">;
|
|
1617
|
+
/**
|
|
1618
|
+
* Clear Incident Annotation
|
|
1619
|
+
*
|
|
1620
|
+
* Clears the annotation of an incident with given id.
|
|
1621
|
+
*/
|
|
1622
|
+
export declare const clearIncidentAnnotation: <ThrowOnError extends boolean = true>(options: Options<ClearIncidentAnnotationData, ThrowOnError>) => RequestResult<ClearIncidentAnnotationResponses, ClearIncidentAnnotationErrors, ThrowOnError, "data">;
|
|
1623
|
+
/**
|
|
1624
|
+
* Set Incident Annotation
|
|
1625
|
+
*
|
|
1626
|
+
* Sets the annotation of an incident with given id.
|
|
1627
|
+
*/
|
|
1628
|
+
export declare const setIncidentAnnotation: <ThrowOnError extends boolean = true>(options: Options<SetIncidentAnnotationData, ThrowOnError>) => RequestResult<SetIncidentAnnotationResponses, SetIncidentAnnotationErrors, ThrowOnError, "data">;
|
|
1629
|
+
/**
|
|
1630
|
+
* Get Jobs
|
|
1631
|
+
*
|
|
1632
|
+
* Queries for jobs that fulfill given parameters.
|
|
1633
|
+
* The size of the result set can be retrieved by using the [Get Job
|
|
1634
|
+
* Count](https://docs.cibseven.org/manual/2.1/reference/rest/job/get-query-count/) method.
|
|
1635
|
+
*/
|
|
1636
|
+
export declare const getJobs: <ThrowOnError extends boolean = true>(options?: Options<GetJobsData, ThrowOnError>) => RequestResult<GetJobsResponses, GetJobsErrors, ThrowOnError, "data">;
|
|
1637
|
+
/**
|
|
1638
|
+
* Get Jobs (POST)
|
|
1639
|
+
*
|
|
1640
|
+
* Queries for jobs that fulfill given parameters. This method is slightly more
|
|
1641
|
+
* powerful than the [Get Jobs](https://docs.cibseven.org/manual/2.1/reference/rest/job/get-query/)
|
|
1642
|
+
* method because it allows filtering by multiple jobs of types `String`,
|
|
1643
|
+
* `Number` or `Boolean`.
|
|
1644
|
+
*/
|
|
1645
|
+
export declare const queryJobs: <ThrowOnError extends boolean = true>(options?: Options<QueryJobsData, ThrowOnError>) => RequestResult<QueryJobsResponses, QueryJobsErrors, ThrowOnError, "data">;
|
|
1646
|
+
/**
|
|
1647
|
+
* Get Job Definitions
|
|
1648
|
+
*
|
|
1649
|
+
* Queries for job definitions that fulfill given parameters.
|
|
1650
|
+
* The size of the result set can be retrieved by using the
|
|
1651
|
+
* [Get Job Definition Count](https://docs.cibseven.org/manual/2.1/reference/rest/job-definition/get-query-count/)
|
|
1652
|
+
* method.
|
|
1653
|
+
*/
|
|
1654
|
+
export declare const getJobDefinitions: <ThrowOnError extends boolean = true>(options?: Options<GetJobDefinitionsData, ThrowOnError>) => RequestResult<GetJobDefinitionsResponses, GetJobDefinitionsErrors, ThrowOnError, "data">;
|
|
1655
|
+
/**
|
|
1656
|
+
* Get Job Definitions (POST)
|
|
1657
|
+
*
|
|
1658
|
+
* Queries for job definitions that fulfill given parameters. This method is slightly
|
|
1659
|
+
* more powerful than the
|
|
1660
|
+
* [Get Job Definitions](https://docs.cibseven.org/manual/2.1/reference/rest/job-definition/get-query/)
|
|
1661
|
+
* method because it allows filtering by multiple job definitions of
|
|
1662
|
+
* types `String`, `Number` or `Boolean`.
|
|
1663
|
+
*/
|
|
1664
|
+
export declare const queryJobDefinitions: <ThrowOnError extends boolean = true>(options?: Options<QueryJobDefinitionsData, ThrowOnError>) => RequestResult<QueryJobDefinitionsResponses, QueryJobDefinitionsErrors, ThrowOnError, "data">;
|
|
1665
|
+
/**
|
|
1666
|
+
* Get Job Definition Count
|
|
1667
|
+
*
|
|
1668
|
+
* Queries for the number of job definitions that fulfill given parameters.
|
|
1669
|
+
* Takes the same parameters as the
|
|
1670
|
+
* [Get Job Definitions](https://docs.cibseven.org/manual/2.1/reference/rest/job-definition/get-query/)
|
|
1671
|
+
* method.
|
|
1672
|
+
*/
|
|
1673
|
+
export declare const getJobDefinitionsCount: <ThrowOnError extends boolean = true>(options?: Options<GetJobDefinitionsCountData, ThrowOnError>) => RequestResult<GetJobDefinitionsCountResponses, GetJobDefinitionsCountErrors, ThrowOnError, "data">;
|
|
1674
|
+
/**
|
|
1675
|
+
* Get Job Definition Count (POST)
|
|
1676
|
+
*
|
|
1677
|
+
* Queries for the number of job definitions that fulfill given parameters. This
|
|
1678
|
+
* method takes the same message body as the
|
|
1679
|
+
* [Get Job Definitions (POST)](https://docs.cibseven.org/manual/2.1/reference/rest/job-definition/post-query/)
|
|
1680
|
+
* method and therefore it is slightly more powerful than the
|
|
1681
|
+
* [Get Job Definition Count](https://docs.cibseven.org/manual/2.1/reference/rest/job-definition/get-query-count/)
|
|
1682
|
+
* method.
|
|
1683
|
+
*/
|
|
1684
|
+
export declare const queryJobDefinitionsCount: <ThrowOnError extends boolean = true>(options?: Options<QueryJobDefinitionsCountData, ThrowOnError>) => RequestResult<QueryJobDefinitionsCountResponses, QueryJobDefinitionsCountErrors, ThrowOnError, "data">;
|
|
1685
|
+
/**
|
|
1686
|
+
* Activate/Suspend Job Definitions
|
|
1687
|
+
*
|
|
1688
|
+
* Activates or suspends job definitions with the given process definition id or process definition key.
|
|
1689
|
+
*/
|
|
1690
|
+
export declare const updateSuspensionStateJobDefinitions: <ThrowOnError extends boolean = true>(options?: Options<UpdateSuspensionStateJobDefinitionsData, ThrowOnError>) => RequestResult<UpdateSuspensionStateJobDefinitionsResponses, UpdateSuspensionStateJobDefinitionsErrors, ThrowOnError, "data">;
|
|
1691
|
+
/**
|
|
1692
|
+
* Get Job Definition
|
|
1693
|
+
*
|
|
1694
|
+
* Retrieves a job definition by id, according to the `JobDefinition` interface in the engine.
|
|
1695
|
+
*/
|
|
1696
|
+
export declare const getJobDefinition: <ThrowOnError extends boolean = true>(options: Options<GetJobDefinitionData, ThrowOnError>) => RequestResult<GetJobDefinitionResponses, GetJobDefinitionErrors, ThrowOnError, "data">;
|
|
1697
|
+
/**
|
|
1698
|
+
* Set Job Definition Priority by Id
|
|
1699
|
+
*
|
|
1700
|
+
* Sets an overriding execution priority for jobs with the given definition id.
|
|
1701
|
+
* Optionally, the priorities of all the definitions' existing jobs are
|
|
1702
|
+
* updated accordingly. The priority can be reset by setting it to
|
|
1703
|
+
* `null`, meaning that a new job's priority will not be determined based
|
|
1704
|
+
* on its definition's priority any longer. See the
|
|
1705
|
+
* [user guide on job prioritization](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/the-job-executor/#set-job-definition-priorities-via-managementservice-api)
|
|
1706
|
+
* for details.
|
|
1707
|
+
*/
|
|
1708
|
+
export declare const setJobPriorityJobDefinition: <ThrowOnError extends boolean = true>(options: Options<SetJobPriorityJobDefinitionData, ThrowOnError>) => RequestResult<SetJobPriorityJobDefinitionResponses, SetJobPriorityJobDefinitionErrors, ThrowOnError, "data">;
|
|
1709
|
+
/**
|
|
1710
|
+
* Set Job Retries By Job Definition Id
|
|
1711
|
+
*
|
|
1712
|
+
* Sets the number of retries of all **failed** jobs associated with the given job
|
|
1713
|
+
* definition id.
|
|
1714
|
+
*/
|
|
1715
|
+
export declare const setJobRetriesJobDefinition: <ThrowOnError extends boolean = true>(options: Options<SetJobRetriesJobDefinitionData, ThrowOnError>) => RequestResult<SetJobRetriesJobDefinitionResponses, SetJobRetriesJobDefinitionErrors, ThrowOnError, "data">;
|
|
1716
|
+
/**
|
|
1717
|
+
* Activate/Suspend Job Definition By Id
|
|
1718
|
+
*
|
|
1719
|
+
* Activates or suspends a given job definition by id.
|
|
1720
|
+
*/
|
|
1721
|
+
export declare const updateSuspensionStateJobDefinition: <ThrowOnError extends boolean = true>(options: Options<UpdateSuspensionStateJobDefinitionData, ThrowOnError>) => RequestResult<UpdateSuspensionStateJobDefinitionResponses, UpdateSuspensionStateJobDefinitionErrors, ThrowOnError, "data">;
|
|
1722
|
+
/**
|
|
1723
|
+
* Get Job Count
|
|
1724
|
+
*
|
|
1725
|
+
* Queries for the number of jobs that fulfill given parameters.
|
|
1726
|
+
* Takes the same parameters as the [Get
|
|
1727
|
+
* Jobs](https://docs.cibseven.org/manual/2.1/reference/rest/job/get-query/) method.
|
|
1728
|
+
*/
|
|
1729
|
+
export declare const getJobsCount: <ThrowOnError extends boolean = true>(options?: Options<GetJobsCountData, ThrowOnError>) => RequestResult<GetJobsCountResponses, GetJobsCountErrors, ThrowOnError, "data">;
|
|
1730
|
+
/**
|
|
1731
|
+
* Get Job Count (POST)
|
|
1732
|
+
*
|
|
1733
|
+
* Queries for jobs that fulfill given parameters. This method takes the same message
|
|
1734
|
+
* body as the [Get Jobs POST](https://docs.cibseven.org/manual/2.1/reference/rest/job/post-
|
|
1735
|
+
* query/) method and therefore it is slightly more powerful than the
|
|
1736
|
+
* [Get Job Count](https://docs.cibseven.org/manual/2.1/reference/rest/job/get-query-count/)
|
|
1737
|
+
* method.
|
|
1738
|
+
*/
|
|
1739
|
+
export declare const queryJobsCount: <ThrowOnError extends boolean = true>(options?: Options<QueryJobsCountData, ThrowOnError>) => RequestResult<QueryJobsCountResponses, QueryJobsCountErrors, ThrowOnError, "data">;
|
|
1740
|
+
/**
|
|
1741
|
+
* Set Job Retries Async (POST)
|
|
1742
|
+
*
|
|
1743
|
+
* Create a batch to set retries of jobs asynchronously.
|
|
1744
|
+
*/
|
|
1745
|
+
export declare const setJobRetriesAsyncOperation: <ThrowOnError extends boolean = true>(options?: Options<SetJobRetriesAsyncOperationData, ThrowOnError>) => RequestResult<SetJobRetriesAsyncOperationResponses, SetJobRetriesAsyncOperationErrors, ThrowOnError, "data">;
|
|
1746
|
+
/**
|
|
1747
|
+
* Activate/Suspend Jobs
|
|
1748
|
+
*
|
|
1749
|
+
* Activates or suspends jobs matching the given criterion.
|
|
1750
|
+
* This can only be on of:
|
|
1751
|
+
* * `jobDefinitionId`
|
|
1752
|
+
* * `processDefinitionId`
|
|
1753
|
+
* * `processInstanceId`
|
|
1754
|
+
* * `processDefinitionKey`
|
|
1755
|
+
*/
|
|
1756
|
+
export declare const updateSuspensionStateBy: <ThrowOnError extends boolean = true>(options?: Options<UpdateSuspensionStateByData, ThrowOnError>) => RequestResult<UpdateSuspensionStateByResponses, UpdateSuspensionStateByErrors, ThrowOnError, "data">;
|
|
1757
|
+
/**
|
|
1758
|
+
* Delete Job
|
|
1759
|
+
*
|
|
1760
|
+
* Deletes a job by id.
|
|
1761
|
+
*/
|
|
1762
|
+
export declare const deleteJob: <ThrowOnError extends boolean = true>(options: Options<DeleteJobData, ThrowOnError>) => RequestResult<DeleteJobResponses, DeleteJobErrors, ThrowOnError, "data">;
|
|
1763
|
+
/**
|
|
1764
|
+
* Get Job
|
|
1765
|
+
*
|
|
1766
|
+
* Retrieves a job by id, according to the `Job` interface in the engine.
|
|
1767
|
+
*/
|
|
1768
|
+
export declare const getJob: <ThrowOnError extends boolean = true>(options: Options<GetJobData, ThrowOnError>) => RequestResult<GetJobResponses, GetJobErrors, ThrowOnError, "data">;
|
|
1769
|
+
/**
|
|
1770
|
+
* Set Job Due Date
|
|
1771
|
+
*
|
|
1772
|
+
* Updates the due date of a job by id.
|
|
1773
|
+
*/
|
|
1774
|
+
export declare const setJobDuedate: <ThrowOnError extends boolean = true>(options: Options<SetJobDuedateData, ThrowOnError>) => RequestResult<SetJobDuedateResponses, SetJobDuedateErrors, ThrowOnError, "data">;
|
|
1775
|
+
/**
|
|
1776
|
+
* Recalculate Job Due Date
|
|
1777
|
+
*
|
|
1778
|
+
* Recalculates the due date of a job by id.
|
|
1779
|
+
*/
|
|
1780
|
+
export declare const recalculateDuedate: <ThrowOnError extends boolean = true>(options: Options<RecalculateDuedateData, ThrowOnError>) => RequestResult<RecalculateDuedateResponses, RecalculateDuedateErrors, ThrowOnError, "data">;
|
|
1781
|
+
/**
|
|
1782
|
+
* Execute Job
|
|
1783
|
+
*
|
|
1784
|
+
* Executes a job by id. **Note:** The execution of the job happens synchronously in
|
|
1785
|
+
* the same thread.
|
|
1786
|
+
*/
|
|
1787
|
+
export declare const executeJob: <ThrowOnError extends boolean = true>(options: Options<ExecuteJobData, ThrowOnError>) => RequestResult<ExecuteJobResponses, ExecuteJobErrors, ThrowOnError, "data">;
|
|
1788
|
+
/**
|
|
1789
|
+
* Set Job Priority
|
|
1790
|
+
*
|
|
1791
|
+
* Sets the execution priority of a job by id.
|
|
1792
|
+
*/
|
|
1793
|
+
export declare const setJobPriority: <ThrowOnError extends boolean = true>(options: Options<SetJobPriorityData, ThrowOnError>) => RequestResult<SetJobPriorityResponses, SetJobPriorityErrors, ThrowOnError, "data">;
|
|
1794
|
+
/**
|
|
1795
|
+
* Set Job Retries
|
|
1796
|
+
*
|
|
1797
|
+
* Sets the retries of the job to the given number of retries by id.
|
|
1798
|
+
*/
|
|
1799
|
+
export declare const setJobRetries: <ThrowOnError extends boolean = true>(options: Options<SetJobRetriesData, ThrowOnError>) => RequestResult<SetJobRetriesResponses, SetJobRetriesErrors, ThrowOnError, "data">;
|
|
1800
|
+
/**
|
|
1801
|
+
* Get Exception Stacktrace
|
|
1802
|
+
*
|
|
1803
|
+
* Retrieves the exception stacktrace corresponding to the passed job id.
|
|
1804
|
+
*/
|
|
1805
|
+
export declare const getStacktrace: <ThrowOnError extends boolean = true>(options: Options<GetStacktraceData, ThrowOnError>) => RequestResult<GetStacktraceResponses, GetStacktraceErrors, ThrowOnError, "data">;
|
|
1806
|
+
/**
|
|
1807
|
+
* Activate/Suspend Job By Id
|
|
1808
|
+
*
|
|
1809
|
+
* Activates or suspends a given job by id.
|
|
1810
|
+
*/
|
|
1811
|
+
export declare const updateJobSuspensionState: <ThrowOnError extends boolean = true>(options: Options<UpdateJobSuspensionStateData, ThrowOnError>) => RequestResult<UpdateJobSuspensionStateResponses, unknown, ThrowOnError, "data">;
|
|
1812
|
+
/**
|
|
1813
|
+
* Correlate
|
|
1814
|
+
*
|
|
1815
|
+
* Correlates a message to the process engine to either trigger a message start event or an intermediate message
|
|
1816
|
+
* catching event. Internally this maps to the engine's message correlation builder methods
|
|
1817
|
+
* `MessageCorrelationBuilder#correlateWithResult()` and `MessageCorrelationBuilder#correlateAllWithResult()`.
|
|
1818
|
+
* For more information about the correlation behavior, see the [Message Events](https://docs.cibseven.org/manual/2.1/bpmn20/events/message-events/)
|
|
1819
|
+
* section of the [BPMN 2.0 Implementation Reference](https://docs.cibseven.org/manual/2.1/reference/bpmn20/).
|
|
1820
|
+
*/
|
|
1821
|
+
export declare const deliverMessage: <ThrowOnError extends boolean = true>(options?: Options<DeliverMessageData, ThrowOnError>) => RequestResult<DeliverMessageResponses, DeliverMessageErrors, ThrowOnError, "data">;
|
|
1822
|
+
/**
|
|
1823
|
+
* Get Metrics in Interval
|
|
1824
|
+
*
|
|
1825
|
+
* Retrieves a list of metrics, aggregated for a given interval.
|
|
1826
|
+
*/
|
|
1827
|
+
export declare const interval: <ThrowOnError extends boolean = true>(options?: Options<IntervalData, ThrowOnError>) => RequestResult<IntervalResponses, IntervalErrors, ThrowOnError, "data">;
|
|
1828
|
+
/**
|
|
1829
|
+
* Delete Task Worker Metrics
|
|
1830
|
+
*
|
|
1831
|
+
* Deletes all task worker metrics prior to the given date or all if no date is provided.
|
|
1832
|
+
*/
|
|
1833
|
+
export declare const deleteTaskMetrics: <ThrowOnError extends boolean = true>(options?: Options<DeleteTaskMetricsData, ThrowOnError>) => RequestResult<DeleteTaskMetricsResponses, DeleteTaskMetricsErrors, ThrowOnError, "data">;
|
|
1834
|
+
/**
|
|
1835
|
+
* Get Sum
|
|
1836
|
+
*
|
|
1837
|
+
* Retrieves the `sum` (count) for a given metric.
|
|
1838
|
+
*/
|
|
1839
|
+
export declare const getMetrics: <ThrowOnError extends boolean = true>(options: Options<GetMetricsData, ThrowOnError>) => RequestResult<GetMetricsResponses, unknown, ThrowOnError, "data">;
|
|
1840
|
+
/**
|
|
1841
|
+
* Execute Migration Plan
|
|
1842
|
+
*
|
|
1843
|
+
* Executes a migration plan synchronously for multiple process instances. To execute
|
|
1844
|
+
* a migration plan asynchronously, use the
|
|
1845
|
+
* [Execute Migration Plan Async(Batch)](https://docs.cibseven.org/manual/2.1/reference/rest/migration/execute-migration-async/)
|
|
1846
|
+
* method.
|
|
1847
|
+
*
|
|
1848
|
+
* For more information about the difference between synchronous and asynchronous
|
|
1849
|
+
* execution of a migration plan, please refer to the related section of
|
|
1850
|
+
* [the user guide](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
|
|
1851
|
+
*/
|
|
1852
|
+
export declare const executeMigrationPlan: <ThrowOnError extends boolean = true>(options?: Options<ExecuteMigrationPlanData, ThrowOnError>) => RequestResult<ExecuteMigrationPlanResponses, ExecuteMigrationPlanErrors, ThrowOnError, "data">;
|
|
1853
|
+
/**
|
|
1854
|
+
* Execute Migration Plan Async (Batch)
|
|
1855
|
+
*
|
|
1856
|
+
* Executes a migration plan asynchronously (batch) for multiple process instances.
|
|
1857
|
+
* To execute a migration plan synchronously, use the
|
|
1858
|
+
* [Execute MigrationPlan](https://docs.cibseven.org/manual/2.1/reference/rest/migration/execute-migration/)
|
|
1859
|
+
* method.
|
|
1860
|
+
*
|
|
1861
|
+
* For more information about the difference between synchronous and asynchronous
|
|
1862
|
+
* execution of a migration plan, please refer to the related section of
|
|
1863
|
+
* [the user guide](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
|
|
1864
|
+
*/
|
|
1865
|
+
export declare const executeMigrationPlanAsync: <ThrowOnError extends boolean = true>(options?: Options<ExecuteMigrationPlanAsyncData, ThrowOnError>) => RequestResult<ExecuteMigrationPlanAsyncResponses, ExecuteMigrationPlanAsyncErrors, ThrowOnError, "data">;
|
|
1866
|
+
/**
|
|
1867
|
+
* Generate Migration Plan
|
|
1868
|
+
*
|
|
1869
|
+
* Generates a migration plan for two process definitions. The generated migration
|
|
1870
|
+
* plan contains migration instructions which map equal activities
|
|
1871
|
+
* between the
|
|
1872
|
+
* two process definitions.
|
|
1873
|
+
*/
|
|
1874
|
+
export declare const generateMigrationPlan: <ThrowOnError extends boolean = true>(options?: Options<GenerateMigrationPlanData, ThrowOnError>) => RequestResult<GenerateMigrationPlanResponses, GenerateMigrationPlanErrors, ThrowOnError, "data">;
|
|
1875
|
+
/**
|
|
1876
|
+
* Validate Migration Plan
|
|
1877
|
+
*
|
|
1878
|
+
* Validates a migration plan statically without executing it. This
|
|
1879
|
+
* corresponds to the
|
|
1880
|
+
* [creation time validation](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/process-instance-migration/#creation-time-validation)
|
|
1881
|
+
* described in the user guide.
|
|
1882
|
+
*/
|
|
1883
|
+
export declare const validateMigrationPlan: <ThrowOnError extends boolean = true>(options?: Options<ValidateMigrationPlanData, ThrowOnError>) => RequestResult<ValidateMigrationPlanResponses, ValidateMigrationPlanErrors, ThrowOnError, "data">;
|
|
1884
|
+
/**
|
|
1885
|
+
* Execute Modification
|
|
1886
|
+
*
|
|
1887
|
+
* Executes a modification synchronously for multiple process instances.
|
|
1888
|
+
* To modify a single process instance, use the
|
|
1889
|
+
* [Modify Process Instance Execution State](https://docs.cibseven.org/manual/2.1/reference/rest/process-instance/post-modification/) method.
|
|
1890
|
+
* To execute a modification asynchronously, use the
|
|
1891
|
+
* [Execute Modification Async (Batch)](https://docs.cibseven.org/manual/2.1/reference/rest/modification/post-modification-async/) method.
|
|
1892
|
+
*
|
|
1893
|
+
* For more information about the difference between synchronous and
|
|
1894
|
+
* asynchronous execution of a modification, please refer to the related
|
|
1895
|
+
* section of the
|
|
1896
|
+
* [user guide](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
|
|
1897
|
+
*/
|
|
1898
|
+
export declare const executeModification: <ThrowOnError extends boolean = true>(options?: Options<ExecuteModificationData, ThrowOnError>) => RequestResult<ExecuteModificationResponses, ExecuteModificationErrors, ThrowOnError, "data">;
|
|
1899
|
+
/**
|
|
1900
|
+
* Execute Modification Async (Batch)
|
|
1901
|
+
*
|
|
1902
|
+
* Executes a modification asynchronously for multiple process instances. To execute a
|
|
1903
|
+
* modification synchronously, use the
|
|
1904
|
+
* [Execute Modification](https://docs.cibseven.org/manual/2.1/reference/rest/modification/post-modification-sync/) method.
|
|
1905
|
+
*
|
|
1906
|
+
* For more information about the difference between synchronous and
|
|
1907
|
+
* asynchronous execution of a modification, please refer to the related
|
|
1908
|
+
* section of the
|
|
1909
|
+
* [user guide](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
|
|
1910
|
+
*/
|
|
1911
|
+
export declare const executeModificationAsync: <ThrowOnError extends boolean = true>(options?: Options<ExecuteModificationAsyncData, ThrowOnError>) => RequestResult<ExecuteModificationAsyncResponses, ExecuteModificationAsyncErrors, ThrowOnError, "data">;
|
|
1912
|
+
/**
|
|
1913
|
+
* Get List
|
|
1914
|
+
*
|
|
1915
|
+
* Queries for process definitions that fulfill given parameters. Parameters may be the properties of
|
|
1916
|
+
* process definitions, such as the name, key or version. The size of the result set can be retrieved
|
|
1917
|
+
* by using the [Get Definition Count](https://docs.cibseven.org/manual/2.1/reference/rest/process-definition/get-query-count/) method.
|
|
1918
|
+
*/
|
|
1919
|
+
export declare const getProcessDefinitions: <ThrowOnError extends boolean = true>(options?: Options<GetProcessDefinitionsData, ThrowOnError>) => RequestResult<GetProcessDefinitionsResponses, GetProcessDefinitionsErrors, ThrowOnError, "data">;
|
|
1920
|
+
/**
|
|
1921
|
+
* Get List Count
|
|
1922
|
+
*
|
|
1923
|
+
* Requests the number of process definitions that fulfill the query criteria.
|
|
1924
|
+
* Takes the same filtering parameters as the [Get Definitions](https://docs.cibseven.org/manual/2.1/reference/rest/process-definition/get-query/) method.
|
|
1925
|
+
*/
|
|
1926
|
+
export declare const getProcessDefinitionsCount: <ThrowOnError extends boolean = true>(options?: Options<GetProcessDefinitionsCountData, ThrowOnError>) => RequestResult<GetProcessDefinitionsCountResponses, GetProcessDefinitionsCountErrors, ThrowOnError, "data">;
|
|
1927
|
+
/**
|
|
1928
|
+
* Delete By Key
|
|
1929
|
+
*
|
|
1930
|
+
* Deletes process definitions by a given key which belong to no tenant id.
|
|
1931
|
+
*/
|
|
1932
|
+
export declare const deleteProcessDefinitionsByKey: <ThrowOnError extends boolean = true>(options: Options<DeleteProcessDefinitionsByKeyData, ThrowOnError>) => RequestResult<DeleteProcessDefinitionsByKeyResponses, DeleteProcessDefinitionsByKeyErrors, ThrowOnError, "data">;
|
|
1933
|
+
/**
|
|
1934
|
+
* Get
|
|
1935
|
+
*
|
|
1936
|
+
* Retrieves the latest version of the process definition which belongs to no tenant according to the `ProcessDefinition` interface in the engine.
|
|
1937
|
+
*/
|
|
1938
|
+
export declare const getProcessDefinitionByKey: <ThrowOnError extends boolean = true>(options: Options<GetProcessDefinitionByKeyData, ThrowOnError>) => RequestResult<GetProcessDefinitionByKeyResponses, GetProcessDefinitionByKeyErrors, ThrowOnError, "data">;
|
|
1939
|
+
/**
|
|
1940
|
+
* Get Deployed Start Form
|
|
1941
|
+
*
|
|
1942
|
+
* Retrieves the deployed form that can be referenced from a start event.
|
|
1943
|
+
* For further information please refer to [User Guide](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#embedded-task-forms).
|
|
1944
|
+
*/
|
|
1945
|
+
export declare const getDeployedStartFormByKey: <ThrowOnError extends boolean = true>(options: Options<GetDeployedStartFormByKeyData, ThrowOnError>) => RequestResult<GetDeployedStartFormByKeyResponses, GetDeployedStartFormByKeyErrors, ThrowOnError, "data">;
|
|
1946
|
+
/**
|
|
1947
|
+
* Get Diagram
|
|
1948
|
+
*
|
|
1949
|
+
* Retrieves the diagram for the latest version of the process definition which belongs to no tenant.
|
|
1950
|
+
*
|
|
1951
|
+
* If the process definition's deployment contains an image resource with the same file name
|
|
1952
|
+
* as the process definition, the deployed image will be returned by the Get Diagram endpoint.
|
|
1953
|
+
* Example: `someProcess.bpmn` and `someProcess.png`.
|
|
1954
|
+
* Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.
|
|
1955
|
+
*/
|
|
1956
|
+
export declare const getProcessDefinitionDiagramByKey: <ThrowOnError extends boolean = true>(options: Options<GetProcessDefinitionDiagramByKeyData, ThrowOnError>) => RequestResult<GetProcessDefinitionDiagramByKeyResponses, GetProcessDefinitionDiagramByKeyErrors, ThrowOnError, "data">;
|
|
1957
|
+
/**
|
|
1958
|
+
* Get Start Form Variables
|
|
1959
|
+
*
|
|
1960
|
+
* Retrieves the start form variables for the latest process definition which belongs to no tenant
|
|
1961
|
+
* (only if they are defined via the
|
|
1962
|
+
* [Generated Task Form](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#generated-task-forms) approach).
|
|
1963
|
+
* The start form variables take form data specified on the start event into account.
|
|
1964
|
+
* If form fields are defined, the variable types and default values
|
|
1965
|
+
* of the form fields are taken into account.
|
|
1966
|
+
*/
|
|
1967
|
+
export declare const getStartFormVariablesByKey: <ThrowOnError extends boolean = true>(options: Options<GetStartFormVariablesByKeyData, ThrowOnError>) => RequestResult<GetStartFormVariablesByKeyResponses, GetStartFormVariablesByKeyErrors, ThrowOnError, "data">;
|
|
1968
|
+
/**
|
|
1969
|
+
* Update History Time to Live
|
|
1970
|
+
*
|
|
1971
|
+
* Updates history time to live for the latest version of the process definition which belongs to no tenant.
|
|
1972
|
+
* The field is used within [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup).
|
|
1973
|
+
* The value of the update is mandatory by default and does not allow `null` values. To enable them, please
|
|
1974
|
+
* set the feature flag `enforceHistoryTimeToLive` to `false`. Read more in [Configuration Properties]
|
|
1975
|
+
* (https://docs.cibseven.org/manual/2.1/reference/deployment-descriptors/tags/process-engine#configuration-properties)
|
|
1976
|
+
*/
|
|
1977
|
+
export declare const updateHistoryTimeToLiveByProcessDefinitionKey: <ThrowOnError extends boolean = true>(options: Options<UpdateHistoryTimeToLiveByProcessDefinitionKeyData, ThrowOnError>) => RequestResult<UpdateHistoryTimeToLiveByProcessDefinitionKeyResponses, UpdateHistoryTimeToLiveByProcessDefinitionKeyErrors, ThrowOnError, "data">;
|
|
1978
|
+
/**
|
|
1979
|
+
* Get Rendered Start Form
|
|
1980
|
+
*
|
|
1981
|
+
* Retrieves the rendered form for the latest version of the process definition which belongs to no tenant.
|
|
1982
|
+
* This method can be used to get the HTML rendering of a
|
|
1983
|
+
* [Generated Task Form](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#generated-task-forms).
|
|
1984
|
+
*/
|
|
1985
|
+
export declare const getRenderedStartFormByKey: <ThrowOnError extends boolean = true>(options: Options<GetRenderedStartFormByKeyData, ThrowOnError>) => RequestResult<GetRenderedStartFormByKeyResponses, GetRenderedStartFormByKeyErrors, ThrowOnError, "data">;
|
|
1986
|
+
/**
|
|
1987
|
+
* Start Instance
|
|
1988
|
+
*
|
|
1989
|
+
* Instantiates a given process definition, starts the latest version of the process definition
|
|
1990
|
+
* which belongs to no tenant.
|
|
1991
|
+
* Process variables and business key may be supplied in the request body.
|
|
1992
|
+
*/
|
|
1993
|
+
export declare const startProcessInstanceByKey: <ThrowOnError extends boolean = true>(options: Options<StartProcessInstanceByKeyData, ThrowOnError>) => RequestResult<StartProcessInstanceByKeyResponses, StartProcessInstanceByKeyErrors, ThrowOnError, "data">;
|
|
1994
|
+
/**
|
|
1995
|
+
* Get Start Form Key
|
|
1996
|
+
*
|
|
1997
|
+
* Retrieves the key of the start form for the latest version of the process definition
|
|
1998
|
+
* which belongs to no tenant.
|
|
1999
|
+
* The form key corresponds to the `FormData#formKey` property in the engine.
|
|
2000
|
+
*/
|
|
2001
|
+
export declare const getStartFormByKey: <ThrowOnError extends boolean = true>(options: Options<GetStartFormByKeyData, ThrowOnError>) => RequestResult<GetStartFormByKeyResponses, GetStartFormByKeyErrors, ThrowOnError, "data">;
|
|
2002
|
+
/**
|
|
2003
|
+
* Get Activity Instance Statistics
|
|
2004
|
+
*
|
|
2005
|
+
* Retrieves runtime statistics of the latest version of the given process definition
|
|
2006
|
+
* which belongs to no tenant, grouped by activities.
|
|
2007
|
+
* These statistics include the number of running activity instances, optionally the number of failed jobs
|
|
2008
|
+
* and also optionally the number of incidents either grouped by incident types or
|
|
2009
|
+
* for a specific incident type.
|
|
2010
|
+
* **Note**: This does not include historic data.
|
|
2011
|
+
*/
|
|
2012
|
+
export declare const getActivityStatisticsByProcessDefinitionKey: <ThrowOnError extends boolean = true>(options: Options<GetActivityStatisticsByProcessDefinitionKeyData, ThrowOnError>) => RequestResult<GetActivityStatisticsByProcessDefinitionKeyResponses, GetActivityStatisticsByProcessDefinitionKeyErrors, ThrowOnError, "data">;
|
|
2013
|
+
/**
|
|
2014
|
+
* Submit Start Form
|
|
2015
|
+
*
|
|
2016
|
+
* Starts the latest version of the process definition which belongs to no tenant
|
|
2017
|
+
* using a set of process variables and the business key.
|
|
2018
|
+
* If the start event has Form Field Metadata defined, the process engine will perform backend validation
|
|
2019
|
+
* for any form fields which have validators defined.
|
|
2020
|
+
* See [Documentation on Generated Task Forms](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#generated-task-forms).
|
|
2021
|
+
*/
|
|
2022
|
+
export declare const submitFormByKey: <ThrowOnError extends boolean = true>(options: Options<SubmitFormByKeyData, ThrowOnError>) => RequestResult<SubmitFormByKeyResponses, SubmitFormByKeyErrors, ThrowOnError, "data">;
|
|
2023
|
+
/**
|
|
2024
|
+
* Activate/Suspend by Id
|
|
2025
|
+
*
|
|
2026
|
+
* Activates or suspends a given process definition by latest version of process definition key
|
|
2027
|
+
* which belongs to no tenant.
|
|
2028
|
+
*/
|
|
2029
|
+
export declare const updateProcessDefinitionSuspensionStateByKey: <ThrowOnError extends boolean = true>(options: Options<UpdateProcessDefinitionSuspensionStateByKeyData, ThrowOnError>) => RequestResult<UpdateProcessDefinitionSuspensionStateByKeyResponses, UpdateProcessDefinitionSuspensionStateByKeyErrors, ThrowOnError, "data">;
|
|
2030
|
+
/**
|
|
2031
|
+
* Delete By Key
|
|
2032
|
+
*
|
|
2033
|
+
* Deletes process definitions by a given key and which belong to a tenant id.
|
|
2034
|
+
*/
|
|
2035
|
+
export declare const deleteProcessDefinitionsByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<DeleteProcessDefinitionsByKeyAndTenantIdData, ThrowOnError>) => RequestResult<DeleteProcessDefinitionsByKeyAndTenantIdResponses, DeleteProcessDefinitionsByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2036
|
+
/**
|
|
2037
|
+
* Get
|
|
2038
|
+
*
|
|
2039
|
+
* Retrieves the latest version of the process definition for tenant according to
|
|
2040
|
+
* the `ProcessDefinition` interface in the engine.
|
|
2041
|
+
*/
|
|
2042
|
+
export declare const getLatestProcessDefinitionByTenantId: <ThrowOnError extends boolean = true>(options: Options<GetLatestProcessDefinitionByTenantIdData, ThrowOnError>) => RequestResult<GetLatestProcessDefinitionByTenantIdResponses, GetLatestProcessDefinitionByTenantIdErrors, ThrowOnError, "data">;
|
|
2043
|
+
/**
|
|
2044
|
+
* Get Deployed Start Form
|
|
2045
|
+
*
|
|
2046
|
+
* Retrieves the deployed form that can be referenced from a start event.
|
|
2047
|
+
* For further information please refer to [User Guide](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#embedded-task-forms).
|
|
2048
|
+
*/
|
|
2049
|
+
export declare const getDeployedStartFormByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<GetDeployedStartFormByKeyAndTenantIdData, ThrowOnError>) => RequestResult<GetDeployedStartFormByKeyAndTenantIdResponses, GetDeployedStartFormByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2050
|
+
/**
|
|
2051
|
+
* Get Diagram
|
|
2052
|
+
*
|
|
2053
|
+
* Retrieves the diagram for the latest version of the process definition for tenant.
|
|
2054
|
+
*
|
|
2055
|
+
* If the process definition's deployment contains an image resource with the same file name
|
|
2056
|
+
* as the process definition, the deployed image will be returned by the Get Diagram endpoint.
|
|
2057
|
+
* Example: `someProcess.bpmn` and `someProcess.png`.
|
|
2058
|
+
* Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.
|
|
2059
|
+
*/
|
|
2060
|
+
export declare const getProcessDefinitionDiagramByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<GetProcessDefinitionDiagramByKeyAndTenantIdData, ThrowOnError>) => RequestResult<GetProcessDefinitionDiagramByKeyAndTenantIdResponses, GetProcessDefinitionDiagramByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2061
|
+
/**
|
|
2062
|
+
* Get Start Form Variables
|
|
2063
|
+
*
|
|
2064
|
+
* Retrieves the start form variables for the latest process definition for a tenant
|
|
2065
|
+
* (only if they are defined via the
|
|
2066
|
+
* [Generated Task Form](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#generated-task-forms) approach).
|
|
2067
|
+
* The start form variables take form data specified on the start event into account.
|
|
2068
|
+
* If form fields are defined, the variable types and default values
|
|
2069
|
+
* of the form fields are taken into account.
|
|
2070
|
+
*/
|
|
2071
|
+
export declare const getStartFormVariablesByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<GetStartFormVariablesByKeyAndTenantIdData, ThrowOnError>) => RequestResult<GetStartFormVariablesByKeyAndTenantIdResponses, GetStartFormVariablesByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2072
|
+
/**
|
|
2073
|
+
* Update History Time to Live
|
|
2074
|
+
*
|
|
2075
|
+
* Updates history time to live for the latest version of the process definition for a tenant.
|
|
2076
|
+
* The field is used within [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup).
|
|
2077
|
+
*/
|
|
2078
|
+
export declare const updateHistoryTimeToLiveByProcessDefinitionKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdData, ThrowOnError>) => RequestResult<UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdResponses, UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2079
|
+
/**
|
|
2080
|
+
* Get Rendered Start Form
|
|
2081
|
+
*
|
|
2082
|
+
* Retrieves the rendered form for the latest version of the process definition for a tenant.
|
|
2083
|
+
* This method can be used to get the HTML rendering of a
|
|
2084
|
+
* [Generated Task Form](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#generated-task-forms).
|
|
2085
|
+
*/
|
|
2086
|
+
export declare const getRenderedStartFormByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<GetRenderedStartFormByKeyAndTenantIdData, ThrowOnError>) => RequestResult<GetRenderedStartFormByKeyAndTenantIdResponses, GetRenderedStartFormByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2087
|
+
/**
|
|
2088
|
+
* Start Instance
|
|
2089
|
+
*
|
|
2090
|
+
* Instantiates a given process definition, starts the latest version of the process definition for tenant.
|
|
2091
|
+
* Process variables and business key may be supplied in the request body.
|
|
2092
|
+
*/
|
|
2093
|
+
export declare const startProcessInstanceByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<StartProcessInstanceByKeyAndTenantIdData, ThrowOnError>) => RequestResult<StartProcessInstanceByKeyAndTenantIdResponses, StartProcessInstanceByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2094
|
+
/**
|
|
2095
|
+
* Get Start Form Key
|
|
2096
|
+
*
|
|
2097
|
+
* Retrieves the key of the start form for the latest version of the process definition for a tenant.
|
|
2098
|
+
* The form key corresponds to the `FormData#formKey` property in the engine.
|
|
2099
|
+
*/
|
|
2100
|
+
export declare const getStartFormByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<GetStartFormByKeyAndTenantIdData, ThrowOnError>) => RequestResult<GetStartFormByKeyAndTenantIdResponses, GetStartFormByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2101
|
+
/**
|
|
2102
|
+
* Get Activity Instance Statistics
|
|
2103
|
+
*
|
|
2104
|
+
* Retrieves runtime statistics of the latest version of the given process definition for a tenant,
|
|
2105
|
+
* grouped by activities.
|
|
2106
|
+
* These statistics include the number of running activity instances, optionally the number of failed jobs
|
|
2107
|
+
* and also optionally the number of incidents either grouped by incident types or
|
|
2108
|
+
* for a specific incident type.
|
|
2109
|
+
* **Note**: This does not include historic data.
|
|
2110
|
+
*/
|
|
2111
|
+
export declare const getActivityStatisticsByProcessDefinitionKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<GetActivityStatisticsByProcessDefinitionKeyAndTenantIdData, ThrowOnError>) => RequestResult<GetActivityStatisticsByProcessDefinitionKeyAndTenantIdResponses, GetActivityStatisticsByProcessDefinitionKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2112
|
+
/**
|
|
2113
|
+
* Submit Start Form
|
|
2114
|
+
*
|
|
2115
|
+
* Starts the latest version of the process definition for a tenant
|
|
2116
|
+
* using a set of process variables and the business key.
|
|
2117
|
+
* If the start event has Form Field Metadata defined, the process engine will perform backend validation
|
|
2118
|
+
* for any form fields which have validators defined.
|
|
2119
|
+
* See [Documentation on Generated Task Forms](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#generated-task-forms).
|
|
2120
|
+
*/
|
|
2121
|
+
export declare const submitFormByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<SubmitFormByKeyAndTenantIdData, ThrowOnError>) => RequestResult<SubmitFormByKeyAndTenantIdResponses, SubmitFormByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2122
|
+
/**
|
|
2123
|
+
* Activate/Suspend by Id
|
|
2124
|
+
*
|
|
2125
|
+
* Activates or suspends a given process definition by the latest version of
|
|
2126
|
+
* the process definition for tenant.
|
|
2127
|
+
*/
|
|
2128
|
+
export declare const updateProcessDefinitionSuspensionStateByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<UpdateProcessDefinitionSuspensionStateByKeyAndTenantIdData, ThrowOnError>) => RequestResult<UpdateProcessDefinitionSuspensionStateByKeyAndTenantIdResponses, UpdateProcessDefinitionSuspensionStateByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2129
|
+
/**
|
|
2130
|
+
* Get XML
|
|
2131
|
+
*
|
|
2132
|
+
* Retrieves latest version the BPMN 2.0 XML of a process definition.
|
|
2133
|
+
* Returns the XML for the latest version of the process definition for tenant.
|
|
2134
|
+
*/
|
|
2135
|
+
export declare const getProcessDefinitionBpmn20XmlByKeyAndTenantId: <ThrowOnError extends boolean = true>(options: Options<GetProcessDefinitionBpmn20XmlByKeyAndTenantIdData, ThrowOnError>) => RequestResult<GetProcessDefinitionBpmn20XmlByKeyAndTenantIdResponses, GetProcessDefinitionBpmn20XmlByKeyAndTenantIdErrors, ThrowOnError, "data">;
|
|
2136
|
+
/**
|
|
2137
|
+
* Get XML
|
|
2138
|
+
*
|
|
2139
|
+
* Retrieves latest version the BPMN 2.0 XML of a process definition.
|
|
2140
|
+
*/
|
|
2141
|
+
export declare const getProcessDefinitionBpmn20XmlByKey: <ThrowOnError extends boolean = true>(options: Options<GetProcessDefinitionBpmn20XmlByKeyData, ThrowOnError>) => RequestResult<GetProcessDefinitionBpmn20XmlByKeyResponses, GetProcessDefinitionBpmn20XmlByKeyErrors, ThrowOnError, "data">;
|
|
2142
|
+
/**
|
|
2143
|
+
* Get Process Instance Statistics
|
|
2144
|
+
*
|
|
2145
|
+
* Retrieves runtime statistics of the process engine, grouped by process definitions.
|
|
2146
|
+
* These statistics include the number of running process instances, optionally the number of failed jobs
|
|
2147
|
+
* and also optionally the number of incidents either grouped by incident types or
|
|
2148
|
+
* for a specific incident type.
|
|
2149
|
+
* **Note**: This does not include historic data.
|
|
2150
|
+
*/
|
|
2151
|
+
export declare const getProcessDefinitionStatistics: <ThrowOnError extends boolean = true>(options?: Options<GetProcessDefinitionStatisticsData, ThrowOnError>) => RequestResult<GetProcessDefinitionStatisticsResponses, GetProcessDefinitionStatisticsErrors, ThrowOnError, "data">;
|
|
2152
|
+
/**
|
|
2153
|
+
* Activate/Suspend By Key
|
|
2154
|
+
*
|
|
2155
|
+
* Activates or suspends process definitions with the given process definition key.
|
|
2156
|
+
*/
|
|
2157
|
+
export declare const updateProcessDefinitionSuspensionState: <ThrowOnError extends boolean = true>(options?: Options<UpdateProcessDefinitionSuspensionStateData, ThrowOnError>) => RequestResult<UpdateProcessDefinitionSuspensionStateResponses, UpdateProcessDefinitionSuspensionStateErrors, ThrowOnError, "data">;
|
|
2158
|
+
/**
|
|
2159
|
+
* Delete
|
|
2160
|
+
*
|
|
2161
|
+
* Deletes a process definition by id.
|
|
2162
|
+
*/
|
|
2163
|
+
export declare const deleteProcessDefinition: <ThrowOnError extends boolean = true>(options: Options<DeleteProcessDefinitionData, ThrowOnError>) => RequestResult<DeleteProcessDefinitionResponses, DeleteProcessDefinitionErrors, ThrowOnError, "data">;
|
|
2164
|
+
/**
|
|
2165
|
+
* Get
|
|
2166
|
+
*
|
|
2167
|
+
* Retrieves a process definition according to the `ProcessDefinition` interface in the engine.
|
|
2168
|
+
*/
|
|
2169
|
+
export declare const getProcessDefinition: <ThrowOnError extends boolean = true>(options: Options<GetProcessDefinitionData, ThrowOnError>) => RequestResult<GetProcessDefinitionResponses, GetProcessDefinitionErrors, ThrowOnError, "data">;
|
|
2170
|
+
/**
|
|
2171
|
+
* Get Deployed Start Form
|
|
2172
|
+
*
|
|
2173
|
+
* Retrieves the deployed form that can be referenced from a start event.
|
|
2174
|
+
* For further information please refer to [User Guide](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#embedded-task-forms).
|
|
2175
|
+
*/
|
|
2176
|
+
export declare const getDeployedStartForm: <ThrowOnError extends boolean = true>(options: Options<GetDeployedStartFormData, ThrowOnError>) => RequestResult<GetDeployedStartFormResponses, GetDeployedStartFormErrors, ThrowOnError, "data">;
|
|
2177
|
+
/**
|
|
2178
|
+
* Get Diagram
|
|
2179
|
+
*
|
|
2180
|
+
* Retrieves the diagram of a process definition.
|
|
2181
|
+
*
|
|
2182
|
+
* If the process definition's deployment contains an image resource with the same file name
|
|
2183
|
+
* as the process definition, the deployed image will be returned by the Get Diagram endpoint.
|
|
2184
|
+
* Example: `someProcess.bpmn` and `someProcess.png`.
|
|
2185
|
+
* Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.
|
|
2186
|
+
*/
|
|
2187
|
+
export declare const getProcessDefinitionDiagram: <ThrowOnError extends boolean = true>(options: Options<GetProcessDefinitionDiagramData, ThrowOnError>) => RequestResult<GetProcessDefinitionDiagramResponses, GetProcessDefinitionDiagramErrors, ThrowOnError, "data">;
|
|
2188
|
+
/**
|
|
2189
|
+
* Get Start Form Variables
|
|
2190
|
+
*
|
|
2191
|
+
* Retrieves the start form variables for a process definition
|
|
2192
|
+
* (only if they are defined via the
|
|
2193
|
+
* [Generated Task Form](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#generated-task-forms) approach).
|
|
2194
|
+
* The start form variables take form data specified on the start event into account.
|
|
2195
|
+
* If form fields are defined, the variable types and default values
|
|
2196
|
+
* of the form fields are taken into account.
|
|
2197
|
+
*/
|
|
2198
|
+
export declare const getStartFormVariables: <ThrowOnError extends boolean = true>(options: Options<GetStartFormVariablesData, ThrowOnError>) => RequestResult<GetStartFormVariablesResponses, GetStartFormVariablesErrors, ThrowOnError, "data">;
|
|
2199
|
+
/**
|
|
2200
|
+
* Update History Time to Live
|
|
2201
|
+
*
|
|
2202
|
+
* Updates history time to live for process definition.
|
|
2203
|
+
* The field is used within [History cleanup](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/history/#history-cleanup).
|
|
2204
|
+
* The value of the update is mandatory by default and does not allow `null` values. To enable them, please
|
|
2205
|
+
* set the feature flag `enforceHistoryTimeToLive` to `false`. Read more in [Configuration Properties]
|
|
2206
|
+
* (https://docs.cibseven.org/manual/2.1/reference/deployment-descriptors/tags/process-engine#configuration-properties)
|
|
2207
|
+
*/
|
|
2208
|
+
export declare const updateHistoryTimeToLiveByProcessDefinitionId: <ThrowOnError extends boolean = true>(options: Options<UpdateHistoryTimeToLiveByProcessDefinitionIdData, ThrowOnError>) => RequestResult<UpdateHistoryTimeToLiveByProcessDefinitionIdResponses, UpdateHistoryTimeToLiveByProcessDefinitionIdErrors, ThrowOnError, "data">;
|
|
2209
|
+
/**
|
|
2210
|
+
* Get Rendered Start Form
|
|
2211
|
+
*
|
|
2212
|
+
* Retrieves the rendered form for a process definition.
|
|
2213
|
+
* This method can be used to get the HTML rendering of a
|
|
2214
|
+
* [Generated Task Form](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#generated-task-forms).
|
|
2215
|
+
*/
|
|
2216
|
+
export declare const getRenderedStartForm: <ThrowOnError extends boolean = true>(options: Options<GetRenderedStartFormData, ThrowOnError>) => RequestResult<GetRenderedStartFormResponses, GetRenderedStartFormErrors, ThrowOnError, "data">;
|
|
2217
|
+
/**
|
|
2218
|
+
* Restart Process Instance
|
|
2219
|
+
*
|
|
2220
|
+
* Restarts process instances that were canceled or terminated synchronously.
|
|
2221
|
+
* Can also restart completed process instances.
|
|
2222
|
+
* It will create a new instance using the original instance information.
|
|
2223
|
+
* To execute the restart asynchronously, use the
|
|
2224
|
+
* [Restart Process Instance Async](https://docs.cibseven.org/manual/2.1/reference/rest/process-definition/post-restart-process-instance-async/) method.
|
|
2225
|
+
*
|
|
2226
|
+
* For more information about the difference between synchronous and asynchronous execution,
|
|
2227
|
+
* please refer to the related section of the
|
|
2228
|
+
* [User Guide](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/process-instance-restart/#execution).
|
|
2229
|
+
*/
|
|
2230
|
+
export declare const restartProcessInstance: <ThrowOnError extends boolean = true>(options: Options<RestartProcessInstanceData, ThrowOnError>) => RequestResult<RestartProcessInstanceResponses, RestartProcessInstanceErrors, ThrowOnError, "data">;
|
|
2231
|
+
/**
|
|
2232
|
+
* Restart Process Instance Async
|
|
2233
|
+
*
|
|
2234
|
+
* Restarts process instances that were canceled or terminated asynchronously.
|
|
2235
|
+
* Can also restart completed process instances.
|
|
2236
|
+
* It will create a new instance using the original instance information.
|
|
2237
|
+
* To execute the restart asynchronously, use the
|
|
2238
|
+
* [Restart Process Instance](https://docs.cibseven.org/manual/2.1/reference/rest/process-definition/post-restart-process-instance-sync/) method.
|
|
2239
|
+
*
|
|
2240
|
+
* For more information about the difference between synchronous and asynchronous execution,
|
|
2241
|
+
* please refer to the related section of the
|
|
2242
|
+
* [User Guide](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/process-instance-restart/#execution).
|
|
2243
|
+
*/
|
|
2244
|
+
export declare const restartProcessInstanceAsyncOperation: <ThrowOnError extends boolean = true>(options: Options<RestartProcessInstanceAsyncOperationData, ThrowOnError>) => RequestResult<RestartProcessInstanceAsyncOperationResponses, RestartProcessInstanceAsyncOperationErrors, ThrowOnError, "data">;
|
|
2245
|
+
/**
|
|
2246
|
+
* Start Instance
|
|
2247
|
+
*
|
|
2248
|
+
* Instantiates a given process definition.
|
|
2249
|
+
* Process variables and business key may be supplied in the request body.
|
|
2250
|
+
*/
|
|
2251
|
+
export declare const startProcessInstance: <ThrowOnError extends boolean = true>(options: Options<StartProcessInstanceData, ThrowOnError>) => RequestResult<StartProcessInstanceResponses, StartProcessInstanceErrors, ThrowOnError, "data">;
|
|
2252
|
+
/**
|
|
2253
|
+
* Get Start Form Key
|
|
2254
|
+
*
|
|
2255
|
+
* Retrieves the key of the start form for a process definition.
|
|
2256
|
+
* The form key corresponds to the `FormData#formKey` property in the engine.
|
|
2257
|
+
*/
|
|
2258
|
+
export declare const getStartForm: <ThrowOnError extends boolean = true>(options: Options<GetStartFormData, ThrowOnError>) => RequestResult<GetStartFormResponses, GetStartFormErrors, ThrowOnError, "data">;
|
|
2259
|
+
/**
|
|
2260
|
+
* Get Static Called Process Definitions
|
|
2261
|
+
*
|
|
2262
|
+
* For the given process, returns a list of called process definitions corresponding
|
|
2263
|
+
* to
|
|
2264
|
+
* the `CalledProcessDefinition` interface in the engine. The list
|
|
2265
|
+
* contains all process definitions
|
|
2266
|
+
* that are referenced statically by call activities in the given
|
|
2267
|
+
* process. This endpoint does not
|
|
2268
|
+
* resolve process definitions that are referenced with expressions. Each
|
|
2269
|
+
* called process definition
|
|
2270
|
+
* contains a list of call activity ids, which specifies the call
|
|
2271
|
+
* activities that are calling that
|
|
2272
|
+
* process. This endpoint does not resolve references to case
|
|
2273
|
+
* definitions.
|
|
2274
|
+
*/
|
|
2275
|
+
export declare const getStaticCalledProcessDefinitions: <ThrowOnError extends boolean = true>(options: Options<GetStaticCalledProcessDefinitionsData, ThrowOnError>) => RequestResult<GetStaticCalledProcessDefinitionsResponses, GetStaticCalledProcessDefinitionsErrors, ThrowOnError, "data">;
|
|
2276
|
+
/**
|
|
2277
|
+
* Get Activity Instance Statistics
|
|
2278
|
+
*
|
|
2279
|
+
* Retrieves runtime statistics of a given process definition, grouped by activities.
|
|
2280
|
+
* These statistics include the number of running activity instances, optionally the number of failed jobs
|
|
2281
|
+
* and also optionally the number of incidents either grouped by incident types or for a specific incident type.
|
|
2282
|
+
* **Note**: This does not include historic data.
|
|
2283
|
+
*/
|
|
2284
|
+
export declare const getActivityStatistics: <ThrowOnError extends boolean = true>(options: Options<GetActivityStatisticsData, ThrowOnError>) => RequestResult<GetActivityStatisticsResponses, GetActivityStatisticsErrors, ThrowOnError, "data">;
|
|
2285
|
+
/**
|
|
2286
|
+
* Submit Start Form
|
|
2287
|
+
*
|
|
2288
|
+
* Starts a process instance using a set of process variables and the business key.
|
|
2289
|
+
* If the start event has Form Field Metadata defined, the process engine will perform backend validation
|
|
2290
|
+
* for any form fields which have validators defined.
|
|
2291
|
+
* See [Documentation on Generated Task Forms](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#generated-task-forms).
|
|
2292
|
+
*/
|
|
2293
|
+
export declare const submitForm: <ThrowOnError extends boolean = true>(options: Options<SubmitFormData, ThrowOnError>) => RequestResult<SubmitFormResponses, SubmitFormErrors, ThrowOnError, "data">;
|
|
2294
|
+
/**
|
|
2295
|
+
* Activate/Suspend By Id
|
|
2296
|
+
*
|
|
2297
|
+
* Activates or suspends a given process definition by id.
|
|
2298
|
+
*/
|
|
2299
|
+
export declare const updateProcessDefinitionSuspensionStateById: <ThrowOnError extends boolean = true>(options: Options<UpdateProcessDefinitionSuspensionStateByIdData, ThrowOnError>) => RequestResult<UpdateProcessDefinitionSuspensionStateByIdResponses, UpdateProcessDefinitionSuspensionStateByIdErrors, ThrowOnError, "data">;
|
|
2300
|
+
/**
|
|
2301
|
+
* Get XML
|
|
2302
|
+
*
|
|
2303
|
+
* Retrieves the BPMN 2.0 XML of a process definition.
|
|
2304
|
+
*/
|
|
2305
|
+
export declare const getProcessDefinitionBpmn20Xml: <ThrowOnError extends boolean = true>(options: Options<GetProcessDefinitionBpmn20XmlData, ThrowOnError>) => RequestResult<GetProcessDefinitionBpmn20XmlResponses, GetProcessDefinitionBpmn20XmlErrors, ThrowOnError, "data">;
|
|
2306
|
+
/**
|
|
2307
|
+
* Get List
|
|
2308
|
+
*
|
|
2309
|
+
* Queries for process instances that fulfill given parameters.
|
|
2310
|
+
* Parameters may be static as well as dynamic runtime properties of process instances.
|
|
2311
|
+
* The size of the result set can be retrieved by using the Get Instance Count method.
|
|
2312
|
+
*/
|
|
2313
|
+
export declare const getProcessInstances: <ThrowOnError extends boolean = true>(options?: Options<GetProcessInstancesData, ThrowOnError>) => RequestResult<GetProcessInstancesResponses, GetProcessInstancesErrors, ThrowOnError, "data">;
|
|
2314
|
+
/**
|
|
2315
|
+
* Get List (POST)
|
|
2316
|
+
*
|
|
2317
|
+
* Queries for process instances that fulfill given parameters through a JSON object.
|
|
2318
|
+
* This method is slightly more powerful than the Get Instances method because
|
|
2319
|
+
* it allows filtering by multiple process variables of types `string`, `number` or `boolean`.
|
|
2320
|
+
*/
|
|
2321
|
+
export declare const queryProcessInstances: <ThrowOnError extends boolean = true>(options?: Options<QueryProcessInstancesData, ThrowOnError>) => RequestResult<QueryProcessInstancesResponses, QueryProcessInstancesErrors, ThrowOnError, "data">;
|
|
2322
|
+
/**
|
|
2323
|
+
* Get List Count
|
|
2324
|
+
*
|
|
2325
|
+
* Queries for the number of process instances that fulfill given parameters.
|
|
2326
|
+
*/
|
|
2327
|
+
export declare const getProcessInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<GetProcessInstancesCountData, ThrowOnError>) => RequestResult<GetProcessInstancesCountResponses, GetProcessInstancesCountErrors, ThrowOnError, "data">;
|
|
2328
|
+
/**
|
|
2329
|
+
* Get List Count (POST)
|
|
2330
|
+
*
|
|
2331
|
+
* Queries for the number of process instances that fulfill the given parameters.
|
|
2332
|
+
* This method takes the same message body as the Get Instances (POST) method and
|
|
2333
|
+
* therefore it is slightly more powerful than the Get Instance Count method.
|
|
2334
|
+
*/
|
|
2335
|
+
export declare const queryProcessInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<QueryProcessInstancesCountData, ThrowOnError>) => RequestResult<QueryProcessInstancesCountResponses, QueryProcessInstancesCountErrors, ThrowOnError, "data">;
|
|
2336
|
+
/**
|
|
2337
|
+
* Delete Async (POST)
|
|
2338
|
+
*
|
|
2339
|
+
* Deletes multiple process instances asynchronously (batch).
|
|
2340
|
+
*/
|
|
2341
|
+
export declare const deleteProcessInstancesAsyncOperation: <ThrowOnError extends boolean = true>(options?: Options<DeleteProcessInstancesAsyncOperationData, ThrowOnError>) => RequestResult<DeleteProcessInstancesAsyncOperationResponses, DeleteProcessInstancesAsyncOperationErrors, ThrowOnError, "data">;
|
|
2342
|
+
/**
|
|
2343
|
+
* Delete Async Historic Query Based (POST)
|
|
2344
|
+
*
|
|
2345
|
+
* Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
|
|
2346
|
+
*/
|
|
2347
|
+
export declare const deleteAsyncHistoricQueryBased: <ThrowOnError extends boolean = true>(options?: Options<DeleteAsyncHistoricQueryBasedData, ThrowOnError>) => RequestResult<DeleteAsyncHistoricQueryBasedResponses, DeleteAsyncHistoricQueryBasedErrors, ThrowOnError, "data">;
|
|
2348
|
+
/**
|
|
2349
|
+
* Set Job Retries Async (POST)
|
|
2350
|
+
*
|
|
2351
|
+
* Create a batch to set retries of jobs associated with given processes asynchronously.
|
|
2352
|
+
*/
|
|
2353
|
+
export declare const setRetriesByProcess: <ThrowOnError extends boolean = true>(options?: Options<SetRetriesByProcessData, ThrowOnError>) => RequestResult<SetRetriesByProcessResponses, SetRetriesByProcessErrors, ThrowOnError, "data">;
|
|
2354
|
+
/**
|
|
2355
|
+
* Set Job Retries Async Historic Query Based (POST)
|
|
2356
|
+
*
|
|
2357
|
+
* Create a batch to set retries of jobs asynchronously based on a historic process instance query.
|
|
2358
|
+
*/
|
|
2359
|
+
export declare const setRetriesByProcessHistoricQueryBased: <ThrowOnError extends boolean = true>(options?: Options<SetRetriesByProcessHistoricQueryBasedData, ThrowOnError>) => RequestResult<SetRetriesByProcessHistoricQueryBasedResponses, SetRetriesByProcessHistoricQueryBasedErrors, ThrowOnError, "data">;
|
|
2360
|
+
/**
|
|
2361
|
+
* Correlate Message Async (POST)
|
|
2362
|
+
*
|
|
2363
|
+
* Correlates a message asynchronously to executions that are waiting for this message.
|
|
2364
|
+
* Messages will not be correlated to process definition-level start message events to start process instances.
|
|
2365
|
+
*/
|
|
2366
|
+
export declare const correlateMessageAsyncOperation: <ThrowOnError extends boolean = true>(options?: Options<CorrelateMessageAsyncOperationData, ThrowOnError>) => RequestResult<CorrelateMessageAsyncOperationResponses, CorrelateMessageAsyncOperationErrors, ThrowOnError, "data">;
|
|
2367
|
+
/**
|
|
2368
|
+
* Activate/Suspend In Group
|
|
2369
|
+
*
|
|
2370
|
+
* Activates or suspends process instances by providing certain criteria:
|
|
2371
|
+
*
|
|
2372
|
+
* # Activate/Suspend Process Instance By Process Definition Id
|
|
2373
|
+
* * `suspend`
|
|
2374
|
+
* * `processDefinitionId`
|
|
2375
|
+
*
|
|
2376
|
+
* # Activate/Suspend Process Instance By Process Definition Key
|
|
2377
|
+
*
|
|
2378
|
+
* * `suspend`
|
|
2379
|
+
* * `processDefinitionKey`
|
|
2380
|
+
* * `processDefinitionTenantId`
|
|
2381
|
+
* * `processDefinitionWithoutTenantId`
|
|
2382
|
+
*
|
|
2383
|
+
* # Activate/Suspend Process Instance In Group
|
|
2384
|
+
* * `suspend`
|
|
2385
|
+
* * `processInstanceIds`
|
|
2386
|
+
* * `processInstanceQuery`
|
|
2387
|
+
* * `historicProcessInstanceQuery`
|
|
2388
|
+
*/
|
|
2389
|
+
export declare const updateSuspensionState: <ThrowOnError extends boolean = true>(options?: Options<UpdateSuspensionStateData, ThrowOnError>) => RequestResult<UpdateSuspensionStateResponses, UpdateSuspensionStateErrors, ThrowOnError, "data">;
|
|
2390
|
+
/**
|
|
2391
|
+
* Activate/Suspend In Batch
|
|
2392
|
+
*
|
|
2393
|
+
* Activates or suspends process instances asynchronously with a list of process instance ids,
|
|
2394
|
+
* a process instance query, and/or a historical process instance query.
|
|
2395
|
+
*/
|
|
2396
|
+
export declare const updateSuspensionStateAsyncOperation: <ThrowOnError extends boolean = true>(options?: Options<UpdateSuspensionStateAsyncOperationData, ThrowOnError>) => RequestResult<UpdateSuspensionStateAsyncOperationResponses, UpdateSuspensionStateAsyncOperationErrors, ThrowOnError, "data">;
|
|
2397
|
+
/**
|
|
2398
|
+
* Set Variables Async (POST)
|
|
2399
|
+
*
|
|
2400
|
+
* Update or create runtime process variables in the root scope of process instances.
|
|
2401
|
+
*/
|
|
2402
|
+
export declare const setVariablesAsyncOperation: <ThrowOnError extends boolean = true>(options?: Options<SetVariablesAsyncOperationData, ThrowOnError>) => RequestResult<SetVariablesAsyncOperationResponses, SetVariablesAsyncOperationErrors, ThrowOnError, "data">;
|
|
2403
|
+
/**
|
|
2404
|
+
* Delete
|
|
2405
|
+
*
|
|
2406
|
+
* Deletes a running process instance by id.
|
|
2407
|
+
*/
|
|
2408
|
+
export declare const deleteProcessInstance: <ThrowOnError extends boolean = true>(options: Options<DeleteProcessInstanceData, ThrowOnError>) => RequestResult<DeleteProcessInstanceResponses, DeleteProcessInstanceErrors, ThrowOnError, "data">;
|
|
2409
|
+
/**
|
|
2410
|
+
* Get Process Instance
|
|
2411
|
+
*
|
|
2412
|
+
* Retrieves a process instance by id, according to the `ProcessInstance` interface in the engine.
|
|
2413
|
+
*/
|
|
2414
|
+
export declare const getProcessInstance: <ThrowOnError extends boolean = true>(options: Options<GetProcessInstanceData, ThrowOnError>) => RequestResult<GetProcessInstanceResponses, GetProcessInstanceErrors, ThrowOnError, "data">;
|
|
2415
|
+
/**
|
|
2416
|
+
* Get Activity Instance
|
|
2417
|
+
*
|
|
2418
|
+
* Retrieves an Activity Instance (Tree) for a given process instance by id.
|
|
2419
|
+
*/
|
|
2420
|
+
export declare const getActivityInstanceTree: <ThrowOnError extends boolean = true>(options: Options<GetActivityInstanceTreeData, ThrowOnError>) => RequestResult<GetActivityInstanceTreeResponses, GetActivityInstanceTreeErrors, ThrowOnError, "data">;
|
|
2421
|
+
/**
|
|
2422
|
+
* Delete ProcessInstance Comments
|
|
2423
|
+
*
|
|
2424
|
+
* Deletes all comments of a process instance by id.
|
|
2425
|
+
*/
|
|
2426
|
+
export declare const deleteProcessInstanceComments: <ThrowOnError extends boolean = true>(options: Options<DeleteProcessInstanceCommentsData, ThrowOnError>) => RequestResult<DeleteProcessInstanceCommentsResponses, DeleteProcessInstanceCommentsErrors, ThrowOnError, "data">;
|
|
2427
|
+
/**
|
|
2428
|
+
* Get Process Instance Comments
|
|
2429
|
+
*
|
|
2430
|
+
* Gets the comments for a process instance by id.
|
|
2431
|
+
*/
|
|
2432
|
+
export declare const getProcessInstanceComments: <ThrowOnError extends boolean = true>(options: Options<GetProcessInstanceCommentsData, ThrowOnError>) => RequestResult<GetProcessInstanceCommentsResponses, GetProcessInstanceCommentsErrors, ThrowOnError, "data">;
|
|
2433
|
+
/**
|
|
2434
|
+
* Update
|
|
2435
|
+
*
|
|
2436
|
+
* Updates a Comment.
|
|
2437
|
+
*/
|
|
2438
|
+
export declare const updateProcessInstanceComment: <ThrowOnError extends boolean = true>(options: Options<UpdateProcessInstanceCommentData, ThrowOnError>) => RequestResult<UpdateProcessInstanceCommentResponses, UpdateProcessInstanceCommentErrors, ThrowOnError, "data">;
|
|
2439
|
+
/**
|
|
2440
|
+
* Delete
|
|
2441
|
+
*
|
|
2442
|
+
* Removes a comment from a process instance by id.
|
|
2443
|
+
*/
|
|
2444
|
+
export declare const deleteProcessInstanceComment: <ThrowOnError extends boolean = true>(options: Options<DeleteProcessInstanceCommentData, ThrowOnError>) => RequestResult<DeleteProcessInstanceCommentResponses, DeleteProcessInstanceCommentErrors, ThrowOnError, "data">;
|
|
2445
|
+
/**
|
|
2446
|
+
* Modify Process Instance Execution State
|
|
2447
|
+
*
|
|
2448
|
+
* Submits a list of modification instructions to change a process instance's execution state.
|
|
2449
|
+
* A modification instruction is one of the following:
|
|
2450
|
+
*
|
|
2451
|
+
* * Starting execution before an activity
|
|
2452
|
+
* * Starting execution after an activity on its single outgoing sequence flow
|
|
2453
|
+
* * Starting execution on a specific sequence flow
|
|
2454
|
+
* * Canceling an activity instance, transition instance, or all instances (activity or transition) for an activity
|
|
2455
|
+
*
|
|
2456
|
+
* Instructions are executed immediately and in the order they are provided in this request's body.
|
|
2457
|
+
* Variables can be provided with every starting instruction.
|
|
2458
|
+
*
|
|
2459
|
+
* The exact semantics of modification can be read about in the [User guide](https://docs.cibseven.org/manual/develop/user-guide/process-engine/process-instance-modification/).
|
|
2460
|
+
*/
|
|
2461
|
+
export declare const modifyProcessInstance: <ThrowOnError extends boolean = true>(options: Options<ModifyProcessInstanceData, ThrowOnError>) => RequestResult<ModifyProcessInstanceResponses, ModifyProcessInstanceErrors, ThrowOnError, "data">;
|
|
2462
|
+
/**
|
|
2463
|
+
* Modify Process Instance Execution State Async
|
|
2464
|
+
*
|
|
2465
|
+
* Submits a list of modification instructions to change a process instance's execution state async.
|
|
2466
|
+
* A modification instruction is one of the following:
|
|
2467
|
+
*
|
|
2468
|
+
* * Starting execution before an activity
|
|
2469
|
+
* * Starting execution after an activity on its single outgoing sequence flow
|
|
2470
|
+
* * Starting execution on a specific sequence flow
|
|
2471
|
+
* * Cancelling an activity instance, transition instance, or all instances (activity or transition) for an activity
|
|
2472
|
+
*
|
|
2473
|
+
* Instructions are executed asynchronous and in the order they are provided in this request's body.
|
|
2474
|
+
* Variables can be provided with every starting instruction.
|
|
2475
|
+
*
|
|
2476
|
+
* The exact semantics of modification can be read about in the
|
|
2477
|
+
* [User guide](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/process-instance-modification/).
|
|
2478
|
+
*/
|
|
2479
|
+
export declare const modifyProcessInstanceAsyncOperation: <ThrowOnError extends boolean = true>(options: Options<ModifyProcessInstanceAsyncOperationData, ThrowOnError>) => RequestResult<ModifyProcessInstanceAsyncOperationResponses, ModifyProcessInstanceAsyncOperationErrors, ThrowOnError, "data">;
|
|
2480
|
+
/**
|
|
2481
|
+
* Activate/Suspend Process Instance By Id
|
|
2482
|
+
*
|
|
2483
|
+
* Activates or suspends a given process instance by id.
|
|
2484
|
+
*/
|
|
2485
|
+
export declare const updateSuspensionStateById: <ThrowOnError extends boolean = true>(options: Options<UpdateSuspensionStateByIdData, ThrowOnError>) => RequestResult<UpdateSuspensionStateByIdResponses, unknown, ThrowOnError, "data">;
|
|
2486
|
+
/**
|
|
2487
|
+
* Get Process Variables
|
|
2488
|
+
*
|
|
2489
|
+
* Retrieves all variables of a given process instance by id.
|
|
2490
|
+
*/
|
|
2491
|
+
export declare const getProcessInstanceVariables: <ThrowOnError extends boolean = true>(options: Options<GetProcessInstanceVariablesData, ThrowOnError>) => RequestResult<GetProcessInstanceVariablesResponses, GetProcessInstanceVariablesErrors, ThrowOnError, "data">;
|
|
2492
|
+
/**
|
|
2493
|
+
* Update/Delete Process Variables
|
|
2494
|
+
*
|
|
2495
|
+
* Updates or deletes the variables of a process instance by id. Updates precede deletions.
|
|
2496
|
+
* So, if a variable is updated AND deleted, the deletion overrides the update.
|
|
2497
|
+
*/
|
|
2498
|
+
export declare const modifyProcessInstanceVariables: <ThrowOnError extends boolean = true>(options: Options<ModifyProcessInstanceVariablesData, ThrowOnError>) => RequestResult<ModifyProcessInstanceVariablesResponses, ModifyProcessInstanceVariablesErrors, ThrowOnError, "data">;
|
|
2499
|
+
/**
|
|
2500
|
+
* Delete Process Variable
|
|
2501
|
+
*
|
|
2502
|
+
* Deletes a variable of a process instance by id.
|
|
2503
|
+
*/
|
|
2504
|
+
export declare const deleteProcessInstanceVariable: <ThrowOnError extends boolean = true>(options: Options<DeleteProcessInstanceVariableData, ThrowOnError>) => RequestResult<DeleteProcessInstanceVariableResponses, unknown, ThrowOnError, "data">;
|
|
2505
|
+
/**
|
|
2506
|
+
* Get Process Variable
|
|
2507
|
+
*
|
|
2508
|
+
* Retrieves a variable of a given process instance by id.
|
|
2509
|
+
*/
|
|
2510
|
+
export declare const getProcessInstanceVariable: <ThrowOnError extends boolean = true>(options: Options<GetProcessInstanceVariableData, ThrowOnError>) => RequestResult<GetProcessInstanceVariableResponses, GetProcessInstanceVariableErrors, ThrowOnError, "data">;
|
|
2511
|
+
/**
|
|
2512
|
+
* Update Process Variable
|
|
2513
|
+
*
|
|
2514
|
+
* Sets a variable of a given process instance by id.
|
|
2515
|
+
*/
|
|
2516
|
+
export declare const setProcessInstanceVariable: <ThrowOnError extends boolean = true>(options: Options<SetProcessInstanceVariableData, ThrowOnError>) => RequestResult<SetProcessInstanceVariableResponses, SetProcessInstanceVariableErrors, ThrowOnError, "data">;
|
|
2517
|
+
/**
|
|
2518
|
+
* Get Process Variable (Binary)
|
|
2519
|
+
*
|
|
2520
|
+
* Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name.
|
|
2521
|
+
* Applicable for byte array or file Process Variables.
|
|
2522
|
+
*/
|
|
2523
|
+
export declare const getProcessInstanceVariableBinary: <ThrowOnError extends boolean = true>(options: Options<GetProcessInstanceVariableBinaryData, ThrowOnError>) => RequestResult<GetProcessInstanceVariableBinaryResponses, GetProcessInstanceVariableBinaryErrors, ThrowOnError, "data">;
|
|
2524
|
+
/**
|
|
2525
|
+
* Update Process Variable (Binary)
|
|
2526
|
+
*
|
|
2527
|
+
* Sets the serialized value for a binary variable or the binary value for a file variable.
|
|
2528
|
+
*/
|
|
2529
|
+
export declare const setProcessInstanceVariableBinary: <ThrowOnError extends boolean = true>(options: Options<SetProcessInstanceVariableBinaryData, ThrowOnError>) => RequestResult<SetProcessInstanceVariableBinaryResponses, SetProcessInstanceVariableBinaryErrors, ThrowOnError, "data">;
|
|
2530
|
+
/**
|
|
2531
|
+
* Get List
|
|
2532
|
+
*
|
|
2533
|
+
* Queries for schema log entries that fulfill given parameters.
|
|
2534
|
+
*/
|
|
2535
|
+
export declare const getSchemaLog: <ThrowOnError extends boolean = true>(options?: Options<GetSchemaLogData, ThrowOnError>) => RequestResult<GetSchemaLogResponses, unknown, ThrowOnError, "data">;
|
|
2536
|
+
/**
|
|
2537
|
+
* Get List (POST)
|
|
2538
|
+
*
|
|
2539
|
+
* Queries for schema log entries that fulfill given parameters.
|
|
2540
|
+
*/
|
|
2541
|
+
export declare const querySchemaLog: <ThrowOnError extends boolean = true>(options?: Options<QuerySchemaLogData, ThrowOnError>) => RequestResult<QuerySchemaLogResponses, unknown, ThrowOnError, "data">;
|
|
2542
|
+
/**
|
|
2543
|
+
* Event
|
|
2544
|
+
*
|
|
2545
|
+
* A signal is an event of global scope (broadcast semantics) and is delivered to all
|
|
2546
|
+
* active handlers. Internally this maps to the engine's signal event received builder
|
|
2547
|
+
* method `RuntimeService#createSignalEvent()`. For more information about the signal
|
|
2548
|
+
* behavior, see the [Signal Events](https://docs.cibseven.org/manual/2.1/reference/bpmn20/events/signal-events/)
|
|
2549
|
+
* section of the [BPMN 2.0 Implementation Reference](https://docs.cibseven.org/manual/2.1/reference/bpmn20/).
|
|
2550
|
+
*/
|
|
2551
|
+
export declare const throwSignal: <ThrowOnError extends boolean = true>(options?: Options<ThrowSignalData, ThrowOnError>) => RequestResult<ThrowSignalResponses, ThrowSignalErrors, ThrowOnError, "data">;
|
|
2552
|
+
/**
|
|
2553
|
+
* Get List
|
|
2554
|
+
*
|
|
2555
|
+
* Queries for tasks that fulfill a given filter. The size of the result set can be
|
|
2556
|
+
* retrieved by using the Get Task Count method.
|
|
2557
|
+
*
|
|
2558
|
+
* **Security Consideration:** There are several query parameters (such as
|
|
2559
|
+
* assigneeExpression) for specifying an EL expression. These are disabled by default to
|
|
2560
|
+
* prevent remote code execution. See the section on
|
|
2561
|
+
* [security considerations](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/securing-custom-code/)
|
|
2562
|
+
* for custom code in the user guide for details.
|
|
2563
|
+
*/
|
|
2564
|
+
export declare const getTasks: <ThrowOnError extends boolean = true>(options?: Options<GetTasksData, ThrowOnError>) => RequestResult<GetTasksResponses, GetTasksErrors, ThrowOnError, "data">;
|
|
2565
|
+
/**
|
|
2566
|
+
* Get List (POST)
|
|
2567
|
+
*
|
|
2568
|
+
* Queries for tasks that fulfill a given filter. This method is slightly more powerful
|
|
2569
|
+
* than the [Get Tasks](https://docs.cibseven.org/manual/2.1/reference/rest/task/get-query/) method because it
|
|
2570
|
+
* allows filtering by multiple process or task variables of types `String`, `Number`
|
|
2571
|
+
* or `Boolean`. The size of the result set can be retrieved by using the
|
|
2572
|
+
* [Get Task Count (POST)](https://docs.cibseven.org/manual/2.1/reference/rest/task/post-query-count/) method.
|
|
2573
|
+
*
|
|
2574
|
+
* **Security Consideration**:
|
|
2575
|
+
* There are several parameters (such as `assigneeExpression`) for specifying an EL
|
|
2576
|
+
* expression. These are disabled by default to prevent remote code execution. See the
|
|
2577
|
+
* section on
|
|
2578
|
+
* [security considerations for custom code](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/securing-custom-code/)
|
|
2579
|
+
* in the user guide for details.
|
|
2580
|
+
*/
|
|
2581
|
+
export declare const queryTasks: <ThrowOnError extends boolean = true>(options?: Options<QueryTasksData, ThrowOnError>) => RequestResult<QueryTasksResponses, QueryTasksErrors, ThrowOnError, "data">;
|
|
2582
|
+
/**
|
|
2583
|
+
* Get List Count
|
|
2584
|
+
*
|
|
2585
|
+
* Retrieves the number of tasks that fulfill a provided filter. Corresponds to the size
|
|
2586
|
+
* of the result set when using the [Get Tasks](https://docs.cibseven.org/manual/2.1/reference/rest/task/) method.
|
|
2587
|
+
*
|
|
2588
|
+
* **Security Consideration:** There are several query parameters (such as
|
|
2589
|
+
* assigneeExpression) for specifying an EL expression. These are disabled by default to
|
|
2590
|
+
* prevent remote code execution. See the section on
|
|
2591
|
+
* [security considerations](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/securing-custom-code/)
|
|
2592
|
+
* for custom code in the user guide for details.
|
|
2593
|
+
*/
|
|
2594
|
+
export declare const getTasksCount: <ThrowOnError extends boolean = true>(options?: Options<GetTasksCountData, ThrowOnError>) => RequestResult<GetTasksCountResponses, GetTasksCountErrors, ThrowOnError, "data">;
|
|
2595
|
+
/**
|
|
2596
|
+
* Get List Count (POST)
|
|
2597
|
+
*
|
|
2598
|
+
* Retrieves the number of tasks that fulfill the given filter. Corresponds to the size
|
|
2599
|
+
* of the result set of the [Get Tasks (POST)](https://docs.cibseven.org/manual/2.1/reference/rest/task/post-query/)
|
|
2600
|
+
* method and takes the same parameters.
|
|
2601
|
+
*
|
|
2602
|
+
* **Security Consideration**:
|
|
2603
|
+
* There are several parameters (such as `assigneeExpression`) for specifying an EL
|
|
2604
|
+
* expression. These are disabled by default to prevent remote code execution. See the
|
|
2605
|
+
* section on
|
|
2606
|
+
* [security considerations for custom code](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/securing-custom-code/)
|
|
2607
|
+
* in the user guide for details.
|
|
2608
|
+
*/
|
|
2609
|
+
export declare const queryTasksCount: <ThrowOnError extends boolean = true>(options?: Options<QueryTasksCountData, ThrowOnError>) => RequestResult<QueryTasksCountResponses, QueryTasksCountErrors, ThrowOnError, "data">;
|
|
2610
|
+
/**
|
|
2611
|
+
* Create
|
|
2612
|
+
*
|
|
2613
|
+
* Creates a new task.
|
|
2614
|
+
*/
|
|
2615
|
+
export declare const createTask: <ThrowOnError extends boolean = true>(options?: Options<CreateTaskData, ThrowOnError>) => RequestResult<CreateTaskResponses, CreateTaskErrors, ThrowOnError, "data">;
|
|
2616
|
+
/**
|
|
2617
|
+
* Get Task Count By Candidate Group
|
|
2618
|
+
*
|
|
2619
|
+
* Retrieves the number of tasks for each candidate group.
|
|
2620
|
+
*/
|
|
2621
|
+
export declare const getTaskCountByCandidateGroup: <ThrowOnError extends boolean = true>(options?: Options<GetTaskCountByCandidateGroupData, ThrowOnError>) => RequestResult<GetTaskCountByCandidateGroupResponses, GetTaskCountByCandidateGroupErrors, ThrowOnError, "data">;
|
|
2622
|
+
/**
|
|
2623
|
+
* Delete
|
|
2624
|
+
*
|
|
2625
|
+
* Removes a task by id.
|
|
2626
|
+
*/
|
|
2627
|
+
export declare const deleteTask: <ThrowOnError extends boolean = true>(options: Options<DeleteTaskData, ThrowOnError>) => RequestResult<DeleteTaskResponses, DeleteTaskErrors, ThrowOnError, "data">;
|
|
2628
|
+
/**
|
|
2629
|
+
* Get
|
|
2630
|
+
*
|
|
2631
|
+
* Retrieves a task by id.
|
|
2632
|
+
*/
|
|
2633
|
+
export declare const getTask: <ThrowOnError extends boolean = true>(options: Options<GetTaskData, ThrowOnError>) => RequestResult<GetTaskResponses, GetTaskErrors, ThrowOnError, "data">;
|
|
2634
|
+
/**
|
|
2635
|
+
* Update
|
|
2636
|
+
*
|
|
2637
|
+
* Updates a task.
|
|
2638
|
+
*/
|
|
2639
|
+
export declare const updateTask: <ThrowOnError extends boolean = true>(options: Options<UpdateTaskData, ThrowOnError>) => RequestResult<UpdateTaskResponses, UpdateTaskErrors, ThrowOnError, "data">;
|
|
2640
|
+
/**
|
|
2641
|
+
* Set Assignee
|
|
2642
|
+
*
|
|
2643
|
+
* Changes the assignee of a task to a specific user.
|
|
2644
|
+
*
|
|
2645
|
+
* **Note:** The difference with the [Claim Task](https://docs.cibseven.org/manual/2.1/reference/rest/task/post-claim/)
|
|
2646
|
+
* method is that this method does not check if the task already has a user
|
|
2647
|
+
* assigned to it.
|
|
2648
|
+
*/
|
|
2649
|
+
export declare const setAssignee: <ThrowOnError extends boolean = true>(options: Options<SetAssigneeData, ThrowOnError>) => RequestResult<SetAssigneeResponses, SetAssigneeErrors, ThrowOnError, "data">;
|
|
2650
|
+
/**
|
|
2651
|
+
* Get List
|
|
2652
|
+
*
|
|
2653
|
+
* Gets the attachments for a task.
|
|
2654
|
+
*/
|
|
2655
|
+
export declare const getAttachments: <ThrowOnError extends boolean = true>(options: Options<GetAttachmentsData, ThrowOnError>) => RequestResult<GetAttachmentsResponses, GetAttachmentsErrors, ThrowOnError, "data">;
|
|
2656
|
+
/**
|
|
2657
|
+
* Create
|
|
2658
|
+
*
|
|
2659
|
+
* Creates an attachment for a task.
|
|
2660
|
+
*/
|
|
2661
|
+
export declare const addAttachment: <ThrowOnError extends boolean = true>(options: Options<AddAttachmentData, ThrowOnError>) => RequestResult<AddAttachmentResponses, AddAttachmentErrors, ThrowOnError, "data">;
|
|
2662
|
+
/**
|
|
2663
|
+
* Delete
|
|
2664
|
+
*
|
|
2665
|
+
* Removes an attachment from a task by id.
|
|
2666
|
+
*/
|
|
2667
|
+
export declare const deleteAttachment: <ThrowOnError extends boolean = true>(options: Options<DeleteAttachmentData, ThrowOnError>) => RequestResult<DeleteAttachmentResponses, DeleteAttachmentErrors, ThrowOnError, "data">;
|
|
2668
|
+
/**
|
|
2669
|
+
* Get
|
|
2670
|
+
*
|
|
2671
|
+
* Retrieves a task attachment by task id and attachment id.
|
|
2672
|
+
*/
|
|
2673
|
+
export declare const getAttachment: <ThrowOnError extends boolean = true>(options: Options<GetAttachmentData, ThrowOnError>) => RequestResult<GetAttachmentResponses, GetAttachmentErrors, ThrowOnError, "data">;
|
|
2674
|
+
/**
|
|
2675
|
+
* Get (Binary)
|
|
2676
|
+
*
|
|
2677
|
+
* Retrieves the binary content of a task attachment by task id and attachment id.
|
|
2678
|
+
*/
|
|
2679
|
+
export declare const getAttachmentData: <ThrowOnError extends boolean = true>(options: Options<GetAttachmentDataData, ThrowOnError>) => RequestResult<GetAttachmentDataResponses, GetAttachmentDataErrors, ThrowOnError, "data">;
|
|
2680
|
+
/**
|
|
2681
|
+
* Handle BPMN Error
|
|
2682
|
+
*
|
|
2683
|
+
* Reports a business error in the context of a running task by id. The error code must
|
|
2684
|
+
* be specified to identify the BPMN error handler. See the documentation for
|
|
2685
|
+
* [Reporting Bpmn Error](https://docs.cibseven.org/manual/2.1/reference/bpmn20/tasks/user-task/#reporting-bpmn-error)
|
|
2686
|
+
* in User Tasks.
|
|
2687
|
+
*/
|
|
2688
|
+
export declare const handleBpmnError: <ThrowOnError extends boolean = true>(options: Options<HandleBpmnErrorData, ThrowOnError>) => RequestResult<HandleBpmnErrorResponses, HandleBpmnErrorErrors, ThrowOnError, "data">;
|
|
2689
|
+
/**
|
|
2690
|
+
* Handle BPMN Escalation
|
|
2691
|
+
*
|
|
2692
|
+
* Reports an escalation in the context of a running task by id. The escalation code must
|
|
2693
|
+
* be specified to identify the escalation handler. See the documentation for
|
|
2694
|
+
* [Reporting Bpmn Escalation](https://docs.cibseven.org/manual/2.1/reference/bpmn20/tasks/user-task/#reporting-bpmn-escalation)
|
|
2695
|
+
* in User Tasks.
|
|
2696
|
+
*/
|
|
2697
|
+
export declare const handleEscalation: <ThrowOnError extends boolean = true>(options: Options<HandleEscalationData, ThrowOnError>) => RequestResult<HandleEscalationResponses, HandleEscalationErrors, ThrowOnError, "data">;
|
|
2698
|
+
/**
|
|
2699
|
+
* Claim
|
|
2700
|
+
*
|
|
2701
|
+
* Claims a task for a specific user.
|
|
2702
|
+
*
|
|
2703
|
+
* **Note:** The difference with the
|
|
2704
|
+
* [Set Assignee](https://docs.cibseven.org/manual/2.1/reference/rest/task/post-assignee/)
|
|
2705
|
+
* method is that here a check is performed to see if the task already has a user
|
|
2706
|
+
* assigned to it.
|
|
2707
|
+
*/
|
|
2708
|
+
export declare const claim: <ThrowOnError extends boolean = true>(options: Options<ClaimData, ThrowOnError>) => RequestResult<ClaimResponses, ClaimErrors, ThrowOnError, "data">;
|
|
2709
|
+
/**
|
|
2710
|
+
* Delete Task Comments
|
|
2711
|
+
*
|
|
2712
|
+
* Deletes all comments of a task by task id.
|
|
2713
|
+
*/
|
|
2714
|
+
export declare const deleteTaskComments: <ThrowOnError extends boolean = true>(options: Options<DeleteTaskCommentsData, ThrowOnError>) => RequestResult<DeleteTaskCommentsResponses, DeleteTaskCommentsErrors, ThrowOnError, "data">;
|
|
2715
|
+
/**
|
|
2716
|
+
* Get List
|
|
2717
|
+
*
|
|
2718
|
+
* Gets the comments for a task by id.
|
|
2719
|
+
*/
|
|
2720
|
+
export declare const getComments: <ThrowOnError extends boolean = true>(options: Options<GetCommentsData, ThrowOnError>) => RequestResult<GetCommentsResponses, GetCommentsErrors, ThrowOnError, "data">;
|
|
2721
|
+
/**
|
|
2722
|
+
* Update
|
|
2723
|
+
*
|
|
2724
|
+
* Updates a Comment.
|
|
2725
|
+
*/
|
|
2726
|
+
export declare const updateTaskComment: <ThrowOnError extends boolean = true>(options: Options<UpdateTaskCommentData, ThrowOnError>) => RequestResult<UpdateTaskCommentResponses, UpdateTaskCommentErrors, ThrowOnError, "data">;
|
|
2727
|
+
/**
|
|
2728
|
+
* Create
|
|
2729
|
+
*
|
|
2730
|
+
* Creates a comment for a task by id.
|
|
2731
|
+
*/
|
|
2732
|
+
export declare const createComment: <ThrowOnError extends boolean = true>(options: Options<CreateCommentData, ThrowOnError>) => RequestResult<CreateCommentResponses, CreateCommentErrors, ThrowOnError, "data">;
|
|
2733
|
+
/**
|
|
2734
|
+
* Delete
|
|
2735
|
+
*
|
|
2736
|
+
* Removes a comment from a task by id.
|
|
2737
|
+
*/
|
|
2738
|
+
export declare const deleteTaskComment: <ThrowOnError extends boolean = true>(options: Options<DeleteTaskCommentData, ThrowOnError>) => RequestResult<DeleteTaskCommentResponses, DeleteTaskCommentErrors, ThrowOnError, "data">;
|
|
2739
|
+
/**
|
|
2740
|
+
* Get
|
|
2741
|
+
*
|
|
2742
|
+
* Retrieves a task comment by task id and comment id.
|
|
2743
|
+
*/
|
|
2744
|
+
export declare const getComment: <ThrowOnError extends boolean = true>(options: Options<GetCommentData, ThrowOnError>) => RequestResult<GetCommentResponses, GetCommentErrors, ThrowOnError, "data">;
|
|
2745
|
+
/**
|
|
2746
|
+
* Complete
|
|
2747
|
+
*
|
|
2748
|
+
* Completes a task and updates process variables.
|
|
2749
|
+
*/
|
|
2750
|
+
export declare const complete: <ThrowOnError extends boolean = true>(options: Options<CompleteData, ThrowOnError>) => RequestResult<CompleteResponses, CompleteErrors, ThrowOnError, "data">;
|
|
2751
|
+
/**
|
|
2752
|
+
* Delegate
|
|
2753
|
+
*
|
|
2754
|
+
* Delegates a task to another user.
|
|
2755
|
+
*/
|
|
2756
|
+
export declare const delegateTask: <ThrowOnError extends boolean = true>(options: Options<DelegateTaskData, ThrowOnError>) => RequestResult<DelegateTaskResponses, DelegateTaskErrors, ThrowOnError, "data">;
|
|
2757
|
+
/**
|
|
2758
|
+
* Get Deployed Form
|
|
2759
|
+
*
|
|
2760
|
+
* Retrieves the deployed form that is referenced from a given task. For further
|
|
2761
|
+
* information please refer to the
|
|
2762
|
+
* [User Guide](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#embedded-task-forms).
|
|
2763
|
+
*/
|
|
2764
|
+
export declare const getDeployedForm: <ThrowOnError extends boolean = true>(options: Options<GetDeployedFormData, ThrowOnError>) => RequestResult<GetDeployedFormResponses, GetDeployedFormErrors, ThrowOnError, "data">;
|
|
2765
|
+
/**
|
|
2766
|
+
* Get Form Key
|
|
2767
|
+
*
|
|
2768
|
+
* Retrieves the form key for a task. The form key corresponds to the `FormData#formKey`
|
|
2769
|
+
* property in the engine. This key can be used to do task-specific form rendering in
|
|
2770
|
+
* client applications. Additionally, the context path of the containing process
|
|
2771
|
+
* application is returned.
|
|
2772
|
+
*/
|
|
2773
|
+
export declare const getForm: <ThrowOnError extends boolean = true>(options: Options<GetFormData, ThrowOnError>) => RequestResult<GetFormResponses, GetFormErrors, ThrowOnError, "data">;
|
|
2774
|
+
/**
|
|
2775
|
+
* Get Task Form Variables
|
|
2776
|
+
*
|
|
2777
|
+
* Retrieves the form variables for a task. The form variables take form data specified
|
|
2778
|
+
* on the task into account. If form fields are defined, the variable types and default
|
|
2779
|
+
* values of the form fields are taken into account.
|
|
2780
|
+
*/
|
|
2781
|
+
export declare const getFormVariables: <ThrowOnError extends boolean = true>(options: Options<GetFormVariablesData, ThrowOnError>) => RequestResult<GetFormVariablesResponses, GetFormVariablesErrors, ThrowOnError, "data">;
|
|
2782
|
+
/**
|
|
2783
|
+
* Get List
|
|
2784
|
+
*
|
|
2785
|
+
* Gets the identity links for a task by id, which are the users and groups that are in
|
|
2786
|
+
* *some* relation to it (including assignee and owner).
|
|
2787
|
+
*/
|
|
2788
|
+
export declare const getIdentityLinks: <ThrowOnError extends boolean = true>(options: Options<GetIdentityLinksData, ThrowOnError>) => RequestResult<GetIdentityLinksResponses, GetIdentityLinksErrors, ThrowOnError, "data">;
|
|
2789
|
+
/**
|
|
2790
|
+
* Add
|
|
2791
|
+
*
|
|
2792
|
+
* Adds an identity link to a task by id. Can be used to link any user or group to a task
|
|
2793
|
+
* and specify a relation.
|
|
2794
|
+
*/
|
|
2795
|
+
export declare const addIdentityLink: <ThrowOnError extends boolean = true>(options: Options<AddIdentityLinkData, ThrowOnError>) => RequestResult<AddIdentityLinkResponses, AddIdentityLinkErrors, ThrowOnError, "data">;
|
|
2796
|
+
/**
|
|
2797
|
+
* Delete
|
|
2798
|
+
*
|
|
2799
|
+
* Removes an identity link from a task by id
|
|
2800
|
+
*/
|
|
2801
|
+
export declare const deleteIdentityLink: <ThrowOnError extends boolean = true>(options: Options<DeleteIdentityLinkData, ThrowOnError>) => RequestResult<DeleteIdentityLinkResponses, DeleteIdentityLinkErrors, ThrowOnError, "data">;
|
|
2802
|
+
/**
|
|
2803
|
+
* Get Local Task Variables
|
|
2804
|
+
*
|
|
2805
|
+
* Retrieves all variables of a given task by id.
|
|
2806
|
+
*/
|
|
2807
|
+
export declare const getTaskLocalVariables: <ThrowOnError extends boolean = true>(options: Options<GetTaskLocalVariablesData, ThrowOnError>) => RequestResult<GetTaskLocalVariablesResponses, GetTaskLocalVariablesErrors, ThrowOnError, "data">;
|
|
2808
|
+
/**
|
|
2809
|
+
* Update/Delete Local Task Variables
|
|
2810
|
+
*
|
|
2811
|
+
* Updates or deletes the variables in the context of a task. Updates precede deletions. So, if a variable is
|
|
2812
|
+
* updated AND deleted, the deletion overrides the update.
|
|
2813
|
+
*/
|
|
2814
|
+
export declare const modifyTaskLocalVariables: <ThrowOnError extends boolean = true>(options: Options<ModifyTaskLocalVariablesData, ThrowOnError>) => RequestResult<ModifyTaskLocalVariablesResponses, ModifyTaskLocalVariablesErrors, ThrowOnError, "data">;
|
|
2815
|
+
/**
|
|
2816
|
+
* Delete Local Task Variable
|
|
2817
|
+
*
|
|
2818
|
+
* Removes a local variable from a task by id.
|
|
2819
|
+
*/
|
|
2820
|
+
export declare const deleteTaskLocalVariable: <ThrowOnError extends boolean = true>(options: Options<DeleteTaskLocalVariableData, ThrowOnError>) => RequestResult<DeleteTaskLocalVariableResponses, DeleteTaskLocalVariableErrors, ThrowOnError, "data">;
|
|
2821
|
+
/**
|
|
2822
|
+
* Get Local Task Variable
|
|
2823
|
+
*
|
|
2824
|
+
* Retrieves a variable from the context of a given task by id.
|
|
2825
|
+
*/
|
|
2826
|
+
export declare const getTaskLocalVariable: <ThrowOnError extends boolean = true>(options: Options<GetTaskLocalVariableData, ThrowOnError>) => RequestResult<GetTaskLocalVariableResponses, GetTaskLocalVariableErrors, ThrowOnError, "data">;
|
|
2827
|
+
/**
|
|
2828
|
+
* Update Local Task Variable
|
|
2829
|
+
*
|
|
2830
|
+
* Sets a variable in the context of a given task.
|
|
2831
|
+
*/
|
|
2832
|
+
export declare const putTaskLocalVariable: <ThrowOnError extends boolean = true>(options: Options<PutTaskLocalVariableData, ThrowOnError>) => RequestResult<PutTaskLocalVariableResponses, PutTaskLocalVariableErrors, ThrowOnError, "data">;
|
|
2833
|
+
/**
|
|
2834
|
+
* Get Local Task Variable (Binary)
|
|
2835
|
+
*
|
|
2836
|
+
* Retrieves a binary variable from the context of a given task by id. Applicable for byte array and file
|
|
2837
|
+
* variables.
|
|
2838
|
+
*/
|
|
2839
|
+
export declare const getTaskLocalVariableBinary: <ThrowOnError extends boolean = true>(options: Options<GetTaskLocalVariableBinaryData, ThrowOnError>) => RequestResult<GetTaskLocalVariableBinaryResponses, GetTaskLocalVariableBinaryErrors, ThrowOnError, "data">;
|
|
2840
|
+
/**
|
|
2841
|
+
* Update Local Task Variable (Binary)
|
|
2842
|
+
*
|
|
2843
|
+
* Sets the serialized value for a binary variable or the binary value for a file variable.
|
|
2844
|
+
*/
|
|
2845
|
+
export declare const setBinaryTaskLocalVariable: <ThrowOnError extends boolean = true>(options: Options<SetBinaryTaskLocalVariableData, ThrowOnError>) => RequestResult<SetBinaryTaskLocalVariableResponses, SetBinaryTaskLocalVariableErrors, ThrowOnError, "data">;
|
|
2846
|
+
/**
|
|
2847
|
+
* Get Rendered Form
|
|
2848
|
+
*
|
|
2849
|
+
* Retrieves the rendered form for a task. This method can be used to get the HTML
|
|
2850
|
+
* rendering of a
|
|
2851
|
+
* [Generated Task Form](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/#generated-task-forms).
|
|
2852
|
+
*/
|
|
2853
|
+
export declare const getRenderedForm: <ThrowOnError extends boolean = true>(options: Options<GetRenderedFormData, ThrowOnError>) => RequestResult<GetRenderedFormResponses, GetRenderedFormErrors, ThrowOnError, "data">;
|
|
2854
|
+
/**
|
|
2855
|
+
* Resolve
|
|
2856
|
+
*
|
|
2857
|
+
* Resolves a task and updates execution variables.
|
|
2858
|
+
*
|
|
2859
|
+
* Resolving a task marks that the assignee is done with the task delegated to them, and
|
|
2860
|
+
* that it can be sent back to the owner. Can only be executed when the task has been
|
|
2861
|
+
* delegated. The assignee will be set to the owner, who performed the delegation.
|
|
2862
|
+
*/
|
|
2863
|
+
export declare const resolve: <ThrowOnError extends boolean = true>(options: Options<ResolveData, ThrowOnError>) => RequestResult<ResolveResponses, ResolveErrors, ThrowOnError, "data">;
|
|
2864
|
+
/**
|
|
2865
|
+
* Submit Form
|
|
2866
|
+
*
|
|
2867
|
+
* Completes a task and updates process variables using a form submit. There are two
|
|
2868
|
+
* difference between this method and the `complete` method:
|
|
2869
|
+
*
|
|
2870
|
+
* * If the task is in state `PENDING` - i.e., has been delegated before, it is not
|
|
2871
|
+
* completed but resolved. Otherwise it will be completed.
|
|
2872
|
+
* * If the task has Form Field Metadata defined, the process engine will perform backend
|
|
2873
|
+
* validation for any form fields which have validators defined.
|
|
2874
|
+
* See the
|
|
2875
|
+
* [Generated Task Forms](https://docs.cibseven.org/manual/2.1/user-guide/task-forms/_index/#generated-task-forms)
|
|
2876
|
+
* section of the [User Guide](https://docs.cibseven.org/manual/2.1/user-guide/) for more information.
|
|
2877
|
+
*/
|
|
2878
|
+
export declare const submit: <ThrowOnError extends boolean = true>(options: Options<SubmitData, ThrowOnError>) => RequestResult<SubmitResponses, SubmitErrors, ThrowOnError, "data">;
|
|
2879
|
+
/**
|
|
2880
|
+
* Unclaim
|
|
2881
|
+
*
|
|
2882
|
+
* Resets a task's assignee. If successful, the task is not assigned to a user.
|
|
2883
|
+
*/
|
|
2884
|
+
export declare const unclaim: <ThrowOnError extends boolean = true>(options: Options<UnclaimData, ThrowOnError>) => RequestResult<UnclaimResponses, UnclaimErrors, ThrowOnError, "data">;
|
|
2885
|
+
/**
|
|
2886
|
+
* Get Task Variables
|
|
2887
|
+
*
|
|
2888
|
+
* Retrieves all variables visible from the task. A variable is visible from the task if it is a local task
|
|
2889
|
+
* variable or declared in a parent scope of the task. See documentation on
|
|
2890
|
+
* [visiblity of variables](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/variables/).
|
|
2891
|
+
*/
|
|
2892
|
+
export declare const getTaskVariables: <ThrowOnError extends boolean = true>(options: Options<GetTaskVariablesData, ThrowOnError>) => RequestResult<GetTaskVariablesResponses, GetTaskVariablesErrors, ThrowOnError, "data">;
|
|
2893
|
+
/**
|
|
2894
|
+
* Update/Delete Task Variables
|
|
2895
|
+
*
|
|
2896
|
+
* Updates or deletes the variables visible from the task. Updates precede deletions. So, if a variable is
|
|
2897
|
+
* updated AND deleted, the deletion overrides the update. A variable is visible from the task if it is a
|
|
2898
|
+
* local task variable or declared in a parent scope of the task. See documentation on
|
|
2899
|
+
* [visiblity of variables](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/variables/).
|
|
2900
|
+
*/
|
|
2901
|
+
export declare const modifyTaskVariables: <ThrowOnError extends boolean = true>(options: Options<ModifyTaskVariablesData, ThrowOnError>) => RequestResult<ModifyTaskVariablesResponses, ModifyTaskVariablesErrors, ThrowOnError, "data">;
|
|
2902
|
+
/**
|
|
2903
|
+
* Delete Task Variable
|
|
2904
|
+
*
|
|
2905
|
+
* Removes a variable that is visible to a task. A variable is visible to a task if it is a local task
|
|
2906
|
+
* variable or declared in a parent scope of the task. See documentation on
|
|
2907
|
+
* [visiblity of variables](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/variables/).
|
|
2908
|
+
*/
|
|
2909
|
+
export declare const deleteTaskVariable: <ThrowOnError extends boolean = true>(options: Options<DeleteTaskVariableData, ThrowOnError>) => RequestResult<DeleteTaskVariableResponses, DeleteTaskVariableErrors, ThrowOnError, "data">;
|
|
2910
|
+
/**
|
|
2911
|
+
* Get Task Variable
|
|
2912
|
+
*
|
|
2913
|
+
* Retrieves a variable from the context of a given task.
|
|
2914
|
+
* The variable must be visible from the task. It is visible from the task if it is a local task variable or
|
|
2915
|
+
* declared in a parent scope of the task. See documentation on
|
|
2916
|
+
* [visiblity of variables](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/variables/).
|
|
2917
|
+
*/
|
|
2918
|
+
export declare const getTaskVariable: <ThrowOnError extends boolean = true>(options: Options<GetTaskVariableData, ThrowOnError>) => RequestResult<GetTaskVariableResponses, GetTaskVariableErrors, ThrowOnError, "data">;
|
|
2919
|
+
/**
|
|
2920
|
+
* Update Task Variable
|
|
2921
|
+
*
|
|
2922
|
+
* Updates a process variable that is visible from the Task scope. A variable is visible from the task if it
|
|
2923
|
+
* is a local task variable, or declared in a parent scope of the task. See the documentation on
|
|
2924
|
+
* [variable scopes and visibility](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/variables#variable-scopes-and-variable-visibility).
|
|
2925
|
+
*
|
|
2926
|
+
* **Note**: If a variable doesn't exist, the variable is created in the top-most scope
|
|
2927
|
+
* visible from the task.
|
|
2928
|
+
*/
|
|
2929
|
+
export declare const putTaskVariable: <ThrowOnError extends boolean = true>(options: Options<PutTaskVariableData, ThrowOnError>) => RequestResult<PutTaskVariableResponses, PutTaskVariableErrors, ThrowOnError, "data">;
|
|
2930
|
+
/**
|
|
2931
|
+
* Get Task Variable (Binary)
|
|
2932
|
+
*
|
|
2933
|
+
* Retrieves a binary variable from the context of a given task. Applicable for byte array and file
|
|
2934
|
+
* variables. The variable must be visible from the task. It is visible from the task if it is a local task
|
|
2935
|
+
* variable or declared in a parent scope of the task. See documentation on
|
|
2936
|
+
* [visiblity of variables](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/variables/).
|
|
2937
|
+
*/
|
|
2938
|
+
export declare const getTaskVariableBinary: <ThrowOnError extends boolean = true>(options: Options<GetTaskVariableBinaryData, ThrowOnError>) => RequestResult<GetTaskVariableBinaryResponses, GetTaskVariableBinaryErrors, ThrowOnError, "data">;
|
|
2939
|
+
/**
|
|
2940
|
+
* Update Task Variable (Binary)
|
|
2941
|
+
*
|
|
2942
|
+
* Sets the serialized value for a binary variable or the binary value for a file variable visible from the
|
|
2943
|
+
* task. A variable is visible from the task if it is a local task variable or declared in a parent scope of
|
|
2944
|
+
* the task. See documentation on
|
|
2945
|
+
* [visiblity of variables](https://docs.cibseven.org/manual/2.1/user-guide/process-engine/variables/).
|
|
2946
|
+
*/
|
|
2947
|
+
export declare const setBinaryTaskVariable: <ThrowOnError extends boolean = true>(options: Options<SetBinaryTaskVariableData, ThrowOnError>) => RequestResult<SetBinaryTaskVariableResponses, SetBinaryTaskVariableErrors, ThrowOnError, "data">;
|
|
2948
|
+
/**
|
|
2949
|
+
* Fetch Telemetry Configuration
|
|
2950
|
+
*
|
|
2951
|
+
* Fetches Telemetry Configuration.
|
|
2952
|
+
*/
|
|
2953
|
+
export declare const getTelemetryConfiguration: <ThrowOnError extends boolean = true>(options?: Options<GetTelemetryConfigurationData, ThrowOnError>) => RequestResult<GetTelemetryConfigurationResponses, GetTelemetryConfigurationErrors, ThrowOnError, "data">;
|
|
2954
|
+
/**
|
|
2955
|
+
* Configure Telemetry
|
|
2956
|
+
*
|
|
2957
|
+
* Deprecated: The sending telemetry feature is removed. Please remove the endpoint usages as they are no longer needed.
|
|
2958
|
+
*
|
|
2959
|
+
* @deprecated
|
|
2960
|
+
*/
|
|
2961
|
+
export declare const configureTelemetry: <ThrowOnError extends boolean = true>(options?: Options<ConfigureTelemetryData, ThrowOnError>) => RequestResult<ConfigureTelemetryResponses, ConfigureTelemetryErrors, ThrowOnError, "data">;
|
|
2962
|
+
/**
|
|
2963
|
+
* Fetch Telemetry Data
|
|
2964
|
+
*
|
|
2965
|
+
* Deprecated: Always returns false. The sending telemetry feature is removed. Please remove the endpoint usages as they are no longer needed.
|
|
2966
|
+
*
|
|
2967
|
+
* @deprecated
|
|
2968
|
+
*/
|
|
2969
|
+
export declare const getTelemetryData: <ThrowOnError extends boolean = true>(options?: Options<GetTelemetryDataData, ThrowOnError>) => RequestResult<GetTelemetryDataResponses, unknown, ThrowOnError, "data">;
|
|
2970
|
+
/**
|
|
2971
|
+
* Get Tenants
|
|
2972
|
+
*
|
|
2973
|
+
* Query for a list of tenants using a list of parameters. The size of the result set
|
|
2974
|
+
* can be retrieved by using the [Get Tenant
|
|
2975
|
+
* Count](https://docs.cibseven.org/manual/2.1/reference/rest/tenant/get-query-count/) method.
|
|
2976
|
+
*/
|
|
2977
|
+
export declare const queryTenants: <ThrowOnError extends boolean = true>(options?: Options<QueryTenantsData, ThrowOnError>) => RequestResult<QueryTenantsResponses, QueryTenantsErrors, ThrowOnError, "data">;
|
|
2978
|
+
/**
|
|
2979
|
+
* Tenant Resource Options
|
|
2980
|
+
*
|
|
2981
|
+
* The `/tenant` resource supports two custom OPTIONS requests, this one for the resource
|
|
2982
|
+
* as such and one for individual tenant instances. The OPTIONS request
|
|
2983
|
+
* allows checking for the set of available operations that the currently
|
|
2984
|
+
* authenticated user can perform on the `/tenant` resource. If the user
|
|
2985
|
+
* can perform an operation or not may depend on various things,
|
|
2986
|
+
* including the users authorizations to interact with this resource and
|
|
2987
|
+
* the internal configuration of the process engine.
|
|
2988
|
+
*/
|
|
2989
|
+
export declare const availableTenantResourceOperations: <ThrowOnError extends boolean = true>(options?: Options<AvailableTenantResourceOperationsData, ThrowOnError>) => RequestResult<AvailableTenantResourceOperationsResponses, unknown, ThrowOnError, "data">;
|
|
2990
|
+
/**
|
|
2991
|
+
* Get Tenant Count
|
|
2992
|
+
*
|
|
2993
|
+
* Query for tenants using a list of parameters and retrieves the count.
|
|
2994
|
+
*/
|
|
2995
|
+
export declare const getTenantCount: <ThrowOnError extends boolean = true>(options?: Options<GetTenantCountData, ThrowOnError>) => RequestResult<GetTenantCountResponses, GetTenantCountErrors, ThrowOnError, "data">;
|
|
2996
|
+
/**
|
|
2997
|
+
* Create Tenant
|
|
2998
|
+
*
|
|
2999
|
+
* Create a new tenant.
|
|
3000
|
+
*/
|
|
3001
|
+
export declare const createTenant: <ThrowOnError extends boolean = true>(options?: Options<CreateTenantData, ThrowOnError>) => RequestResult<CreateTenantResponses, CreateTenantErrors, ThrowOnError, "data">;
|
|
3002
|
+
/**
|
|
3003
|
+
* Delete Tenant
|
|
3004
|
+
*
|
|
3005
|
+
* Deletes a tenant by id.
|
|
3006
|
+
*/
|
|
3007
|
+
export declare const deleteTenant: <ThrowOnError extends boolean = true>(options: Options<DeleteTenantData, ThrowOnError>) => RequestResult<DeleteTenantResponses, DeleteTenantErrors, ThrowOnError, "data">;
|
|
3008
|
+
/**
|
|
3009
|
+
* Get Tenant
|
|
3010
|
+
*
|
|
3011
|
+
* Retrieves a tenant.
|
|
3012
|
+
*/
|
|
3013
|
+
export declare const getTenant: <ThrowOnError extends boolean = true>(options: Options<GetTenantData, ThrowOnError>) => RequestResult<GetTenantResponses, GetTenantErrors, ThrowOnError, "data">;
|
|
3014
|
+
/**
|
|
3015
|
+
* Tenant Resource Options
|
|
3016
|
+
*
|
|
3017
|
+
* The `/tenant` resource supports two custom OPTIONS requests, one for the resource as such and this one for
|
|
3018
|
+
* individual tenant instances. The OPTIONS request allows checking for the set of available operations that
|
|
3019
|
+
* the currently authenticated user can perform on the `/tenant/{id}` resource. If the user can perform an
|
|
3020
|
+
* operation or not may depend on various things, including the users authorizations to interact with this
|
|
3021
|
+
* resource and the internal configuration of the process engine.
|
|
3022
|
+
*/
|
|
3023
|
+
export declare const availableTenantInstanceOperations: <ThrowOnError extends boolean = true>(options: Options<AvailableTenantInstanceOperationsData, ThrowOnError>) => RequestResult<AvailableTenantInstanceOperationsResponses, unknown, ThrowOnError, "data">;
|
|
3024
|
+
/**
|
|
3025
|
+
* Update Tenant
|
|
3026
|
+
*
|
|
3027
|
+
* Updates a given tenant.
|
|
3028
|
+
*/
|
|
3029
|
+
export declare const updateTenant: <ThrowOnError extends boolean = true>(options: Options<UpdateTenantData, ThrowOnError>) => RequestResult<UpdateTenantResponses, UpdateTenantErrors, ThrowOnError, "data">;
|
|
3030
|
+
/**
|
|
3031
|
+
* Tenant Group Membership Resource Options
|
|
3032
|
+
*
|
|
3033
|
+
* The OPTIONS request allows checking for the set of available operations that the
|
|
3034
|
+
* currently authenticated user can perform on the resource. If the user
|
|
3035
|
+
* can perform an operation or not may depend on various things,
|
|
3036
|
+
* including the users authorizations to interact with this resource and
|
|
3037
|
+
* the internal configuration of the process engine.
|
|
3038
|
+
*/
|
|
3039
|
+
export declare const availableTenantGroupMembersOperations: <ThrowOnError extends boolean = true>(options: Options<AvailableTenantGroupMembersOperationsData, ThrowOnError>) => RequestResult<AvailableTenantGroupMembersOperationsResponses, unknown, ThrowOnError, "data">;
|
|
3040
|
+
/**
|
|
3041
|
+
* Delete Tenant Group Membership
|
|
3042
|
+
*
|
|
3043
|
+
* Deletes a membership between a tenant and a group.
|
|
3044
|
+
*/
|
|
3045
|
+
export declare const deleteGroupMembership: <ThrowOnError extends boolean = true>(options: Options<DeleteGroupMembershipData, ThrowOnError>) => RequestResult<DeleteGroupMembershipResponses, DeleteGroupMembershipErrors, ThrowOnError, "data">;
|
|
3046
|
+
/**
|
|
3047
|
+
* Create Tenant Group Membership
|
|
3048
|
+
*
|
|
3049
|
+
* Creates a membership between a tenant and a group.
|
|
3050
|
+
*/
|
|
3051
|
+
export declare const createGroupMembership: <ThrowOnError extends boolean = true>(options: Options<CreateGroupMembershipData, ThrowOnError>) => RequestResult<CreateGroupMembershipResponses, CreateGroupMembershipErrors, ThrowOnError, "data">;
|
|
3052
|
+
/**
|
|
3053
|
+
* Tenant User Membership Resource Options
|
|
3054
|
+
*
|
|
3055
|
+
* The OPTIONS request allows checking for the set of available operations that the
|
|
3056
|
+
* currently authenticated user can perform on the resource. If the user
|
|
3057
|
+
* can perform an operation or not may depend on various things,
|
|
3058
|
+
* including the users authorizations to interact with this resource and
|
|
3059
|
+
* the internal configuration of the process engine.
|
|
3060
|
+
*/
|
|
3061
|
+
export declare const availableTenantUserMembersOperations: <ThrowOnError extends boolean = true>(options: Options<AvailableTenantUserMembersOperationsData, ThrowOnError>) => RequestResult<AvailableTenantUserMembersOperationsResponses, unknown, ThrowOnError, "data">;
|
|
3062
|
+
/**
|
|
3063
|
+
* Delete a Tenant User Membership
|
|
3064
|
+
*
|
|
3065
|
+
* Deletes a membership between a tenant and an user.
|
|
3066
|
+
*/
|
|
3067
|
+
export declare const deleteUserMembership: <ThrowOnError extends boolean = true>(options: Options<DeleteUserMembershipData, ThrowOnError>) => RequestResult<DeleteUserMembershipResponses, DeleteUserMembershipErrors, ThrowOnError, "data">;
|
|
3068
|
+
/**
|
|
3069
|
+
* Create Tenant User Membership
|
|
3070
|
+
*
|
|
3071
|
+
* Creates a membership between a tenant and an user.
|
|
3072
|
+
*/
|
|
3073
|
+
export declare const createUserMembership: <ThrowOnError extends boolean = true>(options: Options<CreateUserMembershipData, ThrowOnError>) => RequestResult<CreateUserMembershipResponses, CreateUserMembershipErrors, ThrowOnError, "data">;
|
|
3074
|
+
/**
|
|
3075
|
+
* Get List
|
|
3076
|
+
*
|
|
3077
|
+
* Query for a list of users using a list of parameters.
|
|
3078
|
+
* The size of the result set can be retrieved by using the Get User Count method.
|
|
3079
|
+
* [Get User Count](https://docs.cibseven.org/manual/2.1/reference/rest/user/get-query-count/) method.
|
|
3080
|
+
*/
|
|
3081
|
+
export declare const getUsers: <ThrowOnError extends boolean = true>(options?: Options<GetUsersData, ThrowOnError>) => RequestResult<GetUsersResponses, GetUsersErrors, ThrowOnError, "data">;
|
|
3082
|
+
/**
|
|
3083
|
+
* Options
|
|
3084
|
+
*
|
|
3085
|
+
* The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such
|
|
3086
|
+
* and one for individual user instances. The `OPTIONS` request allows checking for the set of
|
|
3087
|
+
* available operations that the currently authenticated user can perform on the /user resource.
|
|
3088
|
+
* If the user can perform an operation or not may depend on various things, including the user's
|
|
3089
|
+
* authorizations to interact with this resource and the internal configuration of the process
|
|
3090
|
+
* engine. `OPTIONS /user` returns available interactions on the resource.
|
|
3091
|
+
*/
|
|
3092
|
+
export declare const availableOperations: <ThrowOnError extends boolean = true>(options?: Options<AvailableOperationsData, ThrowOnError>) => RequestResult<AvailableOperationsResponses, unknown, ThrowOnError, "data">;
|
|
3093
|
+
/**
|
|
3094
|
+
* Get List Count
|
|
3095
|
+
*
|
|
3096
|
+
* Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the
|
|
3097
|
+
* [Get Users](https://docs.cibseven.org/manual/2.1/reference/rest/user/get-query/) method.
|
|
3098
|
+
*/
|
|
3099
|
+
export declare const getUserCount: <ThrowOnError extends boolean = true>(options?: Options<GetUserCountData, ThrowOnError>) => RequestResult<GetUserCountResponses, GetUserCountErrors, ThrowOnError, "data">;
|
|
3100
|
+
/**
|
|
3101
|
+
* Create
|
|
3102
|
+
*
|
|
3103
|
+
* Create a new user.
|
|
3104
|
+
*/
|
|
3105
|
+
export declare const createUser: <ThrowOnError extends boolean = true>(options?: Options<CreateUserData, ThrowOnError>) => RequestResult<CreateUserResponses, unknown, ThrowOnError, "data">;
|
|
3106
|
+
/**
|
|
3107
|
+
* Delete
|
|
3108
|
+
*
|
|
3109
|
+
* Deletes a user by id.
|
|
3110
|
+
*/
|
|
3111
|
+
export declare const deleteUser: <ThrowOnError extends boolean = true>(options: Options<DeleteUserData, ThrowOnError>) => RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError, "data">;
|
|
3112
|
+
/**
|
|
3113
|
+
* Options
|
|
3114
|
+
*
|
|
3115
|
+
* The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such
|
|
3116
|
+
* and one for individual user instances. The `OPTIONS` request allows checking for the set of
|
|
3117
|
+
* available operations that the currently authenticated user can perform on the /user resource.
|
|
3118
|
+
* If the user can perform an operation or not may depend on various things, including the user's
|
|
3119
|
+
* authorizations to interact with this resource and the internal configuration of the process
|
|
3120
|
+
* engine. `OPTIONS /user/{id}` returns available interactions on a resource instance.
|
|
3121
|
+
*/
|
|
3122
|
+
export declare const availableUserOperations: <ThrowOnError extends boolean = true>(options: Options<AvailableUserOperationsData, ThrowOnError>) => RequestResult<AvailableUserOperationsResponses, unknown, ThrowOnError, "data">;
|
|
3123
|
+
/**
|
|
3124
|
+
* Update Credentials
|
|
3125
|
+
*
|
|
3126
|
+
* Updates a user's credentials (password)
|
|
3127
|
+
*/
|
|
3128
|
+
export declare const updateCredentials: <ThrowOnError extends boolean = true>(options: Options<UpdateCredentialsData, ThrowOnError>) => RequestResult<UpdateCredentialsResponses, UpdateCredentialsErrors, ThrowOnError, "data">;
|
|
3129
|
+
/**
|
|
3130
|
+
* Get Profile
|
|
3131
|
+
*
|
|
3132
|
+
* Retrieves a user's profile.
|
|
3133
|
+
*/
|
|
3134
|
+
export declare const getUserProfile: <ThrowOnError extends boolean = true>(options: Options<GetUserProfileData, ThrowOnError>) => RequestResult<GetUserProfileResponses, GetUserProfileErrors, ThrowOnError, "data">;
|
|
3135
|
+
/**
|
|
3136
|
+
* Update User Profile
|
|
3137
|
+
*
|
|
3138
|
+
* Updates the profile information of an already existing user.
|
|
3139
|
+
*/
|
|
3140
|
+
export declare const updateProfile: <ThrowOnError extends boolean = true>(options: Options<UpdateProfileData, ThrowOnError>) => RequestResult<UpdateProfileResponses, UpdateProfileErrors, ThrowOnError, "data">;
|
|
3141
|
+
/**
|
|
3142
|
+
* Unlock User
|
|
3143
|
+
*
|
|
3144
|
+
* Unlocks a user by id.
|
|
3145
|
+
*/
|
|
3146
|
+
export declare const unlockUser: <ThrowOnError extends boolean = true>(options: Options<UnlockUserData, ThrowOnError>) => RequestResult<UnlockUserResponses, UnlockUserErrors, ThrowOnError, "data">;
|
|
3147
|
+
/**
|
|
3148
|
+
* Get Variable Instances
|
|
3149
|
+
*
|
|
3150
|
+
* Query for variable instances that fulfill given parameters. Parameters may be the
|
|
3151
|
+
* properties of variable instances, such as the name or type. The size
|
|
3152
|
+
* of the result set can be retrieved by using the [Get Variable Instance
|
|
3153
|
+
* Count](https://docs.cibseven.org/manual/2.1/reference/rest/variable-instance/get-query-count/)
|
|
3154
|
+
* method.
|
|
3155
|
+
*/
|
|
3156
|
+
export declare const getVariableInstances: <ThrowOnError extends boolean = true>(options?: Options<GetVariableInstancesData, ThrowOnError>) => RequestResult<GetVariableInstancesResponses, GetVariableInstancesErrors, ThrowOnError, "data">;
|
|
3157
|
+
/**
|
|
3158
|
+
* Get Variable Instances (POST)
|
|
3159
|
+
*
|
|
3160
|
+
* Query for variable instances that fulfill given parameters through a JSON object.
|
|
3161
|
+
* This method is slightly more powerful than the
|
|
3162
|
+
* [Get Variable Instances](https://docs.cibseven.org/manual/2.1/reference/rest/variable-
|
|
3163
|
+
* instance/get-query/) method because it allows filtering by multiple
|
|
3164
|
+
* variable instances of types `String`, `Number` or `Boolean`.
|
|
3165
|
+
*/
|
|
3166
|
+
export declare const queryVariableInstances: <ThrowOnError extends boolean = true>(options?: Options<QueryVariableInstancesData, ThrowOnError>) => RequestResult<QueryVariableInstancesResponses, QueryVariableInstancesErrors, ThrowOnError, "data">;
|
|
3167
|
+
/**
|
|
3168
|
+
* Get Variable Instance Count
|
|
3169
|
+
*
|
|
3170
|
+
* Query for the number of variable instances that fulfill given parameters. Takes the
|
|
3171
|
+
* same parameters as the [Get Variable
|
|
3172
|
+
* Instances](https://docs.cibseven.org/manual/2.1/reference/rest/variable-instance/get-query/)
|
|
3173
|
+
* method.
|
|
3174
|
+
*/
|
|
3175
|
+
export declare const getVariableInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<GetVariableInstancesCountData, ThrowOnError>) => RequestResult<GetVariableInstancesCountResponses, GetVariableInstancesCountErrors, ThrowOnError, "data">;
|
|
3176
|
+
/**
|
|
3177
|
+
* Get Variable Instance Count (POST)
|
|
3178
|
+
*
|
|
3179
|
+
* Query for the number of variable instances that fulfill given parameters. This
|
|
3180
|
+
* method takes the same message body as the
|
|
3181
|
+
* [Get Variable Instances POST](https://docs.cibseven.org/manual/2.1/reference/rest/variable-
|
|
3182
|
+
* instance/post-query/) method and therefore it is slightly more
|
|
3183
|
+
* powerful than the [Get Variable Instance
|
|
3184
|
+
* Count](https://docs.cibseven.org/manual/2.1/reference/rest/variable-instance/get-query-count/)
|
|
3185
|
+
* method.
|
|
3186
|
+
*/
|
|
3187
|
+
export declare const queryVariableInstancesCount: <ThrowOnError extends boolean = true>(options?: Options<QueryVariableInstancesCountData, ThrowOnError>) => RequestResult<QueryVariableInstancesCountResponses, QueryVariableInstancesCountErrors, ThrowOnError, "data">;
|
|
3188
|
+
/**
|
|
3189
|
+
* Get Variable Instance
|
|
3190
|
+
*
|
|
3191
|
+
* Retrieves a variable by id.
|
|
3192
|
+
*/
|
|
3193
|
+
export declare const getVariableInstance: <ThrowOnError extends boolean = true>(options: Options<GetVariableInstanceData, ThrowOnError>) => RequestResult<GetVariableInstanceResponses, GetVariableInstanceErrors, ThrowOnError, "data">;
|
|
3194
|
+
/**
|
|
3195
|
+
* Get Variable Instance (Binary)
|
|
3196
|
+
*
|
|
3197
|
+
* Retrieves the content of a variable by id. Applicable for byte array and file
|
|
3198
|
+
* variables.
|
|
3199
|
+
*/
|
|
3200
|
+
export declare const getVariableInstanceBinary: <ThrowOnError extends boolean = true>(options: Options<GetVariableInstanceBinaryData, ThrowOnError>) => RequestResult<GetVariableInstanceBinaryResponses, GetVariableInstanceBinaryErrors, ThrowOnError, "data">;
|
|
3201
|
+
/**
|
|
3202
|
+
* Get Rest API version
|
|
3203
|
+
*
|
|
3204
|
+
* Retrieves the version of the Rest API.
|
|
3205
|
+
*/
|
|
3206
|
+
export declare const getRestApiVersion: <ThrowOnError extends boolean = true>(options?: Options<GetRestApiVersionData, ThrowOnError>) => RequestResult<GetRestApiVersionResponses, unknown, ThrowOnError, "data">;
|
|
3207
|
+
//# sourceMappingURL=sdk.gen.d.ts.map
|