r_keeper

ShExecuteProcedure

1
Описание
2
Формат запроса
3
Формат ответа
4
Ответ с ошибкой
5
Примеры

Описание

Формат запроса

//Синхронное выполнение
{
    "taskType": "ShExecuteProcedure",
    "params": {
      "sync": {
        "objectId": "string",
        "timeout": number
      },
      "query": object
    }
}

// Асинхронное выполнение
{
    "taskType": "ShExecuteProcedure",
    "params": {
      "async": {
        "objectId": 0,
        "timeout": number
      },
      "query": object
    }
}

Формат ответа

//Формат ответа на асинхронный запрос
{ 
   "responseCommon":{ 
      "taskGuid":"guid",
      "taskType":"ShExecuteProcedure",
      "objectId":number
   }
}

//Формат ответа на синхронный запрос или на ответ по задаче в случае асинхронного запроса
{
    "taskResponse": object,
    "responseCommon": {
        "taskGuid": "guid",
        "taskType": "ShExecuteProcedure",
        "objectId": "number"
    }
}

Ответ с ошибкой

//Ошибка от сервера
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetStopList",
    "objectId": 0
  },
  "error": {
    "agentError": {
      "code": 0,
      "desc": "string"
    }
  }
}

//Ошибка от агента
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetStopList",
    "objectId": 0
  },
  "error": {
    "agentError": {
      "code": 0,
      "desc": "string"
    }
  }
}