Partilhar via

Upland Panviva US (Pré-visualização)

Upland Panviva melhora o gerenciamento de conhecimento para indústrias complexas e regulamentadas, fornecendo orientação em tempo real alimentada por IA para agentes e clientes. Nossas soluções especializadas garantem conformidade e competitividade, adaptadas para organizações de saúde, bancos, serviços públicos e BPO com grandes contact centers. Do gerenciamento manual focado em conformidade à orientação de IA totalmente integrada, a Panviva se adapta às suas necessidades. Aumente a produtividade e mantenha os padrões de conformidade apoiados pela experiência do setor.

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 Upland Panviva Suporte
URL https://uplandsoftware.com/panviva/support/
Email support@uplandsoftware.com
Metadados do conector
Editora Upland Software Inc..
Sítio Web https://uplandsoftware.com/panviva
Política de privacidade https://uplandsoftware.com/privacy
Categorias Dados; Comercialização

Conector Panviva

Upland Panviva melhora o gerenciamento de conhecimento para indústrias complexas e regulamentadas, fornecendo orientação em tempo real alimentada por IA para agentes e clientes. Nossas soluções especializadas garantem conformidade e competitividade, adaptadas para organizações de saúde, bancos, serviços públicos e BPO com grandes contact centers. Do gerenciamento manual focado em conformidade à orientação de IA totalmente integrada, a Panviva se adapta às suas necessidades. Aumente a produtividade e mantenha os padrões de conformidade apoiados pela experiência do setor.

Pré-requisitos

Você precisará do seguinte para prosseguir:

  • Um plano Microsoft Power Apps ou Power Automate com recurso de conector personalizado
  • Uma camada de assinatura Panviva que inclui APIs

Construindo o conector

