Execute Supplemental Data Manager Job

This API will execute the job based on the job type provided as a JSON parameter. It is an asynchronous API. This API will respond with a callback API to get the Job status.

Table 20-7 Supplemental Data Manager Supported Job Types

Job Type Description
SDM_IMPORT_DIM_MEMBERS This job automates the bulk update of dimension members on your preferred schedule.

REST Resource

POST /HyperionPlanning/rest/sdm/{api_version}/jobs

Required Roles

Job Type Role
SDM_IMPORT_DIM_MEMBERS Service Administrator, Power User

Request

Supported Media Types: application/json

Parameters

This table summarizes the request parameters that are generic to all jobs. The following tables describe parameters specific to individual rules.

Table 20-8 Parameters

Name Description Type Required Default
api_version

Version of the API you are developing with

Path

Yes

None

Table 20-9 SDM_IMPORT_DIM_MEMBERS Parameters

Name Description Type Required Default
jobType

Type of the Job. Value for this job is SDM_IMPORT_DIM_MEMBERS.

String

Yes

None

DimensionName Name of the dimension for which the members need to be imported String Yes None
FileName

Name of the CSV file which contains the dimension member information

String

Yes

None

importMode Mode of the dimension member import. Values are Replace or Update

String

No

Replace
delimiter Delimiter character to parse the CSV data. String No Comma (,)
dateFormat Date format to convert the date or date time value in the CSV file (if any) String No MM-dd-yyyy

Examples of Request Body

Example for Job Type: SDM_IMPORT_DIM_MEMBERS

Example 1:

{
    "jobType": "SDM_IMPORT_DIM_MEMBERS",
    "parameters": {
        "DimensionName": "Control",
        "FileName": "Control_Error.csv"
    }
}

Example 2:

{
    "jobType": "SDM_IMPORT_DIM_MEMBERS",
    "parameters": {
        "DimensionName": "Control",
        "FileName": "Control_Error.csv",
	 "importMode": "Update",
        "delimiter": ",",
        "dateFormat": "MM-dd-yyyy"
     }
}

Response

Supported Media Types: application/json

Table 20-10 Parameters

Name Description
jobId

Supplemental Data job identifier

descriptiveStatus

Additional details about the status

details

Message to the user. In cases where there are errors, the error details are published.

status
  • -1: In Progress

  • 0: Success

  • 1: Failed

items

Not applicable for this job type

links

Detailed information about the link

rel

Valid value: self

href

Links to API call

action

The HTTP call type

Example of Response Body

The following is an example of the response body in JSON format.

{
  "jobId":15016,
  "details": "In Process",
  "status": -1,
  "links": [
    {
      "rel": "self",
      "href": "https://<BASE-URL>/HyperionPlanning/rest/sdm/v1/jobs/15016",
     "action": "GET"
    }
  "error": null,
  "items": [ ],
  "type": EPM
}