UiPath · Schema

QueueDefinition

Definition of a transaction queue for distributing work items

AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

Properties

Name Type Description
Id integer Unique integer identifier of the queue
Name string Display name of the queue
Description string Optional description of the queue's purpose
MaxNumberOfRetries integer Maximum number of automatic retries for failed transactions
AcceptAutomaticallyRetry boolean Whether failed items are automatically requeued for retry
EnforceUniqueReference boolean Whether each item must have a unique reference string
OrganizationUnitId integer ID of the folder in which this queue resides
View JSON Schema on GitHub

JSON Schema

orchestrator-queue-definition-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/json-schema/orchestrator-queue-definition-schema.json",
  "title": "QueueDefinition",
  "description": "Definition of a transaction queue for distributing work items",
  "type": "object",
  "properties": {
    "Id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique integer identifier of the queue",
      "example": 12345
    },
    "Name": {
      "type": "string",
      "description": "Display name of the queue",
      "example": "Example Name"
    },
    "Description": {
      "type": "string",
      "description": "Optional description of the queue's purpose",
      "example": "Example description for this resource."
    },
    "MaxNumberOfRetries": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10,
      "description": "Maximum number of automatic retries for failed transactions",
      "example": 1
    },
    "AcceptAutomaticallyRetry": {
      "type": "boolean",
      "description": "Whether failed items are automatically requeued for retry",
      "example": true
    },
    "EnforceUniqueReference": {
      "type": "boolean",
      "description": "Whether each item must have a unique reference string",
      "example": true
    },
    "OrganizationUnitId": {
      "type": "integer",
      "format": "int64",
      "description": "ID of the folder in which this queue resides",
      "example": 12345
    }
  }
}