Como as APIs do Panviva estão protegidas, você precisará:

  1. Acesso a uma instância do Panviva (também conhecida como locatário)
  2. Uma conta de desenvolvedor no portal do desenvolvedor Panviva US-[https://dev.panviva.com] AU-(https://dev.panviva.com)
  3. Uma assinatura ativa da API Panviva (também conhecida como um plano de API) e credenciais válidas da API Panviva

Depois disso, você pode criar e testar o conector.

Ações Suportadas

O conector Panviva suporta as seguintes ações:

  • Operações de pesquisa
    • Search: Pesquisar documentos, pastas e arquivos (documentos externos) para um termo e retornar resultados paginados
    • Search Artefacts: Retornar resultados de pesquisa do Digital Orchestrator para uma determinada consulta
  • Operações ao vivo
    • Live CSH: Apresentar uma página de resultado de pesquisa CSH da consulta de passagem no cliente Panviva para o usuário especificado no cliente Panviva
    • Live Document: Apresentar uma página de documento para o usuário especificado no cliente Panviva
    • Live Search: Apresentar uma página de resultado de pesquisa da consulta passada no cliente Panviva para o usuário especificado no cliente Panviva
  • Operações documentais
    • Document: Devolver um documento utilizando o ID do documento fornecido
    • Document Containers: Retornar uma lista de contêineres usando a ID do documento fornecida
    • Document Container Relationships: Retornar uma lista da relação pai-filho entre cada contêiner para a ID do documento fornecida
    • Container: Retornar um contêiner usando o ID do contêiner fornecido
    • Document Translations: Retornar uma lista de todas as traduções (por idioma e localidade) de um documento Panviva
  • Operações de recursos
    • Artefact: Retornar um artefato do Digital Orchestrator usando a ID fornecida
    • Get Artefact Categories: Obtém uma lista de todas as categorias de artefactos disponíveis
    • File: Recuperar um arquivo (documento externo) do Panviva
    • Folder: Retornar informações sobre uma pasta Panviva e referências a cada um de seus filhos diretos
    • Folder Children: Recebe todos os filhos imediatos de uma pasta Panviva, não incluindo netos. As crianças podem ser pastas, documentos ou ficheiros (documentos externos)
    • Folder Translations: Obtém todas as traduções de uma pasta Panviva, juntamente com cada pasta traduzida respetivos filhos
    • Folder Root: Obtém a pasta raiz/home em todo o Panviva, que pode ser detalhada usando o ponto de extremidade Get Folder Children. Observe que esse ponto de extremidade era anteriormente conhecido como o ponto de extremidade 'Pesquisa de pasta'
    • Image: Devolve uma imagem do Panviva. Os dados de imagem são representados como uma cadeia de caracteres base64
  • Criar operações
    • Publish Artefact: Atualiza um artefato do Digital Orchestrator já publicado
    • Create Artefact Category: Cria uma categoria para classificar artefatos do Digital Orchestrator
    • Create Artefact: Cria um novo artefato do Digital Orchestrator

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
chave_de_api securestring O api_key para esta api Verdade

Limites de Limitação

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

Ações

Artefacto

Retorne um artefato do Digital Orchestrator usando a ID fornecida.
Container

Retorne um contêiner de documento usando a ID do contêiner fornecida.
Contentores de documentos

Recupera todos os contêineres (seções e subseções) em um documento especificado. Os contêineres representam a estrutura hierárquica do conteúdo dentro de um documento.
Criar artefato

Cria um novo artefato do Digital Orchestrator com conteúdo, metadados e informações de categoria. Os artefatos são peças de conteúdo reutilizáveis que podem ser entregues através de vários canais dentro do Panviva.
Criar categoria de artefato

Cria uma nova categoria para classificar artefatos do Digital Orchestrator. As categorias ajudam a organizar artefatos por tópico, departamento ou qualquer outro sistema de classificação relevante para sua organização.
CSH ao vivo

Apresenta uma página de resultados de pesquisa de ajuda sensível ao contexto (CSH) para um usuário especificado em seu cliente Panviva. Esta operação permite que você envie os resultados da pesquisa diretamente para a tela de um usuário.
Documento

Devolver um documento utilizando o ID do documento fornecido.
Documento ao vivo

Envia um documento específico ou seção de documento diretamente para o cliente Panviva de um usuário especificado. Isso permite que você exiba documentação relevante para os usuários em tempo real enquanto eles trabalham.
Eco

Ecoar uma solicitação para verificar a conectividade com a API Panviva. Este ponto de extremidade é útil para fins de teste e depuração.
Ficheiro

Recupera um documento externo (como um documento PDF, Word ou outro tipo de arquivo) que foi carregado no Panviva. O conteúdo do arquivo é retornado como uma cadeia de caracteres codificada em base64.
Folder

Recupera informações sobre uma pasta Panviva específica, incluindo seus metadados e links para seus filhos diretos. As pastas são usadas para organizar documentos e arquivos em uma estrutura hierárquica.
Imagem

Recupera uma imagem específica armazenada no Panviva. Os dados da imagem são retornados como uma cadeia de caracteres codificada em base64 que pode ser decodificada e exibida em aplicativos ou salva como um arquivo de imagem.
Live search

Apresente uma página de resultado de pesquisa da consulta passada no cliente Panviva para o usuário especificado no cliente Panviva em tempo real.
Obter Categoria de Artefato

Recupera uma lista de todas as categorias disponíveis para classificar artefatos do Digital Orchestrator. Essas categorias ajudam a organizar artefatos e podem ser usadas para filtragem e navegação.
Pasta Crianças

Recupera todos os filhos imediatos (conteúdo direto) de uma pasta Panviva específica. Isso inclui subpastas, documentos e arquivos (documentos externos) que estão diretamente contidos na pasta especificada, mas não inclui itens em subpastas aninhadas.
Pesquisa

Pesquisa documentos, pastas e arquivos (documentos externos) em busca de um termo e retorna resultados paginados.
Pesquisar Artefactos

Retorna os resultados da pesquisa do Digital Orchestrator para uma determinada linguagem natural ou consulta avançada. Este ponto de extremidade permite pesquisar artefatos usando vários métodos de consulta e opções de filtragem.
Publicar artefato

Atualiza um artefato existente do Digital Orchestrator com novo conteúdo, metadados ou informações de categoria. Esta operação é usada para modificar artefatos que já foram publicados.
Raiz da pasta

Recupera a pasta inicial de nível superior no Panviva, que serve como ponto de partida para navegar em toda a hierarquia de conteúdo. Esta pasta raiz contém links para seus filhos diretos, que podem ser acessados usando o ponto de extremidade Get Folder Children para percorrer a estrutura de pastas.
Relações de contêiner de documentos

Recupera a estrutura hierárquica de um documento retornando as relações pai-filho entre todos os contêineres (seções e subseções) dentro do documento. Isso ajuda a entender como o conteúdo é organizado.
Traduções de Documentos

Recupera todas as traduções disponíveis de um documento Panviva em diferentes idiomas e localidades. Isto ajuda a aceder a versões multilingues do mesmo conteúdo.
Traduções de Pastas

Recupera todas as traduções disponíveis de uma pasta Panviva específica em diferentes idiomas e localidades. Isso inclui metadados para cada versão traduzida da pasta e links para acessar seus respetivos filhos.

Artefacto

ID da Operação:
ResourcesArtefactById

Retorne um artefato do Digital Orchestrator usando a ID fornecida.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID do artefato
 id True string

Formato - uuid. O id (ID) do artefato Digital Orchestrator.

Devoluções

A resposta da API Panviva contendo dados de resposta enriquecidos.

Body
GetEnrichedResponseResponse

Container

ID da Operação:
ResourcesContainerById

Retorne um contêiner de documento usando a ID do contêiner fornecida.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID do contêiner
 id True string

A ID de um contêiner de documentos.

Devoluções

A resposta da API Panviva que contém dados de contêiner.

Body
GetContainerResponse

Contentores de documentos

ID da Operação:
ResourcesDocumentByIdContainers

Recupera todos os contêineres (seções e subseções) em um documento especificado. Os contêineres representam a estrutura hierárquica do conteúdo dentro de um documento.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID do documento
 id True integer

O ID interno (IID) do documento Panviva cujos contêineres você deseja recuperar.
Versão do documento
 version integer

A versão específica do documento cujos contêineres você deseja recuperar. Se omitido, os contêineres da versão mais recente serão devolvidos.

Devoluções

A resposta da API Panviva que contém dados de contêiner de documentos.

Body
GetDocumentContainersResponse

Criar artefato

ID da Operação:
ResourcesCreateArtefact

Cria um novo artefato do Digital Orchestrator com conteúdo, metadados e informações de categoria. Os artefatos são peças de conteúdo reutilizáveis que podem ser entregues através de vários canais dentro do Panviva.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
Guardar como rascunho
 isDraft boolean

Indica se o artefato deve ser salvo como um rascunho (true) ou publicá-lo imediatamente (false). Os artefatos de rascunho não são visíveis para os usuários finais até serem publicados.
title
 title string

O título do artefato a ser criado.
mediaType
 mediaType string

O tipo MIME do conteúdo nesta seção (por exemplo, texto/simples, imagem/jpeg).
enviar SMS
 text string

O conteúdo do texto desta secção, se aplicável.
origem
 source string

A referência de origem para este conteúdo se ele vem de material externo.
resourceLocation
 resourceLocation string

Indica se o recurso é armazenado interna ou externamente (valores: interno, externo, nulo).
mediaType
 mediaType string

O tipo de mídia do conteúdo (por exemplo, 'texto/html', 'texto/simples').
enviar SMS
 text string

O conteúdo do texto da seção.
HREF
 href string

Um hiperlink para conteúdo ou recursos adicionais.
resourceLocation
 resourceLocation string

O local do recurso, normalmente uma URL ou caminho de arquivo.
id
 id integer

O identificador exclusivo para o canal.
nome
 name string

O nome do canal para entrega de conteúdo.
id
 id integer

O identificador exclusivo da categoria a ser associada ao artefato.
primaryQuery
 primaryQuery string

O texto da consulta principal que este artefato foi projetado para responder.
consulta
 query string

O texto da consulta de pesquisa.
panvivaDocumentId
 panvivaDocumentId integer

A ID de um documento Panviva relacionado, se este artefato estiver vinculado a um.
panvivaDocumentVersion
 panvivaDocumentVersion integer

A versão do documento Panviva relacionado.
metadados
 metaData object

Devoluções

A resposta da API Panviva após a criação de um novo artefato.

Body
PostArtefactResponse

Criar categoria de artefato

ID da Operação:
ResourcesArtefactCategoryPost

Cria uma nova categoria para classificar artefatos do Digital Orchestrator. As categorias ajudam a organizar artefatos por tópico, departamento ou qualquer outro sistema de classificação relevante para sua organização.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
nome
 name string

O nome da categoria de artefato a ser criada.

Devoluções

A resposta da API Panviva após a criação de uma nova categoria de artefato.

Body
PostArtefactCategoryResponse

CSH ao vivo

ID da Operação:
OperationsLiveCsh

Apresenta uma página de resultados de pesquisa de ajuda sensível ao contexto (CSH) para um usuário especificado em seu cliente Panviva. Esta operação permite que você envie os resultados da pesquisa diretamente para a tela de um usuário.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
nome de utilizador
 username string

O usuário Panviva para quem você deseja enviar o resultado. (Nota: Use username OU userId, não ambos.)
userId
 userId string

O ID numérico do usuário para quem você deseja enviar o resultado. (Nota: Use username OU userId, não ambos.)
consulta
 query string

O termo CSH a procurar.
showFirstResult
 showFirstResult boolean

True para abrir imediatamente o primeiro documento encontrado, ou false para mostrar a lista de resultados.
maximizar o cliente
 maximizeClient boolean

Verdadeiro/Falso dependendo se você deseja que o cliente Panviva maximize na área de trabalho do usuário, quando o documento é entregue.

Devoluções

A resposta da API Panviva depois de enviar uma solicitação CSH ao vivo.

response
object

Documento

ID da Operação:
ResourcesDocumentById

Devolver um documento utilizando o ID do documento fornecido.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID do documento
 id True string

Um identificador exclusivo do documento, ID do documento. Se um documento for um documento traduzido, esse valor representará a ID interna ou IID na API Panviva v1.
Versão do documento
 version integer

Solicite que a API retorne uma versão específica do documento especificado.

Devoluções

A resposta da API Panviva que contém dados do documento.

Body
GetDocumentResponse

Documento ao vivo

ID da Operação:
OperationsLiveDocument

Envia um documento específico ou seção de documento diretamente para o cliente Panviva de um usuário especificado. Isso permite que você exiba documentação relevante para os usuários em tempo real enquanto eles trabalham.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
nome de utilizador
 username string

O usuário Panviva para quem você deseja enviar o resultado. (Nota: Use username OU userId, não ambos.)
userId
 userId string

O ID numérico do usuário para quem você deseja enviar o resultado. (Nota: Use username OU userId, não ambos.)
id
 id string

O ID do documento Panviva que você deseja enviar.
localização
 location string

O ID da Seção que você gostaria que o usuário visse. Nota: Use location OR containerId, não ambos.)
maximizar o cliente
 maximizeClient boolean

Verdadeiro/Falso dependendo se você deseja que o cliente Panviva maximize na área de trabalho do usuário, quando o documento é entregue.
ID do contêiner
 containerId string

A ID do contêiner que você deseja que o usuário veja quando o documento especificado for aberto. (Nota: Use location OR containerId, não ambos.)

Devoluções

A resposta da API Panviva após o envio de uma solicitação de documento ao vivo.

response
object

Eco

ID da Operação:
Echo

Ecoar uma solicitação para verificar a conectividade com a API Panviva. Este ponto de extremidade é útil para fins de teste e depuração.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.

Ficheiro

ID da Operação:
ResourcesFileById

Recupera um documento externo (como um documento PDF, Word ou outro tipo de arquivo) que foi carregado no Panviva. O conteúdo do arquivo é retornado como uma cadeia de caracteres codificada em base64.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID do ficheiro
 id True integer

O ID interno (IID) do arquivo Panviva (documento externo) para recuperar.

Devoluções

A resposta da API Panviva que contém dados de arquivo.

Body
GetFileResponse

Folder

ID da Operação:
ResourcesFolderById

Recupera informações sobre uma pasta Panviva específica, incluindo seus metadados e links para seus filhos diretos. As pastas são usadas para organizar documentos e arquivos em uma estrutura hierárquica.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID da pasta
 id True integer

O ID interno (IID) da pasta Panviva a ser recuperada.

Devoluções

A resposta da API Panviva que contém dados da pasta.

Body
GetFolderResponse

Imagem

ID da Operação:
ResourcesImageById

Recupera uma imagem específica armazenada no Panviva. Os dados da imagem são retornados como uma cadeia de caracteres codificada em base64 que pode ser decodificada e exibida em aplicativos ou salva como um arquivo de imagem.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID da imagem
 id True integer

O identificador exclusivo da imagem Panviva para recuperar.

Devoluções

A resposta da API Panviva contendo dados de imagem.

Body
GetImageResponse
ID da Operação:
OperationsLiveSearch

Apresente uma página de resultado de pesquisa da consulta passada no cliente Panviva para o usuário especificado no cliente Panviva em tempo real.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
nome de utilizador
 username string

O usuário Panviva para quem você deseja enviar o resultado. (Nota: Use username OU userId, não ambos.)
userId
 userId string

