Platform & adminMu Mutation

deleteArchiveJob

Topics: Admin

Delete an archive job, cancelling its schedule. Reports notFound if no such job exists for the tenant. Requires archiveJob:delete permission.

Returns

DeletePayload!

Arguments

TypeID (prefix arj) of the archive job to delete.

Exact field SDL
"""
Delete an archive job, cancelling its schedule. Reports notFound if no such job exists for the tenant. Requires archiveJob:delete permission.
"""
deleteArchiveJob(
  """TypeID (prefix `arj`) of the archive job to delete."""
  id: ArchiveJobID!
): DeletePayload! @topic(names: ["admin"])

Declared on Mutation. Access is checked by the platform for each operation.