SIGNL4 - Alertas móveis

O SIGNL4 oferece alerta móvel crítico, resposta a incidentes e despacho de serviços para operar infraestruturas críticas. Alerta-o persistentemente através de push de aplicações, SMS e chamadas de voz, incluindo seguimento, escalonamento, colaboração e planeamento de tarefas.

Este conector está disponível nos seguintes produtos e regiões:

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Derdack GmbH
URL	https://www.signl4.com/feedback-we-love-hear-from-you/
Email	success@signl4.com

Metadados do conector
Editora	Derdack
Sítio Web	https://www.signl4.com
Política de privacidade	https://www.signl4.com/privacy-policy/
Categorias	Operações de TI; Comunicação

O SIGNL4 oferece alertas críticos, resposta a incidentes e despacho de serviços para a operação de infraestruturas críticas. Alerta-o persistentemente através de push de aplicações, SMS e chamadas de voz, incluindo seguimento, escalonamento, colaboração e planeamento de tarefas.

Você pode integrar o SIGNL4 ao seu fluxo para enviar alertas confiáveis da equipe sempre que necessário.

Pré-requisitos

Você precisa de uma conta SIGNL4. Se você ainda não tem um, você pode obter um em https://connect.signl4.com/. Também pode transferir diretamente a aplicação móvel a partir da Google Play Store ou da Apple App Store.

Como obter credenciais

Para usar o conector, você precisa da chave da API SIGNL4. No portal da Web SIGNL4, você obtém sua chave de API em Integrações -> Chave de API. Em seguida, você pode usar sua chave de API para autenticar seu conector SIGNL4 no Power Automate.

Introdução ao conector

Você pode encontrar uma descrição detalhada das funções da API SIGNL4 aqui. Depois de adicionar o conector SIGNL4 ao fluxo do Power Automatic, você precisa obter a chave da API SIGNL4. Em seguida, você pode usar as funções da API de acordo. Se tiver mais alguma questão, não hesite em contactar a equipa SIGNL4.

A maneira mais fácil de começar é usar a ação EventsSend para enviar um alerta:

Primeiro, obtenha o segredo da sua equipa SIGNL4 / segredo de integração a partir do seu portal web SIGNL4.
Quando você tem o segredo da equipe / segredo de integração você pode usar este na função EventsSend para disparar um evento que pode gerar um alerta para sua equipe. Você só precisa digitar qualquer título e mensagem. Você pode encontrar uma descrição dos outros parâmetros na página de documentação do webhook de entrada.
É isso e agora você aciona um evento e recebe um alerta no SIGNL4.

Problemas conhecidos e limitações

O conector SIGNL4 para Power Automate encapsula toda a API REST SIGNL4 2.0. Algumas funcionalidades dependem do seu plano SIGNL4.

Erros e soluções comuns

N/A

FAQ

Você pode encontrar o FAQ do SIGNL4 e ajuda on-line aqui. Também há uma biblioteca de vídeos abrangente disponível.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
Chave de API	securestring	A chave de API para esta api	Verdade

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Adicionar utilizador a uma equipa	Adicionar usuário a uma equipe.
Alerta de anotações	Anota um alerta por determinadas Informações de Anotação.
Alerta de gatilho	Aciona um novo alerta para sua equipe. Todos os membros da equipa de serviço receberão notificações de alerta.
Atualiza a senha de um usuário	Atualiza a senha de um usuário.
Atualiza dados personalizados de uma determinada instância de script que inclui seu nome para exibição	Atualiza a instância de script especificada.
Atualiza o perfil da equipe de uma equipe	Atualiza o perfil da equipe de uma equipe.
Atualiza o perfil de usuário de um usuário	Atualiza o perfil de usuário de um usuário.
Atualiza um perfil de subscrição	Atualiza um perfil de assinatura.
Atualiza uma ação remota	Pedido de amostra: `PUT /remoteActions/{actionId} { "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7", "name": "MyAction", "enabled": true, }`
Atualiza uma determinada instância de script	Atualiza a instância de script especificada, normalmente usada para atualizar a configuração de um script.
Atualizar a associação da equipe do usuário	Atualiza a associação da equipe do usuário. Você pode mover o usuário para outra equipe dentro da assinatura e/ou alterar a função do usuário.
Atualizar as configurações de privacidade de uma equipe	Atualize as configurações de privacidade de uma equipe.
Atualizar as configurações pré-pagas atuais da sua assinatura	Atualize as configurações pré-pagas atuais da sua assinatura.
Atualizar as configurações pré-pagas atuais de uma assinatura	Atualize as configurações pré-pagas atuais de uma assinatura.
Atualizar informações de localidade (por exemplo, idioma, fuso horário) para o usuário	Atualize as informações de localidade (por exemplo, idioma, fuso horário) para o usuário.
Atualizar o modelo de texto explicativo existente para sua assinatura	Atualize o modelo de texto explicativo existente para sua assinatura.
Atualizar um padrão de alerta existente	Atualize um padrão de alerta existente.
Atualizar uma categoria existente	Pedido de amostra: `PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e { "name": "Water-Updated", "imageName": "water.svg", "color": "#0000cc", "keywordMatching": "All", "keywords": [ { "value": "H2O" }, { "value": "Water" }, { "value": "Wet" } ] }`
Atualizar uma fonte de eventos	Atualize uma fonte de eventos.
Atualizar Webhook por Id	Atualiza o webhook especificado.
Baixar relatório de dever com um fileName específico	Faça o download do relatório de dever com um fileName específico.
Capacidade de ativar um webHook	Capacidade de ativar um webHook.
Capacidade de desativar um webHook	Capacidade de desativar um webHook.
Carregou uma imagem de perfil para um usuário especificado	Carregou uma imagem de perfil para um usuário especificado.
Carregou uma imagem de perfil para uma equipa específica	Carregou uma imagem de perfil para uma equipe especificada.
Confirma todos os alertas visíveis	Esse método confirma todos os alertas não tratados que sua equipe tem atualmente por um usuário específico.
Convidar utilizadores para uma equipa	Convide usuários para uma equipe.
Copiar férias de uma equipa para outra	Copie as férias de uma equipa para outra.
Creat ou Update dado cronograma de serviço	Criar/Atualizar determinado cronograma de tarefas.
Cria uma nova instância de script na equipe SIGNL4	Cria uma nova instância de script do script especificado no corpo da solicitação.
Criar fonte de evento	Crie a origem do evento.
Criar novos modelos de texto explicativo para a sua subscrição	Crie novos modelos de texto explicativo para sua assinatura.
Criar um novo padrão de alerta	Crie um novo padrão de alerta.
Criar um novo trabalho remoto	Pedido de amostra: `POST /remoteActions/{actionId}/jobs { "remoteActionPin" : "1234", "parameters": [ { "name": "Param1", "value": "Value 1" } ] }`
Criar uma nova ação remota	Pedido de amostra: `POST /remoteActions { "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7", "name": "MyAction", "enabled": true, }`
Criar uma nova categoria	Pedido de amostra: `POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7 { "name": "Water", "imageName": "water.svg", "color": "#0000cc", "keywordMatching": "Any", "keywords": [ { "value": "H2O" }, { "value": "Water" } ] }`
Criar Webhook	Cria um novo webhook de saída que será notificado quando determinados eventos ocorrerem.
Define as configurações de alerta de uma equipe específica	Define as configurações de alerta de uma equipe específica.
Definir a localização de um utilizador	Definir a localização de um utilizador.
Definir o número de telefone de um utilizador	Defina o número de telefone de um usuário. Se outro número de telefone for salvo, ele será substituído.
Definir perfis de notificação para o usuário	Defina perfis de notificação para o usuário.
Definir subscrições de categoria	Pedido de amostra: `POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions { }`
Desabilita uma determinada instância de script	Desabilita uma determinada instância de script.
Desfazer a confirmação de um alerta	Esse método tenta desfazer uma confirmação de alerta.
Desfazer fila de várias confirmações	Esse método tenta desfazer a confirmação de vários alertas por meio de uma fila. A operação é tratada em segundo plano.
Desfazer o encerramento de um alerta	Este método tenta desfazer um alerta de fechamento.
Devolve as informações de preço do canal da subscrição	Retorna as informações de preço do canal da assinatura.
Devolve informações do calendário de tarefas com o ID especificado	Retorna informações da agenda de serviço com o ID especificado.
Devolve informações sobre todos os horários planeados	Retorna informações sobre todas as agendas planejadas.
Devolve Relatório de Alerta	Retorna o Relatório de Alerta.
Envia e-mail de convite novamente se existir um convite	Envia um e-mail de convite novamente se existir um convite.
Envia um email para um usuário especificado	Envia um email para um usuário especificado que contém informações de todas as fontes de eventos da equipe do usuário.
Enviar evento	Enviar evento.
Escalar um alerta manualmente para uma equipe	Encaminhe um alerta manualmente para uma equipe.
Exclui a conta de usuário	Exclui a conta de usuário.
Exclui a imagem atual da equipe	Exclui a imagem da equipe atual.
Exclui uma ação remota	Pedido de amostra: `DELETE /eaRemoteActions/{actionId}`
Exclui uma instância de script	Obtém a instância de script especificada pela id da instância passada.
Excluir agendas de serviço no intervalo	Excluir agendas de serviço no intervalo.
Excluir feriados	Excluir feriados.
Excluir imagem pessoal do usuário	Exclua a imagem pessoal do usuário.
Excluir o modelo de texto explicativo existente da sua assinatura	Exclua o modelo de texto explicativo existente da sua assinatura.
Excluir o número de telefone de um usuário	Exclua o número de telefone de um usuário.
Excluir um endereço de contato de um usuário	Excluir um endereço de contato de um usuário.
Excluir um padrão de alerta específico	Exclua um padrão de alerta específico.
Excluir uma categoria existente	Pedido de amostra: `DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e`
Excluir uma distribuição de eventos	Exclua uma distribuição de eventos.
Excluir uma fonte de eventos	Exclua uma fonte de eventos.
Excluir Webhook por Id	Exclui o webhook especificado para que ele não seja mais notificado.
Fechar todos os alertas reconhecidos	Esse método fecha todos os alertas reconhecidos que sua equipe tem atualmente.
Fechar um alerta	Feche um alerta.
Fechar vários alertas	Este método fecha todos os alertas fornecidos.
Guardar férias repetidas para uma equipa	Salve feriados repetidos para uma equipe.
Habilita uma instância de script	Habilita uma instância de script.
Obtenha as configurações pré-pagas atuais da sua assinatura	Obtenha as configurações pré-pagas atuais da sua assinatura.
Obtenha as transações pré-pagas da sua subscrição	Obtenha as transações pré-pagas da sua subscrição.
Obtenha configurações de serviço de equipe para várias equipes	Obtenha configurações de plantão de equipe para várias equipes.
Obtenha informações de todas as subscrições disponíveis e geridas	Obtenha informações de todas as subscrições disponíveis/geridas.
Obtenha o saldo pré-pago atual da sua subscrição	Obtenha o saldo pré-pago atual da sua subscrição.
Obtenha todas as equipas das quais o utilizador é membro	Retorna uma lista de objetos de equipe com detalhes como seu nome. Apenas as equipas das quais o utilizador é membro serão devolvidas.
Obtenha todos os modelos de texto explicativo para a sua subscrição	Obtenha todos os modelos de texto explicativo para a sua subscrição.
Obtenha todos os padrões de alerta da equipe	Obtenha todos os padrões de alerta da equipe.
Obter as configurações pré-pagas atuais de uma assinatura	Obtenha as configurações pré-pagas atuais de uma assinatura.
Obter associações de equipa por equipa	Obtenha associações de equipa por equipa.
Obter associações de equipe de um usuário	Obtenha associações de equipe de um usuário.
Obter configurações de privacidade de equipe para uma equipe	Obtenha as definições de privacidade da Equipa para uma equipa.
Obter detalhes de um evento	Obtenha detalhes de um evento.
Obter detalhes sobre um alerta	Obtenha detalhes sobre um alerta.
Obter entradas de linha cronológica de alerta	Obter entradas de linha cronológica de alerta de um alerta por id.
Obter evento de visão geral	Obtenha uma visão geral do evento por id.
Obter fontes de eventos de uma ou mais equipas	Obtenha fontes de eventos de uma ou mais equipes.
Obter imagem de utilizador pessoal	Obtenha uma imagem de utilizador pessoal.
Obter informações de anexo de um alerta	Obter anexos de um alerta por id.
Obter informações de todas as equipas	Obtenha informações de todas as equipas.
Obter informações de uma subscrição específica	Obtenha informações de uma subscrição específica.
Obter informações do assistente de serviço para as equipas	Obtenha informações sobre o assistente de serviço para as equipas.
Obter informações para todas as equipas da subscrição	Obtenha informações para todas as equipas da subscrição.
Obter informações públicas sobre todas as equipas numa subscrição	Obtenha informações públicas sobre todas as equipas numa subscrição.
Obter informações sobre relatórios de alerta transferíveis	Obtenha informações sobre relatórios de alerta para download.
Obter métricas para todas as categorias	Pedido de amostra: `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics`
Obter métricas para uma categoria específica	Pedido de amostra: `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics`
Obter o saldo pré-pago atual de uma subscrição	Obtenha o saldo pré-pago atual de uma assinatura.
Obter origem do evento por id	Obtenha a origem do evento por id.
Obter parâmetros de evento	Obter parâmetros de um evento por id.
Obter perfis de notificação para o usuário	Obtenha perfis de notificação para o usuário.
Obter relatório de alerta	Devolve informações sobre o volume de alertas ocorrido em diferentes períodos de tempo, bem como informações sobre o comportamento de resposta (quantidade de alertas confirmados e não tratados) dos membros da equipa.
Obter status de dever por ID de usuário	Retorna um objeto com informações de dever.
Obter subscrições de categoria	Pedido de amostra: `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions { }`
Obter todas as categorias	Obtenha todas as categorias.
Obter todas as categorias	Pedido de amostra: `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7`
Obter todos os usuários	Retorna uma lista de objetos de usuário com detalhes como seu endereço de e-mail e informações de dever. Somente os usuários aos quais você tem acesso serão retornados.
Obter todos os usuários de equipes especificadas	Obter todos os usuários de equipes especificadas.
Obter transações pré-pagas de uma subscrição	Obtenha as transações pré-pagas de uma assinatura.
Obter uma categoria específica	Pedido de amostra: `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e`
Obter usuário por ID	Retorna um objeto de usuário com detalhes como seu endereço de e-mail e informações de dever.
Obter visão geral paginada do evento	Obtenha a página de visão geral do evento. Se houver mais resultados, você também receberá um token de continuação que pode ser adicionado ao filtro de eventos.
Obter Webhook por Id	Retorna informações do webhook especificado pela id passada.
Obter Webhooks	Retorna uma coleção de webhooks de saída definidos no sistema.
Obtém a imagem de uma equipe especificada	Obtém a imagem de uma equipe especificada.
Obtém as licenças de número de voz de uma assinatura	Obtém as licenças de número de voz de uma assinatura.
Obtém as licenças de usuário de uma assinatura	Obtém as licenças de usuário de uma assinatura.
Obtém configurações de alerta de uma equipe específica	Obtém configurações de alerta de uma equipe específica.
Obtém configurações de alerta de uma equipe específica	Obtém configurações de alerta de uma equipe específica.
Obtém fontes de eventos de uma equipe específica	Obtém fontes de eventos de uma equipe específica.
Obtém informações de uma equipe específica	Obtém informações de uma equipe específica.
Obtém o progresso da configuração de um usuário específico	Obtém o progresso da configuração de um usuário específico.
Obtém o progresso da configuração de uma equipe específica	Obtém o progresso da configuração de uma equipe específica.
Obtém os nomes de todas as imagens de categoria de alerta	Obtém os nomes de todas as imagens de categoria de alerta. Você pode obter a imagem indo para account.signl4.com/images/alerts/categoryImageName.svg.
Obtém um anexo especificado de um alerta especificado	Obtém um anexo especificado de um alerta especificado.
Poupe férias para uma equipa	Guarde férias para uma equipa.
Punch User como Gerente	O usuário especificado será perfurado para o dever como gerente.
Punch User em	O usuário especificado será perfurado para o dever.
Punch Usuário para fora	O usuário especificado será expulso do dever.
Receba alerta	Recebe um alerta por id.
Receba férias para a equipa	Obtenha férias para a equipa.
Receba notificações de alerta	Receba notificações de todos os usuários por id de alerta.
Recebe alertas paginados	Recebe alertas paginados.
Reconhecer um alerta	Reconheça um alerta.
Reconhecer vários alertas	Este método confirma todos os alertas fornecidos.
Recuperar toda a definição disponível	Recupere toda a definição disponível.
Recuperar uma definição	Recuperar uma definição.
Remove um usuário ou convite de uma equipe	Remove um usuário ou convite de uma equipe.
Retirar o encerramento de vários alertas	Esse método tenta desfazer vários fechamentos de alerta. A operação é tratada em segundo plano.
Retorna ações remotas	Pedido de amostra: `GET /RemoteActions?externalId=12345`
Retorna os recursos de uma assinatura especificada	Retorna os recursos de uma assinatura especificada.
Retorna todas as informações sobre uma determinada instância de script	Obtém a instância de script especificada pela id da instância passada.
Retorna todas as instâncias de script da equipe SIGNL4	Retorna todas as instâncias de script na assinatura.
Retorna todos os scripts de inventário	Retorna todos os scripts de inventário.
Retorna todos os scripts de inventário disponíveis	Retorna todos os scripts de inventário disponíveis que podem ser adicionados a uma assinatura SIGNL4.
Retorna trabalhos remotos paginados do diário	Pedido de amostra: `POST /remoteActions/journal/paged?maxResults=100 { "statusCode": "Executed" }`
Retorna um script de inventário por sua id	Obtém o script especificado pela id de script passada.
Retorna um trabalho remoto do diário	Pedido de amostra: `GET /remoteActions/journal/{jobId}`
Retorna uma ação remota	Pedido de amostra: `GET /RemoteActions/{actionId}`
Salvar várias agendas	Salve várias agendas. É possível substituir os horários existentes, se desejar.
Suprimir um direito específico	Suprimir um direito específico.
Valida um número de telefone criado anteriormente para um usuário	Valida um número de telefone criado anteriormente para um usuário.
Validar intervalos de tempo de um padrão	Valide um intervalo de tempo de um padrão em relação a todos os intervalos de tempo existentes de outros padrões.
Verifica se um usuário tem a permissão fornecida	Verifica se um usuário tem a permissão fornecida.

