search

Query Output Results

This page offers an overview of the output file generated by a query method. A typical output from the query method includes "data" and "result" sections if no errors occur during execution. The "data" and "result" sections contain the following information:

{
    "data": {
        "metaData": {
            "executionTime": {
                "unit": "ms",
                "value": 344.0
            }
        },
        "result": {  
            // Either one of the type will be shown below
            // Type 1: species query
            "species": [
                { 
                    // species information
                } 
            ]
            // Type 2: Databank query 
            "publicDataBankInfo": [ 
                {
                } 
            ], 
            "privateDataBankInfo": [
                {
                }
            ]          
            // Type 3: redox query 
            "redox": { 
                // redox selection 
            }
            // Type 4: kinetics query
            "species": [
                // species name 
                // species phases
            ],
            "equilibriumReactions": [
                // equilibruim reactions
             ]         
        }
     }, 
    "message": "Chemistry generated successfully",
    "status": "SUCCESS"       
}

hashtag
The "metaData" field

This section contains metadata, which provides runtime system information. Currently, the version number of the running software is included in the "metaData".

hashtag
The "result" field

This section presents all the contents produced by query methods.

This method will return both the public and private databank information to users.

result
always shown
type

publicDataBankInfo

✔️

Array of JSON Object

privateDataBankInfo

✔️

Array of JSON Object

circle-info

The keyword "code" in "privateDataBankInfo" can be used as an input in "privateDatabank", which is an array of strings.

Both public and private databanks contain information in an identical format.

PreviousKinetics QueryNextSupporting Information for ChemBuilder

Last updated

Was this helpful?