Compartilhar via


Gerenciamento de Serviços do Aranda (versão prévia)

Aumente a produtividade da sua empresa e transforme a experiência dos usuários com o Aranda Service Management Suite, a solução multilocatário que permite gerenciar, integrar e automatizar processos e serviços de negócios.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – 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
Publicador Aranda Software Corporation
Site https://arandasoft.com/
Política de privacidade https://arandasoft.com/politica-de-privacidad/
Categorias Gestão de empresas; Colaboração

Aranda Service Management Suite (ASMS)

Aumente a produtividade da sua empresa e transforme a experiência dos usuários com o Aranda Service Management Suite, a solução multilocatário que permite gerenciar, integrar e automatizar processos e serviços de negócios. Crie, pesquise e atualize registros armazenados em qualquer workspace (projeto) do ASMS, incluindo incidentes, requisitos e alterações, entre outros.

Pré-requisitos

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.

Obtendo 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 ASMS (Aranda Service Management Suite).

  2. Obter o token de integração

  3. Obtenha a URL da Instância da API asms (ApiAsms) de Gerenciamento de Serviços do Aranda.

  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 uma 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 tíquetes, entre outras ações disponíveis.
  2. Obter a rastreabilidade do tíquete.
  3. Baixe anexos relacionados a um tíquete.
  4. Pesquise artigos de KB (base de dados de conhecimento) no Aranda Service Management Suite.
  5. Baixe anexos de artigos da base de dados de conhecimento (KB).
  6. Criar, pesquisar e atualizar itens de configuração (CIs).
  7. Ele permite que as organizações resolvam suas solicitações internas de suporte, gerenciando e simplificando o processo de resolução de problemas técnicos.
  8. Permite o acompanhamento de comunicações entre solicitantes e agentes de suporte.
  9. Ofereça respostas automatizadas para informar os solicitantes sobre o status de seu tíquete.

Resposta bem-sucedida

Code Nome Description
200 OKEY A solicitação foi bem-sucedida
204 Sem conteúdo Nenhum dado encontrado na solicitação

Erros e soluções comuns

Code Nome Description Solução
400 SolicitaçãoInválida CriteriaNeedsSomeArguments Verifique se os parâmetros de pesquisa não estão vazios
400 SolicitaçãoInválida InvalidAdditionalFieldId Verifique se as IDs dos campos adicionais estão corretas
400 SolicitaçãoInválida InvalidItemType O tipo de caso está incorreto, altere a ID do tipo de caso
400 SolicitaçãoInválida InvalidProjectId A ID do projeto está incorreta, altere a ID do projeto à qual você associará o caso
400 SolicitaçãoInválida InvalidStateId Verificar o status adicionado ao criar ou atualizar um tíquete
400 SolicitaçãoInválida InvalidUploadType Erro ao anexar um arquivo, solicitar assistência de um Administrador do Sistema
400 SolicitaçãoInválida RequestNeedsSomeArguments Verifique os campos necessários do tíquete e adicione o valor correspondente destes no conector
400 SolicitaçãoInválida SearchListIsRequired Solicitar assistência de um Administrador do Sistema
400 SolicitaçãoInválida Nome do parâmetro: {Parâmetro de nome} Verifique se as propriedades mencionadas no erro não são nulas
400 SolicitaçãoInválida É o nome do parâmetro nulo: {Parâmetro de nome} Verifique se as propriedades mencionadas no erro não são nulas
400 SolicitaçãoInválida ItemTypeIsRequired Adicionar tipo de caso
400 SolicitaçãoInválida ModelIdIsEmpty Adicione o parâmetro modelId. É necessário.
400 SolicitaçãoInválida StateIdIsEmpty Adicione o parâmetro stateId. É necessário.
400 SolicitaçãoInválida ServiceIdIsEmpty Adicione o parâmetro serviceId. É necessário.
400 SolicitaçãoInválida CategoryIdIsEmpty Adicione o parâmetro categoryId. É necessário.
400 SolicitaçãoInválida TypesListNeedsSomeArguments Requer a adição do tipo de caso ao pesquisar tíquetes, solicitar assistência de um Administrador do Sistema
400 SolicitaçãoInválida '{PARAMETER_NAME}' AdditionalFieldIsRequired O campo adicional '{PARAMETER_NAME}' é obrigatório
400 SolicitaçãoInválida ModelNotActive O modelo associado ao caso não está ativo
400 SolicitaçãoInválida FailedToCloseTaskPendingCloseTasksPredecessors Se você tentar fechar o caso e o caso pai tiver tarefas pendentes para fechar
400 SolicitaçãoInválida DuplicatedObject O Ci já existe no banco de dados
400 SolicitaçãoInválida Nome do parâmetro EmptyValue: {PARAMETER_NAME} O parâmetro {PARAMETER_NAME} é necessário
400 SolicitaçãoInválida Nome do parâmetro EmptyEnumeration: {PARAMETER_NAME} O parâmetro {PARAMETER_NAME} é uma lista e é necessário
403 Proibido DoNotHavePermissionForThisAction Fale com o Administrador do Sistema para atribuir permissões
Code Nome Description Solução
500 Erro Interno do Servidor Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureExportExcel Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetAdditionalFields Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetCategoriesByService Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetChangeFSC Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetFields Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetFieldsList Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetFiles Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetLookupValues Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetMailTemplates Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetModelByCategory Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetOperators Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetReassignmentReasons Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureGetSimilarItems Solicitar assistência de um Administrador do Sistema
500 Erro Interno do Servidor FailureSearchQuickManagement Solicitar assistência de um Administrador do Sistema

