What is the endpoint for [B003/4-0]Backend Search Job Status?

The [B003/4-0]Backend Search Job Status endpoint is GET https://connect.patsnap.com/bio-openapi/sequence/job/status.

What data can [B003/4-0]Backend Search Job Status return?

[B003/4-0]Backend Search Job Status Check Backend Search Job Status. 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-0]Backend Search Job Status?

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

[B003/4-0]Backend Search Job Status

get

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

Try in Sandbox

Check Backend Search Job Status.

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

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`status`	`string`	`SUCCESS`	Backend job status, including following valid status. QUEUEING,RUNNING,SUCCESS,TIMEOUT,ERROR
`message`	`string`	`Invalid input xxx`	Detailed message of ERROR status
`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": {
    "status": "SUCCESS",
    "message": "Invalid input xxx"
  },
  "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
`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