---
title: "B056 Dictionary query"
method: POST
path: "/synapse/dictionary/search"
tags: ["LS Search"]
---

# B056 Dictionary query

`POST /synapse/dictionary/search`

## Request

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

Obtain dictionary ID through entering keywords or selecting the dictionary type

## Request body

- B056DictionarySearchRequest
  - `dict_type` string: Dictionary type, fields support:PATENT_TECHNOLOGY：patent_technology; AUTHORITY_COUNTRY：patent_country; HOT_CONFERENCE：ct_result_meeting.
  - `id` string: Dictionary ID
  - `keyword` string: keywords
  - `limit` integer: limits
  - `offset` integer: offset
  - `parent_id` string: Parent Dictionary ID
  - `search_tree` boolean: Is Tree Search
  - `sort` B056DictionarySearchSortItemDto[]: Sort
    - `sort_field` string: sort field
    - `sort_order` string: ASC、DESC

## Response `200`

Successful b056 dictionary query response.

- B056DictionarySearchResponse
  - `data` B056DictionarySearchDictionaryTreeSearchResponseDto
    - `items` B056DictionarySearchDictionaryAutocompleteResponseDto[]: Dictionary List
      - `dict_id` string: Dictionary ID
      - `display_name` B056DictionarySearchCommonName[]: Dictionary Name
        - `lang` string: Language
        - `name` string: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
    - `limit` integer: limits
    - `total` integer: Dictionary total
    - `offset` integer: offset
  - `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)
