Add an extra field on the api/report/evaluate endpoint to count the number of incidents per process instance on raw data reports

XMLWordPrintable

    • Type: Task
    • Resolution: Fixed
    • Priority: L3 - Default
    • 3.10.0-alpha2, 3.10.0
    • Affects Version/s: None
    • Component/s: backend
    • None

      Task Description:
      At the moment the raw data report does not count the amount of incidents a process instance has. For the purpose of enriching the raw data report with data which is meaningful for machine learning, we can need to add an extra field on response of the api/report/evaluate endpoint which will return the total amount of open incidents an instance contains. More specifically, the response of the endpoint contains a json key called result, which should now include the following information:

       "result" : {
          "instanceCount" : 3722,
          "instanceCountWithoutFilters" : 3722,
          "measures" : [ {
            "property" : "rawData",
            "aggregationType" : null,
            "userTaskDurationTime" : null,
            "data" : [ {
              "processDefinitionKey" : "AnalysisTestingProcess",
              "processDefinitionId" : "AnalysisTestingProcess:17:a5cffc6c-754f-11ec-90b6-e6a9f32a3df3",
              "numberOfIncidents" : someValue,
              "processInstanceId" : "1330eeb0-7550-11ec-90b6-e6a9f32a3df3",
              "businessKey" : "correlationValue_3211",
              "startDate" : "2020-01-03T02:01:00.000+0000",
              "endDate" : null,
              "duration" : 83832241425,
              "engineName" : "camunda-bpm",
              "tenantId" : null,
              "variables" : {
                "anotherEndEvent" : "0.0036441698813491907",
                "boolVar" : "false",
                "correlatingVariable" : "correlationValue_3211",
                "dateList" : "2003-01-14T16:38:52.144+0100, 2028-01-14T16:38:52.144+0100",
                "dateList._listSize" : "2",
                "dateVar" : "1970-01-16T00:26:09.415+0000",
                "delay" : "false",
                "doubleVar" : "1.7518147474113708E308",
                "freightOrdered" : "0.74926304786165",
                "integerVar" : "866878248",
                "isTransferShipment" : "0.5124754875483395",
                "longVar" : "2282987773707827479",
                "numberList" : "97.0, -82.0, 91.0",
                "numberList._listSize" : "3",
                "person" : "<<OBJECT_VARIABLE_VALUE>>",
                "person.age" : "33.0",
                "person.favouriteDay" : "1951-01-14T16:38:52.144+0100",
                "person.hobbies" : "Armwrestling, Ferret racing",
                "person.hobbies._listSize" : "2",
                "person.name" : "Kyrylo",
                "person.skills.read" : "false",
                "person.skills.write" : "true",
                "shortVar" : "-14276",
                "stringVar" : "aStringValue"
              }
            }
      

      AT:

      • The api/report/evaluate endpoint response has changed so that the totalAmountOfIncidents is included as part of the result attribute
      • The have been ITs developed to verify this behaviour
      • The REST API docs have been updated

        1. Screenshot 2022-08-30 at 09.50.07.png
          913 kB
          Andromachi Rozaki
        2. Screenshot 2022-08-30 at 09.50.15.png
          647 kB
          Andromachi Rozaki

            Assignee:
            Unassigned
            Reporter:
            Andromachi Rozaki
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: