Copy Data
This REST API is used to execute a Copy Data job using the job name. Before executing this job, you should create a Copy Data job in Tax Reporting.
For details on this task, see "Using Copy Data Job" in Administering Tax Reporting
This REST API returns the job ID after starting the Copy Data job.
REST Resource
POST
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs
Required Roles
Service Administrator
Request
Supported Media Types: application/json
Table 22-3 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
api_version |
Version of the API you are working with: v3 | Path | Yes | None |
application |
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 |
Payload | Yes | None |
jobType |
Type of Job. Supported value: COPY_DATA |
Payload | Yes | None |
ProfileName |
Name of the saved copy data job | Payload | Yes | None |
Example of Request Body
{
"jobType": "COPY_DATA",
"jobName": "Execute Profile",
"parameters": {
"ProfileName": "CopyJobTesting"
}
}
Response Body
Supported Media Types: application/json
Table 22-4 Parameters
Name | Description |
---|---|
type |
Tax Reporting Application type, for example, TRCS |
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": 45,
"jobName": "Copy Data",
"descriptiveStatus": "Processing",
"details": null,
"status": -1,
"links": [
{
"href": "https://https://<BASE-URL>/HyperionPlanning/rest/v3/applications/<applicationName>/jobs/<JobId>",
"rel": "self",
"action": "GET"
},
{
"href": "https://https://<BASE-URL>/HyperionPlanning/rest/v3/applications/<applicationName>/jobs/<JobId>/details",
"rel": "job-details",
"action": "GET"
}
]
}