Skip to main content

RequestDeleteResponse

The response returned by the Deletion Job.

fields

  • job non-null DeletionJob

    The Deletion Job that was just created.

    Deletion Job scheduled for a specific Data Pool.

    The Deletion Job represents the asynchronous process of deleting data given some filters inside a Data Pool. It tracks the deletion process until it is finished, showing the progress and the outcome when it is finished.

    • job.id non-null ID

      The Deletion Job's ID.

    • job.createdAt non-null DateTime

      The Deletion Job's creation date and time in UTC.

    • job.createdBy non-null String

      Who created the Deletion Job.

    • job.modifiedAt non-null DateTime

      The Deletion Job's last modification date and time in UTC.

    • job.modifiedBy non-null String

      Who last modified the Deletion Job.

    • job.account non-null Account

      Account to which the Deletion Job belongs.

    • job.environment non-null Environment

      Environment to which the Deletion Job belongs.

    • job.dataPool non-null DataPool

      The Data Pool whose records will be deleted by the Deletion Job.

    • job.status non-null JobStatus

      The current Deletion Job's status.

      • CREATED

        The Job was created, but is not yet being executed.

      • IN_PROGRESS

        The Job is executing.

      • SUCCEEDED

        The Job succeeded.

      • FAILED

        The Job failed. Check the error message.

    • job.filters non-null array of Filter

      The list of filters that will be used for deleting data. Data matching the filters will be deleted.

    • job.error nullable Error

      The error that occurred while deleting data, if any.

    • job.progress non-null Float

      The current progress of the Deletion Job, from 0.0 to 1.0.

    • job.startedAt nullable DateTime

      The time at which the Deletion Job started.

    • job.succeededAt nullable DateTime

      The time at which the Deletion Job succeeded.

    • job.failedAt nullable DateTime

      The time at which the Deletion Job failed.