Compartilhar via


Mavim-iMprove

Com o conector do Mavim, você pode criar um gêmeo digital de sua organização visualizando as relações entre pessoas, processo e tecnologia e cria um mapa de operações de negócios para ajudá-lo a monitorar as mudanças, medir o impacto e tomar decisões de negócios informadas para ajudá-lo a chegar ao seu destino. Nosso software de nuvem usa padrões abertos para integração com aplicativos de terceiros, permitindo a adoção simples na pilha de tecnologia de qualquer empresa.

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 Servicedesk do Mavim
URL https://my.mavim.com
Email servicedesk@mavim.com
Metadados do conector
Publicador Mavim
Site https://www.mavim.com/
Política de privacidade https://trustcenter.mavim.com/
Categorias Gestão de empresas; Colaboração

Usando o conector do Mavim iMprove Power Platform, você pode criar; Recuperar; Atualizar e excluir tópico. Atualizando campos e criar; Recuperar; Atualizar e excluir relações.

Os tópicos do Mavim são armazenados de maneira hierárquica. Onde o "banco de dados Mavim" é chamado de tópico raiz. Abaixo do tópico raiz, existem três filhos, em que o gabinete Amarelo é a área de trabalho; O gabinete verde contém as versões criadas (somente leitura) (como crianças) e o gabinete roxo contém as versões importadas (somente leitura) (como crianças).

Somente no gabinete Amarelo você pode alterar os tópicos; campos e relações. Todos os tópicos; relações e campos têm o identificador exclusivo chamado código DCV. Somente o tópico raiz tem um indentifier estático (d0c2v0). Todos os outros itens que recebem um número gerado fornecido pelo banco de dados Mavim.

Observe que, para alguns tópicos (como "Lixeira" e "Categorias de Relação") as regras de negócios se aplicam.

Para ver os dados de uma maneira mais visual, você pode fazer logon no aplicativo Web Mavim iMprove usando suas credenciais também usadas para o Microsoft Power Platform e a seguinte URL: https://improve.mavimcloud.com/

Pré-requisitos

Para poder usar o conector do Mavim Power Platform, você precisa ter um banco de dados do Mavim Cloud e um logon da ID do Microsoft Entra de seu próprio locatário.

  • Você precisa do identificador do banco de dados Mavim Cloud (dbid);
  • A conta de usuário deve ter um endereço de email válido vinculado à sua conta.

Como obter credenciais

Durante o processo de embarque, pedimos um nome de logon da ID do Microsoft Entra. Isso será registrado como o usuário administrador do banco de dados de nuvem do Mavim. Quando o banco de dados de nuvem estiver pronto, o Mavim fornecerá o identificador de banco de dados também chamado dbid.

Introdução ao conector

A ação GetRootTopic é obter o ponto de partida da árvore hierárquica. Isso retornará o tópico raiz e todas as suas propriedades. As ações de simular são GetTopic para obter um tópico específico; GetTopicChildren para obter todos os tópicos filhos; GetSiblings para obter todos os irmãos de um tópico.

Todas as chamadas para as ações exigem que o dbid se conecte ao seu próprio banco de dados Mavim e a um código de langage. Os idiomas de dados com suporte para a API são inglês (en) e holandês (nl). Os tópicos no banco de dados Mavim têm um código DCV exclusivo, esse é o indentifier de um tópico específico também chamado topicid.

MavimiMprove.GetTopicRoot(dbid,datalanguage);

Obtenha o tópico raiz.

Resposta (exemplo)

{
    "business": {
        "canCreateChildTopic": false,
        "canCreateTopicAfter": false,
        "canDelete": false,
        "isReadOnly": true
    },
    "dcv": "d0c2v0",
    "hasChildren": true,
    "icon": "TreeIconID_DbGreen",
    "isInRecycleBin": false,
    "name": "Mavim Database",
    "orderNumber": -1,
    "typeCategory": "mavimElementContainer"
}

MavimiMprove.GetTopic(dbid,datalanguage,topicId)

Obtenha um tópico específico pelo indentifier dcv.

Resposta (exemplo)

    "business": {
        "canCreateChildTopic": true,
        "canCreateTopicAfter": true,
        "canDelete": true,
        "isReadOnly": false
    },
    "dcv": "d16730231c28607v0",
    "hasChildren": true,
    "icon": "TreeIconID_YellowOpen",
    "isInRecycleBin": false,
    "name": "PowerApps topic",
    "orderNumber": 20,
    "parent": "d16730231c24017v0",
    "resources": [
        {
            "Value": "subTopics"
        },
        {
            "Value": "fields"
        }
    ],
    "typeCategory": "mavimElementContainer"
}

