Module

forms

A module related to xMatters forms.

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

View Source forms.js, line 3

Methods

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

Get a form in a plan from xMatters

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

View Source forms.js, line 21

The Form Objects Requested
Promise.<Form>

# async inner getFormSections(env, query, formId) → {Promise.<Array.<FormSection>>}

Get all sections in a form from xMatters matching the query. Please refer to the link below for the available query parameters.

https://help.xmatters.com/xmapi/index.html#get-form-sections
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.
formId string The unique identifier (id) or name (targetName) of the form you want to retrieve.

View Source forms.js, line 82

Array of Form Section Objects Requested
Promise.<Array.<FormSection>>

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

Get all 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-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 forms.js, line 34

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

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

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

https://help.xmatters.com/xmapi/index.html#get-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 (uuid) or name (targetName) of the plan the forms belong to. Names must be URL-encoded.

View Source forms.js, line 48

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

# async inner getResponseOptions(env, query, formId, planId) → {Promise.<Array.<ResponseOption>>}

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

https://help.xmatters.com/xmapi/index.html#get-form-response-options
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.
formId string The unique identifier (uuid) or name (targetName) of the form you want to retrieve.
planId string The unique identifier (id) or name (targetName) of the plan the forms belong to.

View Source forms.js, line 63

Array of Response Option Objects Requested
Promise.<Array.<ResponseOption>>