Vlocity Platform APIs

Client applications use Platform APIs to access other data and functionality from Vlocity Industry Cloud applications. They provide programmatic access to customer data, such as profile attributes and customer stories, campaign data for call lists and associated members and documents, as well as access to system extensions such as the Vlocity Action framework.

• Action API
  Return a list of actions of type VlocityAction__c.
• Calculation Procedure
  The Calculation Procedure API is an end point to get the calculation procedure result based on one set of data.
• Attribute Objects APIs
  The Attribute Objects APIs control attributes and attribute categories. Attributes, formerly known as segments, describe objects.
• Campaign APIs
  Vlocity Relationship Manager enables sales advisors to create a call list campaign from customer contacts that Vlocity IQ has identified as potentially interested in a [document]. The Campaign APIs enable you to create and interact with these campaigns. POSTing to the /campaign resource streamlines creating the call list campaigns, with interested contacts and relevant documents attached in one API call. PUT updates the campaign status and members. GET accesses one or more campaigns that the current user has created from a given document.
• Integration Procedure APIs
  Call the specified Integration Procedure. You can call an Integration Procedure using GET or POST. For a POST call, the POST body is sent to the Integration Procedure as the input, and HTTP headers are sent in the "options" JSON node.
• DataPacks APIs
  The Vlocity DataPack APIs are not meant for general use.
• Organization API
  Returns the current organization information.
• Customer Stories and Story Quick Actions APIs
  A story is a timeline of anything Salesforce logs for each customer or account. For a specified parent object, stories show the child objects in chronological order on one page. The Stories APIs get that information to display. Without these APIs, you would have to run multiple queries to get all of the child objects.
• Omnistudio Data Mapper APIs
  A Data Mapper is a flexible, yet powerful data loading and extraction engine that greatly simplifies importing and exporting relational data. With Data Mappers, you can map denormalized data exported from legacy and product-centric systems into Salesforce's customer-centric relational schema. You can map fields from interface objects to standard and custom objects, including defining foreign key relationships. Data Mappers support lookup mappings, which map data in existing objects to new fields, as well as linked mappings, which map data created in previous mapping steps to new fields. Data Mappers can also use a preprocessor Apex class to manipulate data before mapping. Detailed error logging is available to assist administrators in resolving import issues.