Search

Search Assets

post

This searches for assets across the PDC that are available based on the provided search term and optional facets.

🚨 Note: Results are limited to 10,000 items.Please refrain your search using facets.

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Body

application/json

searchTermstringRequired

pagenumberOptionalDefault: 1

perPagenumberOptionalDefault: 30

Responses

200

Search results retrieved successfully

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post

/api/public/v1/search

HTTPcURLJavaScriptPython

POST /api/public/v1/search HTTP/1.1
Host: hostname
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "searchTerm": "test"
}

Search with only a termSearch with term and paginationSearch with term and index facetSearch with index and type facetsSearch with index, type, and file format facetSearch with column type and primary/foreign key facetsSearch with profiledAt facetSearch with bucket facetSearch with parent ID facet

{
  "status": 200,
  "pageInfo": {
    "currentPage": 1,
    "perPage": 30,
    "totalMatchCount": 55593,
    "retrievableCount": 10000,
    "pageCount": 333
  },
  "data": [
    {
      "id": "a1b2c3d4",
      "name": "Patient Demographics",
      "description": "Basic patient demographic information",
      "index": "pdc_entities",
      "type": "FILE",
      "fqdn": "Resource/Folder/File/PatientDemographics",
      "style": {
        "color": "#ff9900",
        "icon": "UI Kit Icon"
      },
      "businessTerms": [
        {
          "termId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "PII",
          "fqdn": "Customer/PII",
          "glossaryId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "permissions": [
        "text"
      ],
      "properties": {
        "size": "2MB",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "format": "CSV"
      }
    }
  ]
}

Search Facets

post

Retrieves available facets for search

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Body

application/json

searchTermstringRequired

Responses

200

Search results retrieved successfully

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post

/api/public/v1/search/facets

HTTPcURLJavaScriptPython

POST /api/public/v1/search/facets HTTP/1.1
Host: hostname
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "searchTerm": "test"
}

Search with only a termSearch with term and paginationSearch with term and index facetSearch with index and type facetsSearch with index, type, and file format facetSearch with column type and primary/foreign key facetsSearch with profiledAt facetSearch with bucket facetSearch with parent ID facet

{
  "status": 200,
  "data": [
    {
      "key": "index",
      "options": [
        {
          "name": "pdc_entities",
          "count": 10000,
          "value": "pdc_entities"
        }
      ]
    }
  ]
}