Panviva (Preview)

Panviva is an omnichannel knowledge management solution. Our priority is to aid our clients in keeping their employees happy, so that they can focus on ensuring their customers are happy. Digitally transforming organisations for the last 20 years, we're now helping our customers to deliver knowledge nuggets to their employees and customers, whether they are in the home or the office - anytime and anywhere.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Name Panviva Customer Advocacy Team
URL https://www.panviva.com/support
Email support@panviva.com
Connector Metadata
Publisher Panviva
Website https://www.panviva.com
Privacy policy https://www.panviva.com/privacy-policy
Categories Business Management;Productivity

Creating a connection

The connector supports the following authentication types:

Default Required parameters for creating connection. All regions

Default

Applicable: All regions

Required parameters for creating connection.

Name Type Description
Panviva API Subscription Key securestring The Panviva API Subscription Key for your instance.

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Artefact

Return an artefact using the ID provided

Container

Return a container using the container ID provided

Create Artefact Category

Creates a category for classifying artefacts

Document

Return a document using the document ID provided

Document Container Relationships

Return a list of the parent-child relationship between each container for the document ID provided

Document Containers

Return a list of containers using the document ID provided

Document Translations

Return a list of all translations (per language and locale) of a Panviva document

File

Returns a file (external document) from Panviva

Folder

Return information about a Panviva folder and references to each of its direct children

Folder Children

Gets all the immediate children of a Panviva folder, not including grandchildren. Children can be folders, documents, or files (external documents)

Folder Root

Gets the root/home folder in all of Panviva, which can be drilled into using the Get Folder Children endpoint. Note this endpoint was formerly referred to as the 'Folder Search' endpoint

Folder Translations

Gets all the translations of a Panviva folder, along with each translated folders respective children

Get Artefact Categories

Gets a list of all available artefact categories

Image

Returns an image from Panviva. Image data is represented as a base64 string

Live CSH

Present a CSH search result page of the passing query on Panviva client to specified user on Panviva client

Live Document

Present a document page to specified user on Panviva client

Live Search

Present a search result page of the passing query on Panviva client to specified user on Panviva client

Search

Searches documents, folders, and files (external documents) for a term and returns paginated results

Search Artefacts

Return search results for a given query

Artefact

Return an artefact using the ID provided

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Id
id True string

Format - uuid. The id (ID) of an artefact

Returns

Container

Return a container using the container ID provided

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Id
id True string

The id of a document container

Returns

Create Artefact Category

Creates a category for classifying artefacts

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

name
name string

Returns

Document

Return a document using the document ID provided

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Id
id True string

A document unique identifier, Document ID. If a document is a translated document, this value represents Internal ID or IID in Panviva API v1.

Version
version integer

Request the API to return a particular version of the specified document.

Returns

Document Container Relationships

Return a list of the parent-child relationship between each container for the document ID provided

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Id
id True integer

The internal id (IID) of a Panviva document

Returns

Document Containers

Return a list of containers using the document ID provided

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Id
id True integer

The internal id (IID) of a Panviva document

Returns

Document Translations

Return a list of all translations (per language and locale) of a Panviva document

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Id
id True integer

The internal id (IID) of a Panviva document.

Returns

File

Returns a file (external document) from Panviva

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Id
id True integer

The internal id (IID) of a Panviva file (external document)

Returns

Folder

Return information about a Panviva folder and references to each of its direct children

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Id
id True integer

The internal id (IID) of a Panviva folder

Returns

Folder Children

Gets all the immediate children of a Panviva folder, not including grandchildren. Children can be folders, documents, or files (external documents)

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Id
id True integer

The internal id (IID) of a Panviva folder

Returns

Folder Root

Gets the root/home folder in all of Panviva, which can be drilled into using the Get Folder Children endpoint. Note this endpoint was formerly referred to as the 'Folder Search' endpoint

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Returns

Folder Translations

Gets all the translations of a Panviva folder, along with each translated folders respective children

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Id
id True integer

The internal id (IID) of a Panviva folder

Returns

Get Artefact Categories

Gets a list of all available artefact categories

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Returns

Image

Returns an image from Panviva. Image data is represented as a base64 string

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Id
id True integer

The id of a Panviva image

Returns

Live CSH

Present a CSH search result page of the passing query on Panviva client to specified user on Panviva client

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

username
username string

The Panviva user to whom you wish to send the result. (Note: Use username OR userId, not both.)

userId
userId string

The numeric ID of the user to whom you wish to send the result. (Note: Use username OR userId, not both.)

query
query string

The CSH term to search for.

showFirstResult
showFirstResult boolean

True to immediately open the first document found, or false to show the list of results.

maximizeClient
maximizeClient boolean

True/False depending on whether you want the Panviva client to maximize on the user's desktop, when the document is delivered.

Returns

response
object

Live Document

Present a document page to specified user on Panviva client

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

username
username string

The Panviva user to whom you wish to send the result. (Note: Use username OR userId, not both.)

userId
userId string

The numeric ID of the user to whom you wish to send the result. (Note: Use username OR userId, not both.)

id
id string

The Document ID of the Panviva Document you wish to send.

location
location string

The Section ID you would like the user to see, when the specified document is opened.

maximizeClient
maximizeClient boolean

True/False depending on whether you want the Panviva client to maximize on the user's desktop, when the document is delivered.

Returns

response
object

Present a search result page of the passing query on Panviva client to specified user on Panviva client

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

username
username string

The Panviva user to whom you wish to send the result. (Note: Use username OR userId, not both.)

userId
userId string

The numeric ID of the user to whom you wish to send the result. (Note: Use username OR userId, not both.)

query
query string

The term to search for.

maximizeClient
maximizeClient boolean

True/False depending on whether you want the Panviva client to maximize on the user's desktop, when the document is delivered.

showFirstResult
showFirstResult boolean

True to immediately open the first document found, or false to show the list of results.

Returns

response
object

Searches documents, folders, and files (external documents) for a term and returns paginated results

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Term
term True string

The word or phrase to be searched for

Page Offset
pageOffset integer

The pagination offset to denote the number of initial search results to skip. For example, pageOffset of 100 and pageLimit of 10 would return records 101-110.

Page Limit
pageLimit integer

The number of records to return. Must be an integer between 0 and 1000.

Returns

Search Artefacts

Return search results for a given query

Parameters

Name Key Required Type Description
Instance
instance True string

The instance name as shown on the Panviva Developer Portal.

Simple Query
simplequery string

Natural language query string. For example: 'Action Movies'. (Note: Use simplequery OR advancedquery, not both.)

Advanced Query
advancedquery string

Query string written in Lucene query syntax. For example: 'films AND "a story"'. (Note: Use simplequery OR advancedquery, not both.)

Filter
filter string

Accepts a Lucene-formatted filter string. Examples: 'category eq "Mortgages"', 'panvivaDocumentVersion gt "8"'. (Filterable fields include dateCreated, dateModified, dateDeleted, categoryJson, queryVariationsJson, title, category, primaryQuery, isDeleted, timestamp, panvivaDocumentId, panvivaDocumentVersion, id)

Channel
channel string

Return response for a specific channel, instead of the default

Page Offset
pageOffset integer

The pagination offset to denote the number of initial search results to skip. For example, pageOffset of 100 and pageLimit of 10 would return records 101-110.

Page Limit
pageLimit integer

The number of records to return. Must be an integer between 0 and 1000.

Facet
facet string

Accepts a Lucene-formatted facet string. Examples: 'facet=Category,count:10&facet=Rating'. (Facetable fields include metaData/values)

Returns

Definitions

Name Path Type Description
href
href string
rel
rel string
type
type string

ResourceSearchResult

Name Path Type Description
type
type string
id
id string
name
name string
description
description string
matchedFields
matchedFields array of string
snippet
snippet string
language
language string
links
links array of Link

GetSearchResponse

Name Path Type Description
results
results array of ResourceSearchResult
total
total integer
links
links array of Link

StringInt64NullableKeyValuePair

Name Path Type Description
key
key string
value
value integer

Facet

Name Path Type Description
field
field string
groups
groups array of StringInt64NullableKeyValuePair

ResponseSection

Name Path Type Description
mediaType
mediaType string
text
text string
href
href string
resourceLocation
resourceLocation string

Category

Name Path Type Description
name
name string
id
id integer
dateCreated
dateCreated date-time
dateModified
dateModified date-time

QueryVariation

Name Path Type Description
id
id integer
query
query string

SearchResult

Name Path Type Description
id
id uuid
content
content array of ResponseSection
category
category Category
metaData
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

Name Path Type Description
facets
facets array of Facet
results
results array of SearchResult
total
total integer

GetContainerResponse

Name Path Type Description
id
id string
name
name string
body
body string

Tag

Name Path Type Description
name
name string
value
value string

Training

Name Path Type Description
failureFeedback
failureFeedback string
forcePageSequence
forcePageSequence boolean
forceQuestionSequence
forceQuestionSequence boolean
passingScore
passingScore integer
successFeedback
successFeedback string

GetDocumentResponse

Name Path Type Description
id
id string
name
name string
description
description string
version
version integer
language
language string
tags
tags array of Tag
hidden
hidden boolean
source
source string
type
type string
release
release integer
released
released boolean
copyright
copyright string
classification
classification string
status
status string
percentage
percentage integer
releaseDate
releaseDate date-time
layout
layout string
training
training Training
keywords
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

Name Path Type Description
name
name string

ResponseVariation

Name Path Type Description
content
content array of ResponseSection
channels
channels array of Channel
id
id integer
dateCreated
dateCreated date-time
dateModified
dateModified date-time

GetResponseResponse

Name Path Type Description
links
links array of Link
title
title string
content
content array of ResponseSection
variations
variations array of ResponseVariation
category
category Category
primaryQuery
primaryQuery string
queryVariations
queryVariations array of QueryVariation
panvivaDocumentId
panvivaDocumentId integer
panvivaDocumentVersion
panvivaDocumentVersion integer
metaData
metaData object
id
id uuid
dateCreated
dateCreated date-time
dateModified
dateModified date-time

Container

Name Path Type Description
id
id string
name
name string
body
body string

GetDocumentContainersResponse

Name Path Type Description
containers
containers array of Container

ContainerRelationship

Name Path Type Description
id
id string
parent
parent string
children
children array of string
taskFlow
taskFlow string

GetDocumentContainerRelationshipsResponse

Name Path Type Description
relationships
relationships array of ContainerRelationship

Document

Name Path Type Description
id
id string
name
name string
description
description string
version
version integer
language
language string
tags
tags array of Tag
hidden
hidden boolean
source
source string
type
type string
release
release integer
released
released boolean
copyright
copyright string
classification
classification string
status
status string
percentage
percentage integer
releaseDate
releaseDate date-time
layout
layout string
training
training Training
keywords
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

Name Path Type Description
translations
translations array of Document
origin
origin string

GetFileResponse

Name Path Type Description
id
id string
name
name string
description
description string
version
version integer
language
language string
tags
tags array of Tag
hidden
hidden boolean
source
source string
type
type string
content
content string
fileName
fileName string
release
release integer
released
released boolean
copyright
copyright string
classification
classification string
status
status string
percentage
percentage integer
releaseDate
releaseDate date-time
keywords
keywords array of string
cshKeywords
cshKeywords array of string
changeNote
changeNote string
updatedDate
updatedDate date-time
createdDate
createdDate date-time

GetFolderResponse

Name Path Type Description
id
id string
name
name string
description
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

Name Path Type Description
id
id string
name
name string
description
description string
version
version integer
language
language string
tags
tags array of Tag
hidden
hidden boolean
source
source string
type
type string

GetFolderChildrenResponse

Name Path Type Description
children
children array of Resource

Folder

Name Path Type Description
id
id string
name
name string
description
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

Name Path Type Description
translations
translations array of Folder

GetFolderRootResponse

Name Path Type Description
id
id string
name
name string
description
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

Name Path Type Description
id
id string
name
name string
width
width integer
height
height integer
size
size integer
contentType
contentType string
content
content string

ArtefactCategory

Name Path Type Description
id
id integer
categoryName
categoryName string

GetArtefactCategoriesResponse

Name Path Type Description
categories
categories array of ArtefactCategory

PostArtefactCategoryResponse

Name Path Type Description
categoryId
categoryId integer
categoryName
categoryName string

object

This is the type 'object'.