Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Request successful

Body ()

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).

{
    "type":"object",
    "properties":{
        "descriptiveStatus":{
            "type":"string",
            "description":"The textual status of the job, such as Completed or Error.",
            "readOnly":true
        },
        "details":{
            "type":"string",
            "description":"The detailed result of the job execution.",
            "readOnly":true
        },
        "jobId":{
            "type":"string",
            "readOnly":true
        },
        "jobName":{
            "type":"string",
            "readOnly":true
        },
        "jobType":{
            "type":"string",
            "description":"The Job type.",
            "readOnly":true,
            "enum":[
                "EXPORT_LIBRARY_ARTIFACT",
                "IMPORT_LIBRARY_ARTIFACT",
                "CREATE_DB_SNAPSHOT",
                "EXECUTE_BURST",
                "CREATE_REPORT_SNAPSHOT"
            ]
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "oneOf":[
                    {
                        "$ref":"#/components/schemas/ExportArtifactJobStatusLink"
                    },
                    {
                        "$ref":"#/components/schemas/ImportArtifactJobStatusLink"
                    },
                    {
                        "$ref":"#/components/schemas/CreateDBSnapshotJobStatusLink"
                    },
                    {
                        "$ref":"#/components/schemas/ExecuteBurstJobStatusLink"
                    },
                    {
                        "$ref":"#/components/schemas/CreateReportSnapshotJobStatusLink"
                    }
                ]
            }
        },
        "status":{
            "type":"integer",
            "description":"The status of the job (-1 = in progress, 0 = completed, 1 = error, 3 = cancelled).\n",
            "readOnly":true
        }
    },
    "description":"Status of a Narrative Reporting Job."
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: items

{
    "type":"array",
    "readOnly":true,
    "items":{
        "oneOf":[
            {
                "$ref":"#/components/schemas/ExportArtifactJobStatusLink"
            },
            {
                "$ref":"#/components/schemas/ImportArtifactJobStatusLink"
            },
            {
                "$ref":"#/components/schemas/CreateDBSnapshotJobStatusLink"
            },
            {
                "$ref":"#/components/schemas/ExecuteBurstJobStatusLink"
            },
            {
                "$ref":"#/components/schemas/CreateReportSnapshotJobStatusLink"
            }
        ]
    }
}

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.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/ExportArtifactJobStatusLink"
        },
        {
            "$ref":"#/components/schemas/ImportArtifactJobStatusLink"
        },
        {
            "$ref":"#/components/schemas/CreateDBSnapshotJobStatusLink"
        },
        {
            "$ref":"#/components/schemas/ExecuteBurstJobStatusLink"
        },
        {
            "$ref":"#/components/schemas/CreateReportSnapshotJobStatusLink"
        }
    ]
}

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" ]

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "readOnly":true
        },
        "rel":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "self",
                "log",
                "exported/artifact"
            ]
        }
    },
    "description":"Links to the export job status and job execution results.\n  * [rel=self] provides a link to the current job status. \n  * [rel=log] provides a link to the export log in the Library.\n  * [rel=exported/artifact] \n    * If the job parameter exportLocation was specified as Library, this will provide a link to the exported artifact in the Library.\n    * If the job parameter exportLocation was specified as Temporary, this will provide a link to the Files API to download the file directly.\n    * 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.\n"
}

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" ]

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "readOnly":true
        },
        "rel":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "self",
                "log",
                "imported/artifact"
            ]
        }
    },
    "description":"Links to the import job status and job execution results.\n  * [rel=self] provides a link to the current job status.\n  * [rel=log] provides a link to the import log in the Library.\n  * [rel=imported/artifact] provides a link to the imported artifact in the Library.\n"
}

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" ]

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "readOnly":true
        },
        "rel":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "self",
                "log"
            ]
        }
    },
    "description":"Links to the create database snapshot job status and job execution results.\n  * [rel=self] provides a link to the current job status.\n  * [rel=log] provides a link to the snapshot log.\n"
}

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" ]

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "readOnly":true
        },
        "rel":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "self"
            ]
        }
    },
    "description":"Links to the execute bursting definition job status and job execution results.\n"
}

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" ]

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "readOnly":true
        },
        "rel":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "self"
            ]
        }
    },
    "description":"Links to the create report snapshot job status and job execution results.\n  * [rel=self] provides a link to the current job status.        \n"
}

400 Response

Invalid parameter

Body ()

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.

{
    "type":"object",
    "properties":{
        "detail":{
            "type":"string",
            "description":"Human-readable description specific to this occurrence of the problem."
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code for this occurrence of the problem, set by the origin server."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem."
        },
        "type":{
            "type":"string",
            "description":"Absolute URI [RFC3986] that identifies the problem type."
        }
    },
    "description":"Detailed exception information."
}

404 Response

Job UUID not found

Body ()

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.

{
    "type":"object",
    "properties":{
        "detail":{
            "type":"string",
            "description":"Human-readable description specific to this occurrence of the problem."
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code for this occurrence of the problem, set by the origin server."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem."
        },
        "type":{
            "type":"string",
            "description":"Absolute URI [RFC3986] that identifies the problem type."
        }
    },
    "description":"Detailed exception information."
}

500 Response

Service Error

Body ()

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.

{
    "type":"object",
    "properties":{
        "detail":{
            "type":"string",
            "description":"Human-readable description specific to this occurrence of the problem."
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code for this occurrence of the problem, set by the origin server."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem."
        },
        "type":{
            "type":"string",
            "description":"Absolute URI [RFC3986] that identifies the problem type."
        }
    },
    "description":"Detailed exception information."
}

Back to Top