Adicionar utilizador a uma equipa

ID da Operação:: TeamsAddUser

Adicionar usuário a uma equipe.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa para a qual o utilizador deve ser convidado.
ID de utilizador	userId	True	string	ID do usuário que você deseja adicionar a uma equipe.
roleId	roleId		string
setUserOnDuty	setUserOnDuty		boolean

Devoluções

Body: V2.TeamMembershipDetails

Alerta de anotações

ID da Operação:: AlertsAnnotate

Anota um alerta por determinadas Informações de Anotação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	ID do alerta a ser anotado.
enviar SMS	text		string
tipo	type		integer	0 = Nenhum 1 = Texto 2 = Imagem
userId	userId		string

Devoluções

Body: V2.AlertAnnotationDetails

Alerta de gatilho

ID da Operação:: AlertsTrigger

Aciona um novo alerta para sua equipe. Todos os membros da equipa de serviço receberão notificações de alerta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
nome	name		string
order	order		integer
tipo	type		integer	0 = Nenhum 1 = Objeto 2 = Matriz 3 = Construtor 4 = Propriedade 5 = Comentário 6 = Inteiro 7 = Flutuador 8 = String 9 = Booleano 10 = Nulo 11 = Indefinido 12 = Data 13 = Bruto 14 = Bytes 15 = GUID 16 = Uri 17 = TimeSpan 100 = Html
valor	value		string
conteúdo	content		string
TipoDeConteúdo	contentType		string
codificação	encoding		integer	0 = Nenhum 1 = Base64
id	id		string
nome	name		string
categoria	category		string
Id externo	externalId		string
flags	flags		integer	0 = Nenhum 1 = HasAttachments 2 = HasAnotações 4 = IsBreached 8 = HasLocationInfo 16 = EscalatedToTeam 32 = EscalatedToManager 64 = CreatedByEscalation
severity	severity		integer	0 = Baixo 1 = Maior 2 = Crítica
teamId	teamId	True	string
enviar SMS	text	True	string
title	title	True	string

Devoluções

Body: V2.AlertDetails

Atualiza a senha de um usuário

ID da Operação:: UsersUpdatePassword

Atualiza a senha de um usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID de usuário do usuário cuja senha deve ser alterada.
currentPassword	currentPassword		string
newPassword	newPassword		string

Atualiza dados personalizados de uma determinada instância de script que inclui seu nome para exibição

ID da Operação:: ScriptsUpdateCustomData

Atualiza a instância de script especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da instância de script	instanceId	True	string	ID da instância do script a ser atualizado.
customScriptDescription	customScriptDescription		string
customScriptName	customScriptName		string
instanceId	instanceId		string
nome_script	scriptName		string

Devoluções

Body: ScriptInstanceDetails

Atualiza o perfil da equipe de uma equipe

ID da Operação:: TeamsUpdateProfile

Atualiza o perfil da equipe de uma equipe.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa que deve ser atualizado.
nome	name		string

Devoluções

Body: TeamInfo

Atualiza o perfil de usuário de um usuário

ID da Operação:: UsersUpdateProfile

Atualiza o perfil de usuário de um usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID do usuário a ser atualizado.
nome	name		string
Fuso horário	timeZone		string

Devoluções

Body: UserInfo

Atualiza um perfil de subscrição

ID da Operação:: SubscriptionsUpdateProfile

Atualiza um perfil de assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscriptionId	True	string	ID da subscrição a atualizar
nome	name		string

Devoluções

Body: SubscriptionInfo

Atualiza uma ação remota

ID da Operação:: RemoteActionsUpdate

Pedido de amostra:

PUT /remoteActions/{actionId}
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	actionId	True	string	Id da ação remota a ser atualizada
ID da ação	language		integer	0 = EN 1 = DE
nome	name	True	string
valor	value		string
podeEditar	canEdit		boolean
canExecute	canExecute		boolean
teamId	teamId		string
definitionId	definitionId		string
descrição	description		string
enabled	enabled		boolean
nome	name		string
teamId	teamId		string

Devoluções

Body: V2.RemoteActionDetails

Atualiza uma determinada instância de script

ID da Operação:: ScriptsUpdateConfig

Atualiza a instância de script especificada, normalmente usada para atualizar a configuração de um script.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da instância de script	instanceId	True	string	ID da instância do script a ser atualizado.
Configurações	config
customScriptDescription	customScriptDescription		string
customScriptName	customScriptName		string
enabled	enabled		boolean
teamId	teamId		string

Devoluções

Body: ScriptInstanceDetails

Atualizar a associação da equipe do usuário

ID da Operação:: TeamsUpdateUserMembership

Atualiza a associação da equipe do usuário. Você pode mover o usuário para outra equipe dentro da assinatura e/ou alterar a função do usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	Equipe o usuário que você deseja atualizar pertence no momento.
ID de utilizador	userId	True	string	ID de utilizador do utilizador que pretende atualizar.
ID de utilizador	requesterUserId		string	ID de usuário do usuário com o qual você deseja alterar a função. Isso deve ser fornecido ao usar uma chave api. Esse usuário deve ter administrador de função (para definir a função de administrador) ou administrador de equipe (para definir direitos.
Definir usuário de plantão	setUserOnDuty		boolean	Define o novo status de dever para o usuário se o usuário for movido para uma equipe diferente. Usuário está de plantão ser inadimplente.
isValid	isValid		boolean
roleId	roleId		string
teamId	teamId		string

Devoluções

Body: UserInfo

Atualizar as configurações de privacidade de uma equipe

ID da Operação:: TeamsUpdatePrivacySettings

Atualize as configurações de privacidade de uma equipe.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa
hideContactAddresses	hideContactAddresses		boolean
hideDutyData	hideDutyData		boolean
hideForEscalation	hideForEscalation		boolean

Devoluções

Body: V2.TeamPrivacySettingsDetails

Atualizar as configurações pré-pagas atuais da sua assinatura

ID da Operação:: PrepaidUpdateSettings

Atualize as configurações pré-pagas atuais da sua assinatura.

Parâmetros

Name	Chave	Tipo
topUpAmount	topUpAmount	integer
topUpEnabled	topUpEnabled	boolean
topUpLimit	topUpLimit	integer

Devoluções

Body: PrepaidSettingsInfo

Atualizar as configurações pré-pagas atuais de uma assinatura

ID da Operação:: PrepaidUpdateSettings55

Atualize as configurações pré-pagas atuais de uma assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscriptionId	True	string	ID da subscrição
topUpAmount	topUpAmount		integer
topUpEnabled	topUpEnabled		boolean
topUpLimit	topUpLimit		integer

Devoluções

Body: PrepaidSettingsInfo

Atualizar informações de localidade (por exemplo, idioma, fuso horário) para o usuário

ID da Operação:: UsersUpdateLocaleInfo

Atualize as informações de localidade (por exemplo, idioma, fuso horário) para o usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID de usuário, e-mail ou "eu" para o usuário que você deseja atualizar
linguagem	language		string
Fuso horário	timeZone		string

Devoluções

Body: V2.UserLocaleResponseDetails

Atualizar o modelo de texto explicativo existente para sua assinatura

ID da Operação:: CalloutsUpdateTemplate

Atualize o modelo de texto explicativo existente para sua assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do modelo	templateId	True	string	ID do modelo que pretende atualizar
categoryId	categoryId		string
Id externo	externalId		string
id	id		string
localização	location		string
nome	name		string
Assunto	subject		string
targetAllTeams	targetAllTeams		boolean
targetTeamId	targetTeamId		string
enviar SMS	text		string
tipo de fluxo de trabalho	workflowType		integer	0 = AsConfiguredInTeam 2 = TeamBroadcast 4 = MultiReconhecimento 5 = MultiAcknowledgeEmergency

Devoluções

response: array of V2.CalloutTemplateDetails

Atualizar um padrão de alerta existente

ID da Operação:: TeamsUpdateAlertPattern

Atualize um padrão de alerta existente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe para a qual você deseja criar o padrão
ID do padrão	patternId	True	string	ID do padrão a ser atualizado
categories	categories		array of string
enabled	enabled		boolean
mode	mode		integer	0 = Gestor 1 = Equipa
referenceId	referenceId		string
id	id		string
nome	name		string
canal	channel		integer	0 = Nenhum 1 = Empurrar 2 = Voz 3 = SMS
delayInMinutes	delayInMinutes		integer
enabled	enabled		boolean
overrideEscalationSettings	overrideEscalationSettings		boolean
overrideNotificationProfiles	overrideNotificationProfiles		boolean
overrideResponseSettings	overrideResponseSettings		boolean
responseMode	responseMode		integer	2 = SingleAcknowledge 4 = MultiReconhecimento
Tempo de resposta	responseTime		integer
suprimirSignl	suppressSignl		boolean
hora	hour		integer
minutes	minutes		integer
Dia da semana	weekday		integer	0 = Feriado 1 = Segunda-feira 2 = Terça-feira 3 = Quarta-feira 4 = Quinta-feira 5 = Sexta-feira 6 = Sábado 7 = Domingo
id	id		string

Devoluções

Body: V2.AlertingPatternDetails

Atualizar uma categoria existente

ID da Operação:: CategoriesUpdate

Pedido de amostra:

PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
    "name": "Water-Updated",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "All",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        },
        {
            "value": "Wet"
        }
    ]
}

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a que pertence a categoria
ID da categoria	categoryId	True	string	ID da categoria
enabled	enabled		boolean
id	id		string
nome	name		string
tipo	type	True	integer	0 = Parâmetro 1 = Sujeito 2 = Texto 3 = Localização
valor	value		string
color	color	True	string
id	id		string
nome	name		string
tipo	type	True	integer	0 = Parâmetro 1 = Hiperligação
valor	value		string
id	id		string
nome_da_imagem	imageName	True	string
isDefault	isDefault		boolean
palavra-chaveCorrespondência	keywordMatching	True	integer	0 = Qualquer 1 = Tudo
Palavras Chave	keywords	True	array of string
palavras-chaveExcluído	keywordsExcluded		array of string
nome	name	True	string
options	options		integer	0 = Nenhum 1 = Oculto 2 = DenyDelete 4 = HideOptOut 8 = OcultarPalavras-chave
order	order		integer
teamId	teamId		string

Devoluções

Body: CategoryInfo

Atualizar uma fonte de eventos

ID da Operação:: EventSourcesUpdate

Atualize uma fonte de eventos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Origem do Evento	eventSourceId	True	string	ID da origem do evento
descrição	description		string
desactivado	disabled		boolean
nome	name		string
teamId	teamId		string

Devoluções

Body: EventSourceEndpointInfo

Atualizar Webhook por Id

ID da Operação:: WebhooksUpdate

Atualiza o webhook especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Webhook de saída	webhookId	True	string	Id do webhook de saída a ser atualizado.
descrição	description		string
extUrl	extUrl	True	string
nome	name	True	string
teamId	teamId		string

Devoluções

Body: WebhookInfo

Baixar relatório de dever com um fileName específico

ID da Operação:: TeamsGetDutyReport

Faça o download do relatório de dever com um fileName específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe para a qual você deseja baixar o relatório de plantão.
Nome do arquivo	fileName	True	string	Nome do arquivo do csv para download.

Devoluções

response: binary

Capacidade de ativar um webHook

ID da Operação:: WebhooksDisable

Capacidade de ativar um webHook.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Webhook ID	webhookId	True	string	ID do Webhook para webhook que deve ser desativado.

Devoluções

Body: WebhookInfo

Capacidade de desativar um webHook

ID da Operação:: WebhooksEnable

Capacidade de desativar um webHook.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Webhook ID	webhookId	True	string	ID do Webhook para webhook que deve ser ativado.

Devoluções

Body: WebhookInfo

Carregou uma imagem de perfil para um usuário especificado

ID da Operação:: UsersUploadImage

Carregou uma imagem de perfil para um usuário especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID do utilizador.

Carregou uma imagem de perfil para uma equipa específica

ID da Operação:: TeamsUploadImage

Carregou uma imagem de perfil para uma equipe especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe onde definir a imagem da equipe.

Confirma todos os alertas visíveis

ID da Operação:: AlertsAcknowledgeAll

Esse método confirma todos os alertas não tratados que sua equipe tem atualmente por um usuário específico.

Parâmetros

Name	Chave	Tipo	Description
ID de utilizador	userId	string	ID de usuário do usuário a ser usado para reconhecer os alarmes.
categoryIds	categoryIds	array of string
data-máx.	maxDate	date-time
minData	minDate	date-time
âmbito	scope	integer	0 = Padrão 1 = Todas as Equipas 2 = Equipas Específicas
teamIds	teamIds	array of string

Convidar utilizadores para uma equipa

ID da Operação:: TeamsInviteUser

Convide usuários para uma equipe.

Parâmetros

Name	Chave	Necessário	Tipo
inviterId	inviterId		string
e-mail	email		string
roleId	roleId		string
teamId	teamId	True	string

Devoluções

response: array of V2.InvitationResult

Copiar férias de uma equipa para outra

ID da Operação:: TeamsCopyHolidays

Copie as férias de uma equipa para outra.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa para a qual pretende copiar as férias
Ano	year	True	integer	Ano de onde pretende copiar
ID da Equipa	sourceTeamId	True	string	ID da equipa da equipa da qual pretende copiar as férias

Devoluções

Body: V2.TeamHolidayDetails

Creat ou Update dado cronograma de serviço

ID da Operação:: DutiesCreateOrUpdate

Criar/Atualizar determinado cronograma de tarefas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	Id da equipa à qual o dever deve ser atribuído.
fim	end		date-time
id	id		string
options	options		integer
start	start		date-time
userId	userId		string

Devoluções

Body: ScheduleInfo

Cria uma nova instância de script na equipe SIGNL4

ID da Operação:: ScriptsCreate

Cria uma nova instância de script do script especificado no corpo da solicitação.

Parâmetros

Name	Chave	Tipo
Configurações	config
customScriptDescription	customScriptDescription	string
customScriptName	customScriptName	string
enabled	enabled	boolean
instanceId	instanceId	string
scriptId	scriptId	string
nome_script	scriptName	string
sharedTeams	sharedTeams	array of string
teamId	teamId	string

Devoluções

Body: ScriptInstanceDetails

Criar fonte de evento

ID da Operação:: EventSourcesCreate

Crie a origem do evento.

Parâmetros

Name	Chave	Tipo	Description
descrição	description	string
desactivado	disabled	boolean
linguagem	language	integer	0 = EN 1 = DE
nome	name	string
sharedTeams	sharedTeams	array of string
teamId	teamId	string
tipo	type	integer	0 = Nenhum 1 = E-mail 2 = Webhook

Devoluções

Body: EventSourceEndpointInfo

Criar novos modelos de texto explicativo para a sua subscrição

ID da Operação:: CalloutsCreateTemplate

Crie novos modelos de texto explicativo para sua assinatura.

Parâmetros

Name	Chave	Tipo	Description
categoryId	categoryId	string
Id externo	externalId	string
id	id	string
localização	location	string
nome	name	string
Assunto	subject	string
targetAllTeams	targetAllTeams	boolean
targetTeamId	targetTeamId	string
enviar SMS	text	string
tipo de fluxo de trabalho	workflowType	integer	0 = AsConfiguredInTeam 2 = TeamBroadcast 4 = MultiReconhecimento 5 = MultiAcknowledgeEmergency

Devoluções

response: array of V2.CalloutTemplateDetails

Criar um novo padrão de alerta

ID da Operação:: TeamsCreateAlertPattern

