Module

dynamicTeams

A module related to xMatters dynamic teams.

https://help.xmatters.com/xmapi/index.html#dynamic-teams

View Source dynamicTeams.js, line 3

Members

# inner delete

Delete a dynamic team in xMatters

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

View Source dynamicTeams.js, line 83

# inner constant fields

The key values from the object that can be synchronized.

View Source dynamicTeams.js, line 170

Methods

# async inner create(env, dynamicTeam) → {Promise.<DynamicTeam>}

Create a dynamic team in xMatters

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

View Source dynamicTeams.js, line 65

Dynamic Team Object Created
Promise.<DynamicTeam>

# async inner exportToImport(destination, dynamicTeams, destinationData, options)

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.
dynamicTeams Array.<DynamicTeam> Array of Dynamic Teams to transform.
destinationData xMattersObjects The xMatters data for the destination.
options Object

View Source dynamicTeams.js, line 107

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

Get a dynamic team from xMatters

https://help.xmatters.com/xmapi/index.html#get-a-dynamic-team
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
dynamicTeamId string The unique id of the dynamic team.
query Object A json object representing the query string parameters for this request.

View Source dynamicTeams.js, line 20

Dynamic Team Object Requested
Promise.<DynamicTeam>

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

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

https://help.xmatters.com/xmapi/index.html#get-dynamic-teams
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 dynamicTeams.js, line 33

Array of Dynamic Team Objects Requested
Promise.<Array.<DynamicTeam>>

# async inner getMembers(env, query, dynamicTeamId) → {Promise.<Array.<module:people.Person>>}

Get all dynamic teams 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-dynamic-team-members
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.
dynamicTeamId string The unique id or targetNameof the dynamic team.

View Source dynamicTeams.js, line 47

Array of Person Objects from the Dynamic Team Requested
Promise.<Array.<module:people.Person>>

# async inner sync(destination, sourceDynamicTeams, destination, 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 Description
destination module:environments.xMattersEnvironment The xmtoolbox representation of the target or destination xMatters instance.
sourceDynamicTeams Array.<DynamicTeam> An array of the dynamic team objects to synchronize from the source data.
destination Array.<DynamicTeam> An array of the dynamic team objects to synchronize from the destination data.
options Object

View Source dynamicTeams.js, line 188

Promise.<module:sync.SyncResults>

# async inner update(env, dynamicTeam, dynamicTeamId) → {Promise.<DynamicTeam>}

Update a dynamic team in xMatters

https://help.xmatters.com/xmapi/index.html#update-a-dynamic-team
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
dynamicTeam DynamicTeam
dynamicTeamId string The unique identifier (id) of the dynamic team you want to modify.

View Source dynamicTeams.js, line 79

Dynamic Team Object Updated
Promise.<DynamicTeam>