Partilhar via

Aranda Service Management (Pré-visualização)

Aumente a produtividade da sua empresa e transforme a experiência dos seus utilizadores com o Aranda Service Management Suite, a solução multilocatária que lhe permite gerir, integrar e automatizar processos e serviços empresariais.

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 Aranda Software
URL https://arandasoft.com/
Email soporte@arandasoft.com
Metadados do conector
Editora Aranda Software Corporation
Sítio Web https://arandasoft.com/
Política de privacidade https://arandasoft.com/politica-de-privacidad/
Categorias Gestão Empresarial; Colaboração

Aranda Service Management Suite (ASMS)

Aumente a produtividade da sua empresa e transforme a experiência dos seus utilizadores com o Aranda Service Management Suite, a solução multilocatária que lhe permite gerir, integrar e automatizar processos e serviços empresariais. Crie, pesquise e atualize registros armazenados em qualquer espaço de trabalho (projeto) do ASMS, incluindo incidentes, requisitos e alterações, entre outros.

Pre-requisites

Tenha em mente os seguintes pré-requisitos para continuar:

  • Uma assinatura e uma instância do Aranda Service Management Suite (ASMS). Comece aqui: https://arandasoft.com/
  • Uma assinatura ativa do Microsoft Power Automate com recursos de conector Premium.

Obtenção de credenciais

  • Para executar a autenticação, use o token de integração. No link a seguir, você encontrará informações sobre como obter o token de integração

Introdução ao conector

  1. Requer uma assinatura do Aranda Service Management Suite (ASMS).

  2. Obter o token de integração

  3. Obtenha a URL da instância da API ASMS (ApiAsms) do Aranda Service Management.

  4. Estabeleça uma conexão com o conector do Aranda Service Management Suite.

  5. Selecione uma das seguintes funções oferecidas pelo conector:

    Bilhete

  6. Para obter documentação detalhada em torno do conector, consulte https://docs.arandasoft.com/connectors

Você pode usar esse conector nos seguintes casos:

  1. Crie, pesquise e atualize tickets, entre outras ações disponíveis.
  2. Obter rastreabilidade de bilhetes.
  3. Faça o download de anexos relacionados a um ticket.
  4. Pesquisar artigos da base de dados de conhecimento (KB) no Aranda Service Management Suite.
  5. Transfira anexos de artigos da base de dados de conhecimento (KB).
  6. Crie, pesquise e atualize itens de configuração (CIs).
  7. Permite às organizações resolver os seus pedidos de suporte interno, gerindo e agilizando o processo de resolução de problemas técnicos.
  8. Permite o rastreamento de comunicações entre solicitantes e agentes de suporte.
  9. Ofereça respostas automáticas para informar os solicitantes sobre o status de seu bilhete.

Resposta com êxito

Código Nome Description
200 OK O pedido foi bem-sucedido
204 NãoConteúdo Nenhum dado encontrado na solicitação

Erros e soluções comuns

