API de roteamento do AWA

. Roteamento AWA A API fornece endpoints para rotear um documento para uma fila.

Esta API requer Atribuição avançada de trabalho plug-in (com.glide.awa) e a função awa_integration_user.

Roteamento do AWA - POST /now/awa/queues/queue_sys_id/work_item

Se houver um item de trabalho ativo, o roteará um documento para uma fila. Se um item de trabalho ativo não existir para o documento especificado, criará um item de trabalho e definirá seus campos de acordo.

Formato de URL

URL com controle de versão: /api/now/

URL padrão: /api/now/awa/queues/queue_sys_id/work_item

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
queue_sys_id	Sys_id do registro da fila. Tipo de dados: Cadeia de caracteres Tabela: Fila [awa_queue]

Tabela 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
document_sys_id	Sys_id do documento a ser roteado para a fila. Tipo de dados: Cadeia de caracteres
document_table	Nome da tabela associada ao documento, como incidente. Tipo de dados: Cadeia de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 4. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 5. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 6. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
display_name	Nome do documento a ser roteado por este item de trabalho, como registro de caso. Tipo de dados: Cadeia de caracteres
document_sys_id	Sys_id do documento a ser roteado para a fila. Tipo de dados: Cadeia de caracteres
document_table	Nome da tabela associada ao documento. Tipo de dados: Cadeia de caracteres
queue_sys_id	Sys_id da fila na qual rotear um documento. Tipo de dados: Cadeia de caracteres
sys_id	Sys_id do item de trabalho atribuído à fila. Tipo de dados: Cadeia de caracteres

Solicitação de cURL de amostra

curl -X POST \
  https://instance.servicenow.com/api/now/awa/queues/339eed3f3b892300a2bac9bb34efc4c3/work_item \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-u 'username':'password'
-d '{
  "document_sys_id": "9c573169c611228700193229fff72400",
  "document_table": "incident"
}'

{
  "result": {
    "sys_id": "cd57f90ddbb26300db2051735e9619f0",
    "document_table": "incident",
    "document_sys_id": "9c573169c611228700193229fff72400",
    "queue_sys_id": "339eed3f3b892300a2bac9bb34efc4c3",
    "display_name": "Incident: INC0000001"
  }
}