Planning REST API Client

The Planning REST API client provides the following methods:

• Client creation using com.oracle.ceal.PbcsRestClient (PbcsClientRestClient.groovy)

  PbcsRestClient pbcsClient=new PbcsRestClient(pbcsParams.planningRestUrl,pbcsParams.interopRestUrl,pbcsParams.proxyHost,pbcsParams.proxyPort,pbcsParams.identityDomain,pbcsParams.username, pbcsParams.password, pbcsParams.ignoreSSLCertificationPathErrors)

• List all files

  pbcsClient.listFiles()

• Delete a file

  pbcsClient.deleteFile(fileName)

• Export data

  response=pbcsClient.exportData(appName, Job name for export, export filename on server)

• Get job status

  pbcsClient.getJobStatus(appName,jobId)

• Download file

  pbcsClient.downloadFile(server file name, local destination folder)

• Export metadata

  pbcsClient.exportMetaData(appName,job name for metadata export, Export filename on server)

• Execute LCM Export

  pbcsClient.executeLCMExport(snapshot name)

• Run business rule

  pbcsClient.runBusinessRule(appname,business rule,runtime prompts)

  Example:

  pbcsClient.runBusinessRule("Vision","AggOliv","{Period:Q1,Entity:USA}")

• Cube refresh

  pbcsClient.cubeRefresh(appname,jobname)

  Example:

  pbcsClient.cubeRefresh("Vision","RefreshOliv")

• Run plantype map

  pbcsClient.runPlanTypeMap(appname, jobname, cleardata true/false)

  Example:

  pbcsClient.cubeRefresh("Vision","RefreshOliv")pbcsClient.runPlanTypeMap("Vision","MapOliv","false")

• Run Ruleset

  pbcsClient.runRuleSet(appname, ruleset)

• Import data

  pbcsClient.importData(appname, jobname, export filename)

  Last parameter (export filename) defaults to jobname if no server import filename is specified

• Import metadata

  pbcsClient.importMetaData(appname, jobname, export metadata filename)

  Last parameter defaults to jobname if no server import filename is specified

  Example:

  pbcsClient.importMetaData("Vision","ImportMetaOliv","ExportMetadataOliv.zip")

• Execute LCM import

  pbcsClient.executeLCMImport(snapshot name)

• Upload file

  pbcsClient.uploadFile(Local folder containing file to upload to server,file to upload)

  Example:

  //local folder, and filename as parameters

  pbcsClient.uploadFile("d:\\temp","ExportOliv.zip")