Skip to content

Variable: LongTaskStatusSchema ​

ts
const LongTaskStatusSchema: ZodObject<{
  additionalDetails: ZodOptional<ZodObject<{
     additionalProperties: ZodOptional<ZodString>;
     destinationId: ZodOptional<ZodString>;
     destinationUrl: ZodOptional<ZodString>;
     totalPageNeedToCopy: ZodOptional<ZodNumber>;
  }, ApiObjectConfig<undefined>>>;
  ari: ZodOptional<ZodString>;
  elapsedTime: ZodNumber;
  errors: ZodOptional<ZodArray<ZodObject<{
     args: ZodArray<ZodUnion<readonly [ZodString, ZodRecord<ZodString, ZodAny>]>>;
     key: ZodOptional<ZodString>;
     translation: ZodOptional<ZodString>;
  }, ApiObjectConfig<undefined>>>>;
  finished: ZodBoolean;
  id: ZodString;
  messages: ZodArray<ZodObject<{
     args: ZodArray<ZodUnion<readonly [ZodString, ZodRecord<ZodString, ZodAny>]>>;
     key: ZodOptional<ZodString>;
     translation: ZodOptional<ZodString>;
  }, ApiObjectConfig<undefined>>>;
  name: ZodObject<{
     args: ZodArray<ZodRecord<ZodString, ZodAny>>;
     key: ZodString;
  }, ApiObjectConfig<undefined>>;
  percentageComplete: ZodNumber;
  status: ZodOptional<ZodString>;
  successful: ZodBoolean;
}, ApiObjectConfig<undefined>>;

Defined in: src/v1/models/longTaskStatus.ts:29

Current status of a long running task

Status keys:

  • ERROR_UNKNOWN - Generic error
  • ERROR_LOCK_FAILED - Could not get the lock on destination space
  • ERROR_RELINK - Error when relink pages/attachments
  • ERROR_COPY_PAGE - Error while copying 1 page
  • WARN_RENAME_PAGE - Warning page is rename during copy
  • WARN_IGNORE_COPY_PERMISSION - Warning could not copy permission
  • WARN_IGNORE_COPY_ATTACHMENT - Warning could not copy attachment
  • WARN_IGNORE_DELETE_PAGE - Warning ignoring delete of a non agreed on page
  • STATUS_COPIED_PAGES - Message total pages are copied
  • STATUS_COPYING_PAGES - Message copy pages
  • STATUS_RELINK_PAGES - Message relink pages/attachments
  • STATUS_DELETING_PAGES - Message delete pages
  • STATUS_DELETED_PAGES - Message total pages are deleted
  • STATUS_MOVING_PAGES - Message move pages
  • WARN_IGNORE_VIEW_RESTRICTED - Permission changed - view restricted
  • WARN_IGNORE_EDIT_RESTRICTED - Permission changed - edit restricted
  • INITIALIZING_TASK - Message when initializing task
  • UNKNOWN_STATUS - Message when status is unknown