perguntas frequentes

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

    As IDs podem ser recuperadas de várias maneiras:

    • Usando o Aranda Query Manager, você pode criar um relatório que consulta a tabela ASMS (Aranda Service Management Suite), em que os dados necessários estão localizados. Se você precisar de diretrizes 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 à instalação do ASMS.
    • Se você estiver usando uma instalação local do ASMS, poderá consultar a tabela ASMS em que os dados necessários estão localizados por meio de um cliente SQL.
    • Por meio do Centro de Suporte do Aranda, criando uma solicitação de suporte por meio dos canais de contato indicados no suporte do site a seguir.
  2. Qual é o tamanho máximo dos arquivos a serem anexados ao usar a ação "Adicionar Anexo"?

    O tamanho máximo depende da configuração específica da instância/instalação do ASMS. Pergunte ao administrador do ASMS.

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

    O nível de acesso é o mesmo que a conta técnica 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 técnica cujo token será usado no conector deve ser Nomeada ou Simultânea?

    Como o conector pode acessar a instância do ASMS relacionada várias vezes por hora, é altamente recomendável que a conta seja um 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 do ASMS?

    Sim, ele 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 precisarem ser preenchidos, esses dados também serão necessários ao enviar o caso por meio do conector.

  6. O conector pode ser usado para instâncias do ASMS em ambientes de nuvem e local?

    Sim, ele pode ser usado nas instalações de nuvem e local do ASMS. Em instalações locais, você deve considerar a conectividade entre o servidor ASMS e seu ambiente do Power Automate.

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

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

  8. Quero criar fluxos no Power Automate que começam 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 de eventos que ocorrem no ASMS?

    Sim, é possível. As seguintes etapas são recomendadas:

    • Inicialize um gatilho "Quando uma solicitação HTTP é recebida" e crie um esquema JSON do corpo da solicitação contendo a estrutura de dados que deverá ser recebida do ASMS. Depois que o gatilho for criado, você obterá uma URL HTTP POST (URL do WebHook) para usar em sua instância do ASMS. Não se esqueça de considerar o mecanismo de autenticação para acessar a 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 "Invocar Webhook" e, na 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 de uma regra no ASMS, visite o seguinte link: regra do Webhook
    • Teste a regra criada e valide se uma solicitação HTTP é enviada para a URL do WebHook e inicializa o fluxo no Power Automate.
  9. Posso invocar pontos de extremidade da API REST do ASMS como ações de fluxos no Power Automate?

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

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default 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.

Essa não é uma conexão compartilhável. Se o aplicativo de energia 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 Host ASMS Verdade
Token de autorização secureString Token de autorização Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à 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 anotação ao caso

Adicione uma anotação a um registro de caso específico no ASMS.

Atualizar item de configuração

Atualizar CIs no CMDB do Aranda.

Baixar o anexo de maiúsculas e minúsculas

Baixe o anexo relacionado ao artigo.

Baixar o anexo do artigo