MavimiMprove.GetTopicChildren(dbid, datalanguage, topicId)

Obter os tópicos filhos do tópico

Resposta (exemplo)

[
    {
        "business": {
            "canCreateChildTopic": true,
            "canCreateTopicAfter": true,
            "canDelete": true,
            "isReadOnly": false
        },
        "dcv": "d16730231c28632v0",
        "hasChildren": false,
        "icon": "TreeIconID_YellowOpen",
        "isInRecycleBin": false,
        "name": "Subtopic 1",
        "orderNumber": 1,
        "parent": "d16730231c28607v0",
        "typeCategory": "unknown"
    },
   {
        "business": {
            "canCreateChildTopic": true,
            "canCreateTopicAfter": true,
            "canDelete": true,
            "isReadOnly": false
        },
        "dcv": "d16730231c28633v0",
        "hasChildren": false,
        "icon": "TreeIconID_YellowOpen",
        "isInRecycleBin": false,
        "name": "Subtopic 2",
        "orderNumber": 2,
        "parent": "d16730231c28607v0",
        "typeCategory": "unknown"
    }
]

Outras ações com suporte são

Tópico

  • CreateTopicAfter
  • CreateChildTopic
  • UpdateTopic
  • DeleteTopic

Estrutura de tópicos

  • MoveTopicToTop
  • MoveTopicToBottom
  • MoveTopicUp
  • MoveTopicDown
  • MoveTopicLevelUp
  • MoveTopicLevelDown
  • GetPathToRoot

Fields

  • GetTopicFields
  • GetFieldByDcvAndFieldsetId
  • UpdateFields
  • UpdateBooleanSingleField
  • UpdateTextSingleField
  • UpdateTextMultiField
  • UpdateNumberSingleField
  • UpdateNumberMultiField
  • UpdateDecimalSingleField
  • UpdateDecimalMultiField
  • UpdateDateSingleField
  • UpdateDateMultiField
  • UpdateListSingleField
  • UpdateRelationshipSingleField
  • UpdateRelationshipMultiField
  • UpdateRelationshipListField
  • UpdateSingleHyperlinkField
  • UpdateMultiHyperlinkField

Relações

  • GetTopicRelations
  • SaveRelation
  • DeleteRelation
  • GetRelationCategories

Other

  • GetTopicCharts
  • GetTopicTypes
  • GetTopicIcons
  • Versão

Problemas e limitações conhecidos

  • A atualização de uma descrição de tópico só pode ser feita por nossa API WOPI (Office para a Web). No Portal do Meu Mavim, você pode encontrar mais informações na API do Desenvolvedor do Mavim.
  • A API do Mavim iMprove dá suporte aos idiomas de dados inglês e holandês.
  • No momento, só permitimos que um locatário acesse o banco de dados de nuvem do Mavim. Não há suporte para usuários convidados a partir de agora.

Erros e soluções comuns

401 Não autenticado

  • Verifique se os usuários têm acesso ao banco de dados de nuvem do Mavim. Acesse o gerenciamento de usuário do Mavim iMprove para garantir que os usuários corretos tenham acesso.
  • Verifique se a conta de usuário tem um endereço de email válido.

404 Não encontrado

  • Verifique se o tópico existe no banco de dados de nuvem do Mavim. Você pode usar o Mavim iMprove ou o Mavim Manager para valdidar se ele ainda existir.

perguntas frequentes

Onde posso adicionar usuários adicionais? Adicione usuários adicionais usando a seção de gerenciamento de usuários no aplicativo Mavim iMprove. Aqui você pode adicionar todos os usuários que precisam de acesso. Fornecer acesso ao Mavim iMprove significa que o usuário tem permissão para usar o Mavim iMprove e o acesso à API.

Contas de Serivce/API O acesso ao banco de dados Mavim só é permitido conectando-se com um usuário nomeado. O Mavim não fornece um método de autenticação clientid e secret para se conectar à API.

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.

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Atualiza o nome do tópico

Atualiza o nome de um tópico específico.

Atualiza os campos do tópico

Atualiza vários tipos de campos para um tópico específico.

Atualiza um campo de hiperlink de valor único

Atualiza um campo de hiperlink de valor único para um tópico específico.

Atualiza um campo de hiperlink de vários valores

Atualiza um campo de hiperlink de vários valores para um tópico específico.

Atualizar o campo booliano do tópico

Atualiza um campo booliano específico por identificador de campo e conjunto de campos para um tópico específico.

Atualizar o campo da lista de relacionamentos do tópico

Atualiza um campo de lista de relações de valor único específico por identificador de campo e conjunto de campos para um tópico específico.

