API ActivitySubscriptions

Referência de API Zurich

Release

zurich

ft:locale

pt-BR

ft:publication_title

Referência de API Zurich

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

API ActivitySubscriptions

Versão de lançamento: Zurich

Atualizado 31 de jul. de 2025

18 min. de leitura

. ActivitySubscriptions A API fornece endpoints para recuperar entidades de atividade da Estrutura de assinaturas e feed de atividades.

Esta API requer a ativação do plug-in Subscriptions and Activity Feed Framework (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 Configurar Central do cliente .

ActivitySubscriptions - OBTER /now/actsub/activities

Recupera registros de atividade da estrutura 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 de URL

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

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

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

Tabela 2. Parâmetros de consulta
Nome	Descrição
antes	Valor de data/hora. A solicitação retorna somente registros criados antes dessa 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. Os contextos de atividade predefinidos incluem Consumidor e Contato. Tipo de dados: Cadeia de caracteres Tabela: Contexto de atividade [sn_actsub_activity_context]
context_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 de atividade. Por exemplo, se você definir contextPara o sys_id do contexto de atividade do consumidor, defina este parâmetro como o sys_id do registro da tabela Consumidor [csm_consumer] para o 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_datee 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. Para obter mais detalhes sobre aspectos da atividade, consulte Crie aspectos para contextos de atividade . Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os tipos de aspecto de atividade configurados para o contexto de atividade. Tabela: Aspecto de atividade [sn_actsub_aspecto]
último	Valor de índice da primeira linha de resultado omitido do corpo da resposta. O índice de linha do resultado começa em 0, portanto, a última linha incluída no corpo da resposta é aquela com o índice last-1. Por exemplo, configuração `último: 5` omite linhas com índice 5 e superior e retorna no máximo somente as cinco primeiras linhas de resultado (com valores de índice de 0 a 4). Configuração `De 1` e. `último: 5` ignora a primeira linha de resultado e retorna da segunda à quinta linha de resultado (com valores de índice de 1 a 4). Tipo de dados: Número (inteiro) Padrão: O valor de com.snc.actsub.activities.api.fetch.limit propriedade do sistema (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 Crie aspectos para contextos de atividade . 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
De	Valor de índice da primeira linha de resultado a ser incluída no corpo da resposta. O índice da linha do resultado começa em 0. Por exemplo, `De 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 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. O corpo da resposta result.messageo parâmetro descreve a natureza do erro. Exemplo de mensagens de erro: `Um contexto válido e context_instance são passados` ou `Um fluxo e um usuário válidos foram aprovados` indica que a solicitação não tem um ou ambos contexte. context_instanceparâmetros de consulta. Esses parâmetros são obrigatórios. `StFrom não pode ser maior do que o último` indica que stFromo valor do parâmetro de consulta excede lastvalor do parâmetro de consulta. `Forneça start_date e end_date` indica que a solicitação inclui apenas um dos start_datee. end_dateparâmetros de consulta, que não podem ser usados separadamente. `start_date não pode ser anterior a end_date` indica que o foi especificado start_dateo valor do parâmetro de consulta ocorre após o especificado end_datevalor do parâmetro de consulta. `O contexto informado não está configurado no sistema` indica que contexto valor do parâmetro de consulta não representa um contexto de atividade válido. `Um context_instance válido foi aprovado` indica que context_instanceo valor do parâmetro de consulta não representa uma instância válida do contexto de atividade especificado.
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.

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


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 em que cada objeto representa um registro de atividade do contexto de atividade especificado e da instância de contexto. 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" } ]`
activity.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.activity.content_fields	Matriz de objetos em que 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 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 Conteúdo é exibido como um hiperlink para o registro do objeto no qual esta atividade foi realizada. Falso: O campo Conteúdo é exibido como um hiperlink para o registro do objeto no qual esta atividade foi realizada. Tipo de dados: Cadeia de caracteres
result.activity.content_fields.display_as_timeago	Sinalizador que indica se o campo de conteúdo é exibido ou não no formato Tempo passado. Valores válidos: Verdadeiro: O campo Conteúdo é exibido no formato Tempo passado. Falso: O campo Conteúdo não é exibido no formato Tempo passado. Tipo de dados: Cadeia de caracteres
result.activity.content_fields.label	Rótulo do campo Conteúdo. Tipo de dados: Cadeia de caracteres
result.activity.content_fields.show_label	Sinalizador que indica se o rótulo do campo de conteúdo é exibido ou não 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. Tipo de dados: Cadeia de caracteres
result.activity.content_fields.type	Tipo do campo Conteúdo. Tipo de dados: Cadeia de caracteres
result.activity.content_fields.value	Valor do campo Conteúdo. Tipo de dados: Cadeia de caracteres
resultado.atividades.criado	Data/hora de criação deste registro de atividade. Tipo de dados: Cadeia de caracteres Formato: AAAA-DD-MM hh:mm:ss
resultado.atividades.ícone	Nome do ícone exibido no bloco deste registro de atividade. Tipo de dados: Cadeia de caracteres
result.activity.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.activity.subheader_fields	Matriz de objetos em que cada objeto representa um campo exibido no subcabeçalho do bloco deste 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 subcabeçalho é exibido como um hiperlink para o registro do objeto no qual esta atividade foi realizada. Falso: O campo subcabeçalho não é exibido como um hiperlink para o registro do objeto no qual esta atividade foi realizada. Tipo de dados: Cadeia de caracteres
result.activity.subheader_fields.display_as_timeago	Sinalizador que indica se o campo de subcabeçalho é exibido ou não no formato Tempo passado. Valores válidos: Verdadeiro: O campo subcabeçalho é exibido no formato Tempo passado. Falso: O campo de subcabeçalho não é exibido no formato Tempo passado. Tipo de dados: Cadeia de caracteres
result.activity.subheader_fields.label	Rótulo do campo subcabeçalho. Tipo de dados: Cadeia de caracteres
result.activity.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. Tipo de dados: Cadeia de caracteres
result.activity.subheader_fields.type	Tipo do campo de subcabeçalho. Tipo de dados: Cadeia de caracteres
result.activity.subheader_fields.value	Valor do campo de subcabeçalho. Tipo de dados: Cadeia de caracteres
result.activity.subobject_sys_id	Sys_id do registro do objeto no qual esta atividade foi realizada. Localizado na tabela especificada em subobject_table_namevalor do parâmetro. Tipo de dados: Cadeia de caracteres
result.activity.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_subscripble_object] para o grupo que contém o tipo de atividade associado a este registro de atividade. Tipo de dados: Cadeia de caracteres
result.activity.sys_id	Sys_id deste registro de atividade. Localizado na tabela especificada como source_table_namevalor do parâmetro do corpo da resposta. 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.hasMaisRegistros	Sinalizador que indica se a lista de atividades no corpo da resposta está truncada ou não pelo lastvalor do parâmetro de consulta. Valores válidos: Verdadeiro: A lista de atividades no corpo da resposta é truncada pelo lastvalor do parâmetro de consulta. Repetir a solicitação com um maior lasto valor do parâmetro de consulta retornará atividades adicionais para este contexto e instância de contexto. Falso: A lista de atividades no corpo da resposta não está truncada pelo lastvalor do parâmetro de consulta. Nenhuma atividade adicional está disponível para este contexto e instância de contexto. Tipo de dados: Cadeia de caracteres
resultado.mensagem	Mensagem de erro descrevendo o problema encontrado durante o processamento da solicitação. Tipo de dados: Cadeia de caracteres
result.status	Código de status HTTP retornado para a solicitação. Valores válidos: Consulte Códigos de status. Tipo de dados: Número
resultado.fluxo	Sys_id especificado na solicitação contextparâmetro de consulta. Tipo de dados: Cadeia de caracteres Tabela: Contexto de atividade [sn_actsub_activity_context]
result.user	Sys_id especificado na solicitação context_instanceparâmetro de consulta. Localizado na tabela apropriada para o contexto de atividade. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Solicite o segundo e 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"
          }
        ]
      }
    ]
  }
}

ActivitySubscriptions - OBTER /now/actsub/facets/

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 por tipo de atividade, grupo e configurações de contexto.

Os usuários devem ter a função actsub_user 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 do contexto de atividade, consulte Crie aspectos para contextos de atividade .