Copy Data

This REST API is used to execute a Copy Data job using the profile name. Before executing this job, you should create a Copy Data profile in Financial Consolidation and Close.

For details on this task, see Using Copy Data Profiles.

This REST API returns the job id after starting the Copy Data job.

REST Resource

POST /HyperionPlanning/rest/{api_version}/applications/{application}/jobs


Supported Media Types: application/json

Table 12-14 Parameters

Name Description Type Required Default
api_version Version of the API you are working with: v3 Path Yes None

The name of the application

Get the application name by using the Get Applications API, for example, FCCS or TRCS. See Get Applications.

Path Yes None
jobName Name of the job should be: EXECUTE PROFILE String Yes None
jobType Type of Job. Supported value: COPY_DATA String Yes None
ProfileName Name of the profile to use to copy data String Yes None

Example of Request Body

    "jobType": "Copy_Data",
    "jobName": "Execute Profile",
    "parameters": {
        "ProfileName": "<ProfileName>",

Response Body

Supported Media Types: application/json

Table 12-15 Parameters

Name Description
type Financial Consolidation and Close Application type, for example, FCCS
status Status of the job: -1 =In progress; 0 = Success; 1 = Fail
details In case of errors, details are published with the error string.
descriptiveStatus The status of the job, such as Completed or Error
items Collection of Notification categories
links Detailed information about the link
href Links to API call
action The HTTP call type
rel Relationship type. Possible values: self

Example of Response Body:

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

  "jobId": 8,
  "descriptiveStatus": "Processing",
  "details": null,
  "jobName": "Copy Data",
  "status": -1,
  "links": [