Create Application

Creates an application. An environment can contain only one application.

Required Roles

  • Any application role, and
  • Application Creator and Dimension Editor granular roles

REST Resource

POST /HyperionPlanning/rest/v3/applications

Request

Send a JSON request body with Content-Type: application/json. Use HTTP Basic authentication or an SSO token in the sso_token header. Supply only the parameters supported by the selected application type.

Table 3-3 Request Parameters

Name Description Type Required Default
name Application name, up to eight letters, digits, or underscores. Payload Yes None
description Nonblank application description, up to 255 characters. Payload Yes None
businessProcessType Business process: Planning, FreeForm, or Financial Consolidation and Close; use a supported combination below. Payload Yes None
applicationType Application type selected from the supported combinations below. Payload Yes None
startYear Four-digit fiscal start year, from 1000 to 9999; not accepted for FreeForm. Payload No Not specified
numberOfYears Number of fiscal years to create, at least one; not accepted for FreeForm. Payload No Not specified
planningFrequency Calendar frequency: Custom accepts 12 Months, Monthly, Weekly, or Quarterly; Modules and FCCS accept monthly or 13 Period. Payload For 13 Period 12 Months where supported
fiscalYearStartMonth Fiscal start month, January through December; omit for 13-period calendars and FreeForm. Payload No Not specified
defaultCurrency Default application currency, such as USD; not accepted for FreeForm. Payload No Not specified
supportMultiCurrency Enables multi-currency; supported for Custom, Modules, Sales Planning, Strategic Workforce Planning, and FCCS. Payload No true; FCCS: false
multiCurrencyType Multi-currency mode: Standard or Simplified for Custom; Sales Planning and Strategic Workforce Planning use Simplified when enabled. Payload No Custom: Simplified
enableSandboxes Enables sandboxes for Custom or Modules applications. Payload No false
taskFlowType Task management for Custom, Modules, Sales Planning, or Strategic Workforce Planning: Task List or EPM Task Manager. Payload No Not specified
rollingForecast Enables rolling forecast for Custom applications. Payload No false
rollingForecastPeriodDuration Rolling-forecast duration; accepted only when rollingForecast is true. Payload No 1 when enabled
inputCubes BSO input cubes; required for Custom and Modules, and conditionally required for FreeForm Create Cubes. Payload Conditional—see the Application Types and Cube Requirements table below. None
inputCubes[].name Input cube name, up to eight letters, digits, or underscores. Payload For each cube None
inputCubes[].description Input cube description, up to 255 characters. Payload No Not specified
reportingCubes ASO reporting cubes; required for Custom and Modules, and conditionally required for FreeForm Create Cubes. Payload Conditional—see the Application Types and Cube Requirements table below. None
reportingCubes[].name Reporting cube name, up to eight letters, digits, or underscores. Payload For each cube None
reportingCubes[].description Reporting cube description, up to 255 characters. Payload No Not specified
weeklyDistribution Weekly distribution for supported monthly applications: Even, 4-4-5, 4-5-4, or 5-4-4. Payload No Not specified
customDimensions Up to three additional custom dimension names for Custom applications, each up to 80 characters. Payload No Not specified
standardDimensionRenames Standard dimension renames for Custom, Modules, Sales Planning, Strategic Workforce Planning, or Cash Forecasting. Payload No Not specified
standardDimensionRenames[].sourceDimension Standard dimension to rename: Period, Scenario, Version, Account, or Entity; Custom also supports Years. Payload For each rename None
standardDimensionRenames[].renamedDimensionName New unique standard dimension name, up to 80 characters. Payload For each rename None
dimensionMembersSourcePath Planning Inbox ZIP path containing dimension-member CSV files for Custom applications. Payload No Not specified
period13 13-period calendar options for Modules or FCCS; omit for other frequencies. Payload No Application-specific
period13.prefix Period-name prefix, up to 15 letters, digits, or underscores. Payload No Modules: TP; FCCS: P
period13.distribution 13-period weekly distribution: 3-3-3-4, 3-3-4-3, 3-4-3-3, or 4-3-3-3. Payload No 3-3-3-4
period13.fiscalYearEndDayOfWeek Weekday used to determine the fiscal year end for Modules 13-period calendars. Payload No Not specified
period13.closestToMonthEnd For Modules, true uses the weekday closest to month end; false uses its last occurrence in the month. Payload No Not specified
period13.fiscalYearEndMonth Fiscal year-end month for Modules 13-period calendars. Payload No Not specified
period13.extraWeekFiscalPeriod Period receiving an extra week, from 1 to 13, for Modules 13-period calendars. Payload No Not specified
period13.fiscalCalendarYear Modules fiscal calendar year convention: Current Calendar Year or Previous Calendar Year. Payload No Not specified
createHytdMembers Creates HYTD members in the FCCS period hierarchy. Payload No false
setupType FreeForm setup method: Create Cubes or Import File. Payload For Import File Create Cubes
sourceFile Planning Inbox .otl or .zip filename for FreeForm Import File; not accepted for Create Cubes. Payload For Import File None
standardDimensions Standard dimensions enabled across the cubes created by FreeForm Create Cubes; omitted dimensions remain disabled. Payload No Not specified
standardDimensions[].dimensionType FreeForm standard dimension type: ACCOUNT, ENTITY, or PERIOD. Payload For each dimension None
standardDimensions[].name Name of the FreeForm standard dimension, up to 80 characters. Payload No Not specified