Crie um novo padrão de alerta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe para a qual você deseja criar o padrão
categories	categories		array of string
enabled	enabled		boolean
mode	mode		integer	0 = Gestor 1 = Equipa
referenceId	referenceId		string
id	id		string
nome	name		string
canal	channel		integer	0 = Nenhum 1 = Empurrar 2 = Voz 3 = SMS
delayInMinutes	delayInMinutes		integer
enabled	enabled		boolean
overrideEscalationSettings	overrideEscalationSettings		boolean
overrideNotificationProfiles	overrideNotificationProfiles		boolean
overrideResponseSettings	overrideResponseSettings		boolean
responseMode	responseMode		integer	2 = SingleAcknowledge 4 = MultiReconhecimento
Tempo de resposta	responseTime		integer
suprimirSignl	suppressSignl		boolean
hora	hour		integer
minutes	minutes		integer
Dia da semana	weekday		integer	0 = Feriado 1 = Segunda-feira 2 = Terça-feira 3 = Quarta-feira 4 = Quinta-feira 5 = Sexta-feira 6 = Sábado 7 = Domingo
id	id		string

Devoluções

Body: V2.AlertingPatternDetails

Criar um novo trabalho remoto

ID da Operação:: RemoteActionsCreateJob

Pedido de amostra:

POST /remoteActions/{actionId}/jobs
{
    "remoteActionPin" : "1234",
    "parameters": [
        {
            "name": "Param1",
            "value": "Value 1"
        }
    ]
}

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	actionId	True	string	ID da ação
nome	name	True	string
valor	value		string
alertId	alertId		string
options	options		integer	0 = Nenhum
remoteActionPin	remoteActionPin		string

Devoluções

Body: V2.RemoteJob

Criar uma nova ação remota

ID da Operação:: RemoteActionsCreate

Pedido de amostra:

POST /remoteActions
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

Parâmetros

Name	Chave	Necessário	Tipo	Description
Linguagem	language		integer	0 = EN 1 = DE
nome	name	True	string
valor	value		string
podeEditar	canEdit		boolean
canExecute	canExecute		boolean
teamId	teamId		string
definitionId	definitionId		string
descrição	description		string
enabled	enabled		boolean
nome	name		string
teamId	teamId		string

Devoluções

Body: V2.RemoteActionDetails

Criar uma nova categoria

ID da Operação:: CategoriesCreate

Pedido de amostra:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
    "name": "Water",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "Any",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        }
    ]
}

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a que pertence a categoria
enabled	enabled		boolean
id	id		string
nome	name		string
tipo	type	True	integer	0 = Parâmetro 1 = Sujeito 2 = Texto 3 = Localização
valor	value		string
color	color	True	string
id	id		string
nome	name		string
tipo	type	True	integer	0 = Parâmetro 1 = Hiperligação
valor	value		string
id	id		string
nome_da_imagem	imageName	True	string
isDefault	isDefault		boolean
palavra-chaveCorrespondência	keywordMatching	True	integer	0 = Qualquer 1 = Tudo
Palavras Chave	keywords	True	array of string
palavras-chaveExcluído	keywordsExcluded		array of string
nome	name	True	string
options	options		integer	0 = Nenhum 1 = Oculto 2 = DenyDelete 4 = HideOptOut 8 = OcultarPalavras-chave
order	order		integer
teamId	teamId		string

Devoluções

Body: CategoryInfo

Criar Webhook

ID da Operação:: WebhooksCreate

Cria um novo webhook de saída que será notificado quando determinados eventos ocorrerem.

Parâmetros

Name	Chave	Necessário	Tipo
descrição	description		string
extUrl	extUrl	True	string
nome	name	True	string
teamId	teamId		string

Devoluções

response: string

Define as configurações de alerta de uma equipe específica

ID da Operação:: TeamsSetAlertSettings

Define as configurações de alerta de uma equipe específica.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe para a qual as configurações devem ser definidas.
escAtivado	escEnabled		boolean
escMode	escMode		integer	0 = Gestor 1 = Equipa
escRefId	escRefId		string
filterAction	filterAction		integer	0 = Suprimir 1 = Ocultar 2 = Mudo
filterMode	filterMode		integer	0 = Desligado 1 = WhiteListAllCategories
canal	channel		integer	0 = Nenhum 1 = Empurrar 2 = Voz 3 = SMS
atraso	delay		integer
enabled	enabled		boolean
optar por não participar	optOut		integer	0 = Nenhum 1 = Desativado 2 = Pessoal
overrideNotificationProfiles	overrideNotificationProfiles		boolean
persNotInterval	persNotInterval		integer
persNotMode	persNotMode		integer	0 = Desligado 1 = Resumo
responseMode	responseMode		integer	2 = SingleAcknowledge 4 = MultiReconhecimento
Tempo de resposta	responseTime		integer

Devoluções

Body: AlertSettings

Definir a localização de um utilizador

ID da Operação:: UsersSetLocation

Definir a localização de um utilizador.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID do utilizador.
latitude	latitude		double
longitude	longitude		double
carimbo de data/hora	timestamp		date-time

Devoluções

Body: LocationInfo

Definir o número de telefone de um utilizador

ID da Operação:: UsersSetPhoneNumber

Defina o número de telefone de um usuário. Se outro número de telefone for salvo, ele será substituído.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID de utilizador do utilizador ao qual pretende adicionar um número de telefone
Código do país	countryCode		string
Número de telefone	phoneNumber		string
sendValidationCode	sendValidationCode		boolean
sendValidationCodeVia	sendValidationCodeVia		integer	0 = Nenhum 1 = SMS 2 = Voz

Devoluções

Body: V2.UserPhoneNumberDetails

Definir perfis de notificação para o usuário

ID da Operação:: UsersSetNotificationProfile

Defina perfis de notificação para o usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID do usuário do qual você deseja obter os perfis de notificação.
canal	channel		integer	0 = Nenhum 1 = Empurrar 2 = E-mail 4 = Bot 8 = Voz 16 = SMS
delayInMinutes	delayInMinutes		integer
enabled	enabled		boolean
options	options		integer
persistent	persistent		boolean

Devoluções

response: array of V2.NotificationProfileDetails

Definir subscrições de categoria

ID da Operação:: CategoriesSetSubscription

Pedido de amostra:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a que pertence a categoria
ID da categoria	categoryId	True	string	Categoria a atualizar
estado	status	True	integer	0 = Subscrito 1 = Mudo 2 = Oculto
userId	userId	True	string

Devoluções

response: array of CategorySubscriptionInfo

Desabilita uma determinada instância de script

ID da Operação:: ScriptsDisable

Desabilita uma determinada instância de script.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da instância de script	instanceId	True	string	Id da instância a ser desabilitada.

Devoluções

Body: ScriptInstanceDetails

Desfazer a confirmação de um alerta

ID da Operação:: AlertsUndoAck

Esse método tenta desfazer uma confirmação de alerta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	ID do alerta.
descr	descr		string
uid	uid	True	string

Devoluções

Body: V2.AlertInfo

Desfazer fila de várias confirmações

ID da Operação:: AlertsUndoAcknowledgeMultiple

Esse método tenta desfazer a confirmação de vários alertas por meio de uma fila. A operação é tratada em segundo plano.

Parâmetros

Name	Chave	Necessário	Tipo
alertIds	alertIds	True	array of string
descr	descr		string
uid	uid	True	string

Desfazer o encerramento de um alerta

ID da Operação:: AlertsUndoClose

Este método tenta desfazer um alerta de fechamento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	ID do alerta.
descr	descr		string
uid	uid	True	string

Devoluções

Body: V2.AlertInfo

Devolve as informações de preço do canal da subscrição

ID da Operação:: SubscriptionsGetChannelPriceInfo

Retorna as informações de preço do canal da assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscriptionId	True	string	ID da assinatura que precisa ser recuperada.

Devoluções

Body: ChannelPriceInfo

Devolve informações do calendário de tarefas com o ID especificado

ID da Operação:: DutiesGetInfo

Retorna informações da agenda de serviço com o ID especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	Id da equipa a que pertence o dever
ID do Agendamento de Serviço	scheduleId	True	string	Identificação do horário de serviço solicitado.

Devoluções

Body: ScheduleInfo

Devolve informações sobre todos os horários planeados

ID da Operação:: SchedulesGetPlanned

Retorna informações sobre todas as agendas planejadas.

Parâmetros

Name	Chave	Tipo
limit	limit	integer
minData	minDate	date-time
teamIds	teamIds	array of string
userId	userId	string

Devoluções

response: array of V2.ScheduleDetails

Devolve Relatório de Alerta

ID da Operação:: TeamsGetAlertReport

Retorna o Relatório de Alerta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe para a qual você deseja obter as informações do arquivo de relatório de plantão.
Nome do arquivo	fileName	True	string	Nome do ficheiro que pretende transferir.

Devoluções

response: binary

Envia e-mail de convite novamente se existir um convite

ID da Operação:: TeamsResendInvite

Envia um e-mail de convite novamente se existir um convite.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa da equipa com utilizador convidado.
inviterId	inviterId		string
userMail	userMail	True	string

Devoluções

response: string

Envia um email para um usuário especificado

ID da Operação:: UsersSendEventSourceInfoEmail

Envia um email para um usuário especificado que contém informações de todas as fontes de eventos da equipe do usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	O ID do usuário.
ID da Equipa	teamId		string	O ID da equipe a partir do qual o usuário deve obter as informações do ponto final.

Enviar evento

ID da Operação:: EventsSend

Enviar evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Segredo da Equipa	teamSecret	True	string	Segredo da Equipa.
Title	Title	True	string
Message	Message	True	string
X-S4-Service	X-S4-Service		string	X-S4-Service: : Atribui o Signl à categoria de serviço/sistema com o nome especificado.
X-S4-Location	X-S4-Location		string	X-S4-Location: transmita informações de localização (latitude, longitude) com o seu evento e exiba um mapa no aplicativo móvel.
X-S4-AlertingScenario	X-S4-AlertingScenario		string	X-S4-AlertingScenario: Se esse evento acionar um Signl, permitirá controlar como o SIGNL4 notifica a equipe. Os valores suportados são: single_ack, multi_ack, emergência.
X-S4-ExternalID	X-S4-ExternalID		string	X-S4-ExternalID: Se o evento se originar de um registro em um sistema de terceiros 3rd, use este parâmetro para passar a ID exclusiva desse registro. Esse ID será comunicado em notificações de webhook de saída do SIGNL4, o que é ótimo para correlação/sincronização desse registro com o Signl.
X-S4-Status	X-S4-Status		string	X-S4-Status: Se você quiser resolver um Signl existente por uma ID externa (X-S4-ExternalID), você pode adicionar esse parâmetro de status. Tem três valores possíveis: novo, reconhecido, resolvido.
X-S4-Filtering	X-S4-Filtering		boolean	X-S4-Filtering: especifique um valor booleano de true ou false para aplicar filtragem de eventos para esse evento, ou não. Se definido como true, o evento só acionará uma notificação para a equipe, se contiver pelo menos uma palavra-chave de um dos seus serviços e categorias do sistema (ou seja, estiver na lista branca).
Parâmetro de ID Externo	ExtIdParam		string	Parâmetro de ID externo.
Parâmetro de status externo	ExtStatusParam		string	Parâmetro de status externo.
Novo status	NewStatus		string	Novo Estado.
Parâmetro de status resolvido	ResolvedStatus		string	Parâmetro de status resolvido.
Estado do Ack	AckStatus		string	Ack Status.

Devoluções

Body: OverviewEvent

Escalar um alerta manualmente para uma equipe

ID da Operação:: AlertsEscalateToTeam

Encaminhe um alerta manualmente para uma equipe.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	ID de alerta para o Alerta que você deseja escalar.
targetTeamId	targetTeamId		string
userId	userId		string

Devoluções

response: string

Exclui a conta de usuário

ID da Operação:: UsersDelete

Exclui a conta de usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID do usuário a ser excluído.

Exclui a imagem atual da equipe

ID da Operação:: TeamsDeleteImage

Exclui a imagem da equipe atual.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe da qual você deseja excluir a imagem da equipe.

Exclui uma ação remota

ID da Operação:: RemoteActionsDelete

Pedido de amostra:

DELETE /eaRemoteActions/{actionId}

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	actionId	True	string	A id da ação a ser excluída

Exclui uma instância de script

ID da Operação:: ScriptsDelete

Obtém a instância de script especificada pela id da instância passada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da instância de script	instanceId	True	string	ID da instância da instância de script a ser retornada.

Excluir agendas de serviço no intervalo

ID da Operação:: DutiesDeleteInRange

Excluir agendas de serviço no intervalo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa que pretende eliminar
de	from		date-time
Para	to		date-time

Devoluções

response: array of ScheduleInfo

Excluir feriados

ID da Operação:: TeamsDeleteHolidays

Excluir feriados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID de equipa da qual pretende eliminar feriados
day	day		integer
mês	month		integer	0 = Não definido 1 = janeiro 2 = fevereiro 3 = março 4 = abril 5 = maio 6 = junho 7 = julho 8 = agosto 9 = setembro 10 = outubro 11 = novembro 12 = dezembro
ano	year		integer

Excluir imagem pessoal do usuário

ID da Operação:: UsersDeleteImage

Exclua a imagem pessoal do usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID do usuário ou eu

Excluir o modelo de texto explicativo existente da sua assinatura

ID da Operação:: CalloutsDeleteTemplate

Exclua o modelo de texto explicativo existente da sua assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do modelo	templateId	True	string	ID do modelo.

Excluir o número de telefone de um usuário

ID da Operação:: UsersDeletePhoneNumber

Exclua o número de telefone de um usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID do utilizador

Excluir um endereço de contato de um usuário

ID da Operação:: UsersDeleteContactAddress

Excluir um endereço de contato de um usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID de usuário do usuário para excluir o endereço de
ID do endereço	addressId	True	string	ID do endereço de contacto

Excluir um padrão de alerta específico

ID da Operação:: TeamsDeleteAlertPattern

Exclua um padrão de alerta específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa à qual pretende aceder
ID do padrão	patternId	True	string	ID do padrão para o padrão que você deseja acessar

Excluir uma categoria existente

ID da Operação:: CategoriesDelete

Pedido de amostra:

DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a que pertence a categoria
ID da categoria	categoryId	True	string	ID da categoria a eliminar

Excluir uma distribuição de eventos

ID da Operação:: EventDistributionDelete

Exclua uma distribuição de eventos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Origem do Evento	distributionId	True	string	ID da origem do evento

Excluir uma fonte de eventos

ID da Operação:: EventSourcesDelete

Exclua uma fonte de eventos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Origem do Evento	eventSourceId	True	string	ID da origem do evento

Excluir Webhook por Id

ID da Operação:: WebhooksDelete

Exclui o webhook especificado para que ele não seja mais notificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Webhook de saída	webhookId	True	string	ID do webhook de saída que será excluído.

Fechar todos os alertas reconhecidos

ID da Operação:: AlertsCloseAll

Esse método fecha todos os alertas reconhecidos que sua equipe tem atualmente.

Parâmetros

Name	Chave	Tipo	Description
ID de utilizador	userId	string	ID de usuário do usuário a ser usado para fechar os alarmes.
categoryIds	categoryIds	array of string
data-máx.	maxDate	date-time
minData	minDate	date-time
âmbito	scope	integer	0 = Padrão 1 = Todas as Equipas 2 = Equipas Específicas
teamIds	teamIds	array of string

Fechar um alerta

ID da Operação:: AlertsClose

Feche um alerta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	Id para confirmar um alerta.
descr	descr		string
uid	uid	True	string

Devoluções

Body: V2.AlertInfo

Fechar vários alertas

ID da Operação:: AlertsCloseMultiple

Este método fecha todos os alertas fornecidos.

Parâmetros

Name	Chave	Necessário	Tipo
alertIds	alertIds	True	array of string
descr	descr		string
uid	uid	True	string

Guardar férias repetidas para uma equipa

ID da Operação:: TeamsSaveRepeatingHolidays

Salve feriados repetidos para uma equipe.

Parâmetros

Name

Chave

Necessário

Tipo

Description

ID da Equipa

teamId

True

string

ID da equipa para a qual pretende guardar férias

day

integer

mês

month

integer

0 = Não definido
1 = janeiro
2 = fevereiro
3 = março
4 = abril
5 = maio
6 = junho
7 = julho
8 = agosto
9 = setembro
10 = outubro
11 = novembro
12 = dezembro

Devoluções

Body: V2.TeamHolidayDetails

Habilita uma instância de script

ID da Operação:: ScriptsEnable

Habilita uma instância de script.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da instância de script	instanceId	True	string	Id da instância a ser habilitada.

Devoluções

Body: ScriptInstanceDetails

Obtenha as configurações pré-pagas atuais da sua assinatura

ID da Operação:: PrepaidGetSettings

Obtenha as configurações pré-pagas atuais da sua assinatura.

Devoluções

Body: PrepaidSettingsInfo

Obtenha as transações pré-pagas da sua subscrição

ID da Operação:: PrepaidGetTransactions

Obtenha as transações pré-pagas da sua subscrição.

Devoluções

response: array of PrepaidTransactionInfo

Obtenha configurações de serviço de equipe para várias equipes

ID da Operação:: TeamsGetDutySettings

Obtenha configurações de plantão de equipe para várias equipes.

Parâmetros

Name	Chave	Necessário	Tipo	Description
IDs de equipa	teamId		array	IDs de equipa.

Devoluções

Body: MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-

Obtenha informações de todas as subscrições disponíveis e geridas

