request_act_retrieve_jobs XML Parameters

The following table describes request_act_retrieve_jobs XML Parameters:

Parameter

Description

user_token

Serial identification number supplied to the user during registration. String.

max_returned_nodes

Specifies the maximum number of nodes that is returned in the response. If the response exceeds the maximum specified, the request fails as partial_result. Optional.

NOTE: Should not exceed the value of the EMAPIActiveJobsLoadLimit system parameter.

retrieve_jobs_criterion

Retrieve jobs criteria wrapper. String. Consists of the following filters:

  • include: (Mandatory): Include filter definitions criteria wrapper
  • exclude: (Optional): Exclude filter definitions criteria wrapper.

These parameters include the search_criterion wrapper that consists of a sequence of param elements. At least one search_criterion element must appear in the include element. The amount of search_criterion elements is unlimited. The relationship between search_criterion elements in one filter is OR. For a description of param, see Search_criterion XML parameter.

For an example of request, see request_act_retrieve_jobs XML example.

Parent Topic

Retrieve jobs in the active jobs database