O ID numérico do usuário para quem você deseja enviar o resultado. (Nota: Use username OU userId, não ambos.)
consulta
 query string

O termo a procurar.
maximizar o cliente
 maximizeClient boolean

Verdadeiro/Falso dependendo se você deseja que o cliente Panviva maximize na área de trabalho do usuário, quando o documento é entregue.
showFirstResult
 showFirstResult boolean

True para abrir imediatamente o primeiro documento encontrado, ou false para mostrar a lista de resultados.

Devoluções

A resposta da API Panviva após o envio de uma solicitação de pesquisa ao vivo.

response
object

Obter Categoria de Artefato

ID da Operação:
ResourcesArtefactCategoriesGet

Recupera uma lista de todas as categorias disponíveis para classificar artefatos do Digital Orchestrator. Essas categorias ajudam a organizar artefatos e podem ser usadas para filtragem e navegação.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.

Devoluções

A resposta da API Panviva contendo dados de categoria de artefato.

Body
GetArtefactCategoriesResponse

Pasta Crianças

ID da Operação:
ResourcesFolderByIdChildren

Recupera todos os filhos imediatos (conteúdo direto) de uma pasta Panviva específica. Isso inclui subpastas, documentos e arquivos (documentos externos) que estão diretamente contidos na pasta especificada, mas não inclui itens em subpastas aninhadas.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID da pasta
 id True integer

O ID interno (IID) da pasta Panviva cujo conteúdo você deseja recuperar.

Devoluções

A resposta da API Panviva que contém dados filhos da pasta.

Body
GetFolderChildrenResponse

Pesquisa

ID da Operação:
OperationsSearch

Pesquisa documentos, pastas e arquivos (documentos externos) em busca de um termo e retorna resultados paginados.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
Termo de Pesquisa
 term True string

A palavra ou frase a ser pesquisada. Suporta palavras-chave simples, sintaxe Lucene e padrões regex.
Deslocamento de página
 pageOffset integer

O deslocamento de paginação para indicar o número de resultados iniciais da pesquisa a serem ignorados.
Limite de páginas
 pageLimit integer

O número de registos a devolver. Deve ser um número inteiro entre 0 e 1000.
Alterado quando
 changedWhen string

Palavras-chave auxiliares para aplicar filtros para documentos atualizados no intervalo.
ID da Pasta Pai Direta
 directParentFolderId integer

Pesquise apenas dentro de uma determinada Pasta. Os documentos nas subpastas não são pesquisados. Se não forem fornecidos, os recursos serão pesquisados em todas as pastas.

Devoluções

Name Caminho Tipo Description
results
 results array of object

A lista de recursos que correspondem aos critérios de pesquisa.
tipo
 results.type string

O tipo de recurso retornado (por exemplo, 'documento', 'pasta' ou 'arquivo').
id
 results.id string

O identificador exclusivo do recurso que pode ser usado para recuperar seus detalhes.
nome
 results.name string

O título ou nome de exibição do recurso.
esquema
 results.layout string

O modelo de layout de página usado para o recurso (por exemplo, 'topTabsMedium', 'leftTabsMedium').
descrição
 results.description string

Um breve resumo ou descrição do conteúdo do recurso.
classificação
 results.classification string

A categoria ou classificação do recurso (por exemplo, «filmes», «livros»).
atualizadoData de atualização
 results.updatedDate string

A data em que o recurso foi atualizado pela última vez, no formato ISO 8601 (AAAA-MM-DD).
matchedFields
 results.matchedFields array of string

A lista de campos em que o termo de pesquisa foi encontrado (por exemplo, 'nome', 'conteúdo').
fragmento
 results.snippet string

Um pequeno excerto do conteúdo que mostra o termo de pesquisa em contexto, muitas vezes com destaque.
linguagem
 results.language string

O código do idioma do recurso (por exemplo, 'en-AU' para o inglês australiano).
links
 results.links array of object

Hipermídia links relacionados a este resultado de pesquisa que podem ser usados para operações adicionais.
HREF
 results.links.href string

A URL para acessar o recurso relacionado ou executar uma operação.
rel
 results.links.rel string

O tipo de relação do link para o recurso atual (por exemplo, 'documento', 'arquivo').
tipo
 results.links.type string

O método HTTP a ser usado ao acessar este link (normalmente 'GET').
total
 total integer

O número total de resultados que correspondem aos critérios de pesquisa em todas as páginas.
links
 links array of object

Links de paginação que permitem a navegação entre páginas de resultados de pesquisa.
HREF
 links.href string

O URL para aceder a uma página específica de resultados de pesquisa.
rel
 links.rel string

A relação deste link com a página atual (por exemplo, 'primeiro', 'último', 'próximo', 'prev').
tipo
 links.type string

O método HTTP a ser usado ao acessar este link (normalmente 'GET').

Pesquisar Artefactos

ID da Operação:
OperationsArtefactNls

Retorna os resultados da pesquisa do Digital Orchestrator para uma determinada linguagem natural ou consulta avançada. Este ponto de extremidade permite pesquisar artefatos usando vários métodos de consulta e opções de filtragem.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
Consulta simples
 simplequery string

Cadeia de caracteres de consulta em linguagem natural. Por exemplo: "Que filme de ação é protagonizado por Peter Parker?". (Nota: Use simplequery OU advancedquery, não ambos.)
Consulta avançada
 advancedquery string

Seqüência de caracteres de consulta escrita na sintaxe de consulta Lucene. Por exemplo: 'filmes E 'uma história''. (Nota: Use simplequery OU advancedquery, não ambos.)
Filter
 filter string

