List Subscription Properties statement

List all properties for a specific subscription.

Copy

LIST [ALL] PROPERTIES FOR SUBSCRIPTIONschedule_name((USER | GROUP)user_or_group_name| CONTACTcontact_name) CONTENTreport_or_document_nameINlocation_nameFOR PROJECTproject_name;

where:

subscription_GUID is the ID of the subscription
schedule_name is the name of the schedule
user_or_group_name is the name of the recipient user or group
contact_name is the name of the recipient contact
report_or_document_name is the name of the report or document
location_name is the name of the folder where the report or document resides
project_name is the name of the project where the report or document resides

ResultSet Columns

LIST ALL PROPERTIES FOR SUBSCRIPTION (FILE TYPE) FOR PROJECT

COMPRESS_CONTENTS: Whether or not to compress the content, returned as a boolean value.
CONTENT: The report or document name associated with the subscription, returned as a string.
CREATEUPDATECACHE: Whether or not a cache is created or updated as a result of this subscription, returned as a boolean value.
CREATION_TIME: The time at which the subscription was created, returned as a date/string.
DESCRIPTION: The description of the subscription, returned as a string.
EXPIRATIONDATE: The expiration date of the subscription, returned as a string.
FILENAME: The file name of the subscription, returned as a string.
FOLDER: The folder the subscription delivers to, returned as a string.
GUID: The GUID of the subscription, returned as a string.
MODIFICATIONBYRECIPIENTS: Whether or not recipients can modify the subscription, returned as a boolean.
MODIFICATION_TIME: The time at which the subscription was last modified, returned as a date/string.
NAME: The name of the subscription, returned as a string.
OWNER: The owner of the subscription, returned as a string.
RECIPIENT_RESULTSET: A ResultSet containing a list of recipients for the subscription.

RECIPIENT: The name of the recipient, returned as a vector with type string.
RECIPIENT_ADDRESS: The address of the recipient, returned as a vector with type string.
RECIPIENT_TYPE: The type of the recipient, returned as a vector with type string.

RUNFRESH: Whether or not to retrieve the results from the data source rather than using a cache, returned as a boolean value.
SCHEDULE: The schedule associated with the subscription, returned as a string.
SENDNOTIFICATION: Whether or not to send an email notification that the subscription has been sent, returned as a boolean value.
SENDPREVIEWNOW: Whether or not to send a preview of the subscription upon creation, returned as a boolean value.
SUBSCRIPTION_TYPE: The type of subscription, returned as a string.
ZIPFILENAME: If COMPRESS_CONTENTS is TRUE, the name of the compressed file, returned as a string.

LIST ALL PROPERTIES FOR SUBSCRIPTION (PRINT TYPE) FOR PROJECT

COLLATE: Whether or not to collate copies together, returned as a string.
CONTENT: The report or document name associated with the subscription, returned as a string.
CREATEUPDATECACHE: Whether or not a cache is created or updated as a result of this subscription, returned as a boolean value.
CREATION_TIME: The time at which the subscription was created, returned as a date/string.
DESCRIPTION: The description of the subscription, returned as a string.
EXPIRATIONDATE: The expiration date of the subscription, returned as a string.
FOLDER: The folder the subscription delivers to, returned as a string.
GUID: The GUID of the subscription, returned as a string.
MODIFICATIONBYRECIPIENTS: Whether or not recipients can modify the subscription, returned as a boolean.
MODIFICATION_TIME: The time at which the subscription was last modified, returned as a date/string.
NAME: The name of the subscription, returned as a string.
NUMBER_OF_COPIES: The number of copies to print, returned as an integer.
OWNER: The owner of the subscription, returned as a string.
RECIPIENT_RESULTSET: A ResultSet containing a list of recipients for the subscription.

RECIPIENT: The name of the recipient, returned as a vector with type string.
RECIPIENT_ADDRESS: The address of the recipient, returned as a vector with type string.
RECIPIENT_TYPE: The type of the recipient, returned as a vector with type string.

RUNFRESH: Whether or not to retrieve the results from the data source rather than using a cache, returned as a boolean value.
SCHEDULE: The schedule associated with the subscription, returned as a string.
SENDNOTIFICATION: Whether or not to send an email notification that the subscription has been sent, returned as a boolean value.
SENDPREVIEWNOW: Whether or not to send a preview of the subscription upon creation, returned as a boolean value.
START_PAGE: The page number to begin printing at, returned as an integer.
SUBSCRIPTION_TYPE: The type of subscription, returned as a string.
TO_PAGE: The page number to stop printing at, returned as an integer.

LIST ALL PROPERTIES FOR SUBSCRIPTION (EMAIL TYPE) FOR PROJECT

COMPRESS_CONTENTS: Whether or not to compress contents, returned as a boolean value.
CONTENT: The report or document name associated with the subscription, returned as a string.
CREATEUPDATECACHE: Whether or not a cache is created or updated as a result of this subscription, returned as a boolean value.
CREATION_TIME: The time at which the subscription was created, returned as a date/string.
DESCRIPTION: The description of the subscription, returned as a string.
EXPIRATIONDATE: The expiration date of the subscription, returned as a string.
FILENAME: The file name of the subscription, returned as a string.
FOLDER: The folder the subscription delivers to, returned as a string.
GUID: The GUID of the subscription, returned as a string.
INCLUDEDATA: Whether or not to include the data in the subscription, returned as a boolean value.
INCLUDELINK: Whether or not to include a link to the History List in a subscription, returned as a boolean value.
MESSAGE: The message of the email, returned as a string.
MODIFICATIONBYRECIPIENTS: Whether or not recipients can modify the subscription, returned as a boolean.
MODIFICATION_TIME: The time at which the subscription was last modified, returned as a date/string.
NAME: The name of the subscription, returned as a string.
OWNER: The owner of the subscription, returned as a string.
RECIPIENT_RESULTSET: A ResultSet containing a list of recipients for the subscription.

RECIPIENT: The name of the recipient, returned as a vector with type string.
RECIPIENT_ADDRESS: The address of the recipient, returned as a vector with type string.
RECIPIENT_TYPE: The type of the recipient, returned as a vector with type string.

RUNFRESH: Whether or not to retrieve the results from the data source rather than using a cache, returned as a boolean value.
SCHEDULE: The schedule associated with the subscription, returned as a string.
SENDNOTIFICATION: Whether or not to send an email notification that the subscription has been sent, returned as a boolean value.
SENDPREVIEWNOW: Whether or not to send a preview of the subscription upon creation, returned as a boolean value.
SENDTOHISTORYLIST: Whether or not to send the report or document to the History List, returned as a boolean value.
SUBJECT: The subject of the email, returned as a string.
SUBSCRIPTION_TYPE: The type of subscription, returned as a string.
ZIPFILENAME: If COMPRESS_CONTENTS is TRUE, the name of the compressed file, returned as a string.

LIST ALL PROPERTIES FOR SUBSCRIPTION (CACHE TYPE) FOR PROJECT

CONTENT: The report or document name associated with the subscription, returned as a string.
CREATION_TIME: The time at which the subscription was created, returned as a date/string.
DESCRIPTION: The description of the subscription, returned as a string.
EXPIRATIONDATE: The expiration date of the subscription, returned as a string.
FOLDER: The folder the subscription delivers to, returned as a string.
GUID: The GUID of the subscription, returned as a string.
MODIFICATION_TIME: The time at which the subscription was last modified, returned as a date/string.
NAME: The name of the subscription, returned as a string.
OWNER: The owner of the subscription, returned as a string.
RECIPIENT_RESULTSET: A ResultSet containing a list of recipients for the subscription.

