API Request Attributes

Overview

This page describes the most commonly used Export API's request attributes with short descriptions and samples. This page also list the filters and how they can be used in the API Request.

Details

Attribute Name Type Required Size Description / Possible Values
reportName String Yes 50

Specify the report name
reportViewName Array[String] Yes 50

List of specific report view names, Comma separated array values
displaySSN String No 5

true | false | yes | no | y | n. Default is false.
notification String No 20

NOTIFY_FINAL_STATUS , NOTIFY_CHANGE_STATUS , DO_NOT_NOTIFY
Default value as NOTIFY_FINAL_STATUS

reportOutputFormat String No 50

EXCEL07,EXCEL,PDF,CSV,XML,CSVFULL,CHARACTER_SEPARATED
Default value as CSV

characterSeparated String No 5

TAB, SPACE, OTHER. Default value as Tab
includeTextQualifier String Yes

Default value as true.
other String No 1

Other than Character Separator (Tab and Space)
filters Array[Filter] No 5

Maximum filters array size is 5.
filters.name String No 30

Applicable of Account,Grant and report specific Base ROT tables fields. Maximum size is 5
filters.operator String No 28

Data type as Number : EQUALS, GREATER_THAN, LESS_THAN, GREATER_THAN_EQUALS, LESSER_THAN_EQUALS, NOT_EQUALS, IS_NULL, IS_NOT_NULL, IS_BETWEEN, IS_ANY_OFv Data Type as String : IS, IS_NOT, CONTAINS, BEGIN_WITH, IS_LIKE, IS_NULL, IS_NOT_NULL, IS_ANY_OF
Data Type as Date : IS_ON, IS_AFTER, IS_BEFORE, IS_ON_OR_AFTER, IS_ON_OR_BEFORE, IS_NOT_ON, IS_NULL, IS_NOT_NULL, IS_BETWEEN, IS_ANY_OF

filters.values Array[String] No 255

Operator as IS_ANY_OF, then values Maximum size is 6.
Operator as IS_BETWEEN, then values Maximum size is 2. Other operator size is 1.

filters.dynamicCalendars Array[String] No 255

Calendar names should be specified as an array matching the order of input relative date values (with Default, null, or "" as the default), will only be respected if the report supports the relative date feature, and the operator must align with the date data type.

Note : Report name, Report view names and Possible values are not case sensitive

Sample request

{
  "reportName": "",
  "reportViewNames": [
    "",
    ""
  ],
  "filters": [
    {
      "name": "",
      "operator": "< IS | IS_NOT | CONTAINS | BEGIN_WITH | IS_LIKE | EQUALS | GREATER_THAN | LESS_THAN | GREATER_THAN_EQUALS | LESSER_THAN_EQUALS | NOT_EQUALS | IS_NULL | IS_NOT_NULL | IS_BETWEEN | IS_ANY_OF | IS_ON | IS_AFTER | IS_BEFORE | IS_ON_OR_AFTER | IS_ON_OR_BEFORE | IS_NOT_ON >",
      "values": [
        "",
        ""
      ],
      "dynamicCalendars": [
        "< Calendar1 >",
        "< Calendar2 >"
      ]
    }
  ],
  "displaySSN": "< true | false | yes | no | y | n >",
  "notification": "< NOTIFY_FINAL_STATUS | NOTIFY_CHANGE_STATUS | DO_NOT_NOTIFY >"
}