Aceita uma cadeia de caracteres de filtro escrita na sintaxe de expressão OData. Exemplos: category/name eq 'Mortgages', panvivaDocumentVersion gt '8'. (Os campos filtráveis incluem dateCreated, dateModified, dateDeleted, category/name, category/dateCreated, category/dateModified, metaData/keyword/values, metaData/keyword/dataType, title, 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 indicar o número de resultados iniciais da pesquisa a serem ignorados.
Limite de páginas
 pageLimit integer

O número de registos a devolver. Deve ser um número inteiro entre 0 e 1000.
Faceta String
 facet string

Aceita uma cadeia de caracteres que denota o campo pelo qual a faceta. Exemplos: facet=metaData/keyword/values, facet=category/name. (Os campos da tabela facial incluem metaData/palavra-chave/valores, categoria/id, categoria/nome e panvivaDocumentId)
Realçar Tags
 highlightTags string

Aceita realçar tags pré e post no modelo [start-tag,end-tag]. Exemplo : <em>,</em>. (Nota: A tag de realce padrão é *,*)

Devoluções

A resposta da API Panviva contendo dados de artefato de pesquisa enriquecidos.

Body
GetEnrichedSearchArtefactResponse

Publicar artefato

ID da Operação:
PublishArtefact

Atualiza um artefato existente do Digital Orchestrator com novo conteúdo, metadados ou informações de categoria. Esta operação é usada para modificar artefatos que já foram publicados.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID do artefato
 id True string

O identificador exclusivo (formato UUID) do artefato a ser atualizado.
id
 id uuid

O identificador único do artefacto a atualizar.
primaryResponse
 primaryResponse string

O conteúdo de resposta principal para o artefato.
panvivaDocumentVersion
 panvivaDocumentVersion integer

O número da versão do documento Panviva associado a este artefacto.
mediaType
 mediaType string

O tipo MIME do conteúdo nesta seção (por exemplo, texto/simples, imagem/jpeg).
enviar SMS
 text string

O conteúdo do texto desta secção, se aplicável.
origem
 source string

A referência de origem para este conteúdo se ele vem de material externo.
resourceLocation
 resourceLocation string

Indica se o recurso é armazenado interna ou externamente (valores: interno, externo, nulo).
sectionId
 sectionId string

O identificador exclusivo da seção marcada.
hash
 hash string

Um valor de hash que representa o conteúdo da seção marcada.
id
 id integer

O identificador exclusivo da categoria a ser associada ao artefato.
panvivaDocumentId
 panvivaDocumentId string

A ID do documento Panviva associado a este artefato.
title
 title string

O título do artefato.
primaryQuery
 primaryQuery string

O texto da consulta principal que este artefato foi projetado para responder.
id
 id integer
consulta
 query string

O texto da consulta de pesquisa.
metadados
 metaData object
id
 id integer

O identificador exclusivo da variação.
id
 id integer

O identificador exclusivo para o canal.
nome
 name string

O nome do canal para entrega de conteúdo.
conteúdo
 content string

O conteúdo da variação, normalmente em formato HTML.

Devoluções

A resposta da API Panviva após a atualização de um artefato.

Body
PutArtefactResponse

Raiz da pasta

ID da Operação:
ResourcesFolderRoot

Recupera a pasta inicial de nível superior no Panviva, que serve como ponto de partida para navegar em toda a hierarquia de conteúdo. Esta pasta raiz contém links para seus filhos diretos, que podem ser acessados usando o ponto de extremidade Get Folder Children para percorrer a estrutura de pastas.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.

Devoluções

A resposta da API Panviva contendo dados da pasta raiz.

Body
GetFolderRootResponse

Relações de contêiner de documentos

ID da Operação:
ResourcesDocumentContainersByIdRelationships

Recupera a estrutura hierárquica de um documento retornando as relações pai-filho entre todos os contêineres (seções e subseções) dentro do documento. Isso ajuda a entender como o conteúdo é organizado.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID do documento
 id True integer

O ID interno (IID) do documento Panviva cuja estrutura você deseja recuperar.

Devoluções

A resposta da API Panviva que contém relações de contêiner de documentos.

Body
GetDocumentContainerRelationshipsResponse

Traduções de Documentos

ID da Operação:
ResourcesDocumentByIdTranslations

Recupera todas as traduções disponíveis de um documento Panviva em diferentes idiomas e localidades. Isto ajuda a aceder a versões multilingues do mesmo conteúdo.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID do documento
 id True integer

A ID interna (IID) do documento Panviva original para o qual você deseja recuperar traduções.

Devoluções

A resposta da API Panviva contendo dados de tradução de documentos.

Body
GetDocumentTranslationsResponse

Traduções de Pastas

ID da Operação:
ResourcesFolderByIdTranslations

Recupera todas as traduções disponíveis de uma pasta Panviva específica em diferentes idiomas e localidades. Isso inclui metadados para cada versão traduzida da pasta e links para acessar seus respetivos filhos.

Parâmetros

Name Chave Necessário Tipo Description
Nome da instância
 instance True string

O nome da instância conforme mostrado no Panviva Developer Portal.
ID da pasta
 id True integer

O ID interno (IID) da pasta Panviva original para a qual você deseja recuperar traduções.

Devoluções

A resposta da API Panviva contendo dados de tradução de pastas.

Body
GetFolderTranslationsResponse

Definições

ArtefatoCategoria

Uma categoria no sistema Panviva, usada para classificar artefatos.

Name Caminho Tipo Description
id
 id integer

O identificador exclusivo para a categoria de artefato atribuída pelo sistema.
categoryName
 categoryName string

O nome de exibição da categoria usada para classificar artefatos.

Categoria

Uma categoria no sistema Panviva, usada para classificar artefatos.

Name Caminho Tipo Description
id
 id integer

O identificador exclusivo da categoria.
dateCriado
 dateCreated date-time

A data e a hora em que a categoria foi criada.
dateModificado
 dateModified date-time

A data e a hora em que a categoria foi modificada pela última vez.
nome
 name string

O nome para exibição da categoria.

Channel

Uma lista de canais através dos quais esta variação pode ser entregue.

Name Caminho Tipo Description
id
 id integer

O identificador exclusivo para o canal.
nome
 name string

O nome do canal para entrega de conteúdo.

Container

Um contêiner no sistema Panviva, que pode conter conteúdo, metadados e links para outros recursos.

Name Caminho Tipo Description
id
 id string

O identificador exclusivo para o contêiner, normalmente no formato 'document-version-section-subsection'.
nome
 name string

O nome para exibição ou o título do contêiner.
body
 body string

O conteúdo HTML do contêiner, representando o conteúdo real a ser exibido.

ContainerRelationship

Uma relação entre contêineres, indicando a hierarquia e estrutura de conteúdo dentro do Panviva.

Name Caminho Tipo Description
id
 id string

O identificador exclusivo do contêiner nessa relação.
elemento principal
 parent string

O identificador do contêiner pai, ou null se este for um contêiner de nível superior.
Crianças
 children array of string
fluxo de tarefas
 taskFlow string

O identificador de fluxo de tarefas associado a essa relação de contêiner, se aplicável.

Documento

Um documento no sistema Panviva, que pode conter conteúdo, metadados e links para outros recursos.

Name Caminho Tipo Description
id
 id string

O identificador exclusivo do documento.
nome
 name string

O título ou nome do documento.
descrição
 description string

Um breve resumo descrevendo o conteúdo do documento.
versão
 version integer

O número da versão do documento.
linguagem
 language string

O código do idioma do documento (por exemplo, en-AU para o inglês australiano).
tags
 tags array of Tag
oculto
 hidden boolean

Indica se o documento está oculto dos modos de exibição padrão.
origem
 source string

A origem ou origem do documento.
tipo
 type string

O tipo de recurso (sempre 'documento' para objetos Document).
disponibilizar
 release integer

O número de lançamento do documento.
Lançamento
 released boolean

Indica se o documento foi divulgado/publicado.
Copyright
 copyright string

Informações sobre direitos autorais para o documento.
classificação
 classification string

A categoria de classificação do documento (por exemplo, «filmes»).
estado
 status string

O estado atual do documento (por exemplo, «Terceira fase»).
percentagem
 percentage integer

A porcentagem de conclusão do documento, normalmente 100 para documentos totalmente concluídos.
Data de lançamento
 releaseDate date-time

A data e a hora em que o documento foi divulgado.
esquema
 layout string

O modelo de layout de página usado para o documento (por exemplo, 'leftTabsMedium').
preparação
 training Training

Configurações e informações relacionadas ao treinamento para este documento.
Palavras Chave
 keywords array of string

Palavras-chave associadas ao documento para pesquisa padrão.
cshPalavras-chave
 cshKeywords array of string

Palavras-chave associadas ao documento para ajuda sensível ao contexto (CSH).
atualizadoData de atualização
 updatedDate date-time

A data e a hora em que o documento foi atualizado pela última vez.
createdDate (Data de criação)
 createdDate date-time

A data e a hora em que o documento foi criado.
Conteúdo reutilizável
 reusableContent boolean

Indica se o documento contém blocos de conteúdo reutilizáveis.
alterarNota:
 changeNote string

Notas descrevendo as alterações feitas na versão mais recente.
links
 links array of Link

EnrichedResponseVariation

Uma variação do artefato que pode ser entregue através de diferentes canais.

Name Caminho Tipo Description
id
 id integer

O identificador exclusivo da variação.
dateCriado
 dateCreated date-time

A data e a hora em que a variação foi criada.
dateModificado
 dateModified date-time

A data e a hora em que a variação foi modificada pela última vez.
conteúdo
 content array of ResponseSection
simpleContent
 simpleContent string

Uma versão simplificada do conteúdo, normalmente texto simples.
channels
 channels array of Channel

EnrichedSearchResult

Um resultado de pesquisa enriquecido retornado da API Panviva, contendo informações detalhadas sobre o artefato.

Name Caminho Tipo Description
id
 id uuid

O identificador exclusivo do resultado da pesquisa enriquecida.
conteúdo
 content array of ResponseSection
simpleContent
 simpleContent string

Uma versão simplificada do conteúdo, normalmente texto simples.
categoria
 category Category

Uma categoria no sistema Panviva, usada para classificar artefatos.
metadados
 metaData object
pesquisaPontuação
 searchScore number

A pontuação de relevância do resultado da pesquisa, indicando quão bem ele corresponde à consulta de pesquisa.
links
 links array of Link
queryVariações
 queryVariations array of QueryVariation
primaryQuery
 primaryQuery string

A consulta de pesquisa primária que foi usada para recuperar esse resultado.
panvivaDocumentId
 panvivaDocumentId integer

O identificador único do documento Panviva associado a este resultado.
panvivaDocumentVersion
 panvivaDocumentVersion integer

O número da versão do documento Panviva associado a este resultado.
title
 title string

O título do resultado da pesquisa enriquecida.
Destaques
 highlights Highlights

Destaques do resultado da pesquisa, normalmente usados para indicar termos ou frases correspondentes.

Faceta

Uma faceta usada para filtrar resultados de pesquisa com base em critérios específicos.

Name Caminho Tipo Description
campo
 field string

O nome do campo usado para faceting.
groups
 groups array of StringInt64NullableKeyValuePair

Folder

Uma pasta no sistema Panviva, usada para organizar documentos e artefatos.

Name Caminho Tipo Description
id
 id string

O identificador exclusivo da pasta.
nome
 name string

O nome para exibição da pasta.
descrição
 description string

Um breve resumo descrevendo o conteúdo da pasta.
versão
 version integer

O número da versão da pasta.
linguagem
 language string

O código de idioma para a pasta (por exemplo, en-AU para inglês australiano).
tags
 tags array of Tag
oculto
 hidden boolean

Indica se a pasta está oculta dos modos de exibição de pesquisa.
origem
 source string

A origem ou origem da pasta.
tipo
 type string

O tipo de recurso (sempre 'pasta' para objetos Folder).
links
 links array of Link

GetArtefactCategoriesResponse

A resposta da API Panviva contendo dados de categoria de artefato.

Name Caminho Tipo Description
categories
 categories array of ArtefactCategory

GetContainerResponse

A resposta da API Panviva que contém dados de contêiner.

Name Caminho Tipo Description
id
 id string

O identificador exclusivo do contêiner.
nome
 name string

O nome para exibição do contêiner.
body
 body string

O conteúdo HTML do contêiner.

GetDocumentContainerRelationshipsResponse

A resposta da API Panviva que contém relações de contêiner de documentos.

Name Caminho Tipo Description
Relacionamentos
 relationships array of ContainerRelationship

GetDocumentContainersResponse

A resposta da API Panviva que contém dados de contêiner de documentos.

Name Caminho Tipo Description
containers
 containers array of Container

GetDocumentResponse

A resposta da API Panviva que contém dados do documento.

Name Caminho Tipo Description
id
 id string

O identificador exclusivo do documento.
nome
 name string

O título ou nome do documento.
descrição
 description string

Um breve resumo descrevendo o conteúdo do documento.
versão
 version integer

O número da versão do documento.
linguagem
 language string

O código do idioma do documento (por exemplo, en-AU para o inglês australiano).
tags
 tags array of Tag
oculto
 hidden boolean

Indica se o documento está oculto da pesquisa.
origem
 source string

A origem ou origem do documento.
tipo
 type string

O tipo de recurso (sempre 'documento' para objetos Document).
disponibilizar
 release integer

O número de lançamento do documento.
Lançamento
 released boolean

Indica se o documento foi divulgado/publicado.
Copyright
 copyright string

Informações sobre direitos autorais para o documento.
classificação
 classification string

A categoria de classificação do documento (por exemplo, «filmes»).
estado
 status string

O estado atual do documento (por exemplo, «Terceira fase»).
percentagem
 percentage integer
Data de lançamento
 releaseDate date-time

A data e a hora em que o documento foi divulgado.
esquema
 layout string

O modelo de layout de página usado para o documento (por exemplo, 'leftTabsMedium').
preparação
 training Training

Configurações e informações relacionadas ao treinamento para este documento.
Palavras Chave
 keywords array of string
cshPalavras-chave
 cshKeywords array of string
atualizadoData de atualização
 updatedDate date-time

A data e a hora em que o documento foi atualizado pela última vez.
createdDate (Data de criação)
 createdDate date-time

A data e a hora em que o documento foi criado.
Conteúdo reutilizável
 reusableContent boolean

Indica se o documento contém blocos de conteúdo reutilizáveis.
alterarNota:
 changeNote string

Notas descrevendo as alterações feitas na versão mais recente.
links
 links array of Link

GetDocumentTranslationsResponse

A resposta da API Panviva contendo dados de tradução de documentos.

Name Caminho Tipo Description
traduções
 translations array of Document
origin
 origin string

A origem da tradução, normalmente o ID do documento original.

GetEnrichedResponseResponse

A resposta da API Panviva contendo dados de resposta enriquecidos.

Name Caminho Tipo Description
links
 links array of Link
title
 title string

O título da resposta enriquecida.
conteúdo
 content array of ResponseSection
simpleContent
 simpleContent string

Uma versão simplificada do conteúdo, normalmente texto simples.
Variações
 variations array of EnrichedResponseVariation
categoria
 category Category

Uma categoria no sistema Panviva, usada para classificar artefatos.
primaryQuery
 primaryQuery string

A consulta de pesquisa principal que foi usada para recuperar essa resposta.
queryVariações
 queryVariations array of QueryVariation
panvivaDocumentId
 panvivaDocumentId integer

O identificador único do documento Panviva associado a esta resposta.
panvivaDocumentVersion
 panvivaDocumentVersion integer

O número da versão do documento Panviva associado a esta resposta.
metadados
 metaData object
id
 id uuid

O identificador exclusivo da resposta enriquecida.
dateCriado
 dateCreated date-time

A data e a hora em que a resposta enriquecida foi criada.
dateModificado
 dateModified date-time

A data e a hora em que a resposta enriquecida foi modificada pela última vez.

GetEnrichedSearchArtefactResponse

A resposta da API Panviva contendo dados de artefato de pesquisa enriquecidos.

Name Caminho Tipo Description
Facetas
 facets array of Facet
results
 results array of EnrichedSearchResult
total
 total integer

O número total de resultados de pesquisa encontrados.

GetFileResponse

A resposta da API Panviva que contém dados de arquivo.

Name 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
origem
 source string
tipo
 type string
conteúdo
 content string
fileName
 fileName string
disponibilizar
 release integer
Lançamento
 released boolean
Copyright
 copyright string
classificação
 classification string
estado
 status string
percentagem
 percentage integer
Data de lançamento
 releaseDate date-time
Palavras Chave
 keywords array of string
cshPalavras-chave
 cshKeywords array of string
alterarNota:
 changeNote string
atualizadoData de atualização
 updatedDate date-time
createdDate (Data de criação)
 createdDate date-time

GetFolderChildrenResponse

A resposta da API Panviva que contém dados filhos da pasta.

Name Caminho Tipo Description
Crianças
 children array of Resource

GetFolderResponse

A resposta da API Panviva que contém dados da pasta.

Name Caminho Tipo Description
id
 id string

O identificador exclusivo da pasta.
nome
 name string

O nome para exibição da pasta.
descrição
 description string

Um breve resumo descrevendo o conteúdo da pasta.
versão
 version integer

O número da versão da pasta.
linguagem
 language string

O código de idioma para a pasta (por exemplo, en-AU para inglês australiano).
tags
 tags array of Tag
oculto
 hidden boolean

Indica se a pasta está oculta dos modos de exibição de pesquisa.
origem
 source string

A origem ou origem da pasta.
tipo
 type string

O tipo de recurso (sempre 'pasta' para objetos Folder).
links
 links array of Link

GetFolderRootResponse

A resposta da API Panviva contendo dados da pasta raiz.

Name Caminho Tipo Description
id
 id string

O identificador exclusivo para a pasta raiz.
nome
 name string

O nome para exibição da pasta raiz.
descrição
 description string

Um breve resumo descrevendo o conteúdo da pasta raiz.
versão
 version integer

O número da versão da pasta raiz.
linguagem
 language string

O código de idioma para a pasta raiz (por exemplo, en-AU para inglês australiano).
tags
 tags array of Tag
oculto
 hidden boolean

Indica se a pasta raiz está oculta das exibições de pesquisa.
origem
 source string

A origem ou origem da pasta raiz.
tipo
 type string

O tipo de recurso (sempre 'pasta' para objetos Folder).
links
 links array of Link

GetFolderTranslationsResponse

A resposta da API Panviva contendo dados de tradução de pastas.

Name Caminho Tipo Description
traduções
 translations array of Folder

GetImageResponse

A resposta da API Panviva contendo dados de imagem.

Name Caminho Tipo Description
id
 id string

O identificador exclusivo da imagem.
nome
 name string

O título ou nome da imagem.
Largura
 width integer

A largura da imagem em pixels.
altura
 height integer

A altura da imagem em pixels.
size
 size integer

O tamanho do arquivo de imagem em bytes.
TipoDeConteúdo
 contentType string

O tipo MIME da imagem (por exemplo, image/jpeg, image/png).
conteúdo
 content string

O conteúdo codificado em base64 da imagem.

Destaques

Destaques do resultado da pesquisa, normalmente usados para indicar termos ou frases correspondentes.

Name Caminho Tipo Description
primaryQuery
 primaryQuery string

A consulta de pesquisa primária que foi usada para recuperar esse resultado.
title
 title string

O título do resultado da pesquisa enriquecida.

Links de hipermídia relacionados a este recurso.

Name Caminho Tipo Description
HREF
 href string

A URL para acessar o recurso relacionado ou executar uma operação.
rel
 rel string

O tipo de relação do link para o recurso atual (por exemplo, 'documento', 'arquivo').
tipo
 type string

O método HTTP a ser usado ao acessar este link (normalmente 'GET').

PostArtefactCategoryResponse

A resposta da API Panviva após a criação de uma nova categoria de artefato.

Name Caminho Tipo Description
categoryId
 categoryId integer

O identificador exclusivo da categoria de artefato recém-criada.
categoryName
 categoryName string

O nome de exibição da categoria de artefato recém-criada.

PostArtefactResponse

A resposta da API Panviva após a criação de um novo artefato.

Name Caminho Tipo Description
hasErrors
 hasErrors boolean

Indica se ocorreram erros durante a criação do artefato.
erros
 errors array of string
responseId
 responseId uuid

O identificador exclusivo do artefato recém-criado.

PutArtefactResponse

A resposta da API Panviva após a atualização de um artefato.

Name Caminho Tipo Description
hasErrors
 hasErrors boolean

Indica se ocorreram erros durante a atualização do artefato.
erros
 errors array of string
estado
 status string

O status da operação de atualização de artefato.

QueryVariation

Frases alternativas de consultas que devem corresponder a esse artefato.

Name Caminho Tipo Description
id
 id integer
consulta
 query string

O texto da consulta de pesquisa.

Resource

Um recurso que pode ser um documento, pasta ou outros tipos de conteúdo.

Name Caminho Tipo Description
id
 id string

O identificador exclusivo do recurso.
nome
 name string

O nome para exibição do recurso.
descrição
 description string

Um breve resumo descrevendo o conteúdo do recurso.
versão
 version integer

O número da versão do recurso.
linguagem
 language string

O código de idioma para o recurso (por exemplo, en-AU para inglês australiano).
tags
 tags array of Tag
oculto
 hidden boolean

Indica se o recurso está oculto das exibições padrão.
origem
 source string

A origem ou origem do recurso.
tipo
 type string

O tipo de recurso (por exemplo, 'documento', 'pasta').

RespostaSecção

As seções de conteúdo da resposta.

Name Caminho Tipo Description
mediaType
 mediaType string

O tipo de mídia do conteúdo (por exemplo, 'texto/html', 'texto/simples').
enviar SMS
 text string

O conteúdo do texto da seção.
HREF
 href string

Um hiperlink para conteúdo ou recursos adicionais.
resourceLocation
 resourceLocation string

O local do recurso, normalmente uma URL ou caminho de arquivo.

StringInt64NullableKeyValuePair

Um par chave-valor onde a chave é uma cadeia de caracteres e o valor é um inteiro.

Name Caminho Tipo Description
chave
 key string

O nome do grupo de facetas.
valor
 value integer

A contagem de itens neste grupo de facetas.

Tag

Uma tag de metadados associada ao recurso.

Name Caminho Tipo Description
nome
 name string

O nome ou a chave da tag.
valor
 value string

O valor associado à tag .

Formação

Configurações e informações relacionadas ao treinamento para este documento.

Name Caminho Tipo Description
failureFeedback
 failureFeedback string

A mensagem de feedback exibida quando um usuário falha no treinamento para este documento.
forcePageSequence
 forcePageSequence boolean

Se verdadeiro, os usuários devem visualizar as páginas em sequência durante o treinamento.
forceQuestionSequence
 forceQuestionSequence boolean

Se verdadeiro, os usuários devem responder às perguntas em sequência durante o treinamento.
passingScore
 passingScore integer

A pontuação mínima exigida para passar.
sucessoFeedback
 successFeedback string

A mensagem de feedback exibida quando um usuário passa no treinamento para este documento.

objecto

Este é o tipo 'objeto'.