latestOpenAPI 3.0.12026-08-188456240.4 KB

6e6982573ba6

Report Management API

Update existing report with input information. If not specified in the input, the existing value will be kept intact

put/api/2.0/reports/{objectId}

Path parameters

objectIdinteger required

Report ID to be updated

Request body

createdDateinteger

Created date in milliseconds

lastModDateinteger

Last modified date

idinteger

Report ID

userIdinteger

Report owner's user ID

usernamestring

Report owner's username

statusinteger

Report status

namestring required

Report name

textstring

Email body text

autoSharedboolean

Is report auto-shared on

accessLevelinteger

Access level of the report for current user

Example request

{
  "schedule": {
    "frequencyType": "daily,day,days,weekday,weekdays,hour,hourly,hours,minute,minutes,minutely,week,weeks,weekly,month,months,monthly"
  },
  "properties": {
    "reportContentFilters": [
      {
        "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
        "controlType": "single,picker,slider,range_time_slider",
        "plainControlType": "single,multiple,tree,custom"
      }
    ]
  }
}

Response

Success

createdDateinteger

Created date in milliseconds

lastModDateinteger

Last modified date

idinteger

Report ID

userIdinteger

Report owner's user ID

usernamestring

Report owner's username

statusinteger

Report status

namestring required

Report name

textstring

Email body text

autoSharedboolean

Is report auto-shared on

accessLevelinteger

Access level of the report for current user

Example response

{
  "schedule": {
    "frequencyType": "daily,day,days,weekday,weekdays,hour,hourly,hours,minute,minutes,minutely,week,weeks,weekly,month,months,monthly"
  },
  "properties": {
    "reportContentFilters": [
      {
        "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
        "controlType": "single,picker,slider,range_time_slider",
        "plainControlType": "single,multiple,tree,custom"
      }
    ]
  }
}