Get a Job's status
get
https://<servername>:<port number>/epm/rest/v1/jobs/{jobId}
Get a Narrative Reporting job's status, which will provide links to the job results when the job is complete.
Request
Path Parameters
-
jobId(required): string
The Job UUID being requested.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Request successful
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.
404 Response
Job UUID not found
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.