Atualizar o campo data de vários valores do tópico

Atualiza um campo de data de vários valores específico por campo e identificador de conjunto de campos para um tópico específico.

Atualizar o campo data do tópico

Atualiza um campo de data de valor único específico por campo e identificador de conjunto de campos para um tópico específico.

Atualizar o campo de lista do tópico

Atualiza um campo de lista específico por identificador de campo e conjunto de campos para um tópico específico.

Atualizar o campo de relação de vários valores do tópico

Atualiza um campo de relação de vários valores específico por identificador de campo e conjunto de campos para um tópico específico.

Atualizar o campo de relação do tópico

Atualiza um campo de relação de valor único específico por identificador de campo e conjunto de campos para um tópico específico.

Atualizar o campo de texto de vários valores do tópico

Atualiza um campo de texto de vários valores específico por campo e identificador de conjunto de campos para um tópico específico.

Atualizar o campo de texto do tópico

Atualiza um campo de texto de valor único específico por campo e identificador de conjunto de campos para um tópico específico.

Atualizar o campo decimal de vários valores do tópico

Atualiza um campo decimal de vários valores específico por identificador de campo e conjunto de campos para um tópico específico.

Atualizar o campo decimal do tópico

Atualiza um campo decimal de valor único específico por identificador de campo e conjunto de campos para um tópico específico.

Atualizar o campo número de vários valores do tópico

Atualiza um campo booliano específico por identificador de campo e conjunto de campos para um tópico específico.

Atualizar o campo número do tópico

Atualiza um campo de número de valor único específico por campo e identificador de conjunto de campos para um tópico específico.

Criar relação

Cria uma relação entre dois tópicos.

Criar um novo tópico

Um novo tópico é criado como um irmão após o tópico referenciado.

Criar um novo tópico filho

Um novo tópico é criado como um filho do tópico referenciado.

Excluir relação do tópico

Exclui a relação por id de tópico e relationId.

Excluir um tópico

O tópico específico solicitado pela ID do tópico é excluído.

Mover um tópico para a parte inferior do branch

Mova um tópico específico para a parte inferior do branch.

Mover um tópico para a parte superior do branch

Mova um tópico específico para a parte superior do branch.

Mover um tópico para baixo no branch

Mova um tópico específico para baixo no branch.

Mover um tópico para baixo no branch

Mova um tópico específico para baixo no branch.

Mover um tópico para cima no branch

Mova um tópico específico para cima no branch.

Mover um tópico para cima no branch

Mova um tópico específico para cima no branch.

Obter a versão da API

Recupere o número de versão da API.

Obter as Relações do tópico

Obtenha as Relações do tópico fornecido pela ID do DCV do tópico.

Obter campo do tópico

Obtenha um campo específico por identificador de campo e conjunto de campos para um tópico específico.

Obter o caminho da ID de tópico fornecida para a raiz

Obtenha todos os tópicos no caminho para o tópico raiz.

Obter o tópico raiz

Obtenha o tópico raiz.

Obter os campos do tópico

Em um tópico específico solicitado com a ID do tópico, uma coleção de campos é retornada.

Obter os filhos af um tópico

Obter os tópicos filhos do tópico

Obter os gráficos do tópico

Em um tópico específico solicitado com a ID do tópico, uma coleção de gráficos é retornada.

Obter os tópicos irmãos do tópico

Obtenha os tópicos irmãos do tópico fornecido pela ID do tópico.

Obter tipos para um tópico

Obtenha uma coleção de tipos para um tópico específico fornecido pela ID do tópico.

Obter Tópico

Obtenha um tópico específico pelo indentifier dcv.

Obter uma coleção de tópicos

Obter as categorias de relação do tópico

Obter ícones de disponibilidade para um tipo de tópico

Obtenha uma coleção de ícones para um tipo de tópico específico.

Atualiza o nome do tópico

Atualiza o nome de um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

nome
name string

Obtém ou define o título

Retornos

Corpo
ITopic

Atualiza os campos do tópico

Atualiza vários tipos de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data string
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data array of string
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data integer
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data array of integer
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data boolean
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data double
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data array of double
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data date-time
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data array of date-time
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data object
opções
options object
fieldId
fieldId string
fieldsetId
fieldsetId string
dcv
dcv string
nome
name string
icon
icon string
fieldId
fieldId string
fieldsetId
fieldsetId string
dcv
dcv string
nome
name string
icon
icon string
fieldId
fieldId string
fieldsetId
fieldsetId string
dados
data object
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data uri
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data array of uri

Retornos

Corpo
IField

Atualiza um campo de hiperlink de valor único para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador do conjunto de campos.
fieldsetId True string

