v1

latestOpenAPI 3.0.32026-08-061874701.5 MB

reports

Add report columns

Add columns to a report specified by a report ID. The source sheet columns are matched in these ways:

[type, title] for regular columns
[type, systemColumnType] for system columns
[type=TEXT_NUMBER, sheetNameColumn=true] for the special sheet name report column

Note: All indexes of the columns must be equal. The columns will be added at the specified index, and existing columns at that index or greater will be shifted to the right. For example, if there are 5 columns in the report and a new column is added with index 2, the new column will be added at position 3 and the existing columns that were at positions 3 and 4 will be shifted to positions 4 and 5, respectively.

Note: You can combine multiple CHECKBOX columns or multiple PICKLIST columns from different sheets into a single report column, even if their underlying symbols differ. However, you can't combine a CHECKBOX column with a PICKLIST column, because they're different types.

Note: The system column type AUTO_NUMBER is matched together with columns having the same title and type=TEXT_NUMBER.

post/reports/{reportId}/columns

Request body

Example request

[
  {
    "title": "Sheet Name",
    "type": "TEXT_NUMBER",
    "sheetNameColumn": true,
    "index": 0
  },
  {
    "title": "Item selected",
    "type": "CHECKBOX",
    "index": 0
  },
  {
    "title": "Created by",
    "type": "CONTACT_LIST",
    "systemColumnType": "CREATED_BY",
    "index": 0
  }
]

Response

Returns Result object containing the Report column objects that were added.

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",
  "result": [
    {
      "type": "PICKLIST",
      "systemColumnType": "CREATED_BY",
      "autoNumberFormat": {
        "fill": "",
        "prefix": "",
        "startingNumber": 1,
        "suffix": ""
      }
    }
  ]
}