Uploaded image for project: 'camunda BPM'
  1. camunda BPM
  2. CAM-10678

Camunda docs v7.11 /process-instance/delete api is not updated

    Details

    • Type: Bug Report
    • Status: Closed
    • Priority: L3 - Default
    • Resolution: Fixed
    • Affects Version/s: 7.11.1
    • Fix Version/s: 7.12.0, 7.12.0-alpha3
    • Component/s: engine
    • Labels:
    • Title Keywords:
      Process Instance Deletion Async

      Description

      I was using /process-instance/delete rest api and in the response it returns new field called createUserId which is not documented in the below rest api response.

      Delete Async (POST)

      POST /process-instance/delete : Deletes multiple process instances asynchronously (batch).

      {
        "id": "aBatchId",
        "type": "aBatchType",
        "totalJobs": 10,
        "batchJobsPerSeed": 100,
        "jobsCreated": 10,
        "invocationsPerBatchJob": 1,
        "seedJobDefinitionId": "aSeedJobDefinitionId",
        "monitorJobDefinitionId": "aMonitorJobDefinitionId",
        "batchJobDefinitionId": "aBatchJobDefinitionId",
        "suspened": false,
        "tenantId": "aTenantId"
      }
      

        Activity

        Hide
        miklas.boskamp Miklas Boskamp added a comment -

        The documentation is missing for other REST endpoints as well. Every Endpoint that returns a BatchDto contains this property. (e.g. ExternalTaskRestService#setRetreisAsync)
        Other properties are also affected. (e.g. monitorJobDefinitionId)

        We should check documentations for all endpoints that return BatchDto if properties are missing.

        The changes were introduced with CAM-9230.

        Show
        miklas.boskamp Miklas Boskamp added a comment - The documentation is missing for other REST endpoints as well. Every Endpoint that returns a BatchDto contains this property. (e.g. ExternalTaskRestService#setRetreisAsync) Other properties are also affected. (e.g. monitorJobDefinitionId) We should check documentations for all endpoints that return BatchDto if properties are missing. The changes were introduced with CAM-9230 .
        Hide
        thorben.lindhauer Thorben Lindhauer added a comment -

        Hi Aravindh Ravi,

        Thanks for reporting this. We will update the documentation.

        Cheers,
        Thorben

        Show
        thorben.lindhauer Thorben Lindhauer added a comment - Hi Aravindh Ravi , Thanks for reporting this. We will update the documentation. Cheers, Thorben

          People

          • Assignee:
            Unassigned
            Reporter:
            aravindhrs Aravindh Ravi
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development