Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
reports

Update report definition

Create or entirely replace the definition for the specified report.

put/reports/{reportId}/definition

Request body

Example request

{
  "filters": {
    "operator": "AND",
    "criteria": [
      {
        "column": {
          "title": "Primary Column",
          "type": "TEXT_NUMBER",
          "primary": true
        },
        "operator": "EQUAL",
        "values": [
          "Test"
        ]
      }
    ]
  },
  "groupingCriteria": [
    {
      "column": {
        "title": "Primary Column",
        "type": "TEXT_NUMBER",
        "primary": true
      },
      "sortingDirection": "ASCENDING",
      "isExpanded": true
    }
  ],
  "summarizingCriteria": [
    {
      "column": {
        "title": "Primary Column",
        "type": "TEXT_NUMBER",
        "primary": true
      },
      "aggregationType": "COUNT"
    }
  ],
  "sortingCriteria": [
    {
      "column": {
        "title": "Primary Column",
        "type": "TEXT_NUMBER",
        "primary": true
      },
      "sortingDirection": "ASCENDING"
    }
  ]
}

Response

The operation's success level.

message'PARTIAL_SUCCESS' | 'SUCCESS'

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode0 | 3
  • '0' Success
  • '3' Partial Success of Bulk Operation

Example response

{
  "message": "SUCCESS"
}