Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Queue- Global

The Queue API (Advanced Work Assignment) provides methods to route a document to a queue.

This API is provided within the sn_awa namespace.

Requires the following:

  • Advanced Work Assignment plugin (com.glide.awa)
  • Role: awa_integration_user or admin

Parent Topic:Server API reference

Queue - get(String queue_id)

Gets a queue record by sys_id.

NameTypeDescription
queue_idStringRepresents sys_id of queue record from awa_queue table
TypeDescription
BooleanTrue if queue record exists, false otherwise.
var queue = sn_awa.Queue.get("<queue_id>");
var workItem = queue.route({ 
    document_sys_id: "<sys_id>",
    document_table: "<table>"
});

Queue – route(Object options)

Routes an active work item to the queue object.

If an active work item does not exist for the specified document, this method creates a work item and set its fields accordingly.

NameTypeDescription
optionsObjectContains document sys\_id and table associated with work item:- `document_sys_id: ""` - `document_table: ""`, e.g., interaction
TypeDescription
BooleanTrue if successful, error message otherwise.
var queue = sn_awa.Queue.get("<queue_id>");
var workItem = queue.route({ 
    document_sys_id: "<sys_id>",
    document_table: "<table>"
});

sndocs is an independent community mirror and is not affiliated with or endorsed by ServiceNow.

ServiceNow, the ServiceNow logo, Now, and other ServiceNow marks are trademarks and/or registered trademarks of ServiceNow, Inc., in the United States and/or other countries. Other company and product names may be trademarks of the respective companies with which they are associated.

© 2026 ServiceNow, Inc. All rights reserved.

Documentation content is redistributed under the Apache License 2.0 from the ServiceNowDocs repository.