What is the endpoint for [P055]Get Export Results?

The [P055]Get Export Results endpoint is GET https://connect.patsnap.com/patent-search/task.

Where can I find the OpenAPI schema for [P055]Get Export Results?

The OpenAPI schema is available at /openapi.json#/paths/~1patent-search~1task/get. You can also browse the full specification at /openapi.json.

[P055]Get Export Results

Q: What data can [P055]Get Export Results return?

[P055]Get Export Results Retrieves patent export results based on the specified Task ID. Returns a list of URLs to download files containing search results in the specified file format. Supports up to 100,000 most relevant patents exported. See the Response Schema and Success Response Example on this page for the full structure.

get

https://connect.patsnap.com/patent-search/task

Try in Sandbox

Retrieves patent export results based on the specified Task ID. Returns a list of URLs to download files containing search results in the specified file format. Supports up to 100,000 most relevant patents exported.

1. The download link is valid for 7 days and will be cleared after expiration.

2. You can only query one download status at a time.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`task_id` Required	`string`	`264de8bf7e294505a9a000597e25d615`	Task ID

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`url`	`string`	`http://exportapi.cdn.zhihuiya.com/20180607/1a9649e44d5dac74d5ff95d0455e31b7/20180607020732886.JSON?response-content-disposition=attachment%3B%20filename%3D%2220180607020732886.JSON%22%3B&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180607T020740Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAOMXTQGW2GCEVBM4A%2F20180607%2Fcn-north-1%2Fs3%2Faws4_request&X-Amz-Signature=6983e29dbc4a273742fc6714dc15916957257c1425678e90b7f5f3cd2e8d249e`	Download address
`count`	`integer<int32>`	`24`	Export number of patents
`export_status`	`string`	`SUCCESS`	Export task current status SUCCESS:Exporting task succeeded FAIL:The export task failed. Create the export task again PENDING:The export task is in progress. Please try to obtain the download address later
`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": {
    "url": "http://exportapi.cdn.zhihuiya.com/20180607/1a9649e44d5dac74d5ff95d0455e31b7/20180607020732886.JSON?response-content-disposition=attachment%3B%20filename%3D%2220180607020732886.JSON%22%3B&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180607T020740Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAOMXTQGW2GCEVBM4A%2F20180607%2Fcn-north-1%2Fs3%2Faws4_request&X-Amz-Signature=6983e29dbc4a273742fc6714dc15916957257c1425678e90b7f5f3cd2e8d249e",
    "count": 24,
    "export_status": "SUCCESS"
  },
  "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

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms