Панвива

Panviva — это решение для управления знаниями omnichannel. Наш приоритет заключается в том, чтобы помочь нашим клиентам поддерживать своих сотрудников счастливыми, чтобы они могли сосредоточиться на обеспечении того, чтобы их клиенты были счастливы. Цифровые преобразования организаций за последние 20 лет, мы теперь помогаем нашим клиентам предоставлять знания nuggets своим сотрудникам и клиентам, независимо от того, находятся ли они в доме или офисе - в любое время и в любом месте.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Группа поддержки клиентов Panviva
URL https://www.panviva.com/support
Адрес электронной почты support@panviva.com
Метаданные соединителя
Publisher Панвива
Веб-сайт https://www.panviva.com
Политика конфиденциальности https://www.panviva.com/privacy-policy
Категории Управление бизнесом; Продуктивность

Предпосылки

Чтобы использовать соединитель Panviva, необходимо:

  1. Доступ к экземпляру Panviva (также известному как клиент)
  2. Учетная запись разработчика на портале разработчика Panviva (dev.panviva.com)
  3. Активная подписка API Panviva (также известная как план API) и допустимые учетные данные API Panviva

Если вы не являетесь клиентом или вам нужна помощь www.panviva.com/support.

Получение учетных данных

Выполните приведенные ниже действия, чтобы получить экземпляр ключа API и API.

Если при использовании соединителя возникает ошибка, вы можете найти код ошибки для получения дополнительных сведений. Примечание. Код состояния HTTP в документации может немного отличаться от того, что вы видите в Power Automate или Power Apps, используйте поле "Код ошибки" для поиска.

Чтобы получить ключ API, необходимо:

  1. Войдите на портал разработчика Panviva на dev.panviva.com
  2. Перейдите к своему профилю (щелкните свое имя и щелкните "Профиль" на верхней панели навигации)
  3. Теперь вы увидите ключ API в разделе "Ваши подписки" профиля.

Чтобы получить экземпляр API, необходимо:

  1. Войдите на портал разработчика Panviva на dev.panviva.com
  2. Перейдите к API (щелкните "API" в верхней панели навигации)
  3. Теперь вы увидите экземпляр API в наборе API (найдите "Имя экземпляра для набора API")

Ограничения пропускной способности

Обратите внимание, что ограничения регулирования будут зависеть от типа подписки API (или плана API), на который вы подписаны.

