Skip to main content

Update Subscription Schedule​

Select

SaaS
Customer Managed

Modify the subscription properties like recipients, frequency, output type, etc.

Request Body
  • companyId integer
  • report 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
Responses

OK

Schema
  • error object
  • errorCode integer
  • errorMessage string
POST /reports/updatesubscriptions

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "companyId": 0,

  "report": {

    "reportId": 0,

    "reportName": "string",

    "description": "string",

    "subTaskId": 0,

    "taskId": 0,

    "scheduleName": "string",

    "selfSubscription": 0,

    "companySubscription": 0,

    "subscriptionToEmail": 0,

    "outputType": 0,

    "scheduleUrl": "string",

    "enabled": 0,

    "frequencyDetails": {

      "freq_type": 0,

      "freq_interval": 0,

      "freq_relative_interval": 0,

      "freq_recurrence_factor": 0,

      "freq_subday_interval": 0,

      "skipOccurence": 0,

      "skipDayNumber": 0,

      "active_start_date": 0,

      "active_start_time": 0,

      "active_end_date": 0,

      "active_end_time": 0,

      "active_end_occurence": 0,

      "freq_restart_interval": 0,

      "next_schedule_time": 0,

      "timezone_type": 0,

      "timezoneDisplayName": "string"

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Reports/UpdateSubscriptions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "companyId": 0,
  "report": {
    "reportId": 0,
    "reportName": "string",
    "description": "string",
    "subTaskId": 0,
    "taskId": 0,
    "scheduleName": "string",
    "selfSubscription": 0,
    "companySubscription": 0,
    "subscriptionToEmail": 0,
    "outputType": 0,
    "scheduleUrl": "string",
    "enabled": 0,
    "frequencyDetails": {
      "freq_type": 0,
      "freq_interval": 0,
      "freq_relative_interval": 0,
      "freq_recurrence_factor": 0,
      "freq_subday_interval": 0,
      "skipOccurence": 0,
      "skipDayNumber": 0,
      "active_start_date": 0,
      "active_start_time": 0,
      "active_end_date": 0,
      "active_end_time": 0,
      "active_end_occurence": 0,
      "freq_restart_interval": 0,
      "next_schedule_time": 0,
      "timezone_type": 0,
      "timezoneDisplayName": "string"
    }
  }
}'