Module

subscriptionForms

A module related to xMatters subscription forms.

https://help.xmatters.com/xmapi/index.html#subscription-forms

View Source subscriptionForms.js, line 3

Members

# inner constant fields

The key values from the object that can be synchronized.

View Source subscriptionForms.js, line 176

Methods

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

Create a subscription form in xMatters

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

View Source subscriptionForms.js, line 71

Site Object Created
Promise.<Site>

# async inner exportToImport(destination, subscriptionForms) → {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.
subscriptionForms Array.<SubscriptionForm> Array of subscription form objects to transform.

View Source subscriptionForms.js, line 110

Promise

# async inner get(env, subscriptionFormId, query) → {SubscriptionForm}

Get a subscription form from xMatters

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

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

View Source subscriptionForms.js, line 22

Subscription Form Object Requested
SubscriptionForm

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

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

https://help.xmatters.com/xmapi/index.html#get-subscription-forms
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 subscriptionForms.js, line 35

Array of Subscription Form Objects Requested
Promise.<Array.<SubscriptionForm>>

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

Get all subscription forms 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-subscription-forms-in-a-plan
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 communication plan.

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

View Source subscriptionForms.js, line 52

Array of Subscription Form Objects Requested
Promise.<Array.<SubscriptionForm>>

# async inner sync(destination, sourceSubscriptionForms, destinationSubscriptionForm, 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.
sourceSubscriptionForms Array.<SubscriptionForm> An array of the subscription form objects to synchronize from the source data.
destinationSubscriptionForm Array.<SubscriptionForm> An array of the subscription form objects to synchronize from the destination data.
options Object

View Source subscriptionForms.js, line 199

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

Update an subscription form in xMatters

https://help.xmatters.com/xmapi/index.html#modify-a-subscription-form
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
integration * https://help.xmatters.com/xmapi/index.html#subscription-form-objects
subscriptionFormId * The unique identifier (id) of the subscription form 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 subscriptionForms.js, line 94

Integration Object Updated
Promise.<Integration>