Table 3-4 Application Types and Cube Requirements

businessProcessType applicationType / setupType Cube requirements Other conditions
Planning Custom Both lists are required, each with at least one cube. The first cube in each list is primary; at most two additional cubes are allowed across both lists. Supports calendar, currency, sandbox, task-flow, rolling-forecast, custom-dimension, rename, and dimension-import settings.
Planning Modules — monthly Both lists are required, each with exactly one cube. planningFrequency is 12 Months or Monthly, or may be omitted. Supports fiscalYearStartMonth, weeklyDistribution, taskFlowType, sandboxes, and dimension renames.
Planning Modules — 13 Period Both lists are required, each with exactly one cube. Set planningFrequency to 13 Period. period13 is optional; omit fiscalYearStartMonth and weeklyDistribution.
Planning Sales Planning or Strategic Workforce Planning Neither cube list is accepted; cube names are fixed. Monthly planning is implicit. Supports currency, weeklyDistribution, taskFlowType, and dimension renames; omit planningFrequency and enableSandboxes.
Planning Cash Forecasting Neither cube list is accepted; cube names are fixed. Supports startYear, numberOfYears, fiscalYearStartMonth, defaultCurrency, and dimension renames. Omit planningFrequency, supportMultiCurrency, multiCurrencyType, enableSandboxes, weeklyDistribution, and taskFlowType.
Financial Consolidation and Close Financial Consolidation and Close Neither cube list is accepted; cube names are fixed. Supports monthly or 13 Period calendars, currency, and createHytdMembers. period13 supports prefix and distribution only. Omit customDimensions, standardDimensionRenames, enableSandboxes, multiCurrencyType, weeklyDistribution, and taskFlowType.
Planning or FreeForm FreeForm — Create Cubes At least one of the lists must contain a cube; both lists are not mandatory. At most 12 cubes are allowed across both lists. setupType may be omitted. standardDimensions is optional; omit sourceFile and calendar/planning options.
Planning or FreeForm FreeForm — Import File Neither cube list is accepted. Set setupType to Import File and supply sourceFile. Omit standardDimensions and calendar/planning options.

For Custom, fiscalYearStartMonth and weeklyDistribution apply to monthly calendars only. For Modules and FCCS, Monthly is an alias for 12 Months; omit fiscalYearStartMonth for 13 Period. FCCS accepts period13 only for 13 Period.

Do not supply multiCurrencyType when supportMultiCurrency is false. Sales Planning and Strategic Workforce Planning use Simplified Multi Currency whenever multi-currency is enabled. rollingForecastPeriodDuration is accepted only when rollingForecast is true.

Cube and dimension names must be unique without regard to case. Each sourceDimension may be renamed once; final dimension names must remain unique, and custom dimension names must not collide with them. For dimensionMembersSourcePath, each ZIP entry must be a dimension-member CSV whose base filename matches its dimension name.

Custom dimension names must not contain square brackets, parentheses, braces, colons, commas, semicolons, plus signs, equals signs, angle brackets, vertical bars, backslashes, double quotation marks, or tabs. Reserved cube and dimension names are rejected.

Example request — Custom Planning application:

{
  "name": "App1001",
  "description": "Planning and Budgeting application",
  "businessProcessType": "Planning",
  "applicationType": "Custom",
  "startYear": 2026,
  "numberOfYears": 5,
  "planningFrequency": "Monthly",
  "fiscalYearStartMonth": "January",
  "defaultCurrency": "USD",
  "supportMultiCurrency": true,
  "multiCurrencyType": "Simplified",
  "weeklyDistribution": "Even",
  "taskFlowType": "EPM Task Manager",
  "inputCubes": [
    {
      "name": "Plan1"
    },
    {
      "name": "Plan2",
      "description": "Additional BSO cube"
    }
  ],
  "reportingCubes": [
    {
      "name": "Rep1"
    },
    {
      "name": "Plan3",
      "description": "Additional ASO cube"
    }
  ],
  "customDimensions": [
    "Product",
    "Channel"
  ],
  "standardDimensionRenames": [
    {
      "sourceDimension": "Account",
      "renamedDimensionName": "Ledger"
    },
    {
      "sourceDimension": "Entity",
      "renamedDimensionName": "Market"
    }
  ],
  "dimensionMembersSourcePath": "PBCS_CreateApp_Years.zip",
  "enableSandboxes": false,
  "rollingForecast": true,
  "rollingForecastPeriodDuration": 3
}

Example request — Modules application with a 13-period calendar:

{
  "name": "App2002",
  "description": "Enterprise planning application with 13-period calendar",
  "businessProcessType": "Planning",
  "applicationType": "Modules",
  "startYear": 2026,
  "numberOfYears": 5,
  "planningFrequency": "13 Period",
  "defaultCurrency": "USD",
  "supportMultiCurrency": true,
  "inputCubes": [
    {
      "name": "ModFs"
    }
  ],
  "reportingCubes": [
    {
      "name": "ModAso"
    }
  ],
  "enableSandboxes": false,
  "period13": {
    "prefix": "TP",
    "distribution": "3-3-3-4",
    "fiscalYearEndDayOfWeek": "Saturday",
    "closestToMonthEnd": false,
    "fiscalYearEndMonth": "December",
    "extraWeekFiscalPeriod": 13,
    "fiscalCalendarYear": "Current Calendar Year"
  }
}

Example request — Financial Consolidation and Close application:

{
  "name": "FCCS100",
  "description": "Financial Consolidation and Close application",
  "businessProcessType": "Financial Consolidation and Close",
  "applicationType": "Financial Consolidation and Close",
  "startYear": 2026,
  "numberOfYears": 5,
  "planningFrequency": "13 Period",
  "period13": {
    "prefix": "P",
    "distribution": "3-3-3-4"
  },
  "defaultCurrency": "USD",
  "supportMultiCurrency": true,
  "createHytdMembers": false
}

Example request — FreeForm application with Create Cubes setup:

{
  "name": "FFAPP2",
  "description": "FreeForm app with explicit cubes",
  "businessProcessType": "FreeForm",
  "applicationType": "FreeForm",
  "setupType": "Create Cubes",
  "inputCubes": [
    {
      "name": "Plan1"
    }
  ],
  "reportingCubes": [
    {
      "name": "Rep1"
    }
  ],
  "standardDimensions": [
    {
      "dimensionType": "ACCOUNT",
      "name": "Account"
    },
    {
      "dimensionType": "ENTITY",
      "name": "Entity"
    },
    {
      "dimensionType": "PERIOD",
      "name": "Period"
    }
  ]
}

Example request — FreeForm application with Import File setup:

{
  "name": "FFAPP1",
  "description": "FreeForm app from OTL",
  "businessProcessType": "FreeForm",
  "applicationType": "FreeForm",
  "setupType": "Import File",
  "sourceFile": "Basic.otl"
}

Example URL

https://<BASE-URL>/HyperionPlanning/rest/v3/applications

Response

Supported Media Types: application/json

Successful creation returns HTTP 201 Created.

Table 3-5 Response Parameters

Name Description
name Name of the created application.
description Description of the created application.
businessProcessType Business process of the created application.
applicationType Application type of the created application.
links Links to the application and related operations.
links[].rel Relationship of the linked resource to this resource.
links[].href URL of the linked resource.
links[].action HTTP method used to access the linked resource.

Sample Response

{
  "name": "App1001",
  "description": "Planning and Budgeting application",
  "businessProcessType": "Planning",
  "applicationType": "Custom",
  "links": [
    {
      "rel": "self",
      "href": "https://<BASE-URL>/HyperionPlanning/efsuirest/v3/applications/App1001",
      "action": "GET"
    }
  ]
}