Código Nome Description Solução
400 Pedido Inválido CritériosNecessidadesAlgunsArgumentos Verifique se os parâmetros de pesquisa não estão vazios
400 Pedido Inválido InvalidAdditionalFieldId Verifique se os IDs dos campos adicionais estão corretos
400 Pedido Inválido InvalidItemType O tipo de caso está incorreto, altere o id do tipo de caso
400 Pedido Inválido InvalidProjectId A id do projeto está incorreta, altere a id do projeto à qual você associará o caso
400 Pedido Inválido InvalidStateId Verificar o status adicionado ao criar ou atualizar um Ticket
400 Pedido Inválido InvalidUploadType Ocorreu um erro ao anexar um ficheiro, Solicitar assistência de um administrador de sistema
400 Pedido Inválido RequestNeedsSomeArguments Verifique os campos obrigatórios do bilhete e adicione o valor correspondente destes no conector
400 Pedido Inválido SearchListIsRequired Solicite assistência de um administrador de sistema
400 Pedido Inválido Nome do parâmetro: {Name parameter} Verifique se as propriedades mencionadas no erro não são nulas
400 Pedido Inválido É null parameter name: {Name parameter} Verifique se as propriedades mencionadas no erro não são nulas
400 Pedido Inválido ItemTypeIsRequired Adicionar tipo de caso
400 Pedido Inválido ModelIdIsEmpty Adicione o parâmetro modelId. É obrigatório.
400 Pedido Inválido StateIdIsEmpty Adicione o parâmetro stateId. É obrigatório.
400 Pedido Inválido ServiceIdIsEmpty Adicione o parâmetro serviceId. É obrigatório.
400 Pedido Inválido CategoriaIdIsEmpty Adicione o parâmetro categoryId. É obrigatório.
400 Pedido Inválido TypesListNeedsSomeArguments Requer a adição do tipo de caso ao procurar tickets, Solicite assistência de um administrador de sistema
400 Pedido Inválido '{PARAMETER_NAME}' AdditionalFieldIsRequired O campo adicional «{PARAMETER_NAME}» é obrigatório
400 Pedido Inválido ModeloNotActive O modelo associado ao caso não está ativo
400 Pedido Inválido FailedToCloseTaskPendingCloseTasksPredecessors Se você tentar fechar o caso e o caso pai tiver tarefas pendentes para fechar
400 Pedido Inválido DuplicatedObject O Ci já existe na base de dados
400 Pedido Inválido Nome do parâmetro EmptyValue: {PARAMETER_NAME} O parâmetro {PARAMETER_NAME} é obrigatório
400 Pedido Inválido Nome do parâmetro EmptyEnumeration: {PARAMETER_NAME} O parâmetro {PARAMETER_NAME} é uma lista e é obrigatório
403 Proibido DoNotHavePermissionForThisAction Fale com o administrador do sistema para atribuir permissões
Código Nome Description Solução
500 Erro Interno do Servidor Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureExportExcel Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetAdditionalFields Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetCategoriesByService Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetChangeFSC Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetFields Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetFieldsList Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetFiles Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetLookupValues Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetMailTemplates Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetModelByCategory Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetOperators Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetReassignmentReasons Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureGetSimilarItems Solicite assistência de um administrador de sistema
500 Erro Interno do Servidor FailureSearchQuickManagement Solicite assistência de um administrador de sistema

FAQ

  1. Como recuperar os IDs dos atributos necessários para usar as diferentes ações no conector (por exemplo, projeto, serviço, categoria, grupo, especialista)?

    Os IDs podem ser recuperados de várias maneiras:

    • Usando o Aranda Query Manager, você pode criar um relatório que consulta a tabela do Aranda Service Management Suite (ASMS) onde os dados necessários estão localizados. Se você precisar de orientação sobre os objetos de dados na solução, visite o link https://docs.arandasoft.com/docs/database.html a seguir e identifique a versão do banco de dados Aranda correspondente à sua instalação ASMS.
    • Se você estiver usando uma instalação ASMS On Premise, poderá consultar a tabela ASMS onde os dados necessários estão localizados por meio de um cliente SQL.
    • Via Centro de Suporte Aranda, criando um pedido de suporte através dos canais de contacto indicados no seguinte website Suporte.

  2. Qual é o tamanho máximo de ficheiros a anexar ao utilizar a ação "Adicionar anexo"?

    O tamanho máximo depende da configuração específica da sua instância/instalação ASMS. Por favor, pergunte ao seu administrador ASMS.

  3. Qual é o nível de acesso aos dados exigido pela conta do técnico cujo token é usado na configuração da conexão ASMS exigida pelo conector?

    O nível de acesso é o mesmo que a conta de técnico usada no ASMS regularmente. Em outras palavras, com base nas funções e permissões do técnico correspondente no ASMS, os dados podem ser acessados com o conector.

  4. A conta do técnico cujo token será usado no conector deve ser nomeada ou simultânea?

    Como o conector pode acessar a instância ASMS relacionada várias vezes por hora, é altamente recomendável que a conta seja do tipo Nomeado.

  5. A criação ou modificação de casos usando o conector segue as mesmas regras de validação de dados presentes na interface ASMS?

    Sim, segue as mesmas regras de validação. Por exemplo, ao criar um caso para um projeto, serviço e categoria específicos, se campos nativos e adicionais devem ser preenchidos, esses dados também são necessários ao enviar o caso através do conector.

  6. O conector pode ser usado para instâncias ASMS em ambientes Cloud e On Premise?

    Sim, ele pode ser usado em instalações Cloud e On Premise do ASMS. Em instalações no local, você deve considerar a conectividade entre o servidor ASMS e seu ambiente Power Automatic.

  7. Tenho uma licença Power Automate que só me permite utilizar conectores Standard. Posso usar o conector ASMS?

    Não é possível, o conector ASMS é do tipo Premium.

  8. Quero criar fluxos no Power Automate que comecem a partir de eventos no ASMS (por exemplo, quando um caso foi criado, quando um caso é atribuído a um grupo específico). É possível usar gatilhos que começam a partir de eventos que ocorrem no ASMS?

    Sim, é possível. Recomendam-se os seguintes passos:

    • Inicialize um gatilho "Quando uma solicitação HTTP for recebida" e crie um esquema JSON do corpo da solicitação contendo a estrutura de dados esperada para ser recebida do ASMS. Depois que o gatilho for criado, você receberá um HTTP POST URL (WebHook URL) para usar em sua instância ASMS. Não se esqueça de considerar o mecanismo de autenticação para acessar o URL do WebHook (por exemplo, Token).
    • Crie uma regra de negócios no ASMS para o conjunto de condições que, quando atendidas, devem iniciar o fluxo no Power Automate. Como uma ação dentro da regra, selecione "Invoke Webhook" e, no URL de destino da invocação, insira a URL do WebHook obtida anteriormente, os parâmetros a serem enviados e o corpo da solicitação (que deve corresponder ao esquema JSON do corpo da solicitação). Para obter mais informações sobre como invocar um Webhook a partir de uma regra no ASMS, visite o seguinte link: Regra Webhook
    • Teste a regra criada e valide que uma solicitação HTTP é enviada para a URL do WebHook e inicializa o fluxo no Power Automate.

  9. Posso invocar pontos de extremidade ASMS REST API como ações de fluxos no Power Automate?

    Sim, é possível. Use a ação "HTTP" e preencha os dados necessários nela (URI, Método, Cabeçalhos, Corpo, entre outros).

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
Host ASMS cadeia (de caracteres) Host ASMS Verdade
Token de autorização securestring Token de autorização Verdade

Limites de Limitação

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

Ações

Adicionar anexo ao caso

Anexe um arquivo a um registro de caso específico no ASMS.
Adicionar nota ao caso

Adicione uma nota a um registro de caso específico no ASMS.
Atualizar item de configuração

Atualizar CIs no CMDB Aranda.
Caso de atualização

Atualiza um registro para um caso ASMS.
Criar caso

Crie um novo registro de caso no ASMS.
Criar item de configuração

Crie CIs no CMDB Aranda.
Descarregar o anexo do artigo

Download do anexo relacionado ao artigo.
Faça o download do anexo do caso

Download do anexo relacionado ao artigo.
Obter caso

Obtém um registro dos metadados de um caso ASMS.
Obter histórico de casos

Obter histórico de casos, por padrão as notas não estão incluídas.
Obter item de configuração

Obter CI por nome e série.
Pesquisar artigos

Recupera uma lista de artigos com base nos critérios de pesquisa adicionados na consulta.
Pesquisar casos

Recupera uma lista de registros de caso ASMS dependendo dos critérios de pesquisa adicionados na consulta.
Pesquisar itens de configuração

Recupera uma lista de registros de CIs CMDB dependendo dos critérios de pesquisa adicionados na consulta.

Adicionar anexo ao caso

ID da Operação:
AttachFile

Anexe um arquivo a um registro de caso específico no ASMS.

Parâmetros

Name Chave Necessário Tipo Description
Id por projeto
 ticketId True string

Código do registo
Ficheiro
 file True byte

Arquivo de bytes.
Nome do arquivo
 fileName True string

Nome do ficheiro (por exemplo, 'Vacation_Approval_Form.docx').

Adicionar nota ao caso

ID da Operação:
AttachNote

Adicione uma nota a um registro de caso específico no ASMS.

Parâmetros

Name Chave Necessário Tipo Description
Id por projeto
 ticketId True string

Código do registo
Observação
 message True string

Nota a anexar ao registo.

Atualizar item de configuração

ID da Operação:
UpdateCI

Atualizar CIs no CMDB Aranda.

Parâmetros

Name Chave Necessário Tipo Description
Nome ou CI de série
 request True string

Insira o nome ou a série do item de configuração.
Description
 description string

Descrição pormenorizada da IC.
Serial
 serial string

Serial
Tag de ativo
 assetTag string

Tag de ativo.
Categoria
 categoryId integer

Selecione uma categoria ou insira manualmente um identificador de categoria.
ID responsável
 responsibleId integer

Identificador responsável.
Status ID
 stateId integer

Identificador de status.
Número de licença
 licenseNumber string

Número de licença.
ID do fabricante
 manufacturerId integer

Identificador do fabricante.
Marca
 brandId integer

Selecione uma marca ou insira manualmente um identificador de marca.
Modelo
 modelId integer

Selecione um modelo ou insira manualmente um identificador de modelo.
ID do fornecedor
 providerId integer

Identificador do provedor.
ID do motivo
 reasonId integer

Identificador de motivo.
Preço
 price number

Preço.
RFID
 rfid string

RFID
Data de aceitação
 acceptDate date-time

Data de aceitação.
Data de entrega à empresa
 checkInDate date-time

Data de entrega à empresa.
Data inicial da responsabilidade
 responsibilityDate date-time

Data inicial da responsabilidade.
Código de barras
 barCode string

Código de barras.
Valor unitário da medida
 unitSize string

Meça o valor unitário.
Unidade de medida
 unitId integer

Selecione uma unidade de medida ou insira manualmente um identificador de unidade de medida.
ID do centro de custo
 costCenterId integer

Identificador do centro de custo.
Impacto
 impactId integer

Selecione um impacto ou insira manualmente um identificador de impacto.
Risco
 riskId integer

Selecione um risco ou insira manualmente um identificador de risco.
ID da Localização
 locationId integer

Identificador de localização.
fieldId
 fieldId string

Identificador de campo
values
 values array of string

Valor

Devoluções

Name Caminho Tipo Description
Identificador de item de configuração
 id integer

Identificador do item de configuração.

Caso de atualização

ID da Operação:
UpdateCase

Atualiza um registro para um caso ASMS.

Parâmetros

Name Chave Necessário Tipo Description
Id por projeto
 ticketId True string

Código do registo
Assunto
 subject string

Assunto.
Description
 description string

Descrição pormenorizada do caso.
Solução
 commentary string

Solução de casos.
ID do serviço
 serviceId integer

Identificador do serviço.
ID da categoria
 categoryId integer

Identificador de categoria.
Status ID
 stateId integer

Identificador de status.
ID do motivo
 reasonId integer

Identificador de motivo.
ID do grupo
 groupId integer

Identificador de grupo.
ID responsável
 responsibleId integer

Identificador responsável.
ID do candidato
 applicantId integer

Identificador do requerente.
ID do Cliente
 customerId integer

Identificador do cliente.
ID da Empresa
 companyId integer

Identificador da empresa.
ID de IC
 ciId integer

Identificador CI.
ID do fornecedor
 providerId integer

Identificador do provedor.
ID da área organizacional
 unitId integer

Identificador da área organizacional.
Tipo de registo
 registryTypeId integer

Selecione um tipo de registro ou insira manualmente um identificador de tipo de registro.
Urgência
 urgencyId integer

Selecione uma urgência ou insira manualmente um identificador de urgência.
Impacto
 impactId integer

Selecione uma urgência ou insira manualmente um identificador de impacto.
Interfaz
 interfaceId string

relação do processo com terceiros.
Identificador de campo
 fieldId string

Identificador de campo.
Valores
 values array of string

valores.

Devoluções

Name Caminho Tipo Description
Resultado
 result boolean

Result

Criar caso

ID da Operação:
CreateCase

Crie um novo registro de caso no ASMS.

Parâmetros

Name Chave Necessário Tipo Description
Assunto
 subject True string

Assunto.
Description
 description string

Descrição pormenorizada do caso.
Tipo de Caso
 itemType True string

Selecione um tipo de caso ou insira manualmente um nome de tipo de caso.
Projeto
 projectId True integer

Selecione um projeto ou insira manualmente um identificador de projeto.
Serviço
 serviceId True integer

Selecione um serviço ou insira manualmente um identificador de serviço.
Categoria
 categoryId True integer

Selecione uma categoria ou insira manualmente um identificador de categoria.
Reason
 reasonId integer

Selecione um motivo ou insira manualmente um identificador de motivo.
Grupo
 groupId integer

Selecione um grupo ou insira manualmente um identificador de grupo.
Responsável
 responsibleId integer

Selecione um responsável ou insira manualmente um identificador responsável.
Empresa
 companyId integer

Selecione uma empresa ou insira manualmente um identificador de empresa.
Provider
 providerId integer

Selecione um provedor ou insira manualmente um identificador de provedor.
Área organizacional
 unitId integer

Selecione uma área organizacional ou insira manualmente um identificador de área organizacional.
ID do candidato
 applicantId integer

Identificador do requerente.
ID do Cliente
 customerId integer

Identificador do cliente.
Identificador CI
 ciId integer

Identificador CI.
Tipo de registo
 registryTypeId integer

Selecione um tipo de registro ou insira manualmente um identificador de tipo de registro.
Urgência
 urgencyId integer

Selecione uma urgência ou insira manualmente um identificador de urgência.
Impacto
 impactId integer

Selecione um impacto ou insira manualmente um identificador de impacto.
ID
 fieldId string

Identificador de campo.
values
 values array of string

valor.

Devoluções

Name Caminho Tipo Description
ID do caso
 id integer

Identificador de caso
Id por projeto
 idByProject string

Id por projeto para o registro

Criar item de configuração

ID da Operação:
CreateCI

Crie CIs no CMDB Aranda.

Parâmetros

Name Chave Necessário Tipo Description
Nome
 name True string

Nome
Description
 description string

Descrição pormenorizada da IC.
Serial
 serial string

Série.
Tag de ativo
 assetTag string

Tag de ativo.
Projeto
 projectId True integer

Selecione um projeto ou insira manualmente um identificador de projeto.
Categoria
 categoryId True integer

Selecione uma categoria ou insira manualmente um identificador de categoria.
ID responsável
 responsibleId True integer

Identificador responsável.
Número de licença
 licenseNumber string

Número de licença.
Fabricante
 manufacturerId integer

Selecione um fabricante ou insira manualmente um identificador de fabricante.
Marca
 brandId integer

Selecione uma marca ou insira manualmente um identificador de marca.
Modelo
 modelId integer

Selecione um modelo ou insira manualmente um identificador de modelo.
ID do fornecedor
 providerId integer

Selecione um provedor ou insira manualmente um identificador de provedor.
ID do motivo
 reasonId integer

Identificador de motivo.
Preço
 price number

Preço.
RFID
 rfid string

RFID
Data de aceitação
 acceptDate date-time

Data de aceitação.
Data de entrega à empresa
 checkInDate date-time

Data de entrega à empresa.
Data inicial da responsabilidade
 responsibilityDate date-time

Data inicial da responsabilidade.
Código de barras
 barCode string

Código de barras.
Valor unitário da medida
 unitSize string

Meça o valor unitário.
Unidade de medida
 unitId integer

Selecione uma unidade de medida ou insira manualmente um identificador de unidade de medida.
Centro de custos
 costCenterId integer

Selecione um centro de custo ou insira manualmente um identificador de centro de custo.
Impacto
 impactId integer

Selecione um impacto ou insira manualmente um identificador de impacto.
Risco
 riskId integer

Selecione um risco ou insira manualmente um identificador de risco.
Localização
 locationId integer

Selecione um local ou insira manualmente um identificador de local.
fieldId
 fieldId string

Identificador de campo.
values
 values array of string

Valor

Devoluções

Name Caminho Tipo Description
Identificador de item de configuração
 id integer

Identificador do item de configuração.

Descarregar o anexo do artigo

ID da Operação:
DownloadArticleFile

Download do anexo relacionado ao artigo.

Parâmetros

Name Chave Necessário Tipo Description
ID do artigo
 articleId True integer

Identificador do artigo.
ID do anexo
 fileId True integer

Representa o identificador do anexo.

Devoluções

O conteúdo do anexo.

Conteúdo do ficheiro
binary

Faça o download do anexo do caso

ID da Operação:
DownloadCaseFile

Download do anexo relacionado ao artigo.

Parâmetros

Name Chave Necessário Tipo Description
Id por projeto
 ticketId True string

Código do registo
Identificador de anexo
 fileId True integer

Representa o identificador do anexo.

Devoluções

O conteúdo do anexo.

Conteúdo do ficheiro
binary

Obter caso

ID da Operação:
GetCase

Obtém um registro dos metadados de um caso ASMS.

Parâmetros

Name Chave Necessário Tipo Description
Id por projeto
 ticketId True string

Código do registo

Devoluções

Name Caminho Tipo Description
ID do caso
 id integer

Identificador do sistema para o registo.
Id por projeto
 idByProject string

Id por projeto para o registro.
Assunto
 subject string

Assunto.
Description
 description string

Descrição pormenorizada do caso.
Solução
 commentary string

Solução de casos.
ID do projeto
 projectId integer

Identificador do projeto.
Projeto
 projectName string

Nome do projeto.
Tipo de caso
 itemTypeName string

Nome do tipo de caso.
ID do tipo de caso
 itemTypeId integer

Identificador de tipo de caso.
ID do serviço
 serviceId integer

Identificador do serviço.
Serviço
 serviceName string

Nome do serviço.
ID do modelo
 modelId integer

Identificador do modelo.
Modelo
 modelName string

Nome do modelo.
ID da categoria
 categoryId integer

Identificador de categoria.
Nome da categoria
 categoryName string

Categoria.
ID do candidato
 applicantId integer

Identificador do requerente.
ID do Cliente
 customerId integer

Identificador do cliente.
Client
 customerName string

Nome do cliente.
ID da Empresa
 companyId integer

Identificador da empresa.
Empresa
 companyName string

Nome da empresa.
ID de IC
 ciId integer

Identificador CI.
IC
 ciName string

Nome CI.
SLA ID
 slaId integer

Identificador de SLA.
SLA
 slaName string

Nome do SLA.
Status ID
 stateId integer

Identificador de status.
Situação
 stateName string

Nome do status.
ID do motivo
 reasonId integer

Identificador de motivo.
Reason
 reasonName string

Nome da razão.
ID do grupo
 groupId integer

Identificador de grupo.
Grupo
 groupName string

Nome do grupo.
ID responsável
 responsibleId integer

Identificador responsável.
Responsável
 responsibleName string

Nome do responsável.
ID do tipo de registo
 registryTypeId integer

Identificador do tipo de registo.
Tipo de registo
 registryTypeName string

Nome do tipo de registo.
ID de impacto
 impactId integer

Identificador de impacto.
Impacto
 impactName string

Nome do impacto.
ID de urgência
 urgencyId integer

Identificador de urgência.
Urgência
 urgencyName string

Nome da urgência.
ID de prioridade
 priorityId integer

Identificador de prioridade.
Priority
 priorityName string

Nome da prioridade.
ID do risco
 riskId integer

Identificador de risco.
Risco
 riskName string

Nome do risco.
ID do fornecedor
 providerId integer

Identificador do provedor.
Provider
 providerName string

Nome do provedor.
UC ID
 ucId integer

Identificador de UC.
UC
 ucName string

Nome da UC.
ID da área organizacional
 unitId integer

Identificador da área organizacional.
Área organizacional
 unitName string

Nome da área organizacional.
OLA ID
 olaId integer

Identificador OLA.
OLA
 olaName string

Nome do OLA.
Data de registo
 openedDate string

Data de registo.
Data de encerramento
 closedDate string

Data de encerramento.
Data-limite
 finalDate string

Data final (apenas para registos de tarefas).
Data inicial
 initialDate string

Data inicial (apenas para registos de tarefas).
Custos
 cost number

custos.
Custo real
 realCost number

Custo real.
Custo estimado
 estimatedCost number

Custo estimado.
Preço
 price number

Preço.
Identificador de interface
 interfaceId string

Identificador de interface.
Closed
 isClosed boolean

Fechado.
Progress
 currentProgress number

Progresso.
Data real
 realDate string

Data real.
Data estimada
 estimatedDate string

Data estimada.
ID do autor
 authorId integer

Identificador do autor.
Author
 authorName string

Nome do autor.
Attachments
 attachments array of object

Anexos relacionados com o processo.
ID
 attachments.id integer

Identificador de anexo.
nome
 attachments.name string

Nome do anexo.
Campo adicional
 additionalFields array of object

Campo adicional.
ID
 additionalFields.fieldId integer

identificador de campo.
nome
 additionalFields.nameField string

nome do campo.
values
 additionalFields.values array of string

Valores de campo adicionais.
: ID
 additionalFields.valueDetails.id integer

Especificação para campos de tipo de lista ou catálogo: identificador.
: Valor
 additionalFields.valueDetails.value string

Especificação para campos de tipo de lista ou catálogo: Valor.

Obter histórico de casos

ID da Operação:
CaseHistory

Obter histórico de casos, por padrão as notas não estão incluídas.

Parâmetros

Name Chave Necessário Tipo Description
Id por projeto
 ticketId True string

Código do registo
Incluir notas
 addNote string

Selecione o tipo de nota que deseja adicionar.

Devoluções

Name Caminho Tipo Description
array of object
Chave de ação
 actionId string

Chave de ação
Ação
 actionName string

Nome da atividade ou ação executada no ciclo de vida do ticket.
ID do autor
 authorId integer

Identificador do autor.
Author
 authorName string

Autor que fez a alteração.
Data de criação
 created date-time

Data em que a ação ocorreu.
Nome do campo modificado
 fieldName string

Nome do campo modificado.
Novo valor
 newValue html

Representa o novo valor da propriedade.
Valor antigo
 oldValue html

Valor que foi modificado.
Tipo de nota
 noteType string

Representa o tipo de nota (apenas para a tecla de ação 'Nota').
Identificador de item relacionado
 relatedItemId string

Representa o identificador quando uma Relação é adicionada. (apenas para a chave de ação 'AddedRelated').

Obter item de configuração

ID da Operação:
GetCI

Obter CI por nome e série.

Parâmetros

Name Chave Necessário Tipo Description
Nome ou CI de série
 request True string

Insira o nome ou a série do item de configuração.

Devoluções

Name Caminho Tipo Description
Campo adicional
 additionalFields array of object

Campo adicional.
ID
 additionalFields.fieldId integer

identificador de campo
nome
 additionalFields.nameField string

nome do campo
values
 additionalFields.values array of string

Valores de campo adicionais
: ID
 additionalFields.valueDetails.id integer

Especificação para campos de tipo de lista ou catálogo: identificador
: Valor
 additionalFields.valueDetails.value string

Especificação para campos de tipo de lista ou catálogo: Valor
Tag de ativo
 assetTag string

Tag de ativo.
Código de barras
 barCode string

Código de barras.
ID
 brand.id integer

Identificador de marca.
nome
 brand.name string

Nome da marca.
ID
 category.id integer

Identificador de categoria.
nome
 category.name string

Nome da categoria.
ID
 costCenter.id integer

Identificador do centro de custo.
nome
 costCenter.name string

Nome do centro de custo.
Data de aceitação
 acceptDate date-time

Data de aceitação.
Data de entrega à empresa
 checkinDate date-time

Data de entrega à empresa.
Data inicial da responsabilidade
 responsibilityDate date-time

Data inicial da responsabilidade.
Data de criação
 createdDate date-time

Data de criação.
Data de modificação
 modifiedDate date-time

Data de modificação.
Description
 description string

Descrição pormenorizada da IC.
ID de IC
 id integer

Identificador do sistema para o registo.
ID
 impact.id integer

Identificador de impacto.
nome
 impact.name string

Nome do impacto.
Número de licença
 licenseNumber string

Número de licença.
ID
 manufacturer.id integer

Identificador do fabricante.
nome
 manufacturer.name string

Nome do fabricante.
ID
 model.id integer

Identificador do modelo.
nome
 model.name string

Nome do modelo.
Nome CI
 name string

Nome do item de configuração.
Projetos
 projects array of object

projetos.
ID
 projects.id integer

identificador.
ID
 provider.id integer

Identificador do fabricante.
nome
 provider.name string

Nome do fabricante.
ID
 reason.id integer

Identificador de motivo.
nome
 reason.name string

Nome da razão
ID
 responsible.id integer

Identificador responsável.
nome
 responsible.name string

Nome do responsável.
ID
 risk.id integer

Identificador de risco.
nome
 risk.name string

Nome do risco.
RFID
 rfid string

RFID
Serial
 serial string

Serial
ID
 state.id integer

Identificador de estado.
nome
 state.name string

Nome do estado.
Identificador de item temporário
 tempItemId integer

Identificador de item temporário.
Tipo de IC
 type string

Tipo de item de configuração.
ID
 unit.id integer

Identificador da unidade.
nome
 unit.name string

Nome da unidade.
Valor unitário da medida
 unitSize string

Meça o valor unitário.
Vida útil
 usefulLife integer

Vida útil.
Versão
 version integer

versão

Pesquisar artigos

ID da Operação:
GetArticle

Recupera uma lista de artigos com base nos critérios de pesquisa adicionados na consulta.

Parâmetros

Name Chave Necessário Tipo Description
Projeto
 projectId True integer

Selecione um projeto ou insira manualmente um identificador de projeto.
Pesquisar artigo
 search True string

Pesquise um artigo pelo título, palavra-chave ou descrição.
Categoria
 folderId integer

Selecione uma categoria ou insira manualmente um identificador de categoria.
Tipo
 typeId integer

Selecione um tipo ou insira manualmente um identificador de tipo.

Devoluções

Name Caminho Tipo Description
array of object
Title
 title string

Título.
Description
 description string

Description.
Content
 content html

Conteúdo.
Palavra-chave do artigo
 keyword string

Palavra-chave do artigo.
ID do artigo
 identifier string

Identificador do artigo.
Data de criação
 createdDate string

Data de criação.
Data de modificação
 lastModifiedDate string

Data de modificação.
ID da classe
 classId integer

Identificador de classe.
ID do artigo
 id integer

Identificador do sistema para o registo.
ID
 type.id integer

Identificador de tipo.
nome
 type.name string

Nome do tipo.
URL
 url string

URL
Artigo em anexo
 attachments array of object

Anexos relacionados com o artigo.
ID
 attachments.id integer

Identificador de anexo.
nome
 attachments.name string

Nome do anexo.

Pesquisar casos

ID da Operação:
SearchTickets

Recupera uma lista de registros de caso ASMS dependendo dos critérios de pesquisa adicionados na consulta.

Parâmetros

Name Chave Necessário Tipo Description
Relação entre filtros
 logicOperator True string

Especifica a relação entre os critérios de pesquisa.
Campo a filtrar
 field True string

Campo de maiúsculas e minúsculas a filtrar (por exemplo, 'stateName').
Operador de pesquisa
 operator True string

Operador de pesquisa.
Valor a encontrar
 value True string

Valor do campo a ser encontrado.

Devoluções

Name Caminho Tipo Description
array of object
ID do caso
 id integer

Identificador do sistema para o registo.
Id por projeto
 idByProject string

Id por projeto para o registro.
Assunto
 subject string

Assunto do caso.
Description
 description string

Descrição pormenorizada do caso.
ID do projeto
 projectId integer

Identificador do projeto.
Projeto
 projectName string

Nome do projeto.
Tipo de Caso
 itemTypeName string

Nome do tipo de caso.
ID do tipo de caso
 itemTypeId integer

Identificador de tipo de caso.
ID do serviço
 serviceId integer

Identificador do serviço.
Serviço
 serviceName string

Nome do serviço.
ID do modelo
 modelId integer

Identificador do modelo.
Modelo
 modelName string

Nome do modelo.
ID da categoria
 categoryId integer

Identificador de categoria.
Categoria
 categoryName string

Nome da categoria.
ID do candidato
 applicantId integer

Identificador do requerente.
ID de IC
 ciId integer

Identificador do item de configuração.
IC
 ciName string

Nome do item de configuração principal.
ID do Cliente
 customerId integer

Identificador do cliente.
Client
 customerName string

Nome do cliente.
ID da Empresa
 companyId integer

Identificador da empresa.
Empresa
 companyName string

Nome da empresa.
SLA ID
 slaId integer

Identificador de SLA.
SLA
 slaName string

Nome do SLA.
Status ID
 stateId integer

Identificador de status.
Situação
 stateName string

Nome do status.
ID do motivo
 reasonId integer

Identificador de motivo.
Reason
 reasonName string

Nome da razão.
ID do grupo
 groupId integer

Identificador de grupo.
Grupo
 groupName string

Nome do grupo.
ID responsável
 responsibleId integer

Identificador responsável.
Responsável
 responsibleName string

Nome do responsável.
ID de impacto
 impactId integer

Identificador de impacto.
Impacto
 impactName string

Nome do impacto.
Data de Registo
 openedDate string

Data do Registo.
ID do autor
 authorId integer

Identificador do autor.
Author
 authorName string

Nome do autor.

Pesquisar itens de configuração

ID da Operação:
SearchCIs

Recupera uma lista de registros de CIs CMDB dependendo dos critérios de pesquisa adicionados na consulta.

Parâmetros

Name Chave Necessário Tipo Description
Relação entre filtros
 logicOperator True string

Especifica a relação entre os critérios de pesquisa.
Campo a filtrar
 field True string

Campo CI a filtrar (por exemplo, 'stateName')
Operador de pesquisa
 operator True string

Operador de pesquisa.
Valor a encontrar
 value True string

Valor do campo a ser encontrado.

Devoluções

Name Caminho Tipo Description
array of object
Data de aceitação
 acceptDate date-time

Data de aceitação
Tag de ativo
 assetTag string

Tag de ativo
Nome do responsável
 responsibleName string

Nome do responsável
ID
 category.id integer

Identificador de categoria
nome
 category.name string

Nome da categoria
Data de entrega à empresa
 checkinDate date-time

Data de entrega à empresa.
Data de criação
 createdDate date-time

Data de criação
Description
 description string

Descrição pormenorizada da IC.
ID de IC
 id integer

Identificador do sistema para o registo.
ID
 impact.id integer

Identificador de impacto
nome
 impact.name string

Nome do impacto
Data de modificação
 modifiedDate date-time

Data de modificação
Nome CI
 name string

Nome do item de configuração.
Data inicial da responsabilidade
 responsibilityDate date-time

Data inicial da responsabilidade.
Serial
 serial string

Serial
ID
 state.id integer

Identificador de estado.
nome
 state.name string

Nome do estado.
Tipo de IC
 type string

Tipo de item de configuração.

Definições

binário

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