ID da Operação:: SubscriptionsGetAll

Obtenha informações de todas as subscrições disponíveis/geridas.

Devoluções

response: array of SubscriptionInfo

Obtenha o saldo pré-pago atual da sua subscrição

ID da Operação:: PrepaidGetBalance

Obtenha o saldo pré-pago atual da sua subscrição.

Devoluções

Body: PrepaidBalanceInfo

Obtenha todas as equipas das quais o utilizador é membro

ID da Operação:: UsersGetAllTeams

Retorna uma lista de objetos de equipe com detalhes como seu nome. Apenas as equipas das quais o utilizador é membro serão devolvidas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	userId	True	string	ID da equipa.

Devoluções

response: array of TeamInfo

Obtenha todos os modelos de texto explicativo para a sua subscrição

ID da Operação:: CalloutsGetTemplates

Obtenha todos os modelos de texto explicativo para a sua subscrição.

Devoluções

response: array of V2.CalloutTemplateDetails

Obtenha todos os padrões de alerta da equipe

ID da Operação:: TeamsGetAllAlertPatterns

Obtenha todos os padrões de alerta da equipe.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa que pretende aceder

Devoluções

response: array of V2.AlertingPatternDetails

Obter as configurações pré-pagas atuais de uma assinatura

ID da Operação:: PrepaidGetSettings84

Obtenha as configurações pré-pagas atuais de uma assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscriptionId	True	string	ID da subscrição

Devoluções

Body: PrepaidSettingsInfo

Obter associações de equipa por equipa

ID da Operação:: TeamsGetMemberships

Obtenha associações de equipa por equipa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa à qual pretende aceder.

Devoluções

response: array of V2.TeamMembershipDetails

Obter associações de equipe de um usuário

ID da Operação:: TeamsGetTeamMemberships

Obtenha associações de equipe de um usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID de utilizador a que pretende aceder.

Devoluções

response: array of V2.TeamMembershipDetails

Obter configurações de privacidade de equipe para uma equipe

ID da Operação:: TeamsGetPrivacySettings

Obtenha as definições de privacidade da Equipa para uma equipa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa

Devoluções

Body: V2.TeamPrivacySettingsDetails

Obter detalhes de um evento

ID da Operação:: EventsGetDetails

Obtenha detalhes de um evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Evento	eventId	True	string	ID do evento que pretende obter

Devoluções

Body: V2.EventDetails

Obter detalhes sobre um alerta

ID da Operação:: AlertsGetDetails

Obtenha detalhes sobre um alerta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	Alerta que pretende obter.
ID de utilizador	userId		string	ID de usuário do usuário no qual a api se comporta é chamada. Ele é usado para fins de filtragem em relação ao alerta.

Devoluções

Body: V2.AlertDetails

Obter entradas de linha cronológica de alerta

ID da Operação:: AlertsGetTimeline

Obter entradas de linha cronológica de alerta de um alerta por id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	ID do alerta solicitado.
ID de utilizador	userId		string	ID de Utilizador.

Devoluções

Name	Caminho	Tipo	Description
		array of

Obter evento de visão geral

ID da Operação:: EventsGetOverview

Obtenha uma visão geral do evento por id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Evento	eventId	True	string	Id do evento a obter.

Devoluções

Body: OverviewEvent

Obter fontes de eventos de uma ou mais equipas

ID da Operação:: EventSourcesGet

Obtenha fontes de eventos de uma ou mais equipes.

Parâmetros

Name

Chave

Necessário

Tipo

Description

IDs de equipa

teamId

array

Ids de equipe para obter as fontes do evento. Se você não adicionar nenhuma ID de equipe, obterá fontes de eventos às quais você tem acesso a partir de sua assinatura.

Incluir Interno

includeInternal

boolean

Se verdadeiro, o tipo de Fontes de Eventos internas (Sistema, Manual, API) será incluído no resultado.

Linguagem

language

integer

0 = EN
1 = DE

Devoluções

Body: MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-

Obter imagem de utilizador pessoal

ID da Operação:: UsersGetImage

Obtenha uma imagem de utilizador pessoal.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID de utilizador."
Altura da imagem	height		integer	Altura da imagem."
Largura da imagem	width		integer	Largura da imagem."

Devoluções

Body: UserImage

Obter informações de anexo de um alerta

ID da Operação:: AlertsGetAttachmentInfo

Obter anexos de um alerta por id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	ID do alerta solicitado.

Devoluções

response: array of V2.AlertAttachmentInfo

Obter informações de todas as equipas

ID da Operação:: TeamsGetAllInfo

Obtenha informações de todas as equipas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
IDs de equipa	teamId		array	IDs de equipa

Devoluções

response: array of TeamInfo

Obter informações de uma subscrição específica

ID da Operação:: SubscriptionsGetInfo

Obtenha informações de uma subscrição específica.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscriptionId	True	string	ID da assinatura a ser recuperada.

Devoluções

Body: SubscriptionInfo

Obter informações do assistente de serviço para as equipas

ID da Operação:: DutiesGetDutyAssistantInfo

Obtenha informações sobre o assistente de serviço para as equipas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
IDs de equipa	teamId		array	IDs das equipas para obter os resumos.
Últimos dois deveres	lastTwoDuties		boolean	Decida se quer todas as funções ou apenas as duas últimas.

Devoluções

Body: MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-

Obter informações para todas as equipas da subscrição

ID da Operação:: SubscriptionsGetAllTeamsInfo

Obtenha informações para todas as equipas da subscrição.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscriptionId	True	string	ID da subscrição a atualizar

Devoluções

response: array of TeamInfo

Obter informações públicas sobre todas as equipas numa subscrição

ID da Operação:: TeamsGetAllPublicInformation

Obtenha informações públicas sobre todas as equipas numa subscrição.

Devoluções

response: array of V2.TeamPublicDetails

Obter informações sobre relatórios de alerta transferíveis

ID da Operação:: TeamsGetAlertReportsInfo

Obtenha informações sobre relatórios de alerta para download.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe da qual você deseja baixar relatórios.

Devoluções

response: array of AlertAuditReportFileInfo

Obter métricas para todas as categorias

ID da Operação:: CategoriesGetAllMetrics

Pedido de amostra:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a que pertencem as categorias

Devoluções

response: array of CategoryMetrics

Obter métricas para uma categoria específica

ID da Operação:: CategoriesGetMetrics

Pedido de amostra:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a que pertence a categoria
ID da categoria	categoryId	True	string	ID da categoria a obter

Devoluções

Body: CategoryMetrics

Obter o saldo pré-pago atual de uma subscrição

ID da Operação:: SubscriptionsGetPrepaidBalance

Obtenha o saldo pré-pago atual de uma assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscriptionId	True	string	ID da subscrição

Devoluções

Body: PrepaidBalanceInfo

Obter origem do evento por id

ID da Operação:: EventSourcesGetById

Obtenha a origem do evento por id.

Parâmetros

Name

Chave

Necessário

Tipo

Description

ID da Origem do Evento

eventSourceId

True

string

Id da origem do evento.

Linguagem

language

integer

0 = EN
1 = DE

Devoluções

Body: EventSourceEndpointInfo

Obter parâmetros de evento

ID da Operação:: EventsGetParameters

Obter parâmetros de um evento por id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Evento	eventId	True	string	ID do Evento do Alerta solicitado.

Devoluções

response: array of EventParameterInfo

Obter perfis de notificação para o usuário

ID da Operação:: UsersGetNotificationProfile

Obtenha perfis de notificação para o usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID do usuário do qual você deseja obter os perfis de notificação.

Devoluções

response: array of V2.NotificationProfileDetails

Obter relatório de alerta

ID da Operação:: AlertsGetReport

Devolve informações sobre o volume de alertas ocorrido em diferentes períodos de tempo, bem como informações sobre o comportamento de resposta (quantidade de alertas confirmados e não tratados) dos membros da equipa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId		string	ID de usuário do usuário para o qual você deseja um relatório.
IDs de equipa	teamId		array	IDs de equipe das equipes para as quais você deseja um relatório. Se não definir um ID de equipa, obterá todos os recursos de todas as equipas a que tem acesso.

Devoluções

Body: MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-

Obter status de dever por ID de usuário

ID da Operação:: UsersGetDutyStatus

Retorna um objeto com informações de dever.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	Identificador do usuário a ser obtido. Use 'Eu' para obter informações sobre o usuário conectado no momento. Isso não é possível com uma chave api. Também pode ser um endereço de e-mail de um usuário da equipe ou o id exclusivo de um objeto de usuário de acordo com ele."
ID da Equipa	teamId		array	ID da equipa."

Devoluções

Body: MultiTeamResult-2-UserDutyInfo-V2.DutyError-

Obter subscrições de categoria

ID da Operação:: CategoriesGetSubscription

Pedido de amostra:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a que pertence a categoria
ID da categoria	categoryId	True	string	Categoria para obter subscrições

Devoluções

response: array of CategorySubscriptionInfo

Obter todas as categorias

ID da Operação:: CategoriesGetAll

Obtenha todas as categorias.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId		array	ID da equipa.

Devoluções

Body: MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-

Obter todas as categorias

ID da Operação:: CategoriesGetAllOfTeam

Pedido de amostra:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a que as categorias pertencem

Devoluções

response: array of CategoryInfo

Obter todos os usuários

ID da Operação:: UsersGettAll

Retorna uma lista de objetos de usuário com detalhes como seu endereço de e-mail e informações de dever. Somente os usuários aos quais você tem acesso serão retornados.

Devoluções

response: array of V2.UserDetails

Obter todos os usuários de equipes especificadas

ID da Operação:: TeamsGetAllUsers

Obter todos os usuários de equipes especificadas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
IDs de equipa	teamId		array	Ids de equipe para solicitar. Se estiver vazio, obtém todos os utilizadores de todas as equipas a que tem acesso.

Devoluções

Body: MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-

Obter transações pré-pagas de uma subscrição

ID da Operação:: SubscriptionsGetPrepaidTransactions

Obtenha as transações pré-pagas de uma assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscriptionId	True	string	ID da subscrição para obter transações para

Devoluções

response: array of PrepaidTransactionInfo

Obter uma categoria específica

ID da Operação:: CategoriesGet

Pedido de amostra:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a que pertence a categoria
ID da categoria	categoryId	True	string	ID da categoria a obter

Devoluções

Body: CategoryInfo

Obter usuário por ID

ID da Operação:: UsersGet

Retorna um objeto de usuário com detalhes como seu endereço de e-mail e informações de dever.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	Identificador do usuário a ser obtido. Use 'Eu' para obter informações sobre o usuário conectado no momento. Isso não é possível com uma chave api. Também pode ser um endereço de e-mail de um usuário da equipe ou o id exclusivo de um objeto de usuário de acordo com ele."

Devoluções

Body: V2.UserDetails

Obter visão geral paginada do evento

ID da Operação:: EventsGetOverviewPaged

Obtenha a página de visão geral do evento. Se houver mais resultados, você também receberá um token de continuação que pode ser adicionado ao filtro de eventos.

Parâmetros

Name	Chave	Tipo	Description
Limite	maxResults	integer	Define o limite de detalhes de alerta recuperados por solicitação. São permitidos de 1 a 100 por solicitação. O número de alertas pode ser menor se filtrado, mas pelo menos 1.
nextPartitionKey	nextPartitionKey	string
nextRowKey	nextRowKey	string
nextTableName	nextTableName	string
eventSourceId	eventSourceId	string
eventStatusCode	eventStatusCode	integer	0 = Nenhum 1 = Processamento 2 = Sinalizado 3 = Filtrado 4 = Resolvido 5 = Descartado 6 = Reconhecido 7 = Suprimido 8 = NoRuleApplied 9 = MultipleTargetStatus 1000 = Erro
maxCreationDate	maxCreationDate	date-time
minCreationDate	minCreationDate	date-time
modificadoDesde	modifiedSince	date-time
TeamID	teamid	string
textToSearch	textToSearch	string

Devoluções

Body: PagedResultsPublic-1-OverviewEvent-

Obter Webhook por Id

ID da Operação:: WebhooksGet

Retorna informações do webhook especificado pela id passada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Webhook de saída	webhookId	True	string	Id do webhook de saída a ser recuperado.

Devoluções

Body: WebhookInfo

Obter Webhooks

ID da Operação:: WebhooksGetAll

Retorna uma coleção de webhooks de saída definidos no sistema.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId		string	ID da equipa.

Devoluções

response: array of WebhookInfo

Obtém a imagem de uma equipe especificada

ID da Operação:: TeamsGetImage

Obtém a imagem de uma equipe especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	O id da equipe da qual você deseja obter a imagem.
Altura da imagem	height		integer	Parâmetro opcional que define a altura desejada da imagem recuperada.
Largura da imagem	width		integer	Parâmetro opcional que define a largura desejada da imagem recuperada.

Devoluções

Body: V2.TeamImageDetails

Obtém as licenças de número de voz de uma assinatura

ID da Operação:: SubscriptionsGetVoiceNumberLicense

Obtém as licenças de número de voz de uma assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscriptionId	True	string	ID da subscrição

Devoluções

Body: UserLicenseInfo

Obtém as licenças de usuário de uma assinatura

ID da Operação:: SubscriptionsGetUserLicenses

Obtém as licenças de usuário de uma assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscriptionId	True	string	ID da subscrição

Devoluções

Body: UserLicenseInfo

Obtém configurações de alerta de uma equipe específica

ID da Operação:: TeamsGetAlertSettings

Obtém configurações de alerta de uma equipe específica.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId		array	ID da equipa.

Devoluções

Body: MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-

Obtém configurações de alerta de uma equipe específica

ID da Operação:: TeamsGetAlertSettings99

Obtém configurações de alerta de uma equipe específica.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe para a qual as configurações devem ser recuperadas.

Devoluções

Body: AlertSettings

Obtém fontes de eventos de uma equipe específica

ID da Operação:: TeamsGetEventSources

Obtém fontes de eventos de uma equipe específica.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe para a qual as fontes devem ser recuperadas.

Devoluções

response: array of EventSourceEndpointInfo

Obtém informações de uma equipe específica

ID da Operação:: TeamsGetInfo

Obtém informações de uma equipe específica.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa que deve ser recuperada.

Devoluções

Body: TeamInfo

Obtém o progresso da configuração de um usuário específico

ID da Operação:: UsersGetSetupProgress

Obtém o progresso da configuração de um usuário específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID do usuário para o qual o progresso deve ser recuperado.

Devoluções

Body: UserSetupProgress

Obtém o progresso da configuração de uma equipe específica

ID da Operação:: TeamsGetSetupProgress

Obtém o progresso da configuração de uma equipe específica.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe para a qual o progresso deve ser recuperado.

Devoluções

Body: TeamSetupProgress

Obtém os nomes de todas as imagens de categoria de alerta

ID da Operação:: CategoriesGetImageNames

Obtém os nomes de todas as imagens de categoria de alerta. Você pode obter a imagem indo para account.signl4.com/images/alerts/categoryImageName.svg.

Devoluções

Name	Caminho	Tipo	Description
		array of string

Obtém um anexo especificado de um alerta especificado

ID da Operação:: AlertsGetAttachment

Obtém um anexo especificado de um alerta especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	ID do alerta que contém o anexo desejado.
ID do anexo	attachmentId	True	string	ID do anexo, que você deseja recuperar.
Largura da imagem	width		integer	Parâmetro opcional que define a largura desejada da imagem recuperada.
Altura da imagem	height		integer	Parâmetro opcional que define a altura desejada da imagem recuperada.
Scale	scale		boolean	Parâmetro opcional que define se deseja dimensionar a imagem recuperada. O padrão é definido como true.

Devoluções

response: binary

Poupe férias para uma equipa

ID da Operação:: TeamsSaveHolidays

Guarde férias para uma equipa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa para a qual pretende guardar férias
Ano	year	True	integer	Ano para o qual quer poupar férias
day	day		integer
mês	month		integer	0 = Não definido 1 = janeiro 2 = fevereiro 3 = março 4 = abril 5 = maio 6 = junho 7 = julho 8 = agosto 9 = setembro 10 = outubro 11 = novembro 12 = dezembro

Devoluções

Body: V2.TeamHolidayDetails

Punch User como Gerente

ID da Operação:: DutiesUserPunchInAsManager

O usuário especificado será perfurado para o dever como gerente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
teamIds	teamIds		array of string
userId	userId	True	string

Devoluções

Body: MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Punch User em

ID da Operação:: DutiesUserPunchIn

O usuário especificado será perfurado para o dever.

Parâmetros

Name	Chave	Necessário	Tipo	Description
teamIds	teamIds		array of string
userId	userId	True	string

Devoluções

Body: MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Punch Usuário para fora

ID da Operação:: DutiesUserPunchOut

O usuário especificado será expulso do dever.

Parâmetros

Name	Chave	Necessário	Tipo	Description
teamIds	teamIds		array of string
userId	userId	True	string

Devoluções

Body: MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Receba alerta

ID da Operação:: AlertsGet

Recebe um alerta por id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	ID do alerta solicitado.
ID de utilizador	userId		string	ID de Utilizador.

Devoluções

Body: V2.AlertInfo

Receba férias para a equipa

ID da Operação:: TeamsGetHolidays

