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

Wrong REST API Documentation for Job queries

XMLWordPrintable

      The following documentation:

      Describes how the "jobIds" and "processInstanceIds" are both "comma-separated lists". That is incorrect. They are both arrays of strings. If you pass a string with comma separated ids ("id1,id2,id3...") then engine return an error.

      The same documentation also has attribute "tenantIdIn" which is also described as comma-separated. I have not tested if that has the same issue as the other ones.

      I have tested the queries on a Camunda 7.13 engine, but the API documentation is the same for both 7.13 and 7.14 - so I am assuming that a Camunda 7.14 engine behaves the same way.

        This is the controller panel for Smart Panels app

            [CAM-12833] Wrong REST API Documentation for Job queries

            Yana Vasileva added a comment -

            Hi mimaom,

            Thank you for reporting this.
            I could confirm that the description of the fields ("jobIds", "processInstanceIds", "dueDates", "createTimes","tenantIdIn") is incorrect. The correct request body is:

            {
    "jobIds": [
        "id1",
        "id2"
    ]
}

            Would you like to raise and pull request to make adjustments in the endpoints documentation?

            Best regards,
            Yana

            Yana Vasileva added a comment - Hi mimaom , Thank you for reporting this. I could confirm that the description of the fields ("jobIds", "processInstanceIds", "dueDates", "createTimes","tenantIdIn") is incorrect. The correct request body is: { "jobIds": [ "id1", "id2" ] } Would you like to raise and pull request to make adjustments in the endpoints documentation? Best regards, Yana

            Michael Martinsen added a comment -

            I have created a pull request for this change:

             

            https://github.com/camunda/camunda-docs-manual/pull/806

             

            BR

            Michael

            Michael Martinsen added a comment - I have created a pull request for this change:   https://github.com/camunda/camunda-docs-manual/pull/806   BR Michael

              Unassigned Unassigned
              mimaom Michael Martinsen
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: