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": "ShExecuteProcedure",
    "objectId": 0
  },
  "error": {
    "agentError": {
      "code": 0,
      "desc": "string"
    }
  }
}

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

Пример

// Описание процедур https://apidocs.ucs.ru/doku.php/ru:storehouse5
// Пример запроса
{
	"taskType": "ShExecuteProcedure",
	"params": {
		"async": {
			"objectId": 199997075,
			"timeout": 120
		},
		"query": {
			"procName": "GGroups",
			"userName": "Admin",
			"password": "12345"
		}
	}
}

// Пример ответа на синхронный запрос или на ответ по задаче в случае асинхронного запроса
{
    "taskResponse": {
        "errorCode": 0,
        "errMessage": "OK",
        "Version": "1.8.2",
        "UserName": "Admin",
        "actionName": "GGroups",
        "actionType": "Execute",
        "shTable": [
          {
            "head": "209",
            "original": [
              "1"
          ],
          "fields": [
            "Rid"
          ]
    },
    "responseCommon": {
        "taskGuid": "guid",
        "taskType": "ShExecuteProcedure",
        "objectId": "number"
    }
}