Articles in this section

QuerySurge REST API Version Changes

As QuerySurge is evolving, so is our REST API. The following guide describes potentially breaking changes in the QuerySurge REST API. When upgrading QuerySurge from versions lower then the versions listed here, please follow the recommended modifications to integrations continue to work as expected. 

Version 14.0:

  • QueryPairDTO: Is the response object returned from GET: /QuerySurge/api/project/{ProjectId}/querypair and GET: /QuerySurge/api/project/{ProjectId}/querypair/id} has been updated with the following modifications.
    1. "Key" field has been renamed "keyColumns"
    2. "Ignorable Columns" field has been renamed "ignorableColumns"
    3. "Thresholds" field has been renamed "thresholds"
    4. "Timestamp Columns" field has been renamed "timestampColumns"

Version 14.2:

  • The format for Staging level indexes has been altered with the following modifications. This change impacts endpoints:

    1. GET: /QuerySurge/api/project{ProjectId}/stagingquery
    2. GET: /QuerySurge/api/project{ProjectId}/stagingquery/id
    3. POST: /QuerySurge/api/project{ProjectId}/stagingquery
    4. PUT: /QuerySurge/api/project{ProjectId}/stagingquery/id

    These changes include modification of response entity for indexes. Below shows the old entity and the new entity. 

    Previous ResponseNew Response
     "Index": [
    {
      "id": 0,
      "ColumnIndex": [
        "cola",
        "colb"
      ]
    },
    {
      "id": 1,
      "ColumnIndex": [
        "cola(5)"
      ]
    }
  ]

     "indexes": [
    {
      "index": [
        {
          "indexSize": null,
          "columnName": "cola"
        },
        {
          "indexSize": null,
          "columnName": "colb"
        }
      ]
    },
    {
      "index": [
        {
          "indexSize": 5,
          "columnName": "cola"
        }
      ]
    }
  ]

    This new format, better handles complex indexes and handles potential situations in which parentheses are used in index column names which can cause issues when parsing the response. In addition the entity passed when updating/creating new staging, this change is shown below. 

    Previous RequestNew Request
     "indexColumns": [
   "cola, colb",
   "cola(5)"
 ],
     "indexes": [
    {
      "index": [
        {
          "indexSize": null,
          "columnName": "cola"
        },
        {
          "indexSize": null,
          "columnName": "colb"
        }
      ]
    },
    {
      "index": [
        {
          "indexSize": 5,
          "columnName": "cola"
        }
      ]
    }
  ]

Related articles