Переменные в REST API

Этот раздел перенесён из документации Camunda 7 и в дальнейшем будет доработан с учётом особенностей OpenBPM Engine

В REST API переменные процесса представлены JSON-объектами следующего вида:

{
  "type": "String",
  "value": "Some value",
  "valueInfo": {}

}

REST API поддерживает типы значений (Value Types), поддерживаемые процессным движком.

Регистр имён типов

В REST API имена типов начинаются с заглавной буквы, то есть String вместо string.

Сериализованные и десериализованные значения объектов

Значения объектов (Object Values) — это экземпляры (не примитивных) Java-типов. При работе с REST API обычно рекомендуется работать с сериализованным значением переменной. В этом случае значение извлекается из базы данных и напрямую возвращается в HTTP-ответе. Если создаваемый вами клиент сам не является Java-приложением, убедитесь, что вы используете текстовый формат данных сериализации (такой как XML или JSON).

Чтобы получить сериализованную форму переменной, используйте GET-параметр `deserializeValues=false`.

Сериализация переменных типа Object в REST API

В REST API переменные процесса типа Object могут быть сериализованы в формате JSON или XML.

Сериализация Object в формат JSON:

	{
	   "variables": {
	      "aVariable": {
	         "value": "{\"somekey\": \"somevalue\"}",
	         "type": "Object",
	         "valueInfo": {
	            "objectTypeName": "com.camunda.SomeClass",
	            "serializationDataFormat": "application/json"
	         }
	      }
	   }
	}

Сериализация Object в формат XML:

	{
	   "variables": {
	      "aVariable": {
	         "value": "<somekey>somevalue</somekey>",
	         "type": "Object",
	         "valueInfo": {
	            "objectTypeName": "com.camunda.SomeClass",
	            "serializationDataFormat": "application/xml"
	         }
	      }
	   }
	}

Лицензия и атрибуция

Эта документация была создана на базе материала "Camunda 7 Docs" от Camunda, находится под лицензией Creative Commons Attribution-ShareAlike 3.0 Unported License .

Оригинал документации: https://docs.camunda.org