Module

people

A module related to xMatters people.

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

View Source people.js, line 3

Members

# inner delete

Delete a person in xMatters

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

View Source people.js, line 120

# inner constant fields

The key values from the object that can be synchronized.

View Source people.js, line 219

Methods

# async inner create(env, person) → {Promise.<Person>}

Create a person in xMatters

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

View Source people.js, line 100

Person Object Created
Promise.<Person>

# async inner exportToImport(destination, people, destinationData) → {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.
people Array.<Person> Array of person objects to transform.
destinationData xMattersObjects The xMatters data for the destination.

View Source people.js, line 144

Promise

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

Get a person from xMatters

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

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

View Source people.js, line 23

Person Object Requested
Promise.<Person>

# async inner getDevices(env, query, personId) → {Promise.<Array.<Device>>}

Get all devices for a person 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-person-39-s-devices
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.
personId string The unique identifier (id) or name (targetName) of the person.

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

View Source people.js, line 70

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

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

Get all groups for a person 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-person-39-s-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.
personId string The unique identifier (id) or name (targetName) of the person.

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

View Source people.js, line 87

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

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

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

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

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

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

Get all supervisors for a person 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-person-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.
personId string The unique identifier (id) or name (targetName) of the person.

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

View Source people.js, line 53

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

# async inner sync(destination, sourcePeople, destinationPeople, 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.
sourcePeople Array.<Person> An array of the person objects to synchronize from the source data.
destinationPeople Array.<Person> An array of the person objects to synchronize from the destination data.
options Object

View Source people.js, line 246

Promise.<module:sync.SyncResults>

# async inner update(env, person, personId) → {Promise.<Person>}

Update a person in xMatters

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

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

View Source people.js, line 116

Person Object Updated
Promise.<Person>