Module

sharedLibraries

A module related to xMatters shared libraries.

https://help.xmatters.com/xmapi/index.html#shared-libraries

View Source sharedLibraries.js, line 3

Members

# inner delete

Delete a shared library in xMatters

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

View Source sharedLibraries.js, line 70

# inner constant fields

The key values from the object that can be synchronized.

View Source sharedLibraries.js, line 110

Methods

# async inner create(env, sharedLibrary) → {Promise.<SharedLibrary>}

Create a shared library in xMatters

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

View Source sharedLibraries.js, line 50

Shared Library Object Created
Promise.<SharedLibrary>

# async inner exportToImport(destination, sharedLibraries, 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.
sharedLibraries SharedLibrary https://help.xmatters.com/xmapi/index.html#shared-library-object
destinationData xMattersObjects The xMatters data for the destination.

View Source sharedLibraries.js, line 92

Promise

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

Get a shared library from xMatters

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

View Source sharedLibraries.js, line 20

Shared Library Object Requested
Promise.<SharedLibrary>

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

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

https://help.xmatters.com/xmapi/index.html#get-shared-libraries
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 (id) or name of the communication plan.

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

View Source sharedLibraries.js, line 37

Array of Shared Library Objects Requested
Promise.<Array.<SharedLibrary>>

# async inner sync(destination, sourceSharedLibraries, destinationSharedLibraries, options)

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.
sourceSharedLibraries Array.<SharedLibrary> An array of the shared library objects to synchronize from the source data.
destinationSharedLibraries SharedLibrary An array of the shared library objects to synchronize from the destination data.
options Object

View Source sharedLibraries.js, line 119

# async inner update(env, sharedLibrary, sharedLibraryId) → {Promise.<SharedLibrary>}

Update a shared library in xMatters

https://help.xmatters.com/xmapi/index.html#modify-a-shared-library
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
sharedLibrary SharedLibrary https://help.xmatters.com/xmapi/index.html#shared-library-object
sharedLibraryId string The unique identifier (id) of the shared library to delete.

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

View Source sharedLibraries.js, line 66

Shared Library Object Updated
Promise.<SharedLibrary>