Panviva
O Panviva é uma solução de gerenciamento de conhecimento omnichannel. Nossa prioridade é ajudar nossos clientes a manter seus funcionários felizes, para que eles possam se concentrar em garantir que seus clientes estejam felizes. Transformando digitalmente organizações nos últimos 20 anos, estamos agora ajudando nossos clientes a entregar pepitas de conhecimento para seus funcionários e clientes, sejam eles em casa ou no escritório - a qualquer momento e em qualquer lugar.
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 | Equipe de Defesa do Cliente panviva |
| URL | https://www.panviva.com/support |
| support@panviva.com |
| Metadados do conector | |
|---|---|
| Publicador | Panviva |
| Site | https://www.panviva.com |
| Política de privacidade | https://www.panviva.com/privacy-policy |
| Categorias | Gestão de empresas; Produtividade |
Pré-requisitos
Para usar o conector panviva, você deve ter:
- Acesso a uma instância do Panviva (também conhecida como locatário)
- Uma conta de desenvolvedor no portal do desenvolvedor do Panviva (dev.panviva.com)
- Uma assinatura ativa da API do Panviva (também conhecida como um plano de API) e credenciais válidas da API panviva
Se você não for um cliente ou precisar de ajuda
Como obter credenciais
Siga as etapas abaixo para obter sua instância de API e chave de API.
Se você vir um erro ao usar o conector, poderá procurar mais informações no código de erro. Observação: o código de status HTTP na documentação pode ser um pouco diferente do que você vê no Power Automate ou no Power Apps, use o campo Código de Erro para fins de pesquisa.
Para obter sua chave de API, você deve:
- Entre no portal do desenvolvedor do Panviva no dev.panviva.com
- Navegue até seu perfil (clique em seu nome e clique em "Perfil" na barra de navegação superior)
- Agora, você deverá ver sua chave de API na seção "Suas Assinaturas" do seu perfil.
Para obter sua instância de API, você deve:
- Entre no portal do desenvolvedor do Panviva no dev.panviva.com
- Navegue até a API (clique em "APIs" na barra de navegação superior)
- Agora você deve ver sua instância de API em seu pacote de API (procure "O nome da instância do API Suite é")
Limitações
Observe que seus limites de limitação serão baseados no tipo de assinatura de API (ou plano de API) ao qual você assinou.
Para localizar sua cota ou limite de taxa, você pode:
- Entre no portal do desenvolvedor do Panviva no dev.panviva.com
- Navegue até seu perfil (clique em seu nome e clique em "Perfil" na barra de navegação superior)
- Vá para seu plano de API na seção "Suas Assinaturas" do seu perfil
- Agora você deve ver os detalhes do seu plano (procure "... poderá executar chamadas **/minuto até um máximo de chamadas _**/mês...")
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de Assinatura da API do Panviva | secureString | A Chave de Assinatura da API do Panviva para sua instância. | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Artefato |
Retornar um artefato usando a ID fornecida |
| Contêiner |
Retornar um contêiner usando a ID do contêiner fornecida |
| Contêineres de documento |
Retornar uma lista de contêineres usando a ID do documento fornecida |
| Criar categoria de artefato |
Cria uma categoria para classificar artefatos |
| CSH dinâmico |
Apresentar uma página de resultado da pesquisa CSH da consulta de passagem no cliente Panviva para o usuário especificado no cliente Panviva |
| Documento |
Retornar um documento usando a ID do documento fornecida |
| Documento Ao Vivo |
Apresentar uma página de documento para o usuário especificado no cliente Panviva |
| File |
Retorna um arquivo (documento externo) do Panviva |
| Filhos da Pasta |
Obtém todos os filhos imediatos de uma pasta Panviva, não incluindo netos. Filhos podem ser pastas, documentos ou arquivos (documentos externos) |
| Imagem |
Retorna uma imagem do Panviva. Os dados da imagem são representados como uma cadeia de caracteres base64 |
| Live search |
Apresentar uma página de resultado da pesquisa da consulta de passagem no cliente Panviva para o usuário especificado no cliente Panviva |
| Obter categorias de artefato |
Obtém uma lista de todas as categorias de artefato disponíveis |
| Pasta |
Retornar informações sobre uma pasta panviva e referências a cada um de seus filhos diretos |
| Pesquisa |
Pesquisa documentos, pastas e arquivos (documentos externos) para obter um termo e retorna resultados paginados |
| Pesquisar artefatos |
Retornar resultados da pesquisa para uma determinada consulta |
| Raiz da pasta |
Obtém a pasta raiz/página inicial em todo o Panviva, que pode ser perfurado usando o ponto de extremidade Get Folder Children. Observe que esse ponto de extremidade foi anteriormente chamado de ponto de extremidade "Pesquisa de Pastas" |
| Relações de contêiner de documento |
Retornar uma lista da relação pai-filho entre cada contêiner para a ID do documento fornecida |
| Traduções de documentos |
Retornar uma lista de todas as traduções (por idioma e localidade) de um documento do Panviva |
| Traduções de pastas |
Obtém todas as traduções de uma pasta Panviva, juntamente com cada pasta traduzida respectivas crianças |
Artefato
Retornar um artefato usando a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
ID
|
id | True | string |
Formato – uuid. A ID (ID) de um artefato |
Retornos
- Corpo
- GetResponseResponse
Contêiner
Retornar um contêiner usando a ID do contêiner fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
ID
|
id | True | string |
A ID de um contêiner de documento |
Retornos
- Corpo
- GetContainerResponse
Contêineres de documento
Retornar uma lista de contêineres usando a ID do documento fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
ID
|
id | True | integer |
A ID interna (IID) de um documento panviva |
Retornos
Criar categoria de artefato
Cria uma categoria para classificar artefatos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
nome
|
name | string |
Retornos
CSH dinâmico
Apresentar uma página de resultado da pesquisa CSH da consulta de passagem no cliente Panviva para o usuário especificado no cliente Panviva
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
nome de usuário
|
username | string |
O usuário do Panviva para quem você deseja enviar o resultado. (Observação: use o nome de usuário OR userId, não ambos.) |
|
|
userId
|
userId | string |
A ID numérica do usuário para quem você deseja enviar o resultado. (Observação: use o nome de usuário OR userId, não ambos.) |
|
|
consulta
|
query | string |
O termo CSH a ser pesquisado. |
|
|
showFirstResult
|
showFirstResult | boolean |
True para abrir imediatamente o primeiro documento encontrado ou false para mostrar a lista de resultados. |
|
|
maximizeClient
|
maximizeClient | boolean |
True/False, dependendo se você deseja que o cliente Panviva maximize na área de trabalho do usuário, quando o documento for entregue. |
Retornos
- response
- object
Documento
Retornar um documento usando a ID do documento fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
ID
|
id | True | string |
Um identificador exclusivo do documento, id do documento. Se um documento for um documento traduzido, esse valor representará ID interna ou IID na API do Panviva v1. |
|
Versão
|
version | integer |
Solicite que a API retorne uma versão específica do documento especificado. |
Retornos
- Corpo
- GetDocumentResponse
Documento Ao Vivo
Apresentar uma página de documento para o usuário especificado no cliente Panviva
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
nome de usuário
|
username | string |
O usuário do Panviva para quem você deseja enviar o resultado. (Observação: use o nome de usuário OR userId, não ambos.) |
|
|
userId
|
userId | string |
A ID numérica do usuário para quem você deseja enviar o resultado. (Observação: use o nome de usuário OR userId, não ambos.) |
|
|
id
|
id | string |
A ID do Documento do Panviva que você deseja enviar. |
|
|
local
|
location | string |
A ID da Seção que você deseja que o usuário veja quando o documento especificado for aberto. |
|
|
maximizeClient
|
maximizeClient | boolean |
True/False, dependendo se você deseja que o cliente Panviva maximize na área de trabalho do usuário, quando o documento for entregue. |
Retornos
- response
- object
File
Retorna um arquivo (documento externo) do Panviva
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
ID
|
id | True | integer |
A IID (ID interna) de um arquivo Panviva (documento externo) |
Retornos
- Corpo
- GetFileResponse
Filhos da Pasta
Obtém todos os filhos imediatos de uma pasta Panviva, não incluindo netos. Filhos podem ser pastas, documentos ou arquivos (documentos externos)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
ID
|
id | True | integer |
A IID (ID interna) de uma pasta Panviva |
Retornos
Imagem
Retorna uma imagem do Panviva. Os dados da imagem são representados como uma cadeia de caracteres base64
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
ID
|
id | True | integer |
A ID de uma imagem do Panviva |
Retornos
- Corpo
- GetImageResponse
Live search
Apresentar uma página de resultado da pesquisa da consulta de passagem no cliente Panviva para o usuário especificado no cliente Panviva
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
nome de usuário
|
username | string |
O usuário do Panviva para quem você deseja enviar o resultado. (Observação: use o nome de usuário OR userId, não ambos.) |
|
|
userId
|
userId | string |
A ID numérica do usuário para quem você deseja enviar o resultado. (Observação: use o nome de usuário OR userId, não ambos.) |
|
|
consulta
|
query | string |
O termo a ser pesquisado. |
|
|
maximizeClient
|
maximizeClient | boolean |
True/False, dependendo se você deseja que o cliente Panviva maximize na área de trabalho do usuário, quando o documento for entregue. |
|
|
showFirstResult
|
showFirstResult | boolean |
True para abrir imediatamente o primeiro documento encontrado ou false para mostrar a lista de resultados. |
Retornos
- response
- object
Obter categorias de artefato
Obtém uma lista de todas as categorias de artefato disponíveis
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
Retornos
Pasta
Retornar informações sobre uma pasta panviva e referências a cada um de seus filhos diretos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
ID
|
id | True | integer |
A IID (ID interna) de uma pasta Panviva |
Retornos
- Corpo
- GetFolderResponse
Pesquisa
Pesquisa documentos, pastas e arquivos (documentos externos) para obter um termo e retorna resultados paginados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
Prazo
|
term | True | string |
A palavra ou frase a ser pesquisada |
|
Deslocamento de página
|
pageOffset | integer |
O deslocamento de paginação para denotar o número de resultados iniciais da pesquisa a serem ignoradas. Por exemplo, pageOffset de 100 e pageLimit de 10 retornariam registros 101-110. |
|
|
Limite de Página
|
pageLimit | integer |
O número de registros a serem retornados. Deve ser um inteiro entre 0 e 1000. |
Retornos
- Corpo
- GetSearchResponse
Pesquisar artefatos
Retornar resultados da pesquisa para uma determinada consulta
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
Consulta simples
|
simplequery | string |
Cadeia de caracteres de consulta de linguagem natural. Por exemplo: 'Filmes de Ação'. (Observação: use simplequery OR advancedquery, não ambos.) |
|
|
Consulta Avançada
|
advancedquery | string |
Cadeia de caracteres de consulta escrita na sintaxe da consulta Lucene. Por exemplo: "filmes E "uma história". (Observação: use simplequery OR advancedquery, não ambos.) |
|
|
Filter
|
filter | string |
Aceita uma cadeia de caracteres de filtro formatada em Lucene. Exemplos: 'category eq "Mortgages"', 'panvivaDocumentVersion gt "8"'. (Os campos filtrados incluem dateCreated, dateModified, dateDeleted, categoryJson, queryVariationsJson, title, category, primaryQuery, isDeleted, timestamp, panvivaDocumentId, panvivaDocumentVersion, id) |
|
|
Channel
|
channel | string |
Retornar resposta para um canal específico, em vez do padrão |
|
|
Deslocamento de página
|
pageOffset | integer |
O deslocamento de paginação para denotar o número de resultados iniciais da pesquisa a serem ignoradas. Por exemplo, pageOffset de 100 e pageLimit de 10 retornariam registros 101-110. |
|
|
Limite de Página
|
pageLimit | integer |
O número de registros a serem retornados. Deve ser um inteiro entre 0 e 1000. |
|
|
Faceta
|
facet | string |
Aceita uma cadeia de caracteres de faceta formatada por Lucene. Exemplos: 'facet=Category,count:10&facet=Rating'. (Campos de faceta incluem metaData/valores) |
Retornos
Raiz da pasta
Obtém a pasta raiz/página inicial em todo o Panviva, que pode ser perfurado usando o ponto de extremidade Get Folder Children. Observe que esse ponto de extremidade foi anteriormente chamado de ponto de extremidade "Pesquisa de Pastas"
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
Retornos
- Corpo
- GetFolderRootResponse
Relações de contêiner de documento
Retornar uma lista da relação pai-filho entre cada contêiner para a ID do documento fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
ID
|
id | True | integer |
A ID interna (IID) de um documento panviva |
Retornos
Traduções de documentos
Retornar uma lista de todas as traduções (por idioma e localidade) de um documento do Panviva
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
ID
|
id | True | integer |
A ID interna (IID) de um documento panviva. |
Retornos
Traduções de pastas
Obtém todas as traduções de uma pasta Panviva, juntamente com cada pasta traduzida respectivas crianças
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Exemplo
|
instance | True | string |
O nome da instância, conforme mostrado no Portal do Desenvolvedor do Panviva. |
|
ID
|
id | True | integer |
A IID (ID interna) de uma pasta Panviva |
Retornos
Definições
Link
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
href
|
href | string | |
|
rel
|
rel | string | |
|
tipo
|
type | string |
ResourceSearchResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | string | |
|
id
|
id | string | |
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
matchedFields
|
matchedFields | array of string | |
|
snippet
|
snippet | string | |
|
linguagem
|
language | string | |
|
links
|
links | array of Link |
GetSearchResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | array of ResourceSearchResult | |
|
total
|
total | integer | |
|
links
|
links | array of Link |
StringInt64NullableKeyValuePair
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string | |
|
value
|
value | integer |
Faceta
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
campo
|
field | string | |
|
groups
|
groups | array of StringInt64NullableKeyValuePair |
ResponseSection
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
mediaType
|
mediaType | string | |
|
enviar SMS
|
text | string | |
|
href
|
href | string | |
|
resourceLocation
|
resourceLocation | string |
Categoria
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
id
|
id | integer | |
|
dateCreated
|
dateCreated | date-time | |
|
dateModified
|
dateModified | date-time |
QueryVariation
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
consulta
|
query | string |
SearchResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
conteúdo
|
content | array of ResponseSection | |
|
categoria
|
category | Category | |
|
metadados
|
metaData | object | |
|
searchScore
|
searchScore | number | |
|
links
|
links | array of Link | |
|
queryVariations
|
queryVariations | array of QueryVariation | |
|
primaryQuery
|
primaryQuery | string | |
|
panvivaDocumentId
|
panvivaDocumentId | integer | |
|
panvivaDocumentVersion
|
panvivaDocumentVersion | integer | |
|
title
|
title | string |
GetSearchArtefactResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Facetas
|
facets | array of Facet | |
|
results
|
results | array of SearchResult | |
|
total
|
total | integer |
GetContainerResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
body
|
body | string |
Etiqueta
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
value
|
value | string |
Training
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
failureFeedback
|
failureFeedback | string | |
|
forcePageSequence
|
forcePageSequence | boolean | |
|
forceQuestionSequence
|
forceQuestionSequence | boolean | |
|
passScore
|
passingScore | integer | |
|
successFeedback
|
successFeedback | string |
GetDocumentResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
versão
|
version | integer | |
|
linguagem
|
language | string | |
|
tags
|
tags | array of Tag | |
|
oculto
|
hidden | boolean | |
|
fonte
|
source | string | |
|
tipo
|
type | string | |
|
versão
|
release | integer | |
|
Lançado
|
released | boolean | |
|
copyright
|
copyright | string | |
|
classificação
|
classification | string | |
|
status
|
status | string | |
|
porcentagem
|
percentage | integer | |
|
releaseDate
|
releaseDate | date-time | |
|
layout
|
layout | string | |
|
treinamento
|
training | Training | |
|
Palavras-chave
|
keywords | array of string | |
|
cshKeywords
|
cshKeywords | array of string | |
|
updatedDate
|
updatedDate | date-time | |
|
createdDate
|
createdDate | date-time | |
|
reusableContent
|
reusableContent | boolean | |
|
changeNote
|
changeNote | string | |
|
links
|
links | array of Link |
Channel
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
ResponseVariation
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of ResponseSection | |
|
canais
|
channels | array of Channel | |
|
id
|
id | integer | |
|
dateCreated
|
dateCreated | date-time | |
|
dateModified
|
dateModified | date-time |
GetResponseResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
links
|
links | array of Link | |
|
title
|
title | string | |
|
conteúdo
|
content | array of ResponseSection | |
|
Variações
|
variations | array of ResponseVariation | |
|
categoria
|
category | Category | |
|
primaryQuery
|
primaryQuery | string | |
|
queryVariations
|
queryVariations | array of QueryVariation | |
|
panvivaDocumentId
|
panvivaDocumentId | integer | |
|
panvivaDocumentVersion
|
panvivaDocumentVersion | integer | |
|
metadados
|
metaData | object | |
|
id
|
id | uuid | |
|
dateCreated
|
dateCreated | date-time | |
|
dateModified
|
dateModified | date-time |
Contêiner
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
body
|
body | string |
GetDocumentContainersResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
containers
|
containers | array of Container |
ContainerRelationship
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
pai
|
parent | string | |
|
children
|
children | array of string | |
|
taskFlow
|
taskFlow | string |
GetDocumentContainerRelationshipsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Relações
|
relationships | array of ContainerRelationship |
Documento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
versão
|
version | integer | |
|
linguagem
|
language | string | |
|
tags
|
tags | array of Tag | |
|
oculto
|
hidden | boolean | |
|
fonte
|
source | string | |
|
tipo
|
type | string | |
|
versão
|
release | integer | |
|
Lançado
|
released | boolean | |
|
copyright
|
copyright | string | |
|
classificação
|
classification | string | |
|
status
|
status | string | |
|
porcentagem
|
percentage | integer | |
|
releaseDate
|
releaseDate | date-time | |
|
layout
|
layout | string | |
|
treinamento
|
training | Training | |
|
Palavras-chave
|
keywords | array of string | |
|
cshKeywords
|
cshKeywords | array of string | |
|
updatedDate
|
updatedDate | date-time | |
|
createdDate
|
createdDate | date-time | |
|
reusableContent
|
reusableContent | boolean | |
|
changeNote
|
changeNote | string | |
|
links
|
links | array of Link |
GetDocumentTranslationsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Traduções
|
translations | array of Document | |
|
origem
|
origin | string |
GetFileResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
versão
|
version | integer | |
|
linguagem
|
language | string | |
|
tags
|
tags | array of Tag | |
|
oculto
|
hidden | boolean | |
|
fonte
|
source | string | |
|
tipo
|
type | string | |
|
conteúdo
|
content | string | |
|
fileName
|
fileName | string | |
|
versão
|
release | integer | |
|
Lançado
|
released | boolean | |
|
copyright
|
copyright | string | |
|
classificação
|
classification | string | |
|
status
|
status | string | |
|
porcentagem
|
percentage | integer | |
|
releaseDate
|
releaseDate | date-time | |
|
Palavras-chave
|
keywords | array of string | |
|
cshKeywords
|
cshKeywords | array of string | |
|
changeNote
|
changeNote | string | |
|
updatedDate
|
updatedDate | date-time | |
|
createdDate
|
createdDate | date-time |
GetFolderResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
versão
|
version | integer | |
|
linguagem
|
language | string | |
|
tags
|
tags | array of Tag | |
|
oculto
|
hidden | boolean | |
|
fonte
|
source | string | |
|
tipo
|
type | string | |
|
links
|
links | array of Link |
Resource
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
versão
|
version | integer | |
|
linguagem
|
language | string | |
|
tags
|
tags | array of Tag | |
|
oculto
|
hidden | boolean | |
|
fonte
|
source | string | |
|
tipo
|
type | string |
GetFolderChildrenResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
children
|
children | array of Resource |
Pasta
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
versão
|
version | integer | |
|
linguagem
|
language | string | |
|
tags
|
tags | array of Tag | |
|
oculto
|
hidden | boolean | |
|
fonte
|
source | string | |
|
tipo
|
type | string | |
|
links
|
links | array of Link |
GetFolderTranslationsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Traduções
|
translations | array of Folder |
GetFolderRootResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
versão
|
version | integer | |
|
linguagem
|
language | string | |
|
tags
|
tags | array of Tag | |
|
oculto
|
hidden | boolean | |
|
fonte
|
source | string | |
|
tipo
|
type | string | |
|
links
|
links | array of Link |
GetImageResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
largura
|
width | integer | |
|
height
|
height | integer | |
|
size
|
size | integer | |
|
tipo de conteúdo
|
contentType | string | |
|
conteúdo
|
content | string |
ArtefactCategory
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
categoryName
|
categoryName | string |
GetArtefactCategoriesResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categories
|
categories | array of ArtefactCategory |
PostArtefactCategoryResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categoryId
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
objeto
Esse é o tipo 'object'.