Module

groups

A module related to xMatters groups.

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

View Source groups.js, line 4

Members

# inner delete

Delete a group in xMatters

https://help.xmatters.com/xmapi/index.html#delete-a-group

View Source groups.js, line 84

# inner constant fields

The key values from the object that can be synchronized.

View Source groups.js, line 171

Methods

# async inner create(env, group) → {Promise.<Group>}

Create a group in xMatters

https://help.xmatters.com/xmapi/index.html#create-a-group
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
group Group https://help.xmatters.com/xmapi/index.html#group-object

View Source groups.js, line 64

Group Object Created
Promise.<Group>

# async inner exportToImport(destination, groups, destinationData, options) → {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.
groups Array.<Group> Array of groups to transform.
destinationData xMattersObjects The xMatters data for the destination.
options Object

View Source groups.js, line 109

Promise

# async inner get(env, groupId, query) → {Promise.<Group>}

Get a group from xMatters

https://help.xmatters.com/xmapi/index.html#get-a-group
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
groupId * The unique identifier (id) or name (targetName) of the group.

Examples:
- Oracle Administrators
- 438e9245-b32d-445f-916bd3e07932c892
query Object A json object representing the query string parameters for this request.

View Source groups.js, line 24

Group Object Requested
Promise.<Group>

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

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

https://help.xmatters.com/xmapi/index.html#get-groups
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 groups.js, line 37

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

# async inner getSupervisors(env, query, groupId) → {Promise.<Array.<Person>>}

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

https://help.xmatters.com/xmapi/index.html#get-a-group-39-s-supervisors
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.
groupId string The unique identifier (id) or name (targetName) of the group

View Source groups.js, line 51

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

# async inner sync(destination, Group[]opt, destinationGroups, 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 Attributes Description
destination module:environments.xMattersEnvironment The xmtoolbox representation of the target or destination xMatters instance.
Group[] <optional>
 sourceGroups An array of the group objects to synchronize from the source data.
destinationGroups Array.<Group> An array of the group objects to synchronize from the destination data.
options Object

View Source groups.js, line 195

Promise.<module:sync.SyncResults>

# async inner update(env, group, groupId) → {Promise.<Group>}

Update a group in xMatters

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

Examples:
- 438e9245-b32d-445f-916bd3e07932c892

View Source groups.js, line 80

Group Object Updated
Promise.<Group>