O identificador do conjunto de campos.

O identificador de campo.
fieldId True string

O identificador de campo.

dados
data string

Retornos

Corpo
IField

Atualiza um campo de hiperlink de vários valores para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador do conjunto de campos.
fieldsetId True string

O identificador do conjunto de campos.

O identificador de campo.
fieldId True string

O identificador de campo.

dados
data array of string

Retornos

Corpo
IField

Atualizar o campo booliano do tópico

Atualiza um campo booliano específico por identificador de campo e conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data boolean

Retornos

Corpo
IField

Atualizar o campo da lista de relacionamentos do tópico

Atualiza um campo de lista de relações de valor único específico por identificador de campo e conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldId
fieldId string
fieldsetId
fieldsetId string
dados
data object

Retornos

Corpo
IField

Atualizar o campo data de vários valores do tópico

Atualiza um campo de data de vários valores específico por campo e identificador de conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data array of date-time

Retornos

Corpo
IField

Atualizar o campo data do tópico

Atualiza um campo de data de valor único específico por campo e identificador de conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data date-time

Retornos

Corpo
IField

Atualizar o campo de lista do tópico

Atualiza um campo de lista específico por identificador de campo e conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data object
opções
options object

Retornos

Corpo
IField

Atualizar o campo de relação de vários valores do tópico

Atualiza um campo de relação de vários valores específico por identificador de campo e conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldId
fieldId string
fieldsetId
fieldsetId string
dcv
dcv string
nome
name string
icon
icon string

Retornos

Corpo
IField

Atualizar o campo de relação do tópico

Atualiza um campo de relação de valor único específico por identificador de campo e conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldId
fieldId string
fieldsetId
fieldsetId string
dcv
dcv string
nome
name string
icon
icon string

Retornos

Corpo
IField

Atualizar o campo de texto de vários valores do tópico

Atualiza um campo de texto de vários valores específico por campo e identificador de conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data array of string

Retornos

Corpo
IField

Atualizar o campo de texto do tópico

Atualiza um campo de texto de valor único específico por campo e identificador de conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data string

Retornos

Corpo
IField

Atualizar o campo decimal de vários valores do tópico

Atualiza um campo decimal de vários valores específico por identificador de campo e conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data array of double

Retornos

Corpo
IField

Atualizar o campo decimal do tópico

Atualiza um campo decimal de valor único específico por identificador de campo e conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data double

Retornos

Corpo
IField

Atualizar o campo número de vários valores do tópico

Atualiza um campo booliano específico por identificador de campo e conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data array of integer

Retornos

Corpo
IField

Atualizar o campo número do tópico

Atualiza um campo de número de valor único específico por campo e identificador de conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
topicId
topicId string
setName
setName string
nome_do_campo
fieldName string
fieldValueType
fieldValueType string
required
required boolean
somente leitura
readonly boolean
uso
usage string
dcv
dcv string
nome
name string
icon
icon string
dcv
dcv string
nome
name string
icon
icon string
openLocation
openLocation string
dados
data integer

Retornos

Corpo
IField

Criar relação

Cria uma relação entre dois tópicos.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

fromElementDcv
fromElementDcv string

FromElementDcv

toElementDcv
toElementDcv string

ToElementDcv

relationshipType
relationshipType string

Retornos

Criar um novo tópico

Um novo tópico é criado como um irmão após o tópico referenciado.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

nome
name True string

Obtém ou define o nome

tipo
type True string

Obtém ou define o tipo

icon
icon True string

Obtém ou define o ícone

Retornos

Corpo
ITopic

Criar um novo tópico filho

Um novo tópico é criado como um filho do tópico referenciado.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

nome
name True string

Obtém ou define o nome

tipo
type True string

Obtém ou define o tipo

icon
icon True string

Obtém ou define o ícone

Retornos

Corpo
ITopic

Excluir relação do tópico

Exclui a relação por id de tópico e relationId.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

O identificador de relação.
relationId True string

O identificador de relação.

Excluir um tópico

O tópico específico solicitado pela ID do tópico é excluído.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Retornos

Corpo
ITopic

Mover um tópico para a parte inferior do branch

Mova um tópico específico para a parte inferior do branch.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Mover um tópico para a parte superior do branch

Mova um tópico específico para a parte superior do branch.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Mover um tópico para baixo no branch

Mova um tópico específico para baixo no branch.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Mover um tópico para baixo no branch

Mova um tópico específico para baixo no branch.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Mover um tópico para cima no branch

Mova um tópico específico para cima no branch.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Mover um tópico para cima no branch

Mova um tópico específico para cima no branch.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Obter a versão da API

