RunSqlProc

Purpose	Execute the specified procedure on the database and return the execution result. For certain restaurants, the request is forwarded to r_k Cloud. No agent is required to be connected.
Limitations	Only for the RkReports aggregator
Supported agent version	v2
PluggetSystemType	Sql

Request format

JSON

{
  "taskType": "RunSqlProc",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "procName": "string",
    "params": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }
}

Parameter	Type	Mandatory	Description
taskType	string	yes	Task type. For this method, the value is RunSqlProc
-async			Asynchronous method call: either synchronous or asynchronous
-sync			Synchronous method call: either synchronous or asynchronous
--timeout	int	no	Agent response time in seconds. Default is 120 seconds
--objectId	int	yes	Restaurant code in the licensing system
-procName	string	yes	Full name of the stored procedure
-params		no	Parameters for the called procedure/function
--name	string	yes	Parameter name
--value	string	yes	Parameter value

Synchronous response format

JSON

{
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"RunSqlProc",
      "objectId": 0
   },
   "error":{
      "wsError":{
         "code":"string",
         "desc":"string"
      }
   }
}

Parameter	Type	Description
-taskGuid	guid	Unique code for this task. Used when receiving a task via the queue
-taskType	string enum	Task type
-objectId	int	Restaurant code in the licensing system
error		Error container, for more details see the article Error Description

Asynchronous response format

Successful response

JSON

{
  "taskResponse": {
     "queryResult": {
        "rows": [
            // Array of records
        ]
     }
  },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "RunSqlProc",
    "objectId": 0
  }
}

Response with error

JSON

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "RunSqlProc",
    "objectId": 0
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": 0,
      "desc": "string"
    }
  }
}

Example answer
JSON

{
    "taskResponse": {
        "queryResult": {
            "rows": [
                {
                    "col_1": true,
                    "col_2": 2,
                    "col_3": "str"
                },
                {
                    "col_1": false,
                    "col_2": 3,
                }
            ]
        }
    },
    "responseCommon": {
        "taskGuid": "464ca191-8d3a-439b-ad5b-485f628275e6",
        "taskType": "RunSqlProc",
        "objectId": 199997075
    }
}

Parameter	Parameter type	Description
-queryResult
--rows	array	Array of records of the query execution result
error	string enum	Error container, for more details see the article Error Description