---
updatedAt: 2026-04-24T16:39:46.000Z
agentTools:
  projectIndex: https://developer.onetrust.com/onetrust/llms.txt
---

# Get Scan Job

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.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Data Use Governance - Data Discovery",
    "version": "1.0",
    "contact": {
      "name": "OneTrust Support",
      "url": "https://my.onetrust.com/s/contactsupport"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "description": "The Data Discovery API provides comprehensive REST endpoints for managing data discovery operations including data sources, scan profiles, credentials, and scan jobs with OAuth2 security and extensive filtering capabilities."
  },
  "servers": [
    {
      "url": "https://{hostname}",
      "variables": {
        "hostname": {
          "default": "hostname",
          "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Scan Jobs",
      "description": "APIs to control scan job execution including creation, cancellation, status monitoring, and comprehensive job history retrieval with filtering and pagination support.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"
      },
      "x-displayName": "Scan Jobs"
    }
  ],
  "paths": {
    "/api/discovery-scan-config/v2/scan-job/{jobId}": {
      "get": {
        "operationId": "getJobByIdUsingGET",
        "summary": "Get Scan Job",
        "description": "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.",
        "tags": [
          "Scan Jobs"
        ],
        "parameters": [
          {
            "name": "jobId",
            "in": "path",
            "description": "Unique identifier (UUID) of the scan job. Obtain from Create Scan Job API or Get List of Scan Jobs API. Must be a valid UUID format.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "ef5c9081-431e-4577-bd91-1ff8bbd40f96"
          }
        ],
        "responses": {
          "200": {
            "description": "Scan job details retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "429": {
            "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).",
            "headers": {
              "Retry-After": {
                "schema": {
                  "description": "The number of seconds after which requests will be allowed again.",
                  "format": "int32"
                }
              },
              "ot-period": {
                "schema": {
                  "description": "The unit of time for which the rate limit applies",
                  "enum": [
                    "HOUR",
                    "MINUTE"
                  ]
                }
              },
              "ot-ratelimit-event-id": {
                "schema": {
                  "description": "The unique identifier for the rate-limiting event.",
                  "format": "uuid"
                }
              },
              "ot-request-made": {
                "schema": {
                  "description": "The number of requests made within the specified period.",
                  "format": "int32"
                }
              },
              "ot-requests-allowed": {
                "schema": {
                  "description": "The number of requests allowed within the specified period.",
                  "format": "int32"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "DataUseGovernance-DataDiscovery_OAUTH2": [
              "DATA_DISCOVERY"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "DataUseGovernance-DataDiscovery_ScanProfileV2Dto": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique ID for Scan Profile",
            "type": "string",
            "format": "uuid",
            "example": "4f162d7c-a563-4bf1-a7c4-b7899f6dcdef"
          },
          "name": {
            "description": "Name of Scan Profile",
            "type": "string",
            "example": "My SQL Scan Profile"
          },
          "scanType": {
            "description": "Scan Type of Scan Profile",
            "type": "string",
            "example": "CATALOG",
            "enum": [
              "CATALOG",
              "CATALOG_SCAN"
            ]
          },
          "sourceType": {
            "description": "Source of this Scan Profile",
            "type": "string",
            "example": "USER_DEFINED",
            "enum": [
              "SEED",
              "USER_DEFINED"
            ]
          },
          "systemName": {
            "description": "System Name of Scan Profile",
            "type": "string",
            "example": "MySQL"
          },
          "scanProfileContext": {
            "description": "Properties of Scan Profile Specific to System",
            "type": "object",
            "example": {
              "type": "MySQL",
              "includes": [
                {
                  "database": "OT",
                  "table": "Employee",
                  "columns": "Name"
                }
              ],
              "excludes": [
                {
                  "database": "OT",
                  "table": "Credential",
                  "columns": "Id"
                }
              ],
              "samplingScan": {
                "enableSampling": false
              },
              "tableLimits": {
                "randomize": false,
                "maxCount": 10
              },
              "tableTypes": [
                "TABLE"
              ],
              "databaseLimits": {
                "randomize": false,
                "maxCount": 1
              }
            }
          },
          "systemType": {
            "description": "System Type of Scan Profile",
            "type": "string",
            "example": "RELATIONAL_DATABASE",
            "enum": [
              "RELATIONAL_DATABASE",
              "NON_RELATIONAL_DATABASE",
              "FILE",
              "API",
              "CUSTOM",
              "UNKNOWN",
              "CLOUD_PLATFORM",
              "MACHINE_LEARNING_PLATFORM"
            ]
          },
          "createdDate": {
            "description": "Creation Date of Scan Profile",
            "type": "string",
            "format": "date-time",
            "example": "2021-09-11T01:41:50.143+00:00"
          },
          "displayName": {
            "description": "Display Name for System Name of Scan Profile",
            "type": "string",
            "example": "Amazon Redshift"
          }
        },
        "required": [
          "id",
          "name",
          "scanProfileContext",
          "scanType",
          "systemName",
          "systemType"
        ]
      },
      "DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto": {
        "type": "object",
        "properties": {
          "name": {
            "description": "Name of Scan job",
            "type": "string",
            "example": "S3-DS-24thMarch",
            "minLength": 1
          },
          "sourceSystemId": {
            "description": "Source System ID for Scan job",
            "type": "string",
            "format": "uuid",
            "example": "4f162d7c-a563-4bf1-a7c4-b7899f6dcdef"
          },
          "scannerId": {
            "description": "Scanner ID for Scan Job",
            "type": "string",
            "format": "uuid",
            "example": "4f162d7c-a563-4bf1-a7c4-b7899f6dcdef"
          },
          "status": {
            "description": "Scan job scan status",
            "type": "string",
            "example": "Completed",
            "enum": [
              "QUEUED",
              "PENDING",
              "PROCESSING",
              "COMPLETED",
              "ABORTED",
              "STOPPED_AS_LOAD_ABORTED",
              "CANCELLED",
              "CANCELLING",
              "FAILED",
              "PAUSED",
              "PAUSING",
              "RESUMING"
            ]
          },
          "statusMessage": {
            "description": "Scan job status message",
            "type": "string",
            "example": "status message"
          },
          "scanLevel": {
            "description": "Scan Job scan level",
            "type": "string",
            "example": "CATALOG_SCAN",
            "enum": [
              "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"
            ]
          },
          "isManual": {
            "type": "boolean",
            "writeOnly": true
          },
          "isVoyager": {
            "type": "boolean",
            "writeOnly": true
          },
          "jobContext": {
            "type": "object"
          },
          "expectedRecordCount": {
            "description": "Scan Job expected record count",
            "type": "integer",
            "format": "int64",
            "example": 8
          },
          "failedRecordCount": {
            "description": "Scan Job failed record count",
            "type": "integer",
            "format": "int64",
            "example": 0
          },
          "successRecordCount": {
            "description": "Scan Job success record count",
            "type": "integer",
            "format": "int64",
            "example": 8
          },
          "cancelledRecordCount": {
            "description": "Scan Job cancelled record count",
            "type": "integer",
            "format": "int64",
            "example": 0
          },
          "scannedMetadataCount": {
            "description": "Scan Job scanned metadata count",
            "type": "integer",
            "format": "int64",
            "example": 38
          },
          "uploadedMetadataCount": {
            "description": "Scan Job uploaded metadata count",
            "type": "integer",
            "format": "int64",
            "example": 38
          },
          "failedIngestionCount": {
            "description": "Scan Job failed ingestion count",
            "type": "integer",
            "format": "int64",
            "example": 0
          },
          "createdDate": {
            "description": "Scan Job creation date",
            "type": "string",
            "format": "date-time",
            "example": "2022-05-24T14:44:02.596+00:00"
          },
          "createdBy": {
            "description": "User who created Scan Job",
            "type": "string",
            "format": "uuid",
            "example": "2ae93388-bef6-4b84-a612-8a4904b78dac"
          },
          "jobProgress": {
            "description": "Scan Jobs progress",
            "type": "number",
            "format": "double",
            "example": 100
          },
          "updatedDate": {
            "description": "Scan Job updated date",
            "type": "string",
            "format": "date-time",
            "example": "2022-05-24T14:44:22.294+00:00"
          },
          "updatedBy": {
            "description": "user who last updated scan job",
            "type": "string",
            "format": "uuid",
            "example": "2ae93388-bef6-4b84-a612-8a4904b78dac"
          },
          "cancelledBy": {
            "description": "user who cancelled scan job",
            "type": "string",
            "format": "uuid",
            "example": "2ae93388-bef6-4b84-a612-8a4904b78dac"
          },
          "cancelledDate": {
            "description": "Scan Job cancelled date",
            "type": "string",
            "format": "date-time",
            "example": "2022-05-24T14:44:22.294+00:00"
          },
          "pausedBy": {
            "description": "user who paused scan job",
            "type": "string",
            "format": "uuid",
            "example": "2ae93388-bef6-4b84-a612-8a4904b78dac"
          },
          "pausedDate": {
            "description": "Scan Job paused date",
            "type": "string",
            "format": "date-time",
            "example": "2022-05-24T14:44:22.294+00:00"
          },
          "resumedBy": {
            "description": "user who resumed scan job",
            "type": "string",
            "format": "uuid",
            "example": "2ae93388-bef6-4b84-a612-8a4904b78dac"
          },
          "resumedDate": {
            "description": "Scan Job resumed date",
            "type": "string",
            "format": "date-time",
            "example": "2022-05-24T14:44:22.294+00:00"
          },
          "classifiedTermsCount": {
            "description": "Scan Job classified terms count",
            "type": "integer",
            "format": "int64",
            "example": 7
          },
          "ingestionStatus": {
            "description": "Scan Job ingestion status",
            "type": "string",
            "example": "PUBLISHED",
            "enum": [
              "AWAITING",
              "PUBLISHING",
              "PUBLISHED",
              "NONE"
            ]
          },
          "ingestionDate": {
            "description": "Scan Job ingestion date",
            "type": "string",
            "format": "date-time",
            "example": "2022-05-24T14:44:33.803+00:00"
          },
          "ingestedMetadataVolume": {
            "description": "Scan job ingestion metadata volume in bytes",
            "type": "integer",
            "format": "int64",
            "example": 37734
          },
          "scannedCount": {
            "description": "Scan Job Scan count",
            "type": "string",
            "example": {
              "S3_BUCKET": 3,
              "Column": 14,
              "File": 4,
              "DataSource": 1
            }
          },
          "totalContentSize": {
            "description": "Scan Job total content size in bytes",
            "type": "integer",
            "format": "int64",
            "example": 295454
          },
          "scanProfile": {
            "$ref": "#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileV2Dto"
          },
          "retryAttempts": {
            "description": "Total Retry Attempts for scan job failures",
            "type": "integer",
            "format": "int32",
            "example": 1
          },
          "maxRetries": {
            "description": "Max Retries allowed for scan job failures",
            "type": "integer",
            "format": "int32",
            "example": 3
          },
          "idleScanDuration": {
            "description": "Idle time of scan when Paused (or) during retry",
            "type": "integer",
            "format": "int64",
            "example": 377342131
          },
          "scanDuration": {
            "description": "Actual Scan duration",
            "type": "integer",
            "format": "int64",
            "example": 377342131
          },
          "scanStartedDate": {
            "description": "Actual Scan start date",
            "type": "string",
            "format": "date-time",
            "example": "2022-05-24T14:44:22.294+00:00"
          },
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "manual": {
            "type": "boolean"
          },
          "voyager": {
            "type": "boolean"
          }
        },
        "example": [
          {
            "id": 1,
            "name": "Item"
          }
        ],
        "required": [
          "scannerId",
          "sourceSystemId",
          "status"
        ]
      }
    },
    "securitySchemes": {
      "DataUseGovernance-DataDiscovery_OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "DATA_DISCOVERY": "DATA_DISCOVERY scope for external systems"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0"
  }
}
```

# Sibling pages

* [Create Scan Job](https://developer.onetrust.com/onetrust/reference/createjobusingpost.md)
* [Get List of Scan Jobs](https://developer.onetrust.com/onetrust/reference/getscanjobsbydatasourceusingget_1.md)
* [Get Scan Job](https://developer.onetrust.com/onetrust/reference/getjobusingget_1.md)
* [Cancel Scan Job](https://developer.onetrust.com/onetrust/reference/cancelscanjob.md)
* [Cancel Scan Job](https://developer.onetrust.com/onetrust/reference/canceljobusingpatch.md)