---
title: "GET /scan-requests/{id}"
method: GET
path: "/scan-requests/{id}"
tags: ["ScanRequestController"]
---

# GET /scan-requests/{id}

`GET /scan-requests/{id}`

## Path parameters

- `id` number, required

## Response `200`

ScanRequest model instance

- ScanRequestWithRelations — (tsType: ScanRequestWithRelations, schemaOptions: { includeRelations: true })
  - `id` number
  - `dataSourceConfig` object, required
    - `connector` 'databricks' | 'postgresql', required
    - `token` string
    - `host` string, required
    - `path` string, required
    - `port` number
    - `protocol` string
    - `profileNotebook` string
  - `scanParameters` object
    - `profile` boolean, required
    - `modelDefinitions` object[]
      - `name` string
      - `properties` object
      - `settings` object
        - `databricks` object
          - `catalog` string
          - `database` string
          - `tableName` string
          - `isTemporary` boolean
  - `logs` ScanRequestLogWithRelations[]
    - `id` number
    - `scanRequestId` number, required
    - `status` 'complete' | 'in progress', required
    - `modelDefinition` object
      - `name` string
      - `properties` object
      - `settings` object
        - `databricks` object
          - `catalog` string
          - `database` string
          - `tableName` string
          - `isTemporary` boolean
    - `modelProfile` object
      - `rowCount` number, required
      - `PropertyProfiles` object[]
        - `frequencyDistribution` object, required
          - `bucketName` string, required
          - `bucketCount` number, required
        - `distinctValues` number, required
        - `databricks` object
          - `col_name` string
          - `data_type` string
          - `comment` unknown

## Changes

- **2022-12-15** `17f92620449e` — 1 info
  - added the optional property `logs/items/modelProfile` to the response with the `200` status
- **2022-11-29** `f9eb0e2fcd7e` — 1 breaking, 5 info
  - the `logs/items/modelDefinition/properties/additionalProperties/databricks/comment` response's property type changed from `string` to no type for status `200`
  - added the optional property `dataSourceConfig/anyOf[subschema #1: DatabricksConfig]/port` to the response with the `200` status
  - added the optional property `dataSourceConfig/anyOf[subschema #1: DatabricksConfig]/profileNotebook` to the response with the `200` status
  - added the optional property `dataSourceConfig/anyOf[subschema #1: DatabricksConfig]/protocol` to the response with the `200` status
  - …2 more
- **2022-11-28** `e74eebc73540` — 1 breaking
  - the response property `dataSourceConfig/anyOf[subschema #1: DatabricksConfig]/token` became optional for the status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/ohdsi/apis/data-connection/changes/scan-requests/:id/get.md)

---

[API](https://skmtc.dev/ohdsi/apis/data-connection.md) · [All operations](https://skmtc.dev/ohdsi/apis/data-connection/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ohdsi/data-connection/revisions/17f92620449e/schema)