---
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 ActivitySubscriptions

# API ActivitySubscriptions {#ariaid-title1}

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

A API ActivitySubscriptions fornece endpoints para recuperar entidades de atividade da Estrutura de assinaturas e feed de atividades.
Esta API requer a ativação do plug-in Assinaturas e estrutura de feed de atividades (com.snc.activity_subscriptions). Ative o plug-in Central do cliente (com.sn_csm_customer_central) para propagar a configuração em todas as tabelas necessárias. Para obter mais informações sobre as definições de configuração da Central do cliente, consulte [Configuração da Central do cliente](https://www.servicenow.com/docs/access?context=configure-customer-central&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US).

## Assinaturas de atividade - GET /now/actsub/activities {#ariaid-title2}

Recupera registros de atividades da estrutura de assinaturas e feed de atividades.
Nenhuma função é necessária para acessar este endpoint, mas os dados retornados são limitados pelas configurações de acesso do usuário.

### Formato da URL

URL com controle de versão: /api/now/{api_version}/actsub/activities

URL padrão: /api/now/actsub/activities

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

{#actsub-GET-activities__entry__2}{#actsub-GET-activities__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 |
[Tabela 1. Parâmetros de caminho]

{#actsub-GET-activities__entry__6}{#actsub-GET-activities__end-date-query-param-entry}{#actsub-GET-activities__start-date-query-param-entry}

| Nome | Descrição |
|-|-|
| antes | Valor de data/hora. A solicitação retorna somente registros criados antes desta data e hora. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss ou AAAA-MM-DD |
| contexto | Obrigatório. Sys_id de um contexto de atividade. Localizado na tabela Contexto de atividades \[sn_actsub_activity_context\]. Os contextos de atividade predefinidos incluem Consumidor e Contato. Tipo de dados: cadeia de caracteres |
| contexto_instance | Obrigatório. Sys_id de uma instância do contexto de atividade especificado, representando o iniciador das atividades que você deseja recuperar. Localizado na tabela apropriada para o contexto da atividade. Por exemplo, se você definir context como o sys_id do contexto de atividade do consumidor, defina este parâmetro como o sys_id do registro da tabela Consumidor \[csm_consumer\] do consumidor cujas atividades você deseja recuperar. Tipo de dados: cadeia de caracteres |
| end_date | Valor de data/hora. A solicitação retorna somente registros criados durante o período definido por start_date e este parâmetro. Deve ser definido junto com start_date. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss ou AAAA-MM-DD |
| aspectos | Lista separada por vírgulas de sys_ids de tipos de aspecto de atividade a serem recuperados para o contexto de atividade especificado. Esses sys_ids estão localizados na tabela Aspecto de atividade \[sn_actsub_facet\]. Para obter mais detalhes sobre aspectos de atividade, consulte [Criação de aspectos para contextos de atividade](https://www.servicenow.com/docs/access?context=create-facet-customer-central&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Padrão: retorna todos os tipos de aspecto de atividade configurados para o contexto de atividade. |
| último | Valor de índice da primeira linha de resultado omitido do corpo da resposta. O índice de linha de resultado começa em 0, portanto, a última linha incluída no corpo da resposta é aquela com o índice last-1. Por exemplo, definir `last=5` omite linhas com índice 5 e acima e retorna no máximo somente as primeiras cinco linhas de resultado (com valores de índice de 0 a 4). Definir `stFrom=1` e `last=5` ignora a primeira linha de resultado e retorna da segunda à quinta linhas de resultado (com valores de índice de 1 a 4). Tipo de dados: número (inteiro) Padrão: o valor da propriedade do sistema com.snc.actsub.activities.api.fetch.limit (10 por padrão). |
| record_id | Sys_id de um registro a ser usado ao renderizar aspectos dinâmicos. Localizado na tabela apropriada para o tipo de atividade que você deseja recuperar. Por exemplo, se você quiser buscar atividades para um registro de caso, defina este parâmetro como o sys_id do registro de caso em questão. Para obter mais detalhes sobre aspectos dinâmicos, consulte [Criar aspectos para contextos de atividade](https://www.servicenow.com/docs/access?context=create-facet-customer-central&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres |
| start_date | Valor de data/hora. A solicitação retorna somente registros criados durante o período definido por este parâmetro e end_date. Deve ser definido junto com end_date. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss ou AAAA-MM-DD |
| stDe | Valor de índice da primeira linha de resultado a ser incluída no corpo da resposta. O índice de linha de resultado começa em 0. Por exemplo, `stFrom=2` ignora as duas primeiras linhas de resultado e retorna resultados da terceira linha em diante. Tipo de dados: número (inteiro) Padrão: 0 |
[Tabela 2. Parâmetros de consulta]

{#actsub-GET-activities__entry__26}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[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.").
{#actsub-GET-activities__entry__30}{#actsub-GET-activities__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 4. Cabeçalhos da solicitação]

{#actsub-GET-activities__entry__34}

| 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.").
{#actsub-GET-activities__entry__38}{#actsub-GET-activities__entry-200-status-code}{#actsub-GET-activities__entry-400-status-code}{#actsub-GET-activities__entry-401-status-code}{#actsub-GET-activities__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. O parâmetro do corpo da resposta result.message descreve a natureza do erro. Exemplo de mensagens de erro: * Certifique-se de que um contexto e um context_instance válidos sejam passados ou Certifique-se de que um fluxo e um usuário válidos sejam passados indica que a solicitação não tem um ou ambos os parâmetros de consulta context e context_instance. Esses parâmetros são necessários. * stFrom não pode ser maior que o último indica que o valor do parâmetro de consulta stFrom excede o valor do parâmetro de consulta last. * Forneça start_date e end_date indica que a solicitação inclui apenas um dos parâmetros de consulta start_date e end_date, que não podem ser usados separadamente. * start_date não pode estar à frente de end_date indica que o valor do parâmetro de consulta start_date especificado ocorre após o valor do parâmetro de consulta end_date especificado. * Se o contexto fornecido não estiver configurado no sistema, isso indica que o valor do parâmetro de consulta context não representa um contexto de atividade válido. * Certifique-se de que um context_instance válido seja passado indica que o valor do parâmetro de consulta context_instance não representa uma instância válida do contexto de atividade especificado. {#actsub-GET-activities__ul_cvl_5c4_ylb} |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 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)

{#actsub-GET-activities__entry__48}

| Nome | Descrição |
|-|-|
| resultado | Objeto de resultado. Tipo de dados: objeto "result": { "activities": [Array], "message": "String", "status": Number, "stream": "String", "user": "String" } |
| resultado.atividades | Matriz de objetos na qual cada objeto representa um registro de atividade do contexto de atividade e instância de contexto especificados. Tipo de dados: matriz de objetos "activities": [ { "activity_type_id": "String", "content_fields": [Array], "created": "String", "icon": "String", "source_table_name": "String", "subheader_fields": [Array], "subobject_sys_id": "String", "subobject_table_name": "String", "sys_id": "String", "title": "String" } ] |
| result.activities.activity_type_id | Sys_id do registro da tabela Tipos de atividade \[sn_actsub_activity_type\] que corresponde ao tipo deste registro de atividade. Tipo de dados: cadeia de caracteres |
| result.activities.content_fields | Matriz de objetos na qual cada objeto representa um campo a ser exibido como conteúdo no bloco do registro de atividade. Tipo de dados: matriz de objetos "content_fields": [ { "deeplink_to_subobject": "String", "display_as_timeago": "String", "label": "String", "show_label": "String", "type": "String", "value": "String" } ] |
| result.activities.content_fields.deeplink_to_subobject | Sinalizador que indica se o campo de conteúdo é exibido ou não como um hiperlink para o registro do objeto no qual esta atividade foi realizada. Valores válidos: * verdadeiro: o campo de conteúdo é exibido como um hiperlink para o registro do objeto no qual esta atividade foi realizada. * falso: o campo de conteúdo é exibido como um hiperlink para o registro do objeto no qual esta atividade foi realizada. {#actsub-GET-activities__ul_ej4_bj4_ylb} Tipo de dados: cadeia de caracteres |
| result.activities.content_fields.display_as_timeago | Sinalizador que indica se o campo de conteúdo é exibido ou não no formato de tempo anterior. Valores válidos: * verdadeiro: o campo de conteúdo é exibido no formato de tempo anterior. * falso: o campo de conteúdo não é exibido no formato de tempo anterior. {#actsub-GET-activities__ul_kj4_bj4_ylb} Tipo de dados: cadeia de caracteres |
| resultado.atividades.campos_de_conteúdo.rótulo | Rótulo para o campo de conteúdo. Tipo de dados: cadeia de caracteres |
| result.activities.content_fields.show_label | Sinalizador que indica se o rótulo do campo de conteúdo será exibido para valores de campo de conteúdo no bloco deste registro de atividade. Valores válidos: * verdadeiro: o rótulo do campo de conteúdo é exibido para valores de campo de conteúdo no bloco deste registro de atividade. * falso: o rótulo do campo de conteúdo não é exibido para valores de campo de conteúdo no bloco deste registro de atividade. {#actsub-GET-activities__ul_sj4_bj4_ylb} Tipo de dados: cadeia de caracteres |
| result.activities.content_fields.type | Tipo do campo de conteúdo. Tipo de dados: cadeia de caracteres |
| result.activities.content_fields.value | Valor do campo de conteúdo. Tipo de dados: cadeia de caracteres |
| resultado.atividades.criadas | Data/hora de criação deste registro de atividade. Tipo de dados: cadeia de caracteres Formato: AAAA-DD-MM hh:mm:ss |
| ícone.atividades.resultado | Nome do ícone exibido no bloco deste registro de atividade. Tipo de dados: cadeia de caracteres |
| result.activities.source_table_name | Nome da tabela na qual este registro de atividade está localizado. Determinado pela origem da atividade definida na tabela Tipos de atividade \[sn_actsub_activity_type\] para o tipo associado a este registro de atividade. Tipo de dados: cadeia de caracteres |
| result.activities.subheader_fields | Matriz de objetos em que cada objeto representa um campo exibido no subcabeçalho do bloco para este registro de atividade. Tipo de dados: matriz de objetos "subheader_fields": [ { "deeplink_to_subobject": "String", "display_as_timeago": "String", "label": "String", "show_label": "String", "type": "String", "value": "String" } ] |
| result.activities.subheader_fields.deeplink_to_subobject | Sinalizador que indica se o campo de subcabeçalho é exibido ou não como um hiperlink para o registro do objeto no qual esta atividade foi realizada. Valores válidos: * verdadeiro: o campo de subcabeçalho é exibido como um hiperlink para o registro do objeto no qual esta atividade foi realizada. * falso: o campo de subcabeçalho não é exibido como um hiperlink para o registro do objeto no qual esta atividade foi realizada. {#actsub-GET-activities__ul_ppz_534_ylb} Tipo de dados: cadeia de caracteres |
| result.activities.subheader_fields.display_as_timeago | Sinalizador que indica se o campo de subcabeçalho é exibido ou não no formato de tempo anterior. Valores válidos: * verdadeiro: o campo de subcabeçalho é exibido no formato de tempo anterior. * falso: o campo de subcabeçalho não é exibido no formato de tempo anterior. {#actsub-GET-activities__ul_oqv_y34_ylb} Tipo de dados: cadeia de caracteres |
| resultado.atividades.subcabeçalho_campos.rótulo | Rótulo para o campo de subcabeçalho. Tipo de dados: cadeia de caracteres |
| result.activities.subheader_fields.show_label | Sinalizador que indica se o rótulo do campo de subcabeçalho é exibido ou não para valores de campo de subcabeçalho no bloco deste registro de atividade. Valores válidos: * verdadeiro: o rótulo do campo de subcabeçalho é exibido para valores de campo de subcabeçalho no bloco deste registro de atividade. * falso: o rótulo do campo de subcabeçalho não é exibido para valores de campo de subcabeçalho no bloco deste registro de atividade. {#actsub-GET-activities__ul_iws_q34_ylb} Tipo de dados: cadeia de caracteres |
| result.activities.subheader_fields.type | Tipo do campo de subcabeçalho. Tipo de dados: cadeia de caracteres |
| result.activities.subheader_fields.value | Valor do campo de subcabeçalho. Tipo de dados: cadeia de caracteres |
| result.activities.subobject_sys_id | Sys_id do registro do objeto no qual esta atividade foi realizada. Localizado na tabela especificada no valor do parâmetro subobject_table_name. Tipo de dados: cadeia de caracteres |
| result.activities.subobject_table_name | Nome da tabela que contém o registro do objeto no qual esta atividade foi realizada. Determinado pelo Nome da tabela definido na tabela Grupo de atividades \[sn_actsub_subscribable_object\] para o grupo que contém o tipo de atividade associado a este registro de atividade. Tipo de dados: cadeia de caracteres |
| resultado.atividades.sys_id | Sys_id deste registro de atividade. Localizado na tabela especificada como o valor de parâmetro do corpo da resposta source_table_name. Tipo de dados: cadeia de caracteres |
| resultado.atividades.título | Título exibido no bloco deste registro de atividade. Tipo de dados: cadeia de caracteres |
| resultado.temMaisRegistros | Sinalizador que indica se a lista de atividades no corpo da resposta está truncada ou não pelo valor do parâmetro de consulta last. Valores válidos: * verdadeiro: a lista de atividades no corpo da resposta é truncada pelo valor do parâmetro de consulta last. Repetir a solicitação com um valor de parâmetro de consulta last mais alto retornará atividades adicionais para este contexto e instância de contexto. * falso: a lista de atividades no corpo da resposta não é truncada pelo valor do parâmetro de consulta last. Não há outras atividades disponíveis para este contexto e instância de contexto. {#actsub-GET-activities__ul_x24_sf4_ylb} Tipo de dados: cadeia de caracteres |
| resultado.mensagem | Mensagem de erro que descreve o problema encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| resultado.status | Código de status HTTP retornado para solicitação. Valores válidos: consulte Códigos de status. Tipo de dados: número |
| resultado.fluxo | Sys_id especificado no parâmetro de consulta request context. Localizado na tabela Contexto de atividades \[sn_actsub_activity_context\]. Tipo de dados: cadeia de caracteres |
| resultado.usuário | Sys_id especificado no parâmetro de consulta request context_instance. Localizado na tabela apropriada para o contexto da atividade. Tipo de dados: cadeia de caracteres |
[ ]

### Solicitação de cURL

Solicite o segundo e o terceiro registros de atividade para um contato específico, limitando-se aos dados de 2020:

    curl "https://instance.servicenow.com/api/now/actsub/activities\
    ?context=4a6a035a73d30010e37d71ef64f6a714\
    &context_instance=ddce70866f9331003b3c498f5d3ee417\
    &stFrom=1&last=3\
    &start_date=2020-01-01%2000:00:00&end_date=2020-12-31%2023:59:59" \
    --request GET \
    --header "Accept: application/json" \
    --user "username:password"

O corpo da resposta inclui os dois registros de atividade solicitados para o contato especificado:

    {
      "result": {
        "hasMoreRecords": true,
        "activities": [
          {
            "subobject_table_name": "sn_customerservice_case",
            "source_table_name": "sn_customerservice_case",
            "content_fields": [
              {
                "value": "Test",
                "show_label": "false",
                "type": "string",
                "label": "Short description",
                "display_as_timeago": "false",
                "deeplink_to_subobject": "false"
              }
            ],
            "created": "2020-05-29 18:42:16",
            "activity_type_id": "baf0aace73530010e37d71ef64f6a748",
            "title": "Lamar Wilson created case",
            "subobject_sys_id": "1687360e8d819010f87705a074e52ac9",
            "icon": "clipboard_outline",
            "sys_id": "1687360e8d819010f87705a074e52ac9",
            "subheader_fields": [
              {
                "value": "CS0001007",
                "show_label": "false",
                "type": "string",
                "label": "Number",
                "display_as_timeago": "false",
                "deeplink_to_subobject": "true"
              },
              {
                "value": "2020-05-29 18:42:16",
                "show_label": "false",
                "type": "glide_date_time",
                "label": "Created",
                "display_as_timeago": "true",
                "deeplink_to_subobject": "false"
              },
              {
                "value": "",
                "show_label": "false",
                "type": "reference",
                "label": "Assigned to",
                "display_as_timeago": "false",
                "deeplink_to_subobject": "false"
              },
              {
                "value": "Lamar Wilson",
                "show_label": "false",
                "type": "reference",
                "label": "Contact",
                "display_as_timeago": "false",
                "deeplink_to_subobject": "false"
              }
            ]
          },
          {
            "subobject_table_name": "kb_knowledge",
            "source_table_name": "kb_use",
            "content_fields": [
              {
                "value": "How to Set Up a Broadband Router",
                "show_label": "false",
                "type": "string",
                "label": "Short description",
                "display_as_timeago": "false",
                "deeplink_to_subobject": "false"
              }
            ],
            "created": "2020-05-26 10:00:00",
            "activity_type_id": "4a8c329273d30010e37d71ef64f6a7c1",
            "title": "Lamar Wilson viewed knowledge article",
            "subobject_sys_id": "f855a0a89f011200550bf7b6077fcf4f",
            "icon": "document_outline",
            "sys_id": "b929dd5873941010e37d71ef64f6a719",
            "subheader_fields": [
              {
                "value": "KB0000110",
                "show_label": "false",
                "type": "string",
                "label": "Number",
                "display_as_timeago": "false",
                "deeplink_to_subobject": "true"
              },
              {
                "value": "2020-05-26 10:00:00",
                "show_label": "false",
                "type": "glide_date_time",
                "label": "Created",
                "display_as_timeago": "true",
                "deeplink_to_subobject": "false"
              }
            ]
          }
        ]
      }
    }

## Assinaturas de atividade - GET /now/actsub/facets/{activity_context}/{context_instance} {#ariaid-title3}

Recupera aspectos configurados para um contexto de atividade da Estrutura de assinaturas e feed de atividades. Exibe contagens de atividades e dados para cada aspecto conforme determinado pelo tipo de atividade, grupo e configurações de contexto.
Os usuários devem ter a função admin ou admin para acessar este endpoint. Os dados retornados são limitados pelas configurações de acesso do usuário.

Para obter mais detalhes sobre aspectos de contexto de atividade, consulte [Criação de aspectos para contextos de atividade](https://www.servicenow.com/docs/access?context=create-facet-customer-central&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US).

### Formato da URL

URL com controle de versão: /api/now/{api_version}/actsub/facets/{activity_context}/{context_instance}

URL padrão: /api/now/actsub/facets/{activity_context}/{context_instance}

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

{#actsub-GET-facets__entry__2}{#actsub-GET-facets__version-RESTAPI}

| Nome | Descrição |
|-|-|
| atividade_contexto | Sys_id de um contexto de atividade. Localizado na tabela Contextos de atividades \[sn_actsub_activity_context\]. Os contextos de atividade predefinidos incluem Consumidor e Contato. Navegar até Central do clienteAtividade do ClienteContextos de Atividades para exibir a lista completa de contextos de atividade definidos para sua instância. Tipo de dados: cadeia de caracteres |
| 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 |
| contexto_instance | Sys_id de uma instância do contexto de atividade especificado, representando o iniciador das atividades para as quais você deseja recuperar aspectos. Localizado na tabela de contexto especificada para o registro de contexto de atividade na tabela Contextos de atividade \[sn_actsub_activity_context\]. Por exemplo, se você definir activity_context como o sys_id do contexto de atividade de Contato, deverá definir este parâmetro como o sys_id do registro de Contato \[customer_contact\] do contato cujas facetas de atividade você deseja recuperar. Tipo de dados: cadeia de caracteres |
[Tabela 7. Parâmetros de caminho]

{#actsub-GET-facets__entry__10}{#actsub-GET-facets__end-date-query-param-entry}{#actsub-GET-facets__start-date-query-param-entry}

| Nome | Descrição |
|-|-|
| end_date | Valor de data/hora. A solicitação retorna somente registros criados durante o período definido por start_date e este parâmetro. Deve ser definido junto com start_date. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss ou AAAA-MM-DD |
| aspectos | Lista separada por vírgulas de sys_ids de aspectos de atividade a serem recuperados para o contexto de atividade especificado. Para ver os tipos de aspecto de atividade definidos para um contexto de atividade, navegue até Central do clienteAtividade do ClienteContextos de Atividades e examine a lista relacionada de Aspectos. Tipo de dados: cadeia de caracteres Padrão: retorne todos os aspectos de atividade configurados para o contexto de atividade. |
| get_activity_count | Sinalizador que indica se as contagens de atividades devem ser incluídas ou não para cada aspecto no corpo da resposta. Valores válidos: * verdadeiro: inclui contagens de atividades de aspecto. * falso: omita contagens de atividades de aspecto. {#actsub-GET-facets__ul_zw1_y5n_ylb} Tipo de dados: booliano Padrão: falso |
| carga_lenta | Sinalizador que indica se o desempenho deve ser melhorado ou não, omitindo dados de atividade de aspecto e contagens de atividade do corpo da resposta. Este parâmetro tem precedência sobre get_activity_count. Valores válidos: * verdadeiro: omita os dados de atividade de aspecto e as contagens de atividades. * falso: recuperar dados de atividade de aspecto e contagens de atividade. {#actsub-GET-facets__ul_ph3_kvn_ylb} Tipo de dados: booliano Padrão: falso |
| start_date | Valor de data/hora. A solicitação retorna somente registros criados durante o período definido por este parâmetro e end_date. Deve ser definido junto com end_date. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss ou AAAA-MM-DD |
[Tabela 8. Parâmetros de consulta]

{#actsub-GET-facets__entry__22}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 9. 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.").
{#actsub-GET-facets__entry__26}{#actsub-GET-facets__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 10. Cabeçalhos da solicitação]

{#actsub-GET-facets__entry__30}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 11. 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.").
{#actsub-GET-facets__entry__34}{#actsub-GET-facets__entry-200-status-code}{#actsub-GET-facets__entry-400-status-code}{#actsub-GET-facets__entry-401-status-code}{#actsub-GET-facets__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. O parâmetro do corpo da resposta result.message descreve a natureza do erro. Exemplo de mensagens de erro: * Certifique-se de que detalhes de contexto de atividade válidos sejam passados indica que o valor do parâmetro de caminho activity_context não representa um contexto de atividade válido, o valor do parâmetro de caminho context_instance não representa uma instância válida do contexto de atividade especificado ou ambos. * Forneça start_date e end_date indica que a solicitação inclui apenas um dos parâmetros de consulta start_date e end_date, que não podem ser usados separadamente. * start_date não pode estar à frente de end_date indica que o valor do parâmetro de consulta start_date especificado ocorre após o valor do parâmetro de consulta end_date especificado. {#actsub-GET-facets__ul_cvl_5c4_ylb} |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 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 12. Códigos de status]

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

{#actsub-GET-facets__entry__44}

| Nome | Descrição |
|-|-|
| resultado | Lista de aspectos de atividade. Tipo de dados: matriz de objetos "result": [ { "activity_count": Number, "children": [Array], "facets": [Array], "icon": "String", "is_dynamic": "String", "message": "String", "name": "String", "status": Number } ] |
| resultado.contagem_de_atividades | Número de registros de atividade incluídos neste aspecto (e seus secundários, se houver). Exibido somente quando o parâmetro de consulta lazy_load é falso e o parâmetro de consulta get_activity_count é verdadeiro. Tipo de dados: número |
| resultado.filhos | Matriz de objetos na qual cada objeto representa um registro de atividade (se for um aspecto dinâmico) ou um aspecto secundário (se for um aspecto estático). Tipo de dados: matriz de objetos "children": [ { "activity_count": Number "facet": "String", "icon": "String", "title": "String" } ] |
| result.children.activity_count | Número de registros de atividade incluídos neste aspecto secundário (e seus secundários, se houver). Exibido somente quando o parâmetro de consulta lazy_load é falso e o parâmetro de consulta get_activity_count é verdadeiro. Tipo de dados: número |
| resultado.filhos.criados | Data/hora de criação deste registro de atividade. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss |
| resultado.filhos.faceta | Sys_id deste registro de aspecto secundário. Localizado na tabela Aspecto de atividade \[sn_actsub_facet\]. Tipo de dados: cadeia de caracteres |
| ícone.resultado.filhos | Nome do ícone associado a este aspecto secundário. Tipo de dados: cadeia de caracteres |
| result.children.sys_id | Sys_id deste registro de atividade. Localizado na tabela apropriada para o tipo de aspecto primário. Por exemplo, um registro de atividade incluído na faceta Casos tem um sys_id localizado na tabela Caso \[sn_customerservice_case\]. Tipo de dados: cadeia de caracteres |
| resultado.filhos.metadados | Matriz de objetos em que cada objeto inclui dados de registro de atividade para um campo de aspecto configurado no registro da tabela Aspecto de atividade \[sn_actsub_facet\] para este tipo de aspecto. Tipo de dados: matriz de objetos "metadata": [ { "key": "String", "label": "String", "type": "String", "value": "String" } ] |
| result.children.metadata.key | Nome deste campo de aspecto. Tipo de dados: cadeia de caracteres |
| resultado.crianças.metadados.rótulo | Rótulo deste campo de aspecto. Tipo de dados: cadeia de caracteres |
| result.children.metadata.type | Tipo deste campo de aspecto. Tipo de dados: cadeia de caracteres |
| result.children.metadata.value | Valor deste campo de aspecto. Tipo de dados: cadeia de caracteres |
| resultado.filhos.título | Nome deste registro de atividade ou aspecto secundário. Tipo de dados: cadeia de caracteres |
| result.facets | Matriz de sys_ids associada a este registro de aspecto. Localizado na tabela Aspecto de atividade \[sn_actsub_facet\]. Para um aspecto dinâmico, esta matriz contém o sys_id do próprio aspecto. Para um aspecto estático, ele contém os sys_ids de todos os aspectos que são secundários do aspecto. Tipo de dados: matriz "facets": [ "510d7e2e73570010e37d71ef64f6a70d", "bc9bfaaa73570010e37d71ef64f6a771" ] |
| ícone.resultado | Nome do ícone associado a este aspecto. Tipo de dados: cadeia de caracteres |
| resultado.é_dinâmico | Sinalizador que indica se este aspecto é dinâmico ou não. Este valor determina o tipo de informações incluídas no parâmetro de corpo de resposta children. Valores possíveis: * verdadeiro: este é um aspecto dinâmico. O valor do parâmetro do corpo da resposta children contém detalhes do registro de atividade e o parâmetro facets contém o aspecto dinâmico sys_id. * falso: este é um aspecto estático (um grupo de aspectos). O valor do parâmetro do corpo da resposta children contém aspectos secundários e o parâmetro facets contém os sys_ids desses aspectos secundários. {#actsub-GET-facets__ul_atr_gnv_ylb} Tipo de dados: booliano |
| resultado.mensagem | Mensagem de erro descrevendo o problema encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| result.name | Nome da faceta ou do grupo de facetas. Tipo de dados: cadeia de caracteres |
| resultado.status | Código de status HTTP retornado para solicitação. Valores possíveis: consulte a tabela Código de status. Tipo de dados: número |
[ ]

### Solicitação de cURL

Recuperar aspectos e contagens de atividades de artigos de bate-papo, telefone e conhecimento de um contato:

    curl "https://instance.servicenow.com/api/now/actsub/facets/4a6a035a73d30010e37d71ef64f6a714/ddce70866f9331003b3c498f5d3ee417\
    ?get_activity_count=true\
    &facets=510d7e2e73570010e37d71ef64f6a70d,bc9bfaaa73570010e37d71ef64f6a771,c72d7e2e73570010e37d71ef64f6a7b8" \
    --request GET \
    --header "Accept: application/json" \
    --user "username:password"

O corpo da resposta inclui os três aspectos solicitados como secundários de seus grupos de aspectos, com as contagens de atividades exibidas:

    {
      "result": [
        {
          "is_dynamic": false,
          "name": "Interactions",
          "activity_count": 4.0,
          "facets": [
            "510d7e2e73570010e37d71ef64f6a70d",
            "bc9bfaaa73570010e37d71ef64f6a771"
          ],
          "children": [
            {
              "facet": "510d7e2e73570010e37d71ef64f6a70d",
              "icon": "chat_outline",
              "activity_count": 2.0,
              "title": "Chat"
            },
            {
              "facet": "bc9bfaaa73570010e37d71ef64f6a771",
              "icon": "phone_outline",
              "activity_count": 2.0,
              "title": "Phone"
            }
          ]
        },
        {
          "is_dynamic": false,
          "name": "Portal Activity",
          "activity_count": 5.0,
          "facets": [
            "c72d7e2e73570010e37d71ef64f6a7b8"
          ],
          "children": [
            {
              "facet": "c72d7e2e73570010e37d71ef64f6a7b8",
              "icon": "document_outline",
              "activity_count": 5.0,
              "title": "Knowledge articles"
            }
          ]
        }
      ]
    }