Requesting Information related to scheduled maintenances array

[Dileep Kumar Karanki]

Hi Team,Greetings of the day

1. I have a query related to scheduled_maintenances aaray present in json response of genesys cloud status page Pure cloud status .
2. Could someone let me know the expected json schema and explanation related to schema for scheduled maintenance.
3. We need to understand the properties and need to design alerts in our integration. 
4. does this scheduled_maintenances  array will have only (active,in progress and scheduled maintenances) or (only active maintenances).
5. I didn't understand the relationship between incidents and scheduled_maintenances could you explain or provide some references

Thanks and Regards,

Dileepkaranki  

[Jesse Klein · Accepted solution]

Hi Dileep,

Thanks for reaching out about wanting to understand the JSON responses. Welcome to the community.

I think in general, to answer most of your questions, you can look at the API documentation for the Status API. To do that, take any Statuspage URL and append /api to it. This will give you examples of the schema, as well as the different endpoint and what they specifically return.

For example, there is an endpoint that returns all scheduled maintenances, one that returns all currently active maintenances, and one that returns all maintenances.

It looks like you are using the summary endpoint, which gives the following information:

Get a summary of the status page, including a status indicator, component statuses, unresolved incidents, and any upcoming or in-progress scheduled maintenances.

For your last question. Incidents and maintenances are very similar. A maintenance is considered a special type of incident but for our purposes in the API, you can treat them as separate things.

Hopefully, that helps answer your questions but please feel free to reach back out here with more information.

Regards,
Jesse

[Dileep Kumar Karanki]

Thanks for the information  provided.

I have gone through schema related to All scheduled maintenances endpoint. Based on the schema I have 2 queries

1. I'm not seeing any Component information in the schema.
2. Use of shortlink in the schema.

Thanks and Regards, 

Dileepkaranki