API Ações da caixa de entrada do AWA

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 11 min. de leitura

    • . Ações da caixa de entrada do AWA A API fornece endpoints para aceitar ou rejeitar um item de trabalho em nome de um agente. Esta API também recupera motivos de rejeição para itens de trabalho rejeitados.

    Esta API requer Atribuição avançada de trabalho plug-in (com.glide.awa) e função awa_integration_user. Para obter mais informações, consulte Atribuição de trabalho avançada .

    Ações da caixa de entrada do AWA - GET /awa/inbox/actions/reject_reasons/

    Obtém os motivos de rejeição do item de trabalho para um canal de serviço especificado.

    Formato de URL

    URL com controle de versão: /api/now/awa/inbox/actions/reject_reasons/

    URL padrão: /api/now//awa/inbox/actions/reject_reasons/

    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
    channel_id Sys_id de um canal de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Canais de serviço [awa_service_channel]
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    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
    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.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    403 Proibido.
    Possíveis motivos:
    • O usuário não tem a função awa_integration_user.
    • O valor da propriedade glide.awa.enabled não é verdadeiro . Esta propriedade será listada na tabela Propriedade do sistema [sys_property] se o plug-in Advanced Work Assignment (com.glide.awa) estiver instalado. Para obter mais informações, consulte Componentes instalados com Advanced Work Assignment .
    404 Registro não encontrado. O ID do canal fornecido não é válido.
    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_value Exiba o valor do campo Motivo na tabela Motivos da rejeição [awa_reject_reason].

    Tipo de dados: Cadeia de caracteres
    pedido Ordem na qual os motivos da rejeição são listados na caixa de entrada do agente.

    Tipo de dados: Número
    valor Valor do campo Motivo da rejeição armazenado no banco de dados.

    Tipo de dados: Cadeia de caracteres
    Sys_id Sys_id de um motivo de rejeição para este canal de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Motivos da rejeição [awa_reject_reason]

    O exemplo a seguir mostra como recuperar motivos de rejeição para o canal de serviço de bate-papo.

    curl "https://instance.service-now.com/api/now/awa/inbox/actions/reject_reasons/27f675e3739713004a905ee515f6a7c3" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Corpo da resposta exibindo tarefas rejeitadas com motivos para rejeição.

    {
  "result": [
    {
      "order": 2,
      "value": "Not my expertise",
      "display_value": "Not my expertise",
      "sys_id": "31e3fa29b38023002e7b6e5f26a8dc17"
    },
    {
      "order": 1,
      "value": "Busy",
      "display_value": "Busy",
      "sys_id": "4e93fa29b38023002e7b6e5f26a8dc20"
    }
  ]
}

    Ações da caixa de entrada do AWA - POST /awa/inbox/actions/accept

    Aceita um item de trabalho em Aceitação pendente estado em nome de um agente.

    Formato de URL

    URL com controle de versão: /api/now//awa/inbox/actions/accept

    URL padrão: /api/now/awa/inbox/actions/accept

    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 7. 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
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    agent_id Sys_id do agente listado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    work_item_id Sys_id do item de trabalho.
    O item de trabalho deve atender aos seguintes critérios:
    • O item de trabalho deve ser atribuído ao agente especificado.
    • O item de trabalho deve estar em Aceitação pendente estado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item de trabalho do AWA [awa_work_item]

    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 10. 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
    Tabela 11. 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 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação inválida.
    Possíveis motivos:
    • ID do agente ausente.
    • ID do item de trabalho ausente.
    • O item de trabalho está atribuído a um agente diferente.
    • O item de trabalho não está no estado de aceitação pendente.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    403 Proibido.
    Possíveis motivos:
    • O usuário não tem a função awa_integration_user.
    • O valor da propriedade glide.awa.enabled não é verdadeiro . Esta propriedade será listada na tabela Propriedade do sistema [sys_property] se o plug-in Advanced Work Assignment (com.glide.awa) estiver instalado. Para obter mais informações, consulte Componentes instalados com Advanced Work Assignment .
    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
    documentTable Nome da tabela que lista o documento atribuído a este item de trabalho.

    Tipo de dados: Cadeia de caracteres
    documentSysId Sys_id do registro do documento atribuído à tarefa.

    Tipo de dados: Cadeia de caracteres

    Tabela: Na tabela identificada em documentTablecampo.
    erro Detalhes que descrevem um erro encontrado durante o processo de solicitação.

    Tipo de dados: Objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Detalhes do erro encontrado durante o processo de solicitação.
    Valores possíveis:
    • ID do agente ausente . agent_idnão foi fornecido no corpo da solicitação.
    • ID do item de trabalho ausente . work_item_idnão foi fornecido no corpo da solicitação.
    • O item de trabalho está atribuído a um agente diferente : O item de trabalho especificado não está atribuído ao agente especificado.
    • ID do item de trabalho incorreto : O item de trabalho fornecido no corpo da solicitação é impreciso ou não existe.
    • O item de trabalho não está no estado de aceitação pendente : O item de trabalho fornecido no corpo da solicitação está em um estado diferente de Aceitação pendente .

    Tipo de dados: Cadeia de caracteres
    mensagem.erro Mensagem do erro encontrado durante o processo de solicitação.A descrição é fornecida em error.detailpropriedade.

    Tipo de dados: Cadeia de caracteres
    status Status de uma solicitação malsucedida. Esta propriedade só será incluída na resposta se houver um erro.

    Valor válido: falha

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir mostra como mudar o estado do item de trabalho de um agente selecionado de Aceitação pendente . Aceito .

    curl "https://instance.service-now.com/api/now/awa/inbox/actions/accept" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
 \"agent_id\":\"46c9e158a9fe198101d44d0d22cb640d\",
 \"work_item_id\":\"fd69abfc878b01101ae365b83cbb35fe\"
}" \
--user 'username':'password'

    O corpo da resposta lista o sys_id e a tabela do documento relacionado ao item de trabalho.

    {
  "result": {
    "documentSysId": "57af7aec73d423002728660c4cf6a71c",
    "documentTable": "incident"
  }
}

    Ações da caixa de entrada do AWA - POST /awa/inbox/actions/reject

    Rejeita um item de trabalho em Aceitação pendente estado em nome de um agente. Em caso de sucesso, Atribuído a. o campo está vazio e o valor de Rejeitado o campo é verdadeiro para o item de trabalho especificado.

    Formato de URL

    URL com controle de versão: /api/now//awa/inbox/actions/reject

    URL padrão: /api/now/awa/inbox/actions/reject

    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 13. 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
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    agent_id Sys_id do agente listado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    reject_reason_id Sys_id de um motivo de rejeição para este canal de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Motivos da rejeição [awa_reject_reason]
    work_item_id Sys_id do item de trabalho.
    O item de trabalho deve atender aos seguintes critérios:
    • O item de trabalho deve ser atribuído ao agente especificado.
    • O item de trabalho deve estar em Aceitação pendente estado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item de trabalho do AWA [awa_work_item]

    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 16. 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
    Tabela 17. 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 18. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação inválida.
    Possíveis motivos:
    • ID do agente ausente.
    • ID do item de trabalho ausente.
    • ID do motivo de rejeição ausente.
    • O item de trabalho está atribuído a um agente diferente.
    • O item de trabalho não está no estado de aceitação pendente.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    403 Proibido.
    Possíveis motivos:
    • O usuário não tem a função awa_integration_user.
    • O valor da propriedade glide.awa.enabled não é verdadeiro . Esta propriedade será listada na tabela Propriedade do sistema [sys_property] se o plug-in Advanced Work Assignment (com.glide.awa) estiver instalado. Para obter mais informações, consulte Componentes instalados com Advanced Work Assignment .
    404 Não encontrado. O item solicitado não foi encontrado.
    Possíveis motivos:
    • ID de agente incorreto - Não há registro para o usuário especificado.
    • ID do motivo de rejeição incorreto - não há registro para o motivo de rejeição especificado.
    • ID do item de trabalho incorreto - Não há registro para o item de trabalho especificado.
    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
    agent_id Sys_id do agente listado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    erro Detalhes que descrevem um erro encontrado durante o processo de solicitação.

    Tipo de dados: Objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Detalhes do erro encontrado durante o processo de solicitação.
    Valores possíveis:
    • ID do agente ausente . agent_idnão foi fornecido no corpo da solicitação.
    • ID do item do motivo da rejeição ausente . reject_reason_idnão foi fornecido no corpo da solicitação.
    • ID do item de trabalho ausente . work_item_idnão foi fornecido no corpo da solicitação.
    • Não há registro para awa_reject_reason: <reason_sys_id> . reject_reason_idFornecido no corpo da solicitação não tem um registro correspondente na tabela Motivos da rejeição [awa_reject_reason].
    • Não há registro para awa_work_item : <work_item_sys_id> . work_item_idFornecido no corpo da solicitação não tem um registro correspondente na tabela Item de trabalho do AWA [awa_work_item].
    • Não há registro para sys_user : <agent_sys_id> . agent_idFornecido no corpo da solicitação não tem um registro correspondente na tabela Usuário [sys_user].
    • O item de trabalho não está no estado de aceitação pendente : O item de trabalho fornecido no corpo da solicitação está em um estado diferente de Aceitação pendente .

    Tipo de dados: Cadeia de caracteres
    mensagem.erro Mensagem do erro encontrado durante o processo de solicitação.A descrição é fornecida em error.detailpropriedade.

    Tipo de dados: Cadeia de caracteres
    status Status de uma solicitação malsucedida. Esta propriedade só será incluída na resposta se houver um erro.

    Valor válido: falha

    Tipo de dados: Cadeia de caracteres
    reject_reason_id Sys_id de um motivo de rejeição para este canal de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Motivos da rejeição [awa_reject_reason]
    work_item_id Sys_id do item de trabalho.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como rejeitar um item de trabalho atribuído com o motivo "Não é meu conhecimento".

    curl "https://instance.service-now.com/api/now/awa/inbox/actions/reject" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"agent_id\":\"46c9e158a9fe198101d44d0d22cb640d\",
    \"work_item_id\":\"3ed5df4d87cf01101ae365b83cbb35af\",
    \"reject_reason_id\":\"31e3fa29b38023002e7b6e5f26a8dc17\"
}" \
--user 'username':'password'

    A saída bem-sucedida exibe o mesmo item de trabalho, motivo da rejeição e ID de usuário fornecidos no corpo da solicitação. O item de trabalho especificado na tabela Item de trabalho do AWA [awa_work_item] tem um vazio Atribuído a. e o valor de Rejeitado o campo é verdadeiro.

    {
  "result": {
    "work_item_id": "3ed5df4d87cf01101ae365b83cbb35af",
    "reject_reason_id": "31e3fa29b38023002e7b6e5f26a8dc17",
    "agent_id": "46c9e158a9fe198101d44d0d22cb640d"
  }
}