Module

annotations

A module related to xMatters event annotations (comments).

https://help.xmatters.com/xmapi/index.html#get-event-annotations

View Source annotations.js, line 3

Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance
annotationId string The unique identifier (id) or eventID (eventId) of the event
query Object A json object representing the query string parameters for this request.
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 10

Annotation Object Requested
Promise.<Annotation>
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.
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 31

Array of Annotation Objects Requested
Promise.<Array.<Annotation>>
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
annotation Annotation https://help.xmatters.com/xmapi/index.html#event-annotation-object
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 51

Annotation Object Created
Promise.<Annotation>
Get an event annotation from an event in xMatters

https://help.xmatters.com/xmapi/index.html#get-an-event-annotation

View Source annotations.js, line 3

Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance
annotationId string The unique identifier (id) or eventID (eventId) of the event
query Object A json object representing the query string parameters for this request.
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 10

Annotation Object Requested
Promise.<Annotation>
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.
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 31

Array of Annotation Objects Requested
Promise.<Array.<Annotation>>
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
annotation Annotation https://help.xmatters.com/xmapi/index.html#event-annotation-object
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 51

Annotation Object Created
Promise.<Annotation>
Get all event annotations from a xMatters event matching the query. Please refer to the link below for the available query parameters.

https://help.xmatters.com/xmapi/index.html#get-event-annotations

View Source annotations.js, line 3

Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance
annotationId string The unique identifier (id) or eventID (eventId) of the event
query Object A json object representing the query string parameters for this request.
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 10

Annotation Object Requested
Promise.<Annotation>
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.
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 31

Array of Annotation Objects Requested
Promise.<Array.<Annotation>>
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
annotation Annotation https://help.xmatters.com/xmapi/index.html#event-annotation-object
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 51

Annotation Object Created
Promise.<Annotation>
Create an event annotation in xMatters

https://help.xmatters.com/xmapi/index.html#add-a-comment-to-an-event

View Source annotations.js, line 3

Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance
annotationId string The unique identifier (id) or eventID (eventId) of the event
query Object A json object representing the query string parameters for this request.
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 10

Annotation Object Requested
Promise.<Annotation>
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.
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 31

Array of Annotation Objects Requested
Promise.<Array.<Annotation>>
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
annotation Annotation https://help.xmatters.com/xmapi/index.html#event-annotation-object
eventId string The unique identifier (id) or eventID (eventId) of the event.

Examples :
- “add6a38f-bed7-4169-afa2-cbaf5387ef06”
- “41159032”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use events.getMany() or locate the Event UUID entry on the event’s Properties screen in the user interface.

View Source annotations.js, line 51

Annotation Object Created
Promise.<Annotation>