---
title: "Get Scan Job"
method: GET
path: "/api/discovery-scan-config/v2/scan-job/{jobId}"
tags: ["Scan Jobs"]
---

# Get Scan Job

`GET /api/discovery-scan-config/v2/scan-job/{jobId}`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/discovery-scan-config/v2/scan-job/{jobId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `DATA_DISCOVERY`

Use this API to retrieve details of a specific scan job by its unique identifier. Returns comprehensive job information including status, progress, timestamps, metadata counts, scan profile used, and ingestion status.

## Path parameters

- `jobId` string, uuid, required

## Response `200`

Scan job details retrieved successfully

- DataUseGovernanceDataDiscoveryMetadataScanJobV2Dto
  - `name` string: Name of Scan job
  - `sourceSystemId` string, uuid, required: Source System ID for Scan job
  - `scannerId` string, uuid, required: Scanner ID for Scan Job
  - `status` 'QUEUED' | 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'ABORTED' | 'STOPPED_AS_LOAD_ABORTED' | 'CANCELLED' | 'CANCELLING' | 'FAILED' | 'PAUSED' | 'PAUSING' | 'RESUMING', required: Scan job scan status
  - `statusMessage` string: Scan job status message
  - `scanLevel` 'INCREMENTAL_SCAN' | 'FULL_SCAN' | 'SCAN' | 'SOURCING' | 'CATALOG' | 'CATALOG_SCAN' | 'QUERY' | 'FILE_RETRIEVAL' | 'OFFSET_REPORT' | 'CATALOG_POLICY_SCAN' | 'ASSET_DISCOVERY' | 'DATA_ELEMENT_DISCOVERY' | 'POLICY_ORCHESTRATION_APPLY' | 'POLICY_ORCHESTRATION_UNAPPLY' | 'POLICY_ORCHESTRATION_EDIT' | 'POLICY_ORCHESTRATION_DELETE' | 'ROLE_INGESTION' | 'AI_ASSET_DISCOVERY' | 'GUARDRAIL_POLICY_ENFORCEMENT': Scan Job scan level
  - `isManual` boolean
  - `isVoyager` boolean
  - `jobContext` object
  - `expectedRecordCount` integer: Scan Job expected record count
  - `failedRecordCount` integer: Scan Job failed record count
  - `successRecordCount` integer: Scan Job success record count
  - `cancelledRecordCount` integer: Scan Job cancelled record count
  - `scannedMetadataCount` integer: Scan Job scanned metadata count
  - `uploadedMetadataCount` integer: Scan Job uploaded metadata count
  - `failedIngestionCount` integer: Scan Job failed ingestion count
  - `createdDate` string, date-time: Scan Job creation date
  - `createdBy` string, uuid: User who created Scan Job
  - `jobProgress` number, double: Scan Jobs progress
  - `updatedDate` string, date-time: Scan Job updated date
  - `updatedBy` string, uuid: user who last updated scan job
  - `cancelledBy` string, uuid: user who cancelled scan job
  - `cancelledDate` string, date-time: Scan Job cancelled date
  - `pausedBy` string, uuid: user who paused scan job
  - `pausedDate` string, date-time: Scan Job paused date
  - `resumedBy` string, uuid: user who resumed scan job
  - `resumedDate` string, date-time: Scan Job resumed date
  - `classifiedTermsCount` integer: Scan Job classified terms count
  - `ingestionStatus` 'AWAITING' | 'PUBLISHING' | 'PUBLISHED' | 'NONE': Scan Job ingestion status
  - `ingestionDate` string, date-time: Scan Job ingestion date
  - `ingestedMetadataVolume` integer: Scan job ingestion metadata volume in bytes
  - `scannedCount` string: Scan Job Scan count
  - `totalContentSize` integer: Scan Job total content size in bytes
  - `scanProfile` DataUseGovernanceDataDiscoveryScanProfileV2Dto
    - `id` string, uuid, required: Unique ID for Scan Profile
    - `name` string, required: Name of Scan Profile
    - `scanType` 'CATALOG' | 'CATALOG_SCAN', required: Scan Type of Scan Profile
    - `sourceType` 'SEED' | 'USER_DEFINED': Source of this Scan Profile
    - `systemName` string, required: System Name of Scan Profile
    - `scanProfileContext` object, required: Properties of Scan Profile Specific to System
    - `systemType` 'RELATIONAL_DATABASE' | 'NON_RELATIONAL_DATABASE' | 'FILE' | 'API' | 'CUSTOM' | 'UNKNOWN' | 'CLOUD_PLATFORM' | 'MACHINE_LEARNING_PLATFORM', required: System Type of Scan Profile
    - `createdDate` string, date-time: Creation Date of Scan Profile
    - `displayName` string: Display Name for System Name of Scan Profile
  - `retryAttempts` integer: Total Retry Attempts for scan job failures
  - `maxRetries` integer: Max Retries allowed for scan job failures
  - `idleScanDuration` integer: Idle time of scan when Paused (or) during retry
  - `scanDuration` integer: Actual Scan duration
  - `scanStartedDate` string, date-time: Actual Scan start date
  - `id` string, uuid
  - `manual` boolean
  - `voyager` boolean

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/data-use-governance-data-discovery.md) - [All operations](https://skmtc.dev/onetrust/apis/data-use-governance-data-discovery/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/data-use-governance-data-discovery/revisions/3de7ce93ffb7?raw)