What is the endpoint for [B040] Target basic information?

The [B040] Target basic information endpoint is GET https://connect.patsnap.com/synapse/target/detail.

What data can [B040] Target basic information return?

[B040] Target basic information Obtain Target basic information about name, short name, alias etc. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [B040] Target basic information?

The OpenAPI schema is available at /openapi.json#/paths/~1synapse~1target~1detail/get. You can also browse the full specification at /openapi.json.

[B040] Target basic information

get

https://connect.patsnap.com/synapse/target/detail

Try in Sandbox

Obtain Target basic information about name, short name, alias etc.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`target_id` Required	`string`	`9786d32e3d244a688ec6a60d2fe1b10b`	Target ID, obtain this through the target autocomplete interface

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`alias`	`array`	`[ { "lang": "EN", "name": "CD279" } ]`	Target Alias
`lang`	`string`	`EN`	Language
`name`	`string`	`Ranibizumab (Genentech)`	Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
`profile`	`array`	`[ { "lang": "EN", "name": "Inhibitory receptor on antigen activated T-cells " } ]`	Profile
`target_id`	`string`	`3cbd7b503dd84de6b6d150c6143989fb`	Target ID
`short_name`	`array`	`[ { "lang": "EN", "name": "PD-1" } ]`	Target Short Name
`uniprot_id`	`array`	`[ "Q15116" ]`	UniProt ID
`target_name`	`array`	`[ { "lang": "EN", "name": "Programmed cell death protein 1" } ]`	Target Name
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": {
    "alias": [
      {
        "lang": "EN",
        "name": "Ranibizumab (Genentech)"
      }
    ],
    "profile": [
      {
        "lang": "EN",
        "name": "Ranibizumab (Genentech)"
      }
    ],
    "target_id": "3cbd7b503dd84de6b6d150c6143989fb",
    "short_name": [
      {
        "lang": "EN",
        "name": "Ranibizumab (Genentech)"
      }
    ],
    "uniprot_id": [
      "Q15116"
    ],
    "target_name": [
      {
        "lang": "EN",
        "name": "Ranibizumab (Genentech)"
      }
    ]
  },
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	Quota exceeds the limit!
`67200003`	Access token expired or authentication error!
`67200004`	No permission or API package quota has exceeded the limit!
`67200005`	Insufficient balance, call failed!
`67200006`	This client has expired and call failed!
`67200007`	Exceeded the call limit, call failed!

HTTP Status Codes

Status Code	Description
`0`	Success
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms