A module related to xMatters temporary absences.
https://help.xmatters.com/xmapi/index.html#temporary-absences
https://help.xmatters.com/xmapi/index.html#temporary-absences
Members
# inner delete
Delete a temporary absence in xMatters
https://help.xmatters.com/xmapi/index.html#delete-a-temporary-absence
https://help.xmatters.com/xmapi/index.html#delete-a-temporary-absence
# inner constant fields
The key values from the object that can be synchronized.
Methods
# async inner create(env, temporaryAbsence) → {Promise.<TemporaryAbsence>}
Create a temporary absence in xMatters
https://help.xmatters.com/xmapi/index.html#create-a-temporary-absence
https://help.xmatters.com/xmapi/index.html#create-a-temporary-absence
Parameters:
| Name | Type | Description |
|---|---|---|
env |
module:environments.xMattersEnvironment | The xmtoolbox representation of an xMatters instance. |
temporaryAbsence |
string | https://help.xmatters.com/xmapi/index.html#temporary-absence-object |
Temporary Absence Object Created
Promise.<TemporaryAbsence>
# async inner exportToImport(destination, temporaryAbsences) → {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. |
temporaryAbsences |
Array.<TemporaryAbsence> | https://help.xmatters.com/xmapi/index.html#temporary-absence-object |
Promise
# async inner getMany(env, query) → {Promise.<Array.<TemporaryAbsence>>}
Get all temporary absences from xMatters matching the query. Please refer to the link below for the available query parameters.
https://help.xmatters.com/xmapi/index.html#get-temporary-absences
https://help.xmatters.com/xmapi/index.html#get-temporary-absences
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. |
Array of Temporary Absence Objects Requested
Promise.<Array.<TemporaryAbsence>>
# async inner sync(destination, sourceTemporaryAbsences, destinationTemporaryAbsences, 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. |
sourceTemporaryAbsences |
TemporaryAbsence | An array of the Temporary Absence objects to synchronize from the source data. |
destinationTemporaryAbsences |
Array.<TemporaryAbsence> | An array of the Temporary Absence objects to synchronize from the destination data. |
options |
Object |