OCRotationV2 - getSpans()

Get the spans from the specified start date to the specified end date. If no start and end dates are provided, the start date defaults to a month before and the end date defaults to a month after the current time. You can also use the groups IDs, rota IDs, roster IDs, user IDs to further filter the spans.

Table 1. Parameters
Name Type Description
None
Table 2. Returns
Type Description
Array An array of spans. Each contains the following attributes: id, sys_id, table, rota_id, roster_id, user_id, text, description, color, textColor, start_date, end_date.
Get all spans for the default time period
var spans = new OCRotationV2().getSpans();
var firstSpanStartDate = spans[0].start_date; // get the first span's start date
Get all spans between 1st April 2014 and 5th June 2014
var spans = new OCRotationV2()
    .setStartDate("2014-04-01")
    .setEndDate("2014-06-05")
    .getSpans();
Get the Network group's spans for the default time period
var spans = new OCRotationV2()
     .setGroupIds("287ebd7da9fe198100f92cc8d1d2154e")
     .getSpans();
Get ITIL User's spans between 1st January 2014 and 31st January 2014
var spans = new OCRotationV2()
    .setStartDate("2014-01-01")
    .setEndDate("2014-01-31")
    .setUserIds("681b365ec0a80164000fb0b05854a0cd")
    .getSpans();