Getting Started

The following table lists out the various User Management Integration Service API endpoints.

WHAT DO YOU WANT TO FOCUS ON?LINK TO RESOURCES
Manage users and privileges including audit logging
  • Get all registered users
  • Add a user
  • Update an existing user
  • Delete a specified user
  • Get user history
  • Manage explicit transactions for multi-messages operations
  • Register a transaction ID
  • Register a transaction ID to handle volumes promotion
  • Delete a transaction including messages
  • Get status for a specified transaction ID
  • Get status for a list of transaction IDs
  • Health check
  • Return the current API version
  • Manage templates for measures including volumes, actuals, prices or discounts.
  • Configure condition measures
  • Get a list of configured measure templates
  • Send, get, or delete volumes or baselines.
  • Send volumes of type integer by date on weekly basis
  • Send volumes of type integer by date on daily basis
  • Send volumes of type integer by week on weekly basis
  • Send volumes of type decimal on weekly basis
  • Send volumes of type decimal on weekly basis with start date
  • Send volumes of type decimal on weekly basis with year and week
  • Get volumes on weekly basis for a specified date
  • Get volumes for a specified Date
  • Get volumes for a week of the year
  • Delete volumes of type integer for a year ending before the specified date
  • Delete volumes of type decimal for a year ending before the specified date
  • Delete volumes of type decimal on weekly basis that span the given time range
  • Delete volumes of type integer on weekly basis
  • Delete volume information before one month of the specified date
  • Delete volumes of type decimal older than the specified date
  • Delete volumes of type decimal on daily basis that span the given time range
  • Delete volumes of type integer on daily basis
  • Manages measures for conditions like prices, discounts and costs.
  • Send product prices for a registered transaction
  • Send product discounts for a registered transaction
  • Send account discounts for a registered transaction
  • Send account costs for a registered transaction
  • Send account/products prices for a registered transaction
  • Send account/products costs for a registered transaction
  • Get accounts product measures for a measure type
  • Delete measures for products per accounts based on measure type
  • Delete conditions in bulk mode for accounts products
  • Delete conditions in bulk mode for account measures
  • Delete conditions in bulk mode for product measures
  • Request account measures for a measure
  • Delete measures for accounts based on measure type
  • Request product measures for a measure type
  • Delete measures for products based on measure type
  • Request data for a selected account and year
  • Request data for a selected account and year
  • Get the account plans that have changed since the specified date and time.
  • Get the account plans that have changed since the specified date and time
  • Get the account plans which have changed since compared with the send list of accountplans, year and ETAGs
  • Retrieve available promotions that are processed within CGCloud Processing Engine.
  • Get available promotions processed within CGCloud Processing Engine
  • Get promotions that have changed since the specified date and time
  • Get promotions that have changed since compared with the send list of promotions and ETAGs
  • Get data for a single promotion and promotion level KPIS using pagination
  • Get data for a single promotion
  • Get the total values for KPIs over all products for all periods spanning the promotion runtime
  • Get available tactics for a specified promotion
  • Get data for a specified promotion tactic
  • Get aggregated data for a specified promotion tactic
  • Get a list of products that created at least one writeback
  • Get accounts available and successfully transferred into CGCloud Processing services internal structures
  • Get products available and successfully transferred into CGCloud Processing services internal structures
  • Analyze internal datastructures for integer values on weekly basis
  • Analyze internal datastructures for decimal values on weekly basis
  • Analyze internal datastructures for integer values on daily basis
  • Analyze internal datastructures for decimal values on daily basis
  • Analyze internal datastructures of type decimal on weekly basis
  • Analyze internal datastructures of type decimal on daily basis
  • Get a list of all dependencies for a specified account
  • Manage file requests.
  • Export CSV files
  • Retrieve available accounts and transfer them into the internal structures of the CGCloud Processing services.
  • Get accounts available and successfully transferred