Module

planProperties

A module related to xMatters communication plan properties.

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

View Source planProperties.js, line 3

Members

# inner constant fields

The key values from the object that can be synchronized.

View Source planProperties.js, line 90

Methods

# async inner create(env, property, planId) → {Promise.<PlanProperty>}

Create a plan property in xMatters

https://help.xmatters.com/xmapi/index.html#create-plan-properties
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
property PlanProperty https://help.xmatters.com/xmapi/index.html#property-object
planId string The unique identifier (id) or name of the plan that will contain the property.

View Source planProperties.js, line 34

Plan Property Object Created
Promise.<PlanProperty>

# async inner exportToImport(destination, planProperties, destinationData) → {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.
planProperties Array.<PlanProperty> Array of plan property objects to transform.
destinationData xMattersObjects The xMatters data for the destination.

View Source planProperties.js, line 72

Promise

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

Get all plan properties in a communication plan from xMatters matching the query. Please refer to the link below for the available query parameters.

https://help.xmatters.com/xmapi/index.html#get-plan-properties
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.
planId string The unique identifier (id) or name of the plan that you want to retrieve the properties for. Use plans.get() or plans.getMany() to find the id or name of the plan.

View Source planProperties.js, line 20

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

# async inner sync(destination, sourcePlanProperties, destinationPlanProperties, 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.
sourcePlanProperties Array.<PlanProperty> An array of the plan property objects to synchronize from the source data.
destinationPlanProperties Array.<PlanProperty> An array of the plan property objects to synchronize from the source data.
options Object

View Source planProperties.js, line 110

Promise.<module:sync.SyncResults>

# async inner update(env, property, propertyId, planId) → {Promise.<PlanProperty>}

Update a plan property in xMatters

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

View Source planProperties.js, line 55

Plan Property Object Updated
Promise.<PlanProperty>