AWA API de atribuição

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 3 min. de leitura

    • A API de atribuição do AWA fornece endpoints para atribuir manualmente itens de trabalho aos agentes.

    Esta API requer o plug-in Advanced Work Assignment (com.glide.awa) e a função awa_manager.

    Um item de trabalho é um único trabalho tratado por um agente AWA do início ao fim. Por exemplo, um bate-papo ou um caso é um objeto que pode ser roteado e atribuído a agentes. Para obter mais informações, consulte Advanced Work Assignment.

    Atribuição manual do AWA – POST /awa/workitems/{work_item_sys_id}/assignments

    Atribui um item de trabalho disponível a um agente Advanced Work Assignment disponível.

    O principal caso de uso deste endpoint é habilitar sistemas de roteamento externo para rotear itens de trabalho. Se Advanced Work Assignment estiver configurado para usar o roteamento externo, os itens de trabalho na fila serão atribuídos usando o roteamento externo e não o AWA. A tarefa de item de trabalho pode ser atribuída chamando este endpoint. Para obter informações, consulte Usar roteamento externo.

    Formato de URL

    URL com controle de versões: /now/{api_version}/awa/workitems/{sys_id}/assignments

    URL padrão: /now/awa/workitems/{sys_id}/assignments

    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 acessada. 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
    work_item_sys_id Sys_id do item de trabalho a ser atribuído a um agente disponível. Localizado na tabela Itens de trabalho [awa_work_item].

    O item de trabalho deve estar desatribuído e no estado Aceitação pendente ou Enfileirado. Para obter informações, consulte Verificar itens de trabalho de tarefa não atribuídos.

    Tipo: cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    agent_sys_id Obrigatório. Sys_id do agente disponível para receber o item de trabalho. Agentes são usuários com a função awa_agent na tabela Usuário [sys_user].

    Para obter informações sobre como determinar se um agente está disponível, consulte Controles da caixa de entrada do agente.

    Tipo: 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/json ou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

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

    Tabela 6. Códigos de status
    Código de 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.
    409 Conflito. Não foi possível aprovar a solicitação devido a um erro no item de trabalho ou no sys_id do agente fornecido.
    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
    êxito

    Sinalizador que indica se a atribuição do item de trabalho manual foi bem-sucedida.

    Valores válidos:
    • verdadeiro: atribuição de item de trabalho bem-sucedida.
    • falso: atribuição de item de trabalho malsucedida.

    Tipo de dados: booliano

    Padrão: verdadeiro
    message Mensagem de resposta reconhecendo a atribuição ou exceção bem-sucedida.
    Exceções:
    • "O item de trabalho não pode ser atribuído": o item de trabalho fornecido não pode ser atribuído porque está no estado Aceito ou Cancelado. Consulte Verificar itens de trabalho e eventos do AWA.
    • "<agent_sys_id> não é um agente válido" – O agente não tem a função awa_agent.
    • "<work_item_sys_id> não é um item de trabalho válido" – O sys_id do item de trabalho fornecido não existe.
    • "O item de trabalho já está atribuído a<work_item_sys_id> " – O item de trabalho informado está atribuído a outro agente.
    • "O agente não está disponível": o agente não está no estado Disponível no AWA. Consulte Controles da caixa de entrada do agente.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como atribuir um item de trabalho a um agente do AWA disponível.

    curl "https://instance.servicenow.com/api/now/awa/workitems/<work_item_sys_id>/assignments" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"agent_sys_id\":\"<agent_sys_id>\"}" \
--user 'username':'password'

    O resultado mostra que a tarefa foi atribuída com sucesso ao agente. Você pode verificar os resultados no campo Atribuído a da tabela Itens de trabalho [awa_work_item].

    {
  "result": {
    "success": true,
    "message": "Manual assignment successfully requested"
  }
}