Module

integrations

A module related to xMatters integrations.

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

View Source integrations.js, line 3

Members

# inner delete

Delete an integration in xMatters

https://help.xmatters.com/xmapi/index.html#delete-an-integration

View Source integrations.js, line 89

# inner constant fields

The key values from the object that can be synchronized.

View Source integrations.js, line 155

Methods

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

Create an integration in xMatters

https://help.xmatters.com/xmapi/index.html#create-an-integration
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
integration * https://help.xmatters.com/xmapi/index.html#integration-object
planId * The UUID of the communication plan that is associated with the integration.

View Source integrations.js, line 62

Integration Object Created
Promise.<Integration>

# async inner exportToImport(destination, integrations, 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.
integrations Array.<Integration> https://help.xmatters.com/xmapi/index.html#integration-object
destinationData xMattersObjects The xMatters data for the destination.

View Source integrations.js, line 111

Promise

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

Get a device from xMatters

https://help.xmatters.com/xmapi/index.html#get-an-integration
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
planId * The UUID of the communication plan that the integration belongs to. To get the ID of a plan, use plans.get() or plans.getMany()
integrationId * The name or unique identifier (id) of the integration.

View Source integrations.js, line 20

Integration Object Requested
Promise.<Integration>

# async inner getLogs(env, query, integrationId) → {Promise.<Array.<IntegrationLog>>}

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

https://help.xmatters.com/xmapi/index.html#get-integration-logs
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.
integrationId * The UUID of the integration that you want to retrieve the logs for. Use integrations.getMany() to get the UUID of an integration.

View Source integrations.js, line 48

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

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

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

https://help.xmatters.com/xmapi/index.html#get-integrations
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 * The UUID of the communication plan that you want to list integrations for. Use plans.get() or plans.getMany() to get the UUID of a plan.

View Source integrations.js, line 34

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

# async inner sync(destination, sourceIntegrations, destinationIntegrations, options)

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.
sourceIntegrations Array.<Integration> An array of the integration objects to synchronize from the source data.
destinationIntegrations Array.<Integration> An array of the integration objects to synchronize from the destination data.
options Object

View Source integrations.js, line 176

# async inner update(env, integration, integrationId, planId) → {Promise.<Integration>}

Update an integration in xMatters

https://help.xmatters.com/xmapi/index.html#modify-an-integration
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
integration * https://help.xmatters.com/xmapi/index.html#integration-object
integrationId * The unique identifier (id) of the integration you want to modify.

Examples:
- 345c95ee-4abe-47ea-ae7c-ae84fb4bee4f
planId * The UUID of the communication plan that is associated with the integration.

View Source integrations.js, line 79

Integration Object Updated
Promise.<Integration>