Create a new Job
post
https://<servername>:<port number>/epm/rest/v1/jobs
Start a new Narrative Reporting job for asynchronous execution by the service.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Narrative Reporting Job
Root Schema : schema
Type:
object
Narrative Reporting Job
Show Source
-
jobType: string
Allowed Values:
[ "EXPORT_LIBRARY_ARTIFACT", "IMPORT_LIBRARY_ARTIFACT", "CREATE_DB_SNAPSHOT", "EXECUTE_BURST", "CREATE_REPORT_SNAPSHOT" ]
The Job type to execute. The valid job types are: * EXPORT_LIBRARY_ARTIFACT - The specified artifact will be exported to the Library or to a location where it can be downloaded later. * IMPORT_LIBRARY_ARTIFACT - The artifacts contained in the specified file will be imported into the Library. * CREATE_DB_SNAPSHOT - The service will create a new database backup snapshot file (EPRCS_Backup.tar.gz) and make it available for download using the EPRCSCTL download_db_snapshot command or the EPMAutomate downloadFile command. The service maintains the latest database snapshot only. This command will replace any prior snapshot that was generated by the daily maintenance or by executing this job type. * EXECUTE_BURST - The specified bursting definition will be executed. * CREATE_REPORT_SNAPSHOT - Create a report snapshot based on the passed in parameter of either the report id or report name. -
parameters:
parameters
Nested Schema : parameters
Match One Schema
Show Source
-
object
ImportArtifactJobParameters
To execute an artifact import from the Library, the following parameters may be specified.
-
object
ExportArtifactJobParameters
To execute an artifact export from the Library, the following parameters may be specified.
-
object
CreateDBSnapshotJobParameters
When creating a new database snapshot, the following parameters may be specified.
-
object
ExecuteBurstJobParameters
When executing a bursting job, the following parameters may be specified.
-
object
CreateReportSnapshotJobParameters
When creating a new report snapshot, the following parameters may be specified.
Nested Schema : ImportArtifactJobParameters
Type:
object
To execute an artifact import from the Library, the following parameters may be specified.
Show Source
-
deleteAfterImport: boolean
true or false value. If true, the file being imported will be deleted after a successful import (default is false).
-
errorFile: string
(optional) The log file name to be created. The log file will be available to download using EPMAutomate's downloadFile command.
-
importFile(required): string
The import file's name. If the file is located in the Library, importFile should specify the full path to the Library file. If the file was uploaded to the Files REST API, importFile should specify the temporary file UUID that was returned from the Files API. If the file was uploaded using EPMAutomate, importFile should specify the file name used for the upload.
-
importFolder: string
The Library folder where the artifact will be imported.
-
importFormat: string
Allowed Values:
[ "Native", "File" ]
The format of the file to be imported. * Native - The file will be imported as a native NR / EPRCS exported file. (default) * File - The file will be imported and retain its original format. For example, if the imported file is a zip file, it will be imported to the Library as a zip file. -
importLocation: string
Allowed Values:
[ "Temporary", "Library", "File" ]
The location of the import file. If no import location is specified, import will attempt to lookup the three possible repositories. * Temporary - The import process will use the file that was uploaded using the Files REST API. * Library - The import process will use the file from the Narrative Reporting Library. * File - The import process use the file uploaded by EPMAutomate's uploadFile command. -
importPermissions: boolean
true or false value. If true, the permissions that are included in the import file will be re-assigned after a successful import (default is false).
-
overwrite: boolean
If true, the artifact will be overwritten if it exists in the in the importFolder specified (default is false).
Nested Schema : ExportArtifactJobParameters
Type:
object
To execute an artifact export from the Library, the following parameters may be specified.
Show Source
-
applicationName: string
The application name associated with the Report being exported. This parameter is required when using the LCM export format.
-
artifactName(required): string
The artifact to be exported.
-
artifactType: string
Allowed Values:
[ "ReportPackageResourceType", "ReportResourceType", "ReportSnapshotResourceType", "FolderResourceType", "FileResourceType", "FontResourceType", "BurstingDefinitionResourceType", "BookResourceType" ]
The type of the artifact to export. Supported artifact types are "ReportPackageResourceType","ReportResourceType","ReportSnapshotResourceType","FolderResourceType","FileResourceType","FontResourceType","BurstingDefinitionResourceType" and "BookResourceType" -
errorFile: string
The log file name to be created. The log file will be available to download using EPMAutomate's downloadFile command.
-
exportFormat: string
Allowed Values:
[ "Native", "File", "LCM" ]
The export format of the exported artifact. * Native - exports the artifact in native in NR/EPRCS format which is a zip file(default). * File - exports the artifact in its original binary format. For example if the artifact is a PDF or MS Word doc, it will be exported as a PDF or a Word doc and not as a zip file. * LCM - The artifact will be exported in the EPM LCM format. This format can only be used for Reports. When using the LCM format, the applicationName parameter must also be specified. -
exportLibraryFolder: string
The Library folder where the exported artifact will be stored.
-
exportLocation: string
Allowed Values:
[ "Temporary", "Library", "File" ]
The destination for the export. * Temporary - The artifact will be exported for download using the Files REST API (default). * Library - The artifact will be exported to the Narrative Reporting Library. * File - The artifact will be exported to a file that can be downloaded using EPMAutomate's downloadFile command. -
saveAsFile: string
The file name to use when exporting the artifact.
Nested Schema : CreateDBSnapshotJobParameters
Type:
object
When creating a new database snapshot, the following parameters may be specified.
Show Source
-
errorFile: string
The log file name to be created. The log file will be available to download using EPMAutomate's downloadFile command.
Nested Schema : ExecuteBurstJobParameters
Type:
object
When executing a bursting job, the following parameters may be specified.
Show Source
-
artifactFullPath: string
The full library path of the burst definition to execute. This parameters should be passed if not passing the path as part of the burstingDefinitionName.
-
burstingDefinitionId: string
The id of the burst definition to execute. This parameter should be used if not passing a burstingDefinitionName parameter.
-
burstingDefinitionName: string
The name of the burst definition to execute. The name can contain the full library path of the artifact. This parameter is required if burstingDefinitionId is not being passed as a parameter.
Nested Schema : CreateReportSnapshotJobParameters
Type:
object
When creating a new report snapshot, the following parameters may be specified.
Show Source
-
globalPov: string
(Optional) The Report will be generated using the dimension and member selections specified in the global point of view (POV). The selected members will apply to the Report elements configured to accept a POV. The globalPov is specified as a comma separated list of dimension:member values.
-
libraryLocation: string
(Optional) The library folder to save the snapshot into.
-
overwrite: string
(Optional) Parameter indicating if the snapshot should overwrite an existing snapshot.
-
prompts: string
(Optional) The Report will be generated using the selections specified for each of the prompt values. The prompts parameter value is specified as a comma separated list of promptId:selection values. The prompt Id is a UUID as returned by the prompts request on the Report resource. The selections can be semi-colon separated if the prompt allows for multiple selections. For example, prompts=24fdcfca-a5d4-4123-a60f-5169abc21837:Actual;Budget,56fdcfca-5423-b54d-a60b-3156abc23478:2017;2018
-
reportId: string
The ID of the report to execute the snapshot. This parammeter is required if not passing the reportName parameter.
-
reportName: string
The name of the Report to execute the snapshot. This parameter is required if not passing the ReportId parameter.
-
snapShotName: string
(Optional) The name the snapshot should be saved as.
Response
Supported Media Types
- application/json
201 Response
The Job was received and queued by the server.
Root Schema : JobStatus
Type:
object
Status of a Narrative Reporting Job.
Show Source
-
descriptiveStatus: string
Read Only:
true
The textual status of the job, such as Completed or Error. -
details: string
Read Only:
true
The detailed result of the job execution. -
jobId: string
Read Only:
true
-
jobName: string
Read Only:
true
-
jobType: string
Read Only:
true
Allowed Values:[ "EXPORT_LIBRARY_ARTIFACT", "IMPORT_LIBRARY_ARTIFACT", "CREATE_DB_SNAPSHOT", "EXECUTE_BURST", "CREATE_REPORT_SNAPSHOT" ]
The Job type. -
links: array
links
Read Only:
true
-
status: integer
Read Only:
true
The status of the job (-1 = in progress, 0 = completed, 1 = error, 3 = cancelled).
Nested Schema : items
Match One Schema
Show Source
-
object
ExportArtifactJobStatusLink
Links to the export job status and job execution results. * [rel=self] provides a link to the current job status. * [rel=log] provides a link to the export log in the Library. * [rel=exported/artifact] * If the job parameter exportLocation was specified as Library, this will provide a link to the exported artifact in the Library. * If the job parameter exportLocation was specified as Temporary, this will provide a link to the Files API to download the file directly. * If the job parameter exportLocation was specified as File, this link will not be provided. The file may be downloaded using EPMAutomate's downloadFile command.
-
object
ImportArtifactJobStatusLink
Links to the import job status and job execution results. * [rel=self] provides a link to the current job status. * [rel=log] provides a link to the import log in the Library. * [rel=imported/artifact] provides a link to the imported artifact in the Library.
-
object
CreateDBSnapshotJobStatusLink
Links to the create database snapshot job status and job execution results. * [rel=self] provides a link to the current job status. * [rel=log] provides a link to the snapshot log.
-
object
ExecuteBurstJobStatusLink
Links to the execute bursting definition job status and job execution results.
-
object
CreateReportSnapshotJobStatusLink
Links to the create report snapshot job status and job execution results. * [rel=self] provides a link to the current job status.
Nested Schema : ExportArtifactJobStatusLink
Type:
object
Links to the export job status and job execution results.
* [rel=self] provides a link to the current job status.
* [rel=log] provides a link to the export log in the Library.
* [rel=exported/artifact]
* If the job parameter exportLocation was specified as Library, this will provide a link to the exported artifact in the Library.
* If the job parameter exportLocation was specified as Temporary, this will provide a link to the Files API to download the file directly.
* If the job parameter exportLocation was specified as File, this link will not be provided. The file may be downloaded using EPMAutomate's downloadFile command.
Show Source
-
href: string
Read Only:
true
-
rel: string
Read Only:
true
Allowed Values:[ "self", "log", "exported/artifact" ]
Nested Schema : ImportArtifactJobStatusLink
Type:
object
Links to the import job status and job execution results.
* [rel=self] provides a link to the current job status.
* [rel=log] provides a link to the import log in the Library.
* [rel=imported/artifact] provides a link to the imported artifact in the Library.
Show Source
-
href: string
Read Only:
true
-
rel: string
Read Only:
true
Allowed Values:[ "self", "log", "imported/artifact" ]
Nested Schema : CreateDBSnapshotJobStatusLink
Type:
object
Links to the create database snapshot job status and job execution results.
* [rel=self] provides a link to the current job status.
* [rel=log] provides a link to the snapshot log.
Show Source
-
href: string
Read Only:
true
-
rel: string
Read Only:
true
Allowed Values:[ "self", "log" ]
Nested Schema : ExecuteBurstJobStatusLink
Type:
object
Links to the execute bursting definition job status and job execution results.
Show Source
-
href: string
Read Only:
true
-
rel: string
Read Only:
true
Allowed Values:[ "self" ]
Nested Schema : CreateReportSnapshotJobStatusLink
Type:
object
Links to the create report snapshot job status and job execution results.
* [rel=self] provides a link to the current job status.
Show Source
-
href: string
Read Only:
true
-
rel: string
Read Only:
true
Allowed Values:[ "self" ]
400 Response
Invalid parameter
Root Schema : ExceptionDetail
Type:
object
Detailed exception information.
Show Source
-
detail: string
Human-readable description specific to this occurrence of the problem.
-
status: integer
HTTP status code for this occurrence of the problem, set by the origin server.
-
title: string
Short, human-readable summary of the problem.
-
type: string
Absolute URI [RFC3986] that identifies the problem type.
500 Response
Service Error
Root Schema : ExceptionDetail
Type:
object
Detailed exception information.
Show Source
-
detail: string
Human-readable description specific to this occurrence of the problem.
-
status: integer
HTTP status code for this occurrence of the problem, set by the origin server.
-
title: string
Short, human-readable summary of the problem.
-
type: string
Absolute URI [RFC3986] that identifies the problem type.