Module

plans

A module related to xMatters communication plans.

https://help.xmatters.com/xmapi/index.html#plans

View Source plans.js, line 3

Members

# inner delete

Delete a communication plan in xMatters

https://help.xmatters.com/xmapi/index.html#delete-a-plan

View Source plans.js, line 69

# inner constant fields

The key values from the object that can be synchronized.

View Source plans.js, line 105

Methods

# async inner create(env, plan) → {Promise.<Plan>}

Create a communication plan in xMatters

https://help.xmatters.com/xmapi/index.html#create-a-communication-plan
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
plan Plan https://help.xmatters.com/xmapi/index.html#plan-object

View Source plans.js, line 49

Plan Object Created
Promise.<Plan>

# async inner exportToImport(destination, plans) → {Promise}

Transforms an array of records exported from xMatters to the format needed to import into xMatters.
Parameters:
Name Type Description
destination module:environments.xMattersEnvironment The xmtoolbox representation of the target or destination xMatters instance.
plans Array.<Plan> Array of plan objects to transform.

View Source plans.js, line 92

Promise

# async inner get(env, planId, query) → {Promise.<Plan>}

Get a plan from xMatters

https://help.xmatters.com/xmapi/index.html#get-a-communication-plan
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
planId string The unique identifier (id) or name of the communication plan.

Examples:
- b2341d69-8b83-4660-b8c8-f2e728f675f9
- MIM
query Object A json object representing the query string parameters for this request.

View Source plans.js, line 23

Plan Object Requested
Promise.<Plan>

# async inner getMany(env, query) → {Promise.<Array.<Plan>>}

Get all plans from xMatters matching the query. Please refer to the link below for the available query parameters.

https://help.xmatters.com/xmapi/index.html#get-communication-plans
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
query Object A json object representing the query string parameters for this request.

View Source plans.js, line 36

Array of Plan Objects Requested
Promise.<Array.<Plan>>

# async inner sync(destination, sourcePlans, destination, options) → {Promise.<module:sync.SyncResults>}

Synchronizes an array of objects from a source with destination objects and updates the destination as necessary.
Parameters:
Name Type Description
destination module:environments.xMattersEnvironment The xmtoolbox representation of the target or destination xMatters instance.
sourcePlans Array.<Plan> An array of the communication plan objects to synchronize from the source data.
destination Array.<Plan> The xmtoolbox representation of the target or destination xMatters instance.Plans
options Object

View Source plans.js, line 115

Promise.<module:sync.SyncResults>

# async inner update(env, plan, planId) → {Promise.<Plan>}

Update a plan in xMatters

https://help.xmatters.com/xmapi/index.html#modify-communication-plan
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
plan Plan https://help.xmatters.com/xmapi/index.html#plan-object
planId string The unique identifier (id) of the communication plan.

Examples:
- b2341d69-8b83-4660-b8c8-f2e728f675f9

View Source plans.js, line 65

Plan Object Updated
Promise.<Plan>