Method
POST /signal
Parameters
A JSON object with the following properties:
|value|The variable's value. For variables of type , the serialized value has to be submitted as a String value.
For variables of type File
the value has to be submitted as Base64 encoded string.
|type|The value type of the variable.|valueInfo| A JSON object containing additional, value-type-dependent properties.
For serialized variables of type Object
, the following properties can be provided:
- objectTypeName: A string representation of the object's type name.
serializationDataFormat: The serialization format used to store the variable.
For serialized variables of typeFile
, the following properties can be provided:filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again.
- mimetype: The MIME type of the file that is being uploaded.
transient: Indicates whether the variable should be transient or not. See for more informations.
|Name|Description
|——-
|value|The variable's value. For variables of typeObject
, the serialized value has to be submitted as a String value.
For variables of typeFile
the value has to be submitted as Base64 encoded string.
|type|The value type of the variable.
|valueInfo| A JSON object containing additional, value-type-dependent properties.
For serialized variables of type , the following properties can be provided:
serializationDataFormat: The serialization format used to store the variable.
For serialized variables of typeFile
, the following properties can be provided:filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again.
- mimetype: The MIME type of the file that is being uploaded.
encoding: The encoding of the file that is being uploaded.
The following property can be provided for all value types:
Result
This method returns no content.
Response Codes
- If no name was given
- If a tenant id and an execution id is specified
|403|application/json|If the user is not allowed to throw a signal event.
|500|application/json| If a single execution is specified and no such execution exists or has not subscribed to the signal.
Also see the introduction for the errorresponse format.
Example
POST
Request Body:
Status 204. No content.