What is the endpoint for [R001]Generate Enterprise Report Task?

The [R001]Generate Enterprise Report Task endpoint is POST https://connect.patsnap.com/innovation/company-report/task/create.

Where can I find the OpenAPI schema for [R001]Generate Enterprise Report Task?

The OpenAPI schema is available at /openapi.json#/paths/~1innovation~1company-report~1task~1create/post. You can also browse the full specification at /openapi.json.

[R001]Generate Enterprise Report Task

Q: What data can [R001]Generate Enterprise Report Task return?

[R001]Generate Enterprise Report Task This interface provides the task of creating and downloading enterprise innovation capability reports. See the Response Schema and Success Response Example on this page for the full structure.

post

https://connect.patsnap.com/innovation/company-report/task/create

Try in Sandbox

This interface provides the task of creating and downloading enterprise innovation capability reports

1、Enterprise reports only support downloading the word/pdf version 2、Enterprise reports are consistent with product content 3、All enterprise reports are downloaded in real time, and the download time is 1~10 minutes

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`company_name`	`string`	`小米科技有限责任公司`	Query the name of a single enterprise
`credit_code`	`string`	`91110108551385082Q`	Query the unified social credit code of a single enterprise
`org_number`	`string`	`5513850T82`	Query the organization code of a single enterprise
`report_type` Required	`string`	`word`	Query the type of report returned by the enterprise, either word or pdf

Request Example

Example request body for this API endpoint

JSON

{
  "org_number": "5513850T82",
  "credit_code": "91110108551385082Q",
  "report_type": "word",
  "company_name": "小米科技有限责任公司"
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`job_id`	`string`	`1579434053399036000`	export job id
`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": {
    "job_id": 1579434053399036000
  },
  "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

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms