Previous Topic: addUndelivery—Add Undelivery to Job ContainerNext Topic: Example


listJobs—List Jobs

This action lists all jobs of the specified job container. A filter can be specified to confine the amount of jobs listed.

This action has the following format:

jobcontainer action=listJobs 
name=job_container_name 
{[{filter=filter|filterfile=file_name}] 
[TV] | TV alt}
alt

Provides an alternate - more detailed - list in target view.

An alternate list is provided based on the item name and version only.

In case of coding this parameter the value of the item and version parameter might contain database supported wild cards, for example,

"%"

for an arbitrary, even empty sequence of characters

"_"

for an arbitrary single character

For Microsoft SQL Server also the square brackets ("[","]") have a special meaning. This has to be taken into account when coding the name.

name

Specifies the name of the job container to be listed.

filter

Specifies the expression to confine the amount of information listed.

Attribute

Type

Job name

String

Overall state

{ WAITING | INPROGRESS | OK | ERROR | BUILDING | REMOVING | NOT_AVAILABLE | CREATED | OBSOLETE}

Software

String

Procedure

String

Deliver at

DateTime

Activate at

DateTime

Status message

String

Job state

{UNDEFINED | WAITING | DELIVERY_ORDERED | DELIVERING | DELIVERY_OK | DELIVERY_ERROR | ALREADY_DELIVERED | EXECUTION_ORDERED | EXECUTING | EXECUTION_OK | EXECUTION_ERROR | UNDELIVERY_ORDERED | UNDELIVERING | UNDELIVERY_OK | UNDELIVERY_ERROR | ALREADY_INSTALLED | MANIPULATION_NOT_ALLOWED}

Job task

{INSTALL | CONFIGURE | ACTIVATE | UNINSTALL | DELIVER | UNDELIVER}

Pre action

{NO ACTION | REBOOT | LOGOFF}

Post action

{NO ACTION | REBOOT | LOGOFF | REBOOT AFTER LAST JOB | LOGOFF AFTER LAST JOB}

Delivery calendar

String

User parameters

String

The atomic attributes correspond to those shown at showAttrJobs or showJobDetails.

filterfile

name of the file that contains the filter commands.

The commands in the file are specified in the same way as in the filter parameter, but the size of the file is limited by the capacity of the system that runs this command.

TV

Adjust the view of the list:

none specified

job view

TV

target view