Module

importJobs

A module related to xMatters import jobs.

https://help.xmatters.com/xmapi/index.html#import-jobs

View Source importJobs.js, line 3

Methods

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

Get a import job from xMatters

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

View Source importJobs.js, line 20

Import Job Object Requested
Promise.<ImportJob>

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

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

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

Array of Import Job Objects Requested
Promise.<Array.<ImportJob>>

# async inner getMessages(env, query, importId) → {Promise.<Array.<ImportMessage>>}

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

https://help.xmatters.com/xmapi/index.html#get-import-job-messages
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.
importId *

View Source importJobs.js, line 47

Array of Import Message Objects Requested
Promise.<Array.<ImportMessage>>