Mavim-iMprove
Com o conector Mavim você é capaz de construir um gêmeo digital de sua organização, visualizando as relações entre pessoas, processos e tecnologia e cria um mapa de operações de negócios para ajudá-lo a monitorar a mudança, medir o impacto e tomar decisões de negócios informadas para ajudá-lo a chegar ao seu destino. Nosso software em nuvem faz uso de padrões abertos para integração com aplicativos de terceiros, permitindo uma adoção simples na pilha de tecnologia de qualquer empresa.
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 | Central de serviços Mavim |
| URL | https://my.mavim.com |
| servicedesk@mavim.com |
| Metadados do conector | |
|---|---|
| Editora | Mavim |
| Sítio Web | https://www.mavim.com/ |
| Política de privacidade | https://trustcenter.mavim.com/ |
| Categorias | Gestão Empresarial; Colaboração |
Usando o conector Mavim iMprove Power Platform você é capaz de criar; Recuperar; Tópico Atualizar e excluir. Atualização de campos e Criar; Recuperar; Atualizar e excluir relações.
Os tópicos do Mavim são armazenados de forma hierárquica. Onde o "banco de dados Mavim" é chamado de tópico raiz. Abaixo do tópico raiz existem três crianças, onde o armário 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).
Apenas no gabinete amarelo você pode mudar os tópicos; campos e relações. Todos os temas; relações e campos têm o identificador único chamado código DCV. Apenas o tópico raiz tem um indentificador estático (d0c2v0). Todos os outros itens recebendo um número gerado fornecido pelo banco de dados Mavim.
Observe que para alguns tópicos (como "Lixeira" e "Categorias de relacionamento") aplicam-se regras de negócio.
Para ver os dados de uma forma mais visual, você pode fazer login no aplicativo Web Mavim iMprove usando suas credenciais também usadas para a Microsoft Power Platform e a seguinte URL: https://improve.mavimcloud.com/
Pré-requisitos
Para poder usar o conector Mavim Power Platform, você precisa ter um banco de dados Mavim Cloud e um login Microsoft Entra ID do seu próprio locatário.
- Você precisa do identificador de banco de dados Mavim Cloud (dbid);
- A conta de utilizador deve ter um endereço de correio eletrónico válido associado à sua conta.
Como obter credenciais
Durante o processo de integração, pedimos um nome de login do Microsoft Entra ID. Este será registrado como o usuário administrador do banco de dados em nuvem Mavim. Quando o banco de dados Cloud 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 sua árvore hierárquica. Isso retornará o tópico raiz e todas as suas propriedades. As ações simulares são GetTopic para obter um tópico específico; GetTopicChildren para obter todos os tópicos infantis; GetBrothers 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 um código de linguagem. Os idiomas de dados suportados 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, este é o identificador 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 identificador 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 infantis 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 apoiadas são:
Tópico
- CreateTopicAfter
- CreateChildTopic
- UpdateTopic
- DeleteTopic
Estrutura do tópico
- MoveTopicToTop
- MoveTopicToBottom
- MoveTopicUp
- MoveTopicDown
- MoveTopicLevelUp
- MoveTopicLevelDown
- GetPathToRoot
Campos
- GetTopicFields
- GetFieldByDcvAndFieldsetId
- UpdateFields
- UpdateBooleanSingleField
- UpdateTextSingleField
- UpdateTextMultiField
- UpdateNumberSingleField
- UpdateNumberMultiField
- UpdateDecimalSingleField
- UpdateDecimalMultiField
- UpdateDateSingleField
- UpdateDateMultiField
- UpdateListSingleField
- UpdateRelationshipSingleField
- UpdateRelationshipMultiField
- UpdateRelationshipListField
- UpdateSingleHyperlinkField
- UpdateMultiHyperlinkField
Relações
- GetTopicRelations
- SalvarRelação
- DeleteRelation
- GetRelationCategories
Other
- GetTopicCharts
- GetTopicTypes
- GetTopicIcons
- Versão
Problemas conhecidos e limitações
- A atualização da descrição de um tópico só pode ser feita pela nossa API WOPI (Office for the Web). No Portal My Mavim você pode encontrar mais informações sob a API do desenvolvedor Mavim.
- A API do Mavim iMprove suporta os idiomas de dados inglês e holandês.
- No momento, permitimos que apenas um locatário acesse o banco de dados em nuvem Mavim. Os usuários convidados não são suportados a partir de agora.
Erros e soluções comuns
401 Não athorized
- Verifique se os usuários têm acesso ao banco de dados em nuvem Mavim. Vá para o gerenciamento de usuários do Mavim iMprove para garantir que os usuários corretos tenham acesso.
- Verifique se a conta de usuário tem um endereço de e-mail válido.
404 Não Encontrado
- Verifique se o tópico existe no banco de dados em nuvem Mavim. Você pode usar o Mavim iMprove ou o Mavim Manager para valdidate, se ele ainda existir.
FAQ
Onde posso adicionar mais utilizadores? Adicione outros usuários 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 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 secreta e clientid para se conectar à API.
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.
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de 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 campo booleano do tópico |
Atualiza um campo booleano específico por campo e identificador de conjunto de campos para um tópico específico. |
| Atualizar campo da lista do tópico |
Atualiza uma lista específica campo por campo e identificador de conjunto de campos para um tópico específico. |
| Atualizar campo de data de vários valores do tópico |
Atualiza um identificador específico de data de vários valores por campo e conjunto de campos para um tópico específico. |
| Atualizar campo de lista de relacionamentos do tópico |
Atualiza uma relação de valor único específica campo por campo e identificador de conjunto de campos para um tópico específico. |
| Atualizar campo de número de vários valores do tópico |
Atualiza um campo booleano específico por campo e identificador de conjunto de campos para um tópico específico. |
| Atualizar campo de relacionamento do tópico |
Atualiza uma relação de valor único específica campo por campo e identificador de conjunto de campos para um tópico específico. |
| Atualizar campo de relação de vários valores do tópico |
Atualiza uma relação de vários valores específica campo por campo e identificador de conjunto de campos para um tópico específico. |
| Atualizar campo de texto de vários valores do tópico |
Atualiza um campo de texto específico de vários valores por campo e identificador de conjunto de campos para um tópico específico. |
| Atualizar campo de texto do tópico |
Atualiza um valor único específico campo de texto por campo e identificador de conjunto de campos para um tópico específico. |
| Atualizar campo decimal de vários valores do tópico |
Atualiza um campo decimal de vários valores específico por campo e identificador de conjunto de campos para um tópico específico. |
| Atualizar campo decimal do tópico |
Atualiza um valor único específico campo decimal por campo e identificador de conjunto de campos para um tópico específico. |
| Campo de data de atualização do tópico |
Atualiza um único campo de data-valor específico por campo e identificador de conjunto de campos para um tópico específico. |
| Campo de número de atualização do tópico |
Atualiza um número de valor único específico campo por campo e identificador de conjunto de campos para um tópico específico. |
| Criar novo tópico filho |
Um novo tópico é criado como filho do tópico referenciado. |
| 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. |
| Excluir relação do tópico |
Exclui a relação por topic id e relationId. |
| Excluir um tópico |
O tópico específico solicitado pelo id do tópico é excluído. |
| Mover um tópico para a parte inferior da ramificação |
Mover um tópico específico para a parte inferior da ramificação. |
| Mover um tópico para a parte superior da ramificação |
Mover um tópico específico para a parte superior da ramificação. |
| Mover um tópico para baixo na ramificação |
Mova um tópico específico um lugar para baixo na ramificação. |
| Mover um tópico para baixo na ramificação |
Mova um tópico específico um lugar para baixo na ramificação. |
| Mover um tópico para cima na ramificação |
Mova um tópico específico um lugar para cima na ramificação. |
| Mover um tópico para cima na ramificação |
Mova um tópico específico um lugar para cima na ramificação. |
| Obtenha uma coleção de tópicos |
Obter as categorias de relacionamento do tópico |
| Obter a versão da API |
Recupere o número da versão da API. |
| Obter as crianças af um tópico |
Obter os tópicos infantis do tópico |
| Obter as relações do tópico |
Obtenha as Relações do tópico fornecido pelo tópico DCV ID. |
| Obter campo do tópico |
Obtenha um identificador específico campo por campo e conjunto de campos para um tópico específico. |
| Obter o caminho da ID do tópico fornecido 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 |
A partir de um tópico específico solicitado com a ID do tópico, uma coleção de campos é retornada. |
| Obter os gráficos do tópico |
A partir de 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 fornecidos pelo 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 identificador DCV. |
| Obter ícones disponíveis 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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
|
nome
|
name | string |
Obtém ou define o título |
Devoluções
- Body
- ITopic
Atualiza os campos do tópico
Atualiza vários tipos de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | string | ||
|
fieldsetId
|
fieldsetId | string | ||
|
fieldId
|
fieldId | string | ||
|
setOrder
|
setOrder | integer | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | array of string | ||
|
fieldsetId
|
fieldsetId | string | ||
|
fieldId
|
fieldId | string | ||
|
setOrder
|
setOrder | integer | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | integer | ||
|
fieldsetId
|
fieldsetId | string | ||
|
fieldId
|
fieldId | string | ||
|
setOrder
|
setOrder | integer | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | array of integer | ||
|
fieldsetId
|
fieldsetId | string | ||
|
fieldId
|
fieldId | string | ||
|
setOrder
|
setOrder | integer | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | boolean | ||
|
fieldsetId
|
fieldsetId | string | ||
|
fieldId
|
fieldId | string | ||
|
setOrder
|
setOrder | integer | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | double | ||
|
fieldsetId
|
fieldsetId | string | ||
|
fieldId
|
fieldId | string | ||
|
setOrder
|
setOrder | integer | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | array of double | ||
|
fieldsetId
|
fieldsetId | string | ||
|
fieldId
|
fieldId | string | ||
|
setOrder
|
setOrder | integer | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | date-time | ||
|
fieldsetId
|
fieldsetId | string | ||
|
fieldId
|
fieldId | string | ||
|
setOrder
|
setOrder | integer | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | array of date-time | ||
|
fieldsetId
|
fieldsetId | string | ||
|
fieldId
|
fieldId | string | ||
|
setOrder
|
setOrder | integer | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | object | ||
|
options
|
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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | uri | ||
|
fieldsetId
|
fieldsetId | string | ||
|
fieldId
|
fieldId | string | ||
|
setOrder
|
setOrder | integer | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | array of uri |
Devoluções
- Body
- IField
Atualiza um campo de hiperlink de valor único
Atualiza um campo de hiperlink de valor único para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 |
Devoluções
- Body
- IField
Atualiza um campo de hiperlink de vários valores
Atualiza um campo de hiperlink de vários valores para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 |
Devoluções
- Body
- IField
Atualizar campo booleano do tópico
Atualiza um campo booleano específico por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | boolean |
Devoluções
- Body
- IField
Atualizar campo da lista do tópico
Atualiza uma lista específica campo por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | object | ||
|
options
|
options | object |
Devoluções
- Body
- IField
Atualizar campo de data de vários valores do tópico
Atualiza um identificador específico de data de vários valores por campo e conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | array of date-time |
Devoluções
- Body
- IField
Atualizar campo de lista de relacionamentos do tópico
Atualiza uma relação de valor único específica campo por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 |
Devoluções
- Body
- IField
Atualizar campo de número de vários valores do tópico
Atualiza um campo booleano específico por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | array of integer |
Devoluções
- Body
- IField
Atualizar campo de relacionamento do tópico
Atualiza uma relação de valor único específica campo por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 |
Devoluções
- Body
- IField
Atualizar campo de relação de vários valores do tópico
Atualiza uma relação de vários valores específica campo por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 |
Devoluções
- Body
- IField
Atualizar campo de texto de vários valores do tópico
Atualiza um campo de texto específico de vários valores por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | array of string |
Devoluções
- Body
- IField
Atualizar campo de texto do tópico
Atualiza um valor único específico campo de texto por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | string |
Devoluções
- Body
- IField
Atualizar campo decimal de vários valores do tópico
Atualiza um campo decimal de vários valores específico por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | array of double |
Devoluções
- Body
- IField
Atualizar campo decimal do tópico
Atualiza um valor único específico campo decimal por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | double |
Devoluções
- Body
- IField
Campo de data de atualização do tópico
Atualiza um único campo de data-valor específico por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | date-time |
Devoluções
- Body
- IField
Campo de número de atualização do tópico
Atualiza um número de valor único específico campo por campo e identificador de conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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 | ||
|
order
|
order | integer | ||
|
tópicoId
|
topicId | string | ||
|
setName
|
setName | string | ||
|
fieldName
|
fieldName | string | ||
|
fieldValueType
|
fieldValueType | string | ||
|
required
|
required | boolean | ||
|
só de leitura
|
readonly | boolean | ||
|
utilização
|
usage | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
DCV
|
dcv | string | ||
|
nome
|
name | string | ||
|
icon
|
icon | string | ||
|
openLocalização
|
openLocation | string | ||
|
dados
|
data | integer |
Devoluções
- Body
- IField
Criar novo tópico filho
Um novo tópico é criado como filho do tópico referenciado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de 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 |
Devoluções
- Body
- ITopic
Criar relação
Cria uma relação entre dois tópicos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
deElementDcv
|
fromElementDcv | string |
FromElementDcv |
|
|
toElementDcv
|
toElementDcv | string |
ToElementDcv |
|
|
relationshipType
|
relationshipType | string |
Devoluções
- Body
- IRelationship
Criar um novo tópico
Um novo tópico é criado como um irmão após o tópico referenciado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de 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 |
Devoluções
- Body
- ITopic
Excluir relação do tópico
Exclui a relação por topic id e relationId.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de 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 pelo id do tópico é excluído.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Devoluções
- Body
- ITopic
Mover um tópico para a parte inferior da ramificação
Mover um tópico específico para a parte inferior da ramificação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Mover um tópico para a parte superior da ramificação
Mover um tópico específico para a parte superior da ramificação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Mover um tópico para baixo na ramificação
Mova um tópico específico um lugar para baixo na ramificação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Mover um tópico para baixo na ramificação
Mova um tópico específico um lugar para baixo na ramificação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Mover um tópico para cima na ramificação
Mova um tópico específico um lugar para cima na ramificação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Mover um tópico para cima na ramificação
Mova um tópico específico um lugar para cima na ramificação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Obtenha uma coleção de tópicos
Obter as categorias de relacionamento do tópico
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
Devoluções
- response
- array of ITopic
Obter a versão da API
Obter as crianças af um tópico
Obter os tópicos infantis do tópico
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Devoluções
- response
- array of ITopic
Obter as relações do tópico
Obtenha as Relações do tópico fornecido pelo tópico DCV ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Devoluções
- response
- array of IRelationship
Obter campo do tópico
Obtenha um identificador específico campo por campo e conjunto de campos para um tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem 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. |
Devoluções
- Body
- IField
Obter o caminho da ID do tópico fornecido para a raiz
Obtenha todos os tópicos no caminho para o tópico raiz.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Devoluções
- Body
- ITopicPath
Obter o tópico raiz
Obtenha o tópico raiz.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
Devoluções
- Body
- ITopic
Obter os campos do tópico
A partir de um tópico específico solicitado com a ID do tópico, uma coleção de campos é retornada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador do tópico.
|
topicId | True | string |
O identificador do tópico. |
Devoluções
- response
- array of IField
Obter os gráficos do tópico
A partir de um tópico específico solicitado com a ID do tópico, uma coleção de gráficos é retornada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Devoluções
- response
- array of IChart
Obter os tópicos irmãos do tópico
Obtenha os tópicos irmãos do tópico fornecidos pelo ID do tópico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O DCV identifica.
|
topicId | True | string |
O DCV identifica. |
Devoluções
- 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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O DCV identifica.
|
topicId | True | string |
O DCV identifica. |
Devoluções
- response
- object
Obter tópico
Obtenha um tópico específico pelo identificador DCV.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O identificador de tópico.
|
topicId | True | string |
O identificador de tópico. |
Devoluções
- Body
- ITopic
Obter ícones disponíveis para um tipo de tópico
Obtenha uma coleção de ícones para um tipo de tópico específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de banco de dados Mavim.
|
dbId | True | uuid |
O identificador de banco de dados Mavim. |
|
A linguagem do tópico.
|
dataLanguage | True | string |
A linguagem do tópico. |
|
O tipo Tópico.
|
topicType | True | string |
O tipo Tópico. |
Devoluções
- response
- object
Definições
Tipo de categoria
Tipo de campo
IChart
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
DCV
|
dcv | string | |
|
nome
|
name | string |
IField
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
fieldsetId
|
fieldsetId | string | |
|
fieldId
|
fieldId | string | |
|
setOrder
|
setOrder | integer | |
|
order
|
order | integer | |
|
setName
|
setName | string | |
|
fieldName
|
fieldName | string | |
|
tópicoId
|
topicId | string | |
|
fieldValueType
|
fieldValueType | FieldType | |
|
required
|
required | boolean | |
|
só de leitura
|
readonly | boolean | |
|
utilização
|
usage | string | |
|
relacionamentoCategoria
|
relationshipCategory | IRelationshipElement | |
|
caraterística
|
characteristic | IRelationshipElement | |
|
openLocalização
|
openLocation | string |
IPathItem
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
order
|
order | integer | |
|
dcvID
|
dcvId | string |
IRelationship
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
DCV
|
dcv | string | |
|
isTypeOfTopic
|
isTypeOfTopic | boolean | |
|
categoria
|
category | string | |
|
tipoDeCategoria
|
categoryType | CategoryType | |
|
relationshipType
|
relationshipType | RelationshipType | |
|
icon
|
icon | string | |
|
userInstruction
|
userInstruction | IRelationshipElement | |
|
instruções de envio
|
dispatchInstructions | array of ISimpleDispatchInstruction | |
|
caraterística
|
characteristic | IRelationshipElement | |
|
withElement
|
withElement | IRelationshipElement | |
|
comElementParent
|
withElementParent | IRelationshipElement |
IRelationshipElement
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
DCV
|
dcv | string | |
|
nome
|
name | string | |
|
icon
|
icon | string |
ISimpleDispatchInstruction
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
typeName
|
typeName | string | |
|
DCV
|
dcv | string | |
|
nome
|
name | string | |
|
icon
|
icon | string |
ITopic
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
DCV
|
dcv | string | |
|
elemento principal
|
parent | string | |
|
temCrianças
|
hasChildren | boolean | |
|
nome
|
name | string | |
|
tipoCategoria
|
typeCategory | TopicType | |
|
icon
|
icon | string | |
|
Número da encomenda
|
orderNumber | integer | |
|
resources
|
resources | array of TopicResource | |
|
isInRecycleBin
|
isInRecycleBin | boolean | |
|
negócios
|
business | ITopicBusiness |
ITopicBusiness
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
isReadOnly
|
isReadOnly | boolean | |
|
canDelete
|
canDelete | boolean | |
|
canCreateChildTopic
|
canCreateChildTopic | boolean | |
|
canCreateTopicAfter
|
canCreateTopicAfter | boolean |
ITopicPath
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
caminho
|
path | array of IPathItem | |
|
dados
|
data | array of ITopic |
Tipo de Relacionamento
TópicoRecurso
Tipo de tópico
cadeia (de caracteres)
Este é o tipo de dados básico 'string'.
objecto
Este é o tipo 'objeto'.