---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# API do agente do AWA

# API do agente do AWA {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 22 min. de leitura

A API do agente AWA (Advanced Work Assignment) fornece endpoints para gerenciar a presença do agente, a disponibilidade do canal e a carga de trabalho.
Esta API requer o plug-in Atribuição avançada de trabalho (com.glide.awa) e a função awa_integration_user. Para obter mais informações, consulte [Advanced Work Assignment](https://www.servicenow.com/docs/access?context=awa-overview&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).

## AWA Agente - GET /now/awa/agents/{user_id} {#ariaid-title2}

Retorna o estado atual de presença do agente e a disponibilidade do canal.

### Formato da URL {#awa-GET-agents__section_hsf_jvl_cmb}

URL com controle de versões: /api/now/{api_version}/awa/agents/{user_id}

URL padrão: /api/now/awa/agents/{user_id}

### Parâmetros de solicitação compatíveis

{#awa-GET-agents__entry__2}{#awa-GET-agents__version-RESTAPI}{#awa-GET-agents__awa-api-ph-work_item_id}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| user_id | Sys_id do item de trabalho listado na tabela Item de trabalho do AWA \[awa_work_item\]. 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 no estado Aceitação pendente. {#awa-GET-agents__ul_zcs_rh3_htb} Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]

{#awa-GET-agents__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 2. Parâmetros de consulta]

{#awa-GET-agents__presence__entry__2}{#awa-GET-agents__ph-presence_channels_avail-awa}{#awa-GET-agents__ph-presence_channels_sys_id-awa}{#awa-GET-agents__ph-presence_sys_id-awa}

| Cabeçalho | Descrição |
|-|-|
| presença.canais.disponíveis | Sinalizador que indica se o canal está disponível. Valores possíveis: * verdadeiro: o canal está disponível. * falso: o canal não está disponível. {#awa-GET-agents__ul_qps_xwl_cmb} Tipo de dados: booliano |
| presença.canais.sys_id | sys_id do canal. Localizado na tabela Canais de serviço \[awa_service_channel\]. Tipo de dados: cadeia de caracteres |
| presença.sys_id | sys_id do estado de presença. Localizado na tabela Estados de presença \[awa_presence_state\]. Tipo de dados: cadeia de caracteres |
[Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#awa-GET-agents__entry__20}{#awa-GET-agents__accept-RESTAPI}{#awa-GET-agents__content_type-RESTAPI}

| 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 4. Cabeçalhos da solicitação]

{#awa-GET-agents__entry__26}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status 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 de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#awa-GET-agents__entry__30}{#awa-GET-agents__entry-200-status-code}{#awa-GET-agents__entry-400-status-code}{#awa-GET-agents__entry-401-status-code}{#awa-GET-agents__entry-403-status-code-awa}{#awa-GET-agents__entry-404-status-code}{#awa-GET-agents__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 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.{#awa-GET-agents__li-403-role} * 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 o Advanced Work Assignment](https://www.servicenow.com/docs/access?context=installed-with-awa&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).{#awa-GET-agents__li-403-awa-disabled} {#awa-GET-agents__ul_gch_n34_tsb} |
| 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. |
[Tabela 6. Códigos de status]

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

{#awa-GET-agents__table_r2q_fbm_cmb__entry__2}{#awa-GET-agents__awa-api-entry-error}{#awa-GET-agents__awa-api-ph-error_detail}{#awa-GET-agents__awa-api-ph-error_message}{#awa-GET-agents__ph-presence-awa}{#awa-GET-agents__ph-presence_available-awa}{#awa-GET-agents__ph-presence_channels-awa}{#awa-GET-agents__d3393e337}{#awa-GET-agents__ph-presence_channels_name-awa}{#awa-GET-agents__d3393e405}{#awa-GET-agents__ph-presence_name-awa}{#awa-GET-agents__ph-presence_restrict_update-awa}{#awa-GET-agents__d3393e465}{#awa-GET-agents__awa-api-entry_status}{#awa-GET-agents__ph-sys_id-awa}{#awa-GET-agents__open-workItem_document-ph}{#awa-GET-agents__open-workItem_document_sysid-ph}{#awa-GET-agents__open-workItem_document_table-ph}{#awa-GET-agents__open-workItem_previousWorkItem-ph}{#awa-GET-agents__open-workItem_serviceChannel-ph}{#awa-GET-agents__open-workItem_serviceChannel_name-ph}{#awa-GET-agents__open-workItem_serviceChannel_sys_id-ph}{#awa-GET-agents__open-workItem_size-ph}{#awa-GET-agents__open-workItem_sysid-ph}{#awa-GET-agents__open-workItem_isQueueTransferred-ph}

| Parâmetro | Descrição |
|-|-|
| erro | Detalhes que descrevem um erro encontrado durante o processo de solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processo de solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processo de solicitação. Cada mensagem de erro tem uma descrição correspondente na propriedade detail. Valores possíveis: * Registro não encontrado: as informações fornecidas no corpo da solicitação são imprecisas ou não existem. * Usuário não autenticado: o usuário não tem a função awa_integration_user. {#awa-GET-agents__ul_om3_5sq_tsb} Tipo de dados: cadeia de caracteres |
| presença | Informações sobre o estado de presença atual e o canal de um agente. Tipo de dados: objeto "presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" } |
| presença.disponível | Sinalizador que indica se o agente está disponível. Valores possíveis: * verdadeiro: o agente está disponível. * falso: o agente não está disponível. {#awa-GET-agents__ul_ezb_kwl_cmb} Tipo de dados: booliano |
| presença.canais | Lista de objetos que descreve os canais de comunicação disponíveis com o agente. Tipo de dados: matriz "channels": [ { "available": Boolean, "name": "String", "sys_id": "String" } ] |
| presença.canais.disponíveis | Sinalizador que indica se o canal está disponível. Valores possíveis: * verdadeiro: o canal está disponível. * falso: o canal não está disponível. {#awa-GET-agents__d3393e342} Tipo de dados: booliano |
| presence.channels.name | Nome do canal, como Bate-papo ou Telefone. Tipo de dados: cadeia de caracteres |
| presença.canais.restrict_update | Sinalizador que indica se o usuário pode restringir atualizações, ou seja, selecionar o canal para disponibilidade. Valores possíveis: * verdadeiro: o usuário pode selecionar este canal para disponibilidade. * falso: o usuário não pode selecionar este canal para disponibilidade. {#awa-GET-agents__ul_xjk_kn4_tsb} Tipo de dados: booliano |
| presença.canais.service_channel_type | Tipo de canal de serviço, como bate-papo. Os valores possíveis variam de acordo com os plug-ins instalados. Tipo de dados: cadeia de caracteres |
| presença.canais.sys_id | sys_id do canal. Localizado na tabela Canais de serviço \[awa_service_channel\]. Tipo de dados: cadeia de caracteres |
| presence.name | Nome do estado de presença do agente. Valores possíveis: * Disponível * Indisponível {#awa-GET-agents__ul_mlm_mxl_cmb} Tipo de dados: cadeia de caracteres |
| presença.restrict_update | Sinalizador que indica se o usuário pode restringir atualizações. Valores possíveis: * verdadeiro: o usuário pode restringir atualizações. * falso: o usuário não pode restringir atualizações. {#awa-GET-agents__ul_dfh_cxl_cmb} Tipo de dados: booliano |
| presença.sys_id | sys_id do estado de presença. Localizado na tabela Estados de presença \[awa_presence_state\]. 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 |
| sys_id | sys_id do agente. Tipo de dados: cadeia de caracteres |
| Item de trabalho | workItem: informações sobre o item de trabalho associado ao evento.{#awa-GET-agents__open-workItem-p} |
| workItem.document | workItem.document: Lista de documentos associados à tarefa de item de trabalho. |
| workItem.document.sys_id | workItem.document.sys_id: Sys_id do documento atribuído à tarefa de item de trabalho. |
| workItem.document.table | workItem.document.table: Nome da tabela de documentos atribuída à tarefa. |
| workItem.previousWorkItem | workItem.previousWorkItem: Sys_id do item de trabalho anterior para o mesmo ID de documento. Para os itens de trabalho de não transferência, este valor está vazio. |
| workItem.serviceChannel | workItem.serviceChannel: Lista de canais de serviço associados à tarefa de item de trabalho. |
| workItem.serviceChannel.name | workItem.serviceChannel.name: Nome do canal de serviço, como Bate-papo ou Telefone. |
| workItem.serviceChannel.sys_id | workItem.serviceChannel.sys_id: Sys_id do canal de serviço. |
| workItem.size | workItem.size: capacidade do agente usada quando este item de trabalho é atribuído ao agente. |
| workItem.sys_id | workItem.sys_id: Sys_id do item de trabalho que foi aceito ou oferecido. |
| workItem.isQueueTransferred | workItem.isQueueTransferred: indica se o item de trabalho foi transferido para a fila. Defina como verdadeiro se o item de trabalho for transferido da fila e falso se não for. Para obter mais informações sobre transferências de fila, consulte [Transfer a chat to another queue](https://www.servicenow.com/docs/access?context=transfer-chat-queue&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). |
[Tabela 7. Parâmetros do corpo da resposta (JSON ou XML)]

{#awa-GET-agents__table_r2q_fbm_cmb}  

### Amostra de solicitação cURL

    curl -X GET \
    https://instance.servicenow.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666 \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -u 'username':'password'\

    {
      "result": {
        "presence": {
          "name": "Available",
          "sys_id": "0b10223c57a313005baaaa65ef94f970",
          "available": true,
          "channels": [
            {
              "name": "Chat",
              "available": true,
              "sys_id": "27f675e3739713004a905ee515f6a7c3"
            }
          ]
        },
        "sys_id": "46d44a23a9fe19810012d100cca80666"
      }
    }

## AWA Agente - GET /now/awa/agents/{user_id}/capacities {#ariaid-title3}

Retorna as capacidades do canal de um agente, a capacidade universal e a carga de trabalho atual para ver se o agente pode lidar com um caso.
Use o método [AWA Agente - PUT /now/awa/agents/{user_id}/capacities](https://servicenow-prod.fluidtopics.net/vegVZBMCdsVv5Fh7ZY~twA#awa-PUT-capacities "Habilita a atualização da capacidade máxima (carga de trabalho) de um agente para capacidades de canal e capacidade universal.") para modificar o canal e as capacidades universais de um agente.  
Consulte também:

* [Capacidade e utilização do canal de serviço](https://www.servicenow.com/docs/access?context=awa-service-channel-capacity&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* [Criar ou configurar um canal de serviço](https://www.servicenow.com/docs/access?context=awa-create-service-channel&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* [Configuração da capacidade universal máxima de um agente](https://www.servicenow.com/docs/access?context=awa-universal-capacity&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
{#awa-GET-capacities__ul_rl1_2wg_jtb}

### Formato da URL {#awa-GET-capacities__section_hsf_jvl_cmb}

URL com controle de versão: /api/now/{api_version}/awa/agents/{user_id}/capacities

URL padrão: /api/now/awa/agents/{user_id}/capacities

### Parâmetros de solicitação compatíveis {#awa-GET-capacities__section_vg3_ydq_htb}

{#awa-GET-capacities__table_wg3_ydq_htb__entry__2}{#awa-GET-capacities__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| user_id | Sys_id do agente listado na tabela Usuário \[sys_user\]. Tipo de dados: cadeia de caracteres |
[Tabela 8. Parâmetros de caminho]

{#awa-GET-capacities__table_wg3_ydq_htb} {#awa-GET-capacities__table_xg3_ydq_htb__entry__2}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 9. Parâmetros de consulta]

{#awa-GET-capacities__table_xg3_ydq_htb} {#awa-GET-capacities__table_yg3_ydq_htb__entry__2}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 10. Parâmetros do corpo da solicitação (XML ou JSON)]

{#awa-GET-capacities__table_yg3_ydq_htb}

### Cabeçalhos {#awa-GET-capacities__section_zg3_ydq_htb}

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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#awa-GET-capacities__table_ah3_ydq_htb__entry__2}{#awa-GET-capacities__accept-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 11. Cabeçalhos da solicitação]

{#awa-GET-capacities__table_ah3_ydq_htb} {#awa-GET-capacities__table_bh3_ydq_htb__entry__2}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 12. Cabeçalhos de resposta]

{#awa-GET-capacities__table_bh3_ydq_htb}

### Códigos de status {#awa-GET-capacities__section_ch3_ydq_htb}

Os seguintes códigos de status 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 de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#awa-GET-capacities__table_dh3_ydq_htb__entry__2}{#awa-GET-capacities__entry-200-status-code}{#awa-GET-capacities__entry-400-status-code}{#awa-GET-capacities__entry-401-status-code}{#awa-GET-capacities__entry-403-status-code-awa}{#awa-GET-capacities__entry-404-status-code}{#awa-GET-capacities__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 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.{#awa-GET-capacities__li-403-role} * 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 o Advanced Work Assignment](https://www.servicenow.com/docs/access?context=installed-with-awa&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).{#awa-GET-capacities__li-403-awa-disabled} {#awa-GET-capacities__ul_gch_n34_tsb} |
| 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. |
[Tabela 13. Códigos de status]

{#awa-GET-capacities__table_dh3_ydq_htb}

### Parâmetros do corpo da resposta (JSON ou XML) {#awa-GET-capacities__section_agk_dmp_htb}

{#awa-GET-capacities__table_bgk_dmp_htb__entry__2}{#awa-GET-capacities__ph-presence_channels_sys_id-awa}{#awa-GET-capacities__ordr-row-error}{#awa-GET-capacities__awa-api-ph-universal_capacity}

| Nome | Descrição |
|-|-|
| canais | Lista de objetos que descreve os canais de comunicação disponíveis com o agente. "channels": [ { "channel_sys_id": "String", "current_workload": Number, "max_capacity": Number } ] Tipo de dados: matriz |
| canais.channel_sys_id | sys_id do canal. Localizado na tabela Canais de serviço \[awa_service_channel\]. Tipo de dados: cadeia de caracteres |
| canais.carga_de_trabalho_atual | Número de itens de trabalho em um canal de serviço específico atualmente atribuído ao agente. Tipo de dados: número |
| canais.max_capacity | A carga de trabalho máxima em um canal de serviço específico ao qual o agente pode ser ativamente atribuído de cada vez. Tipo de dados: cadeia de caracteres |
| erro | Detalhes que descrevem um erro encontrado durante o processo de solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processo de solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processo de solicitação. A descrição é fornecida na propriedade error.detail. 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 |
| capacidade_universal | Capacidade máxima para o agente em todos os canais de serviço. Se a carga de trabalho atual de um agente for igual à capacidade universal máxima, itens de trabalho adicionais não serão atribuídos ao agente. Esta propriedade só será retornada se houver um registro de capacidade universal para este agente. Tipo de dados: número |
| carga_de_trabalho universal | Número de itens de trabalho em todos os canais de serviço atualmente atribuídos ao agente especificado. Esta propriedade só retorna se houver um registro de capacidade universal para o agente. Tipo de dados: número |
[ ]

{#awa-GET-capacities__table_bgk_dmp_htb}  

### Amostra de solicitação cURL {#awa-GET-capacities__example_eh3_ydq_htb}

O exemplo a seguir mostra como obter os valores de capacidade e carga de trabalho de um usuário.

    curl "https://instance.service-now.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666/capacities" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

Uma resposta bem-sucedida inclui valores de capacidade e carga de trabalho para cada canal.

    {
      "result": {
        "universal_workload": 2,
        "channels": [
          {
            "channel_sys_id": "27f675e3739713004a905ee515f6a7c3",
            "current_workload": 2,
            "max_capacity": 4
          }
        ],
        "universal_capacity": 10
      }
    }

## AWA Agente - GET /now/awa/agents/{user_id}/presence_states {#ariaid-title4}

Retorna os estados de presença de um agente e indica se o agente está disponível ou em outro estado de presença.

### Formato da URL {#awa-GET-presence_states__section_hsf_jvl_cmb}

URL com controle de versão: /api/now/{api_version}/awa/agents/{user_id}/presence_states

URL padrão: /api/now/awa/agents/{user_id}/presence_states

### Parâmetros de solicitação compatíveis

{#awa-GET-presence_states__entry__2}{#awa-GET-presence_states__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| user_id | Sys_id do agente listado na tabela Usuário \[sys_user\]. Tipo de dados: cadeia de caracteres |
[Tabela 14. Parâmetros de caminho]

{#awa-GET-presence_states__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 15. Parâmetros de consulta]

{#awa-GET-presence_states__entry__12}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 16. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#awa-GET-presence_states__entry__16}{#awa-GET-presence_states__accept-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 17. Cabeçalhos da solicitação]

{#awa-GET-presence_states__entry__20}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 18. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status 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 de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#awa-GET-presence_states__entry__24}{#awa-GET-presence_states__entry-200-status-code}{#awa-GET-presence_states__entry-400-status-code}{#awa-GET-presence_states__entry-401-status-code}{#awa-GET-presence_states__entry-403-status-code-awa}{#awa-GET-presence_states__entry-404-status-code}{#awa-GET-presence_states__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 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.{#awa-GET-presence_states__li-403-role} * 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 o Advanced Work Assignment](https://www.servicenow.com/docs/access?context=installed-with-awa&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).{#awa-GET-presence_states__li-403-awa-disabled} {#awa-GET-presence_states__ul_gch_n34_tsb} |
| 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. |
[Tabela 19. Códigos de status]

### Parâmetros do corpo da resposta (JSON ou XML) {#awa-GET-presence_states__section_agk_dmp_htb}

{#awa-GET-presence_states__table_bgk_dmp_htb__entry__2}{#awa-GET-presence_states__ordr-row-error}{#awa-GET-presence_states__ph-presence_available-awa}{#awa-GET-presence_states__ph-presence_channels_avail-awa}{#awa-GET-presence_states__ph-presence_channels_name-awa}{#awa-GET-presence_states__ph-presence_channels_sys_id-awa}{#awa-GET-presence_states__ph-presence_sys_id-awa}

| Nome | Descrição |
|-|-|
| erro | Detalhes que descrevem um erro encontrado durante o processo de solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processo de solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processo de solicitação. A descrição é fornecida na propriedade error.detail. Tipo de dados: cadeia de caracteres |
| \<presence state\> | Lista de definições do estado de presença do agente como objetos. Cada objeto descreve o estado e inclui os canais do agente. Tipo de dados: matriz { "available": Boolean, "channels": [Array], "disable_inactivity_check": Boolean, "name": "String", "show_channels": Boolean, "sys_id": "String" } |
| \<presence state\>.disponível | Sinalizador que indica se o agente está disponível. Valores possíveis: * verdadeiro: o agente está disponível. * falso: o agente não está disponível. {#awa-GET-presence_states__ul_ezb_kwl_cmb} Tipo de dados: booliano |
| \<presence state\>.canais | Lista de objetos que descreve os canais de comunicação disponíveis com o agente. Tipo de dados: matriz "channels": [ { "available": Boolean, "name": "String", "restrict_update": Boolean, "service_channel_type": "String", "sys_id": "String" } ] |
| \<presence state\>.canais.disponíveis | Sinalizador que indica se o canal está disponível. Valores possíveis: * verdadeiro: o canal está disponível. * falso: o canal não está disponível. {#awa-GET-presence_states__ul_qps_xwl_cmb} Tipo de dados: booliano |
| \<presence state\>.canais.nome | Nome do canal, como Bate-papo ou Telefone. Tipo de dados: cadeia de caracteres |
| \<presence state\>.canais.sys_id | sys_id do canal. Localizado na tabela Canais de serviço \[awa_service_channel\]. Tipo de dados: cadeia de caracteres |
| \<presence state\>.disable_inactivity_check | Sinalizador que indica se deve ser verificado se há inatividade deste estado de presença. Valores válidos: * verdadeiro: a verificação de inatividade do estado de presença está desabilitada. * falso: a verificação de inatividade do estado de presença está habilitada. {#awa-GET-presence_states__ul_alm_cjn_jtb} Tipo de dados: booliano Padrão: falso Para obter informações sobre como modificar essa configuração, consulte [Configurar estados de presença do agente](https://www.servicenow.com/docs/access?context=awa-configure-agent-presence&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US). |
| \<presence state\>.nome | Nome do estado de presença do agente. Os estados de presença instalados por padrão são Disponível, Ausentee Off-line . Tipo de dados: cadeia de caracteres |
| \<presence state\>.ordem | Ordem na qual esse estado é exibido na caixa de entrada do agente. Tipo de dados: número |
| \<presence state\>.mostrar_canais | Sinalizador que indica se o agente tem permissão para mudar o estado de presença, por exemplo, de disponível para ausente. Valores válidos: * verdadeiro: o usuário tem permissão para mudar a presença. * falso: o usuário está impedido de mudar a presença. {#awa-GET-presence_states__ul_qlh_xlh_jtb} Tipo de dados: booliano |
| \<presence state\>.sys_id | sys_id do estado de presença. Localizado na tabela Estados de presença \[awa_presence_state\]. 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 |
[ ]

{#awa-GET-presence_states__table_bgk_dmp_htb}  

### Amostra de solicitação cURL

O exemplo a seguir mostra como obter os estados de presença de um agente especificado.

    curl "https://instance.service-now.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666/presence_states" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

O corpo da resposta lista os possíveis estados de presença do agente e indica que o agente está disponível.

    {
      "result": [
        {
          "name": "Available",
          "order": 0,
          "show_channels": false,
          "sys_id": "0b10223c57a313005baaaa65ef94f970",
          "available": true,
          "channels": [
            {
              "name": "Chat",
              "available": true,
              "sys_id": "27f675e3739713004a905ee515f6a7c3",
              "restrict_update": false,
              "service_channel_type": "chat"
            }
          ],
          "disable_inactivity_check": false
        },
        {
          "name": "Away",
          "order": 1000,
          "show_channels": false,
          "sys_id": "41f9b8dfb31313005baa6e5f26a8dcac",
          "available": false,
          "channels": [],
          "disable_inactivity_check": false
        },
        {
          "name": "Offline",
          "order": 2000,
          "show_channels": false,
          "sys_id": "9cd83267575313005baaaa65ef94f98b",
          "available": false,
          "channels": [],
          "disable_inactivity_check": false
        }
      ]
    }

## AWA Agente - PUT /now/awa/agents/{user_id} {#ariaid-title5}

Define o estado de presença de um agente especificado e, se fornecido, define a disponibilidade do canal do agente para esse estado.

### Formato da URL {#awa-PUT-agents__section_qzs_ncm_cmb}

URL com controle de versões: /api/now/{api_version}/awa/agents/{user_id}

URL padrão: /api/now/awa/agents/{user_id}

### Parâmetros de solicitação compatíveis

{#awa-PUT-agents__entry__2}{#awa-PUT-agents__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| user_id | Sys_id do agente. Localizado na tabela Usuário \[sys_user\]. Tipo de dados: cadeia de caracteres |
[Tabela 20. Parâmetros de caminho]

{#awa-PUT-agents__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 21. Parâmetros de consulta]

{#awa-PUT-agents__entry__12}{#awa-PUT-agents__ph-presence_channels_sys_id-awa}{#awa-PUT-agents__ph-presence_sys_id-awa}

| Nome | Descrição |
|-|-|
| presença.canais | Lista de objetos que define quais canais estão disponíveis para o agente. Tipo de dados: matriz "channels": [ { "available": Boolean, "sys_id": "String" } ] |
| presença.canais.disponíveis | Sinalizador que indica se o canal está disponível. Valores possíveis: * verdadeiro: o canal está disponível. * falso: o canal não está disponível. {#awa-PUT-agents__ul_qps_xwl_cmb} Nota: Esta configuração deve ser especificada para incluir canais no corpo da resposta. Tipo de dados: booliano Padrão: falso |
| presença.canais.sys_id | sys_id do canal. Localizado na tabela Canais de serviço \[awa_service_channel\]. Tipo de dados: cadeia de caracteres |
| presença.sys_id | sys_id do estado de presença. Localizado na tabela Estados de presença \[awa_presence_state\]. Tipo de dados: cadeia de caracteres |
[Tabela 22. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#awa-PUT-agents__entry__22}{#awa-PUT-agents__accept-RESTAPI}{#awa-PUT-agents__content_type-RESTAPI}

| 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 23. Cabeçalhos da solicitação]

{#awa-PUT-agents__entry__28}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 24. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status 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 de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#awa-PUT-agents__entry__32}{#awa-PUT-agents__entry-200-status-code}{#awa-PUT-agents__entry-400-status-code}{#awa-PUT-agents__entry-401-status-code}{#awa-PUT-agents__entry-403-status-code-awa}{#awa-PUT-agents__entry-404-status-code}{#awa-PUT-agents__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 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.{#awa-PUT-agents__li-403-role} * 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 o Advanced Work Assignment](https://www.servicenow.com/docs/access?context=installed-with-awa&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).{#awa-PUT-agents__li-403-awa-disabled} {#awa-PUT-agents__ul_gch_n34_tsb} |
| 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. |
[Tabela 25. Códigos de status]

{#awa-PUT-agents__table_rcs_b2m_cmb__entry__2}{#awa-PUT-agents__awa-api-entry-error}{#awa-PUT-agents__awa-api-ph-error_detail}{#awa-PUT-agents__awa-api-ph-error_message}{#awa-PUT-agents__ph-presence-awa}{#awa-PUT-agents__ph-presence_available-awa}{#awa-PUT-agents__ph-presence_channels-awa}{#awa-PUT-agents__ph-presence_channels_avail-awa}{#awa-PUT-agents__ph-presence_channels_name-awa}{#awa-PUT-agents__d3393e405}{#awa-PUT-agents__ph-presence_name-awa}{#awa-PUT-agents__ph-presence_restrict_update-awa}{#awa-PUT-agents__d3393e465}{#awa-PUT-agents__awa-api-entry_status}{#awa-PUT-agents__ph-sys_id-awa}{#awa-PUT-agents__open-workItem_document-ph}{#awa-PUT-agents__open-workItem_document_sysid-ph}{#awa-PUT-agents__open-workItem_document_table-ph}{#awa-PUT-agents__open-workItem_previousWorkItem-ph}{#awa-PUT-agents__open-workItem_serviceChannel-ph}{#awa-PUT-agents__open-workItem_serviceChannel_name-ph}{#awa-PUT-agents__open-workItem_serviceChannel_sys_id-ph}{#awa-PUT-agents__open-workItem_size-ph}{#awa-PUT-agents__open-workItem_sysid-ph}{#awa-PUT-agents__open-workItem_isQueueTransferred-ph}

| Parâmetro | Descrição |
|-|-|
| erro | Detalhes que descrevem um erro encontrado durante o processo de solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processo de solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processo de solicitação. Cada mensagem de erro tem uma descrição correspondente na propriedade detail. Valores possíveis: * Registro não encontrado: as informações fornecidas no corpo da solicitação são imprecisas ou não existem. * Usuário não autenticado: o usuário não tem a função awa_integration_user. {#awa-PUT-agents__ul_om3_5sq_tsb} Tipo de dados: cadeia de caracteres |
| presença | Informações sobre o estado de presença atual e o canal de um agente. Tipo de dados: objeto "presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" } |
| presença.disponível | Sinalizador que indica se o agente está disponível. Valores possíveis: * verdadeiro: o agente está disponível. * falso: o agente não está disponível. {#awa-PUT-agents__ul_ezb_kwl_cmb} Tipo de dados: booliano |
| presença.canais | Lista de objetos que descreve os canais de comunicação disponíveis com o agente. Tipo de dados: matriz "channels": [ { "available": Boolean, "name": "String", "sys_id": "String" } ] |
| presença.canais.disponíveis | Sinalizador que indica se o canal está disponível. Valores possíveis: * verdadeiro: o canal está disponível. * falso: o canal não está disponível. {#awa-PUT-agents__d3393e342} Tipo de dados: booliano |
| presence.channels.name | Nome do canal, como Bate-papo ou Telefone. Tipo de dados: cadeia de caracteres |
| presença.canais.restrict_update | Sinalizador que indica se o usuário pode restringir atualizações, ou seja, selecionar o canal para disponibilidade. Valores possíveis: * verdadeiro: o usuário pode selecionar este canal para disponibilidade. * falso: o usuário não pode selecionar este canal para disponibilidade. {#awa-PUT-agents__ul_xjk_kn4_tsb} Tipo de dados: booliano |
| presença.canais.service_channel_type | Tipo de canal de serviço, como bate-papo. Os valores possíveis variam de acordo com os plug-ins instalados. Tipo de dados: cadeia de caracteres |
| presença.canais.sys_id | sys_id do canal. Localizado na tabela Canais de serviço \[awa_service_channel\]. Tipo de dados: cadeia de caracteres |
| presence.name | Nome do estado de presença do agente. Valores possíveis: * Disponível * Indisponível {#awa-PUT-agents__ul_mlm_mxl_cmb} Tipo de dados: cadeia de caracteres |
| presença.restrict_update | Sinalizador que indica se o usuário pode restringir atualizações. Valores possíveis: * verdadeiro: o usuário pode restringir atualizações. * falso: o usuário não pode restringir atualizações. {#awa-PUT-agents__ul_dfh_cxl_cmb} Tipo de dados: booliano |
| presença.sys_id | sys_id do estado de presença. Localizado na tabela Estados de presença \[awa_presence_state\]. 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 |
| sys_id | sys_id do agente. Tipo de dados: cadeia de caracteres |
| Item de trabalho | workItem: informações sobre o item de trabalho associado ao evento.{#awa-PUT-agents__open-workItem-p} |
| workItem.document | workItem.document: Lista de documentos associados à tarefa de item de trabalho. |
| workItem.document.sys_id | workItem.document.sys_id: Sys_id do documento atribuído à tarefa de item de trabalho. |
| workItem.document.table | workItem.document.table: Nome da tabela de documentos atribuída à tarefa. |
| workItem.previousWorkItem | workItem.previousWorkItem: Sys_id do item de trabalho anterior para o mesmo ID de documento. Para os itens de trabalho de não transferência, este valor está vazio. |
| workItem.serviceChannel | workItem.serviceChannel: Lista de canais de serviço associados à tarefa de item de trabalho. |
| workItem.serviceChannel.name | workItem.serviceChannel.name: Nome do canal de serviço, como Bate-papo ou Telefone. |
| workItem.serviceChannel.sys_id | workItem.serviceChannel.sys_id: Sys_id do canal de serviço. |
| workItem.size | workItem.size: capacidade do agente usada quando este item de trabalho é atribuído ao agente. |
| workItem.sys_id | workItem.sys_id: Sys_id do item de trabalho que foi aceito ou oferecido. |
| workItem.isQueueTransferred | workItem.isQueueTransferred: indica se o item de trabalho foi transferido para a fila. Defina como verdadeiro se o item de trabalho for transferido da fila e falso se não for. Para obter mais informações sobre transferências de fila, consulte [Transfer a chat to another queue](https://www.servicenow.com/docs/access?context=transfer-chat-queue&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). |
[Tabela 26. Parâmetros do corpo da resposta (JSON ou XML)]

{#awa-PUT-agents__table_rcs_b2m_cmb}  

    curl -X PUT \
     https://instance.servicenow.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666 \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -u 'username':'password'\
    -d '{"presence": {\
      "sys_id": "0b10223c57a313005baaaa65ef94f970",\
      "channels": [{ \
      "sys_id": "0bbdedbb3b892300a2bac9bb34efc445",\
      "available": true
    }] 
    }}

    {
      "result": {
        "presence": {
          "name": "Available",
          "sys_id": "0b10223c57a313005baaaa65ef94f970",
          "available": true,
          "channels": [
            {
              "name": "Chat",
              "available": true,
              "sys_id": "27f675e3739713004a905ee515f6a7c3"
            }
          ]
        },
        "sys_id": "46d44a23a9fe19810012d100cca80666"
      }
    }

## AWA Agente - PUT /now/awa/agents/{user_id}/capacities {#ariaid-title6}

Habilita a atualização da capacidade máxima (carga de trabalho) de um agente para capacidades de canal e capacidade universal.
Use o método [AWA Agente - GET /now/awa/agents/{user_id}/capacities](https://servicenow-prod.fluidtopics.net/vegVZBMCdsVv5Fh7ZY~twA#awa-GET-capacities "Retorna as capacidades do canal de um agente, a capacidade universal e a carga de trabalho atual para ver se o agente pode lidar com um caso.") para recuperar o canal atual e as capacidades universais de um agente.  
Consulte também:

* [Capacidade e utilização do canal de serviço](https://www.servicenow.com/docs/access?context=awa-service-channel-capacity&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* [Criar ou configurar um canal de serviço](https://www.servicenow.com/docs/access?context=awa-create-service-channel&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* [Configuração da capacidade universal máxima de um agente](https://www.servicenow.com/docs/access?context=awa-universal-capacity&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
{#awa-PUT-capacities__ul_rl1_2wg_jtb}

### Formato da URL {#awa-PUT-capacities__section_hsf_jvl_cmb}

URL com controle de versão: /api/now/{api_version}/awa/agents/{user_id}/capacities

URL padrão: /api/now/awa/agents/{user_id}/capacities

### Parâmetros de solicitação compatíveis

{#awa-PUT-capacities__entry__2}{#awa-PUT-capacities__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| user_id | Sys_id do agente listado na tabela Usuário \[sys_user\]. Tipo de dados: cadeia de caracteres |
[Tabela 27. Parâmetros de caminho]

{#awa-PUT-capacities__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 28. Parâmetros de consulta]

{#awa-PUT-capacities__entry__12}

| Nome | Descrição |
|-|-|
| canais | Obrigatório ao atualizar o valor máximo de um ou mais canais para o agente especificado. Objeto JSON que contém um ou mais pares de chave-valor que mapeiam o canal até sua capacidade máxima para cada canal atribuído ao agente. Tipo de dados: objeto O par está no seguinte formato: * Chave (sys_id do canal) -- sys_id do canal. Localizado na tabela Canais de serviço \[awa_service_channel\]. Tipo de dados: cadeia de caracteres * Valor (capacidade máxima) -- A carga de trabalho máxima em um canal de serviço específico ao qual o agente pode ser ativamente atribuído de cada vez. Tipo de dados: número {#awa-PUT-capacities__ul_e35_r3g_jtb} channels: {"<channel_sys_id>": <max_capacity>} |
| capacidade_universal | Obrigatório se a capacidade universal estiver sendo atualizada. Capacidade máxima para o agente em todos os canais de serviço. Se a carga de trabalho atual de um agente for igual à capacidade universal máxima, itens de trabalho adicionais não serão atribuídos ao agente. Tipo de dados: número |
[Tabela 29. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#awa-PUT-capacities__entry__18}{#awa-PUT-capacities__accept-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 30. Cabeçalhos da solicitação]

{#awa-PUT-capacities__entry__22}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 31. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status 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 de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#awa-PUT-capacities__entry__26}{#awa-PUT-capacities__entry-200-status-code}{#awa-PUT-capacities__entry-400-status-code}{#awa-PUT-capacities__entry-404-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 404 | Não encontrado. O item solicitado não foi encontrado. |
[Tabela 32. Códigos de status]

### Parâmetros do corpo da resposta (JSON ou XML) {#awa-PUT-capacities__section_agk_dmp_htb}

{#awa-PUT-capacities__table_bgk_dmp_htb__entry__2}{#awa-PUT-capacities__ph-presence_channels_sys_id-awa}{#awa-PUT-capacities__ordr-row-error}{#awa-PUT-capacities__awa-api-ph-universal_capacity}

| Nome | Descrição |
|-|-|
| canais | Lista de objetos que descreve os canais de comunicação disponíveis com o agente. "channels": [ { "channel_sys_id": "String", "max_capacity": Number } ] Tipo de dados: matriz |
| canais.channel_sys_id | sys_id do canal. Localizado na tabela Canais de serviço \[awa_service_channel\]. Tipo de dados: cadeia de caracteres |
| canais.max_capacity | A carga de trabalho máxima em um canal de serviço específico ao qual o agente pode ser ativamente atribuído de cada vez. Tipo de dados: cadeia de caracteres |
| erro | Detalhes que descrevem um erro encontrado durante o processo de solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processo de solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processo de solicitação. A descrição é fornecida na propriedade error.detail. 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 |
| capacidade_universal | Capacidade máxima para o agente em todos os canais de serviço. Se a carga de trabalho atual de um agente for igual à capacidade universal máxima, itens de trabalho adicionais não serão atribuídos ao agente. Esta propriedade só será retornada se houver um registro de capacidade universal para este agente. Tipo de dados: número |
[ ]

{#awa-PUT-capacities__table_bgk_dmp_htb}  

### Amostra de solicitação cURL

O exemplo a seguir mostra como alterar a capacidade universal do agente e a capacidade máxima de um canal especificado.

    curl "https://instance.service-now.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666/capacities" \
    --request PUT \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
     \"channels\": { \"27f675e3739713004a905ee515f6a7c3\": 6 },
     \"universal_capacity\" : 12
    }" \
    --user 'username':'password'

Uma resposta bem-sucedida inclui os valores de capacidade atualizados.

    {
      "result": {
        "channels": [
          {
            "channel_sys_id": "27f675e3739713004a905ee515f6a7c3",
            "max_capacity": 6
          }
        ],
        "universal_capacity": 12
      }
    }