Get list of report subscriptions

Select

SaaS

Customer Managed

Get list of report subscriptions for a given company and reportId (optional)

Query Parameters

• companyId integer

  Company Id

• reportId integer

  Report Id

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema array

• reports object

  reportId integer

  reportName string

  description string

  subTaskId integer

  taskId integer

  scheduleName string

  selfSubscription integer

  -1 if not subscribed, 1 if subscribed

  companySubscription integer

  0,1,2,3,4,5 for none subscribed, tenant admins subscribed, tenant admins unsubscribed, tenant operators subscribed, tenant operators unsubscribed, both subscribed respectively

  subscriptionToEmail integer

  -1 if user is unsubscribed from email, 0 otherwise

  outputType integer

  0,1,2,3,4 for PDF,CSV,MHTML,PRINT,HTML respectively

  scheduleUrl string

  enabled integer

  frequencyDetails object

  freq_type integer

  freq_interval integer

  freq_relative_interval integer

  freq_recurrence_factor integer

  freq_subday_interval integer

  skipOccurence integer

  skipDayNumber integer

  active_start_date integer

  active_start_time integer

  active_end_date integer

  active_end_time integer

  active_end_occurence integer

  freq_restart_interval integer

  next_schedule_time integer

  timezone_type integer

  timezoneDisplayName string

[
  null
]

{
  "reports": [
    {
      "reportId": 1,
      "reportName": "SLA",
      "description": null,
      "subTaskId": 1,
      "taskId": 1,
      "scheduleName": "subscription_schedule_name",
      "selfSubscription": 1,
      "companySubscription": 1,
      "subscriptionToEmail": 1,
      "outputType": 1,
      "scheduleUrl": "report_generation_url",
      "enabled": 1,
      "frequencyDetails": {
        "freq_type": 1,
        "freq_interval": 1,
        "freq_relative_interval": 1,
        "freq_recurrence_factor": 1,
        "freq_subday_interval": 1,
        "skipOccurence": 1,
        "skipDayNumber": 1,
        "active_start_date": 1,
        "active_start_time": 1,
        "active_end_date": 1,
        "active_end_time": 1,
        "active_end_occurence": 1,
        "freq_restart_interval": 1,
        "next_schedule_time": 1,
        "timezone_type": 1,
        "timezoneDisplayName": "Indian Standard Time"
      }
    }
  ]
}

Loading...