What is the endpoint for [B003/4-1]Get Sequence Search Results?

The [B003/4-1]Get Sequence Search Results endpoint is POST https://connect.patsnap.com/bio-openapi/sequence/job/result.

What data can [B003/4-1]Get Sequence Search Results return?

[B003/4-1]Get Sequence Search Results Get Sequence Search Results By Job ID. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [B003/4-1]Get Sequence Search Results?

The OpenAPI schema is available at /openapi.json#/paths/~1bio-openapi~1sequence~1job~1result/post. You can also browse the full specification at /openapi.json.

[B003/4-1]Get Sequence Search Results

post

https://connect.patsnap.com/bio-openapi/sequence/job/result

Try in Sandbox

Get Sequence Search Results By Job ID.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`job_id` Required	`string`	`953a406a18d84dc8b13f0b923e406a43`	ID of the search job in backend, use this ID for subsequent API calls
`page` Required	`integer<int32>`	`1`	Current page number, start from 1
`size` Required	`integer<int32>`	`10`	Current page result size, support maximum 100
`sort_field`	`object`	`Please check the form: OpenApiSortField`	Sorting of results
`field` Required	`string`	`perc_identity`	Sorting Field. perc_identity、q_perc_identity、s_perc_identity、q_coverage、s_coverage、evalue
`order` Required	`string`	`desc`	Sorting order. desc、asc

Request Example

Example request body for this API endpoint

JSON

