Use Cases

Use cases demonstrate how to get things done with REST APIs, including how to execute analytics reports, manage file attachments, and more. Use them to understand quickly how REST APIs can meet your business needs. To get the most benefit from the following use cases, you should be familiar with basic REST concepts discussed in the Quick Start.

Use Case	Shows how to...
Exclude Null Data in REST API Response to Improve Readability	Reduce the amount of data returned in a response by excluding properties with null data.
Suppress Rules and Custom Processes	Suppress rules and custom processes using certain HTTP headers on POST, PATCH, and DELETE requests.
Work with Contacts to Reset Passwords, Send Mailings, and Run Marketing Campaigns	Perform certain actions on contacts, such as resetting password on contacts, sending a mail to a contact, initiating a marketing campaign , and so on.
Run Analytics Reports to Evaluate Trends and Measure Effectiveness	Run analytics reports by providing different input parameters such as ID, lookup name, pagination limit, and so on.
Manage File Attachments	Work with file attachments, such as retrieving, uploading, downloading, and deleting them.
Manage Named IDs	Retrieve one or multiple NamedIDs. A NamedID represents a menu selection and contains the list of possible values in a menu.
Manage Named ID Hierarchies	Retrieve one or multiple NamedIDHierarchy. A NamedIDHierarchy is a NamedID that holds a hierarchical value.
Send on Save	Send the incident thread response to the primary contact when an incident thread is created.
Perform Bulk Extract	Extract high volumes of data using bulk extract.
Perform Bulk Delete	Delete high volumes of data using bulk delete.
Edit or Convert a Response Thread	Edit the thread content or convert a thread entry type from response to a private note.