<< Back to GIL API Documentation

API documentation: status

Returns information such as current activity, progress information, condition etc. concerning the process model adapter and the external system adapter.

URL:

/api/status[.format]

Example: /api/status.xml

Omitted format defaults to html.

Formats:

html, xml, json

HTTP Method(s):

GET

Response:

ElementDescription
statusSet to any of the following predefined values:
UNKNOWNA temporary status that is expected to change when the status becomes known.
NOT_AVAILABLEA static status indicating that the adapter does not support status reporting. This status is not expected to change.
INITA inital status during the setup process. This status is expected to change to OK or NOK.
OKA status indicating success.
NOKA status indicating failure. A description of the cause can be expected in the statusDescription element.
statusDescriptionAn optional description of the cause of the current status.
operatingStateThe current operating state e.g. RUN, FREEZE.
isActivityDonetrue | false: A activity can be in progress e.g. loading an IC. This element is set to false when there is an activity in progress.
currentActivityContains a descriptive text of the current activity. A text can only be expected when isActivityDone is set to false.
activityCompletionContains progress information (0-100) about the current activity. The value of this element is undefined when isActivityDone is set to true.

Response example(s):

XML:

<status>
  <externalSystem>
    <status>OK</status>
    <statusDescription>The ES is OK</statusDescription>
    <operatingState>Freeze</operatingState>
    <isActivityDone>false</isActivityDone>
    <currentActivity>Loading IC no 19</currentActivity>
    <activityCompletion>60</activityCompletion>
  </externalSystem>
  <processModel>
    <status>OK</status>
    <statusDescription>The PM is OK</statusDescription>
    <operatingState>Freeze</operatingState>
    <isActivityDone>true</isActivityDone>
    <currentActivity/>
    <activityCompletion>0</activityCompletion>
  </processModel>
</status>