---
title: "B010-1 Drug related patent aggregation"
method: POST
path: "/synapse/patent/relate/aggregation"
tags: ["LS Search"]
---

# B010-1 Drug related patent aggregation

`POST /synapse/patent/relate/aggregation`

## Request

- Base URL: `https://connect.patsnap.com`
- URL: `https://connect.patsnap.com/synapse/patent/relate/aggregation`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/docs/synapse/patent/relate/aggregation/post.ts> (a function with typed inputs; its response is checked against the schema)

Obtain Aggregated information through drug, target, disease, etc.

## Request body

- B0101RelateAggregationRequest
  - `drug` B0101RelateAggregationCommonConditionValue
    - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
    - `keyword_value` unknown[]: Keywrod List
      - unknown
    - `value` unknown[]: Value List
      - unknown
  - `drug_patent_type` string: Drug patent type. The value is an enum with the following values: PRODUCT_COMPOUND_SEQUENCE, DRUG_COMBINATION_FORMULATION, PRODUCT_DERIVATIVE, CRYSTAL_FORM, PROCESS, NEW_USE, DOSAGE_FORM, DEVICE, DIAGNOSTIC_ANALYSIS_AND_ASSAY, OTHERS
  - `drug_type` B0101RelateAggregationCommonConditionValue
    - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
    - `keyword_value` unknown[]: Keywrod List
      - unknown
    - `value` unknown[]: Value List
      - unknown
  - `patent_tech_type` B0101RelateAggregationCommonConditionValue
    - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
    - `keyword_value` unknown[]: Keywrod List
      - unknown
    - `value` unknown[]: Value List
      - unknown
  - `target` B0101RelateAggregationCommonConditionValue
    - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
    - `keyword_value` unknown[]: Keywrod List
      - unknown
    - `value` unknown[]: Value List
      - unknown
  - `disease` B0101RelateAggregationCommonConditionValue
    - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
    - `keyword_value` unknown[]: Keywrod List
      - unknown
    - `value` unknown[]: Value List
      - unknown
  - `source` string: Patent Source. The value is an enum with the following values: FDA_PURPLE_BOOK, FDA_ORANGE_BOOK, CDE, MEDSPAL, VAXPAL, MFDS
  - `patent_assignee` B0101RelateAggregationCommonConditionValue
    - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
    - `keyword_value` unknown[]: Keywrod List
      - unknown
    - `value` unknown[]: Value List
      - unknown
  - `patent_country` unknown[]: Authority, obtain this through the dictionary query interface
    - unknown
  - `simple_legal_status` unknown[]: Simple Legal Status. The value is an enum with the following values: INACTIVE, ACTIVE, PENDING, PCT_DESIGNATED_STAGE, PCT_DESIGNATED_STAGE_EXPIRED, UNDETERMINED
    - unknown
  - `pbdt` B0101RelateAggregationLongRangeItem
    - `from` integer: from
    - `to` integer: to
  - `apdt` B0101RelateAggregationLongRangeItem
    - `from` integer: from
    - `to` integer: to
  - `exdt` B0101RelateAggregationLongRangeItem
    - `from` integer: from
    - `to` integer: to
  - `aggregation_field` unknown[]: <p>Aggregation field : </p><p>PHS_CORE_DRUG_ID: Patent Drug</p><p>PHS_DRUG_TYPE_ID: Drug Type</p><p>PHS_CORE_TYPE_ID: Drug Patent Type</p><p>PATENT_TECHNOLOGY: Patent Tech Type</p><p>COUNTRY: Authority</p><p>FAM_COUNTRY: Simple Family Jurisdiction</p><p>EXDT_Y: Estimated Expiry Year</p><p>PHS_THERAPEUTIC_AREA: Therapeutic Area</p><p>PHS_ORG_ID_ONEID: Std. Current Assignee</p><p>ANCS_TYPE: Std. Current Assignee Type</p><p>PHS_ANS_ORG_ID_ONEID: Std. Original Assignee</p><p>ANS_TYPE: Std. Original Assignee Type</p><p>IN_FACET: Inventor</p><p>PHS_EXTENSION_TYPE: Extension Type</p><p>SPC_STATUS: SPC Status</p><p>SPC_COUNTRY: SPC Country/Location</p><p>SPC_EXPIRY_DATE: SPC Expiry Year</p><p>PED_STATUS: PED Status</p><p>PED_EXPIRY_DATE: PED Expiry Year</p><p>PTE_STATUS: PTE Status</p><p>PTE_COUNTRY: PTE Country/Location</p><p>PTE_EXPIRY_DATE: PTE Expiry Year</p><p>PHS_CORE_DRUG_SOURCE: Information Source</p><p>APD_YEAR: Application Year</p><p>PBDT_YEAR: Publication Year</p><p>PHS_DRUG_ID: Related Drug</p><p>PHS_TARGET_ID: Related Target</p><p>PHS_DISEASE_ID: Related Indications</p><p>PHS_DOSAGE_FORM_ID: Related Dosage Form</p><p>SIMPLE_LEGAL_STATUS: Simple Legal Status</p><p>LEGAL_STATUS: Legal Status</p>
    - unknown

## Response `200`

Successful b010-1 drug related patent aggregation response.

- B0101RelateAggregationResponse
  - `data` B0101RelateAggregationAggregationResponse
    - `aggregation_result` B0101RelateAggregationAggregationResult[]: Aggregation result
      - `items` B0101RelateAggregationAggregationResultItem[]: Details of aggregation items
        - `key` string: Primary key
        - `color` string: Color(Return when the aggregated fields are SIMPLE_LEGAL_STATUS and LEGAL_STATUS)
        - `count` integer: Quantity
        - `display_name_cn` string: English display name
        - `display_name_en` string: Chinese display name
      - `total` integer: The number of aggregated items
      - `aggregation_field` string: Aggregated field
  - `status` boolean, required: Status
  - `error_msg` string: Error Message
  - `error_code` integer, required: Error Code

## Other responses

- `201`: Created.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Not Found.

---

[API](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api.md) - [All operations](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/revisions/c2264a0de595?raw)