Baixe o anexo relacionado ao artigo.

Caso de atualização

Atualiza um registro para um caso ASMS.

Casos de pesquisa

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

Criar caso

Crie um novo registro de caso no ASMS.

Criar item de configuração

Crie CIs no CMDB do Aranda.

Obter histórico de casos

Obtenha o histórico de casos, por padrão, as anotações não estão incluídas.

Obter item de configuração

Obter CI por nome e serial.

Obter maiúsculas/minúscula

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

Pesquisar artigos

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

Pesquisar itens de configuração

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

Adicionar anexo ao caso

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Id por projeto
ticketId True string

Código do registro

File
file True byte

Arquivo byte.

Nome do Arquivo
fileName True string

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

Adicionar anotação ao caso

Adicione uma anotação a um registro de caso específico no ASMS.

Parâmetros

Nome Chave Obrigatório Tipo Description
Id por projeto
ticketId True string

Código do registro

Observação
message True string

Observe que deve ser anexado ao registro.

Atualizar item de configuração

Atualizar CIs no CMDB do Aranda.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome ou CI serial
request True string

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

Description
description string

Descrição detalhada da CI.

Serial
serial string

Serial

Marca de ativo
assetTag string

Marca 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 da licença
licenseNumber string

Número da 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 provedor
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 para a empresa
checkInDate date-time

Data da entrega para a empresa.

Data inicial de responsabilidade
responsibilityDate date-time

Data inicial da responsabilidade.

Código de barras
barCode string

Código de barra.

Medir o valor da unidade
unitSize string

Medir o valor da unidade.

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 do Local
locationId integer

Identificador de local.

fieldId
fieldId string

Identificador de campo

values
values array of string

Value

Retornos

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

Identificador de item de configuração.

Baixar o anexo de maiúsculas e minúsculas

Baixe o anexo relacionado ao artigo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Id por projeto
ticketId True string

Código do registro

Identificador de anexo
fileId True integer

Representa o identificador do anexo.

Retornos

O conteúdo do anexo.

Conteúdo do ficheiro
binary

Baixar o anexo do artigo

Baixe o anexo relacionado ao artigo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do artigo
articleId True integer

Identificador de artigo.

ID do anexo
fileId True integer

Representa o identificador do anexo.

Retornos

O conteúdo do anexo.

Conteúdo do ficheiro
binary

Caso de atualização

Atualiza um registro para um caso ASMS.

Parâmetros

Nome Chave Obrigatório Tipo Description
Id por projeto
ticketId True string

Código do registro

Assunto
subject string

Assunto.

Description
description string

Descrição detalhada do caso.

Solução
commentary string

Solução de caso.

ID do Serviço
serviceId integer

Identificador de 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 requerente
applicantId integer

Identificador do requerente.

ID do cliente
customerId integer

Identificador do cliente.

ID da Empresa
companyId integer

Identificador da empresa.

ID de CI
ciId integer

Identificador de CI.

ID do provedor
providerId integer

Identificador do provedor.

ID da área organizacional
unitId integer

Identificador de área organizacional.

Tipo de registro
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.

Interfase
interfaceId string

relação do caso com terceiros.

Identificador de campo
fieldId string

Identificador de campo.

Valores
values array of string

Valores.

Retornos

Nome Caminho Tipo Description
resultado
result boolean

Resultado

Casos de pesquisa

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Relação entre filtros
logicOperator True string

Especifica a relação entre os critérios de pesquisa.

Campo a ser filtrado
field True string

Campo de maiúsculas e minúsculas a ser filtrado (por exemplo, 'stateName').

Operador de pesquisa
operator True string

Operador de pesquisa.

Valor a ser encontrado
value True string

Valor do campo a ser localizado.

Retornos

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

Identificador do sistema para o registro.

Id por projeto
idByProject string

Id por projeto para o registro.

Assunto
subject string

Assunto do caso.

Description
description string

Descrição detalhada do caso.

ID do projeto
projectId integer

Identificador de 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 de serviço.

Service
serviceName string

Nome do serviço.

ID do modelo
modelId integer

Identificador de modelo.

Modelo
modelName string

Nome do modelo.

ID da categoria
categoryId integer

Identificador de categoria.

Categoria
categoryName string

Nome da categoria.

ID do requerente
applicantId integer

Identificador do requerente.

ID de CI
ciId integer

Identificador de item de configuração.

CI
ciName string

Nome do item de configuração principal.

ID do cliente
customerId integer

Identificador do cliente.

Cliente
customerName string

Nome do cliente.

ID da Empresa
companyId integer

Identificador da empresa.

Empresa
companyName string

Nome da empresa.

SLA ID
slaId integer

Identificador SLA.

contrato de nível de serviço
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 do motivo.

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 responsável.

ID de impacto
impactId integer

Identificador de impacto.

Impacto
impactName string

Nome do impacto.

Data do Registro
openedDate string

Data do Registro.

ID do autor
authorId integer

Identificador do autor.

Autor
authorName string

Nome do autor.

Criar caso

Crie um novo registro de caso no ASMS.

Parâmetros

Nome Chave Obrigatório Tipo Description
Assunto
subject True string

Assunto.

Description
description string

Descrição detalhada 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.

Service
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 identificador responsável ou insira manualmente um identificador responsável.

Empresa
companyId integer

Selecione uma empresa ou insira manualmente um identificador da empresa.

Fornecedor
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 requerente
applicantId integer

Identificador do requerente.

ID do cliente
customerId integer

Identificador do cliente.

Identificador de CI
ciId integer

Identificador de CI.

Tipo de registro
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.

Retornos

Nome 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

Crie CIs no CMDB do Aranda.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome
name True string

Nome

Description
description string

Descrição detalhada da CI.

Serial
serial string

Serial.

Marca de ativo
assetTag string

Marca 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 da licença
licenseNumber string

Número da licença.

Fabricante
manufacturerId integer

Selecione um fabricante ou insira manualmente um 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 provedor
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 para a empresa
checkInDate date-time

Data da entrega para a empresa.

Data inicial de responsabilidade
responsibilityDate date-time

Data inicial da responsabilidade.

Código de barras
barCode string

Código de barra.

Medir o valor da unidade
unitSize string

Medir o valor da unidade.

Unidade de medida
unitId integer

Selecione uma unidade de medida ou insira manualmente um identificador de unidade de medida.

Centro de custo
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

Value

Retornos

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

Identificador de item de configuração.

Obter histórico de casos

Obtenha o histórico de casos, por padrão, as anotações não estão incluídas.

Parâmetros

Nome Chave Obrigatório Tipo Description
Id por projeto
ticketId True string

Código do registro

Incluir anotações
addNote string

Selecione o tipo de observação que você deseja adicionar.

Retornos

Nome 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 tíquete.

ID do autor
authorId integer

Identificador do autor.

Autor
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 anotação
noteType string

Representa o tipo de observação (somente para a chave de ação 'Observação').

Identificador de item relacionado
relatedItemId string

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

Obter item de configuração

Obter CI por nome e serial.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome ou CI serial
request True string

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

Retornos

Nome 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

Marca de ativo
assetTag string

Marca de ativo.

Código de barras
barCode string

Código de barra.

ID
brand.id integer

Identificador de marca.

nome
brand.name string

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 para a empresa
checkinDate date-time

Data da entrega para a empresa.

Data inicial de responsabilidade
responsibilityDate date-time

Data inicial da responsabilidade.

Data da criação
createdDate date-time

Data de criação.

Data de modificação
modifiedDate date-time

Data modificada.

Description
description string

Descrição detalhada da CI.

ID de CI
id integer

Identificador do sistema para o registro.

ID
impact.id integer

Identificador de impacto.

nome
impact.name string

Nome do impacto.

Número da licença
licenseNumber string

Número da licença.

ID
manufacturer.id integer

Identificador do fabricante.

nome
manufacturer.name string

Nome do fabricante.

ID
model.id integer

Identificador de modelo.

nome
model.name string

Nome do modelo.

Nome da 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 do motivo

ID
responsible.id integer

Identificador responsável.

nome
responsible.name string

Nome responsável.

ID
risk.id integer

Identificador de risco.

nome
risk.name string

Nome de 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 CI
type string

Tipo de item de configuração.

ID
unit.id integer

Identificador de unidade.

nome
unit.name string

Nome da unidade.

Medir o valor da unidade
unitSize string

Medir o valor da unidade.

Vida útil
usefulLife integer

