Report Subscription - Creates a subscription by report ID
Enter ID of the report for which the subscription is being created.
The requested API version
1.0
Optional User Id
Optional User Email
Class for representing a request to create a new subscription for a report.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
POST /reports/{reportId}/subscriptions HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 562
{
"subscriptionName": "Monthly Report Subscription",
"bookmarkState": "Active",
"schedule": "0 0 1 * *",
"subscribers": [
"user1@example.com",
"user2@example.com"
],
"subject": "Monthly Report Summary",
"content": "This is the content of the monthly report subscription.",
"isActive": true,
"reportPageName": "Sales Dashboard",
"startDateTime": "2024-09-01T09:00:00",
"endDateTime": "2024-09-30T18:00:00",
"timeZone": "(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi",
"reportParameter": [
{
"name": "Parameter1",
"value": "Value1"
},
{
"name": "Parameter2",
"value": "Value2"
}
],
"hasAttachment": true
}
{
"reportSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
"subscriptionName": "text",
"reportId": "123e4567-e89b-12d3-a456-426614174000",
"bookmarkState": "text",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"createdByUserEmail": "text",
"schedule": "text",
"subscribers": [
"text"
],
"subject": "text",
"content": "text",
"isActive": true,
"reportPageName": "text",
"startDateTime": "2025-06-27T11:21:26.278Z",
"endDateTime": "2025-06-27T11:21:26.278Z",
"timeZone": "text",
"reportParameter": [
{
"name": "text",
"value": "text"
}
],
"hasAttachment": true,
"reportParameters": "text"
}
Last updated