Skip to content
API
/
RunMessages

WebAPI.Host (3.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://{{your_venus_webapi_ip_address}}/

Cameras

Operations

Devices

Operations

ErrorHandler

Operations

Files

Operations

InstrumentData

Operations

RunExecutor

Operations

RunMessages

Operations

Receives a push request and enqueues a message to the specified channel.

Request

Security
Bearer
Body

The push request containing the target channel and the message data to enqueue. Cannot be null. The channel and data fields must not be empty.

channelstring

Gets or sets the name of the channel associated with this instance.

dataany

Gets or sets the data content associated with this instance.

curl -i -X POST \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/run-messages' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; x-api-version=3.0' \
  -d '{
    "channel": "string",
    "data": null
  }'

Responses

Returns the details of the enqueued message, including the channel, message ID, timestamp, and current queue depth.

Body
channelstring

Gets or sets the name of the channel associated with this instance.

messageIdstring

Gets or sets the unique identifier for the message.

timestampstring

Gets or sets the timestamp indicating when the object was created or last updated.

queueDepthinteger(int32)

Gets or sets the depth level represented by this instance.

Response
{
  "channel": "string",
  "messageId": "string",
  "timestamp": "string",
  "queueDepth": 0
}

Removes and returns the next message from the specified channel's queue.

Request

Security
Bearer
Path
channelstringrequired

The name of the channel from which to dequeue a message. Cannot be null or empty.

curl -i -X POST \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/run-messages/{channel}/pop' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns the details of the dequeued message, including the channel, message ID, timestamp, and data. If no message is available, returns hasMessage as false.

Body
channelstring

Gets or sets the name of the channel associated with this instance.

hasMessageboolean

Gets or sets a value indicating whether a message is present.

messageIdstring

Gets or sets the unique identifier for the message.

timestampstring

Gets or sets the timestamp indicating when the object was created or last updated.

dataany

Message data, which is expected to be a JSON string.

Response
{
  "channel": "string",
  "hasMessage": true,
  "messageId": "string",
  "timestamp": "string",
  "data": null
}

Retrieves, without removing, the next available message from the specified channel's queue.

Request

Security
Bearer
Path
channelstringrequired

The name of the channel from which to peek the next message. Cannot be null or empty.

curl -i -X GET \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/run-messages/{channel}/peek' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns the details of the next message in the queue, including the channel, message ID, timestamp, and data. If no message is available, returns hasMessage as false.

Body
channelstring

Gets or sets the name of the channel associated with this instance.

hasMessageboolean

Gets or sets a value indicating whether a message is present.

messageIdstring

Gets or sets the unique identifier for the message.

timestampstring

Gets or sets the timestamp indicating when the object was created or last updated.

dataany

Message data, which is expected to be a JSON string.

Response
{
  "channel": "string",
  "hasMessage": true,
  "messageId": "string",
  "timestamp": "string",
  "data": null
}

Retrieves the current depth of the specified channel's queue.

Request

Security
Bearer
Path
channelstringrequired

The name of the channel for which to retrieve the queue depth. Cannot be null or empty.

curl -i -X GET \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/run-messages/{channel}/depth' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns the current depth of the queue for the specified channel.

Body
channelstring

Gets or sets the name of the channel associated with this instance.

depthinteger(int32)

Gets or sets the depth level represented by this instance.

Response
{
  "channel": "string",
  "depth": 0
}

Deletes all messages from the specified channel.

Request

Security
Bearer
Path
channelstringrequired

The name of the channel from which to delete all messages. Cannot be null or empty.

curl -i -X DELETE \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/run-messages/{channel}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns the number of messages that were deleted from the specified channel.

Body
channelstring

The name of the channel from which messages were deleted.

messagesDeletedinteger(int32)

The number of messages that were deleted from the channel.

Response
{
  "channel": "string",
  "messagesDeleted": 0
}

System

Operations

Users

Operations