Module

groupMembers

A module related to xMatters group members/group roster.

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

View Source groupMembers.js, line 2

Members

# inner delete

Remove a group member from a group in xMatters

https://help.xmatters.com/xmapi/index.html#remove-a-member-from-the-group-roster

View Source groupMembers.js, line 40

# inner constant fields

The key values from the object that can be synchronized.

View Source groupMembers.js, line 132

Methods

# async inner create(env, member, groupId) → {Promise.<GroupMember>}

Add a group member to a group in xMatters

https://help.xmatters.com/xmapi/index.html#add-a-member-to-the-group-roster
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
member *
groupId * The unique identifier (id) or name (targetName) of the group. Examples:
- Oracle Administrators
- bab4a72f-e118-462d-ad87-e38e28e822e0

View Source groupMembers.js, line 36

Group Member Object Created
Promise.<GroupMember>

# async inner exportToImport(destination, groupMembers, destinationData)

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.
groupMembers Array.<GroupMember> Array of group members to transform.
destinationData xMattersObjects The xMatters data for the destination.

View Source groupMembers.js, line 64

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

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

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

View Source groupMembers.js, line 19

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

# async inner sync(destination, sourceGroupMembers, destinationGroupMembers, options, groupId) → {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.
sourceGroupMembers Array.<GroupMember> An array of the group member objects to synchronize from the source data.
destinationGroupMembers Array.<GroupMember> An array of the group member objects to synchronize from the destination data.
options Object
groupId string The UUID of the group to sync the group members to.

View Source groupMembers.js, line 143

Promise.<module:sync.SyncResults>