Retrieve Job Status for a Report

Use this REST API to get the processing state for a report job with a specified ID. Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.

Required Roles

Service Administrator, Power User, User, Viewer

GET /arm/rest/fcmapi/{api_version}/job/{module}/{jobIdentifier}

REST Resource

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 14-9 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with	Path	Yes	None
module	Module for Account Reconciliation Report (valid values are RC or TM) Valid values for Financial Close & Consolidation or Tax Reporting are SDM or FCCS (Task Manager)	Path	Yes	Yes
jobIdentifier	The ID of the job	Path	Yes	None

Parameters

Parameters

The following table summarizes the response parameters.

Table 14-10 Parameters

Name	Description
status	Status of the job: -1 = in process; 0 = completed (success); 1 = error
details	Details about the job status, such as "Big Report 10.csv" for generation of a report in csv format named Big Report 10
jobID	The ID of the job, such as 224
type	The type of report: RC (Reconciliation Compliance); TM (Transaction Matching); FCCS (Task Manager) or SDM (Supplemental Data Manager)

Supported Media Types: application/json

Examples of Response Body

The following shows an example of the response body for a completed (successful) report:

{
"links": [
{
        "rel": "self",
        "href": "https:<BASE-URL>/arm/rest/fcmapi/v1/report",
        "action": "POST"
    }, 
}
            "rel": "report-content",
        "href": "https:<BASE-URL>/interop/rest/11.1.2.3.600/applicationsnapshots/Big+Report+10.csv/contents",
        "action": "GET"
}
],
    "details": "Big Report 10.csv".
    "status": 0,
     "type": "RC",
    "link": null,
    "error": null,
    "items": null
    }

The following shows an example of the response body for an error occurring during report generation:

{
"links": [
{
        "rel": "self",
        "href": "https:<BASE-URL>/arm/rest/fcmapi/v1/report/job/TM/1145",
        "action": "GET"
    }, 
]
    "details": "Invalid query attached to the report".
    "status": 1,
     "type": "RC",
    "link": null,
    "error": null,
    "items": null
    }

The following shows an example of the response body for a report generation that is in process:

{
"links": [
{
        "rel": "self",
        "href": "https:<BASE-URL>/arm/rest/fcmapi/v1/report/job/TM/1124",
        "action": "GET"
    }, 
]
    "details": "In Process".
    "status": -1,
     "type": "RC",
    "link": null,
    "error": null,
    "items": null
    }