MENU
    List of APIs
    • 1 Minute to read
    • Dark
    • PDF

    List of APIs

    • Dark
    • PDF

    Article summary

    Master and Analytic Model APIs

    Description

    Append Attributes

    Use this API to create or append attributes and attribute hierarchies, specify display labels for attributes, and create or modify attribute-to-dimension-member mappings in Master and Analytic models.

    Append Dimension Members

    Use this API to add new members into an existing dimension in Master and Analytic models. The model should already be generated and the dimension should exist

    Calculation Run

    This API is used to execute a Calculation defined in Dynamic Planning.

    Calculation Status

    This API returns the current and last status of the running of a calculation.

    Clear Data

    This API clears existing data from Master and Analytic models based on the scope of the definition.

    Clear Leaf Data

    This API clears existing leaf data from Master and Analytic models based on the scope of the definition.

    Export Dimension / Attribute Hierarchy

    This API allows you to export the entire dimension hierarchy from a specified model in XML format. The following data is exported:

    • Hierarchy member code

    • Hierarchy member parent

    • Hierarchy member rollup operator

    • Hierarchy member display label

    • Mapped attributes

    Note:
    DAP (Direct Access to PCR) models and the HACPM_Financial model are not supported with this API. Additionally, the root member (top most member of the hierarchy) will not have a <Member-Parent> tag.

    Export Leaf-Level Data (Scoped)

    This API allows you to export leaf-level data from a specified model in XML format. Optionally, you can specify one or more filters to export specific data.

    Load Data

    This API loads data to Master and Analytic models.

    External Source Model APIs

    Description

    External Source Models APIs that support the new implementation of ESM as of November 2018 are marked with the icon .

    Clear Data 

    This API clears data from an external data source model.

    Clear Dimension Members

    This API clears existing dimension member data available in an external source model.

    Export Leaf-Level Data (Scoped) 

    This API allows you to export leaf-level data from an external source model in XML format. Optionally, you can specify one or more filters to export specific data, and you can specify which fields to export.

    Load Data 

    This API loads data to an external source model.

    Load Dimension Members (Metadata)

    This API loads dimension members to an external source model.

     

     

    User Management APIs

    Description

    Create Users and Groups

    These APIs add users and user group mappings, and delete users.

    List Users and Groups

    These APIs return the names of users or user groups for a tenant.

    Note:
    Loading data and running calculations in Dynamic Planning can be scheduled by leveraging scheduling options available in cloud integration solutions like Boomi.

    Was this article helpful?