REST API:packageDeploy Status Resource

Get Package Deployment Status

Method

GET

URI

https://{yourDomain}/networking/rest/status/packageDeploy/{jobId}

Response

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

<platform> <status>

   <packageDeploy>

<date_created>2011-01-08T14:24:03Z</date_created> <created_id type="USER" uri="https://{yourDomain}/networking/rest/user/qwe123rty456" displayValue="Smith Bob">qwe123rty456</created_id>

       <id>zig789fez098</id>

<packageName>Order Processing</packageName> <totalDeployments>2</totalDeployments> <successfulDeployments>2</successfulDeployments> <failedDeployments>0</failedDeployments> <summary>

        1096387182;;Tenant1;;1;;N/A||1254445340;;Tenant2;;1;;N/A||

</summary> <statusCode>4</statusCode> <status>Deployment Completed</status> <processStartDate>2011-01-09T02:00:00Z</processStartDate> <processEndDate>2011-01-09T02:00:03Z</processEndDate>

   </packageDeploy>

</status>

   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Dynamic Search for Package Deployment Status Records

Method

GET

URI

https://{yourDomain}/networking/rest/status/packageDeploy?{query_parameters}

Query Parameters

• fieldList - A comma-separated list of field names to retrieve

• The asterisk (*) wildcard specifies all fields
• {fieldname} specifies an individual field (e.g. name)

(Use the REST API:field Resource to get a complete list of fields.)

• For a Composite Object, specify {alias}.{fieldname} to select a related-record field, where the alias is defined in the Object Relationships.
• For a Database View, specify {alias}.{fieldname}, where the object alias is defined in the Database View.
• alias.* specifies all fields in the aliased object.

• filter - Filtering criteria to filter the records

• For more examples, see Filter Expressions in REST APIs and the REST API Examples.)

• pageSize - Number of records to retrieve from the result set in order to make a "page".
• page - Number of the logical page in a database result set. The first page is page "zero" (0).

Page zero is returned by default, so appending &pageSize=1 to your query returns a single record.

• getTotalRecordCount returns the number of total records.
  Causes the following structure to be returned, where N is the total number of records:

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

<platform>

  <status>
  <packageDeploy>
  ...
  </packageDeploy>
  </status>
  <message>
     0
     <description>Success</description>
  </message>

  <totalRecordCount>N</totalRecordCount> 

</platform> </syntaxhighlight>

• sortBy - Field name for primary sort
  Ex: &sortBy=name
• sortOrder - Sort order of the primary field, either asc or desc (ascending or descending)
  Ex: &sortOrder=desc
• sortBy2 - Field name for secondary sort
• sortOrder2 - Sort order of the second field, either asc or desc (ascending or descending)

For more information, see: Specifying Query Parameters in REST APIs

Sample Search

?fieldList=packageName,id,status,processEndDate

(Field names are in the Fields section.)

Response

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

<platform>

   <status>
       <packageDeploy>
           <id>far987bar6544</id>
           <packageName>Inventory Management</packageName>
           <status>Deployment Completed</status>
           <processEndDate>2011-01-09T12:01:03Z</processEndDate>
       </packageDeploy>
   </status>

   <status>
       <packageDeploy>
           <id>zig789fez098</id>
           <packageName>Order Processing</packageName>
           <status>Deployment Completed</status>
           <processEndDate>2011-01-09T12:01:58Z</processEndDate>
       </packageDeploy>
   </status>

   <message>
       0
       <description>Success</description>
   </message>
   <recordCount>2</recordCount>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Fields

Name	Type	Description
id	String	ID of the scheduled package-deployment job
packageName	String	Name of the package that was deployed.
totalDeployments	String	Number of deployments attempted
successfulDeployments	String	Number of deployments that succeeded
failedDeployments	String	Number that failed
summary	String	A string showing the results of all deployments, following the pattern: {tenant1 ID};; {tenant1 name};; 1;; N/A || {tenant2 ID};; {tenant2 name};; 0;; {failure message} where: Records are separated by || Fields are separated by ;; 1 is the success code, followed by "N/A" (not applicable) 0 is the failure code, followed by a failure message
statusCode	String	Status code. (See table below)
status	String	Status message. (See table below)
objectName	String	Object into which data is imported
processStartDate	Date	Date and time the import started, in UTC Format
processEndDate	String	Date and time the import completed, in UTC Format
date_created	Date	Date and time the import job was submitted, in UTC Format
created_id	Lookup	ID of the User who created the job

 

Scheduled jobs may be in one of the following states. (Constants are defined in com.platform.api.CONSTANTS.STATUS)

statusCode (int)	status (String)	Description
IN_PROCESS_QUEUE	"In process queue"	Job has been accepted by the scheduler.
STARTED	"Started"	Job is currently being processed.
COMPLETED	"Completed"	Job finished.
WAITING_TO_BE_STOPPED	"Waiting to be stopped"	Job started, but user has issued a STOP request. Processing is continuing until an appropriate stopping-point is reached. (Note: The STOP operation is not available for all jobs.)
STOPPED	"Stopped"	Job was stopped by user.