Vida útil.

Versão
version integer

versão

Obter maiúsculas/minúscula

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Id por projeto
ticketId True string

Código do registro

Retornos

Nome Caminho Tipo Description
ID do caso
id integer

Identificador do sistema para o registro.

Id por projeto
idByProject string

Id por projeto para o registro.

Assunto
subject string

Assunto.

Description
description string

Descrição detalhada do caso.

Solução
commentary string

Solução de caso.

ID do projeto
projectId integer

Identificador de 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 de serviço.

Service
serviceName string

Nome do serviço.

ID do modelo
modelId integer

Identificador de modelo.

Modelo
modelName string

Nome do modelo.

ID da categoria
categoryId integer

Identificador de categoria.

Nome da categoria
categoryName string

Categoria.

ID do requerente
applicantId integer

Identificador do requerente.

ID do cliente
customerId integer

Identificador do cliente.

Cliente
customerName string

Nome do cliente.

ID da Empresa
companyId integer

Identificador da empresa.

Empresa
companyName string

Nome da empresa.

ID de CI
ciId integer

Identificador de CI.

CI
ciName string

Nome da CI.

SLA ID
slaId integer

Identificador SLA.

contrato de nível de serviço
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 do motivo.

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 responsável.

ID do tipo do Registro
registryTypeId integer

Identificador de tipo de registro.

Tipo de registro
registryTypeName string

Nome do tipo do Registro.

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 de risco.

ID do provedor
providerId integer

Identificador do provedor.

Fornecedor
providerName string

Nome do provedor.

UC ID
ucId integer

Identificador uc.

UC
ucName string

Nome da UC.

ID da área organizacional
unitId integer

Identificador de área organizacional.

Área organizacional
unitName string

Nome da área organizacional.

OLA ID
olaId integer

Identificador OLA.

OLA
olaName string

Nome do OLA.

Data do Registro
openedDate string

Data do registro.

Data de fechamento
closedDate string

Data de encerramento.

Data final
finalDate string

Data final (somente para registros de tarefa).

Data inicial
initialDate string

Data inicial (somente para registros de tarefa).

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.

Fechado
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.

Autor
authorName string

Nome do autor.

Attachments
attachments array of object

Anexos relacionados ao caso.

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.

Pesquisar artigos

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Projeto
projectId True integer

Selecione um projeto ou insira manualmente um identificador de projeto.

Artigo de pesquisa
search True string

Pesquise um artigo por seu 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.

Retornos

Nome Caminho Tipo Description
array of object
Title
title string

Título.

Description
description string

Descrição.

Content
content html

Conteúdo.

Palavra-chave do artigo
keyword string

Palavra-chave do artigo.

ID do artigo
identifier string

Identificador de artigo.

Data da criação
createdDate string

Data de criação.

Data de modificação
lastModifiedDate string

Data modificada.

ID da Classe
classId integer

Identificador de classe.

ID do artigo
id integer

Identificador do sistema para o registro.

ID
type.id integer

Identificador de tipo.

nome
type.name string

Nome do tipo.

URL
url string

URL

Artigo anexos
attachments array of object

Anexos relacionados ao artigo.

ID
attachments.id integer

Identificador de anexo.

nome
attachments.name string

Nome do anexo.

Pesquisar itens de configuração

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Relação entre filtros
logicOperator True string

Especifica a relação entre os critérios de pesquisa.

Campo a ser filtrado
field True string

Campo CI a ser filtrado (por exemplo, 'stateName')

Operador de pesquisa
operator True string

Operador de pesquisa.

Valor a ser encontrado
value True string

Valor do campo a ser localizado.

Retornos

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

Data de aceitação

Marca de ativo
assetTag string

Marca de ativo

Nome responsável
responsibleName string

Nome responsável

ID
category.id integer

Identificador de categoria

nome
category.name string

Nome da categoria

Data de entrega para a empresa
checkinDate date-time

Data da entrega para a empresa.

Data da criação
createdDate date-time

Data da criação

Description
description string

Descrição detalhada da CI.

ID de CI
id integer

Identificador do sistema para o registro.

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 da CI
name string

Nome do item de configuração.

Data inicial de 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 CI
type string

Tipo de item de configuração.

Definições

binário

Esse é o tipo de dados básico 'binary'.