Recupere o número de versão da API.

Retornos

response
string

Obter as Relações do tópico

Obtenha as Relações do tópico fornecido pela ID do DCV do tópico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Retornos

Obter campo do tópico

Obtenha um campo específico por identificador de campo e conjunto de campos para um tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

O identificador de definição do conjunto de campos.
fieldsetId True string

O identificador de definição do conjunto de campos.

O identificador de definição de campo.
fieldId True string

O identificador de definição de campo.

Retornos

Corpo
IField

Obter o caminho da ID de tópico fornecida para a raiz

Obtenha todos os tópicos no caminho para o tópico raiz.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Retornos

Corpo
ITopicPath

Obter o tópico raiz

Obtenha o tópico raiz.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

Retornos

Corpo
ITopic

Obter os campos do tópico

Em um tópico específico solicitado com a ID do tópico, uma coleção de campos é retornada.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do tópico.
topicId True string

O identificador do tópico.

Retornos

response
array of IField

Obter os filhos af um tópico

Obter os tópicos filhos do tópico

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Retornos

response
array of ITopic

Obter os gráficos do tópico

Em um tópico específico solicitado com a ID do tópico, uma coleção de gráficos é retornada.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Retornos

response
array of IChart

Obter os tópicos irmãos do tópico

Obtenha os tópicos irmãos do tópico fornecido pela ID do tópico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador dcv.
topicId True string

O identificador dcv.

Retornos

response
array of ITopic

Obter tipos para um tópico

Obtenha uma coleção de tipos para um tópico específico fornecido pela ID do tópico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador dcv.
topicId True string

O identificador dcv.

Retornos

response
object

Obter Tópico

Obtenha um tópico específico pelo indentifier dcv.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O identificador do Tópico.
topicId True string

O identificador do Tópico.

Retornos

Corpo
ITopic

Obter uma coleção de tópicos

Obter as categorias de relação do tópico

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

Retornos

response
array of ITopic

Obter ícones de disponibilidade para um tipo de tópico

Obtenha uma coleção de ícones para um tipo de tópico específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
O identificador do banco de dados Mavim.
dbId True uuid

O identificador do banco de dados Mavim.

O idioma do tópico.
dataLanguage True string

O idioma do tópico.

O tipo de tópico.
topicType True string

O tipo de tópico.

Retornos

response
object

Definições

CategoryType

FieldType

IChart

Nome Caminho Tipo Description
dcv
dcv string
nome
name string

IField

Nome Caminho Tipo Description
fieldsetId
fieldsetId string
fieldId
fieldId string
setOrder
setOrder integer
ordem
order integer
setName
setName string
nome_do_campo
fieldName string
topicId
topicId string
fieldValueType
fieldValueType FieldType
required
required boolean
somente leitura
readonly boolean
uso
usage string
relationshipCategory
relationshipCategory IRelationshipElement
característica
characteristic IRelationshipElement
openLocation
openLocation string

IPathItem

Nome Caminho Tipo Description
ordem
order integer
dcvId
dcvId string

IRelationship

Nome Caminho Tipo Description
dcv
dcv string
isTypeOfTopic
isTypeOfTopic boolean
categoria
category string
tipoDeCategoria
categoryType CategoryType
relationshipType
relationshipType RelationshipType
icon
icon string
userInstruction
userInstruction IRelationshipElement
dispatchInstructions
dispatchInstructions array of ISimpleDispatchInstruction
característica
characteristic IRelationshipElement
withElement
withElement IRelationshipElement
withElementParent
withElementParent IRelationshipElement

IRelationshipElement

Nome Caminho Tipo Description
dcv
dcv string
nome
name string
icon
icon string

ISimpleDispatchInstruction

Nome Caminho Tipo Description
typeName
typeName string
dcv
dcv string
nome
name string
icon
icon string

ITopic

Nome Caminho Tipo Description
dcv
dcv string
pai
parent string
hasChildren
hasChildren boolean
nome
name string
typeCategory
typeCategory TopicType
icon
icon string
orderNumber
orderNumber integer
resources
resources array of TopicResource
isInRecycleBin
isInRecycleBin boolean
empresa
business ITopicBusiness

ITopicBusiness

Nome Caminho Tipo Description
isReadOnly
isReadOnly boolean
canDelete
canDelete boolean
canCreateChildTopic
canCreateChildTopic boolean
canCreateTopicAfter
canCreateTopicAfter boolean

ITopicPath

Nome Caminho Tipo Description
caminho
path array of IPathItem
dados
data array of ITopic

RelationshipType

TopicResource

TopicType

cadeia

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

objeto

Esse é o tipo 'object'.