Class: module:api/IssuesApi

module:api/IssuesApi(apiClient)

new module:api/IssuesApi(apiClient)

Constructs a new IssuesApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.
Source:

Members

(static, readonly) RegionEnum :String

Allowed values for the region property.

Type:
  • String
Properties:
Name Type Description
US String

value: "US"
EMEA String

value: "EMEA"
EU String

value: "EU"
Source:

Methods

GetAttachments(containerId, issueId, opts, oauth2client, credentials)

Returns issue attachments.

Parameters:
Name Type Description
containerId String

Project ID
issueId String

Issue ID
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

GetAttributeDefinitions(containerId, opts, oauth2client, credentials)

Returns attribute definitions.

Parameters:
Name Type Description
containerId String

Container ID
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

GetAttributeMappings(containerId, opts, oauth2client, credentials)

Returns attribute mappings.

Parameters:
Name Type Description
containerId String

Container ID
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

GetComments(containerId, issueId, opts, oauth2client, credentials)

Returns issue comments.

Parameters:
Name Type Description
containerId String

Project ID
issueId String

Issue ID
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

GetIssue(containerId, issueId, opts, oauth2client, credentials)

Returns one issue by id.

Parameters:
Name Type Description
containerId String

Project ID
issueId String

Issue ID
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

GetIssues(containerId, opts, oauth2client, credentials)

Returns issues.

Parameters:
Name Type Description
containerId String

Project ID
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

GetRootCauses(containerId, opts, oauth2client, credentials)

Returns root causes.

Parameters:
Name Type Description
containerId String

Container ID
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

GetTypes(containerId, opts, oauth2client, credentials)

Returns types.

Parameters:
Name Type Description
containerId String

Container ID
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

PatchIssue(containerId, issueId, body, opts, oauth2client, credentials)

Updates an issue

Parameters:
Name Type Description
containerId String

Container ID
issueId String

Issue ID
body Object

Payload body
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

PostAttachments(containerId, opts, oauth2client, credentials)

Creates issue attachments.

Parameters:
Name Type Description
containerId String

Project ID
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

PostComment(containerId, opts, oauth2client, credentials)

Creates issue comment.

Parameters:
Name Type Description
containerId String

Project ID
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

PostIssue(containerId, body, opts, oauth2client, credentials)

Creates a new issue

Parameters:
Name Type Description
containerId String

Container ID
body Object

Payload body
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source: