[]
v8.1
(Showing Draft Content)

QueueMonitor

QueueMonitor

[GET] /api/v2/common/task-queue-monitor

Get queue monitor statistical.

Response

Status Code: 200

Success

QueueStatsResponseModel

Status Code: 400

Bad Request

ServerPluginError

Models

Ƭ QueueStatsResponseModel

Represent a queue statistical response model.

Name Type Description Example
workersNullable WorkerInfoViewModel Get or set worker info list.
tasksNullable CommonTaskInfo Get or set task info list.

Ƭ WorkerInfoViewModel

Represent a worker information model.

Name Type Description Example
idNullable string Get or set the worker ID.
urlNullable string Get or set the worker URL.
lastSeen ISO DateTime Sting Get or set the last seen time of the worker.
tasksInProgress int32 Get or set the number of tasks in progress by the worker.
displayNameNullable string Get or set the display name of the worker.
specializationsNullable Array<string> Get or set the specializations of the worker.

Ƭ CommonTaskInfo

Represent a common task info response model.

Name Type Description Example
taskID TaskIDViewModel
workerUrlNullable string Get or set worker url.
workerIDNullable string Get or set worker id.
initiatorNullable string Get or set task initiator.
documentNameNullable string Get or set document name.
displayDocNameNullable string Get or set display name.
documentIdNullable string Get or set document id.
documentTypeNullable string Get or set document type.
startTime ISO DateTime Sting Get or set task start time.
endTimeNullable ISO DateTime Sting Get or set task end time.
progressNullable string Get or set task progress.
errorMessageNullable string Get or set task error message.
descriptionNullable string Get or set task description.
breakStatus CommonTaskInfo+TaskStatus
status CommonTaskInfo+TaskStatus
type CommonTaskInfo+TaskType

Ƭ TaskIDViewModel

Represent a task ID view model.

Name Type Description Example
idNullable string Get or set the task ID.
parent TaskIDViewModel

Ƭ CommonTaskInfo+TaskStatus

Enum:

  • NotStarted
  • WaitingForActivation
  • WaitingToRun
  • Started
  • ReadingResult
  • Verifying
  • Canceled
  • Failed
  • Finished

Enumeration of task status

* NotStarted - 0 - Not started.
* WaitingForActivation - 1 - Waiting for activation.
* WaitingToRun - 2 - Waiting to run.
* Started - 3 - Started.
* ReadingResult - 4 - Reading result.
* Verifying - 5 - Verifying.
* Canceled - 6 - Canceled.
* Failed - 7 - Failed.
* Finished - 8 - Finished.

Ƭ CommonTaskInfo+TaskType

Enum:

  • Queue
  • Scheduler

Enumeration of task types.

* Queue - 0 - Queue task.
* Scheduler - 1 - Scheduler task.

Ƭ ServerPluginError

Server plugin error

Name Type Description Example
codeNullable string error code
messageNullable string error message
contextNullable string error context
innerError ServerPluginError
extensionsNullable any Extended result