{
  "page": 1,
  "size": 10,
  "job_id": "953a406a18d84dc8b13f0b923e406a43",
  "sort_field": {
    "field": "perc_identity",
    "order": "desc"
  }
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`total`	`integer<int32>`	`1000`	Query Results Count
`results`	`array`	`Please check the form: OpenApiHit`	Query Results
`gaps`	`integer<int32>`	-	Total number of gap
`hsps`	`array`	`Please check the form: OpenApiHsps`	Hit information
`q_end`	`integer<int32>`	`123`	Query sequence hit end index
`s_end`	`integer<int32>`	`123`	Subject sequence hit end index
`matched`	`string`	`MQ DL A +AH LH F SPL HCMTN+VVQ+FTANTLLALGASPAMVIE EEASQFAAIASALL+NVGTLTQ RA AMRAAVE+A ++TPWTLDPVAVGAL++RR FC +LLS +PAA`	Details of sequence match hit
`q_start`	`integer<int32>`	`1`	Query sequence hit start index
`s_start`	`integer<int32>`	`1`	Subject sequence hit start index
`q_string`	`string`	`MQVDLLGSAQSAHALH`	Query sequence hit region
`s_string`	`string`	`MQVDLLGSAQSAHALH`	Subject sequence hit region
`s_len`	`integer<int32>`	`123`	Subject sequence length
`score`	`number<double>`	`68.45`	Raw Score
`evalue`	`string`	`1.12271e-54`	The higher you set this e-value threshold, the more results you are likely to see.E-Value indicates how likely it is that a sequence is similar to yours simply by chance. For instance, if your sequence is very short, there is a higher likelihood that it appears in several locations simply by chance. The greater the e-value, the more likely it is that this is just down to luck.
`seq_id`	`string`	`834879`	Sequence ID
`patents`	`object`	`Please check the form: Patent`	Patent List. Only return top 100, can retrieve the full set by “Single Sequence All Patent List” API
`total`	`integer<int32>`	`1000`	Total patent count of the sequence
`patents`	`array`	`Please check the form: OpenApiPatentDetail`	Patent List
`pn`	`string`	`JP1999068462A`	Patent publication number
`claimed`	`boolean`	`true`	Whether the subject sequence is in patent claims
`location`	`object`	`{ "APP": [ "5" ], "FIG": [ "1A" ], "PAGE": [ "55/56" ], "ANNEX": [ "2" ], "TABLE": [ "A-1" ], "EXAMPLE": [ "8" ] }`	Sequence location in patent
`patent_id`	`string`	`94ea8785-959f-47cf-aba2-091605d30c12`	Patent ID
`sequence_id_number`	`array`	`[ "1" ]`	Sequence ID number in patent
`identity`	`string`	`93/123`	Blast Identity value
`positive`	`string`	`104/123`	Positive value
`bit_score`	`number<double>`	`68.45`	Bit Score
`q_coverage`	`number<double>`	`68.45`	Coverage percentage of query sequence
`s_coverage`	`number<double>`	`68.45`	Coverage percentage of subject sequence
`s_sequence`	`string`	`MQPDLHSRALAAHTLHQFRTLSPLTHCMTNEVVQSFTANTLLALGASPAMVIEPEEASQFAAIASALLVNVGTLTQERATAMRAAVERAYHAKTPWTLDPVAVGALEFRRRFCLDLLSLQPAA`	Subject sequence
`perc_identity`	`number<double>`	`87.34`	Identity percentage value
`q_perc_identity`	`number<double>`	`87.34`	Identity percentage value of query sequence
`s_perc_identity`	`number<double>`	`87.34`	Identity percentage value of subject sequence
`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": {
    "total": 1000,
    "results": [
      {
        "gaps": 0,
        "hsps": [
          {
            "q_end": 123,
            "s_end": 123,
            "matched": "MQ DL   A +AH LH F   SPL HCMTN+VVQ+FTANTLLALGASPAMVIE EEASQFAAIASALL+NVGTLTQ RA AMRAAVE+A  ++TPWTLDPVAVGAL++RR FC +LLS +PAA",
            "q_start": 1,
            "s_start": 1,
            "q_string": "MQVDLLGSAQSAHALH",
            "s_string": "MQVDLLGSAQSAHALH"
          }
        ],
        "s_len": 123,
        "score": 68.45,
        "evalue": 1.12271e-54,
        "seq_id": 834879,
        "patents": {
          "total": 1000,
          "patents": [
            {
              "pn": "JP1999068462A",
              "claimed": true,
              "location": {
                "APP": [
                  "5"
                ],
                "FIG": [
                  "1A"
                ],
                "PAGE": [
                  "55/56"
                ],
                "ANNEX": [
                  "2"
                ],
                "TABLE": [
                  "A-1"
                ],
                "EXAMPLE": [
                  "8"
                ]
              },
              "patent_id": "94ea8785-959f-47cf-aba2-091605d30c12",
              "sequence_id_number": [
                "1"
              ]
            }
          ]
        },
        "identity": "93/123",
        "positive": "104/123",
        "bit_score": 68.45,
        "q_coverage": 68.45,
        "s_coverage": 68.45,
        "s_sequence": "MQPDLHSRALAAHTLHQFRTLSPLTHCMTNEVVQSFTANTLLALGASPAMVIEPEEASQFAAIASALLVNVGTLTQERATAMRAAVERAYHAKTPWTLDPVAVGALEFRRRFCLDLLSLQPAA",
        "perc_identity": 87.34,
        "q_perc_identity": 87.34,
        "s_perc_identity": 87.34
      }
    ]
  },
  "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
`67200000`	API call exceeds the total limit set by the platform!
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	The current call rate is too fast, exceeding the current configuration limit QPS!
`67200003`	The key and secret parameters for applying for the token are incorrect or the client has been disabled!
`67200004`	The requested api does not have permission. Please contact our support personnel!
`67200005`	Insufficient account balance/number of calls!
`67200006`	The client has exceeded the activation validity period!
`67200007`	The current call exceeds the configured usage limit of the day!
`67200008`	Please check if the required apikey in the query parameter has been transmitted!
`67200009`	The apikey does not match the passed bearerToken. Please check if a valid token is being used!
`67200012`	The request is illegal!
`67200100`	The current server status is busy, request response timeout!
`67200101`	The API requested currently does not exist. Please check the request path!

HTTP Status Codes

Status Code	Description
`0`	Success
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found
`53000002`	Unable to find job id.

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms