[P018]Claim

get
https://connect.patsnap.com/basic-patent-data/claim-data
Try in Sandbox

Receive patent claim data by patent_id or patent_number. Patent claim data includes claim text and number of independent claims.

The API supports batch requests with a maximum of 100 patents, and more patent id or patent number are separated with English comma. Batch requests are deducted from traffic/costs, and will be deducted multiple times based on the number of successful results returned.

Request Parameters

List of parameters supported by this API endpoint

NameTypeExampleDescription
patent_id
string1a47a70d-6b54-4709-a72a-ed552781fcac,7353c607-0594-4592-b99e-aea9f517de17
patent_id
patent_number
stringJP1999068462A
patent_number
replace_by_related
string0
When the claims of current patent is unavailable, whether to replace it with the claims of its family patent?default not to replace: 1. Yes 0: No

Response Schema

Structure of the API response data

Field NameTypeExampleDescription
data
array-
response data
pn
stringUS11205304B2
patent number
claims
arrayPlease check the form: Claims
claim data
lang
stringEN
language
claim_text
string1. A method for selectively constructing a search result for data requested by a search request, said method comprising: generating, by a processor of a computer system, a first tree as a result of executing a subtree procedure specified in a query over a template tree by use of path information of a data node corresponding to data requested by a search request and existing within a database system, wherein the search request comprises the query and path information of the data node, wherein the query traverses the template tree representing a hierarchically organized data structure of the database system according to the path information, wherein the path information indicates a hierarchical address of the data node within the template tree, wherein the subtree procedure dynamically expands the template tree comprising at least one node into a respective group of one or more child nodes pursuant to the path information of the search request, wherein said at least one node is associated with a respective subtree generator callback function for the subtree procedure to perform resulting in dynamically expanded said respective group of one or more child nodes, such that said child nodes of the first tree instantiate respective values located by the path information from at least one data source interconnected to the database system such that the first tree comprises only a portion of the hierarchically organized data structure of the database system specified in the path information of the received search request without expanding entire child nodes for the first tree; selecting, by the processor, the data node that satisfies the path information from the generated first tree; and transferring, by the processor, a value associated with the selected data node to a user program that sent the search request as a search result such that the user program receives the data corresponding to the path information in response to the search request, wherein the user program runs on a computing system coupled to the computer system through a communication medium.\n2. The method of claim 1, said executing the subtree procedure comprising: traversing a node of said at least one node in the template tree in a descending order from a top level in the hierarchical address specified in the path information, wherein each node in the template tree comprises a respective subtree generator callback function and a respective data set such that the respective subtree generator callback function generates a respective subtree of said each node upon being invoked and such that the respective data set of said each node instantiates all nodes in the respective subtree generated by the respective subtree generator callback function, and wherein the hierarchical address of the path information is ordered such that a higher level in the hierarchical address appears prior to a lower level in the hierarchical address corresponding to the hierarchical address in the template tree; expanding the node in the template tree visited in said traversing; and iterating said traversing and said expanding for each node in the template tree until a bottom level in the hierarchical address of the path information is reached.\n3. The method of claim 2, said expanding comprising: determining that a child node of the node visited in said traversing does not exist indicating that the node needs to be expanded into a subtree; creating the subtree of the node visited in said traversing by invoking a subtree generator callback function associated with the node visited in said traversing; injecting, to the template tree, the created subtree as the child node of the node visited in said traversing; disassociating the subtree generator callback function from the node visited in said traversing such that the node visited in said traversing does not redundantly create another subtree subsequent to said injecting; and storing the template tree comprising the created subtree as the first tree.\n4. The method of claim 2, said expanding comprising: determining that a child node of the node visited in said traversing is a terminal node that is not expandable; and storing the template tree comprising the child node comprising a value corresponding to the child node selected from a first data set associated with the node visited from said traversing as the first tree.\n5. The method of claim 2, wherein the respective data set of the node in the template tree is dynamically collected from a data source of said at least one data source prior to said expanding.\n6. The method of claim 1, wherein the hierarchically organized data structure of the database system and the search result are expressed in the Extensible Markup Language (XML), and wherein the path information is expressed in the XML Path Language (XPath).\n7. A computer program product, comprising a computer readable hardware storage device having computer readable program code stored therein, said program code containing instructions executable by a processor of a computer system to implement a method for selectively constructing a search result for data requested by a search request, said method comprising: generating, by the processor, a first tree as a result of executing a subtree procedure specified in a query over a template tree by use of path information of a data node corresponding to data requested by a search request and existing within a database system, wherein the search request comprises the query and path information of the data node, wherein the query traverses the template tree representing a hierarchically organized data structure of the database system according to the path information, wherein the path information indicates a hierarchical address of the data node within the template tree, wherein the subtree procedure dynamically expands the template tree comprising at least one node into a respective group of one or more child nodes pursuant to the path information of the search request, wherein said at least one node is associated with a respective subtree generator callback function for the subtree procedure to perform resulting in dynamically expanded said respective group of one or more child nodes, such that said child nodes of the first tree instantiate respective values located by the path information from at least one data source interconnected to the database system such that the first tree comprises only a portion of the hierarchically organized data structure of the database system specified in the path information of the received search request without expanding entire child nodes for the first tree; selecting, by the processor, the data node that satisfies the path information from the generated first tree; and transferring, by the processor, a value associated with the selected data node to a user program that sent the search request as a search result such that the user program receives the data corresponding to the path information in response to the search request, wherein the user program runs on a computing system coupled to the computer system through a communication medium.\n8. The computer program product of claim 7, said executing the subtree procedure comprising: traversing a node of said at least one node in the template tree in a descending order from a top level in the hierarchical address specified in the path information, wherein each node in the template tree comprises a respective subtree generator callback function and a respective data set such that the respective subtree generator callback function generates a respective subtree of said each node upon being invoked and such that the respective data set of said each node instantiates all nodes in the respective subtree generated by the respective subtree generator callback function, and wherein the hierarchical address of the path information is ordered such that a higher level in the hierarchical address appears prior to a lower level in the hierarchical address corresponding to the hierarchical address in the template tree; expanding the node in the template tree visited in said traversing; and iterating said traversing and said expanding for each node in the template tree until a bottom level in the hierarchical address of the path information is reached.\n9. The computer program product of claim 8, said expanding comprising: determining that a child node of the node visited in said traversing does not exist indicating that the node needs to be expanded into a subtree; creating the subtree of the node visited in said traversing by invoking a subtree generator callback function associated with the node visited in said traversing; injecting, to the template tree, the created subtree as the child node of the node visited in said traversing; disassociating the subtree generator callback function from the node visited in said traversing such that the node visited in said traversing does not redundantly create another subtree subsequent to said injecting; and storing the template tree comprising the created subtree as the first tree.\n10. The computer program product of claim 8, said expanding comprising: determining that a child node of the node visited in said traversing is a terminal node that is not expandable; and storing the template tree comprising the child node comprising a value corresponding to the child node selected from a first data set associated with the node visited from said traversing as the first tree.\n11. The computer program product of claim 8, wherein the respective data set of the node in the template tree is dynamically collected from a data source of said at least one data source prior to said expanding.\n12. The computer program product of claim 7, wherein the hierarchically organized data structure of the database system and the search result are expressed in the Extensible Markup Language (XML), and wherein the path information is expressed in the XML Path Language (XPath).\n13. A computer system, comprising a processor, a memory coupled to the processor, and a computer readable storage device coupled to the processor, said storage device containing program code executable by the processor via the memory to implement a method for selectively constructing a search result for data requested by a search request, said method comprising: generating, by the processor, a first tree as a result of executing a subtree procedure specified in a query over a template tree by use of path information of a data node corresponding to data requested by a search request and existing within a database system, wherein the search request comprises the query and path information of the data node, wherein the query traverses the template tree representing a hierarchically organized data structure of the database system according to the path information, wherein the path information indicates a hierarchical address of the data node within the template tree, wherein the subtree procedure dynamically expands the template tree comprising at least one node into a respective group of one or more child nodes pursuant to the path information of the search request, wherein said at least one node is associated with a respective subtree generator callback function for the subtree procedure to perform resulting in dynamically expanded said respective group of one or more child nodes, such that said child nodes of the first tree instantiate respective values located by the path information from at least one data source interconnected to the database system such that the first tree comprises only a portion of the hierarchically organized data structure of the database system specified in the path information of the received search request without expanding entire child nodes for the first tree; selecting, by the processor, the data node that satisfies the path information from the generated first tree; and transferring, by the processor, a value associated with the selected data node to a user program that sent the search request as a search result such that the user program receives the data corresponding to the path information in response to the search request, wherein the user program runs on a computing system coupled to the computer system through a communication medium.\n14. The computer system of claim 13, said executing the subtree procedure comprising: traversing a node of said at least one node in the template tree in a descending order from a top level in the hierarchical address specified in the path information, wherein each node in the template tree comprises a respective subtree generator callback function and a respective data set such that the respective subtree generator callback function generates a respective subtree of said each node upon being invoked and such that the respective data set of said each node instantiates ail nodes in the respective subtree generated by the respective subtree generator callback function, and wherein the hierarchical address of the path information is ordered such that a higher level in the hierarchical address appears prior to a lower level in the hierarchical address corresponding to the hierarchical address in the template tree; expanding the node in the template tree visited in said traversing; and iterating said traversing and said expanding for each node in the template tree until a bottom level in the hierarchical address of the path information is reached.\n15. The computer system of claim 14, said expanding comprising: determining that a child node of the node visited in said traversing does not exist indicating that the node needs to be expanded into a subtree; creating the subtree of the node visited in said traversing by invoking a subtree generator callback function associated with the node visited in said traversing; injecting, to the template tree, the created subtree as the child node of the node visited in said traversing; disassociating the subtree generator callback function from the node visited in said traversing such that the node visited in said traversing does not redundantly create another subtree subsequent to said injecting; and storing the template tree comprising the created subtree as the first tree.\n16. The computer system of claim 14, said expanding comprising: determining that a child node of the node visited in said traversing is a terminal node that is not expandable; and storing the template tree comprising the child node comprising a value corresponding to the child node selected from a first data set associated with the node visited from said traversing as the first tree.\n17. The computer system of claim 14, wherein the respective data set of the node in the template tree is dynamically collected from a data source of said at least one data source prior to said expanding.\n18. The computer system of claim 13, wherein the hierarchically organized data structure of the database system and the search result are expressed in the Extensible Markup Language (XML), and wherein the path information is expressed in the XML Path Language (XPath).
text
data_format
stringoriginal
Original data: if there are several languages with original data, all will be returned
claim_independent_count
integer<int32>3
independent claim count
patent_id
string718ead9c-4f3c-4674-8f5a-24e126827269
patent id
status
Required
booleanfalse
Status
error_msg
stringThe request parameter format is incorrect!
Error Message
error_code
Required
integer0
Error Code

