Function redact

redact(
    client: Client,
    parameters: {
        redactions?: {
            contentItem: {
                entityId: string;
                entityType:
                    | string & {}
                    | "issuefieldvalue"
                    | "issue-comment"
                    | "issue-worklog";
                id: string;
                [key: string]: unknown;
            };
            externalId: string;
            reason: string;
            redactionPosition: {
                adfPointer?: string;
                expectedText: string;
                from: number;
                to: number;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        }[];
    },
    options?: RequestOptions,
): 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
- client: Client
- parameters: {
      redactions?: {
          contentItem: {
              entityId: string;
              entityType:
                  | string & {}
                  | "issuefieldvalue"
                  | "issue-comment"
                  | "issue-worklog";
              id: string;
              [key: string]: unknown;
          };
          externalId: string;
          reason: string;
          redactionPosition: {
              adfPointer?: string;
              expectedText: string;
              from: number;
              to: number;
              [key: string]: unknown;
          };
          [key: string]: unknown;
      }[];
  }
- Optionaloptions: RequestOptions
Returns Promise<string>
- Defined in src/cloud/api/issueRedaction.ts:16

Function redact

Parameters

Returns Promise<string>

Settings