Obtenha férias para a equipa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a partir da qual pretende obter férias

Devoluções

Body: V2.TeamHolidayDetails

Receba notificações de alerta

ID da Operação:: AlertsGetNotifications

Receba notificações de todos os usuários por id de alerta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	ID do alerta solicitado.

Devoluções

response: array of AlertNotificationInfo

Recebe alertas paginados

ID da Operação:: AlertsGetPaged

Recebe alertas paginados.

Parâmetros

Name	Chave	Tipo	Description
ID de utilizador	userId	string	ID de utilizador do utilizador para o qual pretende receber alertas.
Limite de alerta	maxResults	integer	Define o limite de detalhes de alerta recuperados por solicitação. São permitidos de 1 a 100 por solicitação. O número de alertas pode ser menor se filtrado, mas pelo menos 1.
depoisId	afterId	string
alertIds	alertIds	array of string
alertStatusCodes	alertStatusCodes	integer	0 = Nenhum 1 = Aberto 2 = Reconhecido 4 = Fechado 8 = NãoResposta 16 = Falha 32 = Erro
categoryIds	categoryIds	array of string
nextPartitionKey	nextPartitionKey	string
nextRowKey	nextRowKey	string
nextTableName	nextTableName	string
Id externo	externalId	string
maxCriado	maxCreated	date-time
minCriado	minCreated	date-time
modificadoDesde	modifiedSince	date-time
showPersonalHiddenCategorias	showPersonalHiddenCategories	boolean
teamIds	teamIds	array of string
textToSearch	textToSearch	string

Devoluções

Body: PagedResultsPublic-1-V2.AlertInfo-

Reconhecer um alerta

ID da Operação:: AlertsAcknowledge

Reconheça um alerta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do alerta	alertId	True	string	Id para confirmar um alerta.
descr	descr		string
uid	uid	True	string

Devoluções

Body: V2.AlertInfo

Reconhecer vários alertas

ID da Operação:: AlertsAcknowledgeMultiple

Este método confirma todos os alertas fornecidos.

Parâmetros

Name	Chave	Necessário	Tipo
alertIds	alertIds	True	array of string
descr	descr		string
uid	uid	True	string

Recuperar toda a definição disponível

ID da Operação:: RemoteActionsGetAvailableDefinitions

Recupere toda a definição disponível.

Parâmetros

Name

Chave

Necessário

Tipo

Description

Linguagem

language

integer

0 = EN
1 = DE

Devoluções

response: array of V2.RemoteActionDefinitionDetails

Recuperar uma definição

ID da Operação:: RemoteActionsGetDefinition

Recuperar uma definição.

Parâmetros

Name

Chave

Necessário

Tipo

Description

ID da definição

definitionId

True

string

Id da definição

Linguagem

language

integer

0 = EN
1 = DE

Devoluções

Body: V2.RemoteActionDefinitionDetails

Remove um usuário ou convite de uma equipe

ID da Operação:: TeamsRemoveUser

Remove um usuário ou convite de uma equipe.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe da qual o usuário deve ser excluído
ID de utilizador	userId	True	string	ID do usuário que deve ser excluído
ID de utilizador	requesterUserId		string	ID de usuário do usuário que removerá o outro usuário.

Retirar o encerramento de vários alertas

ID da Operação:: AlertsUndoCloseMultiple

Esse método tenta desfazer vários fechamentos de alerta. A operação é tratada em segundo plano.

Parâmetros

Name	Chave	Necessário	Tipo
alertIds	alertIds	True	array of string
descr	descr		string
uid	uid	True	string

Retorna ações remotas

ID da Operação:: RemoteActionsGetActions

Pedido de amostra:

GET /RemoteActions?externalId=12345

Parâmetros

Name	Chave	Tipo	Description
ID da Equipa	teamId	string	ID da Equipa
ID externo	externalId	string	Filtro opcional para identificação externa
Tipo	type	integer	0 = Desconhecido 1 = Script 2 = EnterpriseAlert 3 = Webhook
Serviço Executor	executorService	string	Serviço Executor
Linguagem	language	integer	0 = EN 1 = DE

Devoluções

response: array of V2.RemoteActionInfo

Retorna os recursos de uma assinatura especificada

ID da Operação:: SubscriptionsGetFeatures

Retorna os recursos de uma assinatura especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da subscrição	subscriptionId	True	string	Id da assinatura da qual os recursos precisam ser recuperados.

Devoluções

response: array of SubscriptionFeature

Retorna todas as informações sobre uma determinada instância de script

ID da Operação:: ScriptsGetInfo

Obtém a instância de script especificada pela id da instância passada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da instância de script	instanceId	True	string	ID da instância da instância de script a ser retornada.

Devoluções

Body: ScriptInstanceDetails

Retorna todas as instâncias de script da equipe SIGNL4

ID da Operação:: ScriptsGetAll

Retorna todas as instâncias de script na assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
IDs de equipa	teamId		array	IDs de equipa.
Modificado desde	modifiedSince		date-time	Modificado desde então.

Devoluções

response: array of ScriptInstanceInfo

Retorna todos os scripts de inventário

ID da Operação:: ScriptsGetAll76

Retorna todos os scripts de inventário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Linguagem	language		string	Linguagem

Devoluções

response: array of InventoryScriptInfo

Retorna todos os scripts de inventário disponíveis

ID da Operação:: ScriptsGetAvailable

Retorna todos os scripts de inventário disponíveis que podem ser adicionados a uma assinatura SIGNL4.

Devoluções

response: array of InventoryScriptInfo

Retorna trabalhos remotos paginados do diário

ID da Operação:: RemoteActionsGetJobsPaged

Pedido de amostra:

POST /remoteActions/journal/paged?maxResults=100
{
    "statusCode": "Executed"
}

Parâmetros

Name	Chave	Tipo	Description
Resultados máximos	maxResults	integer	Resultados máximos
Linguagem	language	integer	0 = EN 1 = DE
actionId	actionId	string
continuationToken	continuationToken	string
maxCreationDate	maxCreationDate	date-time
minCreationDate	minCreationDate	date-time
modificadoDesde	modifiedSince	date-time
statusCódigos	statusCodes	integer	0 = Nenhum 1 = Pendente 2 = Pronto 4 = Corrida 8 = Executado 16 = Erro

Devoluções

Body: PagedResultsPublic-1-V2.RemoteJob-

Retorna um script de inventário por sua id

ID da Operação:: ScriptsGet

Obtém o script especificado pela id de script passada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Script ID	scriptId	True	string	O Id do script a ser retornado.
Linguagem	language		string	Linguagem

Devoluções

Body: ScriptInstanceDetails

Retorna um trabalho remoto do diário

ID da Operação:: RemoteActionsGetJob

Pedido de amostra:

GET /remoteActions/journal/{jobId}

Parâmetros

Name

Chave

Necessário

Tipo

Description

ID do trabalho

jobId

True

string

O id do trabalho a devolver

Linguagem

language

integer

0 = EN
1 = DE

Devoluções

Body: V2.RemoteJob

Retorna uma ação remota

ID da Operação:: RemoteActionsGet

Pedido de amostra:

GET /RemoteActions/{actionId}

Parâmetros

Name

Chave

Necessário

Tipo

Description

ID da ação

actionId

True

string

O id da ação de devolução

Linguagem

language

integer

0 = EN
1 = DE

Devoluções

Body: V2.RemoteActionDetails

Salvar várias agendas

ID da Operação:: DutiesSaveMultiple

Salve várias agendas. É possível substituir os horários existentes, se desejar.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a definir
Substituir	overrideExisting		boolean	Substitua ou corte agendas existentes se definido como true.
fim	end		date-time
id	id		string
options	options		integer
start	start		date-time
userId	userId		string

Devoluções

response: array of ScheduleInfo

Suprimir um direito específico

ID da Operação:: DutiesDelete

Suprimir um direito específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipa a que pertence o dever.
ID do Agendamento de Serviço	dutyId	True	string	ID do dever a suprimir.

Valida um número de telefone criado anteriormente para um usuário

ID da Operação:: UsersValidatePhoneNumber

Valida um número de telefone criado anteriormente para um usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID de usuário do usuário que você deseja validar o número de telefone criado anteriormente
Número de telefone	phoneNumber		string
código de validação	validationCode		string

Validar intervalos de tempo de um padrão

ID da Operação:: TeamsValidateAlertPattern

Valide um intervalo de tempo de um padrão em relação a todos os intervalos de tempo existentes de outros padrões.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Equipa	teamId	True	string	ID da equipe do padrão de alerta
ID do padrão	patternId		string	Alertando o ID do padrão para o qual você deseja economizar intervalos de tempo. Pode ser nulo
IDs de categoria	categoryIds		array	IDs de categoria do padrão que você deseja validar. Pode ser null.
hora	hour		integer
minutes	minutes		integer
Dia da semana	weekday		integer	0 = Feriado 1 = Segunda-feira 2 = Terça-feira 3 = Quarta-feira 4 = Quinta-feira 5 = Sexta-feira 6 = Sábado 7 = Domingo
id	id		string

Devoluções

response: array of V2.TimeSlotValidationResultDetails

Verifica se um usuário tem a permissão fornecida

ID da Operação:: UsersCheckPermissions

Verifica se um usuário tem a permissão fornecida.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	userId	True	string	ID do usuário para verificar as permissões.
permissões	permissions		array of string
teamIds	teamIds		array of string

Devoluções

Body: MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-

Definições

AlertAuditReportFileInfo

Name	Caminho	Tipo
fileName	fileName	string
fileSizeInBytes	fileSizeInBytes	integer
Por últimoRecord	lastRecord	date-time
lastUpdated	lastUpdated	date-time
mês	month	integer
ano	year	integer

AlertEscalationModes

0 = Gestor
1 = Equipa

0 = Gestor
1 = Equipa

: integer

AlertFilterActions

0 = Suprimir
1 = Ocultar
2 = Mudo

0 = Suprimir
1 = Ocultar
2 = Mudo

: integer

AlertFilterModes

0 = Desligado
1 = WhiteListAllCategories

0 = Desligado
1 = WhiteListAllCategories

: integer

AlertNotificationInfo

Name	Caminho	Tipo	Description
address	address	string
deviceName	deviceName	string
Última atualização	lastUpdate	date-time
messageStatus	messageStatus	AlertNotificationInfoMessageStatus	0 = Nenhum 1 = Rejeitado 2 = Falha 3 = Em fila 4 = Transmitido 5 = Buffered 6 = Entregue 7 = Cancelado 8 = Protegido 9 = AbusoProtegido 10 = Atrasado
messageStatusErrorCode	messageStatusErrorCode	integer
notificationChannelType	notificationChannelType	AlertNotificationInfoChannelType	0 = Nenhum 1 = Empurrar 2 = E-mail 4 = Bot 8 = Voz 16 = SMS
userId	userId	string
userStatus	userStatus	AlertNotificationInfoUserStatus	0 = Nenhum 1 = MessageCreated 2 = NotOnDuty 3 = CategoriaOculto 4 = CategoriaMuted 5 = NoNotificationProfiles 6 = NoMessagesByNotificationProfiles

AlertNotificationInfoChannelType

0 = Nenhum
1 = Empurrar
2 = E-mail
4 = Bot
8 = Voz
16 = SMS

0 = Nenhum
1 = Empurrar
2 = E-mail
4 = Bot
8 = Voz
16 = SMS

: integer

AlertNotificationInfoMessageStatus

0 = Nenhum
1 = Rejeitado
2 = Falha
3 = Em fila
4 = Transmitido
5 = Buffered
6 = Entregue
7 = Cancelado
8 = Protegido
9 = AbusoProtegido
10 = Atrasado

0 = Nenhum
1 = Rejeitado
2 = Falha
3 = Em fila
4 = Transmitido
5 = Buffered
6 = Entregue
7 = Cancelado
8 = Protegido
9 = AbusoProtegido
10 = Atrasado

: integer

AlertNotificationInfoUserStatus

0 = Nenhum
1 = MessageCreated
2 = NotOnDuty
3 = CategoriaOculto
4 = CategoriaMuted
5 = NoNotificationProfiles
6 = NoMessagesByNotificationProfiles

0 = Nenhum
1 = MessageCreated
2 = NotOnDuty
3 = CategoriaOculto
4 = CategoriaMuted
5 = NoNotificationProfiles
6 = NoMessagesByNotificationProfiles

: integer

AlertResponseModes

2 = SingleAcknowledge
4 = MultiReconhecimento

2 = SingleAcknowledge
4 = MultiReconhecimento

: integer

Configurações de alerta

Name	Caminho	Tipo	Description
escAtivado	escEnabled	boolean
escMode	escMode	AlertEscalationModes	0 = Gestor 1 = Equipa
escRefId	escRefId	string
filterAction	filterAction	AlertFilterActions	0 = Suprimir 1 = Ocultar 2 = Mudo
filterMode	filterMode	AlertFilterModes	0 = Desligado 1 = WhiteListAllCategories
notificationProfileOverrides	notificationProfileOverrides	array of AlertSettingsNotificationProfile
optar por não participar	optOut	TeamCategoryOptOutModes	0 = Nenhum 1 = Desativado 2 = Pessoal
overrideNotificationProfiles	overrideNotificationProfiles	boolean
persNotInterval	persNotInterval	integer
persNotMode	persNotMode	PersistentNotificationModes	0 = Desligado 1 = Resumo
responseMode	responseMode	AlertResponseModes	2 = SingleAcknowledge 4 = MultiReconhecimento
Tempo de resposta	responseTime	integer

AlertSettingsChannelType

0 = Nenhum
1 = Empurrar
2 = Voz
3 = SMS

0 = Nenhum
1 = Empurrar
2 = Voz
3 = SMS

: integer

AlertSettingsNotificationProfile

Name

Caminho

Tipo

Description

canal

channel

AlertSettingsChannelType

0 = Nenhum
1 = Empurrar
2 = Voz
3 = SMS

atraso

delay

integer

enabled

boolean

CategoriaAumento

Name	Caminho	Tipo	Description
enabled	enabled	boolean
id	id	string
nome	name	string
tipo	type	CategoryAugmentationType	0 = Parâmetro 1 = Sujeito 2 = Texto 3 = Localização
valor	value	string

CategoryAugmentationType

0 = Parâmetro
1 = Sujeito
2 = Texto
3 = Localização

0 = Parâmetro
1 = Sujeito
2 = Texto
3 = Localização

: integer

CategoriaEnriquecimento

Name	Caminho	Tipo	Description
id	id	string
nome	name	string
tipo	type	CategoryEnrichmentType	0 = Parâmetro 1 = Hiperligação
valor	value	string

CategoriaTipo de Enriquecimento

0 = Parâmetro
1 = Hiperligação

0 = Parâmetro
1 = Hiperligação

: integer

CategoryInfo

Name	Caminho	Tipo	Description
augmentations	augmentations	array of CategoryAugmentation
color	color	string
enriquecimento	enrichments	array of CategoryEnrichment
id	id	string
nome_da_imagem	imageName	string
isDefault	isDefault	boolean
palavra-chaveCorrespondência	keywordMatching	KeywordMatchingType	0 = Qualquer 1 = Tudo
Palavras Chave	keywords	array of string
palavras-chaveExcluído	keywordsExcluded	array of string
nome	name	string
options	options	CategoryInfoOptions	0 = Nenhum 1 = Oculto 2 = DenyDelete 4 = HideOptOut 8 = OcultarPalavras-chave
order	order	integer
teamId	teamId	string

CategoryInfoOptions

0 = Nenhum
1 = Oculto
2 = DenyDelete
4 = HideOptOut
8 = OcultarPalavras-chave

0 = Nenhum
1 = Oculto
2 = DenyDelete
4 = HideOptOut
8 = OcultarPalavras-chave

: integer

CategoriaMétricas

Name	Caminho	Tipo
categoryId	categoryId	string
dura24h	last24h	integer
lastAlert	lastAlert	date-time
assinanteCount	subscriberCount	integer

CategorySubscriptionInfo

Name

Caminho

Tipo

Description

estado

status

CategorySubscriptionStatus

0 = Subscrito
1 = Mudo
2 = Oculto

userId

string

CategorySubscriptionStatus

0 = Subscrito
1 = Mudo
2 = Oculto

0 = Subscrito
1 = Mudo
2 = Oculto

: integer

CanalPriceInfo

Name	Caminho	Tipo	Description
mensagem de texto (SMS)	sms	integer
voicePerMinute	voicePerMinute	integer

DeverResumoInfo

Name	Caminho	Tipo
Fim do dever	dutyEnd	date-time
Identificação do dever	dutyId	string
dutyStart	dutyStart	date-time

EventParameterInfo

Name	Caminho	Tipo	Description
nome	name	string
order	order	integer
tipo	type	EventParameterTypes	0 = Nenhum 1 = Objeto 2 = Matriz 3 = Construtor 4 = Propriedade 5 = Comentário 6 = Inteiro 7 = Flutuador 8 = String 9 = Booleano 10 = Nulo 11 = Indefinido 12 = Data 13 = Bruto 14 = Bytes 15 = GUID 16 = Uri 17 = TimeSpan 100 = Html
valor	value	string

EventParameterTypes

0 = Nenhum
1 = Objeto
2 = Matriz
3 = Construtor
4 = Propriedade
5 = Comentário
6 = Inteiro
7 = Flutuador
8 = String
9 = Booleano
10 = Nulo
11 = Indefinido
12 = Data
13 = Bruto
14 = Bytes
15 = GUID
16 = Uri
17 = TimeSpan
100 = Html

0 = Nenhum
1 = Objeto
2 = Matriz
3 = Construtor
4 = Propriedade
5 = Comentário
6 = Inteiro
7 = Flutuador
8 = String
9 = Booleano
10 = Nulo
11 = Indefinido
12 = Data
13 = Bruto
14 = Bytes
15 = GUID
16 = Uri
17 = TimeSpan
100 = Html

: integer

EventSeverities

0 = Baixo
1 = Maior
2 = Crítica

0 = Baixo
1 = Maior
2 = Crítica

: integer

EventSourceEndpointInfo

Name	Caminho	Tipo	Description
address	address	string
descrição	description	string
desactivado	disabled	boolean
groupId	groupId	string
id	id	string
último evento	lastEvent	date-time
nome	name	string
subtipo	subType	string
ID de subscrição	subscriptionId	string
teamId	teamId	string
tipo	type	EventSourceTypes	0 = Nenhum 1 = E-mail 2 = WebHook 3 = Script 4 = Sistema 5 = Manual 6 = Voz 7 = Api

EventSourceTypes

0 = Nenhum
1 = E-mail
2 = WebHook
3 = Script
4 = Sistema
5 = Manual
6 = Voz
7 = Api

0 = Nenhum
1 = E-mail
2 = WebHook
3 = Script
4 = Sistema
5 = Manual
6 = Voz
7 = Api

: integer

EventStatusCodes

0 = Nenhum
1 = Processamento
2 = Sinalizado
3 = Filtrado
4 = Resolvido
5 = Descartado
6 = Reconhecido
7 = Suprimido
8 = NoRuleApplied
9 = MultipleTargetStatus
1000 = Erro

0 = Nenhum
1 = Processamento
2 = Sinalizado
3 = Filtrado
4 = Resolvido
5 = Descartado
6 = Reconhecido
7 = Suprimido
8 = NoRuleApplied
9 = MultipleTargetStatus
1000 = Erro

: integer

InventoryScriptInfo

Name	Caminho	Tipo
Configurações	config
dados	data	ScriptDescriptionData
eventPattern	eventPattern
localizaçãoDetalhes	localizationDetails	array of ScriptLocalizationDetail
scriptId	scriptId	string
nome_script	scriptName	string
Visibilidade	visibility	string

KeywordMatchingType

0 = Qualquer
1 = Tudo

0 = Qualquer
1 = Tudo

: integer

LocalizaçãoInfo

Name	Caminho	Tipo
latitude	latitude	double
longitude	longitude	double
carimbo de data/hora	timestamp	date-time

MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-

Name	Caminho	Tipo	Description
dados	data	array of EventSourceEndpointInfo
erros	errors	array of V2.EventSourceEndpointError

MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-

Name	Caminho	Tipo	Description
dados	data	array of TeamDutySummaryInfo
erros	errors	array of V2.TeamDutySummaryError

MultiTeamResult-2-UserDutyInfo-V2.DutyError-

Name	Caminho	Tipo	Description
dados	data	array of UserDutyInfo
erros	errors	array of V2.DutyError

MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-

Name	Caminho	Tipo	Description
dados	data	array of V2.AlertCountsDetails
erros	errors	array of V2.AlertReportError

MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-

Name	Caminho	Tipo	Description
dados	data	array of V2.AlertSettingsDetails
erros	errors	array of V2.AlertSettingsError

MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-

Name	Caminho	Tipo	Description
dados	data	array of V2.CategoryDetails
erros	errors	array of V2.CategoryError

MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-

Name	Caminho	Tipo	Description
dados	data	array of V2.TeamDutySettingsDetails
erros	errors	array of V2.TeamDutySettingsError

MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-

Name	Caminho	Tipo	Description
dados	data	array of V2.TeamPermissions
erros	errors	array of V2.PermissionError

MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-

Name	Caminho	Tipo	Description
dados	data	array of V2.UserDetails
erros	errors	array of V2.TeamUserError

MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Name	Caminho	Tipo	Description
dados	data	array of V2.UserDutyDetails
erros	errors	array of V2.DutyChangeError

Visão geralEvento

Name	Caminho	Tipo	Description
reconhecidoAlertas	acknowledgedAlerts	array of string
alertId	alertId	string
categoryId	categoryId	string
fechadoAlertas	closedAlerts	array of string
tempo de criação	creationTime	date-time
eventSourceGroupId	eventSourceGroupId	string
eventSourceId	eventSourceId	string
eventSourceTeamId	eventSourceTeamId	string
eventSourceType	eventSourceType	EventSourceTypes	0 = Nenhum 1 = E-mail 2 = WebHook 3 = Script 4 = Sistema 5 = Manual 6 = Voz 7 = Api
eventStatus	eventStatus	EventStatusCodes	0 = Nenhum 1 = Processamento 2 = Sinalizado 3 = Filtrado 4 = Resolvido 5 = Descartado 6 = Reconhecido 7 = Suprimido 8 = NoRuleApplied 9 = MultipleTargetStatus 1000 = Erro
id	id	string
últimaModificação	lastModified	date-time
severity	severity	EventSeverities	0 = Baixo 1 = Maior 2 = Crítica
teamId	teamId	string
enviar SMS	text	string
title	title	string

PagedResultsPublicContinuationToken

Name	Caminho	Tipo
nextPartitionKey	nextPartitionKey	string
nextRowKey	nextRowKey	string
nextTableName	nextTableName	string

PagedResultsPublic-1-OverviewEvent-

Name	Caminho	Tipo
continuationToken	continuationToken	PagedResultsPublicContinuationToken
temMais	hasMore	boolean
results	results	array of OverviewEvent

PagedResultsPublic-1-V2.AlertInfo-

Name	Caminho	Tipo
continuationToken	continuationToken	PagedResultsPublicContinuationToken
temMais	hasMore	boolean
results	results	array of V2.AlertInfo

PagedResultsPublic-1-V2.RemoteJob-

Name	Caminho	Tipo
continuationToken	continuationToken	PagedResultsPublicContinuationToken
temMais	hasMore	boolean
results	results	array of V2.RemoteJob

PersistentNotificationModes

0 = Desligado
1 = Resumo

0 = Desligado
1 = Resumo

: integer

Pré-pagoSaldoInfo

Name	Caminho	Tipo
saldo	balance	integer
mais recenteTopUp	latestTopUp	date-time
pendentesTransações	pendingTransactions	boolean

Pré-pagoConfiguraçõesInfo

Name	Caminho	Tipo
topUpAmount	topUpAmount	integer
topUpEnabled	topUpEnabled	boolean
topUpLimit	topUpLimit	integer

Pré-pagoTransactionInfo

Name	Caminho	Tipo
Montante	amount	integer
autoTopUpId	autoTopUpId	string
criado	created	date-time
criado por	createdBy	string
moeda	currency	string
modified	modified	date-time
Código do pacote	packageCode	string
estado	status	string
código de estado	statusCode	integer
ID de subscrição	subscriptionId	string
transactionId	transactionId	string

ScheduleInfo

Name	Caminho	Tipo
fim	end	date-time
id	id	string
options	options	integer
start	start	date-time
userId	userId	string

ScriptDescriptionData

Name	Caminho	Tipo
descrição	description	string
nome	name	string
scriptType	scriptType	string
breveDescrição	shortDescription	string

ScriptInstanceDetails

Name	Caminho	Tipo
Configurações	config
customScriptDescription	customScriptDescription	string
customScriptName	customScriptName	string
enabled	enabled	boolean
eventPattern	eventPattern
eventSourceId	eventSourceId	string
instanceId	instanceId	string
últimaModificação	lastModified	date-time
runtimeInformation	runtimeInformation	ScriptInstanceInfoRuntimeInformationModel
scriptId	scriptId	string
nome_script	scriptName	string
ID de subscrição	subscriptionId	string
teamId	teamId	string
webhookUrl	webhookUrl	string

ScriptInstanceInfo

Name	Caminho	Tipo
customScriptDescription	customScriptDescription	string
customScriptName	customScriptName	string
enabled	enabled	boolean
eventPattern	eventPattern
eventSourceId	eventSourceId	string
instanceId	instanceId	string
últimaModificação	lastModified	date-time
runtimeInformation	runtimeInformation	ScriptInstanceInfoRuntimeInformationModel
scriptId	scriptId	string
nome_script	scriptName	string
ID de subscrição	subscriptionId	string
teamId	teamId	string

ScriptInstanceInfoRuntimeInformationModel

Name

Caminho

Tipo

Description

runtimeStatus

ScriptInstanceInfoRuntimeStatus

0 = Desconhecido
1 = Início
2 = OK
3 = Parar
4 = Interrompido
-1 = Erro

runtimeStatusMessage

string

ScriptInstanceInfoRuntimeStatus

0 = Desconhecido
1 = Início
2 = OK
3 = Parar
4 = Interrompido
-1 = Erro

0 = Desconhecido
1 = Início
2 = OK
3 = Parar
4 = Interrompido
-1 = Erro

: integer

ScriptLocalizationDetail

Name	Caminho	Tipo
Configurações	config
dados	data	ScriptDescriptionData
linguagem	language	string

SubscriptionFeature

Name	Caminho	Tipo
nome	name	string
tipo	type	integer
valor	value	string

SubscriçãoInfo

Name	Caminho	Tipo
branchId	branchId	string
country	country	string
moeda	currency	string
externalAccountId	externalAccountId	string
id	id	string
nome	name	string
próximoFaturação	nextBilling	date-time
ownerId	ownerId	string
Código do plano	planCode	string
PlanState	planState	integer
referralEnabled	referralEnabled	boolean
estado	status	integer

TeamCategoryOptOutModes

0 = Nenhum
1 = Desativado
2 = Pessoal

0 = Nenhum
1 = Desativado
2 = Pessoal

: integer

TeamDutySummaryInfo

Name	Caminho	Tipo
dutyAssistEnabled	dutyAssistEnabled	boolean
deverResumos	dutySummaries	array of DutySummaryInfo
teamId	teamId	string

TeamInfo

Name	Caminho	Tipo
id	id	string
imageLastModified	imageLastModified	date-time
Ids de membro	memberIds	array of string
nome	name	string
setupProgressEnabled	setupProgressEnabled	boolean
ID de subscrição	subscriptionId	string
timezone	timezone	string

TeamSetupProgress

Name	Caminho	Tipo
completedPassos	completedSteps	array of string
teamId	teamId	string
carimbo de data/hora	timestamp	date-time

UserDutyInfo

Name	Caminho	Tipo
lastAlterar	lastChange	date-time
Plantão	onDuty	boolean
onManagerDuty	onManagerDuty	boolean
em atraso	overdue	boolean
teamId	teamId	string
userId	userId	string

Imagem de usuário

Name	Caminho	Tipo
conteúdo	content	byte
contentDispostion	contentDispostion	string
contentEncoding	contentEncoding	string
TipoDeConteúdo	contentType	string
últimaModificação	lastModified	date-time
nome	name	string

Informações do usuário

Name	Caminho	Tipo
colorIndex	colorIndex	integer
contatoEndereços	contactAddresses	array of
deverInfos	dutyInfos	UserDutyInfo
externalAuthProvider	externalAuthProvider	string
id	id	string
isDesativada	isDeactivated	boolean
isConvidar	isInvite	boolean
isRemoteActionPinSet	isRemoteActionPinSet	boolean
visto pela última vez	lastSeen	date-time
correio	mail	string
nome	name	string
roleId	roleId	string
ID de subscrição	subscriptionId	string
Fuso horário	timeZone	string
userImageLastModified	userImageLastModified	date-time

UserLicenseInfo

Name	Caminho	Tipo
currentUsers	currentUsers	integer
isFree	isFree	boolean
isTrial	isTrial	boolean
Usuários licenciados	licensedUsers	integer
Código do plano	planCode	string

UserPermission

Name	Caminho	Tipo	Description
permitido	allowed	boolean
permissão	permission	string

UserSetupProgress

Name	Caminho	Tipo
completedPassos	completedSteps	array of string
carimbo de data/hora	timestamp	date-time
userId	userId	string

V2. AlertAnnotationDetails

Name	Caminho	Tipo	Description
id	id	string
teamId	teamId	string
enviar SMS	text	string
carimbo de data/hora	timestamp	date-time
tipo	type	V2.AlertAnnotationTypes	0 = Nenhum 1 = Texto 2 = Imagem
userId	userId	string

V2. AlertAnnotationTypes

0 = Nenhum
1 = Texto
2 = Imagem

0 = Nenhum
1 = Texto
2 = Imagem

: integer

V2. AlertAttachmentInfo

Name	Caminho	Tipo
TipoDeConteúdo	contentType	string
id	id	string
nome	name	string

V2. AlertaCategoriaContagemDetalhes

Name	Caminho	Tipo
reconheceu	acknowledged	integer
categoryId	categoryId	string
fechado	closed	integer
não manuseado	unhandled	integer

V2. AlertCountTypes

1 = TeamCurrentDuty
2 = TeamLastDuty
3 = UserLastDutyChange
4 = Últimas 24 horas

1 = TeamCurrentDuty
2 = TeamLastDuty
3 = UserLastDutyChange
4 = Últimas 24 horas

: integer

V2. AlertCountsDetalhes

Name	Caminho	Tipo	Description
reconheceu	acknowledged	integer
categoryContagens	categoryCounts	array of V2.AlertCategoryCountsDetails
fechado	closed	integer
fim	end	date-time
últimaModificação	lastModified	date-time
start	start	date-time
ID de subscrição	subscriptionId	string
teamId	teamId	string
tipo	type	V2.AlertCountTypes	1 = TeamCurrentDuty 2 = TeamLastDuty 3 = UserLastDutyChange 4 = Últimas 24 horas
typeString	typeString	string
não manuseado	unhandled	integer
userId	userId	string

V2. AlertDeliveryStatusCodes

0 = Nenhum
1 = Aberto
2 = Falha
4 = Transmitido
6 = Entregue
8 = Protegido
9 = AbusoProtegido
22 = Parcialmente Reprovado
24 = Parcialmente Transmitido
26 = Parcialmente Entregue
30 = NoOneOnDuty
31 = NoOneNotified

0 = Nenhum
1 = Aberto
2 = Falha
4 = Transmitido
6 = Entregue
8 = Protegido
9 = AbusoProtegido
22 = Parcialmente Reprovado
24 = Parcialmente Transmitido
26 = Parcialmente Entregue
30 = NoOneOnDuty
31 = NoOneNotified

: integer

V2. AlertDeliveryStatusDetails

Name

Caminho

Tipo

Description

alertId

string

código de estado

statusCode

V2.AlertDeliveryStatusCodes

0 = Nenhum
1 = Aberto
2 = Falha
4 = Transmitido
6 = Entregue
8 = Protegido
9 = AbusoProtegido
22 = Parcialmente Reprovado
24 = Parcialmente Transmitido
26 = Parcialmente Entregue
30 = NoOneOnDuty
31 = NoOneNotified

userDeliveryStatus

array of V2.UserDeliveryStatus

V2. AlertDetails

Name	Caminho	Tipo	Description
parameters	parameters	array of V2.EventParameterDetails
attachments	attachments	array of V2.AlertAttachmentInfo
categoryId	categoryId	string
escalonamentos	escalations	array of V2.AlertEscalationDetails
eventId	eventId	string
Id externo	externalId	string
flags	flags	V2.AlertFlags	0 = Nenhum 1 = HasAttachments 2 = HasAnotações 4 = IsBreached 8 = HasLocationInfo 16 = EscalatedToTeam 32 = EscalatedToManager 64 = CreatedByEscalation
histórico	history	V2.AlertHistoryInfo
id	id	string
últimaModificação	lastModified	date-time
obrigatórioAgradecimentos	requiredAcknowledgements	integer
severity	severity	V2.AlertSeverities	0 = Baixo 1 = Maior 2 = Crítica
estado	status	V2.AlertStatusDetails
ID de subscrição	subscriptionId	string
teamId	teamId	string
enviar SMS	text	string
linha do tempoEntradas	timelineEntries	array of
title	title	string
tipo de fluxo de trabalho	workflowType	V2.AlertWorkflowTypes	0 = Nenhum 1 = Utilizador 2 = TeamBroadcast 3 = TeamEscalation 4 = MultiReconhecimento 5 = MultiAcknowledgeEmergency

V2. AlertEscalationDetalhes

Name	Caminho	Tipo	Description
alertId	alertId	string
alertStatus	alertStatus	V2.AlertStatusCodes	0 = Nenhum 1 = Aberto 2 = Reconhecido 4 = Fechado 8 = NãoResposta 16 = Falha 32 = Erro
escType	escType	V2.AlertEscalationType	0 = Nenhum 1 = Gestor 2 = Equipa
estado	status	V2.AlertEscalationStatus	0 = Ok 1 = InProgress 2 = TargetInvalid 3 = TargetPrivate 4 = Filtrado 5 = Suprimido
teamId	teamId	string
Nome da equipa	teamName	string
carimbo de data/hora	timestamp	date-time

V2. AlertEscalationStatus

0 = Ok
1 = InProgress
2 = TargetInvalid
3 = TargetPrivate
4 = Filtrado
5 = Suprimido

0 = Ok
1 = InProgress
2 = TargetInvalid
3 = TargetPrivate
4 = Filtrado
5 = Suprimido

: integer

V2. AlertEscalationType

0 = Nenhum
1 = Gestor
2 = Equipa

0 = Nenhum
1 = Gestor
2 = Equipa

: integer

V2. Sinalizadores de alerta

0 = Nenhum
1 = HasAttachments
2 = HasAnotações
4 = IsBreached
8 = HasLocationInfo
16 = EscalatedToTeam
32 = EscalatedToManager
64 = CreatedByEscalation

0 = Nenhum
1 = HasAttachments
2 = HasAnotações
4 = IsBreached
8 = HasLocationInfo
16 = EscalatedToTeam
32 = EscalatedToManager
64 = CreatedByEscalation

: integer

V2. AlertHistoryInfo

Name	Caminho	Tipo
reconhecidoNa	acknowledgedAt	date-time
Agradecimentos	acknowledgements	array of string
fechadoEm	closedAt	date-time
fechadoPor	closedBy	string
criado	created	date-time

V2. AlertInfo

Name	Caminho	Tipo	Description
categoryId	categoryId	string
eventId	eventId	string
Id externo	externalId	string
flags	flags	V2.AlertFlags	0 = Nenhum 1 = HasAttachments 2 = HasAnotações 4 = IsBreached 8 = HasLocationInfo 16 = EscalatedToTeam 32 = EscalatedToManager 64 = CreatedByEscalation
histórico	history	V2.AlertHistoryInfo
id	id	string
últimaModificação	lastModified	date-time
obrigatórioAgradecimentos	requiredAcknowledgements	integer
severity	severity	V2.AlertSeverities	0 = Baixo 1 = Maior 2 = Crítica
estado	status	V2.AlertStatusDetails
ID de subscrição	subscriptionId	string
teamId	teamId	string
enviar SMS	text	string
title	title	string
tipo de fluxo de trabalho	workflowType	V2.AlertWorkflowTypes	0 = Nenhum 1 = Utilizador 2 = TeamBroadcast 3 = TeamEscalation 4 = MultiReconhecimento 5 = MultiAcknowledgeEmergency

V2. AlertReportError

Name	Caminho	Tipo
código de erro	errorCode	integer
Descrição do Erro	errorDescription	string
teamId	teamId	string

V2. AlertSettingsChannelType

0 = Nenhum
1 = Empurrar
2 = Voz
3 = SMS

0 = Nenhum
1 = Empurrar
2 = Voz
3 = SMS

: integer

V2. AlertSettingsDetalhes

Name	Caminho	Tipo	Description
escAtivado	escEnabled	boolean
escMode	escMode	AlertEscalationModes	0 = Gestor 1 = Equipa
escRefId	escRefId	string
filterAction	filterAction	AlertFilterActions	0 = Suprimir 1 = Ocultar 2 = Mudo
filterMode	filterMode	AlertFilterModes	0 = Desligado 1 = WhiteListAllCategories
notificationProfileOverrides	notificationProfileOverrides	array of V2.AlertSettingsNotificationProfileDetails
optar por não participar	optOut	TeamCategoryOptOutModes	0 = Nenhum 1 = Desativado 2 = Pessoal
overrideNotificationProfiles	overrideNotificationProfiles	boolean
persNotInterval	persNotInterval	integer
persNotMode	persNotMode	PersistentNotificationModes	0 = Desligado 1 = Resumo
responseMode	responseMode	AlertResponseModes	2 = SingleAcknowledge 4 = MultiReconhecimento
Tempo de resposta	responseTime	integer
teamId	teamId	string

V2. AlertSettingsError

Name	Caminho	Tipo
código de erro	errorCode	integer
Descrição do Erro	errorDescription	string
teamId	teamId	string

V2. AlertSettingsNotificationProfileDetails

Name

Caminho

Tipo

Description

canal

channel

V2.AlertSettingsChannelType

0 = Nenhum
1 = Empurrar
2 = Voz
3 = SMS

delayInMinutes

integer

enabled

boolean

V2. Gravidades de alerta

0 = Baixo
1 = Maior
2 = Crítica

0 = Baixo
1 = Maior
2 = Crítica

: integer

V2. AlertStatusCodes

0 = Nenhum
1 = Aberto
2 = Reconhecido
4 = Fechado
8 = NãoResposta
16 = Falha
32 = Erro

0 = Nenhum
1 = Aberto
2 = Reconhecido
4 = Fechado
8 = NãoResposta
16 = Falha
32 = Erro

: integer

V2. AlertStatusDetails

Name

Caminho

Tipo

Description

alertDeliveryStatus

V2.AlertDeliveryStatusDetails

código de estado

statusCode

V2.AlertStatusCodes

0 = Nenhum
1 = Aberto
2 = Reconhecido
4 = Fechado
8 = NãoResposta
16 = Falha
32 = Erro

V2. AlertWorkflowTypes

0 = Nenhum
1 = Utilizador
2 = TeamBroadcast
3 = TeamEscalation
4 = MultiReconhecimento
5 = MultiAcknowledgeEmergency

0 = Nenhum
1 = Utilizador
2 = TeamBroadcast
3 = TeamEscalation
4 = MultiReconhecimento
5 = MultiAcknowledgeEmergency

: integer

V2. AlertingPatternChannelType

0 = Nenhum
1 = Empurrar
2 = Voz
3 = SMS

0 = Nenhum
1 = Empurrar
2 = Voz
3 = SMS

: integer

V2. AlertingPatternDetails

Name	Caminho	Tipo
categories	categories	array of string
escalonamentoConfigurações	escalationSettings	V2.AlertingPatternEscalationSettings
id	id	string
nome	name	string
notificationProfileOverrides	notificationProfileOverrides	array of V2.AlertingPatternNotificationProfileDetails
overrideEscalationSettings	overrideEscalationSettings	boolean
overrideNotificationProfiles	overrideNotificationProfiles	boolean
overrideResponseSettings	overrideResponseSettings	boolean
responseSettings	responseSettings	V2.AlertingPatternResponseSettings
suprimirSignl	suppressSignl	boolean
Faixas horárias	timeSlots	array of V2.TimeSlotDetails

V2. AlertingPatternEscalationSettings

Name

Caminho

Tipo

Description

enabled

boolean

mode

AlertEscalationModes

0 = Gestor
1 = Equipa

referenceId

string

V2. AlertingPatternNotificationProfileDetails

Name

Caminho

Tipo

Description

canal

channel

V2.AlertingPatternChannelType

0 = Nenhum
1 = Empurrar
2 = Voz
3 = SMS

delayInMinutes

integer

enabled

boolean

V2. AlertingPatternResponseSettings

Name

Caminho

Tipo

Description

responseMode

AlertResponseModes

2 = SingleAcknowledge
4 = MultiReconhecimento

Tempo de resposta

responseTime

integer

V2. CalloutTemplateDetails

Name	Caminho	Tipo	Description
categoryId	categoryId	string
Id externo	externalId	string
id	id	string
localização	location	string
nome	name	string
Assunto	subject	string
targetAllTeams	targetAllTeams	boolean
targetTeamId	targetTeamId	string
enviar SMS	text	string
tipo de fluxo de trabalho	workflowType	V2.CalloutTemplateWorkflowType	0 = AsConfiguredInTeam 2 = TeamBroadcast 4 = MultiReconhecimento 5 = MultiAcknowledgeEmergency

V2. CalloutTemplateWorkflowType

0 = AsConfiguredInTeam
2 = TeamBroadcast
4 = MultiReconhecimento
5 = MultiAcknowledgeEmergency

0 = AsConfiguredInTeam
2 = TeamBroadcast
4 = MultiReconhecimento
5 = MultiAcknowledgeEmergency

: integer

V2. CategoriaAumentoDetalhes

Name	Caminho	Tipo	Description
enabled	enabled	boolean
id	id	string
nome	name	string
tipo	type	V2.CategoryAugmentationType	0 = Parâmetro 1 = Sujeito 2 = Texto 3 = Localização
valor	value	string

V2. CategoryAugmentationType

0 = Parâmetro
1 = Sujeito
2 = Texto
3 = Localização

0 = Parâmetro
1 = Sujeito
2 = Texto
3 = Localização

: integer

V2. CategoriaDetalhes

Name	Caminho	Tipo	Description
augmentations	augmentations	array of V2.CategoryAugmentationDetails
color	color	string
enriquecimento	enrichments	array of V2.CategoryEnrichmentDetails
id	id	string
nome_da_imagem	imageName	string
isDefault	isDefault	boolean
palavra-chaveCorrespondência	keywordMatching	V2.KeywordMatchingType	0 = Qualquer 1 = Tudo
Palavras Chave	keywords	array of string
palavras-chaveExcluído	keywordsExcluded	array of string
nome	name	string
options	options	V2.CategoryOptions	0 = Nenhum 1 = Oculto 2 = DenyDelete 4 = HideOptOut 8 = OcultarPalavras-chave
order	order	integer
teamId	teamId	string

V2. CategoriaEnriquecimentoDetalhes

Name	Caminho	Tipo	Description
id	id	string
nome	name	string
tipo	type	V2.CategoryEnrichmentType	0 = Parâmetro 1 = Hiperligação
valor	value	string

V2. CategoriaTipo de Enriquecimento

0 = Parâmetro
1 = Hiperligação

0 = Parâmetro
1 = Hiperligação

: integer

V2. CategoryError

Name	Caminho	Tipo
código de erro	errorCode	integer
Descrição do Erro	errorDescription	string
teamId	teamId	string

V2. CategoriaOpções

0 = Nenhum
1 = Oculto
2 = DenyDelete
4 = HideOptOut
8 = OcultarPalavras-chave

0 = Nenhum
1 = Oculto
2 = DenyDelete
4 = HideOptOut
8 = OcultarPalavras-chave

: integer

V2. Tipo de canal

0 = Nenhum
1 = Empurrar
2 = E-mail
4 = Bot
8 = Voz
16 = SMS

0 = Nenhum
1 = Empurrar
2 = E-mail
4 = Bot
8 = Voz
16 = SMS

: integer

V2. DutyChangeError

Name	Caminho	Tipo
código de erro	errorCode	integer
Descrição do Erro	errorDescription	string
teamId	teamId	string
userId	userId	string

V2. DutyError

Name	Caminho	Tipo
código de erro	errorCode	integer
Descrição do Erro	errorDescription	string
teamId	teamId	string

V2. Modos de serviço

0 = Nenhum
1 = Primário
100 = Gestor

0 = Nenhum
1 = Primário
100 = Gestor

: integer

V2. Detalhes do Evento

Name	Caminho	Tipo	Description
parameters	parameters	array of V2.EventParameterDetails
reconhecidoAlertas	acknowledgedAlerts	array of string
fechadoAlertas	closedAlerts	array of string
tempo de criação	creationTime	date-time
eventSourceGroupId	eventSourceGroupId	string
eventSourceId	eventSourceId	string
eventSourceTeamId	eventSourceTeamId	string
eventSourceType	eventSourceType	V2.EventSourceTypes	0 = Nenhum 1 = E-mail 2 = WebHook 3 = Script 4 = Sistema 5 = Manual 6 = Voz 7 = Api
eventStatus	eventStatus	V2.EventStatusCodes	0 = Nenhum 1 = Processamento 2 = Sinalizado 3 = Filtrado 4 = Resolvido 5 = Descartado 6 = Reconhecido 7 = Suprimido 8 = NoRuleApplied 9 = MultipleTargetStatus 1000 = Erro
Id externo	externalId	string
de	from	string
id	id	string
últimaModificação	lastModified	date-time
severity	severity	V2.EventSeverities	0 = Baixo 1 = Maior 2 = Crítica
targets	targets	array of V2.EventTargetDetails
enviar SMS	text	string
title	title	string

V2. EventParameterDetails

Name	Caminho	Tipo	Description
id	id	string
nome	name	string
options	options	V2.EventParameterOptions	0 = Nenhum 1 = ExcludeFromCategorization
order	order	integer
tipo	type	V2.EventParameterTypes	0 = Nenhum 1 = Objeto 2 = Matriz 3 = Construtor 4 = Propriedade 5 = Comentário 6 = Inteiro 7 = Flutuador 8 = String 9 = Booleano 10 = Nulo 11 = Indefinido 12 = Data 13 = Bruto 14 = Bytes 15 = GUID 16 = Uri 17 = TimeSpan 100 = Html
valor	value	string

V2. EventParameterOptions

0 = Nenhum
1 = ExcludeFromCategorization

0 = Nenhum
1 = ExcludeFromCategorization

: integer

V2. EventParameterTypes

0 = Nenhum
1 = Objeto
2 = Matriz
3 = Construtor
4 = Propriedade
5 = Comentário
6 = Inteiro
7 = Flutuador
8 = String
9 = Booleano
10 = Nulo
11 = Indefinido
12 = Data
13 = Bruto
14 = Bytes
15 = GUID
16 = Uri
17 = TimeSpan
100 = Html

0 = Nenhum
1 = Objeto
2 = Matriz
3 = Construtor
4 = Propriedade
5 = Comentário
6 = Inteiro
7 = Flutuador
8 = String
9 = Booleano
10 = Nulo
11 = Indefinido
12 = Data
13 = Bruto
14 = Bytes
15 = GUID
16 = Uri
17 = TimeSpan
100 = Html

: integer

V2. EventSeverities

0 = Baixo
1 = Maior
2 = Crítica

0 = Baixo
1 = Maior
2 = Crítica

: integer

V2. EventSourceEndpointError

Name	Caminho	Tipo
código de erro	errorCode	integer
Descrição do Erro	errorDescription	string
teamId	teamId	string

V2. EventSourceTypes

0 = Nenhum
1 = E-mail
2 = WebHook
3 = Script
4 = Sistema
5 = Manual
6 = Voz
7 = Api

0 = Nenhum
1 = E-mail
2 = WebHook
3 = Script
4 = Sistema
5 = Manual
6 = Voz
7 = Api

: integer

V2. EventStatusCodes

0 = Nenhum
1 = Processamento
2 = Sinalizado
3 = Filtrado
4 = Resolvido
5 = Descartado
6 = Reconhecido
7 = Suprimido
8 = NoRuleApplied
9 = MultipleTargetStatus
1000 = Erro

0 = Nenhum
1 = Processamento
2 = Sinalizado
3 = Filtrado
4 = Resolvido
5 = Descartado
6 = Reconhecido
7 = Suprimido
8 = NoRuleApplied
9 = MultipleTargetStatus
1000 = Erro

: integer

V2. EventTargetDetails

Name	Caminho	Tipo	Description
alertId	alertId	string
categoryId	categoryId	string
tempo de criação	creationTime	date-time
distributionId	distributionId	string
eventId	eventId	string
eventTargetStatus	eventTargetStatus	V2.EventTargetStatusCode	0 = Nenhum 1 = Processamento 2 = Sinalizado 3 = Filtrado 4 = Resolvido 5 = Descartado 6 = Reconhecido 7 = Suprimido 1000 = Erro
id	id	string
últimaModificação	lastModified	date-time
teamId	teamId	string

V2. EventTargetStatusCode

0 = Nenhum
1 = Processamento
2 = Sinalizado
3 = Filtrado
4 = Resolvido
5 = Descartado
6 = Reconhecido
7 = Suprimido
1000 = Erro

0 = Nenhum
1 = Processamento
2 = Sinalizado
3 = Filtrado
4 = Resolvido
5 = Descartado
6 = Reconhecido
7 = Suprimido
1000 = Erro

: integer

V2. FeriadoDetalhes

Name	Caminho	Tipo	Description
day	day	integer
mês	month	V2.Month	0 = Não definido 1 = janeiro 2 = fevereiro 3 = março 4 = abril 5 = maio 6 = junho 7 = julho 8 = agosto 9 = setembro 10 = outubro 11 = novembro 12 = dezembro
repetindo	repeating	boolean
ano	year	integer

V2. ConviteResultado

Name	Caminho	Tipo
código de erro	errorCode	integer
errorMessage	errorMessage	string
Usuário convidado	invitedUser	V2.InvitedUserInfo
sucesso	success	boolean

V2. InvitedUserInfo

Name	Caminho	Tipo	Description
endereço de correio	mailAddress	string
roleId	roleId	string
estado	status	V2.UserStatus	0 = Nenhum 1 = Suprimido 2 = Convidado 3 = Ativo
userId	userId	string

V2. KeywordMatchingType

0 = Qualquer
1 = Tudo

0 = Qualquer
1 = Tudo

: integer

V2. Mês

0 = Não definido
1 = janeiro
2 = fevereiro
3 = março
4 = abril
5 = maio
6 = junho
7 = julho
8 = agosto
9 = setembro
10 = outubro
11 = novembro
12 = dezembro

0 = Não definido
1 = janeiro
2 = fevereiro
3 = março
4 = abril
5 = maio
6 = junho
7 = julho
8 = agosto
9 = setembro
10 = outubro
11 = novembro
12 = dezembro

: integer

V2. NotificationProfileDetails

Name	Caminho	Tipo	Description
canal	channel	V2.ChannelType	0 = Nenhum 1 = Empurrar 2 = E-mail 4 = Bot 8 = Voz 16 = SMS
delayInMinutes	delayInMinutes	integer
enabled	enabled	boolean
options	options	integer
persistent	persistent	boolean

V2. SobreposiçãoTimeSlotsDetalhes

Name	Caminho	Tipo	Description
refId	refId	string
Faixas horárias	timeSlots	array of V2.TimeSlotDetails

V2. PermissionError

Name	Caminho	Tipo
código de erro	errorCode	integer
Descrição do Erro	errorDescription	string
teamId	teamId	string

V2. TelefoneNúmeroValidaçãoStatus

0 = NotValidated
1 = Validado
2 = PaísNãoSuportado

0 = NotValidated
1 = Validado
2 = PaísNãoSuportado

: integer

V2. RemoteActionDefinitionDetails

Name	Caminho	Tipo	Description
parameters	parameters	array of V2.RemoteActionDefinitionParameterDetails
criadosAt	createdAt	date-time
descrição	description	string
executorService	executorService	string
Id externo	externalId	string
id	id	string
nome	name	string
código de estado	statusCode	V2.RemoteActionDefinitionStatus	0 = Desativado 1 = Ativado 2 = Inválido
statusDescrição	statusDescription	string
tipo	type	V2.RemoteActionTypes	0 = Desconhecido 1 = Script 2 = EnterpriseAlert 3 = Webhook
versão	version	integer

V2. RemoteActionDefinitionParameterDetails

Name	Caminho	Tipo	Description
controlType	controlType	V2.RemoteActionParameterControlTypes	0 = Texto 1 = MultiLineText 2 = Inteiro 3 = Duplo 4 = Bool 5 = Tempo 6 = Data 7 = Fuso Horário 8 = Palavra-passe 9 = PIN 10 = Escolha única 11 = MultiEscolha 12 = Sugestão
defaultValue	defaultValue	string
descrição	description	string
nome de exibição	displayName	string
nome	name	string
options	options	V2.RemoteActionParameterOptions	0 = Nenhum 1 = Obrigatório 2 = Bloqueado 4 = Criptografado
order	order	integer
values	values	array of string

V2. RemoteActionDefinitionStatus

0 = Desativado
1 = Ativado
2 = Inválido

0 = Desativado
1 = Ativado
2 = Inválido

: integer

V2. RemoteActionDetails

Name	Caminho	Tipo	Description
parameters	parameters	array of V2.RemoteActionParameter
acesso	access	array of V2.RemoteActionTeamAccessDetails
criadosAt	createdAt	date-time
currentPrincipal	currentPrincipal	V2.RemoteActionPrincipalAccessDetails
definitionId	definitionId	string
definiçãoVersão	definitionVersion	integer
descrição	description	string
enabled	enabled	boolean
executorService	executorService	string
Id externo	externalId	string
id	id	string
nome	name	string
código de estado	statusCode	V2.RemoteActionStatus	0 = Desativado 1 = Ativado 2 = Inválido 4 = ProviderDisabled
statusDescrição	statusDescription	string
ID de subscrição	subscriptionId	string
teamId	teamId	string
tipo	type	V2.RemoteActionTypes	0 = Desconhecido 1 = Script 2 = EnterpriseAlert 3 = Webhook

V2. RemoteActionInfo

Name	Caminho	Tipo	Description
acesso	access	array of V2.RemoteActionTeamAccessDetails
criadosAt	createdAt	date-time
currentPrincipal	currentPrincipal	V2.RemoteActionPrincipalAccessDetails
definitionId	definitionId	string
descrição	description	string
enabled	enabled	boolean
id	id	string
nome	name	string
código de estado	statusCode	V2.RemoteActionStatus	0 = Desativado 1 = Ativado 2 = Inválido 4 = ProviderDisabled
statusDescrição	statusDescription	string
ID de subscrição	subscriptionId	string
teamId	teamId	string
tipo	type	V2.RemoteActionTypes	0 = Desconhecido 1 = Script 2 = EnterpriseAlert 3 = Webhook

V2. RemoteActionParameter

Name	Caminho	Tipo	Description
controlType	controlType	V2.RemoteActionParameterControlTypes	0 = Texto 1 = MultiLineText 2 = Inteiro 3 = Duplo 4 = Bool 5 = Tempo 6 = Data 7 = Fuso Horário 8 = Palavra-passe 9 = PIN 10 = Escolha única 11 = MultiEscolha 12 = Sugestão
nome de exibição	displayName	string
nome	name	string
options	options	V2.RemoteActionParameterOptions	0 = Nenhum 1 = Obrigatório 2 = Bloqueado 4 = Criptografado
order	order	integer
valor	value	string
values	values	array of string

V2. RemoteActionParameterControlTypes

0 = Texto
1 = MultiLineText
2 = Inteiro
3 = Duplo
4 = Bool
5 = Tempo
6 = Data
7 = Fuso Horário
8 = Palavra-passe
9 = PIN
10 = Escolha única
11 = MultiEscolha
12 = Sugestão

0 = Texto
1 = MultiLineText
2 = Inteiro
3 = Duplo
4 = Bool
5 = Tempo
6 = Data
7 = Fuso Horário
8 = Palavra-passe
9 = PIN
10 = Escolha única
11 = MultiEscolha
12 = Sugestão

: integer

V2. RemoteActionParameterOptions

0 = Nenhum
1 = Obrigatório
2 = Bloqueado
4 = Criptografado

0 = Nenhum
1 = Obrigatório
2 = Bloqueado
4 = Criptografado

: integer

V2. RemoteActionPrincipalAccessDetails

Name	Caminho	Tipo	Description
podeEditar	canEdit	boolean
canExecute	canExecute	boolean

V2. RemoteActionStatus

0 = Desativado
1 = Ativado
2 = Inválido
4 = ProviderDisabled

0 = Desativado
1 = Ativado
2 = Inválido
4 = ProviderDisabled

: integer

V2. RemoteActionTeamAccessDetalhes

Name	Caminho	Tipo
podeEditar	canEdit	boolean
canExecute	canExecute	boolean
teamId	teamId	string

V2. RemoteActionTypes

0 = Desconhecido
1 = Script
2 = EnterpriseAlert
3 = Webhook

0 = Desconhecido
1 = Script
2 = EnterpriseAlert
3 = Webhook

: integer

V2. Trabalho Remoto

Name	Caminho	Tipo	Description
parameters	parameters	array of V2.RemoteJobParameter
actionId	actionId	string
ativadoAT	activatedAt	date-time
criadosAt	createdAt	date-time
creatorInfo	creatorInfo	V2.RemoteJobCreatorDetails
definitionId	definitionId	string
Id externo	externalId	string
id	id	string
Última atualização	lastUpdate	date-time
options	options	V2.RemoteJobOptions	0 = Nenhum
começouEm	startedAt	date-time
código de estado	statusCode	V2.RemoteJobStatusCodes	0 = Nenhum 1 = Pendente 2 = Pronto 4 = Corrida 8 = Executado 16 = Erro
statusDescrição	statusDescription	string
detalhes do status	statusDetails	string
tipo	type	V2.RemoteActionTypes	0 = Desconhecido 1 = Script 2 = EnterpriseAlert 3 = Webhook

V2. RemoteJobCreatorDetails

Name

Caminho

Tipo

Description

referenceId

string

referenceName

string

tipo

type

V2.RemoteJobCreatorType

0 = Nenhum
1 = Utilizador
2 = ApiKey
3 = Sistema

V2. RemoteJobCreatorType

0 = Nenhum
1 = Utilizador
2 = ApiKey
3 = Sistema

0 = Nenhum
1 = Utilizador
2 = ApiKey
3 = Sistema

: integer

V2. RemoteJobOptions

0 = Nenhum

0 = Nenhum

: integer

V2. RemoteJobParameter

Name	Caminho	Tipo	Description
nome	name	string
valor	value	string

V2. RemoteJobStatusCodes

0 = Nenhum
1 = Pendente
2 = Pronto
4 = Corrida
8 = Executado
16 = Erro

0 = Nenhum
1 = Pendente
2 = Pronto
4 = Corrida
8 = Executado
16 = Erro

: integer

V2. ScheduleDetails

Name	Caminho	Tipo
fim	end	date-time
id	id	string
options	options	integer
start	start	date-time
teamId	teamId	string
userId	userId	string

V2. TeamDutySettingsDetalhes

Name	Caminho	Tipo
autosnapEnabled	autosnapEnabled	boolean
dutyAssistantAtivado	dutyAssistantEnabled	boolean
dutyChangeNotificationsEnabled	dutyChangeNotificationsEnabled	boolean
comprimento do dever	dutyLength	integer
Data de entrega	handoverDate	date-time
Tempo de entrega	handoverTime	integer
entregaDia da semana	handoverWeekDay	integer
minMembroOnDuty	minMemberOnDuty	integer
agendamentoAtivado	schedulingEnabled	boolean
shiftReportCarbonCopyMail	shiftReportCarbonCopyMail	string
shiftReportEnabled	shiftReportEnabled	boolean
teamId	teamId	string
timezone	timezone	string

V2. TeamDutySettingsError

Name	Caminho	Tipo
código de erro	errorCode	integer
Descrição do Erro	errorDescription	string
teamId	teamId	string

V2. TeamDutySummaryError

Name	Caminho	Tipo
código de erro	errorCode	integer
Descrição do Erro	errorDescription	string
userId	userId	string

V2. TeamHolidayDetalhes

Name	Caminho	Tipo	Description
feriados	holidays	array of V2.HolidayDetails
teamId	teamId	string

V2. TeamImageDetails

Name	Caminho	Tipo
conteúdo	content	byte
contentDispostion	contentDispostion	string
contentEncoding	contentEncoding	string
TipoDeConteúdo	contentType	string
últimaModificação	lastModified	date-time
nome	name	string

V2. TeamMembershipDetails

Name	Caminho	Tipo	Description
endereço de correio	mailAddress	string
membroDesde	memberSince	date-time
roleId	roleId	string
estado	status	V2.UserStatus	0 = Nenhum 1 = Suprimido 2 = Convidado 3 = Ativo
teamId	teamId	string
userId	userId	string

V2. TeamPermissions

Name	Caminho	Tipo	Description
permissões	permissions	array of UserPermission
teamId	teamId	string

V2. TeamPrivacySettingsDetalhes

Name	Caminho	Tipo
hideContactAddresses	hideContactAddresses	boolean
hideDutyData	hideDutyData	boolean
hideForEscalation	hideForEscalation	boolean
teamId	teamId	string

V2. TeamPublicDetails

Name	Caminho	Tipo
id	id	string
nome	name	string
privacySettings	privacySettings	V2.TeamPrivacySettingsDetails

V2. TeamUserError

Name	Caminho	Tipo
código de erro	errorCode	integer
Descrição do Erro	errorDescription	string
teamId	teamId	string

V2. TimeSlotDetalhes

Name	Caminho	Tipo
fim	end	V2.WeekTimeDetails
id	id	string
start	start	V2.WeekTimeDetails

V2. TimeSlotValidationResultDetails

Name	Caminho	Tipo
isSobreposição	isOverlapping	boolean
item	item	V2.TimeSlotDetails
sobreposiçãoTimeSlots	overlappingTimeSlots	array of V2.OverlappingTimeSlotsDetails
válido	valid	boolean

V2. UserDeliveryStatus

Name

Caminho

Tipo

Description

código de estado

statusCode

V2.UserDeliveryStatusCodes

0 = Nenhum
1 = Aberto
2 = Falha
4 = Transmitido
6 = Entregue
8 = Protegido
9 = AbusoProtegido
24 = Parcialmente Transmitido
26 = Parcialmente Entregue
30 = NotOnDuty
31 = CategoriaOptOut
32 = NoMessagesSent

userId

string

V2. UserDeliveryStatusCodes

0 = Nenhum
1 = Aberto
2 = Falha
4 = Transmitido
6 = Entregue
8 = Protegido
9 = AbusoProtegido
24 = Parcialmente Transmitido
26 = Parcialmente Entregue
30 = NotOnDuty
31 = CategoriaOptOut
32 = NoMessagesSent

0 = Nenhum
1 = Aberto
2 = Falha
4 = Transmitido
6 = Entregue
8 = Protegido
9 = AbusoProtegido
24 = Parcialmente Transmitido
26 = Parcialmente Entregue
30 = NotOnDuty
31 = CategoriaOptOut
32 = NoMessagesSent

: integer

V2. Detalhes do usuário

Name	Caminho	Tipo
colorIndex	colorIndex	integer
contatoEndereços	contactAddresses	array of
deverInfos	dutyInfos	array of V2.UserDutyDetails
externalAuthProvider	externalAuthProvider	string
id	id	string
isDesativada	isDeactivated	boolean
isConvidar	isInvite	boolean
visto pela última vez	lastSeen	date-time
correio	mail	string
nome	name	string
remoteActionPinSet	remoteActionPinSet	boolean
ID de subscrição	subscriptionId	string
Fuso horário	timeZone	string
userImageLastModified	userImageLastModified	date-time

V2. UserDutyDetails

Name	Caminho	Tipo	Description
dutyMode	dutyMode	V2.DutyModes	0 = Nenhum 1 = Primário 100 = Gestor
lastAlterar	lastChange	date-time
onDutyTime	onDutyTime	integer
em atraso	overdue	boolean
teamId	teamId	string
userId	userId	string

V2. UserLocaleResponseDetails

Name	Caminho	Tipo
id	id	string
linguagem	language	string
Fuso horário	timeZone	string

V2. UserPhoneNumberDetails

Name

Caminho

Tipo

Description

Código do país

countryCode

string

Número de telefone

phoneNumber

string

validationStatus

V2.PhoneNumberValidationStatus

0 = NotValidated
1 = Validado
2 = PaísNãoSuportado

V2. Status do Usuário

0 = Nenhum
1 = Suprimido
2 = Convidado
3 = Ativo

0 = Nenhum
1 = Suprimido
2 = Convidado
3 = Ativo

: integer

V2. WeekTimeDetails

Name

Caminho

Tipo

Description

hora

hour

integer

minutes

integer

Dia da semana

weekday

V2.Weekday

0 = Feriado
1 = Segunda-feira
2 = Terça-feira
3 = Quarta-feira
4 = Quinta-feira
5 = Sexta-feira
6 = Sábado
7 = Domingo

V2. Dia da semana

0 = Feriado
1 = Segunda-feira
2 = Terça-feira
3 = Quarta-feira
4 = Quinta-feira
5 = Sexta-feira
6 = Sábado
7 = Domingo

0 = Feriado
1 = Segunda-feira
2 = Terça-feira
3 = Quarta-feira
4 = Quinta-feira
5 = Sexta-feira
6 = Sábado
7 = Domingo

: integer

WebhookInfo

Name	Caminho	Tipo
descrição	description	string
enabled	enabled	boolean
extUrl	extUrl	string
id	id	string
nome	name	string
subID	subId	string
teamId	teamId	string

cadeia (de caracteres)

Este é o tipo de dados básico 'string'.

binário

Este é o tipo de dados básico 'binário'.

Partilhar via

SIGNL4 - Alertas móveis

Pré-requisitos

Como obter credenciais

Introdução ao conector

Problemas conhecidos e limitações

Erros e soluções comuns

FAQ

A criar uma ligação

Padrão

Limites de Limitação

Ações

Adicionar utilizador a uma equipa

Parâmetros

Devoluções

Alerta de anotações

Parâmetros

Devoluções

Alerta de gatilho

Parâmetros

Devoluções

Atualiza a senha de um usuário

Parâmetros

Atualiza dados personalizados de uma determinada instância de script que inclui seu nome para exibição

Parâmetros

Devoluções

Atualiza o perfil da equipe de uma equipe

Parâmetros

Devoluções

Atualiza o perfil de usuário de um usuário

Parâmetros

Devoluções

Atualiza um perfil de subscrição

Parâmetros

Devoluções

Atualiza uma ação remota

Parâmetros

Devoluções

Atualiza uma determinada instância de script

Parâmetros

Devoluções

Atualizar a associação da equipe do usuário

Parâmetros

Devoluções

Atualizar as configurações de privacidade de uma equipe

Parâmetros

Devoluções

Atualizar as configurações pré-pagas atuais da sua assinatura

Parâmetros

Devoluções

Atualizar as configurações pré-pagas atuais de uma assinatura

Parâmetros

Devoluções

Atualizar informações de localidade (por exemplo, idioma, fuso horário) para o usuário

Parâmetros

Devoluções

Atualizar o modelo de texto explicativo existente para sua assinatura

Parâmetros

Devoluções

Atualizar um padrão de alerta existente

Parâmetros

Devoluções

Atualizar uma categoria existente

Parâmetros

Devoluções

Atualizar uma fonte de eventos

Parâmetros

Devoluções

Atualizar Webhook por Id

Parâmetros

Devoluções

Baixar relatório de dever com um fileName específico

Parâmetros

Devoluções

Capacidade de ativar um webHook

Parâmetros

Devoluções

Capacidade de desativar um webHook

Parâmetros

Devoluções