Success Response Example

Example of a successful API response

JSON
{
  "data": [
    {
      "pn": "US11205304B2",
      "claims": [
        {
          "lang": "EN",
          "claim_text": "1. A method for selectively constructing a search result for data requested by a search request, said method comprising: generating, by a processor of a computer system, a first tree as a result of executing a subtree procedure specified in a query over a template tree by use of path information of a data node corresponding to data requested by a search request and existing within a database system, wherein the search request comprises the query and path information of the data node, wherein the query traverses the template tree representing a hierarchically organized data structure of the database system according to the path information, wherein the path information indicates a hierarchical address of the data node within the template tree, wherein the subtree procedure dynamically expands the template tree comprising at least one node into a respective group of one or more child nodes pursuant to the path information of the search request, wherein said at least one node is associated with a respective subtree generator callback function for the subtree procedure to perform resulting in dynamically expanded said respective group of one or more child nodes, such that said child nodes of the first tree instantiate respective values located by the path information from at least one data source interconnected to the database system such that the first tree comprises only a portion of the hierarchically organized data structure of the database system specified in the path information of the received search request without expanding entire child nodes for the first tree; selecting, by the processor, the data node that satisfies the path information from the generated first tree; and transferring, by the processor, a value associated with the selected data node to a user program that sent the search request as a search result such that the user program receives the data corresponding to the path information in response to the search request, wherein the user program runs on a computing system coupled to the computer system through a communication medium.\\n2. The method of claim 1, said executing the subtree procedure comprising: traversing a node of said at least one node in the template tree in a descending order from a top level in the hierarchical address specified in the path information, wherein each node in the template tree comprises a respective subtree generator callback function and a respective data set such that the respective subtree generator callback function generates a respective subtree of said each node upon being invoked and such that the respective data set of said each node instantiates all nodes in the respective subtree generated by the respective subtree generator callback function, and wherein the hierarchical address of the path information is ordered such that a higher level in the hierarchical address appears prior to a lower level in the hierarchical address corresponding to the hierarchical address in the template tree; expanding the node in the template tree visited in said traversing; and iterating said traversing and said expanding for each node in the template tree until a bottom level in the hierarchical address of the path information is reached.\\n3. The method of claim 2, said expanding comprising: determining that a child node of the node visited in said traversing does not exist indicating that the node needs to be expanded into a subtree; creating the subtree of the node visited in said traversing by invoking a subtree generator callback function associated with the node visited in said traversing; injecting, to the template tree, the created subtree as the child node of the node visited in said traversing; disassociating the subtree generator callback function from the node visited in said traversing such that the node visited in said traversing does not redundantly create another subtree subsequent to said injecting; and storing the template tree comprising the created subtree as the first tree.\\n4. The method of claim 2, said expanding comprising: determining that a child node of the node visited in said traversing is a terminal node that is not expandable; and storing the template tree comprising the child node comprising a value corresponding to the child node selected from a first data set associated with the node visited from said traversing as the first tree.\\n5. The method of claim 2, wherein the respective data set of the node in the template tree is dynamically collected from a data source of said at least one data source prior to said expanding.\\n6. The method of claim 1, wherein the hierarchically organized data structure of the database system and the search result are expressed in the Extensible Markup Language (XML), and wherein the path information is expressed in the XML Path Language (XPath).\\n7. A computer program product, comprising a computer readable hardware storage device having computer readable program code stored therein, said program code containing instructions executable by a processor of a computer system to implement a method for selectively constructing a search result for data requested by a search request, said method comprising: generating, by the processor, a first tree as a result of executing a subtree procedure specified in a query over a template tree by use of path information of a data node corresponding to data requested by a search request and existing within a database system, wherein the search request comprises the query and path information of the data node, wherein the query traverses the template tree representing a hierarchically organized data structure of the database system according to the path information, wherein the path information indicates a hierarchical address of the data node within the template tree, wherein the subtree procedure dynamically expands the template tree comprising at least one node into a respective group of one or more child nodes pursuant to the path information of the search request, wherein said at least one node is associated with a respective subtree generator callback function for the subtree procedure to perform resulting in dynamically expanded said respective group of one or more child nodes, such that said child nodes of the first tree instantiate respective values located by the path information from at least one data source interconnected to the database system such that the first tree comprises only a portion of the hierarchically organized data structure of the database system specified in the path information of the received search request without expanding entire child nodes for the first tree; selecting, by the processor, the data node that satisfies the path information from the generated first tree; and transferring, by the processor, a value associated with the selected data node to a user program that sent the search request as a search result such that the user program receives the data corresponding to the path information in response to the search request, wherein the user program runs on a computing system coupled to the computer system through a communication medium.\\n8. The computer program product of claim 7, said executing the subtree procedure comprising: traversing a node of said at least one node in the template tree in a descending order from a top level in the hierarchical address specified in the path information, wherein each node in the template tree comprises a respective subtree generator callback function and a respective data set such that the respective subtree generator callback function generates a respective subtree of said each node upon being invoked and such that the respective data set of said each node instantiates all nodes in the respective subtree generated by the respective subtree generator callback function, and wherein the hierarchical address of the path information is ordered such that a higher level in the hierarchical address appears prior to a lower level in the hierarchical address corresponding to the hierarchical address in the template tree; expanding the node in the template tree visited in said traversing; and iterating said traversing and said expanding for each node in the template tree until a bottom level in the hierarchical address of the path information is reached.\\n9. The computer program product of claim 8, said expanding comprising: determining that a child node of the node visited in said traversing does not exist indicating that the node needs to be expanded into a subtree; creating the subtree of the node visited in said traversing by invoking a subtree generator callback function associated with the node visited in said traversing; injecting, to the template tree, the created subtree as the child node of the node visited in said traversing; disassociating the subtree generator callback function from the node visited in said traversing such that the node visited in said traversing does not redundantly create another subtree subsequent to said injecting; and storing the template tree comprising the created subtree as the first tree.\\n10. The computer program product of claim 8, said expanding comprising: determining that a child node of the node visited in said traversing is a terminal node that is not expandable; and storing the template tree comprising the child node comprising a value corresponding to the child node selected from a first data set associated with the node visited from said traversing as the first tree.\\n11. The computer program product of claim 8, wherein the respective data set of the node in the template tree is dynamically collected from a data source of said at least one data source prior to said expanding.\\n12. The computer program product of claim 7, wherein the hierarchically organized data structure of the database system and the search result are expressed in the Extensible Markup Language (XML), and wherein the path information is expressed in the XML Path Language (XPath).\\n13. A computer system, comprising a processor, a memory coupled to the processor, and a computer readable storage device coupled to the processor, said storage device containing program code executable by the processor via the memory to implement a method for selectively constructing a search result for data requested by a search request, said method comprising: generating, by the processor, a first tree as a result of executing a subtree procedure specified in a query over a template tree by use of path information of a data node corresponding to data requested by a search request and existing within a database system, wherein the search request comprises the query and path information of the data node, wherein the query traverses the template tree representing a hierarchically organized data structure of the database system according to the path information, wherein the path information indicates a hierarchical address of the data node within the template tree, wherein the subtree procedure dynamically expands the template tree comprising at least one node into a respective group of one or more child nodes pursuant to the path information of the search request, wherein said at least one node is associated with a respective subtree generator callback function for the subtree procedure to perform resulting in dynamically expanded said respective group of one or more child nodes, such that said child nodes of the first tree instantiate respective values located by the path information from at least one data source interconnected to the database system such that the first tree comprises only a portion of the hierarchically organized data structure of the database system specified in the path information of the received search request without expanding entire child nodes for the first tree; selecting, by the processor, the data node that satisfies the path information from the generated first tree; and transferring, by the processor, a value associated with the selected data node to a user program that sent the search request as a search result such that the user program receives the data corresponding to the path information in response to the search request, wherein the user program runs on a computing system coupled to the computer system through a communication medium.\\n14. The computer system of claim 13, said executing the subtree procedure comprising: traversing a node of said at least one node in the template tree in a descending order from a top level in the hierarchical address specified in the path information, wherein each node in the template tree comprises a respective subtree generator callback function and a respective data set such that the respective subtree generator callback function generates a respective subtree of said each node upon being invoked and such that the respective data set of said each node instantiates ail nodes in the respective subtree generated by the respective subtree generator callback function, and wherein the hierarchical address of the path information is ordered such that a higher level in the hierarchical address appears prior to a lower level in the hierarchical address corresponding to the hierarchical address in the template tree; expanding the node in the template tree visited in said traversing; and iterating said traversing and said expanding for each node in the template tree until a bottom level in the hierarchical address of the path information is reached.\\n15. The computer system of claim 14, said expanding comprising: determining that a child node of the node visited in said traversing does not exist indicating that the node needs to be expanded into a subtree; creating the subtree of the node visited in said traversing by invoking a subtree generator callback function associated with the node visited in said traversing; injecting, to the template tree, the created subtree as the child node of the node visited in said traversing; disassociating the subtree generator callback function from the node visited in said traversing such that the node visited in said traversing does not redundantly create another subtree subsequent to said injecting; and storing the template tree comprising the created subtree as the first tree.\\n16. The computer system of claim 14, said expanding comprising: determining that a child node of the node visited in said traversing is a terminal node that is not expandable; and storing the template tree comprising the child node comprising a value corresponding to the child node selected from a first data set associated with the node visited from said traversing as the first tree.\\n17. The computer system of claim 14, wherein the respective data set of the node in the template tree is dynamically collected from a data source of said at least one data source prior to said expanding.\\n18. The computer system of claim 13, wherein the hierarchically organized data structure of the database system and the search result are expressed in the Extensible Markup Language (XML), and wherein the path information is expressed in the XML Path Language (XPath).",
          "data_format": "original",
          "claim_independent_count": 3
        }
      ],
      "patent_id": "718ead9c-4f3c-4674-8f5a-24e126827269"
    }
  ],
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

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

Platform Errors

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

HTTP Status Codes

Status CodeDescription
0Success
401Unauthorized
403Forbidden
404Not Found