Module

planEndpoints

A module related to xMatters communication plan endpoints.

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

View Source planEndpoints.js, line 3

Members

# inner delete

Delete a plan endpoint in xMatters

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

View Source planEndpoints.js, line 74

# inner constant fields

The key values from the object that can be synchronized.

View Source planEndpoints.js, line 122

Methods

# async inner create(env, endpoint, planId) → {Promise.<module:planEndpoints.Endpoint>}

Create a plan endpoint in xMatters

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

View Source planEndpoints.js, line 53

Plan Endpoint Object Created
Promise.<module:planEndpoints.Endpoint>

# async inner exportToImport(destination, planEndpoints, 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.
planEndpoints module:planEndpoints.Endpoint Array of plan endpoint objects to transform.
destinationData xMattersObjects The xMatters data for the destination.

View Source planEndpoints.js, line 96

Promise

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

Get a plan endpoint from xMatters

https://help.xmatters.com/xmapi/index.html#get-endpoints
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
endpointId string The unique identifier (id) of the endpoint.
query Object A json object representing the query string parameters for this request.
planId string The unique identifier (id) or name of the plan you want to list the constants for.

View Source planEndpoints.js, line 25

Plan Endpoint Object Requested
Promise.<PlanEndpoint>

# async inner getMany(env, query, planId) → {Promise.<Array.<module:planEndpoints.Endpoint>>}

Get all plan endpoints in a 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-endpoints
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 you want to list the constants for.

View Source planEndpoints.js, line 39

Array of Plan Endpoint Objects Requested
Promise.<Array.<module:planEndpoints.Endpoint>>

# async inner sync(destination, sourcePlanEndpoints, destinationPlanEndpoints, 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.
sourcePlanEndpoints Array.<module:planEndpoints.Endpoint> An array of the plan endpoint objects to synchronize from the source data.
destinationPlanEndpoints Array.<module:planEndpoints.Endpoint> An array of the plan endpoint objects to synchronize from the destination data.
options Object

View Source planEndpoints.js, line 140

Promise.<module:sync.SyncResults>

# async inner update(env, endpoint, endpointId, planId) → {Promise.<module:planEndpoints.Endpoint>}

Update a plan endpoint in xMatters

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

Examples:
- b2341d69-8b83-4660-b8c8-f2e728f675f9
planId string The unique identifier (id) or name of the plan containing the endpoint.

View Source planEndpoints.js, line 70

Plan Endpoint Object Updated
Promise.<module:planEndpoints.Endpoint>

Type Definitions

Object

# Endpoint

View Source planEndpoints.js, line 10