RECIPIENT: The name of the recipient, returned as a vector with type string.
RECIPIENT_ADDRESS: The address of the recipient, returned as a vector with type string.
RECIPIENT_TYPE: The type of the recipient, returned as a vector with type string.

SCHEDULE: The schedule associated with the subscription, returned as a string.
SENDNOTIFICATION: Whether or not to send an email notification that the subscription has been sent, returned as a boolean value.
SUBSCRIPTION_TYPE: The type of subscription, returned as a string.

LIST ALL PROPERTIES FOR SUBSCRIPTION (HISTORY LIST TYPE) FOR PROJECT

CONTENT: The report or document name associated with the subscription, returned as a string.
CREATEUPDATECACHE: Whether or not a cache is created or updated as a result of this subscription, returned as a boolean value.
CREATION_TIME: The time at which the subscription was created, returned as a date/string.
DESCRIPTION: The description of the subscription, returned as a string.
EXPIRATIONDATE: The expiration date of the subscription, returned as a string.
FOLDER: The folder the subscription delivers to, returned as a string.
GUID: The GUID of the subscription, returned as a string.
HISTORY_LINK_URL: The URL of the History List entry associated with the subscription, returned as a string.
HISTORY_LINK_WEBSERVER: The web server of the History List associated with the subscription, returned as a string.
MODIFICATIONBYRECIPIENTS: Whether or not recipients can modify the subscription, returned as a boolean.
MODIFICATION_TIME: The time at which the subscription was last modified, returned as a date/string.
NAME: The name of the subscription, returned as a string.
OVERWRITE_OLDER_VERSION: Whether or not to overwrite the older version of the content, returned as a boolean.
OWNER: The owner of the subscription, returned as a string.
RECIPIENT_RESULTSET: A ResultSet containing a list of recipients for the subscription.

RECIPIENT: The name of the recipient, returned as a vector with type string.
RECIPIENT_ADDRESS: The address of the recipient, returned as a vector with type string.
RECIPIENT_TYPE: The type of the recipient, returned as a vector with type string.

RUNFRESH: Whether or not to retrieve the results from the data source rather than using a cache, returned as a boolean value.
SCHEDULE: The schedule associated with the subscription, returned as a string.
SUBSCRIPTION_TYPE: The type of subscription, returned as a string.

LIST ALL PROPERTIES FOR SUBSCRIPTION (MOBILE TYPE) FOR PROJECT

CONTENT: The report or document name associated with the subscription, returned as a string.
CREATEUPDATECACHE: Whether or not a cache is created or updated as a result of this subscription, returned as a boolean value.
CREATION_TIME: The time at which the subscription was created, returned as a date/string.
DESCRIPTION: The description of the subscription, returned as a string.
DEVICE_TYPE: The type of mobile device the subscription is designed for, returned as a string.
EXPIRATIONDATE: The expiration date of the subscription, returned as a string.
FOLDER: The folder the subscription delivers to, returned as a string.
GUID: The GUID of the subscription, returned as a string.
MODIFICATIONBYRECIPIENTS: Whether or not recipients can modify the subscription, returned as a boolean.
MODIFICATION_TIME: The time at which the subscription was last modified, returned as a date/string.
NAME: The name of the subscription, returned as a string.
OVERWRITE_OLDER_VERSION: Whether or not to overwrite the older version of the content, returned as a boolean.
OWNER: The owner of the subscription, returned as a string.
RECIPIENT_RESULTSET: A ResultSet containing a list of recipients for the subscription.

RECIPIENT: The name of the recipient, returned as a vector with type string.
RECIPIENT_ADDRESS: The address of the recipient, returned as a vector with type string.
RECIPIENT_TYPE: The type of the recipient, returned as a vector with type string.

RUNFRESH: Whether or not to retrieve the results from the data source rather than using a cache, returned as a boolean value.
SCHEDULE: The schedule associated with the subscription, returned as a string.
SUBSCRIPTION_TYPE: The type of subscription, returned as a string.