Jump to

• Request
• Response
• Examples

Import Rules

post

/essbase/rest/v1/utils/rules/actions/import

Imports a rules file.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• overwrite(optional): boolean

  Optional overwrite specification. Default value is false, meaning if the rules file already exists, an error is returned. When set to true, if the rule file already exists, it will be overwritten.

  Default Value: false

Body ()

File path information: source and destination catalog paths.

Root Schema : FilePathDetail

Type: object

Show Source

• from(optional): string
• to(optional): string

{
    "type":"object",
    "properties":{
        "to":{
            "type":"string"
        },
        "from":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Rules file imported successfully.

400 Response

Bad Request

Failed to import rules file. The file path information may be incorrect.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to import an Essbase data load or dimension build rule file definition to create a new rule.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Commands

The following script imports a data load rule definition to Sample Basic.

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/utils/rules/actions/import" -H Accept:application/json -H "Content-Type: application/json" -d '{ "from": "/shared/dataload_rul.json", "to": "/applications/Sample/Basic/newdataload.rul" }' -u %User%:%Password%

Back to Top