Use Cases

The following table contains use cases to better understand building requests for your REST APIs.

Task More Information
Excluding Null Data This use case describes how to reduce the amount of data returned in a response by excluding properties with null data.
Suppressing Rules and External Events This use case describes how to suppress rules and external events using certain HTTP headers on POST, PATCH, and DELETE requests.
Annotating REST API Requests This use case describes how to use the OSvC-CREST-Application-Context HTTP header to add comments to REST API requests.
Working with Contacts This use case describes how to perform certain actions on contacts, such as resetting password on contacts, sending a mail to a contact, initiating a marketing campaign , and so on.
Executing Analytics Reports This use case describes how to run analytics reports by providing different input parameters such as ID, lookup name, pagination limit, and so on.
Managing File Attachments This use case describes how to work with file attachments, such as retrieving, uploading, downloading, and deleting them.
Managing NamedIDs This use case describes how to retrieve one or multiple NamedIDs. A NamedID represents a menu selection and contains the list of possible values in a menu.
Managing NamedIDHierarchies This use case describes how to retrieve one or multiple NamedIDHierarchy. A NamedIDHierarchy is a NamedID that holds a hierarchical value.
Bulk Delete This use case describes how to delete high volumes of data using bulk delete, lists the objects that support bulk delete, and provides examples.