Get Status Payload Fields

Question

What is the intended purpose of the Get Status API response fields for the following scenarios:

updateTime –  Does this field show the date and time when Data holder checks the health of all endpoints? This might be periodically, for example every 5 minutes.

Alternatively, does it represent the date and time when the status field changed state. For example, would it show the date and time when OK status changed to PARTIAL_FAILURE status?

Answer

The API was designed to support scenarios where status is automatically detected, but also scenarios where the response payload is manually created.

In this context, the updateTime field represents the last time the information being presented was either updated, modified or verified.  The detectionTime field indicates when the issue was actually identified.

For automatic update these may be the same if the status is updated immediately on detection.  The updateTime may then change every five minutes until service is restored.

For manual updates when the status changes the timestamps could be very divergent. For example, the outage might be detected at 3 pm but the status might be updated at 3:15 pm.

See:

• CDS Get Status API
• CDS ResponseCommonDiscoveryStatus