Description

The sp:GetChangedWorkItemsRequest API method will return a particular set of work items’ attributes (job or standard activity) if any of the work item’s attributes have changed since a previous call. The operation works for a single FRU for the whole memory horizon.

If the option JeopOnly is set, work items will be returned only if one of a configurable set of jeopardy conditions has changed. The jeopardy conditions that are to be monitored are configured by the FRU parameter GetChangedJobs: Jeopardy Conditions in the API section of the Scheduling Unit Settings page in ServiceManager (the database name is: gcj_jeop_check_states).

In this context, the change could be:

1. one or more of the configured jeopardy conditions for that work item has changed;
2. the configured conditions include “overdue” (P) and/or “Missed appointment - Late” (M) and the job is in jeopardy because it is overdue or late and the amount by which it’s overdue or late has changed; or
3. the configured conditions include “early” (Before Contract Earliest (B) or Missed Appointment (Me)) and the job is early and the amount by which it’s early has changed.

Changes are determined by time-stamp comparison. On the first call, the time-stamp should not be supplied so that all of the work items are returned along with a new server-generated time. This new time-stamp is then supplied to the next call so that the changes made since the previous call can be determined by the server, and only work items that have changed since that previous time-stamp are then returned.

Definition

The definition of this API is:

Return Structure

The API returns a non-standard return structure.

Return Codes

In addition to the Standard Return Codes, the possible Return Codes from this API are: