Report Subscription - Update an existing subscription

Update an existing subscription

PUT/reports/{reportId}/subscriptions/{reportSubscriptionId}

Authorization

Bearer

Path parameters

reportSubscriptionId*string (uuid)

Expects id of an existing subscription

reportId*string (uuid)

Expects id of an existing report

Query parameters

Header parameters

Body

application/jsontext/jsonapplication/*+json

Expects a "ReportSubscription" of type ReportSubscriptionPost schema

subscriptionNamenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the subscriptionName property.

bookmarkStatenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the bookmarkState property.

schedulenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the schedule property.

subscribersnullable array of string

A public property of type list of string that has both a getter and a setter method, which allows for getting and setting the value of the subscribers property.

subjectnullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the subject property.

contentnullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the content property.

isActiveboolean

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the isActive property.

reportPageNamenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the reportPage property.

startDateTimestring (date-time)

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the StartDateTime property.

endDateTimestring (date-time)

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the EndDateTime property.

timeZonenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the TimeZone(IST etc) property.

reportParameternullable array of object

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the ReportParameter property.

hasAttachmentboolean

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the HasAttachment property.

Response

200304400403404500

Success

Body

text/plainapplication/jsontext/json

messagenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the Message property.

statusCodeinteger (int32)

A public property of type integer that has both a getter and a setter method, which allows for getting and setting the value of the StatusCode property.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/reports/{reportId}/subscriptions/{reportSubscriptionId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200304400403404500

{
  "message": "Success Message",
  "statusCode": 200
}