Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

queue-controller

Create Or Update Queue (saveQueue)

Create or update the Queue. When creating queue, platform generates Queue Id as time-based UUID. Specify existing Queue id to update the queue. Referencing non-existing Queue Id will cause 'Not Found' error.

Queue name is unique in the scope of sysadmin. Remove 'id', 'tenantId' from the request body example (below) to create new Queue entity.

Available for users with 'SYS_ADMIN' authority.

post/api/queues

Query parameters

serviceType'TB-RULE-ENGINE' | 'TB-CORE' | 'TB-TRANSPORT' | 'JS-EXECUTOR' required

Service type (implemented only for the TB-RULE-ENGINE)

Request body

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

namestring
topicstring
pollIntervalinteger
partitionsinteger
consumerPerPartitionboolean
packProcessingTimeoutinteger
{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example request

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "QUEUE"
  },
  "createdTime": 1746028547220,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "additionalInfo": {}
}

Response

OK

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

namestring
topicstring
pollIntervalinteger
partitionsinteger
consumerPerPartitionboolean
packProcessingTimeoutinteger
{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "QUEUE"
  },
  "createdTime": 1746028547220,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "additionalInfo": {}
}