Class: Auditing

Auditing

new Auditing()

Auditing Resource representing the auditing records

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

addRecord(options, callbackopt) → {Promise.<any>}

Store a record in Audit Log

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

summary string

summary

remoteAddress string

remoteAddress

authorKey string

authorKey

created string

created

category string

category

eventSource string

eventSource

description string

description

objectItem string

objectItem

changedValues string

changedValues

associatedItems string

associatedItems

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getRecords(options, callbackopt) → {Promise.<any>}

Returns auditing records filtered using provided parameters- the number of record from which search starts- maximum number of returned results (if is limit is 1000, it will be set do default value: 1000)- text query; each record that will be returned must contain the provided text in one of its fields- timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty only records that where created in the same moment or after the 'from' timestamp will be provided in response- timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty only records that where created in the same moment or earlier than the 'to' timestamp will be provided in response

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
offset string

offset - the number of record from which search starts

limit string

limit - maximum number of returned results (if is limit is 1000, it will be set do default value: 1000)

filter string

filter - text query; each record that will be returned must contain the provided text in one of its fields

from string

from - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty only records that where created in the same moment or after the 'from' timestamp will be provided in response

to string

to - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty only records that where created in the same moment or earlier than the 'to' timestamp will be provided in response

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>