Start a conversation

Requests execution through the DocumentLauncher

General information

This mechanism is designed to ensure the consistency of calculations in the CPE and to eliminate the unpredictability of the result of the CPE.

When executing a request through the Document Launcher, an entry is first created in the kernel_document table. All information about the progress of the request is recorded in this table. The final result is written to the result field as a JSON-encoded string. Document information can be obtained via request document/get.

Also, if the onSuccessURL and onFailURL parameters are passed to the original request, the corresponding callbacks will be called based on the result of the request execution.

Additional request parameters

Parameter Type Mandatory field Note
onSuccessURL String No If the request is successfully executed via DocumentLauncher and if this parameter is present, an HTTP request is made to
<onSuccessURL>?documentId=<id>
onFailURL String No In case of an error in executing the request via DocumentLauncher and with this parameter present, an HTTP request is made to
<onFailURL>?documentId=<id>

Request execution

When calling a request executed through a queue is successful, the following result will be obtained:

Successful response

{  
 "errorCode": 0,  
 "errorMessage"null,
 "primary": {    
  "success"true,    
  "message""Request queued successfully",    
  "payload": {      
      "documentId": 1083    
  },    
  "errors": [],    
  "debug": []  
 },  
 "secondary": [],  
 "locale""en-US"
}
Choose files or drag and drop files
Was this article helpful?
Yes
No
  1. Daria Tsirelnikova

  2. Posted
  3. Updated

Comments