Class IssueRedactionService

This resource represents Issue Redaction. Provides APIs to redact issue data.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-redaction

Hierarchy

CommonHttpService
- IssueRedactionService

Index

Constructors

Methods

getRedactionStatus redact initialize

Constructors

constructor

new IssueRedactionService(getClientInstance): IssueRedactionService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns IssueRedactionService
Inherited from CommonHttpService.constructor

Methods

getRedactionStatus

getRedactionStatus(params): Promise<RedactionJobStatusResponse>
Retrieves the current status of a redaction job ID.

The jobStatus will be one of the following:
- IN_PROGRESS - The redaction job is currently in progress
- COMPLETED - The redaction job has completed successfully.
- PENDING - The redaction job has not started yet
Parameters
- params: {
  jobId: string;
  }
  - jobId: string
    Redaction job id
Returns Promise<RedactionJobStatusResponse>
Returned if the job status is successfully retrieved.

Path
GET /rest/api/3/redact/status/{jobId} @scopes-beta redact:issue:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-redaction#api-rest-api-3-redact-status-jobid-get

redact

redact(params): Promise<string>
Submit a job to redact issue field data. This will trigger the redaction of the data in the specified fields asynchronously.

The redaction status can be polled using the job id.
Parameters
- params: {
  bulkRedactionRequest: BulkRedactionRequest;
  }
  - bulkRedactionRequest: BulkRedactionRequest
    List of redaction requests
Returns Promise<string>
Returned if the job submission is successful. The response contains the job id.

Path
POST /rest/api/3/redact @scopes-beta redact:issue:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-redaction#api-rest-api-3-redact-post

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize