New Cloud EPM Platform REST APIs

New REST APIs that support the Cloud EPM Platform features such as application and object discovery, forms, dashboards, dimensions and members, cubes, jobs, and so on are now available. These APIs are used by the Data Exploration EPM Agent skills.

Applies to: FreeForm, Planning

Platform APIs deal with areas such as application artifacts, data, metadata, semantics, Insights, connections, and user context.

Number of Platform APIs in this update: 141

Core Platform REST APIs

Area and Number of APIs API Operations
Applications (7)
 		 List/get applications, retrieve summary and update metadata. Create application contract for direct clients. Delete application (reference only).
Cubes (3) List cubes, get a cube and create cube.
Dimensions and members (12)
 		 List/get dimensions, create/update by application or cube, add/get dynamic child members, batch save, evaluate selections and secured member search
Calculation Manager (16) List, get, create, replace, delete rules and rulesets. Validate payload, validate existing artifact, and deploy rules and rulesets.
Form definitions (5) Create, get, PATCH, replace and delete form definitions.
Dashboard definitions (6)

Create, get, PATCH, replace and delete definitions. PATCH a dashboard component.

Data, Workflow and User Context APIs

Area and Number of APIs API Operations
Data export / import (10) Forms: GET data, POST export/load and POST import/save. Dashboards: export/import component data. Cubes: ad hoc/slice/MDX export, slice import and clear.
Jobs (5)  Execute a job, list definitions, retrieve job status/details and child-job details.
Approval units (6)  listPlanningUnits, getPlanningUnit, getPlanningUnitHistoryAndAnnotations,
getPlanningUnitPromotionPath, changePlanningUnitStatus, getPlanningUnitAvailableActions.
Substitution variables (8) Application and cube scopes: list, set, get one and delete one.
User variables (7) Definitions: list, create/update, get by ID and delete by ID. Values: list, update and get by variable name.
Profiles / POV / photo (9) Get current/named-user profiles, retrieve/merge/replace current and named-user POVs, retrieve approval-unit owner photo.
User preferences (9) Get/save current-user preferences, get effective formatting preferences, get/set current/named-user sticky preferences and named-user preferences.

Semantics and Intelligence APIs

   
Business Concepts (11)  List/create/get/update/partially update/delete concepts. Search, resolve, audit coverage, discover related objects/members and query associations
Business Concepts Objects and associations (6) Search objects. List, replace, add/update and delete an object’s Business Concept associations.
Business Concepts Semantic Foundation (10)  Resolve POV, retrieve live context, find forms by slices, export/import semantic workbooks. List/create/get/replace/delete context intersections.
Insights  (4) getInsights, getInsightById, executeInsightAnalysis, getInsightSummary.
IPM calendar (2) createIpmCalendar, getIpmCalendar.
Service connections (5)  getServiceConnections, createServiceConnection, getServiceConnection,
updateServiceConnection, deleteServiceConnection.

Business Benefit: These APIs helps you create your custom programs and skills to execute Cloud EPM Platform tasks.

Key resources