GetStatus

getStatus API

Returns the status of jobs submitted to the scheduler by these operations:

• Data import
• Package deployment

Syntax

<syntaxhighlight lang="java" enclose="div">

StatusBean status = getStatus(String resourceName, String id); </syntaxhighlight>

Parameters

resourceName

A string that specifies the kind of job to be checked.
Possible values, defined in the CONSTANTS class, are:

STATUS.PACKAGE_DEPLOY
STATUS.IMPORT

id

The ID of the job.

Returns

StatusBean object

Example: Get status for an import

This example returns the status for import job #974326842, where the import job ID is returned by the REST bulk upload resource or the Java importData API.

<syntaxhighlight lang="java" enclose="div">

import com.platform.api.*; import com.platform.beans.*; import static com.platform.api.CONSTANTS.*; import static com.platform.api.Functions.*;

...

StatusBean sb = getStatus(CONSTANTS.STATUS.IMPORT, "974326842"); ImportStatusBean isb = (ImportStatusBean)sb.getObject(); Logger.info("Import status code: " + isb.getStatusCode()

             + "; status: " +isb.getStatus(), "Import");

</syntaxhighlight>

Learn more: ImportStatusBean

Example: Get status for a known deployment

This example returns the status for deployment job #870821896.

<syntaxhighlight lang="java" enclose="div">

import com.platform.api.*; import com.platform.beans.*; import static com.platform.api.CONSTANTS.*; import static com.platform.api.Functions.*;

...

StatusBean sb = getStatus(CONSTANTS.STATUS.PACKAGE_DEPLOY, "870821896"); PackageDeployStatusBean pdsb = (PackageDeployStatusBean)sb.getObject(); Logger.info("Deployment status code: " + pdsb.getStatusCode()

             + "; status: " + pdsb.getStatus(), "Deploy");

</syntaxhighlight>

Learn more: PackageDeployStatusBean

Example: Get status for all package deployments

This example returns the status for all package deployments since the platform was installed.

<syntaxhighlight lang="java" enclose="div">

CollectionBean cb = searchStatus(STATUS.PACKAGE_DEPLOY, "id, status", ""); List list = (List)cb.getObject(); for(Object statusBean : list ) {

   StatusBean status = (StatusBean)statusBean;
   PackageDeployStatusBean pdsb = (PackageDeployStatusBean)status.getObject();
   Logger.info("Status code for: " + pdsb.getRecordId() 
                 + "; status:" + pdsb.getStatus(), "Deploy");

} </syntaxhighlight>