/// <summary>
/// Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event. Internally this maps to the engine's message correlation builder methods `MessageCorrelationBuilder#correlateWithResult()` and `MessageCorrelationBuilder#correlateAllWithResult()`. For more information about the correlation behavior, see the [Message Events](https://docs.camunda.org/manual/7.14/bpmn20/events/message-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.14/reference/bpmn20/).
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="correlationMessageDto"> (optional)</param>
/// <returns>List<MessageCorrelationResultWithVariableDto></returns>
public List <MessageCorrelationResultWithVariableDto> DeliverMessage(CorrelationMessageDto correlationMessageDto = default(CorrelationMessageDto))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <MessageCorrelationResultWithVariableDto> > localVarResponse = DeliverMessageWithHttpInfo(correlationMessageDto);
return(localVarResponse.Data);
}
/// <summary>
/// Gets the comments for a task by id.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">The id of the task to retrieve the comments for.</param>
/// <returns>List<CommentDto></returns>
public List <CommentDto> GetComments(string id)
{
Camunda.OpenApi.Client.Client.ApiResponse <List <CommentDto> > localVarResponse = GetCommentsWithHttpInfo(id);
return(localVarResponse.Data);
}
/// <summary>
/// Gets the comments for a task by id.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">The id of the task to retrieve the comments for.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of List<CommentDto></returns>
public async System.Threading.Tasks.Task <List <CommentDto> > GetCommentsAsync(string id, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <CommentDto> > localVarResponse = await GetCommentsWithHttpInfoAsync(id, cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Triggers evaluation of conditions for conditional start event(s). Internally this maps to the engines condition evaluation builder method ConditionEvaluationBuilder#evaluateStartConditions(). For more information see the [Conditional Start Events](https://docs.camunda.org/manual/7.14/reference/bpmn20/events/conditional-events/#conditional-start-event) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.14/reference/bpmn20/).
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="evaluationConditionDto"> (optional)</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of List<ProcessInstanceDto></returns>
public async System.Threading.Tasks.Task <List <ProcessInstanceDto> > EvaluateConditionAsync(EvaluationConditionDto evaluationConditionDto = default(EvaluationConditionDto), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <ProcessInstanceDto> > localVarResponse = await EvaluateConditionWithHttpInfoAsync(evaluationConditionDto, cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Retrieves a task comment by task id and comment id.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">The id of the task.</param>
/// <param name="commentId">The id of the comment to be retrieved.</param>
/// <returns>CommentDto</returns>
public CommentDto GetComment(string id, string commentId)
{
Camunda.OpenApi.Client.Client.ApiResponse <CommentDto> localVarResponse = GetCommentWithHttpInfo(id, commentId);
return(localVarResponse.Data);
}
/// <summary>
/// Retrieves the names of all process engines available on your platform. **Note**: You cannot prepend `/engine/{name}` to this method.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of List<ProcessEngineDto></returns>
public async System.Threading.Tasks.Task <List <ProcessEngineDto> > GetProcessEngineNamesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <ProcessEngineDto> > localVarResponse = await GetProcessEngineNamesWithHttpInfoAsync(cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Fetch Telemetry Configuration Fetches Telemetry Configuration.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>TelemetryConfigurationDto</returns>
public TelemetryConfigurationDto GetTelemetryConfiguration()
{
Camunda.OpenApi.Client.Client.ApiResponse <TelemetryConfigurationDto> localVarResponse = GetTelemetryConfigurationWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Retrieves the `sum` (count) for a given metric.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="metricsName">The name of the metric.</param>
/// <param name="startDate">The start date (inclusive). (optional)</param>
/// <param name="endDate">The end date (exclusive). (optional)</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of MetricsResultDto</returns>
public async System.Threading.Tasks.Task <MetricsResultDto> GetMetricsAsync(string metricsName, DateTime?startDate = default(DateTime?), DateTime?endDate = default(DateTime?), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
Camunda.OpenApi.Client.Client.ApiResponse <MetricsResultDto> localVarResponse = await GetMetricsWithHttpInfoAsync(metricsName, startDate, endDate, cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Retrieves a list of metrics, aggregated for a given interval.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="name">The name of the metric. (optional)</param>
/// <param name="reporter">The name of the reporter (host), on which the metrics was logged. This will have value provided by the [hostname configuration property](https://docs.camunda.org/manual/7.14/reference/deployment-descriptors/tags/process-engine/#hostname). (optional)</param>
/// <param name="startDate">The start date (inclusive). (optional)</param>
/// <param name="endDate">The end date (exclusive). (optional)</param>
/// <param name="firstResult">Pagination of results. Specifies the index of the first result to return. (optional)</param>
/// <param name="maxResults">Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)</param>
/// <param name="interval">The interval for which the metrics should be aggregated. Time unit is seconds. Default: The interval is set to 15 minutes (900 seconds). (optional, default to "900")</param>
/// <param name="aggregateByReporter">Aggregate metrics by reporter. (optional)</param>
/// <returns>List<MetricsIntervalResultDto></returns>
public List <MetricsIntervalResultDto> Interval(string name = default(string), string reporter = default(string), DateTime?startDate = default(DateTime?), DateTime?endDate = default(DateTime?), int?firstResult = default(int?), int?maxResults = default(int?), string interval = default(string), string aggregateByReporter = default(string))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <MetricsIntervalResultDto> > localVarResponse = IntervalWithHttpInfo(name, reporter, startDate, endDate, firstResult, maxResults, interval, aggregateByReporter);
return(localVarResponse.Data);
}
/// <summary>
/// Gets the identity links for a task by id, which are the users and groups that are in *some* relation to it (including assignee and owner).
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">The id of the task to retrieve the identity links for.</param>
/// <param name="type">Filter by the type of links to include. (optional)</param>
/// <returns>List<IdentityLinkDto></returns>
public List <IdentityLinkDto> GetIdentityLinks(string id, string type = default(string))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <IdentityLinkDto> > localVarResponse = GetIdentityLinksWithHttpInfo(id, type);
return(localVarResponse.Data);
}
/// <summary>
/// Retrieves the `sum` (count) for a given metric.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="metricsName">The name of the metric.</param>
/// <param name="startDate">The start date (inclusive). (optional)</param>
/// <param name="endDate">The end date (exclusive). (optional)</param>
/// <returns>MetricsResultDto</returns>
public MetricsResultDto GetMetrics(string metricsName, DateTime?startDate = default(DateTime?), DateTime?endDate = default(DateTime?))
{
Camunda.OpenApi.Client.Client.ApiResponse <MetricsResultDto> localVarResponse = GetMetricsWithHttpInfo(metricsName, startDate, endDate);
return(localVarResponse.Data);
}
/// <summary>
/// Queries for schema log entries that fulfill given parameters.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="firstResult">Pagination of results. Specifies the index of the first result to return. (optional)</param>
/// <param name="maxResults">Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)</param>
/// <param name="schemaLogQueryDto"> (optional)</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of List<SchemaLogEntryDto></returns>
public async System.Threading.Tasks.Task <List <SchemaLogEntryDto> > QuerySchemaLogAsync(int?firstResult = default(int?), int?maxResults = default(int?), SchemaLogQueryDto schemaLogQueryDto = default(SchemaLogQueryDto), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <SchemaLogEntryDto> > localVarResponse = await QuerySchemaLogWithHttpInfoAsync(firstResult, maxResults, schemaLogQueryDto, cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Queries for schema log entries that fulfill given parameters.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="firstResult">Pagination of results. Specifies the index of the first result to return. (optional)</param>
/// <param name="maxResults">Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)</param>
/// <param name="schemaLogQueryDto"> (optional)</param>
/// <returns>List<SchemaLogEntryDto></returns>
public List <SchemaLogEntryDto> QuerySchemaLog(int?firstResult = default(int?), int?maxResults = default(int?), SchemaLogQueryDto schemaLogQueryDto = default(SchemaLogQueryDto))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <SchemaLogEntryDto> > localVarResponse = QuerySchemaLogWithHttpInfo(firstResult, maxResults, schemaLogQueryDto);
return(localVarResponse.Data);
}
/// <summary>
/// Queries for schema log entries that fulfill given parameters.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="version">Only return schema log entries with a specific version. (optional)</param>
/// <param name="firstResult">Pagination of results. Specifies the index of the first result to return. (optional)</param>
/// <param name="maxResults">Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)</param>
/// <returns>List<SchemaLogEntryDto></returns>
public List <SchemaLogEntryDto> GetSchemaLog(string version = default(string), int?firstResult = default(int?), int?maxResults = default(int?))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <SchemaLogEntryDto> > localVarResponse = GetSchemaLogWithHttpInfo(version, firstResult, maxResults);
return(localVarResponse.Data);
}
/// <summary>
/// Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event. Internally this maps to the engine's message correlation builder methods `MessageCorrelationBuilder#correlateWithResult()` and `MessageCorrelationBuilder#correlateAllWithResult()`. For more information about the correlation behavior, see the [Message Events](https://docs.camunda.org/manual/7.14/bpmn20/events/message-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.14/reference/bpmn20/).
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="correlationMessageDto"> (optional)</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of List<MessageCorrelationResultWithVariableDto></returns>
public async System.Threading.Tasks.Task <List <MessageCorrelationResultWithVariableDto> > DeliverMessageAsync(CorrelationMessageDto correlationMessageDto = default(CorrelationMessageDto), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <MessageCorrelationResultWithVariableDto> > localVarResponse = await DeliverMessageWithHttpInfoAsync(correlationMessageDto, cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Retrieves a list of metrics, aggregated for a given interval.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="name">The name of the metric. (optional)</param>
/// <param name="reporter">The name of the reporter (host), on which the metrics was logged. This will have value provided by the [hostname configuration property](https://docs.camunda.org/manual/7.14/reference/deployment-descriptors/tags/process-engine/#hostname). (optional)</param>
/// <param name="startDate">The start date (inclusive). (optional)</param>
/// <param name="endDate">The end date (exclusive). (optional)</param>
/// <param name="firstResult">Pagination of results. Specifies the index of the first result to return. (optional)</param>
/// <param name="maxResults">Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)</param>
/// <param name="interval">The interval for which the metrics should be aggregated. Time unit is seconds. Default: The interval is set to 15 minutes (900 seconds). (optional, default to "900")</param>
/// <param name="aggregateByReporter">Aggregate metrics by reporter. (optional)</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of List<MetricsIntervalResultDto></returns>
public async System.Threading.Tasks.Task <List <MetricsIntervalResultDto> > IntervalAsync(string name = default(string), string reporter = default(string), DateTime?startDate = default(DateTime?), DateTime?endDate = default(DateTime?), int?firstResult = default(int?), int?maxResults = default(int?), string interval = default(string), string aggregateByReporter = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <MetricsIntervalResultDto> > localVarResponse = await IntervalWithHttpInfoAsync(name, reporter, startDate, endDate, firstResult, maxResults, interval, aggregateByReporter, cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Retrieves the names of all process engines available on your platform. **Note**: You cannot prepend `/engine/{name}` to this method.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>List<ProcessEngineDto></returns>
public List <ProcessEngineDto> GetProcessEngineNames()
{
Camunda.OpenApi.Client.Client.ApiResponse <List <ProcessEngineDto> > localVarResponse = GetProcessEngineNamesWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Creates a comment for a task by id.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">The id of the task to add the comment to.</param>
/// <param name="commentDto">**Note:** Only the `message` property will be used. Every other property passed to this endpoint will be ignored. (optional)</param>
/// <returns>CommentDto</returns>
public CommentDto CreateComment(string id, CommentDto commentDto = default(CommentDto))
{
Camunda.OpenApi.Client.Client.ApiResponse <CommentDto> localVarResponse = CreateCommentWithHttpInfo(id, commentDto);
return(localVarResponse.Data);
}
/// <summary>
/// Retrieves the version of the Rest API.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>VersionDto</returns>
public VersionDto GetRestAPIVersion()
{
Camunda.OpenApi.Client.Client.ApiResponse <VersionDto> localVarResponse = GetRestAPIVersionWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Creates a comment for a task by id.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">The id of the task to add the comment to.</param>
/// <param name="commentDto">**Note:** Only the `message` property will be used. Every other property passed to this endpoint will be ignored. (optional)</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of CommentDto</returns>
public async System.Threading.Tasks.Task <CommentDto> CreateCommentAsync(string id, CommentDto commentDto = default(CommentDto), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
Camunda.OpenApi.Client.Client.ApiResponse <CommentDto> localVarResponse = await CreateCommentWithHttpInfoAsync(id, commentDto, cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Fetch Telemetry Configuration Fetches Telemetry Configuration.
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of TelemetryConfigurationDto</returns>
public async System.Threading.Tasks.Task <TelemetryConfigurationDto> GetTelemetryConfigurationAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
Camunda.OpenApi.Client.Client.ApiResponse <TelemetryConfigurationDto> localVarResponse = await GetTelemetryConfigurationWithHttpInfoAsync(cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Triggers evaluation of conditions for conditional start event(s). Internally this maps to the engines condition evaluation builder method ConditionEvaluationBuilder#evaluateStartConditions(). For more information see the [Conditional Start Events](https://docs.camunda.org/manual/7.14/reference/bpmn20/events/conditional-events/#conditional-start-event) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.14/reference/bpmn20/).
/// </summary>
/// <exception cref="Camunda.OpenApi.Client.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="evaluationConditionDto"> (optional)</param>
/// <returns>List<ProcessInstanceDto></returns>
public List <ProcessInstanceDto> EvaluateCondition(EvaluationConditionDto evaluationConditionDto = default(EvaluationConditionDto))
{
Camunda.OpenApi.Client.Client.ApiResponse <List <ProcessInstanceDto> > localVarResponse = EvaluateConditionWithHttpInfo(evaluationConditionDto);
return(localVarResponse.Data);
}