Skip to content

Function: getRedactionStatus() ​

ts
function getRedactionStatus(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  bulkRedactionResponse?: {
   [key: string]: unknown;
     results: object[];
  };
  jobStatus?: string & object | "IN_PROGRESS" | "PENDING" | "COMPLETED";
}>;

Defined in: src/cloud/api/issueRedaction.ts:39

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 ​

ParameterTypeDescription
clientClient-
parameters{ jobId: string; }-
parameters.jobIdstringRedaction job id
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; bulkRedactionResponse?: { [key: string]: unknown; results: object[]; }; jobStatus?: string & object | "IN_PROGRESS" | "PENDING" | "COMPLETED"; }>