Server API reference › API reference › API implementation and reference
ChangeCollisionHelper- Global
The ChangeCollisionHelper script include provides helper methods found in the Change Management - Collision Detector (com.snc.change.collision) plugin.
Use these methods in server side scripts, or when using Ajax calls on the client. You must have the Change Management - Collision Detector plugin installed to use these methods.
Parent Topic:Server API reference
ChangeCollisionHelper - addCiToChangeAffectedCis(String ci, String changeId)
Adds the CI to the change's affected CI list.
| Name | Type | Description |
|---|
| ci | String | The sys_id of the configuration item |
| changeId | String | The change record's sys_id |
ChangeCollisionHelper - getAffectedCisByChangeId(String changeId)
Returns the Affected CI sys_ids for the given change.
| Name | Type | Description |
|---|
| changeId | String | A change record's sys_id |
| Type | Description |
|---|
| Array | An array of sys_ids of affected CIs. |
ChangeCollisionHelper - getBlackoutsByDate(GlideDateTime startDate, GlideDateTime endDate)
Returns any blackout that overlap the period defined by startDate and endDate.
| Name | Type | Description |
|---|
| startDate | GlideDateTime | The beginning date |
| endDate | GlideDateTime | The ending date |
| Type | Description |
|---|
| Array | An array of blackouts (blackoutId:stringSpan). |
ChangeCollisionHelper - getChangesWithAffectedCi(String ci, GlideDateTime startDate, GlideDateTime endDate)
Returns changes scheduled in the timespan (defined by startDate and endDate) that have the given CI in their Affected CIs list.
| Name | Type | Description |
|---|
| ci | String | The configuration item's sys_id |
| startDate | GlideDateTime | The beginning date |
| endDate | GlideDateTime | The ending date of the time span |
| Type | Description |
|---|
| Array | An array of change record's sys_ids |
ChangeCollisionHelper - getChangesWithCi(String ci, GlideDateTime startDate, GlideDateTime endDate)
Returns the changes that are in the timespan (startDate, endDate) and that are linked to the given CI.
| Name | Type | Description |
|---|
| ci | String | The configuration item's sys_id |
| startDate | GlideDateTime | The beginning date |
| endDate | GlideDateTime | The ending date of the time span |
| Type | Description |
|---|
| Array | An array of sys_ids for change records |
ChangeCollisionHelper - getCiMaintenanceSchedule(String ci)
Returns the Maintenance Schedule for a CI.
| Name | Type | Description |
|---|
| ci | String | The configuration item's sys_id |
ChangeCollisionHelper - getDependants(String ci)
Returns all the CIs that depend on the given CI.
| Name | Type | Description |
|---|
| ci | String | A configuration item's sys_id |
| Type | Description |
|---|
| Array | An array of CIs |
ChangeCollisionHelper - getDependencies(String ci)
Returns all the CIs that the given CI depends on.
| Name | Type | Description |
|---|
| ci | String | The configuration item's sys_id |
| Type | Description |
|---|
| Array | An array of CIs |
ChangeCollisionHelper - isCiInAffectedCis(String ci, String changeId)
Check if an CI is already in the change's affected CIs list.
| Name | Type | Description |
|---|
| ci | String | The sys_id of the configuration item |
| changeId | String | The change record's sys_id |
| Type | Description |
|---|
| Boolean | True if the CI already is in the change's affected CI list. |
ChangeCollisionHelper - isDateInCiMaintenanceWindows( GlideDateTime startDate, GlideDateTime endDate, String maintenanceWindow)
Checks if the time span defined by startDate and endDate falls in the CI's maintenance window.
| Name | Type | Description |
|---|
| startDate | GlideDateTime | The beginning date |
| endDate | GlideDateTime | The ending date |
| maintenanceWindow | String | The configuration item's sys_id |
| Type | Description |
|---|
| Boolean | True if the time span is in the CI's maintenance window |