Чтобы найти квоту или ограничение скорости, можно:

  1. Войдите на портал разработчика Panviva на dev.panviva.com
  2. Перейдите к своему профилю (щелкните свое имя и щелкните "Профиль" на верхней панели навигации)
  3. Перейдите к плану API в разделе "Ваши подписки" профиля
  4. Теперь вы увидите сведения о плане (найдите "... будет иметь возможность выполнять ** вызовы/минуту до максимума звонков _** в месяц...)

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ подписки API Panviva securestring Ключ подписки API Panviva для вашего экземпляра. True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Folder

Возврат сведений о папке Panviva и ссылках на каждый из его прямых дочерних элементов

Live CSH

Представление страницы результатов поиска CSH для передаваемого запроса клиента Panviva указанному пользователю в клиенте Panviva

Артефакт

Возврат артефакта с помощью предоставленного идентификатора

Динамический документ

Представление страницы документа указанному пользователю в клиенте Panviva

Документ

Возврат документа с помощью предоставленного идентификатора документа

Дочерние папки

Получает всех непосредственных детей папки Panviva, не включая внуков. Дочерние элементы могут быть папками, документами или файлами (внешними документами)

Живой поиск

Представление страницы результатов поиска передаваемого запроса на клиент Panviva указанному пользователю в клиенте Panviva

Изображение

Возвращает изображение из Panviva. Данные изображения представлены в виде строки base64

Искать

Выполняет поиск документов, папок и файлов (внешних документов) для термина и возвращает результаты с разбивкой на страницы.

Контейнер

Возврат контейнера с помощью предоставленного идентификатора контейнера

Контейнеры документов

Возврат списка контейнеров с помощью предоставленного идентификатора документа

Корневой каталог папки

Возвращает корневую или домашнюю папку во всей Panviva, которую можно детализировать с помощью конечной точки Get Folder Children. Обратите внимание, что ранее эта конечная точка называлась конечной точкой "Поиск папок"

Переводы документов

Возвращает список всех переводов (на язык и языковой стандарт) документа Panviva

Переводы папок

Возвращает все переводы папки Panviva, а также все переведенные папки, соответствующие дочерним элементам

Поиск артефактов

Возврат результатов поиска для заданного запроса

Получение категорий артефактов

Возвращает список всех доступных категорий артефактов

Связи контейнеров документов

Возвращает список отношений "родительский-дочерний" между каждым контейнером для предоставленного идентификатора документа

Создание категории артефактов

Создает категорию для классификации артефактов

Файл

Возвращает файл (внешний документ) из Panviva

Folder

Возврат сведений о папке Panviva и ссылках на каждый из его прямых дочерних элементов

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Идентификатор
id True integer

Внутренний идентификатор (IID) папки Panviva

Возвращаемое значение

Live CSH

Представление страницы результатов поиска CSH для передаваемого запроса клиента Panviva указанному пользователю в клиенте Panviva

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

username
username string

Пользователь Panviva, которому вы хотите отправить результат. (Примечание. Используйте имя пользователя OR userId, а не оба.)

userId
userId string

Числовой идентификатор пользователя, которому нужно отправить результат. (Примечание. Используйте имя пользователя OR userId, а не оба.)

query
query string

Термин CSH для поиска.

showFirstResult
showFirstResult boolean

Значение true, чтобы сразу открыть первый найденный документ или значение false, чтобы отобразить список результатов.

maximizeClient
maximizeClient boolean

Значение True/False в зависимости от того, хотите ли клиент Panviva развернуть на рабочем столе пользователя при доставке документа.

Возвращаемое значение

response
object

Артефакт

Возврат артефакта с помощью предоставленного идентификатора

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Идентификатор
id True string

Формат — uuid. Идентификатор артефакта

Возвращаемое значение

Динамический документ

Представление страницы документа указанному пользователю в клиенте Panviva

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

username
username string

Пользователь Panviva, которому вы хотите отправить результат. (Примечание. Используйте имя пользователя OR userId, а не оба.)

userId
userId string

Числовой идентификатор пользователя, которому нужно отправить результат. (Примечание. Используйте имя пользователя OR userId, а не оба.)

id
id string

Идентификатор документа Panviva, который вы хотите отправить.

location
location string

Идентификатор раздела, который вы хотите увидеть, когда откроется указанный документ.

maximizeClient
maximizeClient boolean

Значение True/False в зависимости от того, хотите ли клиент Panviva развернуть на рабочем столе пользователя при доставке документа.

Возвращаемое значение

response
object

Документ

Возврат документа с помощью предоставленного идентификатора документа

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Идентификатор
id True string

Уникальный идентификатор документа, идентификатор документа. Если документ является переведенным документом, это значение представляет внутренний идентификатор или IID в API Panviva версии 1.

Версия
version integer

Попросите API вернуть определенную версию указанного документа.

Возвращаемое значение

Дочерние папки

Получает всех непосредственных детей папки Panviva, не включая внуков. Дочерние элементы могут быть папками, документами или файлами (внешними документами)

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Идентификатор
id True integer

Внутренний идентификатор (IID) папки Panviva

Возвращаемое значение

Живой поиск

Представление страницы результатов поиска передаваемого запроса на клиент Panviva указанному пользователю в клиенте Panviva

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

username
username string

Пользователь Panviva, которому вы хотите отправить результат. (Примечание. Используйте имя пользователя OR userId, а не оба.)

userId
userId string

Числовой идентификатор пользователя, которому нужно отправить результат. (Примечание. Используйте имя пользователя OR userId, а не оба.)

query
query string

Термин для поиска.

maximizeClient
maximizeClient boolean

Значение True/False в зависимости от того, хотите ли клиент Panviva развернуть на рабочем столе пользователя при доставке документа.

showFirstResult
showFirstResult boolean

Значение true, чтобы сразу открыть первый найденный документ или значение false, чтобы отобразить список результатов.

Возвращаемое значение

response
object

Изображение

Возвращает изображение из Panviva. Данные изображения представлены в виде строки base64

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Идентификатор
id True integer

Идентификатор изображения Panviva

Возвращаемое значение

Тело
GetImageResponse

Искать

Выполняет поиск документов, папок и файлов (внешних документов) для термина и возвращает результаты с разбивкой на страницы.

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Срок
term True string

Слово или фраза для поиска

Смещение страницы
pageOffset integer

Смещение разбиения на страницы, обозначающего количество пропустить начальных результатов поиска. Например, pageOffset из 100 и pageLimit из 10 возвращает записи 101-110.

Ограничение страницы
pageLimit integer

Количество возвращаемых записей. Должно быть целым числом от 0 до 1000.

Возвращаемое значение

Контейнер

Возврат контейнера с помощью предоставленного идентификатора контейнера

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Идентификатор
id True string

Идентификатор контейнера документов

Возвращаемое значение

Контейнеры документов

Возврат списка контейнеров с помощью предоставленного идентификатора документа

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Идентификатор
id True integer

Внутренний идентификатор (IID) документа Panviva

Возвращаемое значение

Корневой каталог папки

Возвращает корневую или домашнюю папку во всей Panviva, которую можно детализировать с помощью конечной точки Get Folder Children. Обратите внимание, что ранее эта конечная точка называлась конечной точкой "Поиск папок"

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Возвращаемое значение

Переводы документов

Возвращает список всех переводов (на язык и языковой стандарт) документа Panviva

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Идентификатор
id True integer

Внутренний идентификатор (IID) документа Panviva.

Возвращаемое значение

Переводы папок

Возвращает все переводы папки Panviva, а также все переведенные папки, соответствующие дочерним элементам

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Идентификатор
id True integer

Внутренний идентификатор (IID) папки Panviva

Возвращаемое значение

Поиск артефактов

Возврат результатов поиска для заданного запроса

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Простой запрос
simplequery string

Строка запроса естественного языка. Например: "Фильмы действий". (Примечание. Используйте простой запрос ИЛИ расширенный запрос, а не оба.)

Расширенный запрос
advancedquery string

Строка запроса, написанная в синтаксисе запроса Lucene. Например: "Фильмы И "история". (Примечание. Используйте простой запрос ИЛИ расширенный запрос, а не оба.)

Filter
filter string

Принимает строку фильтра в формате Lucene. Примеры: "категория eq "Ипотечные кредиты", "panvivaDocumentVersion gt "8". (Поля, доступные для фильтрации, включают dateCreated, dateModified, dateDeleted, categoryJson, queryVariationsJson, title, category, primaryQuery, isDeleted, timestamp, panvivaDocumentId, panvivaDocumentVersion, id)

Channel
channel string

Возврат ответа для определенного канала вместо значения по умолчанию

Смещение страницы
pageOffset integer

Смещение разбиения на страницы, обозначающего количество пропустить начальных результатов поиска. Например, pageOffset из 100 и pageLimit из 10 возвращает записи 101-110.

Ограничение страницы
pageLimit integer

Количество возвращаемых записей. Должно быть целым числом от 0 до 1000.

Грань
facet string

Принимает строку аспектов в формате Lucene. Примеры: "facet=Category,count:10&facet=Rating". (Поля facetable включают metaData/values)

Возвращаемое значение

Получение категорий артефактов

Возвращает список всех доступных категорий артефактов

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Возвращаемое значение

Связи контейнеров документов

Возвращает список отношений "родительский-дочерний" между каждым контейнером для предоставленного идентификатора документа

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Идентификатор
id True integer

Внутренний идентификатор (IID) документа Panviva

Возвращаемое значение

Создание категории артефактов

Создает категорию для классификации артефактов

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

имя
name string

Возвращаемое значение

Файл

Возвращает файл (внешний документ) из Panviva

Параметры

Имя Ключ Обязательно Тип Описание
Экземпляр
instance True string

Имя экземпляра, как показано на портале разработчика Panviva.

Идентификатор
id True integer

Внутренний идентификатор (IID) файла Panviva (внешний документ)

Возвращаемое значение

Тело
GetFileResponse

Определения

Имя Путь Тип Описание
href
href string
rel
rel string
type
type string

ResourceSearchResult

Имя Путь Тип Описание
type
type string
id
id string
имя
name string
описание
description string
matchedFields
matchedFields array of string
обрезок
snippet string
language
language string
links
links array of Link

GetSearchResponse

Имя Путь Тип Описание
results
results array of ResourceSearchResult
итог
total integer
links
links array of Link

StringInt64NullableKeyValuePair

Имя Путь Тип Описание
key
key string
value
value integer

Грань

Имя Путь Тип Описание
поле
field string
groups
groups array of StringInt64NullableKeyValuePair

ResponseSection

Имя Путь Тип Описание
mediaType
mediaType string
текст
text string
href
href string
resourceLocation
resourceLocation string

Категория

Имя Путь Тип Описание
имя
name string
id
id integer
dateCreated
dateCreated date-time
dateModified
dateModified date-time

QueryVariation

Имя Путь Тип Описание
id
id integer
query
query string

SearchResult

Имя Путь Тип Описание
id
id uuid
содержимое
content array of ResponseSection
категория
category Category
метаданные
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

Имя Путь Тип Описание
Аспекты
facets array of Facet
results
results array of SearchResult
итог
total integer

GetContainerResponse

Имя Путь Тип Описание
id
id string
имя
name string
body
body string

Тег

Имя Путь Тип Описание
имя
name string
value
value string

Обучение

Имя Путь Тип Описание
failureFeedback
failureFeedback string
forcePageSequence
forcePageSequence boolean
forceQuestionSequence
forceQuestionSequence boolean
передачаScore
passingScore integer
successFeedback
successFeedback string

GetDocumentResponse

Имя Путь Тип Описание
id
id string
имя
name string
описание
description string
version
version integer
language
language string
tags
tags array of Tag
hidden
hidden boolean
source
source string
type
type string
выпуск / релиз
release integer
освобожденный
released boolean
авторское право
copyright string
classification
classification string
статус
status string
процент
percentage integer
ReleaseDate
releaseDate date-time
мобильных приложений
layout string
тренировка
training Training
ключевые слова
keywords array of string
cshKeywords
cshKeywords array of string
обновленная дата
updatedDate date-time
дата создания
createdDate date-time
reusableContent
reusableContent boolean
changeNote
changeNote string
links
links array of Link

Channel

Имя Путь Тип Описание
имя
name string

ResponseVariation

Имя Путь Тип Описание
содержимое
content array of ResponseSection
channels
channels array of Channel
id
id integer
dateCreated
dateCreated date-time
dateModified
dateModified date-time

GetResponseResponse

Имя Путь Тип Описание
links
links array of Link
title
title string
содержимое
content array of ResponseSection
Вариации
variations array of ResponseVariation
категория
category Category
primaryQuery
primaryQuery string
queryVariations
queryVariations array of QueryVariation
panvivaDocumentId
panvivaDocumentId integer
panvivaDocumentVersion
panvivaDocumentVersion integer
метаданные
metaData object
id
id uuid
dateCreated
dateCreated date-time
dateModified
dateModified date-time

Контейнер

Имя Путь Тип Описание
id
id string
имя
name string
body
body string

GetDocumentContainersResponse

Имя Путь Тип Описание
containers
containers array of Container

ContainerRelationship

Имя Путь Тип Описание
id
id string
parent
parent string
children
children array of string
taskFlow
taskFlow string

GetDocumentContainerRelationshipsResponse

Имя Путь Тип Описание
Отношения
relationships array of ContainerRelationship

Документ

Имя Путь Тип Описание
id
id string
имя
name string
описание
description string
version
version integer
language
language string
tags
tags array of Tag
hidden
hidden boolean
source
source string
type
type string
выпуск / релиз
release integer
освобожденный
released boolean
авторское право
copyright string
classification
classification string
статус
status string
процент
percentage integer
ReleaseDate
releaseDate date-time
мобильных приложений
layout string
тренировка
training Training
ключевые слова
keywords array of string
cshKeywords
cshKeywords array of string
обновленная дата
updatedDate date-time
дата создания
createdDate date-time
reusableContent
reusableContent boolean
changeNote
changeNote string
links
links array of Link

GetDocumentTranslationsResponse

Имя Путь Тип Описание
Переводы
translations array of Document
origin
origin string

GetFileResponse

Имя Путь Тип Описание
id
id string
имя
name string
описание
description string
version
version integer
language
language string
tags
tags array of Tag
hidden
hidden boolean
source
source string
type
type string
содержимое
content string
fileName
fileName string
выпуск / релиз
release integer
освобожденный
released boolean
авторское право
copyright string
classification
classification string
статус
status string
процент
percentage integer
ReleaseDate
releaseDate date-time
ключевые слова
keywords array of string
cshKeywords
cshKeywords array of string
changeNote
changeNote string
обновленная дата
updatedDate date-time
дата создания
createdDate date-time

GetFolderResponse

Имя Путь Тип Описание
id
id string
имя
name string
описание
description string
version
version integer
language
language string
tags
tags array of Tag
hidden
hidden boolean
source
source string
type
type string
links
links array of Link

Resource

Имя Путь Тип Описание
id
id string
имя
name string
описание
description string
version
version integer
language
language string
tags
tags array of Tag
hidden
hidden boolean
source
source string
type
type string

GetFolderChildrenResponse

Имя Путь Тип Описание
children
children array of Resource

Folder

Имя Путь Тип Описание
id
id string
имя
name string
описание
description string
version
version integer
language
language string
tags
tags array of Tag
hidden
hidden boolean
source
source string
type
type string
links
links array of Link

GetFolderTranslationsResponse

Имя Путь Тип Описание
Переводы
translations array of Folder

GetFolderRootResponse

Имя Путь Тип Описание
id
id string
имя
name string
описание
description string
version
version integer
language
language string
tags
tags array of Tag
hidden
hidden boolean
source
source string
type
type string
links
links array of Link

GetImageResponse

Имя Путь Тип Описание
id
id string
имя
name string
Ширина
width integer
height
height integer
size
size integer
Тип контента
contentType string
содержимое
content string

ArtefactCategory

Имя Путь Тип Описание
id
id integer
categoryName
categoryName string

GetArtefactCategoriesResponse

Имя Путь Тип Описание
categories
categories array of ArtefactCategory

PostArtefactCategoryResponse

Имя Путь Тип Описание
categoryId
categoryId integer
categoryName
categoryName string

объект

Это тип «объект».